undefined - Protocol API Reference

GET/api/public/core/v1/labels

Get all labels

Fetches all labels with links

Query parameters

Name
projection
Type
string
required
Description
Level of detail in the projection of an label.
- S includes:
  - barcode
  - modelName
  - plLocation
  - links
- M includes:
  - All of S
  - homeTrx
  - plState
  - batteryState
  - lowBatteryDate
- L includes:
  - All of M
  - lastTrxList
  - hardwareRevision
  - lastDisplayUpdate
  - batteryStateChanged
  - batteryStateLastConfirmed
  - batteryStateFirstEnteredLow
  - firstLinked
  - lastLinked
  - lastUpdate
  - lastOkUpdate
Name
filter[barcode]
Type
array
required
Description
Filter response based on a label barcode or list of barcodes. As example: A4631053950916186 or G4421230000216185,G4421230000616189,G4421230001116185
Name
filter[modelName]
Type
string
required
Description
Filter response based on modelName.
Name
filter[plState]
Type
string
required
Description
Filter response based on state of the label.
Name
filter[batteryState]
Type
string
required
Description
Filter response based on battery state of the label.
Name
sortProperty
Type
string
required
Description
The property to sort the response on.
Name
sortDirection
Type
string
required
Description
The sort direction for the response based on sortProperty. Default is ASC
Name
start
Type
integer
required
Description
The offset to start at, 0-based. For example, specifying the start value 1000 with a limit of 500 will return 500 labels starting at position 1000.
Name
limit
Type
integer
required
Description
The amount, i.e. how many labels will be returned.
Name
serializeDatesToIso8601
Type
boolean
required
Description
If dates should be serialized to ISO 8601 (eg 1997-07-16T19:20:30.45+01:00). Defaults to false for backwards compatibility.

Request

GET

/api/public/core/v1/labels

curl -X GET https://<storeid>.<tenantname>.pcm.pricer-plaza.com/api/public/core/v1/labels \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {token}"

Response

[
  {
    "itemId": "1",
    "itemName": "Apples",
    "price": "0.99",
    "itemGroup": "Fruit",
    "department": "Fruit & vegetables",
    "presentation": "NORMAL",
    "lastUpdated": "2019-12-16T10:36:37+01:00[Europe/Berlin]",
    "validFrom": "2019-12-24 10:00:00",
    "sics": [
      "[\"0001\",\"01\"]"
    ],
    "properties": "object",
    "links": [
      {
        "barcode": "A4099520243916391",
        "itemId": "1",
        "linkedItemId": "2",
        "displayPosition": 0,
        "facings": ""
      }
    ]
  }
]

PATCH/api/public/core/v1/labels

Link labels

Link labels to items as per defined in the provided listReturns an id to the asynchronous update request, which can be used to query the links-result endpoint.

body parameters

array of objects

Name
barcode
Type
string
required
Description
Label barcode
Name
modelName
Type
string
required
Description
The name of the linked model
Name
linkDepartment
Type
string
required
Description
Link department
Name
plLocation
Type
string
required
Description
Pricer label location
Name
plState
Type
string
required
Description
State of the label
Name
batteryState
Type
string
required
Description
Battery state
Name
lowBatteryDate
Type
string
required
Description
Low battery date
Name
homeTrx
Type
string
required
Description
Home trx, short form. If specified, will have priority over link department
Name
lastTrxList
Type
string
required
Description
Trx list
Name
hardwareRevision
Type
string
required
Description
Hardware version
Name
lastDisplayUpdate
Type
string
required
Description
Last display updated time
Name
batteryStateChanged
Type
string
required
Description
Battery state changed time
Name
batteryStateLastConfirmed
Type
string
required
Description
Battery state last confirmed time
Name
batteryStateFirstEnteredLow
Type
string
required
Description
Battery state first entered low time
Name
firstLinked
Type
string
required
Description
First linked time
Name
lastLinked
Type
string
required
Description
Last linked time
Name
lastUpdate
Type
string
required
Description
Last update time
Name
lastOkUpdate
Type
string
required
Description
Last ok update time

positions object

A class representing one or more positions for a label

manual object

A class representing a position for a label

Name
x
Type
number
required
Description
Name
y
Type
number
required
Description
Name
floor
Type
integer
required
Description

links array of objects

List of links

Name
barcode
Type
string
required
Description
The barcode of the linked label
Name
itemId
Type
string
required
Description
The id of the linked item. This field is required if linkedItemId is not specified.
Name
linkedItemId
Type
string
required
Description
The item id or SIC actually used when linking the item. If this is specified when linking, it will be used in preference to the itemId field
Name
displayPosition
Type
integer
required
Description
The position of the item on the label. 0-based. For single item labels always equal to 0
Name
facings
Type
string
required
Description
The number of facings for the link

Request

PATCH

/api/public/core/v1/labels

curl -X PATCH https://<storeid>.<tenantname>.pcm.pricer-plaza.com/api/public/core/v1/labels \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {token}"
  -d [{"barcode": "A4099520243916391", "modelName": "SmartTAG Power S Red", "linkDepartment": "A01", "plLocation": "", "plState": "string", "batteryState": "string", "lowBatteryDate": "string", "homeTrx": "A1", "lastTrxList": "string", "hardwareRevision": "string", "lastDisplayUpdate": "string", "batteryStateChanged": "string", "batteryStateLastConfirmed": "string", "batteryStateFirstEnteredLow": "string", "firstLinked": "string", "lastLinked": "string", "lastUpdate": "string", "lastOkUpdate": "string", "positions": {"manual": {"x": 10, "y": 20, "floor": 1}}, "links": [{"barcode": "A4099520243916391", "itemId": "1", "linkedItemId": "2", "displayPosition": 0, "facings": ""}]}]

Response

{
  "requestId": "integer"
}

POST/api/public/core/v1/labels/link-single

Link a single label

This operation is synchronous and thereby bypasses the backoffice system and its queues.

Query parameters

Name
timeout
Type
integer
required
Description
The timeout in milliseconds for how long to wait for a synchronous response to the link request. If the operation is not completed before the timeout is reached, PENDING will be returned.

body parameters

Name
barcode
Type
string
required
Description
Label barcode
Name
itemId
Type
string
required
Description
The id of the linked item
Name
displayPosition
Type
integer
required
Description
The position of the item on the label. 0-based. For single item labels always equal to 0
Name
facings
Type
string
required
Description
The number of facings for the link
Name
modelName
Type
string
required
Description
The name of the ESL model to use
Name
linkDepartment
Type
string
required
Description
Link department
Name
homeTrx
Type
string
required
Description
Home trx, short form. If specified, will have priority over link department
Name
plLocation
Type
string
required
Description
Pricer label location

Request

POST

/api/public/core/v1/labels/link-single

curl -X POST https://<storeid>.<tenantname>.pcm.pricer-plaza.com/api/public/core/v1/labels/link-single \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {token}"
  -d {"barcode": "A4099520243916391", "itemId": "1", "displayPosition": 0, "facings": "", "modelName": "SmartTAG Power S Red", "linkDepartment": "A01", "homeTrx": "A1", "plLocation": ""}

Response

{
  "barcode": "string",
  "itemId": "string",
  "status": "string"
}

GET/api/public/core/v1/labels/models

Get all models and their compatible label types

Request

GET

/api/public/core/v1/labels/models

curl -X GET https://<storeid>.<tenantname>.pcm.pricer-plaza.com/api/public/core/v1/labels/models \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {token}"

Response

{
  "models": [
    {
      "name": "SmartTAG HD Fruits",
      "labelTypes": [
        "integer"
      ],
      "linkPositions": 1
    }
  ]
}

GET/api/public/core/v1/labels/models/{barcodeOrLabelType}

Get all models available for specified barcode or label type

Path parameters

Name
barcodeOrLabelType
Type
string
required
required
Description
Barcode of the label or the label type. As example: '1318' or 'N4241010922213188'

Request

GET

/api/public/core/v1/labels/models/{barcodeOrLabelType}

curl -X GET https://<storeid>.<tenantname>.pcm.pricer-plaza.com/api/public/core/v1/labels/models/{barcodeOrLabelType} \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {token}"

Response

{
  "models": [
    {
      "name": "SmartTAG HD Fruits",
      "labelTypes": [
        "integer"
      ],
      "linkPositions": 1
    }
  ]
}

POST/api/public/core/v1/labels/refresh/{modelName}

Refresh labels based on model name

All labels that match the model name will be refreshed.

Path parameters

Name
modelName
Type
string
required
required
Description
The model name.

Request

POST

/api/public/core/v1/labels/refresh/{modelName}

curl -X POST https://<storeid>.<tenantname>.pcm.pricer-plaza.com/api/public/core/v1/labels/refresh/{modelName} \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {token}"

Response

"string"

GET/api/public/core/v1/labels/{barcode}

Get a label with specified barcode

Fetches the label with links

Path parameters

Name
barcode
Type
string
required
required
Description

Query parameters

Name
projection
Type
string
required
Description
Level of detail in the projection of an label.
- S includes:
  - barcode
  - modelName
  - plLocation
  - links
- M includes:
  - All of S
  - homeTrx
  - plState
  - batteryState
  - lowBatteryDate
- L includes:
  - All of M
  - lastTrxList
  - hardwareRevision
  - lastDisplayUpdate
  - batteryStateChanged
  - batteryStateLastConfirmed
  - batteryStateFirstEnteredLow
  - firstLinked
  - lastLinked
  - lastUpdate
  - lastOkUpdate
Name
serializeDatesToIso8601
Type
boolean
required
Description
If dates should be serialized to ISO 8601 (eg 1997-07-16T19:20:30.45+01:00). Defaults to false for backwards compatibility.

Request

GET

/api/public/core/v1/labels/{barcode}

curl -X GET https://<storeid>.<tenantname>.pcm.pricer-plaza.com/api/public/core/v1/labels/{barcode} \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {token}"

Response

{
  "barcode": "A4099520243916391",
  "modelName": "SmartTAG Power S Red",
  "linkDepartment": "A01",
  "plLocation": "",
  "plState": "string",
  "batteryState": "string",
  "lowBatteryDate": "string",
  "homeTrx": "A1",
  "lastTrxList": "string",
  "hardwareRevision": "string",
  "lastDisplayUpdate": "string",
  "batteryStateChanged": "string",
  "batteryStateLastConfirmed": "string",
  "batteryStateFirstEnteredLow": "string",
  "firstLinked": "string",
  "lastLinked": "string",
  "lastUpdate": "string",
  "lastOkUpdate": "string",
  "positions": {
    "manual": {
      "x": 10,
      "y": 20,
      "floor": 1
    }
  },
  "links": [
    {
      "barcode": "A4099520243916391",
      "itemId": "1",
      "linkedItemId": "2",
      "displayPosition": 0,
      "facings": ""
    }
  ]
}

POST/api/public/core/v1/labels/{barcode}/display-page

Display page

Show specific info page on specified label.

Path parameters

Name
barcode
Type
string
required
required
Description
The barcode of the label

body parameters

Name
duration
Type
integer
required
Description
Duration in seconds, when the page is shown. Notes: In case action is "restore-page", duration value is ignored
Name
page
Type
string
required
Description
The page that will be shown temporarily
Name
action
Type
string
required
Description
Allowed action

Request

POST

/api/public/core/v1/labels/{barcode}/display-page

curl -X POST https://<storeid>.<tenantname>.pcm.pricer-plaza.com/api/public/core/v1/labels/{barcode}/display-page \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {token}"
  -d {"duration": 60, "page": "Info", "action": "set-temporary"}

Response

"Missing example"

POST/api/public/core/v1/labels/{barcode}/flash

Flash single label

Flashes one label based on barcode

Path parameters

Name
barcode
Type
string
required
required
Description
The barcode of the label to flash

body parameters

Name
duration
Type
integer
required
Description
The flash duration in seconds. Defaults to 4. 0 (zero) means stop flashing. Accepted values are all between 0-1800. The flash duration behaviour of DM and segment labels differs a bit. When flashing a DM label the duration will be according to the given duration. For segment labels the duration will be the ceiling value in relation to: 0, 4, 8, 30, 60, 300, 900, 1800 in seconds. So the duration 61 will flash for 300 sec.
Name
realTime
Type
boolean
required
Description
The transmission priority of the flash. When this is set to true it is seen as high priority, if set to false it is seen as normal priority. Defaults to true
Name
color
Type
string
required
Description
Color of LED in RGB format without blanks: #ff0000 or rgb(255,0,0). The color will be set to closest supported color. Supported colors: GREEN, RED, BLUE, CYAN, MAGENTA, YELLOW, WHITE.
Name
flashType
Type
integer
required
Description
Flash type. Possible values 10 - Low, 20 - Semi-low, 30 - Semi-Strong-Strobe, 40 - Strong-Strobe, 50 - Strong.

Request

POST

/api/public/core/v1/labels/{barcode}/flash

curl -X POST https://<storeid>.<tenantname>.pcm.pricer-plaza.com/api/public/core/v1/labels/{barcode}/flash \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {token}"
  -d {"duration": 4, "realTime": true, "color": "#ff00ff", "flashType": 10}

Response

{
  "result": "string"
}

POST/api/public/core/v1/labels/{barcode}/flash-with-department

Flash single label with department

Flashes one label based on barcode

Path parameters

Name
barcode
Type
string
required
required
Description
The barcode of the label to flash

body parameters

Name
duration
Type
integer
required
Description
The flash duration in seconds. Defaults to 4. 0 (zero) means stop flashing. Accepted values are all between 0-1800. The flash duration behaviour of DM and segment labels differs a bit. When flashing a DM label the duration will be according to the given duration. For segment labels the duration will be the ceiling value in relation to: 0, 4, 8, 30, 60, 300, 900, 1800 in seconds. So the duration 61 will flash for 300 sec.
Name
realTime
Type
boolean
required
Description
The transmission priority of the flash. When this is set to true it is seen as high priority, if set to false it is seen as normal priority. Defaults to true
Name
color
Type
string
required
Description
Color of LED in RGB format without blanks: #ff0000 or rgb(255,0,0). The color will be set to closest supported color. Supported colors: GREEN, RED, BLUE, CYAN, MAGENTA, YELLOW, WHITE.
Name
flashType
Type
integer
required
Description
Flash type. Possible values 10 - Low, 20 - Semi-low, 30 - Semi-Strong-Strobe, 40 - Strong-Strobe, 50 - Strong.
Name
linkDepartment
Type
string
required
Description
The link department ID or alias

Request

POST

/api/public/core/v1/labels/{barcode}/flash-with-department

curl -X POST https://<storeid>.<tenantname>.pcm.pricer-plaza.com/api/public/core/v1/labels/{barcode}/flash-with-department \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {token}"
  -d {"duration": 4, "realTime": true, "color": "#ff00ff", "flashType": 10, "linkDepartment": "A01"}

Response

{
  "result": "string"
}

DELETE/api/public/core/v1/labels/{barcode}/links

Unlink single label

Unlink one label based on barcode

Path parameters

Name
barcode
Type
string
required
required
Description
The barcode of the label to unlink

Request

DELETE

/api/public/core/v1/labels/{barcode}/links

curl -X DELETE https://<storeid>.<tenantname>.pcm.pricer-plaza.com/api/public/core/v1/labels/{barcode}/links \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {token}"

Response

{
  "requestId": "integer"
}

DELETE/api/public/core/v1/labels/{barcode}/links/{displayPosition}

Unlink single item on the label

Unlink one item, based on link index, on the label based on barcode

Path parameters

Name
barcode
Type
string
required
required
Description
The barcode of the label to unlink
Name
displayPosition
Type
integer
required
required
Description
The index of the item on label

Request

DELETE

/api/public/core/v1/labels/{barcode}/links/{displayPosition}

curl -X DELETE https://<storeid>.<tenantname>.pcm.pricer-plaza.com/api/public/core/v1/labels/{barcode}/links/{displayPosition} \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {token}"

Response

{
  "requestId": "integer"
}

PUT/api/public/core/v1/labels/{barcode}/positions/manual

Update manual position

Add or update the manual position of an ESL.

Path parameters

Name
barcode
Type
string
required
required
Description
The barcode of the label

body parameters

Name
eslBarcode
Type
string
required
Description
The barcode of the ESL

position object

A representation of the position of an ESL

Name
x
Type
number
required
Description
Name
y
Type
number
required
Description
Name
floor
Type
integer
required
Description

Request

PUT

/api/public/core/v1/labels/{barcode}/positions/manual

curl -X PUT https://<storeid>.<tenantname>.pcm.pricer-plaza.com/api/public/core/v1/labels/{barcode}/positions/manual \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {token}"
  -d {"eslBarcode": "string", "position": {"x": 10, "y": 20, "floor": 1}}

Response

"Missing example"

DELETE/api/public/core/v1/labels/{barcode}/positions/manual

Delete manual position

Delete the manual position of an ESL. Also removes any queued up fingerprint request for the ESL.

Path parameters

Name
barcode
Type
string
required
required
Description
The barcode of the label

Request

DELETE

/api/public/core/v1/labels/{barcode}/positions/manual

curl -X DELETE https://<storeid>.<tenantname>.pcm.pricer-plaza.com/api/public/core/v1/labels/{barcode}/positions/manual \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {token}"

Response

"Missing example"