Read products

Return one page of the online store's complete catalogue. SKUU reads the whole catalogue this way every 12 hours by default. Each read is a complete snapshot. Only a snapshot that validates from the first page to the last counts.

  • Pagination: limit is required and SKUU sends 100. Support 1 to 250 and never return more than requested. cursor is absent on the first request. Return next_cursor while more pages exist and null on the last page. A cursor is opaque; SKUU sends it back as a string. Keep the snapshot stable while SKUU pages through it.
  • Completeness: returning null early ends the snapshot early. Every variant missing from a completed snapshot is retired and its network stock set to zero. To remove a product, stop returning it.
  • Required fields: every product has product_id, title, brand, at least one public HTTPS image and at least one variant. Every variant has variant_id, size (exactly One size for an article without a size), price, currency and inventory. Send barcode whenever the store has it.
  • How SKUU links products: by barcode first, then the store's SKU, then title and size within the same brand. A catalogue with barcodes links almost completely. Colour is stored and shown, never compared.
  • What makes SKUU reject a snapshot: a missing brand, image or size, a currency that differs from the store's, a duplicate product_id or variant_id, a product without variants, a variant missing an agreed location or listing an unknown one, a location id that is not a plain whole number, or a number sent as a string. A rejected snapshot changes nothing; the previous one stays in force.
  • Retries: SKUU retries a network failure, 429 and any 5xx; the schedule is on Errors and retries. Any other 4xx stops the flow and alerts SKUU customer service.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
required
1 to 250

Page size. SKUU sends 100; support 1 to 250 and never return more than requested.

string
length ≥ 1

The next_cursor from the preceding response, sent back as a string. Omit it on the first request.

Responses

Language
Credentials
Bearer
opaque customer-issued token
URL
LoadingLoading…
Response
Choose an example:
application/json