Retrieve OrderRow List

Request

Path Params

order_id

string

required

Query Params

sort

string

optional

field(s) for sorting the dataset, see sorting for more info

Example:

updated_at:desc,id

limit

integer

optional

maximum number of records given, see pagination for more info

>= 1

Default:

100

Example:

100

offset

integer

optional

the number of records to be skipped, see pagination for more info

>= 0

Default:

0

Example:

0

filter

string

optional

used to filter the dataset, see filtering for more info

Example:

created_at:gt:2020-09-26,and,(id:not:starts_with:0000,or,id:contains:FFFF)

show

string

optional

limit the response to show only specific properties, see show & hide for more info

Example:

id,updated_at

hide

string

optional

hide properties from the response, see show & hide for more info

Example:

created_at,updated_at

Header Params

x-api-key

string

required

Default:

x-api-env

string

required

Default:

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200Ok

application/json

Body

count

integer <uint64>

optional

Total amount of items

>= 0

Default:

1

limit

integer <uint64>

optional

Max amount of items fetched

>= 0<= 1000

Default:

100

offset

integer <uint64>

optional

Offset so items may be paginated

>= 0

Default:

0

data

array[object (OrderRow) {22}]

optional

Items

id

string <uuid>

read-onlyoptional

code

string | null

optional

<= 50 characters

Default:

NULL

description

string

optional

<= 150 characters

order_id

string <uuid> | null

optional

item_id

string <uuid> | null

optional

activity_id

string <uuid> | null

optional

transaction

string | null

optional

<= 36 characters

Default:

NULL

position

integer | null

optional

>= 0<= 4294967296

type

string | null

optional

<= 50 characters

Default:

NULL

unit

string

optional

<= 50 characters

item_code

string | null

optional

<= 50 characters

Default:

NULL

reserved

number | null

optional

Default:

NULL

quantity

number | null

optional

Default:

NULL

quantity_delivered

number | null

optional

Default:

NULL

quantity_backorder

number | null

optional

Default:

NULL

quantity_original

number | null

optional

Default:

NULL

status

string | null

optional

<= 32 characters

Default:

NULL

delivered_date

string <date>

optional

Default:

NULL

resource_ref

string | null

optional

<= 64 characters

Default:

NULL

external_ref

string | null

optional

<= 64 characters

Default:

NULL

created_at

string <date-time>

read-onlyoptional

Date and time of creation

Default:

NULL

updated_at

string <date-time>

read-onlyoptional

Date and time of last update

Default:

NULL

Example

{
  "count": 1,
  "limit": 100,
  "offset": 0,
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "code": "NULL",
      "description": "string",
      "order_id": "93101167-9065-4b9c-b98b-5d789a3ed9fe",
      "item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c",
      "activity_id": "98dae057-958f-4b2f-9ed4-41f109afdc3f",
      "transaction": "NULL",
      "position": 0,
      "type": "NULL",
      "unit": "string",
      "item_code": "NULL",
      "reserved": "NULL",
      "quantity": "NULL",
      "quantity_delivered": "NULL",
      "quantity_backorder": "NULL",
      "quantity_original": "NULL",
      "status": "NULL",
      "delivered_date": "NULL",
      "resource_ref": "NULL",
      "external_ref": "NULL",
      "created_at": "NULL",
      "updated_at": "NULL"
    }
  ]
}

🟠404Not Found

🟠401Not Logged In