Products

Data Definition Document

Field Name	Field Type	Optional/Mandatory	Length	Description
Business Unit	Object	Mandatory
TypeCode	string	Optional		Available Values: [RetailStore]
ID	string	Mandatory

Item	Object	Mandatory
Action	string	Mandatory		Available Values: [AddItem, UpdateItem, DeleteItem, AddUpdateItem]
ItemID	Object	Mandatory
Type	string	Mandatory		Available Values[SKU]
ID	string	Mandatory

AlternativeItemIDs	Object	Optional		Allows the reporting of multiple itemid's for a single item from Head office, for example both the SKU and the barcode. One is the main and reported as the ItemID above, the others are reported here
Type	string	Mandatory
ID	string	Mandatory
MerchandiseHierarchy	Object[]	Mandatory
Level	string	Mandatory		Free Text
Value	string	Mandatory		Free Text
Brand	string	Optional		Unique name to denote the item as a product of a single manufacturer or supplier
Manufacturer	Object	Optional
Id	string	Mandatory
Name	string	Optional	35
Grade	Object	Optional
Id	string	Optional
Name	string	Optional
Brand	Object	Optional
Id	string	Optional
Name	string	Optional
Manufacturer	Object	Optional
Id	string	Optional
Name	string	Optional
Item Price	Object	Optional
Currency	string	Optional	3
ValueTypeCode
Amount	decimal	Mandatory
SupplierInformation	Object	Optional
SupplierID	string	Mandatory		A code assigned by the retailer to uniquely identify the supplier
SupplierName	string	Mandatory		A friendly name for this supplier.
Description	string	Optional		The description of the SUPPLIER ITEM
SupplierItemID	string	Mandatory		The code assigned by the supplier to uniquely identify the ITEM
AvailabilityStatus	string	Mandatory		A code to signify the availability of the SUPPLIER ITEM
SalesUnitPerPackUnitQuantity	integer	Optional		The number of retail sale units in the supplier item pack. For example 24 cans of Coke (the retail sale units) in a case (supplier item pack) or 4 six packs (the retail sale units) in a case (supplier item pack).
Brand	string	Optional		Unique name to denote the item as a product of a single manufacturer or supplier
Group	Object	Optional
GroupID	string	Optional		A user defined field used to enable arbitrary grouping of items. The ID field combined with the type allows the implementation of mulitple programs of the same type.
GroupType	string	Optional		A user defined field used to indicate to consuming systems the type of group. This would allow the consuming application to determine the context of the group and behave accordingly. Examples would be Mixmatch, discount, suggestive selling, prerequisite tools, price optimization, substitution, loyalty programs, incompatible items, quantity restrictions, time restrictions, premium eligible item, parking validation

JSON

"ProductMaintenance": {
  "ProductID": "12345678",
  "StatusCode": "Active",
  "AlternativeProductIDs": [
    {
      "Type": "UPI",
      "ID": "ABCD123"
    },
    {
      "Type": "UPC",
      "ID": "221341234"
    },
    {
      "Type": "HOID",
      "ID": "ZXY123"
    },
    {
      "Type": "SKU",
      "ID": "3915:ABcCD123"
    },
  ],
  "Attributes": [
      {
          "AttributeName": "BrandName",
          "AttributeValue": "Novo"
      }
  ],
  "MerchandiseHierarchy": [
    {
        "Level": "Department",
        "Value": "Men’s clothing"
    },
    {
        "Level": "SubDepartment",
        "Value": "Men’s clothing"
    },
    {
        "Level": "Category",
        "Value": "Clothing"
    },
    {
        "Level": "Sub-Category",
        "Value": "Clothing Mens"
    },
  ],
  "ManufacturerInformation": [
      {
          "Manufacturer": {
              "ID": "?",
              "Name": "NOVO NORDISK PHARMA"
          },
          "AlternativeManufacturerIDs": [
              {
                  "Type": "USI",
                  "ID": 6036
              }
          ]
      }
  ],
  "ProductPrice": [
    {
        "Currency": "AUD",
        "ValueTypeCode": "RegularSalesUnitPrice",
        "Amount": "2.60"
    },
    {
        "Currency": "AUD",
        "ValueTypeCode": "UnitListPrice",
        "Amount": "2.40"
    },
    {
        "Currency": "AUD",
        "ValueTypeCode": "VolumeDiscountPrice",
        "Amount": "2.20"
    }
  ],
  "TaxInformation": [
    {
         "TaxType": "GST",
         "TaxGroupID": "D",
         "TaxPercent": "10"
    },
    {
         "TaxType": "PST",
         "TaxGroupID": "D",
         "TaxPercent": "10"
    }
  ],
  "Display": {
      "Description": {
        "Text": "Cowboy Shirt"
      },
      "ShelfLabel": {
        "Text": "Shirt"
      }
  }
}

4.1.8 Scenario: Add Item with Multiple Item ID’s

Brief Description

We have to receive both SKU and barcode(s) item identifiers from Head Office with all other data of the article.

Data

Item sale data, including:
- An identifiers for the item being sold.

4.1.8 Conformance XML Instance Document – Add Item with Multiple Item ID’s

JSON

{
   "BusinessUnit": {
      "TypeCode": "RetailStore",
      "ID": "100"
   },
   "Item": {
      "Action": "AddItem",
      "ItemID": {
         "Type": "SKU",
         "ID": "12345678"
      },
      "AlternativeItemID": {
         "Type": "UPC",
         "ID": "221341234"
      }
   }
}

4.5 Use Case: Display Item Names and/or Descriptions

4.5.1 Scenario: Display Item Names in Different Languages for Both the Customer and Operator

Brief Description

Data Item:

An identifier for the items.
The unit price for the item.

4.5.1 Conformance XML Instance Document — Display Item Names in Different Languages for Both the Customer and Operator

JSON

{
  "Item": {
      "ItemCategory": "Stock",
      "Action": "ChangeItem",
      "ItemID": {
         "Type": "SKU",
         "ID": "2345"
      },
      "Display": {
         "Language": "eng",
         "Name": "Shirt",
         "ShortName": "Shirt",
         "Description": {
            "Language": "eng",
            "Text": "Cowboy Shirt"
         },
         "ShelfLabel": {
            "Format": "String",
            "Text": "Shirt"
         },
         "TradeItemDescription": "123456789012345678901234567890123456789012345678901234567890123\n45678901234567890123456789012345678901234567890123456789012345678901234567890123"
      }
   }
}

6.1 Scenario: Sell item which is subject to tax

Brief Description:

Sell item which is subject to one or more tax authorities Minimal piece of information is Tax Group ID

Data

Common item and price data
Tax common data

6.1 Conformance JSON Instance Document – Sell item which is subject to tax

JSON

{
  "Item": {
      "ItemCategory": "Stock",
      "Action": "ChangeItem",
      "ItemID": {
         "Type": "SKU",
         "ID": "String"
      },
      "ItemPrice": {
         "ValueTypeCode": "RegularSalesUnitPrice",
         "Value": "3.14"
      },
      "TaxInformation": {
         "TaxType": "Sales",
         "TaxGroupID": "D",
         "TaxPercent": "10"
      }
   }
}