Skip to content

Get Product Category

Request

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

Security
BearerPartnerUser
Path
location_idintegerrequired

Location ID

product_category_idintegerrequired

Product Category ID

Query
includeArray of strings, unique

Related resources to include. child_categories and goods are literal wire values for Product Categories and Products.

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

Responses

Product Category retrieved successfully

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

Resources requested through include, when available

Response
{ "data": { "type": "good_category", "id": "5", "attributes": { … } }, "meta": [] }