Any given XML element in the NAMM B2B standard might appear in multiple documents, making consistent element definition, validation, and use across documents critical. It is therefore useful to be able to determine, for any given tag, the documents and context in which it appears.
Below is an alphabetical list of all XML elements used in the B2B standard documents, the documents in which they appear, their data types, lengths, and any pertinent notes about content, range, source, or values.
Document name abbreviations used in the “Appears In” column are:
-
AS = Advanced Shipment Notice
-
FA = Functional Acknowledgement
-
IN = Invoice
-
IT = Item
-
PB = Price Book
-
PO = Purchase Order
-
PR = Purchase Order Status Request
-
PS = Purchase Order Status
-
PY = Party
-
ST = Sell Through
Data type abbreviations used in the “Type” column are:
-
C = Complex/Container
-
D = Date
-
F = Flag (Y/N, C/D, etc.)
-
I = Integer
-
N = Numeric (decimal)
-
S = String
-
U = URL/URI
Tag |
Appears In |
Type |
Len |
Notes |
<Address> |
AS IN PB PO PS PY ST |
C |
- |
|
<Address1> |
AS IN PB PO PS PY ST |
S |
35 |
Based on UPS fields |
<Address2> |
AS IN PB PO PS PY ST |
S |
35 |
Based on UPS fields |
<Address3> |
AS IN PB PO PS PY ST |
S |
35 |
Based on UPS fields |
<AnnounceDate> |
IT |
D |
10 |
ISO format: YYYY-MM-DD |
<ASNRequirement> |
PO |
F |
1 |
“Y” or “N” |
<Attn> |
AS IN PB PO PS PY ST |
S |
35 |
Based on UPS fields |
<Audio> |
IT |
U |
|
Audio URL |
<Audios> |
IT |
C |
- |
|
<Availability> |
IT |
C |
- |
|
<Available> |
IT |
S |
|
"YES", "NO", "LOW", "MEDIUM", or "HIGH" |
<AvailableDate> |
IT |
D |
10 |
ISO format: YYYY-MM-DD |
<Backorder> |
PO |
F |
1 |
“Y” or “N” |
<Barcode> |
IT |
C |
- |
|
<BarCodeId> |
AS IN PB PO ST |
S |
14 |
GTIN-12 (UPC), GTIN-13 (EAN/JAN), GTIN-14 (GTIN-14), or Vendor Part Number |
<Barcodes> |
IT |
C |
- |
|
<BarCodeType> |
AS IN PB PO ST |
S |
10 |
“GTIN-12”, “GTIN-13”, “GTIN-14”, or “PartNumber” |
<BillTo> |
IN PO |
C |
- |
|
<BrandName> |
IT |
S |
50 |
Item brand name |
<Bullet> |
IT |
S |
|
Item bullet point |
<Bullets> |
IT |
C |
- |
|
<BuyerItemDesc> |
AS PO |
S |
50 |
Buyer’s item description |
<BuyerItemId> |
AS IN PO ST |
S |
25 |
Buyer’s item ID |
<BuyerName> |
IN PO PS |
S |
35 |
Buyer company name |
<BuyerOrderId> |
AS IN PO PR PS |
S |
25 |
Buyer’s order ID |
<BuyerOrderIds> |
PR |
C |
- |
|
<Category> |
IT |
S |
|
Item category |
<City> |
AS IN PB PO PS PY ST |
S |
30 |
Based on UPS fields |
<Comments> |
IN |
S |
250 |
Comments |
<Condition> |
IT |
S |
|
Item condition |
<ConfNbr> |
AS |
S |
25 |
Confirmation number |
<Container> |
AS IT |
C |
- |
|
<ContainerId> |
AS |
S |
25 |
Container ID |
<ContainerQty> |
AS |
I |
6 |
6 digits, as 999999 |
<Containers> |
AS IT |
C |
- |
|
<Contributor> |
IT |
S |
|
Item contributor |
<Copyright> |
IT |
C |
- |
|
<CopyrightLine> |
IT |
S |
|
Copyright line (text) |
<Country> |
AS IN PB PO PS PY ST |
S |
50 |
Country name |
<CountryCode> |
AS IN PB PO PS PY ST |
S |
2 |
ISO standard |
<CountryOrigin> |
IT |
S |
50 |
Item country of origin |
<Credits> |
IT |
C |
- |
|
<Data> |
IT |
C |
- |
|
<DateBeginShip> |
PO |
D |
10 |
ISO format: YYYY-MM-DD |
<DateCancel> |
PO |
D |
10 |
ISO format: YYYY-MM-DD |
<DateEndShip> |
PO |
D |
10 |
ISO format: YYYY-MM-DD |
<DateOrdered> |
PO PS |
D |
10 |
ISO format: YYYY-MM-DD |
<DateShipped> |
IN |
D |
10 |
ISO format: YYYY-MM-DD |
<DBA> |
PY |
S |
35 |
Doing Business As name |
<Description> |
PY |
S |
|
Partner location description |
<DimUOM> |
IT |
S |
5 |
From UOM table |
<Document> |
IT |
U |
|
Document URL |
<Documents> |
IT |
C |
- |
|
<Email> |
PY |
S |
100 |
Email address |
<EndDate> |
PY ST |
D |
10 |
ISO format: YYYY-MM-DD |
<EndOfProductionDate> |
IT |
D |
10 |
ISO format: YYYY-MM-DD |
<EstDeliver> |
AS |
D |
10 |
ISO format: YYYY-MM-DD |
<EstimatedShipDate> |
PS |
D |
10 |
ISO format: YYYY-MM-DD |
<ExtendedAttributes> |
IT |
C |
- |
|
<ExtendedCostValue> |
IN |
N |
10 |
5.4, as 12345.6789 |
<ExtendedCurrencyCode> |
IN |
S |
3 |
ISO standard currency code |
<Fax> |
PY |
S |
24 |
Fax number |
<FreightTotal> |
IN |
N |
10 |
5.4, as 12345.6789 |
<Height> |
IT |
N |
10 |
5.4, as 12345.6789 |
<ICQtyPerUOM> |
AS PO |
N |
10 |
5.4, as 12345.6789 |
<ICUOM> |
AS PO |
S |
5 |
From UOM table |
<Id> |
AS FA IN IT PB PO PR PS ST |
S |
50 |
Unique document ID |
<Image> |
IT |
U |
256 |
Image URL |
<Images> |
IT |
C |
- |
|
<IncoTermsCode> |
IN PO |
S |
3 |
From Inco Terms table |
<IncoTermsDesc> |
IN PO |
S |
35 |
From Inco Terms table |
<InvoiceDate> |
IN |
D |
10 |
ISO format: YYYY-MM-DD |
<InvoiceDetail> |
IN |
C |
- |
|
<InvoiceDueDate> |
IN |
D |
10 |
ISO format: YYYY-MM-DD |
<InvoiceHeader> |
IN |
C |
- |
|
<InvoiceId> |
IN |
S |
32 |
|
<InvoiceLineNbr> |
IN |
I |
6 |
6 digits, as 999999 |
<InvoiceSummary> |
IN |
C |
- |
|
<InvoiceTotal> |
IN |
N |
10 |
5.4, as 12345.6789 |
<InvoiceType> |
IN |
F |
1 |
“C” or “D” (Credit/Debit invoice) |
<Item> |
AS IN IT PB PO PS ST |
C |
- |
|
<ItemAttrs> |
AS |
C |
- |
|
<ItemDescLong> |
IT |
S |
|
Long item description |
<ItemFamily> |
IT |
S |
|
Item family |
<ItemId> |
AS |
C |
- |
|
<ItemQty> |
AS |
C |
- |
|
<Items> |
IN IT PB PO PS ST |
C |
- |
|
<ItemUOMCode> |
AS |
S |
5 |
From UOM table |
<ItemUOMDesc> |
AS |
S |
15 |
From UOM table |
<Keyword> |
IT |
S |
|
Item keyword |
<Keywords> |
IT |
C |
- |
|
<Kit> |
IT |
F |
1 |
“Y” or “N” |
<Length> |
IT |
N |
10 |
5.4, as 12345.6789 |
<Level> |
PB |
C |
- |
|
<LevelMax> |
PB |
I |
|
Level maximum |
<LevelMin> |
PB |
I |
|
Level minimum |
<Levels> |
PB |
C |
- |
|
<LevelUOM> |
PB |
S |
|
From UOM table |
<LineTotal> |
IN |
N |
10 |
5.4, as 12345.6789 |
<Location> |
PY ST |
C |
- |
|
<Locations> |
PY ST |
C |
- |
|
<MarketingInfo> |
IT |
C |
- |
|
<MasterBOL> |
AS |
S |
25 |
Master Bill Of Lading ID |
<MCQtyPerUOM> |
AS PO |
I |
6 |
6 digits, as 999999 |
<MCUOM> |
AS PO |
S |
5 |
From UOM table |
<Media> |
IT |
C |
- |
|
<MiscCharge> |
IN |
N |
10 |
5.4, as 12345.6789 |
<Name> |
AS IN PB PO PS PY ST |
S |
35 |
Based on UPS fields |
<NAMM_ASN> |
AS |
C |
- |
Root container/file identifier |
<NAMM_FunctionalAcknowledgement> |
FA |
C |
- |
Root container/file identifier |
<NAMM_Invoice> |
IN |
C |
- |
Root container/file identifier |
<NAMM_ITEM> |
IT |
C |
- |
Root container/file identifier |
<NAMM_PARTY> |
PY |
C |
- |
Root container/file identifier |
<NAMM_POStatusRequest> |
PR |
C |
- |
Root container/file identifier |
<NAMM_POStatus> |
PS |
C |
- |
Root container/file identifier |
<NAMM_PO> |
PO |
C |
- |
Root container/file identifier |
<NAMM_PRICEBOOK> |
PB |
C |
- |
Root container/file identifier |
<NAMM_SELLTHROUGH> |
ST |
C |
- |
Root container/file identifier |
<Order> |
AS |
C |
- |
|
<Orders> |
AS |
C |
- |
|
<PackListNbr> |
IN |
S |
25 |
Packing list number |
<PartyId> |
AS FA IN PB PO PR PS PY ST |
S |
25 |
GLN or NAMM ID. If using GLN, then 13 digits w/possible leading zeros denoting location. Otherwise, NAMM ID + “*” + five digits denoting location. |
<PartyIdType> |
PY |
S |
4 |
“GLN” or “NAMM” |
<PaymentTerms> |
PS |
C |
- |
|
<Phone> |
PY |
S |
24 |
Phone number |
<POComments> |
PO |
S |
250 |
Comments |
<PODetail> |
PO |
C |
- |
|
<POFileType> |
PO |
S |
1 |
“P” or “A”, indicating Pre-accepted or Accepted PO |
<POHeader> |
PO |
C |
- |
|
<POLineNbr> |
AS IN PO PS |
I |
6 |
6 digits, as 999999 |
<PORevisionNumber> |
PO |
I |
6 |
6 digits, as 999999 |
<PostalCode> |
AS IN PB PO PS PY ST |
S |
9 |
ZIP 5+4 format w/o dash |
<POStatusIndicator> |
PO |
S |
1 |
“N” or “U”, indicating New or Updated PO |
<POStatusRequestId> |
PS |
S |
|
Unique document ID |
<Price> |
IT PB |
N |
10 |
5.4, as 12345.6789 |
<Pricing> |
IT |
C |
- |
|
<PrimaryCategory> |
IT |
S |
|
Item primary category |
<ProductURL> |
IT |
U |
500 |
URL for product information |
<PRONbr> |
AS |
S |
25 |
Shipment PRO number |
<Publisher> |
IT |
S |
|
Musical composition publisher |
<Qty> |
AS IN PO PS ST |
N |
10 |
5.4, as 12345.6789 |
<QtyOnHand> |
IT ST |
I |
|
Quantity on hand |
<QtyPerUOM> |
IT |
I |
|
Quantity per UOM |
<QtyUOM> |
IN PO ST |
S |
5 |
From UOM table |
<QueryURL> |
IT |
S |
|
Query URL |
<RelatedItem> |
IT |
C |
- |
|
<RelatedItems> |
IT |
C |
- |
|
<RemitTo> |
IN |
C |
- |
|
<ReplacementID> |
IT |
S |
25 |
The SupplierItemID that replaces the item |
<RetailCurrencyCode> |
IN PO |
S |
3 |
ISO standard currency code |
<RetailValue> |
IN PO PS |
N |
10 |
5.4, as 12345.6789 |
<RevisionDate> |
PY |
D |
10 |
ISO format: YYYY-MM-DD |
<SalesRep> |
IN |
S |
35 |
Sales rep name |
<SalesTax> |
IN |
N |
10 |
5.4, as 12345.6789 |
<SalesTotal> |
ST |
N |
10 |
5.4, as 12345.6789 |
<SalesTotalCurrencyCode> |
ST |
S |
3 |
ISO standard currency code |
<SealId> |
AS |
S |
25 |
Container seal ID |
<SecondaryCategories> |
IT |
C |
- |
|
<SequenceNbr> |
PS |
I |
|
PO item sequence number |
<Serialized> |
IT |
F |
1 |
“Y” or “N” |
<SerialNbr> |
AS |
S |
25 |
Item serial number |
<SerialNbrs> |
AS |
C |
- |
|
<ShipDate> |
PS |
D |
|
ISO format: YYYY-MM-DD |
<ShipFrom> |
AS |
C |
- |
|
<ShipInstructions> |
IN PO |
S |
250 |
Shipping instructions |
<ShipmentHeader> |
AS |
C |
- |
|
<ShipmentId> |
AS IN |
S |
25 |
Shipment ID |
<ShipmentIds> |
IN |
C |
- |
|
<ShipmentItemQty> |
AS |
I |
6 |
6 digits, as 999999 |
<ShipmentQty> |
AS |
C |
- |
|
<ShipmentRefs> |
AS |
C |
- |
|
<ShipmentTerms> |
PS |
C |
- |
|
<ShipmentType> |
AS |
S |
25 |
Shipment type |
<Shipped> |
AS |
D |
10 |
ISO format: YYYY-MM-DD |
<ShipperTrackingNumber> |
AS |
S |
25 |
Tracking number |
<ShipTo> |
AS IN PO |
C |
- |
|
<SoldTo> |
AS FA IN PB PO PR PS ST |
C |
- |
|
<StartDate> |
PY ST |
D |
10 |
ISO format: YYYY-MM-DD |
<State> |
AS IN PB PO PS PY ST |
S |
2 |
State code |
<StatusCode> |
FA PS |
S |
3 |
Status code |
<StatusMessage> |
FA PS |
S |
10 |
Status message |
<StdContainer> |
AS |
C |
- |
|
<StdContainerType> |
AS |
S |
|
Container type |
<StdPack> |
AS |
C |
- |
|
<StdPackType> |
AS |
S |
|
Package type |
<SubTitle> |
IT |
S |
|
Item topic subtitle |
<SuperTitle> |
IT |
S |
|
Item topic supertitle |
<Supplier> |
AS FA IN PB PO PR PS ST |
C |
- |
|
<SupplierId> |
IT |
S |
25 |
GLN or NAMM ID. If using GLN, then 13 digits w/possible leading zeros denoting location. Otherwise, NAMM ID + “*” + five digits denoting location. |
<SupplierItemDesc> |
AS IN IT |
S |
50 |
Supplier item description |
<SupplierItemId> |
AS IN IT PB PO ST |
S |
25 |
Supplier item ID |
<SupplierModel> |
IT |
S |
50 |
Supplier model |
<SupplierOrderId> |
IN PS |
S |
25 |
Supplier’s order ID |
<TermsCode> |
IN PO PS |
S |
15 |
From Terms Code table or partner-specific codes |
<TermsDate> |
IN PO |
D |
10 |
ISO format: YYYY-MM-DD. Required if TermsCode is P998 |
<TermsDays> |
IN PO |
I |
6 |
6 digits, as 999999. Required if TermsCode is P998 |
<TermsPercent> |
IN PO PS |
N |
6 |
3.2, as 100.00. Required if TermsCode is P998 |
<TermsPercentDays> |
IN PO |
I |
6 |
6 digits, as 999999. Required if TermsCode is P998 |
<Timestamp> |
AS FA IN IT PB PO PR PS ST |
S |
19 |
YYYY-MM-DD + “T” + HH:MM:SS |
<Title> |
IT |
S |
|
Item title |
<Topic> |
IT |
C |
- |
|
<TotalItemLines> |
IN |
I |
6 |
6 digits, as 999999 |
<TotalItemQty> |
IN |
I |
6 |
6 digits, as 999999 |
<TradingPartner> |
PY |
C |
- |
|
<TranspCarrier> |
IN PO |
S |
15 |
Required if TranspCode is S998 |
<TranspCode> |
AS IN PO |
S |
15 |
From Terms Code table or partner-specific codes |
<TranspDesc> |
AS IN PO |
S |
50 |
Transportation description |
<TranspTerms> |
IN PO |
S |
|
Transportation terms |
<TranspTime> |
IN PO |
I |
6 |
6 digits, as 999999 |
<Type> |
IT |
S |
10 |
“GTIN-12”, “GTIN-13”, “GTIN-14”, or “PartNumber” |
<UCCurrencyCode> |
IN PO |
S |
3 |
ISO standard currency code |
<UCValue> |
IN PO PS |
N |
10 |
5.4, as 12345.6789 |
<UnAvailableDate> |
IT |
D |
10 |
ISO format: YYYY-MM-DD |
<UOM> |
IT |
S |
5 |
From UOM table |
<URL> |
PY |
U |
500 |
Partner company URL |
<Vehicle> |
AS |
C |
- |
|
<VehicleId> |
AS |
S |
25 |
Vehicle ID |
<VehicleType> |
AS |
S |
|
Vehicle type |
<Video> |
IT |
U |
|
Video URL |
<Videos> |
IT |
C |
- |
|
<Volume> |
AS |
C |
- |
|
<VolumeUOMCode> |
AS |
S |
5 |
From UOM table |
<VolumeUOMDesc> |
AS |
S |
15 |
From UOM table |
<VolumeValue> |
AS |
N |
10 |
5.4, as 12345.6789 |
<WarrantyLabTerm> |
IT |
I |
6 |
6 digits, as 999999 |
<WarrantyLabUOM> |
IT |
S |
5 |
From UOM table |
<WarrantyPartTerm> |
IT |
I |
6 |
6 digits, as 999999 |
<WarrantyPartUOM> |
IT |
S |
5 |
From UOM table |
<Weight> |
AS IT |
N |
10 |
5.4, as 12345.6789 |
<WeightUOM> |
IT |
S |
5 |
From UOM table |
<WeightUOMCode> |
AS |
S |
5 |
From UOM table |
<WeightUOMDesc> |
AS |
S |
15 |
From UOM table |
<WeightValue> |
AS |
N |
10 |
5.4, as 12345.6789 |
<Width> |
IT |
N |
10 |
5.4, as 12345.6789 |