KYkyckr
Orders

Get List of Orders

Changed on

List all orders

get/orders

Request

Query parameters

startDatestring

Earliest date to fetch orders for in ISO-8601

endDatestring

Latest date to fetch orders for in ISO-8601

isoCodestring

Jurisdiction code in ISO 3166 alpha-2

Response

OK

orderIdstring

The related orderId.

correlationIdstring

The related correlationId to this request, for support purposes.

customerReferencestring

A customer provided reference, which appears in the order list.

timeStampstring date-time

The UTC time at which the request occurred.

detailsstring

The response status details for the current request.

Example response

{
  "orderId": "12345",
  "cost": {
    "type": "credit",
    "value": 3
  },
  "links": {
    "self": "/orders/12345"
  },
  "data": [
    {
      "orderId": 12345,
      "orderDate": "2023-01-01T00:00:00Z",
      "cost": {
        "type": "credit",
        "value": 3
      },
      "user": "/users/12345",
      "productDetails": {
        "productName": "Annual Accounts 2021-22",
        "productId": "PROD-DOC-000001",
        "productCategory": "Financial Information"
      },
      "companyDetails": {
        "companyName": "Kyckr Limited",
        "companyNumber": "R123456",
        "kyckrID": "IE|UjEyMzQ1Ng=="
      },
      "links": {
        "data": "/orders/12345/download?format=json",
        "document": "/orders/12345/download?format=pdf"
      }
    }
  ]
}

Changes

  • 43819cfabfedRevision changes
    • breaking

      the / response's property type changed from number to string for status

    • breaking

      the / response's property type changed from number to string for status

    • breaking

      the / response's property type changed from number to string for status

    • breaking

      the / response's property type changed from number to string for status

    • breaking

      the / response's property type changed from number to string for status

    • breaking

      the /// response's property type changed from string to integer for status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • info

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