Suppliers
Update a supplier
Update a supplier. Requires the MANAGER role.
__Host-qm_session<token>
Session cookie set by sign-in on HTTPS deployments (the hosted demo).
In: cookie
Path Parameters
id*string
Resource id (UUID).
Format
uuidHeader Parameters
X-Requested-With*string
CSRF guard: must be quartermaster on every mutation.
Request Body
application/json
Fields for creating or updating a supplier.
Fields for creating or updating a supplier.
name*string
Display name.
Length
2 <= length <= 120website?|
Supplier website.
Default
nulldescription?|
Free-text description.
Default
nulllead_time_days*integer
Days from order to delivery.
Range
0 <= value <= 60tax_rate_bps*integer
Tax rate, in basis points (825 = 8.25%).
Range
0 <= value <= 3000fee_terms?array<>
Published fees and shipping terms; any other fee in a quote is unauthorised.
Items
items <= 10Default
[]active?boolean
Whether the record is in use.
Default
truecheckout_eligible?boolean
Whether orders from this supplier can be paid through PayPal checkout.
Default
trueResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PUT "https://example.com/suppliers/0f8fad5b-d9cb-469f-a165-70867728950e" \ -H "X-Requested-With: quartermaster" \ -H "Content-Type: application/json" \ -d '{ "name": "string", "lead_time_days": 0, "tax_rate_bps": 0 }'{ "supplier": { "id": "string", "name": "string", "approved": true, "active": true, "checkout_eligible": true, "lead_time_days": 0, "tax_rate_bps": 0, "fee_terms": [ { "code": "string", "label": "string", "kind": "SHIPPING", "amount_minor": 0, "waived_over_minor": 0 } ], "website": "string", "description": "string", "quarantined": true, "catalog_items": 0, "data_source": "CHANNEL3_MARKET", "catalog": [ { "id": "string", "supplier_id": "string", "sku": "string", "title": "string", "description": "string", "category": "food_packaging", "inventory_item_id": "string", "pack_quantity": 0, "unit_price_minor": 0, "currency": "string", "in_stock": true, "recurring": true, "quarantined": true, "quarantine_reason": "string", "updated_at": "string" } ], "created_at": "string" }}