Quantity Upload — Inventory

You can use ProductQuantity update quantity into Teapplix. The data can either be full counts (in-stock), or incremental credits or debits.

Method and Endpoint

Quantity Upload uses “POST” REST method, and the URL is below:

https://api.teapplix.com/api2/ProductQuantity

The JSON schema is given below:

GET POST

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

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

GET Request

Query parameters

Property	Type	Description	Constraints
WarehouseId	string
ItemName	string
Upc	string

GET Response - 200

Inventory Quantity Result

Product Operation result

Property	Type	Description	Constraints
ProductQuantities	Product Quantity[]	Product quantities data	Required

Product Quantity

Product Quantity

Property	Type	Description	Constraints
ItemName	string	Item Name
WarehouseId	integer	Warehouse Id
WarehouseName	string	Warehouse Name. Provided for external warehouses only.
Asin	string
Upc	string	Upc
Location	string	Location
Xref3	string	Xref3
UnitCost	number	Unit Cost
TotalCost	number	Total Cost
QtyOnHand	integer	Qty On Hand
QtyToShip	integer	Qty To Ship
QtyAvailable	integer	Qty Available
QtyReserve	integer	Qty Reserve
ItemTitle	string	Item Title

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 - 500

POST Request

Inventory Quantities

Inventory Quantities

Property	Type	Description	Constraints
Quantities	Inventory Quantity[]	Inventory Quantities	Required
Cleanup	boolean	Cleanup old in-stock records that are replaced by current import
ProductCrossReference	string	Automatically create the referenced product if not found	One of: reject, create

Inventory Quantity

Product Quantity

Property	Type	Description	Constraints
PONumber	integer	PO Number
PostDate	string	Post Date	Required
PostType	string		RequiredOne of: debit, credit, in-stock
WarehouseId	integer	Warehouse Id. WarehouseId, WarehouseName or both WarehouseId and WarehouseName are accepted, but WarehouseName has higher priority if they does not match.
WarehouseName	string	Warehouse Name. Only allowed for external warehouses. WarehouseId, WarehouseName or both WarehouseId and WarehouseName are accepted, but WarehouseName has higher priority if they does not match.
ItemName	string	Item Name	Required
Quantity	integer	Quantity	Required
Location	string	Location
UnitPrice	number	Unit Price
PostComment	string	Post Comment

POST Response - 200

Product Results

Product Operation result

Property	Type	Description	Constraints
Products	ProductOperationResult[]	Product create details	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

POST 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

POST 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

POST 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