Sparehawk Supplier API
The supplier-facing REST API (Wave 9 item 5): push offers, read RFQs routed to you, and submit quotes — from your own systems, without anyone logging into the cabinet by hand. Authenticate with an API key created under Cabinet > Developer > API keys.
Version 1.0.0 Download the OpenAPI spec (JSON)
Offers
Bulk upsert and patch your catalogue.
/v1/supplier-api/offers/bulkBulk upsert offers
Upserts up to 1000 offers per call, matched by MPN + condition. An MPN not yet in the catalogue becomes a needs_review part stub rather than an error. Supports an Idempotency-Key header: the same key replays the first response instead of running the mutation again.
Parameters
Idempotency-Key(header) — A key you generate per attempt. A retry with the same key replays the cached response.
Responses
201— Per-line results — a line can succeed even if another in the same call failed.400— Validation error (e.g. more than 1000 offers in one call).401— Missing or invalid API key.403— The key is missing the offers:write scope.429— This key has exceeded its rate limit.
/v1/supplier-api/offers/{id}Patch one offer's stock/price/lead time
Parameters
id(path, required)
Responses
200— Updated.401— Missing or invalid API key.403— The key is missing the offers:write scope.404— No such offer for this supplier.
RFQs
RFQs routed to your supplier account.
/v1/supplier-api/rfqsList RFQs routed to you
Responses
200— Up to the 100 most recent, newest first.401— Missing or invalid API key.403— The key is missing the rfqs:read scope.
/v1/supplier-api/rfqs/{id}Fetch one RFQ's detail, including its lines
Parameters
id(path, required)
Responses
200— Found.401— Missing or invalid API key.403— The key is missing the rfqs:read scope.404— Not routed to this supplier.
Quotes
Submit a quote against a routed RFQ.
/v1/supplier-api/quotesSubmit a quote against a routed RFQ
Responses
201— Created.401— Missing or invalid API key.403— The key is missing the quotes:write scope.404— The RFQ (or one of its lines) is not routed to this supplier.
