Get Incoming Orders

get

https://api.apicbase.com/api/v2/procurement/incoming_orders/

Returns a list of incoming orders for a supplier outlet.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Ordering options

The following values can be used in the ordering query parameter to sort results: control_number, ordered_on, received_on, and sent_on. To sort the results in descending order, prepend each parameter with a -.

Query Params

page

int32

A page number within the paginated result set.

ordering

string

A field to order results by.

supplier_outlet

string

Filter by the internal supplier outlet ID fulfilling the order.

ordering_outlet

string

Filter by the outlet ID that placed the original purchase order.

control_number

string

Filter on an exact order number.

control_number__contains

string

Filter on a order number containing the specified string.

po_number

string

Defaults to Filter on an exact purchase order number.

po_number__contains

string

Filter on a purchase order number containing the specified string.

status

string

enum

Filter by incoming order status.

Allowed:

status__in

array of strings

Filter by multiple incoming order statuses. Comma-separated values.

status__in

ordered_by

string

Filter by the user ID who ordered the original purchase order.

delivery_closed

string

Filter on orders that are or are not accepting more deliveries.

ordered_on

string

Filter on the exact 'ordered on' date of the purchase order.

ordered_on__gt

string

Filter orders where the purchase order's 'ordered on' date is after the specified date.

ordered_on__lt

string

Filter orders where the purchase order's 'ordered on' date is before the specified date.

received_on

string

Filter on the exact 'received_on' date of the purchase order.

received_on__gt

string

Filter orders where the purchase order's 'received_on' date is after the specified date.

received_on__lt

string

Filter orders where the purchase order's 'received_on' date is before the specified date.

expected_delivery_date

string

Filter on the exact expected delivery date of the purchase order.

expected_delivery_date__gt

string

Filter orders where the purchase order's expected delivery date is after the specified date.

expected_delivery_date__lt

string

Filter orders where the purchase order's expected delivery date is before the specified date.

discount

string

Filter on the exact discount amount of the purchase order.

discount__gt

string

Filter orders where the purchase order's discount is greater than the specified amount.

discount__lt

string

Filter orders where the purchase order's discount is less than the specified amount.

sent_by

string

Filter by the user ID who sent the order.

sent_on

string

Filter on the exact 'sent on' date of the order.

sent_on__gt

string

Filter orders where the 'sent on' date is after the specified date.

sent_on__lt

string

Filter orders where the 'sent on' date is before the specified date.

has_updated_stock

string

Filter on whether the order has updated stock when sent.

Responses

Language

Credentials

OAuth2

Loading…

Response

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

application/json

Ordering options

200200

400400