跳转到内容
TeapplixTeapplixTeapplix Help

Product

此内容尚不支持你的语言。

Product API allows you to add, update and delete “product” definitions into Teapplix. A product is identified by “item_name” or “SKU” in Teapplix, and can have many attributes, including GTINs (UPC, ASIN, etc), location, associated images, attributes, and various descriptions.

The Product API is intended for bulk transfer of product information between Teapplix and external systems. For example, you can upload products into Teapplix from external systems so that you can launch listings on Walmart and Jet.com.

Note that certain product fields are only exposed when you have subscription to Teapplix InventoryAdvisor, and or Teapplix Listing functionality.

In the below operations, we support different REST methods:

  • GET ==> obtain existing products in Teapplix, returned in JSON format
  • POST ==> insert new products into Teapplix, any duplicate ItemName will cause the product insert to fail
  • PUT ==> update products that already exists in Teapplix, use ItemName to lookup
  • DELETE ==> remove products from Teapplix

Data Pagination

Note that GET method supports pagination, which allow you to chose PageSize (100 by default, maximum 1000) and PageNumber (starting from 1). To use pagination, append PageSize and PageNumber to the query string of GET request. Response will also display PageSize and PageNumber for current dataset. To download all products, increase PageNumber until you get response with empty dataset.

https://api.teapplix.com/api2/Product Explorer

GET Request

Query parameters

PropertyTypeDescriptionConstraints
ItemName string Item Name of product
ItemType string
VariationType string
RootItemName string
Upc string
Location string
ItemTitle string
Category string
WalmartCategoryId string
WalmartTaxCode string
Supplier string
Asin string
Xref3 string
DefaultPrice string
DefaultPriceSign string Condition Sign to search, available signs '=', '>', '<', '>=', '<=', '<>', defaults to '='
Cost string
CostSign string Condition Sign to search, available signs '=', '>', '<', '>=', '<=', '<>', defaults to '='
SalesRep string
CommissionRate string
DangerousGoodsType string
CountryOfOrigin string
Brand string
Model string
Manufacturer string
ManufacturerPartNumber string
Status string Status of downloaded inventory products. Possible values: active, inactive, all. Default active
DetailLevel string Set to 'CatalogInfo' to include catalog and listing fields in the response
PageSize string Max records to return per response. Default 100. Limit 1000. Use 'Next' or 'Prev' link to paginate
PageNumber string Page number. Considering PageNumber, returns the PageNumber-th page, 1-indexed

GET Response - 200

Product Get Response

PropertyTypeDescriptionConstraints
Products Product[] Required
Pagination Pagination Declares pagination data

Pagination

Declares pagination data

PropertyTypeDescriptionConstraints
PageSize integer Current Page Size
PageNumber integer Current Page Number. Increase it to get next set of data until you get empty items list.
TotalPages integer Total Pages
Warning string Warning message

Product

PropertyTypeDescriptionConstraints
ItemName string Required
ItemType string
VariationType string One of: none, root
ItemTitle string
Active integer
Upc string
Asin string
CustomField string
CustomField2 string
CustomField3 string
CustomField4 string
Supplier string
SupplierSku string
Brand string
Mpn string
Location string
DefaultPrice number
DefaultCost number
HarmonizedCode string
CountryOfOrigin string 2 letter ISO code Max-Length: 2Min-Length: 2Pattern: [A-Z]{2}
CustomsValue number
CustomsDescription string
LocalizedCustomsDescription string
SalesRep string
CommissionRate number
ScanControl string One of: normal, individual_scan, serial_scan, none
DangerousGoodsType integer
DangerousGoodsDetails DangerousGoodsDetails Dangerous Goods Details
MainImage ProductMainImage Product Main Image
Weight Weight Weight of a package or an item.
Dimensions Dimensions of package If not set Teapplix will apply 6x6x4 by default
ShippingPlan ProductShippingPlan Default shipping execution policy for this product. Controls which carrier methods are used, case pack behavior, and add-on options. All fields are optional.
CatalogInfo ProductCatalogInfo Product catalog and listing fields. Only populated when DetailLevel=CatalogInfo is requested.

DangerousGoodsDetails

Dangerous Goods Details

PropertyTypeDescriptionConstraints
CommodityType string Commodity Type One of: UN, ID, NA
CommodityId string Commodity Type Max-Length: 5
PackingGroup string Packing Group One of: I, II, III
PackingType string Packing Type Max-Length: 60
PackingInstruction string Packing Instruction Max-Length: 4
AircraftCategoryType string Aircraft Category Type One of: PASSENGER_AND_CARGO_AIRCRAFT, CARGO_AIRCRAFT_ONLY
ProperName string Proper Name Max-Length: 30
TechnicalName string Technical Name Max-Length: 20
PrimaryClass string Primary Class Max-Length: 4
SubsidiaryClass string Subsidiary Class Max-Length: 4
ReportableQty number Reportable Quantity
ReportableQtyUnit string Reportable Quantity Unit One of: oz, lb, gram, kg
Percentage string Percentage Max-Length: 3
AuthorizationInfo string AuthorizationInfo Max-Length: 40

ProductMainImage

Product Main Image

PropertyTypeDescriptionConstraints
ImageUrlLarge string Large Image URL
ImageUrlSmall string Small Image URL
AltText string Alternate Text

Weight

Weight of a package or an item.

PropertyTypeDescriptionConstraints
Value number Absolute weight value Required
Unit string Unit RequiredOne of: OZ, LB, GR, KG

Dimensions of package

If not set Teapplix will apply 6x6x4 by default

PropertyTypeDescriptionConstraints
Length number Length Required
Width number Width Required
Depth number Depth Required
Unit string Unit of measurement RequiredOne of: IN, CM

ProductShippingPlan

Default shipping execution policy for this product. Controls which carrier methods are used, case pack behavior, and add-on options. All fields are optional.

PropertyTypeDescriptionConstraints
EconomyMethod string Carrier method code for Economy class. Valid values from GET /ShipMethods.
StandardMethod string Carrier method code for Standard class. Valid values from GET /ShipMethods.
ExpeditedMethod string Carrier method code for Expedited class. Valid values from GET /ShipMethods.
SecondDayMethod string Carrier method code for 2-Day class. Valid values from GET /ShipMethods.
OneDayMethod string Carrier method code for 1-Day class. Valid values from GET /ShipMethods.
IntlEconomyMethod string Carrier method code for International Economy class. Valid values from GET /ShipMethods.
IntlStandardMethod string Carrier method code for International Standard class. Valid values from GET /ShipMethods.
IntlExpeditedMethod string Carrier method code for International Expedited class. Valid values from GET /ShipMethods.
DomesticInsurance integer Add insurance to domestic shipments. 1 = yes, 0 = no. One of: 0, 1
InternationalInsurance integer Add insurance to international shipments. 1 = yes, 0 = no. One of: 0, 1
SignatureRequired integer Require signature on delivery. 1 = yes, 0 = no. One of: 0, 1
IdenticalPackageCount integer Number of identical packages a single product unit ships in. Opposite of CasePack: CasePack groups multiple units into one case, IdenticalPackageCount splits one unit across N same-sized boxes. Minimum: 1
PackageInstructions string Free-form packing instructions for this product. Max 255 characters.
CasePack ProductCasePack Case pack configuration. When an order quantity is a multiple of UnitsPerCase, each case ships as a separate unit according to Strategy.

ProductCatalogInfo

Product catalog and listing fields. Only populated when DetailLevel=CatalogInfo is requested.

PropertyTypeDescriptionConstraints
Category string
ShortDescriptionBase64 string
LongDescriptionBase64 string
WalmartCategoryId string
WalmartCategoryOptionsBase64 string
WalmartTaxCode integer
MAPPrice number
MSRPPrice number
AdditionalImages ProductImage[] Additional Images
Features Product Feature[] Product Features
ShippingExceptions ProductShippingException[] Item Shipping Exceptions
Keywords string Product Keywords

ProductCasePack

Case pack configuration. When an order quantity is a multiple of UnitsPerCase, each case ships as a separate unit according to Strategy.

PropertyTypeDescriptionConstraints
UnitsPerCase integer Number of product units per case shipped. When this is set product is typicalled sold in multiples of this quantity. Typically applies in case of B2B sales. RequiredMinimum: 1
Strategy string How each case is shipped. SPLIT creates a separate child order per case. EP (Extra Package) adds each case as an extra package on the same order. RequiredOne of: SPLIT, EP

ProductImage

PropertyTypeDescriptionConstraints
sku string
seqNum string
url string
altText string
purpose string

Product Feature

Product Feature

PropertyTypeDescriptionConstraints
AttributeValue string Attribute Value
AttributeValueSeq integer

ProductShippingException

Product Shipping Exception

PropertyTypeDescriptionConstraints
IsAllowed integer Is Allowed
ShipMethod string Ship Method
ServiceLevel string
ShipRegion string Ship Region
ShipPrice number Ship Price
OverrideType string Override Type
ExceptionType string Exception Type
StoreType string Store Type

GET Response - 400

Message

PropertyTypeDescriptionConstraints
Success boolean Always false on this envelope. Message is the error envelope (4xx/5xx); Success is kept on the wire so legacy clients can branch on it without parsing the HTTP status. Required
Code integer Indicate error code. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115
Message string Message typically associated with errors
Description string[] Detailed description

GET Response - 401

Message

PropertyTypeDescriptionConstraints
Success boolean Always false on this envelope. Message is the error envelope (4xx/5xx); Success is kept on the wire so legacy clients can branch on it without parsing the HTTP status. Required
Code integer Indicate error code. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115
Message string Message typically associated with errors
Description string[] Detailed description

GET Response - 500

Message

PropertyTypeDescriptionConstraints
Success boolean Always false on this envelope. Message is the error envelope (4xx/5xx); Success is kept on the wire so legacy clients can branch on it without parsing the HTTP status. Required
Code integer Indicate error code. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115
Message string Message typically associated with errors
Description string[] Detailed description
Test Request