Skip to main content
Supplier records let you link products to their source and keep contact details in one place. All supplier endpoints are scoped to a shop.

List suppliers

GET /api/v1/shops/{shop_id}/suppliers
Returns an array of SupplierOut objects.

Create a supplier

POST /api/v1/shops/{shop_id}/suppliers
string
required
Supplier’s business or trading name.
string
Name of the primary contact person at the supplier.
string
Supplier contact phone number.
string
Supplier contact email address.
string
Physical or mailing address for the supplier.
string
Free-text notes about this supplier (e.g. payment terms, delivery schedule).

Get a supplier

GET /api/v1/shops/{shop_id}/suppliers/{supplier_id}

Update a supplier

PATCH /api/v1/shops/{shop_id}/suppliers/{supplier_id} Send only the fields you want to change. Accepts the same fields as SupplierIn.

Delete a supplier

DELETE /api/v1/shops/{shop_id}/suppliers/{supplier_id}
Returns 204 No Content on success.

SupplierOut fields

integer
Unique supplier ID.
string
Supplier business name.
string
Primary contact person, if set.
string
Contact phone number, if set.
string
Contact email address, if set.
string
Supplier address, if set.
string
Free-text notes about the supplier.
string
ISO 8601 timestamp of when the supplier was added.