Skip to content

Sparehawk Supplier API

The supplier-facing REST API: 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.0Download the OpenAPI spec (JSON)

01

Offers

Bulk upsert and patch your catalogue.

post/v1/supplier-api/offers/bulk

Bulk 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-KeyheaderA key you generate per attempt. A retry with the same key replays the cached response.

Responses

  • 201Per-line results — a line can succeed even if another in the same call failed.
  • 400Validation error (e.g. more than 1000 offers in one call).
  • 401Missing or invalid API key.
  • 403The key is missing the offers:write scope.
  • 429This key has exceeded its rate limit.
patch/v1/supplier-api/offers/{id}

Patch one offer's stock/price/lead time

Parameters

  • idpath, required

Responses

  • 200Updated.
  • 401Missing or invalid API key.
  • 403The key is missing the offers:write scope.
  • 404No such offer for this supplier.
02

RFQs

RFQs routed to your supplier account.

get/v1/supplier-api/rfqs

List RFQs routed to you

Responses

  • 200Up to the 100 most recent, newest first.
  • 401Missing or invalid API key.
  • 403The key is missing the rfqs:read scope.
get/v1/supplier-api/rfqs/{id}

Fetch one RFQ's detail, including its lines

Parameters

  • idpath, required

Responses

  • 200Found.
  • 401Missing or invalid API key.
  • 403The key is missing the rfqs:read scope.
  • 404Not routed to this supplier.
03

Quotes

Submit a quote against a routed RFQ.

post/v1/supplier-api/quotes

Submit a quote against a routed RFQ

Responses

  • 201Created.
  • 401Missing or invalid API key.
  • 403The key is missing the quotes:write scope.
  • 404The RFQ (or one of its lines) is not routed to this supplier.

    Go to