Skip to content

Get Product

Request

Retrieve a Product for a Location as a JSON:API resource object.

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

product_idintegerrequired

Product ID

Query
includeArray of strings, unique

Related resources or conditional attributes to include

Items Enum:"loyalty_abonement_type""loyalty_certificate_type""mark_settings""storage_amounts""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/{product_id}?include=loyalty_abonement_type' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>'

Responses

Product retrieved successfully

Bodyapplication/json
dataobject(Product Resource)required
metaArray of any, <= 0 itemsrequired
includedArray of objects(includedResource)

Resources requested through include, when available

Response
{ "data": { "type": "good", "id": "100", "attributes": { … } }, "meta": [] }