Queue

Queue is like a folder that orders are organized into. A queue uniquely map to one warehouse, and has a default shipping profile.

GET POST PUT DELETE

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

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

GET Request

Query parameters

Property	Type	Description	Constraints
QueueId	integer	Filter by queue ID (exact match). Use to look up a specific queue by its numeric ID.
QueueName	string	Case-insensitive substring search on queue name. Returns all queues whose name contains this string.
WarehouseId	integer	Filter by warehouse ID (exact match). Returns all queues assigned to that warehouse (FK to /Warehouse).
WarehouseName	string	Filter by warehouse name (exact match). Alternative to WarehouseId: returns all queues assigned to the warehouse with this name.
ProfileId	integer	Filter by shipping profile ID (exact match). Returns all queues using that shipping profile (FK to /ShippingProfile).
ProfileName	string	Filter by shipping profile name (exact match). Alternative to ProfileId: returns all queues using the profile with this name.

GET Response - 200

Queue Get Response

Response to GET /Queue. Contains a list of order queues matching the query filters, ordered by QueueSeq then QueueId.

Property	Type	Description	Constraints
Queues	Order Queue[]	List of order queues matching the query filters. Empty array if none match.	Required

Order Queue

Order queue — groups orders by warehouse and shipping profile. Each queue has a WarehouseId (FK: warehouse.warehouse_id) and a ProfileId (FK: shipping_profile.id). The shipping table references queue_id.

Property	Type	Description	Constraints
QueueId	integer	Unique queue identifier. QueueIds 1-4 are built-in and cannot be deleted. QueueIds 1-2 also have immutable names. On create, omit to auto-assign (must be > 4 if provided). On update/delete, provide to identify the queue (alternative to QueueName).	Minimum: 1
QueueType	string	Purpose for the Queue. Controls how the queue is handled in the UI and workflow. Allowed values: DISPLAY, HOLD, PRINT, RETURN, 3PL and AGENT. DISPLAY QUEUE is the default and for every day use. HOLD queue are for orders not to be printed for now and we may block label print or submit to 3pl until orders are moved out. PRINT and 3PL are for orders ready to print shipping label or submit to external warehouses. RETURN are for return shipments from customers back. AGENT is desiged to hold orders where AI Agent will run automated processes based on Agent.md to further route and distribute the orders.	One of: DISPLAY, HOLD, AGENT, PRINT, RETURN, 3PL
QueueName	string	Display name for the order queue. Must be unique. Required on create. Immutable for QueueIds 1-2. On update/delete, may be used instead of QueueId to identify the queue (exact match).
WarehouseId	integer	Warehouse assigned to orders in this queue (FK to /Warehouse). Provide either WarehouseId or WarehouseName (not both). Defaults to 1 (default warehouse) if both are omitted on create.	Minimum: 1
WarehouseName	string	Warehouse name (exact match). Alternative to WarehouseId: provide either WarehouseId or WarehouseName (not both). Use GET /Warehouse to find valid warehouse names. Input-only field — not returned in GET responses.
ProfileId	integer	Shipping profile used for label printing in this queue (FK to /ShippingProfile). Provide either ProfileId or ProfileName (not both). Defaults to 1 (default profile) if both are omitted on create.	Minimum: 1
ProfileName	string	Shipping profile name (exact match). Alternative to ProfileId: provide either ProfileId or ProfileName (not both). Use GET /ShippingProfile to find valid profile names. Input-only field — not returned in GET responses.
AgentInstructions	string	Markdown instructions / Agent.md for the AGENT queue on how to process the orders. Ignored and not returned for all other queue types.
AdditionalProfiles	integer[]	Additional shipping profile IDs for this queue (stored in queue_profile table). Each profile ID must exist in shipping_profile table. Returns empty array if no additional profiles.

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 Queue

Order queue — groups orders by warehouse and shipping profile. Each queue has a WarehouseId (FK: warehouse.warehouse_id) and a ProfileId (FK: shipping_profile.id). The shipping table references queue_id.

Property	Type	Description	Constraints
QueueId	integer	Unique queue identifier. QueueIds 1-4 are built-in and cannot be deleted. QueueIds 1-2 also have immutable names. On create, omit to auto-assign (must be > 4 if provided). On update/delete, provide to identify the queue (alternative to QueueName).	Minimum: 1
QueueType	string	Purpose for the Queue. Controls how the queue is handled in the UI and workflow. Allowed values: DISPLAY, HOLD, PRINT, RETURN, 3PL and AGENT. DISPLAY QUEUE is the default and for every day use. HOLD queue are for orders not to be printed for now and we may block label print or submit to 3pl until orders are moved out. PRINT and 3PL are for orders ready to print shipping label or submit to external warehouses. RETURN are for return shipments from customers back. AGENT is desiged to hold orders where AI Agent will run automated processes based on Agent.md to further route and distribute the orders.	One of: DISPLAY, HOLD, AGENT, PRINT, RETURN, 3PL
QueueName	string	Display name for the order queue. Must be unique. Required on create. Immutable for QueueIds 1-2. On update/delete, may be used instead of QueueId to identify the queue (exact match).
WarehouseId	integer	Warehouse assigned to orders in this queue (FK to /Warehouse). Provide either WarehouseId or WarehouseName (not both). Defaults to 1 (default warehouse) if both are omitted on create.	Minimum: 1
WarehouseName	string	Warehouse name (exact match). Alternative to WarehouseId: provide either WarehouseId or WarehouseName (not both). Use GET /Warehouse to find valid warehouse names. Input-only field — not returned in GET responses.
ProfileId	integer	Shipping profile used for label printing in this queue (FK to /ShippingProfile). Provide either ProfileId or ProfileName (not both). Defaults to 1 (default profile) if both are omitted on create.	Minimum: 1
ProfileName	string	Shipping profile name (exact match). Alternative to ProfileId: provide either ProfileId or ProfileName (not both). Use GET /ShippingProfile to find valid profile names. Input-only field — not returned in GET responses.
AgentInstructions	string	Markdown instructions / Agent.md for the AGENT queue on how to process the orders. Ignored and not returned for all other queue types.
AdditionalProfiles	integer[]	Additional shipping profile IDs for this queue (stored in queue_profile table). Each profile ID must exist in shipping_profile table. Returns empty array if no additional profiles.

POST Response - 200

QueueOperationResult

Result of a single queue 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
QueueId	integer	The QueueId of the affected queue. 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 queue matched the given QueueId or QueueName.	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

Order Queue

Order queue — groups orders by warehouse and shipping profile. Each queue has a WarehouseId (FK: warehouse.warehouse_id) and a ProfileId (FK: shipping_profile.id). The shipping table references queue_id.

Property	Type	Description	Constraints
QueueId	integer	Unique queue identifier. QueueIds 1-4 are built-in and cannot be deleted. QueueIds 1-2 also have immutable names. On create, omit to auto-assign (must be > 4 if provided). On update/delete, provide to identify the queue (alternative to QueueName).	Minimum: 1
QueueType	string	Purpose for the Queue. Controls how the queue is handled in the UI and workflow. Allowed values: DISPLAY, HOLD, PRINT, RETURN, 3PL and AGENT. DISPLAY QUEUE is the default and for every day use. HOLD queue are for orders not to be printed for now and we may block label print or submit to 3pl until orders are moved out. PRINT and 3PL are for orders ready to print shipping label or submit to external warehouses. RETURN are for return shipments from customers back. AGENT is desiged to hold orders where AI Agent will run automated processes based on Agent.md to further route and distribute the orders.	One of: DISPLAY, HOLD, AGENT, PRINT, RETURN, 3PL
QueueName	string	Display name for the order queue. Must be unique. Required on create. Immutable for QueueIds 1-2. On update/delete, may be used instead of QueueId to identify the queue (exact match).
WarehouseId	integer	Warehouse assigned to orders in this queue (FK to /Warehouse). Provide either WarehouseId or WarehouseName (not both). Defaults to 1 (default warehouse) if both are omitted on create.	Minimum: 1
WarehouseName	string	Warehouse name (exact match). Alternative to WarehouseId: provide either WarehouseId or WarehouseName (not both). Use GET /Warehouse to find valid warehouse names. Input-only field — not returned in GET responses.
ProfileId	integer	Shipping profile used for label printing in this queue (FK to /ShippingProfile). Provide either ProfileId or ProfileName (not both). Defaults to 1 (default profile) if both are omitted on create.	Minimum: 1
ProfileName	string	Shipping profile name (exact match). Alternative to ProfileId: provide either ProfileId or ProfileName (not both). Use GET /ShippingProfile to find valid profile names. Input-only field — not returned in GET responses.
AgentInstructions	string	Markdown instructions / Agent.md for the AGENT queue on how to process the orders. Ignored and not returned for all other queue types.
AdditionalProfiles	integer[]	Additional shipping profile IDs for this queue (stored in queue_profile table). Each profile ID must exist in shipping_profile table. Returns empty array if no additional profiles.

PUT Response - 200

QueueOperationResult

Result of a single queue 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
QueueId	integer	The QueueId of the affected queue. 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 queue matched the given QueueId or QueueName.	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

Queue Delete

Request body for DELETE /Queue. Deletes a single order queue. Provide either QueueId or QueueName (not both). Deletion is blocked if the queue has active (unshipped) orders. Built-in queues (QueueId 1-4) cannot be deleted.

Property	Type	Description	Constraints
QueueId	integer	ID of the order queue to delete
QueueName	string	Name of the order queue to delete (exact match)

DELETE Response - 200

QueueOperationResult

Result of a single queue 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
QueueId	integer	The QueueId of the affected queue. 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 queue matched the given QueueId or QueueName.	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