undefined - Protocol API Reference

GET/api/v1/stores

Get All Stores

Retrieve the information of all stores

Headers

Name
X-Pricer-Transaction-Id
Type
string
required
Description
A transaction id to trace requests across multiple services.
Name
X-Pricer-Client-Id
Type
string
required
Description
A client id to trace requests across multiple services.

Query parameters

Name
page
Type
integer
required
Description
The page number
Name
size
Type
integer
required
Description
The numbers of items to return
Name
search
Type
string
required
Description
The search string to filter stores with
Name
size_filter
Type
array
required
Description
Filter based on store size
Name
type_filter
Type
array
required
Description
Filter based on store type
Name
tag_filter
Type
array
required
Description
Filter based on tag

Request

GET

/api/v1/stores

curl -X GET https://store.pricer-plaza.com/api/v1/stores \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {token}"

Response

[
  {
    "id": "50d0e062-b922-48a0-bb31-cce8a52068d6",
    "name": "test-store",
    "description": "Test store for example",
    "tenantId": "6cce2e6d-3ab5-41d9-8103-9c61b97dcf20",
    "tenantName": "Pricer AB",
    "pcsId": "pcsId",
    "classicStoreId": "2293e757-587a-41c1-8915-f1d02ebdcfa1",
    "type": "string",
    "config": {
      "version": "R5.38.1",
      "os": "linux",
      "pricerServerVersion": "5.33.x",
      "basestation": "E3"
    },
    "size": "string",
    "externalStoreId": 2137,
    "category": "string",
    "createdAt": "string",
    "updatedAt": "string",
    "createdBy": "string",
    "onPremGatewayEnabled": false,
    "address": {
      "addressLine": "V\u00e4stra J\u00e4rnv\u00e4gsgatan 7",
      "city": "Stockholm",
      "state": "Uppland",
      "country": "Sweden",
      "region": "Europe",
      "postalCode": "111 64",
      "latitude": 62.323838,
      "longitude": 63.345324
    }
  }
]

GET/api/v1/stores/{storeId}

Get Store by Store ID

Retrieve the information of the store with the matching store ID.

Headers

Name
X-Pricer-Transaction-Id
Type
string
required
Description
A transaction id to trace requests across multiple services.
Name
X-Pricer-Client-Id
Type
string
required
Description
A client id to trace requests across multiple services.

Path parameters

Name
storeId
Type
string
required
required
Description
Unique id of the store

Request

GET

/api/v1/stores/{storeId}

curl -X GET https://store.pricer-plaza.com/api/v1/stores/{storeId} \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {token}"

Response

{
  "id": "50d0e062-b922-48a0-bb31-cce8a52068d6",
  "name": "test-store",
  "description": "Test store for example",
  "tenantId": "6cce2e6d-3ab5-41d9-8103-9c61b97dcf20",
  "tenantName": "Pricer AB",
  "pcsId": "pcsId",
  "classicStoreId": "2293e757-587a-41c1-8915-f1d02ebdcfa1",
  "type": "string",
  "config": {
    "version": "R5.38.1",
    "os": "linux",
    "pricerServerVersion": "5.33.x",
    "basestation": "E3"
  },
  "size": "string",
  "externalStoreId": 2137,
  "category": "string",
  "createdAt": "string",
  "updatedAt": "string",
  "createdBy": "string",
  "onPremGatewayEnabled": false,
  "address": {
    "addressLine": "V\u00e4stra J\u00e4rnv\u00e4gsgatan 7",
    "city": "Stockholm",
    "state": "Uppland",
    "country": "Sweden",
    "region": "Europe",
    "postalCode": "111 64",
    "latitude": 62.323838,
    "longitude": 63.345324
  }
}

GET/api/v2/stores

Get All Stores V2

Retrieve the information of all stores

Headers

Name
X-Pricer-Transaction-Id
Type
string
required
Description
A transaction id to trace requests across multiple services.
Name
X-Pricer-Client-Id
Type
string
required
Description
A client id to trace requests across multiple services.

Query parameters

Name
cursor
Type
string
required
Description
The cursor to start from
Name
size
Type
integer
required
Description
The numbers of items to return
Name
size_filter
Type
array
required
Description
Filter based on store size
Name
type
Type
string
required
Description
Store type:
- PLAZA - For plaza stores
- ON_PREM - For on-perm or offline stores
Name
category
Type
string
required
Description
Store Categories:
- GROCERY- Grocery Store and such
- DIY - Do-It-Yourself stores
- MMM - Mechanical, Materials and Manufacturing
- EL - Electronics
- FURNITURE - Furniture and home decoration
- BEAUTY - Personal care
- HEALTH - Personal health care
- PHARMACIES - Pharmacies
- FASHION - Fashion
- OTHERS - Other types
Name
search
Type
string
required
Description
The search string to filter stores with
Name
name
Type
string
required
Description
Filter based on exact store name

Request

GET

/api/v2/stores

curl -X GET https://store.pricer-plaza.com/api/v2/stores \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {token}"

Response

{
  "cursor": "string",
  "moreResults": "boolean",
  "stores": [
    {
      "id": "50d0e062-b922-48a0-bb31-cce8a52068d6",
      "name": "test-store",
      "description": "Test store for example",
      "tenantId": "6cce2e6d-3ab5-41d9-8103-9c61b97dcf20",
      "tenantName": "Pricer AB",
      "pcsId": "pcsId",
      "classicStoreId": "2293e757-587a-41c1-8915-f1d02ebdcfa1",
      "type": "string",
      "config": {
        "version": "R5.38.1",
        "os": "linux",
        "pricerServerVersion": "5.33.x",
        "basestation": "E3"
      },
      "size": "string",
      "externalStoreId": 2137,
      "category": "string",
      "createdAt": "string",
      "updatedAt": "string",
      "createdBy": "string",
      "onPremGatewayEnabled": false,
      "address": {
        "addressLine": "V\u00e4stra J\u00e4rnv\u00e4gsgatan 7",
        "city": "Stockholm",
        "state": "Uppland",
        "country": "Sweden",
        "region": "Europe",
        "postalCode": "111 64",
        "latitude": 62.323838,
        "longitude": 63.345324
      }
    }
  ],
  "total": "integer"
}