GET/api/public/core/v1/items

Get multiple items

Fetches many items (paginated)

Query parameters

  • Name
    projection
    Type
    string
    required
    Description

    Level of detail in the projection of an item.


    • S includes:

      • id
      • name
      • price

    • M includes:

      • All of S
      • itemGroup
      • department
      • presentation
      • lastUpdated
      • validFrom
      • sics
      • properties

    • L includes:

      • All of M
      • links
  • 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 items starting at position 1000.

  • Name
    limit
    Type
    integer
    required
    Description

    The amount, i.e. how many items will be returned. Currently restricted to 1000.

Request

GET
/api/public/core/v1/items
curl -X GET https://<storeid>.<tenantname>.pcm.pricer-plaza.com/api/public/core/v1/items \
  -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": ""
      }
    ]
  }
]
DELETE/api/public/core/v1/items

Delete a list of items

Deletes a list of items by itemId.
Returns an id to the asynchronous delete request, which can be used to query the items-result endpoint.

body parameters

  • Name
    itemIds
    Type
    array of string
    required
    Description

    Items to be deleted

Request

DELETE
/api/public/core/v1/items
curl -X DELETE https://<storeid>.<tenantname>.pcm.pricer-plaza.com/api/public/core/v1/items \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {token}"
  -d {"itemIds": ["string"]}

Response

{
  "requestId": "integer"
}
PATCH/api/public/core/v1/items

Update or add multiple items

Updates the items in the system with the provided list of items
Existing items will be updated. New items will be added.
Only populated fields will be updated. null or empty fields will not clear the corresponding field of existing items.Returns an id to the asynchronous update request, which can be used to query the items-result endpoint.

body parameters

    array of objects

    • Name
      itemId
      Type
      string
      required
      Description

      Unique id of an item

    • Name
      itemName
      Type
      string
      required
      Description

      Name of an item

    • Name
      price
      Type
      string
      required
      Description

      Price of an item

    • Name
      itemGroup
      Type
      string
      required
      Description

      Item group

    • Name
      department
      Type
      string
      required
      Description

      Department

    • Name
      presentation
      Type
      string
      required
      Description

      Presentation. Also known as IPF

    • Name
      lastUpdated
      Type
      string
      required
      Description

      Timestamp representing when the item was last updated

    • Name
      validFrom
      Type
      string
      required
      Description

      Timestamp used for scheduling a future update

    • Name
      sics
      Type
      array of string
      required
      Description

      List of secondary item codes

      • properties object

      Map of custom item properties

      • Name
        additionalProperties
        Type
        string
        required
        Description

        Additional properties

      links array of objects

      List of linked labels

      • 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/items
curl -X PATCH https://<storeid>.<tenantname>.pcm.pricer-plaza.com/api/public/core/v1/items \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {token}"
  -d [{"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": ""}]}]

Response

{
  "requestId": "integer"
}
DELETE/api/public/core/v1/items/sic/{sic}

Deletes a sic

Deletes a sic from it's item. This does not delete the item itself.

Path parameters

  • Name
    sic
    Type
    string
    required
    required
    Description

    The SIC to delete from an item

Request

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

Response

{
  "requestId": "integer"
}
GET/api/public/core/v1/items/{itemId}

Get single item

Fetches 1 item specified by itemId

Path parameters

  • Name
    itemId
    Type
    string
    required
    required
    Description

    The id of the item to fetch

Query parameters

  • Name
    projection
    Type
    string
    required
    Description

    Level of detail in the projection of an item.


    • S includes:

      • id
      • name
      • price

    • M includes:

      • All of S
      • itemGroup
      • department
      • presentation
      • lastUpdated
      • validFrom
      • sics
      • properties

    • L includes:

      • All of M
      • links

Request

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

Response

{
  "value": "object",
  "filters": "object"
}
DELETE/api/public/core/v1/items/{itemId}

Delete single item

Deletes by itemId.
Returns an id to the asynchronous delete request, which can be used to query the items-result endpoint.

Path parameters

  • Name
    itemId
    Type
    string
    required
    required
    Description

    The id of the item to delete

Request

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

Response

{
  "requestId": "integer"
}
PATCH/api/public/core/v1/items/{itemId}

Update or add single item

Updates or adds the item specified by itemId.
Only populated fields will be updated. null or empty fields will not clear the corresponding field of the existing item.
Returns an id to the asynchronous update request, which can be used to query the items-result endpoint.

Path parameters

  • Name
    itemId
    Type
    string
    required
    required
    Description

    The id of the item to update

body parameters

  • Name
    itemId
    Type
    string
    required
    Description

    Unique id of an item

  • Name
    itemName
    Type
    string
    required
    Description

    Name of an item

  • Name
    price
    Type
    string
    required
    Description

    Price of an item

  • Name
    itemGroup
    Type
    string
    required
    Description

    Item group

  • Name
    department
    Type
    string
    required
    Description

    Department

  • Name
    presentation
    Type
    string
    required
    Description

    Presentation. Also known as IPF

  • Name
    lastUpdated
    Type
    string
    required
    Description

    Timestamp representing when the item was last updated

  • Name
    validFrom
    Type
    string
    required
    Description

    Timestamp used for scheduling a future update

  • Name
    sics
    Type
    array of string
    required
    Description

    List of secondary item codes

    • properties object

    Map of custom item properties

    • Name
      additionalProperties
      Type
      string
      required
      Description

      Additional properties

    links array of objects

    List of linked labels

    • 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/items/{itemId}
curl -X PATCH https://<storeid>.<tenantname>.pcm.pricer-plaza.com/api/public/core/v1/items/{itemId} \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {token}"
  -d {"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": ""}]}

Response

{
  "requestId": "integer"
}
POST/api/public/core/v1/items/{itemId}/flash

Flash single item

Flash all labels, linked to a single item, that have the capability to flash. The response will contain individual flash status for each label. Note that an empty list of labels in the response means that no labels are linked to the specified item.

Path parameters

  • Name
    itemId
    Type
    string
    required
    required
    Description

    The id of the item 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/items/{itemId}/flash
curl -X POST https://<storeid>.<tenantname>.pcm.pricer-plaza.com/api/public/core/v1/items/{itemId}/flash \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {token}"
  -d {"duration": 4, "realTime": true, "color": "#ff00ff", "flashType": 10}

Response

{
  "results": [
    {
      "barcode": "string",
      "result": "string"
    }
  ]
}
DELETE/api/public/core/v1/items/{itemId}/links

Unlink all labels, based on item id

Path parameters

  • Name
    itemId
    Type
    string
    required
    required
    Description

    The item id to unlink

Request

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

Response

{
  "requestId": "integer"
}
POST/api/public/core/v1/items/{itemId}/page/{pageIndex}

Update item image for a page

Update the image on the page of an item.

# Example usage, note the @ before the file path
curl 'https://username:password@officeserver.pricer.com:3306/api/public/core/v1/items/13/page/0?resize=0' -F 'imageFile=@/path/to/image.png'

This will upload the image to item 13 on page 0 without resizing, which in turn update all labels that are displaying the given item.

Path parameters

  • Name
    itemId
    Type
    string
    required
    required
    Description

    The id of the item of which to update the image.

    If the item does not exist and SystemParameters.ITEM_MUST_EXIST is true, an error will be thrown. If the item does not exist and SystemParameters.ITEM_MUST_EXIST is false, the item will be created.

  • Name
    pageIndex
    Type
    integer
    required
    required
    Description

    The index of the page of the item to update. Values are between 0 and 127 inclusive. If there is no such page for the given image size, an error will be thrown.

Query parameters

  • Name
    resize
    Type
    integer
    required
    required
    Description

    Whether or not to resize the image. Valid values are

    ValueEnumDescription
    0NO_RESIZEThe image is not resized
    1MAINTAIN_ASPECT_RATIOThe image is resized if the aspect ratio can be maintained
    2FORCED_FITThe image is resized regardless of earlier aspect ratio

    If NO_RESIZE is selected, then at most one image will be updated. For MAINTAIN_ASPECT_RATIO and FORCED_FIT all the existing image item properties for the given page will be updated. If the value does not correspond to a valid option, an error will be thrown.

body parameters

    object

    • Name
      imageFile
      Type
      string
      required
      Description

      The raw image data

Request

POST
/api/public/core/v1/items/{itemId}/page/{pageIndex}
curl -X POST https://<storeid>.<tenantname>.pcm.pricer-plaza.com/api/public/core/v1/items/{itemId}/page/{pageIndex} \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {token}"
  -d {"imageFile": "string"}

Response

{
  "requestId": "integer"
}