Documentation Powered by ReDoc

PLU List API (0.0.1)

Download OpenAPI specification:Download

A PLU list is a hierarchical list used in a checkout for navigating your way to non-barcoded items such as services or fruits and vegetables. Available actions to be able to supply PLU lists configuration for a particular store.

PLU lists are recursive structures that contain either item references (typically a non-barcoded item) or additional PLU references (representing a group containing sub groups or items).

Additional properties PLU List

Property key Data type Description
ItemCategoryId STRING An identifier for a merchandise structure.
ItemCategory.Code STRING Identifies a hierarchy level within a summarization tree structure for '
merchandise sales analysis and merchandise classification.
PriceSpecification.Id STRING A unique identifier for this price point. Observe that the merchandise
structure of the price line must be the same as for this item.

Extra additional properties

Extra POS properties(not defined above) can be added and they need to be prefixed with Pos.extra. as in the example below

"additionalProperties": [ {
"id": "Pos.extra.myExtraProperty",
"value": true,
"dataType": "BOOL"
}]}

Authentication

ocms

Machine authentication is supported with OCMS.

Security Scheme Type OAuth2
clientCredentials OAuth Flow
Token URL: https://auth.retailsvc.com/oauth2/token
Scopes:

    plu

    Add a PLU list. Requires permission ```plulist.wri

    Add a PLU list. Requires permission plulist.write

    Authorizations:
    ocms
    header Parameters
    Correlation-Id
    string <uuid>
    Example: fe0aded2-ba52-11eb-a075-e3d570c587ed

    Id used for tracking a request throughout the system(s).
    If not supplied, it will be automatically generated by this system.

    Request Body schema: application/json
    Array of objects (AdditionalProperty)

    Additional custom properties can be added via this field.

    businessUnitGroupId
    required
    string

    Identifier for the business unit group that this PLU list applies to.

    effectiveDate
    string <date>

    The date when this PLU list should be applied, if present.

    id
    required
    string <= 128 characters

    A unique identifier for the PLU list.

    Array of objects (ImagesType)

    A list of images that can be referenced by their id rather than embedded.

    required
    Array of PluGroupType (object) or PluItemType (object) (PluContentType)

    PLU lists can contain other PLU lists and/or items.

    Responses

    Request samples

    Content type
    application/json
    {
    • "businessUnitGroupId": "store-1",
    • "id": "top-5-items-plu",
    • "plu": [
      ]
    }