Orders

List orders

The List orders endpoint returns a list of orders for a given company's connection.

Orders contain the transaction details for all products sold by the company.

Before using this endpoint, you must have retrieved data for the company.

get/companies/{companyId}/connections/{connectionId}/data/commerce-orders

Query parameters

pageinteger

Example:1

Page number. Read more.

pageSizeinteger

Example:100

Number of records to return in a page. Read more.

querystring

Codat query string. Read more.

orderBystring

Example:-modifiedDate

Field to order results by. Read more.

Response

Orders required— unresolved $ref

Changes

Changed in 9 of the 53 revisions of this API.520

Feb 13, 20248ba9a6a9b56a9See the full diff
- ○
  added the optional property validation to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property validation to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property validation to the response with the 402 status
  response-optional-property-added
- ○
  added the optional property validation to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property validation to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property validation to the response with the 409 status
  response-optional-property-added
- ○
  added the optional property validation to the response with the 429 status
  response-optional-property-added
- ○
  added the optional property validation to the response with the 500 status
  response-optional-property-added
- ○
  added the optional property validation to the response with the 503 status
  response-optional-property-added
Oct 23, 2023638d28ff67734See the full diff
- ○
  added the non-success response with the status 402
  response-non-success-status-added
- ○
  added the non-success response with the status 403
  response-non-success-status-added
- ○
  added the non-success response with the status 500
  response-non-success-status-added
- ○
  added the non-success response with the status 503
  response-non-success-status-added
Oct 17, 2023b278cc4896b41See the full diff
- ▲
  the allOf[subschema #1]/results/items/allOf[subschema #2]/ response's property type/format changed from object/ to / for status 200
  response-property-type-changed
Jul 4, 2023494a393d5cec1See the full diff
- ○
  added the optional property allOf[subschema #1]/results/items/allOf[subschema #2]/supplementalData to the response with the 200 status
  response-optional-property-added
May 31, 2023da0aba4733ac1See the full diff
- ○
  added the non-success response with the status 429
  response-non-success-status-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
May 25, 2023be0826c6d38f4See the full diff
- ○
  added the non-success response with the status 400
  response-non-success-status-added
- ○
  added the non-success response with the status 401
  response-non-success-status-added
- ○
  added the non-success response with the status 404
  response-non-success-status-added
- ○
  added the non-success response with the status 409
  response-non-success-status-added
May 19, 2023753db470ad5a1See the full diff
- ○
  the query request parameter page became optional
  request-parameter-became-optional
May 10, 2023e37fd02554a41See the full diff
- ▲
  for the query request parameter page, the min was increased from 0.00 to 1.00
  request-parameter-min-increased
May 4, 2023b0aafeb284723See the full diff
- ▲
  the response property allOf[subschema #1]/results/items/allOf[subschema #2]/customerRef/name became optional for the status 200
  response-property-became-optional
- ▲
  the response property allOf[subschema #1]/results/items/allOf[subschema #2]/orderLineItems/items/allOf[subschema #2]/productRef/name became optional for the status 200
  response-property-became-optional
- ▲
  the response property allOf[subschema #1]/results/items/allOf[subschema #2]/orderLineItems/items/allOf[subschema #2]/productVariantRef/name became optional for the status 200
  response-property-became-optional

Full history