List in-store offers

Return every in-store (physical-store) offer owned by the given organization. Results are paginated with the standard {data, pagination} envelope; default page_size is 25, max is 100. Returns 404 when the organization does not exist or the caller lacks the VIEW permission on it.

GET /retailers/api/v1/organizations/{organization_id}/in-store-offers

List in-store offers

cURL

curl --request GET \
  --url https://www.closient.com/retailers/api/v1/organizations/{organization_id}/in-store-offers \
  --header 'X-API-Key: <api-key>'

200

{
  "data": [
    {
      "id": "<string>",
      "product_id": "<string>",
      "physical_store_id": "<string>",
      "metadata": {},
      "organization_id": "<string>",
      "sku": "",
      "price": {
        "amount": "5.99",
        "currency": "USD"
      },
      "status": "active",
      "is_verified": false,
      "source": "manual",
      "quantity_on_hand": 1,
      "aisle": "",
      "store_pickup_available": false
    }
  ],
  "pagination": {
    "page": 2,
    "page_size": 2,
    "total_count": 1,
    "total_pages": 2,
    "has_next": true,
    "has_previous": true
  }
}

Authorizations

APIKeyHeaderAuthOAuthTokenAuthSessionAuth

X-API-Key · string · header · required

Path Parameters

organization_id · string<shortuuid> · required

UUID of the organization that owns the offers.

Required string length: 22

Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Query Parameters

page · integer · default: 1

Page number (1-indexed).

Required range: x >= 1

page_size · integer · default: 25

Number of items per page (max 100).

Required range: 1 <= x <= 100

Response

200

application/json

OK

data · InStoreOfferOut · object[] · required

Items on the current page, each conforming to the endpoint's item schema. Empty when the result set is empty or page is past the end.

Show child attributes

pagination · PaginationMeta · object · required

Pagination envelope describing position within the full result set.

Show child attributes

Example:

{
  "has_next": true,
  "has_previous": false,
  "page": 1,
  "page_size": 25,
  "total_count": 342,
  "total_pages": 14
}