xml Stock

The Stock message intent is to exchange information related to stock levels

General usage

- The message includes functionality to differentiate classes of inventory, and to permit financial valuation of inventories facilitating price protection claims, auditing, statutory declarations, etc.
- The specified quantities relating to a product can indicate opening stock, closing stock, and goods movement (receipts or withdrawals) of held inventory, for a given time frame.
- The specified quantities can relate directly to a product or package, and may be sub-detailed within different groups or classes, e.g., batch, age, valuation, location, etc.

Name Required Description Examples Xpath Type Limits Sort Id
EDI message name

The name of the EDI message

 
 <stockReport text="Btwentyfour Example Stock Report" environment="Production" messageId="223456" messageDate="2021-12-23T12:19:05.167Z"  dateFrom="2021-12-22" dateTo="2021-12-22">

/b24Message/stockReport/@text

 Text 100 1
Environment

Environment/test indicator - either "Production" or "Test"

 
 <stockReport text="Btwentyfour Example Stock Report" environment="Production" messageId="223456" messageDate="2021-12-23T12:19:05.167Z"  dateFrom="2021-12-22" dateTo="2021-12-22">

/b24Message/stockReport/@environment

 Text 200 2
Btwentyfour message ID

Message ID set by Btwentyfour Open Commerce Platform.

 
 <stockReport text="Btwentyfour Example Stock Report" environment="Production" messageId="223456" messageDate="2021-12-23T12:19:05.167Z"  dateFrom="2021-12-22" dateTo="2021-12-22">

/b24Message/stockReport/@messageId

 Number 300 3
Btwentyfour message date

Message date set by Btwentyfour Open Commerce Platform.

 
 <stockReport text="Btwentyfour Example Stock Report" environment="Production" messageId="223456" messageDate="2021-12-23T12:19:05.167Z"  dateFrom="2021-12-22" dateTo="2021-12-22">

/b24Message/stockReport/@messageDate

 Date/Time 400 4
Date From

First stock reporting date in the file

 
 <stockReport text="Btwentyfour Example Stock Report" environment="Production" messageId="223456" messageDate="2021-12-23T12:19:05.167Z"  dateFrom="2021-12-22" dateTo="2021-12-22">

/b24Message/stockReport/dateFrom/#date

 Date/Time 500 5
Date To

Last stock reporting date in the file

 
 <stockReport text="Btwentyfour Example Stock Report" environment="Production" messageId="223456" messageDate="2021-12-23T12:19:05.167Z"  dateFrom="2021-12-22" dateTo="2021-12-22">

/b24Message/stockReport/dateTo/#date

 Date/Time 600 6
Sender Gln Yes

The sender of the EDI message, identified by a GLN.

 
 <sender gln="7340117836950">

/b24Message/stockReport/sender/#gln

 Number 700 7
Recipient Gln Yes

The recipient of the EDI message, identified by a GLN. (If the file contains multiple supplier items, recipient should always be Btwentyfour Open Commerce Platform.)

 
 <recipient gln="7340117802900">

/b24Message/stockReport/recipient/#gln

 Number 800 8
StockReport Number Yes

Stock report ID for the whole transaction.

 
 <documentReference documentType="stockReport" id="STOCK1X2345" date="2021-12-23">

/b24Message/stockReport/documentReference[@documentType="stockReport"]/@id

 Text 900 9
StockReport Date Yes

Stock report date.

 
 <documentReference documentType="stockReport" id="STOCK1X2345" date="2021-12-23">

/b24Message/stockReport/documentReference[@documentType="stockReport"]/@date

 Date/Time 1000 10
Supplier Gln

The supplier identified with by GLN (use only if the report contains items from one single supplier)

 
 <supplier gln="7340117815580">

/b24Message/stockReport/supplier/#gln

 Number 1100 11
Buyer Gln Yes

The buyer/retailer/marketplace HQ, identified by GLN

 
 <buyer gln="7340117836950">

/b24Message/stockReport/buyer/#gln

 Number 1200 12
Site Gln Yes

The specific site/warehouse/store holding the reported stock, identified with GLN

 
 <location gln="3333333333333">

/b24Message/stockReport/site/location/#gln

 Number 1300 13
Stock date Yes

Date and time of reported stock count

 
 <stock date="2021-12-22" id="160-36282308640-2021-12-22">

/b24Message/stockReport/site/stock/#date

 Date/Time 1400 14
Stock Id

A unique identification code used to identify the stock of the storage location at the exact date, Possibly a combination of the Location's own Id and the date such as "gln-2022-11-22"

 
 <stock date="2021-12-22" id="160-36282308640-2021-12-22">

/b24Message/stockReport/site/stock/@id

 Text 1500 15
Age Group

The intended age Group/category such as: Adult, Junior, Kids

 
 <property name="ageGroup">Adults</property>

/b24Message/stockReport/site/stock/item/property[@name="ageGroup"]

 Text 1600 16
Supplier Yes

The supplier of the item, identified by a GLN. (should be same for all items if supplier GLN is also specified in message header)

 
 <supplier gln="7340117815580">

/b24Message/stockReport/site/stock/item/supplier/#gln

 Number 1700 17
Color Description

Plain text description of the product color

 
 <dimension name="color" code="666">Black</dimension>

/b24Message/stockReport/site/stock/item/dimension[@name="color"]

 Text 1800 18
Age Group

Age category such as: Adults, Youth, Kids, and Toddler

 
 <property name="ageGroup">Adults</property>

/b24Message/stockReport/site/stock/item/property[@name = "ageGroup"]

 Text 1900 19
Brand

The brand of the product

 
 <property name="brand">B24 Running</property>

/b24Message/stockReport/site/stock/item/property[@name = "brand"]

 2000 20
Description

Description including product attributes that make up the specific item/SKU that is offered to the buyer/consumer. For Apparel/Footwear-products typically a combination of the model name, color and size, for cosmetics/beuaty-products the description could e.g. consist of model name, fragrance/scent and volume.

 
 <property name="description">Btwentyfour Running Shoe Black 38</property>

/b24Message/stockReport/site/stock/item/property[@name = "description"]

 Text 2100 21
Gender

The gender category of the product (b24 example values: "Male", "Female" or "Unisex")

 
  <property name="gender">Women</property>

/b24Message/stockReport/site/stock/item/property[@name = "gender"]

 Text 2200 22
GoodsClass Description

The Goods Freetext Description of the product. Standard classification systems are e.g. B24, Fedas, DTB or BTE

 
 <property code="170255" name="goodsClass" set="Fedas">170255</property>

/b24Message/stockReport/site/stock/item/property[@name = "goodsClass"]

 Text 2300 23
GoodsClass Code

The Goods Classification Code of the product. Standard classification systems are e.g. B24, Fedas, DTB or BTE

 
 <property code="170255" name="goodsClass" set="Fedas">170255</property>

/b24Message/stockReport/site/stock/item/property[@name = "goodsClass"]\@code

 Text 2400 24
GoodsClass Set

The Classification system set that the goodsclass belongs to, standard systems are B24, DTB, and BTE, but there are also Internal goodsclasses that can be sent, the goodsclass for them is not standardized however.

 
 <property code="170255" name="goodsClass" set="Fedas">170255</property>

/b24Message/stockReport/site/stock/item/property[@name = "goodsClass"]\@set

 Text 2500 25
Model Number

Idenficiation of the model of the article

 
 <property name="modelNo" registry="Supplier">1064</property>

/b24Message/stockReport/site/stock/item/property[@name = "modelNo"]

 Text 2600 26
Barcode

The supplier's EAN/UPC code of the product

 
 <itemReference coding="EAN13" registry="Supplier">1234567891125</itemReference>

/b24Message/stockReport/site/stock/item/itemReference[@registry="Supplier"]

 Number 2700 27
Barcode Type

The type of barcode, for example "EAN13" or "UPCA". For a complete list, see http://big.btwentyfour.com/codes#id1

<itemReference registry="Supplier"

 
 <itemReference coding="EAN13" registry="Supplier">1234567891125</itemReference>

/b24Message/stockReport/site/stock/item/itemReference[@registry="Supplier"]/@coding

 Text 2800 28
Quantity On Hand

Quantity of goods currently stored at the location

 
 <quantity type="OnHand" value="6">
            <quantityState type="Available" value="3" />
            <quantityState type="Allocated" value="3" />
 </quantity>

/b24Message/stockReport/site/stock/item/quantity[@type = "OnHand"]

 Number 2900 29
Available Quantity

Quantity of goods currently stored at the location that is available for sale

 
 <quantity type="OnHand" value="6">
            <quantityState type="Available" value="3" />
            <quantityState type="Allocated" value="3" />
 </quantity>

/b24Message/stockReport/site/stock/item/quantity[@type = "OnHand"]/quantityState[@type = "Available"]

 Number 3000 30
Allocated Quantity

Quantity of goods currently stored at the location that has already been allocated for sale

 
 <quantity type="OnHand" value="6">
            <quantityState type="Available" value="3" />
            <quantityState type="Allocated" value="3" />
 </quantity>

/b24Message/stockReport/site/stock/item/quantity[@type = "OnHand"]/quantityState[@type = "Allocated"]

 Number 3100 31
Quantity On Order

Quantity of goods that have been ordered to the location, currently awaiting delivery

 
 <quantity type="OnOrder" value="2" />

/b24Message/stockReport/site/stock/item/quantity[@type = "OnOrder"]

 Number 3200 32
Retail Price

The current list price the product has at the buyer's store location.

 
 <price type="retailPrice" value="200.00" currency="EUR" />

/b24Message/stockReport/site/stock/item/price[@type = "retailPrice"]

 Number 3300 33
Retail Price Currency

The currency of the product's retail Price

 
 <price type="retailPrice" value="200.00" currency="EUR" />

/b24Message/stockReport/site/stock/item/price[@type = "retailPrice"]\@currency

 Text 3400 34
Cost Price

The price that the product was bought from the Supplier.

 
 <price type="costPrice" value="80.00" currency="EUR" />

/b24Message/stockReport/site/stock/item/price[@type = "costPrice"]

 Number 3500 35
Cost Price Currency

The currency of the product's cost Price

 
 <price type="costPrice" value="80.00" currency="EUR" />

/b24Message/stockReport/site/stock/item/price[@type = "costPrice"]\@currency

 Text 3600 36