Item Mapping — Inventory

Teapplix allows you to perform Item Mapping, which basically translate names from Marketplaces to real “ItemName” in Teapplix Inventory System.

You can query (GET), create (POST) or delete (DELETE) item mappings using the /ProductXref end point:

GET POST DELETE

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

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

GET Request

Query parameters

Property	Type	Description	Constraints
TeapplixSKU	string	Teapplix SKU
SourceItemName	string	Item Name of product
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 Mapping Response

Property	Type	Description	Constraints
ProductXrefs	Product Mapping[]		Required
Pagination	Pagination	Declares pagination data

Pagination

Declares pagination data

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

Declares product mapping

Property	Type	Description	Constraints
SourceItemName	string		Required
TeapplixSKU	string		Required

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

Products Mapping

Used to insert Products Mapping

Property	Type	Description	Constraints
ProductXrefs	Product Mapping[]	Product Mappings to be inserted	Required
AutoCleanup	boolean	Auto Cleanup flag. false = reject on any issue; true = copy or create of target, followed by deep delete of source, reject if target is QB inventory	Required

Product Mapping

Declares product mapping

Property	Type	Description	Constraints
SourceItemName	string		Required
TeapplixSKU	string		Required

POST Response - 200

Product Mapping Operation result

Product Mapping Operation result

Property	Type	Description	Constraints
ProductXrefs	Product Mapping Operation details[]	Product mapping operation details	Required

Product Mapping Operation details

Property	Type	Description	Constraints
SourceItemName	string	Source Item Name	RequiredMax-Length: 40
Success	boolean	DEPRECATED: use Code (0 = success, non-zero = error) instead. This field will be removed in the next API major version.	Required
Code	integer	Indicate error code or 0 if success. Codes list and description are located on help page http://www.teapplix.com/help/?page_id=7115
Message	string	Message
Teapplix SKU	string	Teapplix SKU	Max-Length: 40

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

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

DELETE Request

Products Mapping Delete Request

Used to delete Product Mapping

Property	Type	Description	Constraints
ProductXrefs	string[]	Source SKU to be deleted	Required

DELETE Response - 200

Product Mapping Operation result

Product Mapping Operation result

Property	Type	Description	Constraints
ProductXrefs	Product Mapping Operation details[]	Product mapping operation details	Required

Product Mapping Operation details

Property	Type	Description	Constraints
SourceItemName	string	Source Item Name	RequiredMax-Length: 40
Success	boolean	DEPRECATED: use Code (0 = success, non-zero = error) instead. This field will be removed in the next API major version.	Required
Code	integer	Indicate error code or 0 if success. Codes list and description are located on help page http://www.teapplix.com/help/?page_id=7115
Message	string	Message
Teapplix SKU	string	Teapplix SKU	Max-Length: 40

DELETE 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

DELETE 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

DELETE 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