Discovery
A client's public profile with its published offerings
A client's public profile with its published offerings.
GET
/v1/explore/clients/{clientId}A client's public profile with its published offerings. Drafts and archived offerings are not included, and variants carry the shopper's view only: no cost, markup or stock counts. Requires catalog:read; an unknown or inactive client gives client_not_found (404).
Authorization
bearerAuth AuthorizationBearer <token>
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
clientId*string
Format
uuidResponse Body
application/json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/v1/explore/clients/497f6eca-6276-4993-bfeb-53cbbbba6f08"{ "client": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "merchant_id": "500924a8-3f5e-4c00-beb8-2efcde988aea", "org_alias": "string", "display_name": "string", "category": "string", "description": "string", "logo_url": "string", "commission_bps": 0, "status": "pending", "approved_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z" }, "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" } ]}