Codes

Accepted codes and formats for all Btwentyfour XML commerce messages

Order Type

Below is a list of accepted Order Types in C21 XML. The order type attribute has to either be empty or equal to one of the values listed below.

Order TypeDescription
REGULAR_ORDERIn-season order of goods from supplier’s remaining production batch (aka. “Refill-order”, “Re-Order”, “Top-up order”, “222”)
AUTOMATIC_REGULAR_ORDEROrder automatically created/triggered by algorithm (e.g. remaining stock level, trending sales)
CONTRACT_ORDEROrder contract agreed between buyer and supplier. (aka “Blanket order”, “221”)
CHECKOUT_ORDERCheckout of goods from previously agreed contract between buyer and supplier. (aka “Call-off order”, “226”)
PRE_ORDERPre-seasonal order of goods or services, according to conditions set out in an offer.
RETURN_ORDERReturn of previously ordered and delivered goods.
DROPSHIP_ORDERConsumer orders goods via an e-commerce retailer who ships directly to the consumer from a third party supplier.
DIRECT_SHIPMENT_ORDERSeller ships the order directly to the customer without any other stopping in the supply chain.
BACK_TO_BACK_ORDERCreated based on one or several sales orders for items the retailer does not keep in stock.
CONSIGNMENT_ORDERRequest to fill/increase the supplier’s consignment goods inventory at the retailer.
CLOSE_OUT_ORDERUsed by the buyer to indicate that goods are ordered from the supplier’s sale/clearance inventory.
FORECAST_ORDERUsed by the buyer to communicate predictions/estimates of future order quantities.

Code Example

<order currency="EUR" environment="production" orderType="REGULAR_ORDER" text="Btwentyfour Order Example">

Order Status

Order status attributes exist at both header level and item level with separate sets of values.

Header level

Order StatusDescription
ORDER_STATUS_REGISTEREDOrder is Registered
ORDER_STATUS_CANCELLEDOrder is Cancelled
ORDER_STATUS_SHIPPEDOrder is Shipped
ORDER_STATUS_INVOICEDOrder is Invoiced

Code Example

<orderResponse text="Btwentyfour Example Ordrsp" status="ORDER_STATUS_REGISTERED" currency="EUR">

Item level

Order StatusDescription
ORDER_LINE_STATUS_CANCELLEDOrder Line is Cancelled
ORDER_LINE_STATUS_SHIPPEDOrder Line is Shipped
ORDER_LINE_STATUS_INVALIDOrder Line is Invalid (e.g. invalid item)
ORDER_LINE_STATUS_INVOICEDOrder Line is Invoiced
ORDER_LINE_STATUS_REGISTEREDOrder Line is Registered
ORDER_LINE_STATUS_BACKORDEROrder Line is backordered

Code Example

<item status="ORDER_LINE_STATUS_REGISTERED">

Order Response Action Codes

Please note that all action codes are case sensitive.

Header level

ActionDescription
AcceptThe Order is accepted without changes
Accept With ChangesOrder is accepted with changes (changes specified on item/line-level)
CancelOrder is cancelled

Code Example

<property name="action">Accept With Changes</property>

Item level

ActionDescription
AcceptThe line item is accepted
CancelThe line item is cancelled
Quantity ChangeItem quantity is changed
Price ChangeItem price is changed
Delivery Date ChangeItem delivery date is changed
Shipping Date ChangeItem shipping date is changed
Item ChangeAn item is replaced or added compared to the original order
BackorderItem is backordered

Code Example

<property name="action">Price Change</property>

Order Change Action Codes

Please note that all action codes are case sensitive.

Header level

ActionDescription
CancelThe entire order is canceled
Order Type ChangeThe order’s order type is changed
Delivery Date ChangeThe order’s delivery date is changed
Consignee ChangeThe order’s consignee is changed
Ultimate Consignee ChangeThe order’s ultimate consignee is changed

Code Example

<property name="action">Delivery Date Change</property>

Item level

ActionDescription
AddThe line/item is added to the order
CancelThe line/item is canceled
Price ChangeThe line/item’s price is changed
Delivery Date ChangeThe line/item’s delivery date is changed
Quantity ChangeThe line/item’s quantity is changed
Barcode ChangeThe line/item’s barcode is changed
No ChangeNo change is requested for the line/item

Code Example

<property name="action">No Change</property>

Production & Test Environments

The environment attribute accepts the following values:

production test

Code Example

<order currency="EUR" environment="production" orderType="REGULAR_ORDER">

Item Number Format

Predefined barcode types that can be used in the itemReference element as the coding attribute:

EAN11 EAN13 EAN14 EAN8 ISBN UPCA UPCE CODE39 QR

Code Example

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

Unit of Measure

Unit of measure codes used in the unitOfMeasure item property element:

CodeDescription
PCEPieces
PAIPair
PACPack
SETSet

Code Example

<property name="unitOfMeasure">PCE</property>

INVOIC Allowance Codes

Code and name examples for the allowances element:

CodeName
ACAUnspecified allowance
QDQuantity discount
RAEReseller discount
DIMutually agreed discount, or the discount published in PRICAT

INVOIC Charge Codes

Code and name examples for the charges element:

CodeName
ABKUnspecified charge
FCFreight charge
ISInvoice services
AEVEnvironmental fee
INInsurance fee
HDHandling charge
PCPackaging cost

INVOIC Tax Codes

Code and name examples for the taxes element:

CodeName
VATValue added tax
ENGEnergy tax
ENVEnvironmental tax
ORGVAT on original invoice (only applicable with credit notes)

INVOIC Account Types

TypeDescription
SE.BGSwedish bankgiro
SE.PGSwedish postgiro
IBANIBAN
BICBIC
BankBank account number
BranchCodeBranch code/number
SwiftSwift

Currency Codes

ISO 4217 is the International Standard for currency codes. Use the standard three-letter ISO 4217 codes in all Btwentyfour messages (e.g. EUR, SEK, USD).

Country Codes

ISO 3166 is the International Standard for country codes and codes for their subdivisions. Use the Alpha-2 codes. See: ISO 3166 Alpha-2 country codes

Package Types

Examples of commonly used package types can be found at the GS1 website: GS1 packaging type codes

Party Information — Party Location Types

A comprehensive list of accepted location types and their associated codes.

CodeDescription
OSOnline Store
BMBrick-and-Mortar Store
DCDistribution Center
WHWarehouse
PUPop-Up Store
KKKiosk
HQHeadquarters
OFOther Facility
NSNot Specified