Retrieve Order List

Request

Query Params

limit

integer

optional

Number of maximum records given. More info pagination

Default:

100

offset

integer

optional

Number of records to be skipped. More info pagination

Default:

0

filter

string

optional

Filter the dataset. More info filtering

sort

string

optional

Sorting the dataset. More info sorting

show

string

optional

Show only specific properties from the response. More info show & hide

hide

string

optional

Hide properties from the response. More info show & hide

with

string

optional

Object(s) included in the dataset. More info eager loading

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

curl --location --request GET 'https://api.vplan.com/v1/order?limit=100&offset=0&filter=&sort=&show=&hide=&with=' \
--header 'x-api-key;' \
--header 'x-api-env;'

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 (Order) {26}]

optional

Items

id

string <uuid>

read-onlyoptional

Unique identifier

project_id

string <uuid> | null

optional

<= 36 characters

Default:

NULL

warehouse_id

string <uuid> | null

optional

<= 36 characters

Default:

NULL

relation_id

string <uuid> | null

optional

<= 36 characters

Default:

NULL

item_id

string <uuid> | null

optional

<= 36 characters

Default:

NULL

address_id

string <uuid> | null

optional

<= 36 characters

Default:

NULL

collection_id

string <uuid>

optional

Unique identifier of the Collection

meta

object | null

optional

transaction

string | null

optional

<= 36 characters

Default:

NULL

code

string

optional

<= 100 characters

type

enum<string> | enum<null>

optional

Allowed values:

ProductionProjectPurchaseQuotationSales

sub_type

string | null

optional

<= 25 characters

Default:

NULL

status

string | null

optional

<= 10 characters

Default:

NULL

note

string | null

optional

<= 65535 characters

Default:

NULL

description

string

optional

<= 150 characters

Default:

NULL

contact

string | null

optional

<= 100 characters

Default:

NULL

date

string <date> | null

optional

Default:

NULL

promised_date

string <date> | null

optional

Default:

NULL

desired_date

string <date> | null

optional

Default:

NULL

delivered_date

string <date> | null

optional

Default:

NULL

quantity

number | null

optional

Default:

NULL

relation_ref

string | null

optional

<= 255 characters

Default:

NULL

external_url

string | null

optional

<= 2048 characters

Default:

NULL

external_ref

string | null

read-onlyoptional

Third-party reference of the object, for informational purposes only

Example:

fb1033a2ed70

created_at

string <date-time>

read-onlyoptional

Date and time of creation

Example:

2024-04-11T10:22:15Z

updated_at

string <date-time>

read-onlyoptional

Date and time of last update

Example:

2024-04-11T10:22:15Z

Example

{
    "count": 1,
    "limit": 100,
    "offset": 0,
    "data": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "project_id": "NULL",
            "warehouse_id": "NULL",
            "relation_id": "NULL",
            "item_id": "NULL",
            "address_id": "NULL",
            "collection_id": "4bdef85c-3f50-4006-a713-2350da665f80",
            "meta": {},
            "transaction": "NULL",
            "code": "string",
            "type": "Production",
            "sub_type": "NULL",
            "status": "NULL",
            "note": "NULL",
            "description": "NULL",
            "contact": "NULL",
            "date": "NULL",
            "promised_date": "NULL",
            "desired_date": "NULL",
            "delivered_date": "NULL",
            "quantity": "NULL",
            "relation_ref": "NULL",
            "external_url": "NULL",
            "external_ref": "fb1033a2ed70",
            "created_at": "2024-04-11T10:22:15Z",
            "updated_at": "2024-04-11T10:22:15Z"
        }
    ]
}

🟠404Not Found

🟠401Not Logged In