List of orders

get

https://app-staging.b2brouter.net/projects/{account}/orders.{format}

Returns a paginated list of the submitted orders of the company

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

account

string

required

Account identifier (ID)

format

string

enum

required

Format

The format of the API response can be either JSON or XML.

Allowed:

Query Params

offset

integer

Defaults to 0

Jump to the first object.

limit

integer

Defaults to 25

Number of items in the response (500 maximum)

number

string

Filter on order number.

filename

string

Name of the attachment.

delivery_location_id

integer

Filtered by delivery_location_id.

client

string

Search field. Searches on the customer name and VAT code.

sel_data

string

enum

Filter on submission date options.

Allowed:

date_from

date

Filter from submission order date.

date_to

date

Filter to submission order date.

country

string

Search field. Searches on the country code.

delivery_confirmed

integer

enum

0 to 1

Filter on order status "delivery confirmed".

Allowed:

closed

integer

enum

0 to 1

Filter on order status "closed".

Allowed:

accepted

integer

enum

0 to 1

Filter on order status "accepted".

Allowed:

refused

integer

enum

0 to 1

Filter on order status "refused".

Allowed:

received

integer

enum

0 to 1

Filter on order status "received".

Allowed:

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

403

Forbidden

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/xml

200Successful operation