Sales orders

List sales orders

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

Sales orders represent a customer's intention to purchase goods or services from the SMB.

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

get/companies/{companyId}/data/salesOrders

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

Success

pageNumberinteger required

Current page number.

pageSizeinteger required

Number of items to return in results array.

totalResultsinteger required

Total number of items.

_linksLinks required— unresolved $ref

Example response

{
  "pageNumber": 1,
  "pageSize": 10,
  "totalResults": 1,
  "_links": {
    "self": {
      "href": "/companies/{id}/data/{dataType}"
    },
    "current": {
      "href": "/companies/{id}/data/{dataType}?page=1&pageSize=10"
    }
  }
}

Changes

Changed in 2 of the 51 revisions of this API.39

Feb 13, 20244bfab0afa6ca9See the full diff
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
Jan 8, 20240fcc5f736d863See the full diff
- ●
  added the new customers enum value to the ///////// response property for the response status
  response-property-enum-value-added
- ●
  added the new suppliers enum value to the ///////// response property for the response status
  response-property-enum-value-added
- ●
  added the new trackingCategories enum value to the ///////// response property for the response status
  response-property-enum-value-added

Full history