Ctrlk
Order DeskSystem StatusLog in
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Making Requests

The Order Desk API accepts and returns JSON. Send Content-Type: application/json with requests that include a JSON body.

To avoid receiving 400 responses from our API, please ensure all requests follow the valid HTTP/1.x specification (RFC 7231). Some common invalid examples include:

  • Sending Content-Length or Content-Type headers during GET requests

  • Sending a request body with a GET request

  • Sending CONNECT, TRACE, or PATCH requests

  • Sending an invalid Host header

Updating Resources

Order and inventory update operations behave like replacements rather than merges.

You must pass the complete resource, as any parts left out will be updated as blank. To change a single field, retrieve the current record, modify that field in the response you received, and submit the complete record.

Method Override

The API documents update operations as PUT. Legacy clients that cannot issue PUT can send POST with the following header:

X-HTTP-Method-Override: PUT

Dates

Unless an endpoint explicitly says it uses store-local time, dates are UTC and use this format:

YYYY-MM-DD HH:MM:SS

Several order search filters have _local variants that use your store's local time instead. These are noted on the operations that accept them.