OrderTags

OrderTags is an API you use to get, add or remove tags to an order.

Use the GET method to obtain list of tags for an order.

Use the POST method to append list of tags to an order. The existing tags on the order will not be affected. For example, if order A has tag “t1”, and you add tags [“t2”, “t3”], order will end up with 3 tags: [“t1”, “t2”, “t3”]

Use the DELETE method to remove list of tags to an order, other tags on the order will remain.

Any tag name mentioned on the API request must exists. Adding a tag to an order that already has said tag will be silently ignored. Deleting a tag from an order that does not have such tag will also be silently ignored. For example, if order A has tag [ “t1”, “t2”, “t3” ], removing tag [“t0”, “t1”] will give success response and result in order A having tags [“t2”, “t3”].

GET POST DELETE

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

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

GET Request

Query parameters

Property	Type	Description	Constraints
TxnId	string	TxnId of order. Use this parameter to download only one order.

GET Response - 200

Order Tags

'APIToken' header should be included in each request

Property	Type	Description	Constraints
Orders	Order Tags Of One Order[]	Array of orders

Order Tags Of One Order

Property	Type	Description	Constraints
TxnId	string	Unique id for each entry	RequiredMax-Length: 40Pattern: [\s\S]
TagList	string[]	Order’s tags list	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

Order Tags

'APIToken' header should be included in each request

Property	Type	Description	Constraints
Orders	Order Tags Of One Order[]	Array of orders

Order Tags Of One Order

Property	Type	Description	Constraints
TxnId	string	Unique id for each entry	RequiredMax-Length: 40Pattern: [\s\S]
TagList	string[]	Order’s tags list	Required

POST Response - 200

Order Tags Results

Property	Type	Description	Constraints
OrdersResult	Order Tags Result[]		Required

Order Tags Result

Property	Type	Description	Constraints
TxnId	string	Unique id for each entry	RequiredMax-Length: 40
Success	boolean	DEPRECATED: use Status (Success/Failure/NotFound) and Code instead. This field will be removed in the next API major version.	Required
Status	string	Per-order operation status: 'Success' if the tag operation succeeded, 'NotFound' if the order does not exist, 'Failure' for any other error.	RequiredOne of: Success, Failure, NotFound
Code	integer	DEPRECATED: under HTTP 200, the canonical per-order discriminator is Status (Success/Failure/NotFound). For specific failure detail, read Message and Description. Code will be removed in the next API major version. The error envelope (HTTP 4xx/5xx Message) keeps Code as canonical — only this per-item Code is being phased out.
Message	string	Detailed message. Typically associated with errors	Max-Length: 255
Description	string[]	Detailed description

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

Order Tags

'APIToken' header should be included in each request

Property	Type	Description	Constraints
Orders	Order Tags Of One Order[]	Array of orders

Order Tags Of One Order

Property	Type	Description	Constraints
TxnId	string	Unique id for each entry	RequiredMax-Length: 40Pattern: [\s\S]
TagList	string[]	Order’s tags list	Required

DELETE Response - 200

Order Tags Results

Property	Type	Description	Constraints
OrdersResult	Order Tags Result[]		Required

Order Tags Result

Property	Type	Description	Constraints
TxnId	string	Unique id for each entry	RequiredMax-Length: 40
Success	boolean	DEPRECATED: use Status (Success/Failure/NotFound) and Code instead. This field will be removed in the next API major version.	Required
Status	string	Per-order operation status: 'Success' if the tag operation succeeded, 'NotFound' if the order does not exist, 'Failure' for any other error.	RequiredOne of: Success, Failure, NotFound
Code	integer	DEPRECATED: under HTTP 200, the canonical per-order discriminator is Status (Success/Failure/NotFound). For specific failure detail, read Message and Description. Code will be removed in the next API major version. The error envelope (HTTP 4xx/5xx Message) keeps Code as canonical — only this per-item Code is being phased out.
Message	string	Detailed message. Typically associated with errors	Max-Length: 255
Description	string[]	Detailed description

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