Skip to main content
GET
/
core
/
filing
/
order-status
/
{orderedWithin}
Order Status
curl --request GET \
  --url https://rest.kyckr.com/core/filing/order-status/{orderedWithin} \
  --header 'Authorization: <api-key>'
[
  {
    "aVAILABLEField": 1,
    "aWAITING_DELIVERYField": 0,
    "dELIVERY_ERRORField": 0,
    "accountIdField": 0,
    "nodeIdField": "GBR_1000",
    "orderDateTimeField": "2021-01-15T16:05:27.927",
    "orderReferenceField": "",
    "productIdField": "",
    "descriptionField": "Company Profile / KYCKR LIMITED / €2.35 / United Kingdom",
    "productOrderIdField": 10818754,
    "replyDateTimeField": null,
    "sentToClientField": false,
    "statusField": 3,
    "urlField": "https://data.kyckr.com/8010gdsg4848484",
    "userIdField": null,
    "formatField": ""
  },
  {
    "aVAILABLEField": 1,
    "aWAITING_DELIVERYField": 0,
    "dELIVERY_ERRORField": 0,
    "accountIdField": 0,
    "nodeIdField": "GBR_1000",
    "orderDateTimeField": "2021-01-14T16:50:17.57",
    "orderReferenceField": "",
    "productIdField": "",
    "descriptionField": "CH_OfficialProfile_2 / Doe, John / €1.09 / United Kingdom",
    "productOrderIdField": 10816797,
    "replyDateTimeField": null,
    "sentToClientField": false,
    "statusField": 3,
    "urlField": "https://data.kyckr.com/105844dsfd8",
    "userIdField": null,
    "formatField": ""
  },
  {
    "aVAILABLEField": 1,
    "aWAITING_DELIVERYField": 0,
    "dELIVERY_ERRORField": 0,
    "accountIdField": 0,
    "nodeIdField": "GBR_1000",
    "orderDateTimeField": "2021-01-13T18:11:04.087",
    "orderReferenceField": "",
    "productIdField": "",
    "descriptionField": "CH_OfficialProfile_2 / Doe, John, Franky / €1.09 / United Kingdom",
    "productOrderIdField": 10815404,
    "replyDateTimeField": null,
    "sentToClientField": false,
    "statusField": 3,
    "urlField": "https://data.kyckr.com/124719gfdsg4854840",
    "userIdField": null,
    "formatField": ""
  }
]

Authorizations

​
Authorization
string
header
required

Path Parameters

​
orderedWithin
integer
required

This is the number of days you wish to go back to retrieve products. Maximum number of days is 30 and minimum is 0 (which means today).

Required range: 0 <= x <= 30

Response

200 - application/json

In this example, we a retrieving a list of products we have has ordered in the last 30 days. In the request parameters, we have entered 30 as the OrderedWithin and our API access token as the request header.

​
aVAILABLEField
number
deprecated
​
aWAITING_DELIVERYField
number
deprecated
​
dELIVERY_ERRORField
number
deprecated
​
accountIdField
number
deprecated
​
nodeIdField
string
deprecated
​
orderDateTimeField
string
​
orderReferenceField
string
​
partIdField
string
​
productIdField
string
​
descriptionField
string
​
productOrderIdField
number
​
sentToClientField
boolean
deprecated
​
statusField
enum<number>

Order status (see related guide)

Available options:
1,
2,
3,
5,
9,
21
​
urlField
string<uri>
​
structuredDataUrlField
string<uri>
​
formatField
string
deprecated
​
companyNameField
string
​
companyNumberField
string