KRkruzer-corp
orders

List orders

Changed on

Returns a paginated list of orders scoped to the caller account. A creation-date window (createdFrom/createdTo, ISO 8601, max 6 months apart) is required; status, channel filters, free-text search and sorting are optional.

get/api/v1/orders

Request

Query parameters

statusstring[]
channelIdstring[]
customerIdstring
createdFromstring required
createdTostring required
qstring
pagenumber
limitnumber
sortBystring
sortOrderstring

Response

Paginated list of orders.

Example response

{
  "meta": {
    "total": 42,
    "pages": 3,
    "current_page": 1,
    "next_page": 2,
    "limit": 20
  }
}

Changes

  • a3b4750a505fRevision changes
    • breaking

      added the new required query request parameter createdFrom

    • breaking

      added the new required query request parameter createdTo

    • info

      added the new optional query request parameter channelId

    • info

      added the new optional query request parameter customerId

    • info

      added the new optional query request parameter limit

    • info

      added the new optional query request parameter page

    • info

      added the new optional query request parameter q

    • info

      added the new optional query request parameter sortBy

    • info

      added the new optional query request parameter sortOrder

    • info

      added the new optional query request parameter status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

  • 84194c31ab85Revision changes
    • info

      endpoint added