Skip to content

Autocomplete Products

Request

Search Products by name, article number, or barcode.

The search term must contain at least two characters and cannot contain emoji. Pagination uses page and limit and is returned in meta.pagination.

Security
BearerPartnerUser
Path
location_idintegerrequired

Location ID

Query
filter[term]string, >= 2 charactersrequired

Product name, article number, or barcode search term

pageinteger, >= 1

Page number

Default:1
limitinteger, [ 1 .. 250 ]

Maximum number of Products to return

Default:250
includeArray of strings, unique

Related resources to include; wire values are literal API keys

Items Enum:"loyalty_abonement_type""loyalty_certificate_type""mark_settings"
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/autocomplete?filter%5Bterm%5D=string&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": [ { … } ], "included": [ { … } ], "meta": { "pagination": { … } } }