Skip to content

List Products

Request

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.

Security
BearerPartnerUser
Path
location_idintegerrequired

Location ID

Query
filter[ids][]Array of integers, non-empty

Filter by Product IDs

filter[related_loyalty_entity_slug]string

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

  • common - regular Products
  • loyalty_abonement - membership Products
  • loyalty_certificate - gift card Products
Default:"common"
Enum:"common""loyalty_abonement""loyalty_certificate"
pageinteger, >= 1

Page number

Default:1
limitinteger, [ 1 .. 250 ]

Maximum number of Products to return

Default:250
includeArray of strings, unique

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

Items Enum:"loyalty_abonement_type""loyalty_certificate_type""mark_settings""actual_cost"
Headers
Acceptstringrequired

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

Default:"application/vnd.api.v2+json"
Example:application/vnd.api.v2+json
Authorizationstringrequired

Bearer {partner_token}, User {user_token}

curl -i -X GET \
  'https://developer.alteg.io/_mock/en/b2b-v2/openapi/locations/{location_id}/products?filter%5Bids%5D%5B%5D=1&filter%5Brelated_loyalty_entity_slug%5D=common&page=1&limit=250&include=loyalty_abonement_type' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>'

Responses

Products retrieved successfully

Bodyapplication/json
dataArray of objects(Product Resource)required
metaobjectrequired
includedArray of objects(includedResource)

Resources requested through include, when available

Response
{ "data": [ { … } ], "meta": { "pagination": { … } } }