Get Supplier Ordering Details

Returns a list of the supplier's ordering details per outlet.

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

Each result covers one outlet and carries its delivery schedule, minimum order amount, standard delivery fee, customer numbers, supplier email addresses and order approval settings.

This endpoint accepts OAuth access tokens only, as described in Authentication. A v1 API token (Authorization: Token ...) is refused with 401.

order_approval_enabled, daily_order_threshold and approver_roles are returned to every library with their stored values, whether or not it has the Order Approval module. When enabled with a threshold, they take precedence over the supplier's settings for that outlet.

Path Params
integer
required

A supplier ID.

Query Params
string

Filter by outlet name (case-insensitive partial match)

integer

Filter by specific outlet ID

boolean

Filter by linked status

boolean

Filter by whether outlet accepts deliveries all days

custom_fields
object

Filter by custom outlet fields

string

Sort results. Options: outlet__name, outlet__apic_id, minimum_order_amount (prefix with - for descending)

int32

A page number within the paginated result set

Responses

400

Bad Request - Validation errors

401

The request was not authenticated with an OAuth access token. A v1 API token (Authorization: Token ...) is refused here.

403

Forbidden - User lacks manage_procurement permission

404

Not Found - Supplier does not exist

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