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 1000 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 1100 2
Btwentyfour message ID

Message ID set by Btwentyfour Omnichannel 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 1200 3
Btwentyfour message date

Message date set by Btwentyfour Omnichannel 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 1300 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 1400 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 1500 6
Sender Yes

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

 <sender gln="7340117836950"> 

/b24Message/stockReport/sender/#gln

Number 1600 7
Recipient Yes

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

 <recipient gln="7340117802900"> 

/b24Message/stockReport/recipient/#gln

Number 1700 8
Document 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 1800 9
Document Date Yes

Stock report date.

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

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

Date/Time 1900 10
Supplier

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 2000 11
Buyer Yes

The buyer/retailer/marketplace HQ, identified by GLN

 <buyer gln="7340117836950"> 

/b24Message/stockReport/buyer/#gln

Number 2100 12
Site Yes

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

 <location gln="3333333333333"> 

/b24Message/stockReport/site/location/#gln

Number 2200 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 2300 14
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 3000 21
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 3200 23
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 3400 25
Barcode with type Yes

The supplier's EAN/UPC code of the product

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

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

Number 3600 27
Quantity Type Yes

Type of reported quantity for the item from the specified stock site/warehouse. Options "OnHand" = number of pieces on hand at the reported stock site; "OnOrder" = Number of pieces on open order but not yet received at the reported stock site

 <quantity type="OnHand" value="6"> 

/b24Message/stockReport/site/stock/item/quantity[@type]

Text 4300 34
Quantity Value Yes

Number of pieces of the item reported from the specified stock site/warehouse and quantity type.

 <quantity type="OnHand" value="6"> 

/b24Message/stockReport/site/stock/item/quantity[@value]

Number 4400 35
Quantity State Type

Specification of current quantityState of reported quantity. Options: "Available" = available for sale at the reported site; "Allocated" = quantity already booked for customer order, relocation or for other reason not available for sale at the reported site.

 <quantityState type="Available" value="3"/> 

/b24Message/stockReport/site/stock/item/quantity/quantityState/[@type]

Text 4500 36
Quantity State Value

Number of pieces of the reported quantityState at the stock site. (Available value + Allocated value = OnHand Value)

 <quantityState type="Available" value="3"/> 

/b24Message/stockReport/site/stock/item/quantity/quantityState/[@value]

Number 4600 37