Skip to content
TeapplixTeapplixTeapplix Help

Variations — Inventory

Variation API allows you to define all the variations for a given “root” product. This is only available if you subscribe to ActionShip Listing product and want to upload the product to supported marketplaces like Walmart and Jet.

A variation is a specific color, size etc version of the “root” product. Each variation is a specific SKU | UPC, can have it’s own size and weight and price and quantity. It is a concrete version of a product that can be sold.

For example, while many shoes can be the same brand design, different size can be separate “variations”. When you buy a pair of shoes, you are buying a specific size, which is a specific variation. You can be in stock in one size (variation), and out of stock for anther size of the same shoe.

Teapplix supports both download as well as upload of product varations:

  • GET —> download variation information for a given root product
  • POST —> create, or update (overwrite), list of product variations for a given root product
https://api.teapplix.com/api2/ProductVariation Explorer

GET Request

Query parameters

PropertyTypeDescriptionConstraints
ParentItemName string

GET Response - 200

Product Variation Result

Product Variations for selected ParentItemName

PropertyTypeDescriptionConstraints
ProductVariations Product Variation[] Product variations Required

Product Variation

Declares product

PropertyTypeDescriptionConstraints
ItemName string RequiredPattern: [\s\S]
Asin string
Upc string
MainImage ProductMainImage Product Main Image
AdditionalImages ProductImage[] Additional Images
DefaultPrice number
Attributes Product Variation Attribute[] Variation Attributes

ProductMainImage

Product Main Image

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

ProductImage

PropertyTypeDescriptionConstraints
sku string
seqNum string
url string
altText string
purpose string

Product Variation Attribute

Product Feature

PropertyTypeDescriptionConstraints
AttributeName string Attribute Name
AttributeValue string Attribute Value
SwatchImage ProductImage

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