Combo Products — Inventory

Combo API allows you to define all the children of a combo product. A combo product is a kit, where several base products (with quantity 1 or more) can be combined and sold as one item. Defining combo products help you track inventory when the combo is sold.

Teapplix supports both download as well as update of product combo:

• GET —> download combo child for a given combo product
• PUT—> update (overwrite), list of child product for a given combo product. The child products listed here must already exist and not be of type combo, otherwise you will get validation errors.

Note that in the above 2 API, the base product must have ItemType=‘combo’, otherwise, the API will give you an error.

Also, to change a product from a combo to a single product, you use /Product api (PUT update) to change ItemType from combo to other types. Once you do that, all the child product references will be removed. The child product still exist, but their linkage to the combo product are all removed.

GET PUT

https://api.teapplix.com/api2/ProductCombo Test Request Explorer

Request Response - 200 Response - 400 Response - 401 Response - 500

GET Request

Query parameters

Property	Type	Description	Constraints
ParentItemName	string	Item Name of parent product

GET Response - 200

Combo Product Get Response

Property	Type	Description	Constraints
ChildItems	Combo Product Child Item[]		Required

Combo Product Child Item

Declares Combo Product Child Item

Property	Type	Description	Constraints
ItemName	string		Required
Quantity	integer

GET Response - 400

Message

Property	Type	Description	Constraints
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

Property	Type	Description	Constraints
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

Property	Type	Description	Constraints
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

Request Response - 200 Response - 400 Response - 401 Response - 404 Response - 500

PUT Request

Combo Product data to update

Used to update Inventory Combo Products

Property	Type	Description	Constraints
ParentItemName	string	Parent Item Name	Required
ChildItems	Combo Product Child Item[]	Combo Product Child Items to be inserted or updated. If you call method again, all Child Items will be overwritten	Required

Combo Product Child Item

Declares Combo Product Child Item

Property	Type	Description	Constraints
ItemName	string		Required
Quantity	integer

PUT Response - 200

Combo Product Operation result

Combo Product Operation result

Property	Type	Description	Constraints
ChildItems	ProductOperationResult[]	Result of each child item operation	Required

ProductOperationResult

Property	Type	Description	Constraints
ItemName	string	Item Name	RequiredMax-Length: 40
Status	string	Submission status for product	RequiredOne of: Success, Failure, NotFound
Message	string	Message

PUT Response - 400

Message

Property	Type	Description	Constraints
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

PUT Response - 401

Message

Property	Type	Description	Constraints
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

PUT Response - 404

Message

Property	Type	Description	Constraints
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

PUT Response - 500

Message

Property	Type	Description	Constraints
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 Close

URL APIToken Body

Send