The client's own offerings, one page at a time
The client's own offerings in every status, with the merchant view of each variant: cost, markup, pricing mode and stock counts, none of which Explore ever shows a shopper.
/v1/clients/{clientId}/offeringsThe client's own offerings in every status, with the merchant view of each variant: cost, markup, pricing mode and stock counts, none of which Explore ever shows a shopper. Filter by status, category_id, free-text q and low_stock. Needs authority over the client — membership of its organization, an API key bound to this client, or tenant staff holding clients:manage; anything else is refused not_client_member or insufficient_scope (403), and an unknown client client_not_found (404). Answers with next_cursor; limit is clamped to 1-100.
Authorization
bearerAuth A tenant API key (sk_{env}_{id}_{secret}), a wallet user token, or an IdP access token. Which principal the credential resolves to decides the scopes it carries; see the authentication guide.
In: header
Path Parameters
uuidQuery Parameters
Value in
- "draft"
- "published"
- "archived"
uuidMatches title, SKU or barcode
length <= 128Only items with a variant at or under its low-stock threshold
Last seen id from the previous page. The listing resumes after that row, so an id that belongs to no row in the listing is refused invalid_request (400) rather than answered with an empty page.
uuid1 <= value <= 10050Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/v1/clients/497f6eca-6276-4993-bfeb-53cbbbba6f08/offerings"{ "offerings": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643", "kind": "item", "title": "string", "description": "string", "amount": 0, "interval": "weekly", "image_url": "string", "metadata": { "property1": "string", "property2": "string" }, "commission_bps": 0, "category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2", "options": [ "string" ], "markup": { "kind": "percent", "value": 0 }, "variants": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "offering_id": "a7d124b6-6a8c-44d1-9d46-4636e3f8c04e", "sku": "string", "barcode": "string", "option_values": [ "string" ], "position": 0, "pricing_mode": "manual", "cost_amount": 0, "markup": { "kind": "percent", "value": 0 }, "amount": 0, "image_url": "string", "inventory": { "track_inventory": true, "in_stock": true, "low_stock": true, "on_hand": 0, "reserved": 0, "available": 0, "allow_backorder": true, "low_stock_threshold": 0 }, "status": "active", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" } ], "status": "draft", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" } ], "next_cursor": "a7ec8888-a9c3-4732-a281-9a08510f220b"}