Tags

Tags are created to filter orders. A order in Teapplix can have any number of tags.

GET POST PUT DELETE

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

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

GET Request

Query parameters

Property	Type	Description	Constraints
TagId	integer	Filter by tag ID (exact match). Use to look up a specific tag by its numeric ID.
TagName	string	Case-insensitive substring search on tag name. Returns all tags whose name contains this string.

GET Response - 200

Tag Get Response

Response to GET /Tag. Contains a list of tags matching the query filters, ordered by TagId.

Property	Type	Description	Constraints
Tags	Tag[]	List of tags matching the query filters. Empty array if none match.	Required

Tag

Order tag entity. Tags are colored labels applied to orders for visual grouping and filtering. TagId 1 (Ready To Ship) and TagId 2 (Hold) are system tags and cannot be deleted. Use /OrderTags to apply or remove tags from orders.

Property	Type	Description	Constraints
TagId	integer	Unique tag identifier. On create, omit to auto-assign. On update/delete, provide to identify the tag (alternative to TagName).	Minimum: 1
TagName	string	Display name of the tag. Must be unique. Required on create. On update/delete, may be used instead of TagId to identify the tag (exact match).
Color	string	Display color of the tag as a CSS color string (e.g. '#ff0000' or 'red'). Required on create.

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

Tag

Order tag entity. Tags are colored labels applied to orders for visual grouping and filtering. TagId 1 (Ready To Ship) and TagId 2 (Hold) are system tags and cannot be deleted. Use /OrderTags to apply or remove tags from orders.

Property	Type	Description	Constraints
TagId	integer	Unique tag identifier. On create, omit to auto-assign. On update/delete, provide to identify the tag (alternative to TagName).	Minimum: 1
TagName	string	Display name of the tag. Must be unique. Required on create. On update/delete, may be used instead of TagId to identify the tag (exact match).
Color	string	Display color of the tag as a CSS color string (e.g. '#ff0000' or 'red'). Required on create.

POST Response - 200

TagOperationResult

Result of a single tag create, update, or delete operation. Status is Success, Failure, or NotFound. Message contains a human-readable description of the outcome or error.

Property	Type	Description	Constraints
TagId	integer	The TagId of the affected tag. For create operations, this is the newly assigned ID.	Required
Status	string	Outcome of the operation: Success = completed successfully; Failure = error occurred (see Message); NotFound = no tag matched the given TagId or TagName.	RequiredOne of: Success, Failure, NotFound
Message	string	Human-readable description of the outcome. Always present on Failure and NotFound; also present on Success.

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

PUT Request

Tag

Order tag entity. Tags are colored labels applied to orders for visual grouping and filtering. TagId 1 (Ready To Ship) and TagId 2 (Hold) are system tags and cannot be deleted. Use /OrderTags to apply or remove tags from orders.

Property	Type	Description	Constraints
TagId	integer	Unique tag identifier. On create, omit to auto-assign. On update/delete, provide to identify the tag (alternative to TagName).	Minimum: 1
TagName	string	Display name of the tag. Must be unique. Required on create. On update/delete, may be used instead of TagId to identify the tag (exact match).
Color	string	Display color of the tag as a CSS color string (e.g. '#ff0000' or 'red'). Required on create.

PUT Response - 200

TagOperationResult

Result of a single tag create, update, or delete operation. Status is Success, Failure, or NotFound. Message contains a human-readable description of the outcome or error.

Property	Type	Description	Constraints
TagId	integer	The TagId of the affected tag. For create operations, this is the newly assigned ID.	Required
Status	string	Outcome of the operation: Success = completed successfully; Failure = error occurred (see Message); NotFound = no tag matched the given TagId or TagName.	RequiredOne of: Success, Failure, NotFound
Message	string	Human-readable description of the outcome. Always present on Failure and NotFound; also present on Success.

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

Tag Delete

Request body for DELETE /Tag. Deletes a single tag. Provide either TagId or TagName (not both). Deletion is blocked if the tag is assigned to any orders. System tags (TagId 1 = Ready To Ship, TagId 2 = Hold) cannot be deleted.

Property	Type	Description	Constraints
TagId	integer	ID of the tag to delete
TagName	string	Name of the tag to delete (exact match)

DELETE Response - 200

TagOperationResult

Result of a single tag create, update, or delete operation. Status is Success, Failure, or NotFound. Message contains a human-readable description of the outcome or error.

Property	Type	Description	Constraints
TagId	integer	The TagId of the affected tag. For create operations, this is the newly assigned ID.	Required
Status	string	Outcome of the operation: Success = completed successfully; Failure = error occurred (see Message); NotFound = no tag matched the given TagId or TagName.	RequiredOne of: Success, Failure, NotFound
Message	string	Human-readable description of the outcome. Always present on Failure and NotFound; also present on Success.

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