Data in this section is described in accordance with the GS1 Standard: https://www.gs1.org/.
In this section, the following information about the Item Catalogue data is presented:
- Item Catalogue Settings in CStoreOffice®
- Item Catalogue Data Mapping Table
- XML Example with Item Catalogue Data
- Item Catalogue Data Export via the Business Documents API
Prerequisites
- The Item Catalogue data becomes accessible through the Business Documents API only after items have been added or updated in Price Book through CStoreOffice®.
- To access the complete list of price book items for your account, submit a ticket to Petrosoft Support to perform the initial full item catalog upload.
Item Catalogue Settings in CStoreOffice®
Item catalogue contains newly added or edited Items in the CStoreOffice® Account (Company). For the initial load all items shall be sent in the document set. In CStoreOffice®, Item Catalogue data can be found in the following forms:
- Item Setup Form
This form can be opened from Price Book > Items. For more information, see Items.
- Promotion Form
This form can be opened from Price Book > Promotions. For more information, see Promotions.
Item Catalogue Data Mapping Tables
Item Catalogue data from the above form is converted to XML data according to the Item Catalogue Data Mapping Tables which are presented below.
Item Catalogue Data Mapping Table
Report Header
|
XML Path |
CSO Source |
|
catalogueItemNotificationMessage/ StandardBusinessDocumentHeader/HeaderVersion |
Always filled with "1.0". |
|
catalogueItemNotificationMessage/ StandardBusinessDocumentHeader/Sender/Identifier{Authority} |
Always {Authority}="GS1". |
|
catalogueItemNotificationMessage/ StandardBusinessDocumentHeader/ Sender/contactInformation/contact |
Manager's Name and Surname. |
|
catalogueItemNotificationMessageStandard BusinessDocumentHeader/Receiver/ Identifier{Authority} |
Always {Authority}="GS1". |
|
catalogueItemNotificationMessageStandard BusinessDocumentHeader/ DocumentIdentification/Standard |
Standard for message sending, here "GS1". |
|
catalogueItemNotificationMessageStandard BusinessDocumentHeader/ DocumentIdentification/TypeVersion |
Standard's version, here "3.1". |
|
catalogueItemNotificationMessageStandard BusinessDocumentHeader/ DocumentIdentification/InstanceIdentifier |
Always filled with "0". |
|
catalogueItemNotificationMessageStandard BusinessDocumentHeader/ DocumentIdentification/Type |
Always filled with "catalogueItemNotification". |
|
catalogueItemNotificationMessageStandard BusinessDocumentHeader/ DocumentIdentification/CreationDateAndTime |
Document creation date and time. |
Report Data
To learn more about CStoreOffice® forms and entities mentioned in the Description and CSO Source columns, use the Item Catalogue Settings in CStoreOffice® section or Petrosoft University Portal.
XML Example with Item Catalogue Data
The example below is taken from the testing environment with testing data. No association with any real company, product, event, or data is intended or should be inferred.
XML Example with Item Catalogue Data
<?xml version="1.0"?>
<catalogueItemNotificationMessage>
<StandardBusinessDocumentHeader>
<HeaderVersion>1.0</HeaderVersion>
<Sender>
<Identifier Authority="GS1">178</Identifier>
<contactInformation>
<contact/>
</contactInformation>
</Sender>
<Receiver>
<Identifier Authority="GS1"/>
</Receiver>
<DocumentIdentification>
<Standard>GS1</Standard>
<TypeVersion>3.1</TypeVersion>
<InstanceIdentifier>0</InstanceIdentifier>
<Type>catalogueItemNotification</Type>
<CreationDateAndTime>2021-08-16T14:54:09-04:00</CreationDateAndTime>
</DocumentIdentification>
</StandardBusinessDocumentHeader>
<transaction>
<transactionIdentification>
<entityIdentification>n/a</entityIdentification>
<contentOwner>
<gln>0000000000000</gln>
</contentOwner>
</transactionIdentification>
<documentCommand>
<documentCommandHeader type="ADD">
<documentCommandIdentification>
<entityIdentification>n/a</entityIdentification>
<contentOwner>
<gln>0000000000000</gln>
</contentOwner>
</documentCommandIdentification>
</documentCommandHeader>
<catalogueItemNotification>
<creationDateTime>2021-08-16T14:54:09-04:00</creationDateTime>
<documentStatusCode>ORIGINAL</documentStatusCode>
<catalogueItemNotificationIdentification>
<entityIdentification>n/a</entityIdentification>
<contentOwner>
<gln>0000000000000</gln>
</contentOwner>
</catalogueItemNotificationIdentification>
<isReload>false</isReload>
<catalogueItem>
<catalogueItemState>
<catalogueItemStateCode>REGISTERED</catalogueItemStateCode>
</catalogueItemState>
<tradeItem>
<gtin>00000710900003</gtin>
<additionalTradeItemIdentification additionalTradeItemIdentificationTypeCode="UPC">71090000 </additionalTradeItemIdentification>
<additionalTradeItemIdentification additionalTradeItemIdentificationTypeCode="PLU">0 </additionalTradeItemIdentification>
<contextIdentification>1</contextIdentification>
<isTradeItemABaseUnit>true</isTradeItemABaseUnit>
<isTradeItemAConsumerUnit>true</isTradeItemAConsumerUnit>
<isTradeItemADespatchUnit>false</isTradeItemADespatchUnit>
<isTradeItemAnInvoiceUnit>false</isTradeItemAnInvoiceUnit>
<isTradeItemAnOrderableUnit>true</isTradeItemAnOrderableUnit>
<tradeItemUnitDescriptorCode>BASE_UNIT_OR_EACH</tradeItemUnitDescriptorCode>
<informationProviderOfTradeItem/>
<gdsnTradeItemClassification>
<gpcCategoryCode>00000000</gpcCategoryCode>
<gpcCategoryName>n/a</gpcCategoryName>
<additionalTradeItemClassification>
<additionalTradeItemClassificationValue>
<additionalTradeItemClassificationCodeValue>300 </additionalTradeItemClassificationCodeValue>
<additionalTradeItemClassificationCodeDescription>CATEGORY </additionalTradeItemClassificationCodeDescription>
</additionalTradeItemClassificationValue>
<additionalTradeItemClassificationValue>
<additionalTradeItemClassificationCodeValue>306 </additionalTradeItemClassificationCodeValue>
<additionalTradeItemClassificationCodeDescription>DEPARTMENT </additionalTradeItemClassificationCodeDescription>
</additionalTradeItemClassificationValue>
<additionalTradeItemClassificationValue>
<additionalTradeItemClassificationCodeValue>1_300 </additionalTradeItemClassificationCodeValue>
<additionalTradeItemClassificationCodeDescription>ITEM_TAG </additionalTradeItemClassificationCodeDescription>
</additionalTradeItemClassificationValue>
<additionalTradeItemClassificationValue>
<additionalTradeItemClassificationCodeValue>2_306 </additionalTradeItemClassificationCodeValue>
<additionalTradeItemClassificationCodeDescription>ITEM_TAG </additionalTradeItemClassificationCodeDescription>
</additionalTradeItemClassificationValue>
<additionalTradeItemClassificationValue>
<additionalTradeItemClassificationCodeValue>242_0 </additionalTradeItemClassificationCodeValue>
<additionalTradeItemClassificationCodeDescription>ITEM_TAG </additionalTradeItemClassificationCodeDescription>
</additionalTradeItemClassificationValue>
<additionalTradeItemClassificationValue>
<additionalTradeItemClassificationCodeValue>249_0 </additionalTradeItemClassificationCodeValue>
<additionalTradeItemClassificationCodeDescription>ITEM_TAG </additionalTradeItemClassificationCodeDescription>
</additionalTradeItemClassificationValue>
<additionalTradeItemClassificationValue>
<additionalTradeItemClassificationCodeValue>251_0 </additionalTradeItemClassificationCodeValue>
<additionalTradeItemClassificationCodeDescription>ITEM_TAG </additionalTradeItemClassificationCodeDescription>
</additionalTradeItemClassificationValue>
<additionalTradeItemClassificationValue>
<additionalTradeItemClassificationCodeValue>259_2127 </additionalTradeItemClassificationCodeValue>
<additionalTradeItemClassificationCodeDescription>ITEM_TAG </additionalTradeItemClassificationCodeDescription>
</additionalTradeItemClassificationValue>
<additionalTradeItemClassificationValue>
<additionalTradeItemClassificationCodeValue>1859_2295 </additionalTradeItemClassificationCodeValue>
<additionalTradeItemClassificationCodeDescription>ITEM_TAG </additionalTradeItemClassificationCodeDescription>
</additionalTradeItemClassificationValue>
<additionalTradeItemClassificationValue>
<additionalTradeItemClassificationCodeValue>2101_2282 </additionalTradeItemClassificationCodeValue>
<additionalTradeItemClassificationCodeDescription>ITEM_TAG </additionalTradeItemClassificationCodeDescription>
</additionalTradeItemClassificationValue>
<additionalTradeItemClassificationValue>
<additionalTradeItemClassificationCodeValue>2119_0 </additionalTradeItemClassificationCodeValue>
<additionalTradeItemClassificationCodeDescription>ITEM_TAG </additionalTradeItemClassificationCodeDescription>
</additionalTradeItemClassificationValue>
<additionalTradeItemClassificationValue>
<additionalTradeItemClassificationCodeValue>2137_0 </additionalTradeItemClassificationCodeValue>
<additionalTradeItemClassificationCodeDescription>ITEM_TAG </additionalTradeItemClassificationCodeDescription>
</additionalTradeItemClassificationValue>
<additionalTradeItemClassificationValue>
<additionalTradeItemClassificationCodeValue>2164_0 </additionalTradeItemClassificationCodeValue>
<additionalTradeItemClassificationCodeDescription>ITEM_TAG </additionalTradeItemClassificationCodeDescription>
</additionalTradeItemClassificationValue>
<additionalTradeItemClassificationValue>
<additionalTradeItemClassificationCodeValue>2254_0 </additionalTradeItemClassificationCodeValue>
<additionalTradeItemClassificationCodeDescription>ITEM_TAG </additionalTradeItemClassificationCodeDescription>
</additionalTradeItemClassificationValue>
</additionalTradeItemClassification>
</gdsnTradeItemClassification>
<targetMarket>
<targetMarketCountryCode>124</targetMarketCountryCode>
</targetMarket>
<tradeItemInformation>
<productionVariantEffectiveDateTime>2019-12-19T00:00:00-05:00 </productionVariantEffectiveDateTime>
<extension>
<tradeItemDescriptionModule>
<tradeItemDescriptionInformation>
<descriptionShort languageCode="EN">LEX12 10 PEN</descriptionShort>
<tradeItemDescription languageCode="EN">LEX12 10 PENNY VAPING KIT </tradeItemDescription>
</tradeItemDescriptionInformation>
</tradeItemDescriptionModule>
<tradeItemMeasurementsModule>
<tradeItemMeasurements>
<avpList>
<stringAVP attributeName="Size">EA</stringAVP>
<stringAVP attributeName="Measure Type">piece</stringAVP>
</avpList>
</tradeItemMeasurements>
</tradeItemMeasurementsModule>
<x1:salesInformationModule xmlns:x1="urn:gs1:gdsn:sales_information:xsd:3">
<tradeItemPriceInformation/>
<avpList>
<stringAVP attributeName="Vendor ID">3388</stringAVP>
<stringAVP attributeName="VIN">459712</stringAVP>
<stringAVP attributeName="Unit in Case">1</stringAVP>
</avpList>
</x1:salesInformationModule>
</extension>
</tradeItemInformation>
<tradeItemSynchronisationDates>
<lastChangeDateTime>2021-08-16T14:54:09-04:00</lastChangeDateTime>
</tradeItemSynchronisationDates>
<avpList>
<stringAVP attributeName="Manufacturer Id">7</stringAVP>
<stringAVP attributeName="IsNotForSale">0</stringAVP>
<stringAVP attributeName="Active">1</stringAVP>
<stringAVP attributeName="Item Linkable">0</stringAVP>
</avpList>
</tradeItem>
</catalogueItem>
</catalogueItemNotification>
</documentCommand>
</transaction>
</catalogueItemNotificationMessage>
To download the XML Example with Item Catalogue Data XML file, click here.
Item Catalogue Data Export via the Business Documents API
To export the XML files with the Item Catalogue data via the Business Documents API:
- Start calling the API from the
/account-level-resourcesendpoint. - Use price-book-item as the Document type identifier value.
For more information, see Calling the Business Documents API at the Account Level.
