GET
List supplier orders

Authorizations

x-api-key
string
header
required

Query Parameters

page
number
default:0

Page number, starting at 0.

per_page
number
default:10

Number of orders per page.

external_order_number
string

Returns orders whose external_order_number contains this value.

internal_order_number
string

Returns orders whose internal_order_number contains this value.

external_order_numbers
string[]

Returns orders whose external_order_number is exactly one of these values. Send it as a JSON array, e.g. ?external_order_numbers=["PO-001","PO-002"].

supplier_order_state_id
number[]

Returns orders in any of these states (see the states table). Send it as a JSON array, e.g. ?supplier_order_state_id=[1,2,4].

warehouse_code
string

Code of the destination warehouse. Ignored if no warehouse has this code.

Response

A page of supplier orders (can be empty).

data
object[]
meta
object

Pagination of this response. There is no total count.