Create Supplier

Creates a new supplier in the library.

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

You can edit the details of placing orders with a supplier using the Edit Supplier Ordering Details endpoint.

Order approval settings

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.

  • Without the module, a request that changes any of them is refused with 400, naming only the fields whose value differs from the stored one. Sending the stored values back is accepted, so a record that is read and written back whole goes through.
  • approver_roles is written as role IDs. It is read as role objects (id, name) and written as a list of their IDs, like a user connector's role. Sending the objects back is refused with 400.
  • Enabling needs a threshold. order_approval_enabled: true without a daily_order_threshold is refused with 400 on daily_order_threshold.
  • Roles are checked when written. Each one must belong to the library, be a library or outlet role and hold the Approve Orders permission; otherwise the request is refused with 400 on approver_roles, listing the rejected IDs.
Body Params
string
required

Supplier name

string

First name of the contact person

string

Last name of the contact person

supplier_email_list
array of strings

List of supplier email addresses

supplier_email_list
string

Tax/VAT number

string

Customer reference number

string

Internal supplier identifier

float
≥ 0

Standard delivery fee amount

string

Additional notes about the supplier

outlets
array of strings

List of outlet IDs linked to this supplier

outlets
boolean

Whether to attach CSV files on purchase orders

address
object

Supplier address information

boolean

Whether orders to this supplier are checked against daily_order_threshold. true needs a threshold.

string | null

A decimal amount with at most two decimals, from 0 to 9999999999.99, or null.

approver_roles
array of strings

The IDs of the roles to notify. Replaces the current selection; [] clears it, and leaving the key out keeps it. Each role must belong to the library, be a library or outlet role and hold the Approve Orders permission. Send the IDs, not the objects returned on read.

approver_roles
Responses

403

Forbidden - User lacks required permissions

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