Get Purchase Orders

Returns a list of all purchase orders in the library.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
🚧

This view is restricted for integrated suppliers.

Partner supplier applications who have access to this endpoint can only retrieve orders addressed to them. Normal users have access to the full list.

Order status

Adding items to your cart in Apicbase instantiates a purchase order, orders in this state can already be retrieved by this endpoint. A Purchase Order can have the following states:

  • IN_PROGRESS: the order is in the cart, and its items can still be edited.
  • ORDERED: the order has been sent to the supplier, delivery is expected.
  • DELIVERED: the order has been at least partially delivered. An order can have more than one delivery, and this state means that at least one has already taken place.

Additionally the delivery_closed status indicates whether deliveries are still expected for some Purchase Order. They are only in a true final state when delivery_closed is true. This value is always false for orders in an IN_PROGRESS or ORDERED state.

👍

An order does not need to be complete to be closed.

Being closed is not an indication that the order was completely fulfilled. Orders can be partially fulfilled, and they can also have delivered items beyond the ones that were ordered.

Invoice status values

The invoice_status attribute can have these values, with these meanings:

ValueDescription
0Not yet received
1Received
2Payable
3Paid

Viewed and fetched by supplier

The "viewed by supplier" date is set when a supplier opens the email sent by Apicbase, or in the case of integrated suppliers, by a trigger defined by themselves.

The "fetched by supplier" date is only set by integrated suppliers retrieving POs via our API, and indicates when the order was fetched by their system.

Query Params
int32

A page number within the paginated result set.

string

A field to order results by.

string

Filter on a supplier ID.

string

Filter on an outlet ID.

string

Filter on an order number. Only queries exact matches.

string

Filter on an order number. Queries partial matches on this field.

string

A user ID.

string
enum

Filter on a status.

Allowed:
status__in
array of strings

Filter on multiple status.

status__in
boolean

Filter on orders that are or are not accepting more deliveries. When true, no more deliveries are expected.

date

Filter on the order's ordered on date.

date

Filter on the order's ordered on date (greater than).

date

Filter on the order's ordered on date (lower than).

date

Filter on the order's expected delivery date.

date

Filter on the order's expected delivery date (greater than).

date

Filter on the order's expected delivery date (lower than).

float

Filter on a discount amount (exact).

float

Filter on a discount amount (greater than).

float

Filter on a discount amount (lower than).

string

Filter on an invoice number

string
enum

Filter on an invoice status.

Allowed:
boolean

Filter on orders that have/have not been viewed by the supplier.

date

Filter on the order's viewed by supplier date.

date

Filter on the order's viewed by supplier date (greater than).

date

Filter on the order's viewed by supplier date (lower than).

boolean

Filter on orders that have/have not been fetched by the supplier.

date

Filter on the order's fetched by supplier date.

date

Filter on the order's fetched by supplier date (greater than).

date

Filter on the order's fetched by supplier date (lower than).

Response

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json