Sign in
Products

List Products

Retrieve Products for a Location as JSON:API resource objects.

Pagination uses page and limit. The response includes the effective page, calculated offset, and limit in meta.pagination.

Related data can be requested by repeating the include parameter. The actual_cost value is returned only when requested and when the Business User has permission to view it.

get/locations/{location_id}/products

Path parameters

location_idinteger required

Location ID

Query parameters

filter[ids][]integer[]

Filter by Product IDs

filter[related_loyalty_entity_slug]'common' | 'loyalty_abonement' | 'loyalty_certificate'

Filter by Product purpose. Wire values are literal API values:

  • common - regular Products
  • loyalty_abonement - membership Products
  • loyalty_certificate - certificate Products
pageinteger

Page number

limitinteger

Maximum number of Products to return

includestring[]

Related resources or conditional attributes to include. Wire values are literal API keys. Use the Product detail operation for storage_amounts.

Headers

Acceptstring required

Required B2B v2 response media type. Use application/vnd.api.v2+json. A charset parameter is also accepted.

Authorizationstring required

Bearer {partner_token}, User {user_token}

Response

Products retrieved successfully