Order Management API (1.0)

The Order Management API is a simple API that allows you to search for orders or update the status of an order

Common Authorization Parameters

Each request is authorized using username and password fields passed either as query parameters (for GET/POST operations) or part of the application/x-www-form-urlencoded body (for POST operations).

Error Codes

Each response contains a response_status field containing the following error codes.

Code Severity Description
10001 SUCCESS
30001 ERROR Authentication failed
31000 ERROR API not enabled on your site
40004 WARNING Product ID Not Found
50002 ERROR No conditions specified
50003 ERROR Condition N 'field' is missing
50003 ERROR Condition N 'condition' is missing
50003 ERROR date1 is invalid
50003 ERROR date2 is invalid

Order Search

Retrieve a list of orders based upon your search parameters. The maximum number of rows returned is 100. Use the returned "total" value to determine if you need to paginate using the offset parameter.
You can specify multiple conditions in which case the conditions will be joined with a logical 'AND'.
To use multiple conditions you will need to pass the parameters using the multi condition parameter format:

conditions[n][parameter name]

where n starts at 1 and "parameter name" is the name of the parameter as below.

Request Body schema: application/x-www-form-urlencoded
field
required
integer

The Field the condition is tested against.
Multi condition parameter format: conditions[n][field]

Values

  • 1: Date Ordered
  • 2: Date Production Files Ready
  • 3: Invoice Number
  • 4: Order Status
  • 5: Date Due
  • 6: Date Invoiced
  • 7: Date Shipped
  • 8: Date Modified
condition
required
integer

The logical test to use.
Multi condition parameter name: conditions[n][condition]

Values

  • 1: ==
  • 2: !=
  • 3: <
  • 4: >
  • 5: <=
  • 6: >=
  • 7: Between
date1
string

The date to test against (Required when field is Date Ordered or Date Production Files Ready).
The date is in ISO-8601 date format in UTC timezone (YYYY-MM-DDTHH:MM:SS).
Multi condition parameter name: conditions[n][date1]

date2
string

The end date to test against (Required when field is Date Ordered or Date Production Files Ready and condition is 7: Between).
The date is in ISO-8601 date format in UTC timezone (YYYY-MM-DDTHH:MM:SS).
Multi condition parameter name: conditions[n][date2]

string
string

The string to test against (Required when field is Invoice Number). Multi condition parameter name: conditions[n][string]

limit
integer [ 0 .. 100 ]
Default: 100

Limit the number of results returned. The maximum limit is 100

offset
integer
Default: 0

Offset of the results to allow pagination

sortby
integer
Default: 2

What field to sort the results by
Values

  • 1: Date Ordered
  • 2: Date Production Files Ready
  • 3: Invoice Number
  • 4: Order Status
  • 5: Date Due
  • 6: Date Invoiced
  • 7: Date Shipped
  • 8: Date Modified
include_workflow_data
integer
Default: 0

Include workflow information used to track items going through the production workflow. Set to 1 to include workflow information.

include_po_data
integer
Default: 0

Include purchase order information associated with the above workflow information. This will make workflow information be included.Set to 1 to include purchase order information.

include_shipments
integer
Default: 0

Include shipment information. Set to 1 to include shipment information.

include_production_file_info
integer
Default: 0

Include production file information. Set to 1 to include information about the format and offsets/cropping of the production files.

skip_login_token
integer
Default: 0

Don't add the user login token to document download urls. Set to 1 to not add the user login token. The user's password can be added to the download document url instead of the token.

Responses

Request samples

Content type
application/x-www-form-urlencoded
field=2&condition=4&date1=2018-02-01T00%3A00%3A00

Response samples

Content type
application/json
{
  • "response_status": {
    },
  • "orders": [