Orders
This page provides a description of the available API routes for managing orders.
Last updated
Was this helpful?
This page provides a description of the available API routes for managing orders.
Last updated
Was this helpful?
After each ticket update, orders are automatically generated. Each order includes contextual information about the products and specifies the order endpoint where the products will be processed.
Order is represented by class.
GET http://{server-address}/orders
Returns all orders that matches query parameters. Result is of type .
deviceName
string
Supports NData syntax.
$skip
int
Pagination property. Describing number of records to skip from beginning of result collection.
$take
int
Pagination property. Maximum count of items to be returned.
$sort
string[]
Comma separated list of property names. Please see NData syntax.
$count
bool
If set to true, response will not contain items collection. Use to get resource count, not the resources themselves.
id
string
Supports NData syntax.
number
int
Supports NData syntax.
ticketId
string
Supports NData syntax.
ticketName
string
Supports NData syntax.
userUserName
string
Supports NData syntax.
isProcessed
bool
Supports NData syntax.
isProcessable
bool
Supports NData syntax.
Authorization*
string
Authorization header with authorization token.
GET http://{server-address}/orders/{id}
id*
string
Unique order identifier.
Authorization*
string
Authorization header with authorization token.
POST http://{server-address}/orders
Required rights
Authorization*
string
Authorization header with authorization token.
(body)*
ProcessOrdersContext
Conext to specify order processing.
POST http://{server-address}/orders/{id}/status
Required rights
id*
string
Order unique identifier
Authorization*
string
Authorization header with authorization token.
(body)*
OrderStatusContext
POST http://{server-address}/orders/{id}/items/{itemId}/status
Required rights
id*
string
Order unique identifier
itemId*
int
Order item identifier
Authorization*
string
Authorization header with authorization token.
(body)
OrderStatusContext
POST http://{server-address}/orders/{id}/endpoints/{endpointName}/status
Required rights
id*
string
Order unique identifier
endpointName*
string
Order endpoint name
Authorization*
string
Authorization header with authorization token.
(body)
OrderStatusContext
DELETE http://{server-address}/orders/{id}
Required rights
id*
string
Unique order identifier.
Authorization*
string
Authorization header with authorization token.
Result is of type .
Invokes order processing. Method accepts in request body, that is used to specify orders to be processed, using identifiers. Collection of all affected models is returned.
Authorized user must have OrderProcess assigned.
Manually changes status for entire order (for all items and all associated order endpoints). Method accepts in request body. Updated is returned.
Authorized user must have OrderUpdate assigned.
Manually changes order status for specified . Status is set for all associated with given order item. Method accepts in request body. Updated is returned.
Authorized user must have OrderUpdate assigned.
Manually change the order status for a specified on a specific . Method accepts in request body. Updated is returned.
Authorized user must have OrderUpdate assigned.
Authorized user must have OrderDelete assigned.