GuidesAPI ReferenceChangelogWeb EDISupportContact Us
API Reference

Shipping Notice

Ship Notice/Manifest (856)

A Ship Notice/Manifest (856) is sent by a supplier to notify a buyer that a shipment has been sent.

Field Type Required Description
purpose
 string Purpose of the ship notice (e.g., original, change, cancellation)
Values: original cancellation change
shipmentId
 string ✓ Unique shipment identifier
carrierDetails
 object Carrier and shipping details for the shipment
quantityAndWeight
 array Quantity and weight details for the shipment
packageForm
 string Form of packaging
Values: bag carton case coil pallet
packageMaterial
 string Material of packaging
Values: aluminum corrugated plastic plasticVacuumed standard steel wood
weightUOM
 string Unit of measure for weight
Values: pound kilogram
grossWeight
 string Gross weight including packaging
netWeight
 string Net weight of contents only
volume
 string Total volume of the shipment
volumeUOM
 string Unit of measure for volume
Values: cubicFeet cubicInches cubicMeter cubicYard gallon liter
dimensionUOM
 string Unit of measure for length
Values: foot meter
length
 string Total linear length of coils in the shipment
basebox
 string Billable quantity in baseboxes (tin plate industry unit: 112 sheets × 14"×20" = 31,360 sq in)
routing
 array Carrier routing and transportation details
sequenceType
 string Sequence in the routing chain
Values: origin 1stAfterOrigin 4thAfterOrigin haulage
standardCarrierAlphaCode
 string SCAC code identifying the carrier
customCarrierCode
 string Custom carrier identifier
transportationMethod
 string Method of transportation. EDIFACT: prefer C001.8179 (transportMeansDescriptionCode) — its means/vessel-level codes match this enum directly. Fall back to C220.8067 (transportModeNameCode) ONLY when 8179 is absent; 8067 carries broad-mode codes only (1=Maritime, 2=Rail, 3=Road, 4=Air, 5=Mail, 6=Multimodal, 7=Fixed installation, 8=Inland water) which map loosely: 1→ocean, 2→rail, 3→supplierTruck, 4→air. Granular enum values (airExpress, oceanContainerized, trailer, etc.) cannot be recovered from 8067 — emit a SCHEMA GAP if neither path carries the partner value.
Values: air airExpress airFreightForward backhaul bestWay commonCarrier consolidation customerPickup expeditedTruck lessThanTrailerLoad mail ocean oceanContainerized parcelPost privateCarrier rail shipperAgent supplierTruck trailer mutuallyDefined
locationType
 string Type of routing location
Values: inStore receiversLocation allPoints portOfArrival portOfEmbarkation origin mutuallyDefined
location
 string Routing location identifier or name
description
 string Description of routing details
serviceLevel
 string Service level for shipping
Values: deliveryConfirmation doorService economy eveningService expedited firstClass ground groundHundredWeight international metro morning nextDayAir nextDayHundredWeight nextDayEvening nextDayMorning1030 nextDayMorning930 nextDaySaturday overnight poBoxZipCode priorityMail priorityMailInsured proofOfDelivery sameDay saturdayService secondDay secondDayHundredWeight secondDayAir secondDaySaturday standard standardGround threeDay
orderStatus
 string Order shipping status
Values: shipCompleteOnDate complete partialShipment shipPartialBackorderToShipOnDate partialShipOnDate shipped backordered mutuallyDefined availableScheduledToShip availableNoShipSchedule multiPickup availableToShipUnBilledQuantity stopOff
transitDirectionType
 string Direction of transit
Values: buyerToSeller sellerToBuyer subcontractorToSeller sellerToDropShipLocation sellToForwarder sellerToSubcontractor mutuallyDefined
transitTimeType
 string Unit for transit time
Values: calendarDays hours workingDays
transitTime
 string Expected transit time value
equipment
 object Equipment details such as trailer information
equipmentType
 string Type of transportation equipment
Values: container reefer trailer oceanVessel
equipmentId
 string Equipment identifier (e.g., trailer number)
sealNumber
 string Seal number for security verification
freeOnBoard
 array FOB (Free on Board) terms and conditions
methodOfPayment
 string Freight payment method
Values: airCollect airPrepaid paidByBuyer collect mutuallyAgreed portOfCall halfPrepaid mixed serviceFreightNoCharge advancePrepaid customerPickupBackhaul prepaidChargeCustomer prepaidBySeller paidBySeller pickup thirdPartyPay
locationType
 string Type of FOB location
Values: cityAndState country destination origin stateProvince warehouse
locationDescription
 string Description of FOB location
titlePassageType
 string Type of title passage location
Values: cityAndState country destination origin stateProvince warehouse
titlePassageDescription
 string Description of title passage location
transportationTermsSource
 string Source of transportation terms
Values: incoTerms tradeTerms mutuallyDefined
transportationTerms
 string Incoterms or trade terms code
Values: costAndFreight costInsuranceAndFreight carriageAndInsurancePaidTo carriagePaidTo deliveredAtFrontier deliverDutyPaid deliverDutyUnpaid deliveredDutyUnpaid deliveredExQuay deliveredExShip domesticallySupplied exQuay exShip exWorks freeAlongsideShip freeCarrier freightCarriageInsurancePaidTo freightCarriagePaidTo freeOnBoard freeOnRail freeOnTruck nonPrivilegedForeign privilegedForeign mutuallyDefined
riskOfLoss
 string Risk of loss transfer point
Values: toDestinationBuyer toFreightEqPointSeller toPoolPointSeller toDestinationSeller mutuallyDefined
description
 string Additional FOB description
specialHandling
 array Special handling requirements for the shipment
handlingType
 string Type of special handling required
Values: bulkyArticle dangerous deliveryService domestic doNotFreeze doNotUseWaterForFire environmentalControlLimits explosiveGas export flammable flammablePoisonGas fragile fullContainerConsolidatorLoad fullContainerFactoryLoad hazardousMaterial humiditySensitive ice keepDry marshalingNotRequired noPlacardsRequired notifyConsigneeBeforeDelivery partialShip perHourRatesApplied perishable poisonousGas protectFromHeat radioactiveMaterial refrigerated shipperLoadCount signatureAndTimeRequired stowBelowDeck temperatureControl trailerFactoryLoad transitShip unloadAsPlacarded waiveInspection volatileOrganicCompound
description
 string Description of special handling
materialId
 string Hazardous material identifier
materialClass
 string Hazardous material class
conditionResponse
 boolean Condition response indicator
references
 object Reference numbers associated with the shipment
appointmentNumber
 object Delivery appointment number
value
 string The reference identifier value
description
 string Additional description or context for the reference
billOfLadingNumber
 object Bill of lading number for the shipment
value
 string The reference identifier value
description
 string Additional description or context for the reference
loadPlanningNumber
 object Load planning or load ID number
value
 string The reference identifier value
description
 string Additional description or context for the reference
pickupReferenceNumber
 object Pickup reference number
value
 string The reference identifier value
description
 string Additional description or context for the reference
proNumber
 object Progressive or PRO number from the carrier
value
 string The reference identifier value
description
 string Additional description or context for the reference
trackingNumber
 object Shipment tracking number
value
 string The reference identifier value
description
 string Additional description or context for the reference
vendorNumber
 object Identifier of the vendor/supplier entity (who the vendor is). NOT the vendor's reference for a specific order — that lives on orders[].vendorOrderNumber.
value
 string The reference identifier value
description
 string Additional description or context for the reference
dates
 object Important dates such as ship date and delivery date
shipDate
 unknown Date the goods were shipped
deliveryDate
 unknown Estimated or scheduled delivery date
shippingPaymentTerms
 string Shipping payment terms (prepaid by seller or collect from buyer)
Values: prepaidBySeller collect
parties
 object Parties involved in the shipment. Includes contact information where available
shipFrom
 object Ship-from location where goods originate
name
 string Party name or company name
additionalName1
 string Additional name line 1
additionalName2
 string Additional name line 2
identificationCode
 string Party identification code value
identificationCodeType
 string Type of identification code
Values: sendersId receiversId duns plantCode dunsPlus4 drugEnforcementAdmin telephone federalReserveRouting standardAddressSAN healthIndustryHIN warehouse schoolId memberId stateLicenseId globalLocationId
addressLine1
 string Street address line 1
addressLine2
 string Street address line 2
addressLine3
 string Street address line 3
addressLine4
 string Street address line 4
city
 string City name
stateOrProvinceCode
 string State or province code
postalCode
 string Postal or ZIP code
countryCode
 string Country code (ISO)
zoneType
 string Address zone type
Values: residential commercial
contacts
 array Contact persons for this party
type
 string ✓ Type of contact. Default to 'primary' for party-level (N1_loop) PER segments and context-routed header-level PER segments — the parent party's role provides the context. Use other types only to distinguish multiple contacts within a single party (e.g. 'hazmat' for HM, 'shipping' for SD).
Values: primary customerRelations orderInquiry department shipping receiving hazmat
name
 string Contact person name
phoneNumber
 string Contact phone number. Default source is the comm-number paired with a TE qualifier (PER03/04, PER05/06, or PER07/08). If the partner guideline note on the comm-number element labels the value as a different comm type (e.g. "Fax #", "Email"), follow the note and route accordingly.
faxNumber
 string Contact fax number. Default source is the comm-number paired with an FX qualifier (PER03/04, PER05/06, or PER07/08). If the partner guideline note on a comm-number element labels its value as fax even when the qualifier is TE/EM, follow the note and route the value here.
email
 string Contact email address. Default source is the comm-number paired with an EM qualifier (PER03/04, PER05/06, or PER07/08). If the partner guideline note on the comm-number element labels the value as a different comm type, follow the note and route accordingly.
shipTo
 object Ship-to location where goods are being delivered
name
 string Party name or company name
additionalName1
 string Additional name line 1
additionalName2
 string Additional name line 2
identificationCode
 string Party identification code value
identificationCodeType
 string Type of identification code
Values: sendersId receiversId duns plantCode dunsPlus4 drugEnforcementAdmin telephone federalReserveRouting standardAddressSAN healthIndustryHIN warehouse schoolId memberId stateLicenseId globalLocationId
addressLine1
 string Street address line 1
addressLine2
 string Street address line 2
addressLine3
 string Street address line 3
addressLine4
 string Street address line 4
city
 string City name
stateOrProvinceCode
 string State or province code
postalCode
 string Postal or ZIP code
countryCode
 string Country code (ISO)
zoneType
 string Address zone type
Values: residential commercial
contacts
 array Contact persons for this party
type
 string ✓ Type of contact. Default to 'primary' for party-level (N1_loop) PER segments and context-routed header-level PER segments — the parent party's role provides the context. Use other types only to distinguish multiple contacts within a single party (e.g. 'hazmat' for HM, 'shipping' for SD).
Values: primary customerRelations orderInquiry department shipping receiving hazmat
name
 string Contact person name
phoneNumber
 string Contact phone number. Default source is the comm-number paired with a TE qualifier (PER03/04, PER05/06, or PER07/08). If the partner guideline note on the comm-number element labels the value as a different comm type (e.g. "Fax #", "Email"), follow the note and route accordingly.
faxNumber
 string Contact fax number. Default source is the comm-number paired with an FX qualifier (PER03/04, PER05/06, or PER07/08). If the partner guideline note on a comm-number element labels its value as fax even when the qualifier is TE/EM, follow the note and route the value here.
email
 string Contact email address. Default source is the comm-number paired with an EM qualifier (PER03/04, PER05/06, or PER07/08). If the partner guideline note on the comm-number element labels the value as a different comm type, follow the note and route accordingly.
supplier
 object Supplier or vendor fulfilling the order
name
 string Party name or company name
additionalName1
 string Additional name line 1
additionalName2
 string Additional name line 2
identificationCode
 string Party identification code value
identificationCodeType
 string Type of identification code
Values: sendersId receiversId duns plantCode dunsPlus4 drugEnforcementAdmin telephone federalReserveRouting standardAddressSAN healthIndustryHIN warehouse schoolId memberId stateLicenseId globalLocationId
addressLine1
 string Street address line 1
addressLine2
 string Street address line 2
addressLine3
 string Street address line 3
addressLine4
 string Street address line 4
city
 string City name
stateOrProvinceCode
 string State or province code
postalCode
 string Postal or ZIP code
countryCode
 string Country code (ISO)
zoneType
 string Address zone type
Values: residential commercial
contacts
 array Contact persons for this party
type
 string ✓ Type of contact. Default to 'primary' for party-level (N1_loop) PER segments and context-routed header-level PER segments — the parent party's role provides the context. Use other types only to distinguish multiple contacts within a single party (e.g. 'hazmat' for HM, 'shipping' for SD).
Values: primary customerRelations orderInquiry department shipping receiving hazmat
name
 string Contact person name
phoneNumber
 string Contact phone number. Default source is the comm-number paired with a TE qualifier (PER03/04, PER05/06, or PER07/08). If the partner guideline note on the comm-number element labels the value as a different comm type (e.g. "Fax #", "Email"), follow the note and route accordingly.
faxNumber
 string Contact fax number. Default source is the comm-number paired with an FX qualifier (PER03/04, PER05/06, or PER07/08). If the partner guideline note on a comm-number element labels its value as fax even when the qualifier is TE/EM, follow the note and route the value here.
email
 string Contact email address. Default source is the comm-number paired with an EM qualifier (PER03/04, PER05/06, or PER07/08). If the partner guideline note on the comm-number element labels the value as a different comm type, follow the note and route accordingly.
allowances
 array Allowances or discounts applied to the shipment
type
 string ✓ Type of allowance or charge
Values: advertising defectiveAllowance discount freight handling newStore other promotionalAllowance quantityDiscount rebate restocking serviceAtPickupOrDelivery shipping shippingAndHandling swell unsaleableMerchandiseAllowance volume warehouse
amount
 string Fixed amount of allowance or charge
percent
 string Percentage of allowance or charge
percentBasis
 string Basis for calculating percentage
Values: basePrice
methodOfHandling
 string How the charge is handled
Values: collect paidByVendor paidByCustomer prepaid
description
 string Description of the allowance or charge
charges
 array Additional charges applied to the shipment
type
 string ✓ Type of allowance or charge
Values: advertising defectiveAllowance discount freight handling newStore other promotionalAllowance quantityDiscount rebate restocking serviceAtPickupOrDelivery shipping shippingAndHandling swell unsaleableMerchandiseAllowance volume warehouse
amount
 string Fixed amount of allowance or charge
percent
 string Percentage of allowance or charge
percentBasis
 string Basis for calculating percentage
Values: basePrice
methodOfHandling
 string How the charge is handled
Values: collect paidByVendor paidByCustomer prepaid
description
 string Description of the allowance or charge
assertions
 object Assertions or special conditions for the shipment
isConsigneeRequired
 object Indicates whether consignee information is required
value
 boolean ✓
isDirectPurchase
 object Indicates that the item was purchased directly from the manufacturer
value
 boolean ✓
isHighPriority
 object Indicates the shipment is high priority
value
 boolean ✓
isInventoryOrder
 object Indicates the shipment is for an inventory order
value
 boolean ✓
isSignatureRequired
 object Indicates a signature is required upon delivery
value
 boolean ✓
isDSCSACompliant
 object Indicates compliance with Drug Supply Chain Security Act (DSCSA)
value
 boolean ✓
orders
 array ✓ Orders included in this shipment with their items
purchaseOrderNumber
 string ✓ Purchase order number for this shipment
releaseNumber
 string Release number for blanket or contract orders
purchaseOrderDate
 unknown Date of the original purchase order
customerOrderNumber
 string Customer-assigned order number
vendorOrderNumber
 string The vendor's own reference number for this specific order (the order ID the vendor uses in their system). NOT an identifier of the vendor entity — that lives on references.vendorNumber.
parties
 object Parties associated with this order
markFor
 object Mark-for party, the ultimate recipient of the goods
name
 string Party name or company name
additionalName1
 string Additional name line 1
additionalName2
 string Additional name line 2
identificationCode
 string Party identification code value
identificationCodeType
 string Type of identification code
Values: sendersId receiversId duns plantCode dunsPlus4 drugEnforcementAdmin telephone federalReserveRouting standardAddressSAN healthIndustryHIN warehouse schoolId memberId stateLicenseId globalLocationId
addressLine1
 string Street address line 1
addressLine2
 string Street address line 2
addressLine3
 string Street address line 3
addressLine4
 string Street address line 4
city
 string City name
stateOrProvinceCode
 string State or province code
postalCode
 string Postal or ZIP code
countryCode
 string Country code (ISO)
zoneType
 string Address zone type
Values: residential commercial
contacts
 array Contact persons for this party
type
 string ✓ Type of contact. Default to 'primary' for party-level (N1_loop) PER segments and context-routed header-level PER segments — the parent party's role provides the context. Use other types only to distinguish multiple contacts within a single party (e.g. 'hazmat' for HM, 'shipping' for SD).
Values: primary customerRelations orderInquiry department shipping receiving hazmat
name
 string Contact person name
phoneNumber
 string Contact phone number. Default source is the comm-number paired with a TE qualifier (PER03/04, PER05/06, or PER07/08). If the partner guideline note on the comm-number element labels the value as a different comm type (e.g. "Fax #", "Email"), follow the note and route accordingly.
faxNumber
 string Contact fax number. Default source is the comm-number paired with an FX qualifier (PER03/04, PER05/06, or PER07/08). If the partner guideline note on a comm-number element labels its value as fax even when the qualifier is TE/EM, follow the note and route the value here.
email
 string Contact email address. Default source is the comm-number paired with an EM qualifier (PER03/04, PER05/06, or PER07/08). If the partner guideline note on the comm-number element labels the value as a different comm type, follow the note and route accordingly.
Structure Variant
 union This schema has 4 structural variants ("Shipment > Order > Tare > Pack > Item", "Shipment > Order > Tare > Item", "Shipment > Order > Pack > Item", "Shipment > Order > Item"). Each shares the common fields below but differs in how items are organized. Expand a variant to see its specific fields.
pallets
 array ✓ Pallets containing cartons with items for this order
palletType
 string Type of pallet used
Values: chep iGps peco whiteWood hardWood aluminum specifiedByDOT metal standard steel wood slipsheet softWood
trackingNumber
 string Carrier-assigned tracking number for the pallet
serialShippingId
 string Serial Shipping Container Code (SSCC) for the pallet
upcShippingContainerCode
 string 14-digit U.P.C. Shipping Container Code (SCC-14/ITF-14) for the pallet. Pallet level barcode identifying the shipping unit distinctly from the consumer unit inside.
upcConsumerPackageCode
 string U.P.C. Consumer Package Code for the pallet. Used when the case pack quantity is 1 and the consumer selling unit is also the shipping unit (e.g. Target single-unit shipments).
layersPerPallet
 integer Number of layers stacked on the pallet
cartonsPerLayer
 integer Number of cartons per layer on the pallet
palletExchangeType
 string Pallet exchange or return arrangement
Values: noExchangeOrReturn exchange return customerPurchase thirdPartyExchange
palletPhysicalDetails
 object Physical details of the pallet
numberOfUnits
 string Number of units in the package
size
 string Size value of the package
sizeUOM
 string Unit of measure for size
Values: bag box carton case cassette each fluidOunce gram kilogram liter milliliter ounce packPAK package pair pound roll tote unit
packageForm
 string Form of the package
Values: bag bottle box can carton coil container pallet shrinkWrap unit
packageMaterial
 string Material of the package
Values: corrugated plastic plasticVacuumed standard wood
weightUOM
 string Unit of measure for weight
Values: pound kilogram
grossWeight
 string Gross weight including packaging
netWeight
 string Net weight of contents only
volumeUOM
 string Unit of measure for volume
Values: standardCubicFoot centiliter cubicDecimeter cubicCentimeter cubicFeet cubicInches cubicMeter cubicYard deciliter fluidOunce gallon halfGallon kiloliter kilogramsPerCubicMeter liter milliliter netGallons pint halfPint quart
volume
 string Volume value
length
 string Length dimension
width
 string Width dimension
height
 string Height dimension
dimensionUOM
 string Unit of measure for dimensions
Values: standardCubicFoot boardFeet hundredBoardFeet cubicDecimeter cubicCentimeter cubicFeet cubicInches centimeter cubicMeter cubicYard decimeter foot hundredFeet hundredFeetLinear hundredSquareFeet hundredYards inch linearFoot linearMeter linearYard millimeter meter squareFoot squareInches squareMeter squareYard thousandSquareInches thousandFeetLinear thousandFeetBoard tenSquareFeet thousandSquareFeet yard
packageId
 string Package identifier
basebox
 string Billable quantity in baseboxes (tin plate industry unit: 112 sheets × 14"×20" = 31,360 sq in)
baseboxBasisWeight
 string Basis weight in pounds per base box — the standard steel mill weight specification unit
cartons
 array ✓ Cartons contained on this pallet
items
 array ✓ Items contained in this carton
purchaseOrderLineId
 string Line item identifier from the original purchase order
references
 object Reference numbers for the item
billOfLadingNumber
 object Bill of lading number for this item
value
 string The reference identifier value
description
 string Additional description or context for the reference
billOfMaterial
 object Bill of materials reference for the item
value
 string The reference identifier value
description
 string Additional description or context for the reference
heatCode
 object Steel mill heat number for traceability
value
 string The reference identifier value
description
 string Additional description or context for the reference
barCode
 object Barcode identifier for the item
value
 string The reference identifier value
description
 string Additional description or context for the reference
departmentNumber
 object Department number for this item
value
 string The reference identifier value
description
 string Additional description or context for the reference
invoiceNumber
 object Invoice number associated with this item
value
 string The reference identifier value
description
 string Additional description or context for the reference
productIds
 object ✓ Product identification codes such as UPC, SKU, or vendor item number
buyerItemNumber
 string Buyer-assigned item number
vendorItemNumber
 string Vendor-assigned item number (EDIFACT LIN/PIA supplier's item number)
gtin12
 string GTIN-12 (UPC-A) barcode
gtin13
 string GTIN-13 (EAN) barcode
gtin14
 string GTIN-14 (ITF-14) case code barcode
caseCode
 string Case code identifier
drugCode
 string National Drug Code (NDC)
standardBookNumber
 string ISBN or standard book number
buyerItemIds
 array Additional buyer product identifiers
type
 string ✓ Type of product identifier
Values: catalog manufacturerPart sku style
value
 string ✓ Product identifier value
vendorItemIds
 array Additional vendor product identifiers
type
 string ✓ Type of product identifier
Values: catalog manufacturerPart sku style
value
 string ✓ Product identifier value
productAttributes
 object Product attributes such as color, size, and description
description
 string General product description. Sourced from X12 PID05 when PID02="08" (Product Description, general) or when PID02 is absent. In EDIFACT, sourced from EVERY IMD composite for this line item where itemDescriptionCode="SP" (Product) — there may be MULTIPLE matching IMD repetitions per line item, and ALL of them must be included. Within each matching IMD, concatenate itemDescription + itemDescription_1 (the continuation field) with a single space; then $join those per-IMD strings across ALL matching IMDs with a single space separator. Do NOT pick only the first matching IMD — partners commonly split a long description across multiple IMD segments because each itemDescription element is capped at 35 characters. The qualifier code "SP" (or X12 "08") is positional — it identifies which IMDs carry the product description, and must NOT be reported as a schema gap.
shortDescription
 string {"description":"Short product description"}
brand
 string Brand or label name for the product
colorCode
 string Color code identifier
colorDescription
 string Color description text
sizeCode
 string Size code identifier
sizeDescription
 string Size description text
materialCode
 string Material code identifier
materialDescription
 string Material description text
materialAttributes
 object
type
 string Material type or classification
grade
 string Material grade or quality tier (e.g., prime, excessPrime, waste)
annealMethod
 string Annealing method applied to the material
temper
 string Heat treatment or mechanical processing state of the material
finish
 string Surface finish or texture applied to the material
outerCoating
 string Outer surface coating or plating
innerCoating
 string Inner surface coating or plating
surfaceProtection
 string Surface protection method or specification
treatment
 string Chemical or mechanical treatment applied to the material
weld
 string Welding specification or classification for the material
processCode
 string Process code identifier
processDescription
 string Process description text
height
 string Product height dimension
length
 string Product length dimension
width
 string Product width dimension
dimensionUOM
 string Unit of measure for product dimensions
Values: standardCubicFoot boardFeet hundredBoardFeet cubicDecimeter cubicCentimeter cubicFeet cubicInches centimeter cubicMeter cubicYard decimeter foot hundredFeet hundredFeetLinear hundredSquareFeet hundredYards inch linearFoot linearMeter linearYard millimeter meter squareFoot squareInches squareMeter squareYard thousandSquareInches thousandFeetLinear thousandFeetBoard tenSquareFeet thousandSquareFeet yard
lotNumber
 string Lot or batch number for the product
coilNumber
 string Unique identifier for a coil, used in industrial materials (steel, aluminum)
quantityShipped
 object Quantity shipped for this item
value
 string ✓ Numeric quantity value
unitOfMeasure
 string Unit of measure for the quantity
Values: assembly assortment bag bale ball bar barrel belt bin block boardFeet bolt book bottle box bulk bundle bushel cake can card carton cartridge case cassette celsius cell centigram centiliter centimeter coil combo cone container count cover display dozen drum each flakeTon foot gallon gram gramsPerLiter inch kilogram kit knots linearFoot liter meter milliliter monetaryValue ocularInsertSystem order ounce packPAK package pad pail pair pairInches palletLift palletUnitLoad person piece pint pound poundEquivalent poundGross quart reel roll section set sheet sixPack squareFoot syringe thousand threePack tote tube unit vial
expirationDate
 unknown Expiration date of the product
manufactureDate
 unknown Manufacture or production date of the product
countryOfOrigin
 string Country where the product was manufactured
outerPack
 object Physical details for the outer packaging (case/carton level)
numberOfUnits
 string Number of units in the package
size
 string Size value of the package
sizeUOM
 string Unit of measure for size
Values: bag box carton case cassette each fluidOunce gram kilogram liter milliliter ounce packPAK package pair pound roll tote unit
packageForm
 string Form of the package
Values: bag bottle box can carton coil container pallet shrinkWrap unit
packageMaterial
 string Material of the package
Values: corrugated plastic plasticVacuumed standard wood
weightUOM
 string Unit of measure for weight
Values: pound kilogram
grossWeight
 string Gross weight including packaging
netWeight
 string Net weight of contents only
volumeUOM
 string Unit of measure for volume
Values: standardCubicFoot centiliter cubicDecimeter cubicCentimeter cubicFeet cubicInches cubicMeter cubicYard deciliter fluidOunce gallon halfGallon kiloliter kilogramsPerCubicMeter liter milliliter netGallons pint halfPint quart
volume
 string Volume value
length
 string Length dimension
width
 string Width dimension
height
 string Height dimension
dimensionUOM
 string Unit of measure for dimensions
Values: standardCubicFoot boardFeet hundredBoardFeet cubicDecimeter cubicCentimeter cubicFeet cubicInches centimeter cubicMeter cubicYard decimeter foot hundredFeet hundredFeetLinear hundredSquareFeet hundredYards inch linearFoot linearMeter linearYard millimeter meter squareFoot squareInches squareMeter squareYard thousandSquareInches thousandFeetLinear thousandFeetBoard tenSquareFeet thousandSquareFeet yard
packageId
 string Package identifier
basebox
 string Billable quantity in baseboxes (tin plate industry unit: 112 sheets × 14"×20" = 31,360 sq in)
baseboxBasisWeight
 string Basis weight in pounds per base box — the standard steel mill weight specification unit
innerPack
 object Physical details for the inner packaging
numberOfUnits
 string Number of units in the package
size
 string Size value of the package
sizeUOM
 string Unit of measure for size
Values: bag box carton case cassette each fluidOunce gram kilogram liter milliliter ounce packPAK package pair pound roll tote unit
packageForm
 string Form of the package
Values: bag bottle box can carton coil container pallet shrinkWrap unit
packageMaterial
 string Material of the package
Values: corrugated plastic plasticVacuumed standard wood
weightUOM
 string Unit of measure for weight
Values: pound kilogram
grossWeight
 string Gross weight including packaging
netWeight
 string Net weight of contents only
volumeUOM
 string Unit of measure for volume
Values: standardCubicFoot centiliter cubicDecimeter cubicCentimeter cubicFeet cubicInches cubicMeter cubicYard deciliter fluidOunce gallon halfGallon kiloliter kilogramsPerCubicMeter liter milliliter netGallons pint halfPint quart
volume
 string Volume value
length
 string Length dimension
width
 string Width dimension
height
 string Height dimension
dimensionUOM
 string Unit of measure for dimensions
Values: standardCubicFoot boardFeet hundredBoardFeet cubicDecimeter cubicCentimeter cubicFeet cubicInches centimeter cubicMeter cubicYard decimeter foot hundredFeet hundredFeetLinear hundredSquareFeet hundredYards inch linearFoot linearMeter linearYard millimeter meter squareFoot squareInches squareMeter squareYard thousandSquareInches thousandFeetLinear thousandFeetBoard tenSquareFeet thousandSquareFeet yard
packageId
 string Package identifier
basebox
 string Billable quantity in baseboxes (tin plate industry unit: 112 sheets × 14"×20" = 31,360 sq in)
baseboxBasisWeight
 string Basis weight in pounds per base box — the standard steel mill weight specification unit
sublineItems
 array Subline items for component or kit details
sublineId
 string Subline item identifier
quantity
 object Quantity for the subline item
value
 string ✓ Numeric quantity value
unitOfMeasure
 string Unit of measure for the quantity
Values: assembly assortment bag bale ball bar barrel belt bin block boardFeet bolt book bottle box bulk bundle bushel cake can card carton cartridge case cassette celsius cell centigram centiliter centimeter coil combo cone container count cover display dozen drum each flakeTon foot gallon gram gramsPerLiter inch kilogram kit knots linearFoot liter meter milliliter monetaryValue ocularInsertSystem order ounce packPAK package pad pail pair pairInches palletLift palletUnitLoad person piece pint pound poundEquivalent poundGross quart reel roll section set sheet sixPack squareFoot syringe thousand threePack tote tube unit vial
unitCostPrice
 string Unit cost price for the subline item
unitPriceBasis
 string Basis for the unit price
Values: advise beforeDiscount discount net noCharge perHundred perThousand perDozen perEach perFoot perGram perKilogram perTen perOunce perPound perTenThousand perUOM promotion standard suggestedRetail wholesale wholesalePerEach
productIds
 object ✓ Product identifiers for the subline item
buyerItemNumber
 string Buyer-assigned item number
vendorItemNumber
 string Vendor-assigned item number (EDIFACT LIN/PIA supplier's item number)
gtin12
 string GTIN-12 (UPC-A) barcode
gtin13
 string GTIN-13 (EAN) barcode
gtin14
 string GTIN-14 (ITF-14) case code barcode
caseCode
 string Case code identifier
drugCode
 string National Drug Code (NDC)
standardBookNumber
 string ISBN or standard book number
buyerItemIds
 array Additional buyer product identifiers
type
 string ✓ Type of product identifier
Values: catalog manufacturerPart sku style
value
 string ✓ Product identifier value
vendorItemIds
 array Additional vendor product identifiers
type
 string ✓ Type of product identifier
Values: catalog manufacturerPart sku style
value
 string ✓ Product identifier value
productAttributes
 object Product attributes for the subline item
description
 string General product description. Sourced from X12 PID05 when PID02="08" (Product Description, general) or when PID02 is absent. In EDIFACT, sourced from EVERY IMD composite for this line item where itemDescriptionCode="SP" (Product) — there may be MULTIPLE matching IMD repetitions per line item, and ALL of them must be included. Within each matching IMD, concatenate itemDescription + itemDescription_1 (the continuation field) with a single space; then $join those per-IMD strings across ALL matching IMDs with a single space separator. Do NOT pick only the first matching IMD — partners commonly split a long description across multiple IMD segments because each itemDescription element is capped at 35 characters. The qualifier code "SP" (or X12 "08") is positional — it identifies which IMDs carry the product description, and must NOT be reported as a schema gap.
shortDescription
 string {"description":"Short product description"}
brand
 string Brand or label name for the product
colorCode
 string Color code identifier
colorDescription
 string Color description text
sizeCode
 string Size code identifier
sizeDescription
 string Size description text
materialCode
 string Material code identifier
materialDescription
 string Material description text
materialAttributes
 object
type
 string Material type or classification
grade
 string Material grade or quality tier (e.g., prime, excessPrime, waste)
annealMethod
 string Annealing method applied to the material
temper
 string Heat treatment or mechanical processing state of the material
finish
 string Surface finish or texture applied to the material
outerCoating
 string Outer surface coating or plating
innerCoating
 string Inner surface coating or plating
surfaceProtection
 string Surface protection method or specification
treatment
 string Chemical or mechanical treatment applied to the material
weld
 string Welding specification or classification for the material
processCode
 string Process code identifier
processDescription
 string Process description text
height
 string Product height dimension
length
 string Product length dimension
width
 string Product width dimension
dimensionUOM
 string Unit of measure for product dimensions
Values: standardCubicFoot boardFeet hundredBoardFeet cubicDecimeter cubicCentimeter cubicFeet cubicInches centimeter cubicMeter cubicYard decimeter foot hundredFeet hundredFeetLinear hundredSquareFeet hundredYards inch linearFoot linearMeter linearYard millimeter meter squareFoot squareInches squareMeter squareYard thousandSquareInches thousandFeetLinear thousandFeetBoard tenSquareFeet thousandSquareFeet yard
lotNumber
 string Lot or batch number for the subline item
assertions
 array Assertions or special conditions for this item
isDirectPurchase
 object Indicates that the item was purchased directly from the manufacturer
value
 boolean ✓
isDirectPurchaseStatementReceived
 object Indicates that a direct purchase statement has been received
value
 boolean ✓
trackingNumber
 string Carrier-assigned tracking number for the carton
serialShippingId
 string GS1 Serial Shipping Container Code (SSCC-18) with Application Identifier (AI 00) for the carton. 18-digit, globally unique, and serially assigned per logistics unit — not derived from the product UPC. For product-derived 14-digit SCC-14/ITF-14 case codes use upcShippingContainerCode instead.
upcShippingContainerCode
 string 14-digit U.P.C. Shipping Container Code (SCC-14/ITF-14) for the carton. The most common carton-level barcode, identifying the shipping unit distinctly from the consumer unit inside.
upcConsumerPackageCode
 string U.P.C. Consumer Package Code for the carton. Used when the case pack quantity is 1 and the consumer selling unit is also the shipping unit (e.g. Target single-unit shipments).
cartonPhysicalDetails
 object Physical details of the carton
numberOfUnits
 string Number of units in the package
size
 string Size value of the package
sizeUOM
 string Unit of measure for size
Values: bag box carton case cassette each fluidOunce gram kilogram liter milliliter ounce packPAK package pair pound roll tote unit
packageForm
 string Form of the package
Values: bag bottle box can carton coil container pallet shrinkWrap unit
packageMaterial
 string Material of the package
Values: corrugated plastic plasticVacuumed standard wood
weightUOM
 string Unit of measure for weight
Values: pound kilogram
grossWeight
 string Gross weight including packaging
netWeight
 string Net weight of contents only
volumeUOM
 string Unit of measure for volume
Values: standardCubicFoot centiliter cubicDecimeter cubicCentimeter cubicFeet cubicInches cubicMeter cubicYard deciliter fluidOunce gallon halfGallon kiloliter kilogramsPerCubicMeter liter milliliter netGallons pint halfPint quart
volume
 string Volume value
length
 string Length dimension
width
 string Width dimension
height
 string Height dimension
dimensionUOM
 string Unit of measure for dimensions
Values: standardCubicFoot boardFeet hundredBoardFeet cubicDecimeter cubicCentimeter cubicFeet cubicInches centimeter cubicMeter cubicYard decimeter foot hundredFeet hundredFeetLinear hundredSquareFeet hundredYards inch linearFoot linearMeter linearYard millimeter meter squareFoot squareInches squareMeter squareYard thousandSquareInches thousandFeetLinear thousandFeetBoard tenSquareFeet thousandSquareFeet yard
packageId
 string Package identifier
basebox
 string Billable quantity in baseboxes (tin plate industry unit: 112 sheets × 14"×20" = 31,360 sq in)
baseboxBasisWeight
 string Basis weight in pounds per base box — the standard steel mill weight specification unit
specialHandling
 array Special handling requirements for the carton
handlingType
 string Type of special handling required
Values: bulkyArticle dangerous deliveryService domestic doNotFreeze doNotUseWaterForFire environmentalControlLimits explosiveGas export flammable flammablePoisonGas fragile fullContainerConsolidatorLoad fullContainerFactoryLoad hazardousMaterial humiditySensitive ice keepDry marshalingNotRequired noPlacardsRequired notifyConsigneeBeforeDelivery partialShip perHourRatesApplied perishable poisonousGas protectFromHeat radioactiveMaterial refrigerated shipperLoadCount signatureAndTimeRequired stowBelowDeck temperatureControl trailerFactoryLoad transitShip unloadAsPlacarded waiveInspection volatileOrganicCompound
description
 string Description of special handling
materialId
 string Hazardous material identifier
materialClass
 string Hazardous material class
conditionResponse
 boolean Condition response indicator
pallets
 array ✓ Pallets containing items directly for this order
palletType
 string Type of pallet used
Values: chep iGps peco whiteWood hardWood aluminum specifiedByDOT metal standard steel wood slipsheet softWood
trackingNumber
 string Carrier-assigned tracking number for the pallet
serialShippingId
 string Serial Shipping Container Code (SSCC) for the pallet
upcShippingContainerCode
 string 14-digit U.P.C. Shipping Container Code (SCC-14/ITF-14) for the pallet. Pallet level barcode identifying the shipping unit distinctly from the consumer unit inside.
upcConsumerPackageCode
 string U.P.C. Consumer Package Code for the pallet. Used when the case pack quantity is 1 and the consumer selling unit is also the shipping unit (e.g. Target single-unit shipments).
layersPerPallet
 integer Number of layers stacked on the pallet
cartonsPerLayer
 integer Number of cartons per layer on the pallet
palletExchangeType
 string Pallet exchange or return arrangement
Values: noExchangeOrReturn exchange return customerPurchase thirdPartyExchange
palletPhysicalDetails
 object Physical details of the pallet
numberOfUnits
 string Number of units in the package
size
 string Size value of the package
sizeUOM
 string Unit of measure for size
Values: bag box carton case cassette each fluidOunce gram kilogram liter milliliter ounce packPAK package pair pound roll tote unit
packageForm
 string Form of the package
Values: bag bottle box can carton coil container pallet shrinkWrap unit
packageMaterial
 string Material of the package
Values: corrugated plastic plasticVacuumed standard wood
weightUOM
 string Unit of measure for weight
Values: pound kilogram
grossWeight
 string Gross weight including packaging
netWeight
 string Net weight of contents only
volumeUOM
 string Unit of measure for volume
Values: standardCubicFoot centiliter cubicDecimeter cubicCentimeter cubicFeet cubicInches cubicMeter cubicYard deciliter fluidOunce gallon halfGallon kiloliter kilogramsPerCubicMeter liter milliliter netGallons pint halfPint quart
volume
 string Volume value
length
 string Length dimension
width
 string Width dimension
height
 string Height dimension
dimensionUOM
 string Unit of measure for dimensions
Values: standardCubicFoot boardFeet hundredBoardFeet cubicDecimeter cubicCentimeter cubicFeet cubicInches centimeter cubicMeter cubicYard decimeter foot hundredFeet hundredFeetLinear hundredSquareFeet hundredYards inch linearFoot linearMeter linearYard millimeter meter squareFoot squareInches squareMeter squareYard thousandSquareInches thousandFeetLinear thousandFeetBoard tenSquareFeet thousandSquareFeet yard
packageId
 string Package identifier
basebox
 string Billable quantity in baseboxes (tin plate industry unit: 112 sheets × 14"×20" = 31,360 sq in)
baseboxBasisWeight
 string Basis weight in pounds per base box — the standard steel mill weight specification unit
items
 array ✓ Items contained on this pallet
purchaseOrderLineId
 string Line item identifier from the original purchase order
references
 object Reference numbers for the item
billOfLadingNumber
 object Bill of lading number for this item
value
 string The reference identifier value
description
 string Additional description or context for the reference
billOfMaterial
 object Bill of materials reference for the item
value
 string The reference identifier value
description
 string Additional description or context for the reference
heatCode
 object Steel mill heat number for traceability
value
 string The reference identifier value
description
 string Additional description or context for the reference
barCode
 object Barcode identifier for the item
value
 string The reference identifier value
description
 string Additional description or context for the reference
departmentNumber
 object Department number for this item
value
 string The reference identifier value
description
 string Additional description or context for the reference
invoiceNumber
 object Invoice number associated with this item
value
 string The reference identifier value
description
 string Additional description or context for the reference
productIds
 object ✓ Product identification codes such as UPC, SKU, or vendor item number
buyerItemNumber
 string Buyer-assigned item number
vendorItemNumber
 string Vendor-assigned item number (EDIFACT LIN/PIA supplier's item number)
gtin12
 string GTIN-12 (UPC-A) barcode
gtin13
 string GTIN-13 (EAN) barcode
gtin14
 string GTIN-14 (ITF-14) case code barcode
caseCode
 string Case code identifier
drugCode
 string National Drug Code (NDC)
standardBookNumber
 string ISBN or standard book number
buyerItemIds
 array Additional buyer product identifiers
type
 string ✓ Type of product identifier
Values: catalog manufacturerPart sku style
value
 string ✓ Product identifier value
vendorItemIds
 array Additional vendor product identifiers
type
 string ✓ Type of product identifier
Values: catalog manufacturerPart sku style
value
 string ✓ Product identifier value
productAttributes
 object Product attributes such as color, size, and description
description
 string General product description. Sourced from X12 PID05 when PID02="08" (Product Description, general) or when PID02 is absent. In EDIFACT, sourced from EVERY IMD composite for this line item where itemDescriptionCode="SP" (Product) — there may be MULTIPLE matching IMD repetitions per line item, and ALL of them must be included. Within each matching IMD, concatenate itemDescription + itemDescription_1 (the continuation field) with a single space; then $join those per-IMD strings across ALL matching IMDs with a single space separator. Do NOT pick only the first matching IMD — partners commonly split a long description across multiple IMD segments because each itemDescription element is capped at 35 characters. The qualifier code "SP" (or X12 "08") is positional — it identifies which IMDs carry the product description, and must NOT be reported as a schema gap.
shortDescription
 string {"description":"Short product description"}
brand
 string Brand or label name for the product
colorCode
 string Color code identifier
colorDescription
 string Color description text
sizeCode
 string Size code identifier
sizeDescription
 string Size description text
materialCode
 string Material code identifier
materialDescription
 string Material description text
materialAttributes
 object
type
 string Material type or classification
grade
 string Material grade or quality tier (e.g., prime, excessPrime, waste)
annealMethod
 string Annealing method applied to the material
temper
 string Heat treatment or mechanical processing state of the material
finish
 string Surface finish or texture applied to the material
outerCoating
 string Outer surface coating or plating
innerCoating
 string Inner surface coating or plating
surfaceProtection
 string Surface protection method or specification
treatment
 string Chemical or mechanical treatment applied to the material
weld
 string Welding specification or classification for the material
processCode
 string Process code identifier
processDescription
 string Process description text
height
 string Product height dimension
length
 string Product length dimension
width
 string Product width dimension
dimensionUOM
 string Unit of measure for product dimensions
Values: standardCubicFoot boardFeet hundredBoardFeet cubicDecimeter cubicCentimeter cubicFeet cubicInches centimeter cubicMeter cubicYard decimeter foot hundredFeet hundredFeetLinear hundredSquareFeet hundredYards inch linearFoot linearMeter linearYard millimeter meter squareFoot squareInches squareMeter squareYard thousandSquareInches thousandFeetLinear thousandFeetBoard tenSquareFeet thousandSquareFeet yard
lotNumber
 string Lot or batch number for the product
coilNumber
 string Unique identifier for a coil, used in industrial materials (steel, aluminum)
quantityShipped
 object Quantity shipped for this item
value
 string ✓ Numeric quantity value
unitOfMeasure
 string Unit of measure for the quantity
Values: assembly assortment bag bale ball bar barrel belt bin block boardFeet bolt book bottle box bulk bundle bushel cake can card carton cartridge case cassette celsius cell centigram centiliter centimeter coil combo cone container count cover display dozen drum each flakeTon foot gallon gram gramsPerLiter inch kilogram kit knots linearFoot liter meter milliliter monetaryValue ocularInsertSystem order ounce packPAK package pad pail pair pairInches palletLift palletUnitLoad person piece pint pound poundEquivalent poundGross quart reel roll section set sheet sixPack squareFoot syringe thousand threePack tote tube unit vial
expirationDate
 unknown Expiration date of the product
manufactureDate
 unknown Manufacture or production date of the product
countryOfOrigin
 string Country where the product was manufactured
outerPack
 object Physical details for the outer packaging (case/carton level)
numberOfUnits
 string Number of units in the package
size
 string Size value of the package
sizeUOM
 string Unit of measure for size
Values: bag box carton case cassette each fluidOunce gram kilogram liter milliliter ounce packPAK package pair pound roll tote unit
packageForm
 string Form of the package
Values: bag bottle box can carton coil container pallet shrinkWrap unit
packageMaterial
 string Material of the package
Values: corrugated plastic plasticVacuumed standard wood
weightUOM
 string Unit of measure for weight
Values: pound kilogram
grossWeight
 string Gross weight including packaging
netWeight
 string Net weight of contents only
volumeUOM
 string Unit of measure for volume
Values: standardCubicFoot centiliter cubicDecimeter cubicCentimeter cubicFeet cubicInches cubicMeter cubicYard deciliter fluidOunce gallon halfGallon kiloliter kilogramsPerCubicMeter liter milliliter netGallons pint halfPint quart
volume
 string Volume value
length
 string Length dimension
width
 string Width dimension
height
 string Height dimension
dimensionUOM
 string Unit of measure for dimensions
Values: standardCubicFoot boardFeet hundredBoardFeet cubicDecimeter cubicCentimeter cubicFeet cubicInches centimeter cubicMeter cubicYard decimeter foot hundredFeet hundredFeetLinear hundredSquareFeet hundredYards inch linearFoot linearMeter linearYard millimeter meter squareFoot squareInches squareMeter squareYard thousandSquareInches thousandFeetLinear thousandFeetBoard tenSquareFeet thousandSquareFeet yard
packageId
 string Package identifier
basebox
 string Billable quantity in baseboxes (tin plate industry unit: 112 sheets × 14"×20" = 31,360 sq in)
baseboxBasisWeight
 string Basis weight in pounds per base box — the standard steel mill weight specification unit
innerPack
 object Physical details for the inner packaging
numberOfUnits
 string Number of units in the package
size
 string Size value of the package
sizeUOM
 string Unit of measure for size
Values: bag box carton case cassette each fluidOunce gram kilogram liter milliliter ounce packPAK package pair pound roll tote unit
packageForm
 string Form of the package
Values: bag bottle box can carton coil container pallet shrinkWrap unit
packageMaterial
 string Material of the package
Values: corrugated plastic plasticVacuumed standard wood
weightUOM
 string Unit of measure for weight
Values: pound kilogram
grossWeight
 string Gross weight including packaging
netWeight
 string Net weight of contents only
volumeUOM
 string Unit of measure for volume
Values: standardCubicFoot centiliter cubicDecimeter cubicCentimeter cubicFeet cubicInches cubicMeter cubicYard deciliter fluidOunce gallon halfGallon kiloliter kilogramsPerCubicMeter liter milliliter netGallons pint halfPint quart
volume
 string Volume value
length
 string Length dimension
width
 string Width dimension
height
 string Height dimension
dimensionUOM
 string Unit of measure for dimensions
Values: standardCubicFoot boardFeet hundredBoardFeet cubicDecimeter cubicCentimeter cubicFeet cubicInches centimeter cubicMeter cubicYard decimeter foot hundredFeet hundredFeetLinear hundredSquareFeet hundredYards inch linearFoot linearMeter linearYard millimeter meter squareFoot squareInches squareMeter squareYard thousandSquareInches thousandFeetLinear thousandFeetBoard tenSquareFeet thousandSquareFeet yard
packageId
 string Package identifier
basebox
 string Billable quantity in baseboxes (tin plate industry unit: 112 sheets × 14"×20" = 31,360 sq in)
baseboxBasisWeight
 string Basis weight in pounds per base box — the standard steel mill weight specification unit
sublineItems
 array Subline items for component or kit details
sublineId
 string Subline item identifier
quantity
 object Quantity for the subline item
value
 string ✓ Numeric quantity value
unitOfMeasure
 string Unit of measure for the quantity
Values: assembly assortment bag bale ball bar barrel belt bin block boardFeet bolt book bottle box bulk bundle bushel cake can card carton cartridge case cassette celsius cell centigram centiliter centimeter coil combo cone container count cover display dozen drum each flakeTon foot gallon gram gramsPerLiter inch kilogram kit knots linearFoot liter meter milliliter monetaryValue ocularInsertSystem order ounce packPAK package pad pail pair pairInches palletLift palletUnitLoad person piece pint pound poundEquivalent poundGross quart reel roll section set sheet sixPack squareFoot syringe thousand threePack tote tube unit vial
unitCostPrice
 string Unit cost price for the subline item
unitPriceBasis
 string Basis for the unit price
Values: advise beforeDiscount discount net noCharge perHundred perThousand perDozen perEach perFoot perGram perKilogram perTen perOunce perPound perTenThousand perUOM promotion standard suggestedRetail wholesale wholesalePerEach
productIds
 object ✓ Product identifiers for the subline item
buyerItemNumber
 string Buyer-assigned item number
vendorItemNumber
 string Vendor-assigned item number (EDIFACT LIN/PIA supplier's item number)
gtin12
 string GTIN-12 (UPC-A) barcode
gtin13
 string GTIN-13 (EAN) barcode
gtin14
 string GTIN-14 (ITF-14) case code barcode
caseCode
 string Case code identifier
drugCode
 string National Drug Code (NDC)
standardBookNumber
 string ISBN or standard book number
buyerItemIds
 array Additional buyer product identifiers
type
 string ✓ Type of product identifier
Values: catalog manufacturerPart sku style
value
 string ✓ Product identifier value
vendorItemIds
 array Additional vendor product identifiers
type
 string ✓ Type of product identifier
Values: catalog manufacturerPart sku style
value
 string ✓ Product identifier value
productAttributes
 object Product attributes for the subline item
description
 string General product description. Sourced from X12 PID05 when PID02="08" (Product Description, general) or when PID02 is absent. In EDIFACT, sourced from EVERY IMD composite for this line item where itemDescriptionCode="SP" (Product) — there may be MULTIPLE matching IMD repetitions per line item, and ALL of them must be included. Within each matching IMD, concatenate itemDescription + itemDescription_1 (the continuation field) with a single space; then $join those per-IMD strings across ALL matching IMDs with a single space separator. Do NOT pick only the first matching IMD — partners commonly split a long description across multiple IMD segments because each itemDescription element is capped at 35 characters. The qualifier code "SP" (or X12 "08") is positional — it identifies which IMDs carry the product description, and must NOT be reported as a schema gap.
shortDescription
 string {"description":"Short product description"}
brand
 string Brand or label name for the product
colorCode
 string Color code identifier
colorDescription
 string Color description text
sizeCode
 string Size code identifier
sizeDescription
 string Size description text
materialCode
 string Material code identifier
materialDescription
 string Material description text
materialAttributes
 object
type
 string Material type or classification
grade
 string Material grade or quality tier (e.g., prime, excessPrime, waste)
annealMethod
 string Annealing method applied to the material
temper
 string Heat treatment or mechanical processing state of the material
finish
 string Surface finish or texture applied to the material
outerCoating
 string Outer surface coating or plating
innerCoating
 string Inner surface coating or plating
surfaceProtection
 string Surface protection method or specification
treatment
 string Chemical or mechanical treatment applied to the material
weld
 string Welding specification or classification for the material
processCode
 string Process code identifier
processDescription
 string Process description text
height
 string Product height dimension
length
 string Product length dimension
width
 string Product width dimension
dimensionUOM
 string Unit of measure for product dimensions
Values: standardCubicFoot boardFeet hundredBoardFeet cubicDecimeter cubicCentimeter cubicFeet cubicInches centimeter cubicMeter cubicYard decimeter foot hundredFeet hundredFeetLinear hundredSquareFeet hundredYards inch linearFoot linearMeter linearYard millimeter meter squareFoot squareInches squareMeter squareYard thousandSquareInches thousandFeetLinear thousandFeetBoard tenSquareFeet thousandSquareFeet yard
lotNumber
 string Lot or batch number for the subline item
assertions
 array Assertions or special conditions for this item
isDirectPurchase
 object Indicates that the item was purchased directly from the manufacturer
value
 boolean ✓
isDirectPurchaseStatementReceived
 object Indicates that a direct purchase statement has been received
value
 boolean ✓
cartons
 array ✓ Cartons containing items for this order
items
 array ✓ Items contained in this carton
purchaseOrderLineId
 string Line item identifier from the original purchase order
references
 object Reference numbers for the item
billOfLadingNumber
 object Bill of lading number for this item
value
 string The reference identifier value
description
 string Additional description or context for the reference
billOfMaterial
 object Bill of materials reference for the item
value
 string The reference identifier value
description
 string Additional description or context for the reference
heatCode
 object Steel mill heat number for traceability
value
 string The reference identifier value
description
 string Additional description or context for the reference
barCode
 object Barcode identifier for the item
value
 string The reference identifier value
description
 string Additional description or context for the reference
departmentNumber
 object Department number for this item
value
 string The reference identifier value
description
 string Additional description or context for the reference
invoiceNumber
 object Invoice number associated with this item
value
 string The reference identifier value
description
 string Additional description or context for the reference
productIds
 object ✓ Product identification codes such as UPC, SKU, or vendor item number
buyerItemNumber
 string Buyer-assigned item number
vendorItemNumber
 string Vendor-assigned item number (EDIFACT LIN/PIA supplier's item number)
gtin12
 string GTIN-12 (UPC-A) barcode
gtin13
 string GTIN-13 (EAN) barcode
gtin14
 string GTIN-14 (ITF-14) case code barcode
caseCode
 string Case code identifier
drugCode
 string National Drug Code (NDC)
standardBookNumber
 string ISBN or standard book number
buyerItemIds
 array Additional buyer product identifiers
type
 string ✓ Type of product identifier
Values: catalog manufacturerPart sku style
value
 string ✓ Product identifier value
vendorItemIds
 array Additional vendor product identifiers
type
 string ✓ Type of product identifier
Values: catalog manufacturerPart sku style
value
 string ✓ Product identifier value
productAttributes
 object Product attributes such as color, size, and description
description
 string General product description. Sourced from X12 PID05 when PID02="08" (Product Description, general) or when PID02 is absent. In EDIFACT, sourced from EVERY IMD composite for this line item where itemDescriptionCode="SP" (Product) — there may be MULTIPLE matching IMD repetitions per line item, and ALL of them must be included. Within each matching IMD, concatenate itemDescription + itemDescription_1 (the continuation field) with a single space; then $join those per-IMD strings across ALL matching IMDs with a single space separator. Do NOT pick only the first matching IMD — partners commonly split a long description across multiple IMD segments because each itemDescription element is capped at 35 characters. The qualifier code "SP" (or X12 "08") is positional — it identifies which IMDs carry the product description, and must NOT be reported as a schema gap.
shortDescription
 string {"description":"Short product description"}
brand
 string Brand or label name for the product
colorCode
 string Color code identifier
colorDescription
 string Color description text
sizeCode
 string Size code identifier
sizeDescription
 string Size description text
materialCode
 string Material code identifier
materialDescription
 string Material description text
materialAttributes
 object
type
 string Material type or classification
grade
 string Material grade or quality tier (e.g., prime, excessPrime, waste)
annealMethod
 string Annealing method applied to the material
temper
 string Heat treatment or mechanical processing state of the material
finish
 string Surface finish or texture applied to the material
outerCoating
 string Outer surface coating or plating
innerCoating
 string Inner surface coating or plating
surfaceProtection
 string Surface protection method or specification
treatment
 string Chemical or mechanical treatment applied to the material
weld
 string Welding specification or classification for the material
processCode
 string Process code identifier
processDescription
 string Process description text
height
 string Product height dimension
length
 string Product length dimension
width
 string Product width dimension
dimensionUOM
 string Unit of measure for product dimensions
Values: standardCubicFoot boardFeet hundredBoardFeet cubicDecimeter cubicCentimeter cubicFeet cubicInches centimeter cubicMeter cubicYard decimeter foot hundredFeet hundredFeetLinear hundredSquareFeet hundredYards inch linearFoot linearMeter linearYard millimeter meter squareFoot squareInches squareMeter squareYard thousandSquareInches thousandFeetLinear thousandFeetBoard tenSquareFeet thousandSquareFeet yard
lotNumber
 string Lot or batch number for the product
coilNumber
 string Unique identifier for a coil, used in industrial materials (steel, aluminum)
quantityShipped
 object Quantity shipped for this item
value
 string ✓ Numeric quantity value
unitOfMeasure
 string Unit of measure for the quantity
Values: assembly assortment bag bale ball bar barrel belt bin block boardFeet bolt book bottle box bulk bundle bushel cake can card carton cartridge case cassette celsius cell centigram centiliter centimeter coil combo cone container count cover display dozen drum each flakeTon foot gallon gram gramsPerLiter inch kilogram kit knots linearFoot liter meter milliliter monetaryValue ocularInsertSystem order ounce packPAK package pad pail pair pairInches palletLift palletUnitLoad person piece pint pound poundEquivalent poundGross quart reel roll section set sheet sixPack squareFoot syringe thousand threePack tote tube unit vial
expirationDate
 unknown Expiration date of the product
manufactureDate
 unknown Manufacture or production date of the product
countryOfOrigin
 string Country where the product was manufactured
outerPack
 object Physical details for the outer packaging (case/carton level)
numberOfUnits
 string Number of units in the package
size
 string Size value of the package
sizeUOM
 string Unit of measure for size
Values: bag box carton case cassette each fluidOunce gram kilogram liter milliliter ounce packPAK package pair pound roll tote unit
packageForm
 string Form of the package
Values: bag bottle box can carton coil container pallet shrinkWrap unit
packageMaterial
 string Material of the package
Values: corrugated plastic plasticVacuumed standard wood
weightUOM
 string Unit of measure for weight
Values: pound kilogram
grossWeight
 string Gross weight including packaging
netWeight
 string Net weight of contents only
volumeUOM
 string Unit of measure for volume
Values: standardCubicFoot centiliter cubicDecimeter cubicCentimeter cubicFeet cubicInches cubicMeter cubicYard deciliter fluidOunce gallon halfGallon kiloliter kilogramsPerCubicMeter liter milliliter netGallons pint halfPint quart
volume
 string Volume value
length
 string Length dimension
width
 string Width dimension
height
 string Height dimension
dimensionUOM
 string Unit of measure for dimensions
Values: standardCubicFoot boardFeet hundredBoardFeet cubicDecimeter cubicCentimeter cubicFeet cubicInches centimeter cubicMeter cubicYard decimeter foot hundredFeet hundredFeetLinear hundredSquareFeet hundredYards inch linearFoot linearMeter linearYard millimeter meter squareFoot squareInches squareMeter squareYard thousandSquareInches thousandFeetLinear thousandFeetBoard tenSquareFeet thousandSquareFeet yard
packageId
 string Package identifier
basebox
 string Billable quantity in baseboxes (tin plate industry unit: 112 sheets × 14"×20" = 31,360 sq in)
baseboxBasisWeight
 string Basis weight in pounds per base box — the standard steel mill weight specification unit
innerPack
 object Physical details for the inner packaging
numberOfUnits
 string Number of units in the package
size
 string Size value of the package
sizeUOM
 string Unit of measure for size
Values: bag box carton case cassette each fluidOunce gram kilogram liter milliliter ounce packPAK package pair pound roll tote unit
packageForm
 string Form of the package
Values: bag bottle box can carton coil container pallet shrinkWrap unit
packageMaterial
 string Material of the package
Values: corrugated plastic plasticVacuumed standard wood
weightUOM
 string Unit of measure for weight
Values: pound kilogram
grossWeight
 string Gross weight including packaging
netWeight
 string Net weight of contents only
volumeUOM
 string Unit of measure for volume
Values: standardCubicFoot centiliter cubicDecimeter cubicCentimeter cubicFeet cubicInches cubicMeter cubicYard deciliter fluidOunce gallon halfGallon kiloliter kilogramsPerCubicMeter liter milliliter netGallons pint halfPint quart
volume
 string Volume value
length
 string Length dimension
width
 string Width dimension
height
 string Height dimension
dimensionUOM
 string Unit of measure for dimensions
Values: standardCubicFoot boardFeet hundredBoardFeet cubicDecimeter cubicCentimeter cubicFeet cubicInches centimeter cubicMeter cubicYard decimeter foot hundredFeet hundredFeetLinear hundredSquareFeet hundredYards inch linearFoot linearMeter linearYard millimeter meter squareFoot squareInches squareMeter squareYard thousandSquareInches thousandFeetLinear thousandFeetBoard tenSquareFeet thousandSquareFeet yard
packageId
 string Package identifier
basebox
 string Billable quantity in baseboxes (tin plate industry unit: 112 sheets × 14"×20" = 31,360 sq in)
baseboxBasisWeight
 string Basis weight in pounds per base box — the standard steel mill weight specification unit
sublineItems
 array Subline items for component or kit details
sublineId
 string Subline item identifier
quantity
 object Quantity for the subline item
value
 string ✓ Numeric quantity value
unitOfMeasure
 string Unit of measure for the quantity
Values: assembly assortment bag bale ball bar barrel belt bin block boardFeet bolt book bottle box bulk bundle bushel cake can card carton cartridge case cassette celsius cell centigram centiliter centimeter coil combo cone container count cover display dozen drum each flakeTon foot gallon gram gramsPerLiter inch kilogram kit knots linearFoot liter meter milliliter monetaryValue ocularInsertSystem order ounce packPAK package pad pail pair pairInches palletLift palletUnitLoad person piece pint pound poundEquivalent poundGross quart reel roll section set sheet sixPack squareFoot syringe thousand threePack tote tube unit vial
unitCostPrice
 string Unit cost price for the subline item
unitPriceBasis
 string Basis for the unit price
Values: advise beforeDiscount discount net noCharge perHundred perThousand perDozen perEach perFoot perGram perKilogram perTen perOunce perPound perTenThousand perUOM promotion standard suggestedRetail wholesale wholesalePerEach
productIds
 object ✓ Product identifiers for the subline item
buyerItemNumber
 string Buyer-assigned item number
vendorItemNumber
 string Vendor-assigned item number (EDIFACT LIN/PIA supplier's item number)
gtin12
 string GTIN-12 (UPC-A) barcode
gtin13
 string GTIN-13 (EAN) barcode
gtin14
 string GTIN-14 (ITF-14) case code barcode
caseCode
 string Case code identifier
drugCode
 string National Drug Code (NDC)
standardBookNumber
 string ISBN or standard book number
buyerItemIds
 array Additional buyer product identifiers
type
 string ✓ Type of product identifier
Values: catalog manufacturerPart sku style
value
 string ✓ Product identifier value
vendorItemIds
 array Additional vendor product identifiers
type
 string ✓ Type of product identifier
Values: catalog manufacturerPart sku style
value
 string ✓ Product identifier value
productAttributes
 object Product attributes for the subline item
description
 string General product description. Sourced from X12 PID05 when PID02="08" (Product Description, general) or when PID02 is absent. In EDIFACT, sourced from EVERY IMD composite for this line item where itemDescriptionCode="SP" (Product) — there may be MULTIPLE matching IMD repetitions per line item, and ALL of them must be included. Within each matching IMD, concatenate itemDescription + itemDescription_1 (the continuation field) with a single space; then $join those per-IMD strings across ALL matching IMDs with a single space separator. Do NOT pick only the first matching IMD — partners commonly split a long description across multiple IMD segments because each itemDescription element is capped at 35 characters. The qualifier code "SP" (or X12 "08") is positional — it identifies which IMDs carry the product description, and must NOT be reported as a schema gap.
shortDescription
 string {"description":"Short product description"}
brand
 string Brand or label name for the product
colorCode
 string Color code identifier
colorDescription
 string Color description text
sizeCode
 string Size code identifier
sizeDescription
 string Size description text
materialCode
 string Material code identifier
materialDescription
 string Material description text
materialAttributes
 object
type
 string Material type or classification
grade
 string Material grade or quality tier (e.g., prime, excessPrime, waste)
annealMethod
 string Annealing method applied to the material
temper
 string Heat treatment or mechanical processing state of the material
finish
 string Surface finish or texture applied to the material
outerCoating
 string Outer surface coating or plating
innerCoating
 string Inner surface coating or plating
surfaceProtection
 string Surface protection method or specification
treatment
 string Chemical or mechanical treatment applied to the material
weld
 string Welding specification or classification for the material
processCode
 string Process code identifier
processDescription
 string Process description text
height
 string Product height dimension
length
 string Product length dimension
width
 string Product width dimension
dimensionUOM
 string Unit of measure for product dimensions
Values: standardCubicFoot boardFeet hundredBoardFeet cubicDecimeter cubicCentimeter cubicFeet cubicInches centimeter cubicMeter cubicYard decimeter foot hundredFeet hundredFeetLinear hundredSquareFeet hundredYards inch linearFoot linearMeter linearYard millimeter meter squareFoot squareInches squareMeter squareYard thousandSquareInches thousandFeetLinear thousandFeetBoard tenSquareFeet thousandSquareFeet yard
lotNumber
 string Lot or batch number for the subline item
assertions
 array Assertions or special conditions for this item
isDirectPurchase
 object Indicates that the item was purchased directly from the manufacturer
value
 boolean ✓
isDirectPurchaseStatementReceived
 object Indicates that a direct purchase statement has been received
value
 boolean ✓
trackingNumber
 string Carrier-assigned tracking number for the carton
serialShippingId
 string GS1 Serial Shipping Container Code (SSCC-18) with Application Identifier (AI 00) for the carton. 18-digit, globally unique, and serially assigned per logistics unit — not derived from the product UPC. For product-derived 14-digit SCC-14/ITF-14 case codes use upcShippingContainerCode instead.
upcShippingContainerCode
 string 14-digit U.P.C. Shipping Container Code (SCC-14/ITF-14) for the carton. The most common carton-level barcode, identifying the shipping unit distinctly from the consumer unit inside.
upcConsumerPackageCode
 string U.P.C. Consumer Package Code for the carton. Used when the case pack quantity is 1 and the consumer selling unit is also the shipping unit (e.g. Target single-unit shipments).
cartonPhysicalDetails
 object Physical details of the carton
numberOfUnits
 string Number of units in the package
size
 string Size value of the package
sizeUOM
 string Unit of measure for size
Values: bag box carton case cassette each fluidOunce gram kilogram liter milliliter ounce packPAK package pair pound roll tote unit
packageForm
 string Form of the package
Values: bag bottle box can carton coil container pallet shrinkWrap unit
packageMaterial
 string Material of the package
Values: corrugated plastic plasticVacuumed standard wood
weightUOM
 string Unit of measure for weight
Values: pound kilogram
grossWeight
 string Gross weight including packaging
netWeight
 string Net weight of contents only
volumeUOM
 string Unit of measure for volume
Values: standardCubicFoot centiliter cubicDecimeter cubicCentimeter cubicFeet cubicInches cubicMeter cubicYard deciliter fluidOunce gallon halfGallon kiloliter kilogramsPerCubicMeter liter milliliter netGallons pint halfPint quart
volume
 string Volume value
length
 string Length dimension
width
 string Width dimension
height
 string Height dimension
dimensionUOM
 string Unit of measure for dimensions
Values: standardCubicFoot boardFeet hundredBoardFeet cubicDecimeter cubicCentimeter cubicFeet cubicInches centimeter cubicMeter cubicYard decimeter foot hundredFeet hundredFeetLinear hundredSquareFeet hundredYards inch linearFoot linearMeter linearYard millimeter meter squareFoot squareInches squareMeter squareYard thousandSquareInches thousandFeetLinear thousandFeetBoard tenSquareFeet thousandSquareFeet yard
packageId
 string Package identifier
basebox
 string Billable quantity in baseboxes (tin plate industry unit: 112 sheets × 14"×20" = 31,360 sq in)
baseboxBasisWeight
 string Basis weight in pounds per base box — the standard steel mill weight specification unit
specialHandling
 array Special handling requirements for the carton
handlingType
 string Type of special handling required
Values: bulkyArticle dangerous deliveryService domestic doNotFreeze doNotUseWaterForFire environmentalControlLimits explosiveGas export flammable flammablePoisonGas fragile fullContainerConsolidatorLoad fullContainerFactoryLoad hazardousMaterial humiditySensitive ice keepDry marshalingNotRequired noPlacardsRequired notifyConsigneeBeforeDelivery partialShip perHourRatesApplied perishable poisonousGas protectFromHeat radioactiveMaterial refrigerated shipperLoadCount signatureAndTimeRequired stowBelowDeck temperatureControl trailerFactoryLoad transitShip unloadAsPlacarded waiveInspection volatileOrganicCompound
description
 string Description of special handling
materialId
 string Hazardous material identifier
materialClass
 string Hazardous material class
conditionResponse
 boolean Condition response indicator
items
 array ✓ Items for this order
purchaseOrderLineId
 string Line item identifier from the original purchase order
references
 object Reference numbers for the item
billOfLadingNumber
 object Bill of lading number for this item
value
 string The reference identifier value
description
 string Additional description or context for the reference
billOfMaterial
 object Bill of materials reference for the item
value
 string The reference identifier value
description
 string Additional description or context for the reference
heatCode
 object Steel mill heat number for traceability
value
 string The reference identifier value
description
 string Additional description or context for the reference
barCode
 object Barcode identifier for the item
value
 string The reference identifier value
description
 string Additional description or context for the reference
departmentNumber
 object Department number for this item
value
 string The reference identifier value
description
 string Additional description or context for the reference
invoiceNumber
 object Invoice number associated with this item
value
 string The reference identifier value
description
 string Additional description or context for the reference
productIds
 object ✓ Product identification codes such as UPC, SKU, or vendor item number
buyerItemNumber
 string Buyer-assigned item number
vendorItemNumber
 string Vendor-assigned item number (EDIFACT LIN/PIA supplier's item number)
gtin12
 string GTIN-12 (UPC-A) barcode
gtin13
 string GTIN-13 (EAN) barcode
gtin14
 string GTIN-14 (ITF-14) case code barcode
caseCode
 string Case code identifier
drugCode
 string National Drug Code (NDC)
standardBookNumber
 string ISBN or standard book number
buyerItemIds
 array Additional buyer product identifiers
type
 string ✓ Type of product identifier
Values: catalog manufacturerPart sku style
value
 string ✓ Product identifier value
vendorItemIds
 array Additional vendor product identifiers
type
 string ✓ Type of product identifier
Values: catalog manufacturerPart sku style
value
 string ✓ Product identifier value
productAttributes
 object Product attributes such as color, size, and description
description
 string General product description. Sourced from X12 PID05 when PID02="08" (Product Description, general) or when PID02 is absent. In EDIFACT, sourced from EVERY IMD composite for this line item where itemDescriptionCode="SP" (Product) — there may be MULTIPLE matching IMD repetitions per line item, and ALL of them must be included. Within each matching IMD, concatenate itemDescription + itemDescription_1 (the continuation field) with a single space; then $join those per-IMD strings across ALL matching IMDs with a single space separator. Do NOT pick only the first matching IMD — partners commonly split a long description across multiple IMD segments because each itemDescription element is capped at 35 characters. The qualifier code "SP" (or X12 "08") is positional — it identifies which IMDs carry the product description, and must NOT be reported as a schema gap.
shortDescription
 string {"description":"Short product description"}
brand
 string Brand or label name for the product
colorCode
 string Color code identifier
colorDescription
 string Color description text
sizeCode
 string Size code identifier
sizeDescription
 string Size description text
materialCode
 string Material code identifier
materialDescription
 string Material description text
materialAttributes
 object
type
 string Material type or classification
grade
 string Material grade or quality tier (e.g., prime, excessPrime, waste)
annealMethod
 string Annealing method applied to the material
temper
 string Heat treatment or mechanical processing state of the material
finish
 string Surface finish or texture applied to the material
outerCoating
 string Outer surface coating or plating
innerCoating
 string Inner surface coating or plating
surfaceProtection
 string Surface protection method or specification
treatment
 string Chemical or mechanical treatment applied to the material
weld
 string Welding specification or classification for the material
processCode
 string Process code identifier
processDescription
 string Process description text
height
 string Product height dimension
length
 string Product length dimension
width
 string Product width dimension
dimensionUOM
 string Unit of measure for product dimensions
Values: standardCubicFoot boardFeet hundredBoardFeet cubicDecimeter cubicCentimeter cubicFeet cubicInches centimeter cubicMeter cubicYard decimeter foot hundredFeet hundredFeetLinear hundredSquareFeet hundredYards inch linearFoot linearMeter linearYard millimeter meter squareFoot squareInches squareMeter squareYard thousandSquareInches thousandFeetLinear thousandFeetBoard tenSquareFeet thousandSquareFeet yard
lotNumber
 string Lot or batch number for the product
coilNumber
 string Unique identifier for a coil, used in industrial materials (steel, aluminum)
quantityShipped
 object Quantity shipped for this item
value
 string ✓ Numeric quantity value
unitOfMeasure
 string Unit of measure for the quantity
Values: assembly assortment bag bale ball bar barrel belt bin block boardFeet bolt book bottle box bulk bundle bushel cake can card carton cartridge case cassette celsius cell centigram centiliter centimeter coil combo cone container count cover display dozen drum each flakeTon foot gallon gram gramsPerLiter inch kilogram kit knots linearFoot liter meter milliliter monetaryValue ocularInsertSystem order ounce packPAK package pad pail pair pairInches palletLift palletUnitLoad person piece pint pound poundEquivalent poundGross quart reel roll section set sheet sixPack squareFoot syringe thousand threePack tote tube unit vial
expirationDate
 unknown Expiration date of the product
manufactureDate
 unknown Manufacture or production date of the product
countryOfOrigin
 string Country where the product was manufactured
outerPack
 object Physical details for the outer packaging (case/carton level)
numberOfUnits
 string Number of units in the package
size
 string Size value of the package
sizeUOM
 string Unit of measure for size
Values: bag box carton case cassette each fluidOunce gram kilogram liter milliliter ounce packPAK package pair pound roll tote unit
packageForm
 string Form of the package
Values: bag bottle box can carton coil container pallet shrinkWrap unit
packageMaterial
 string Material of the package
Values: corrugated plastic plasticVacuumed standard wood
weightUOM
 string Unit of measure for weight
Values: pound kilogram
grossWeight
 string Gross weight including packaging
netWeight
 string Net weight of contents only
volumeUOM
 string Unit of measure for volume
Values: standardCubicFoot centiliter cubicDecimeter cubicCentimeter cubicFeet cubicInches cubicMeter cubicYard deciliter fluidOunce gallon halfGallon kiloliter kilogramsPerCubicMeter liter milliliter netGallons pint halfPint quart
volume
 string Volume value
length
 string Length dimension
width
 string Width dimension
height
 string Height dimension
dimensionUOM
 string Unit of measure for dimensions
Values: standardCubicFoot boardFeet hundredBoardFeet cubicDecimeter cubicCentimeter cubicFeet cubicInches centimeter cubicMeter cubicYard decimeter foot hundredFeet hundredFeetLinear hundredSquareFeet hundredYards inch linearFoot linearMeter linearYard millimeter meter squareFoot squareInches squareMeter squareYard thousandSquareInches thousandFeetLinear thousandFeetBoard tenSquareFeet thousandSquareFeet yard
packageId
 string Package identifier
basebox
 string Billable quantity in baseboxes (tin plate industry unit: 112 sheets × 14"×20" = 31,360 sq in)
baseboxBasisWeight
 string Basis weight in pounds per base box — the standard steel mill weight specification unit
innerPack
 object Physical details for the inner packaging
numberOfUnits
 string Number of units in the package
size
 string Size value of the package
sizeUOM
 string Unit of measure for size
Values: bag box carton case cassette each fluidOunce gram kilogram liter milliliter ounce packPAK package pair pound roll tote unit
packageForm
 string Form of the package
Values: bag bottle box can carton coil container pallet shrinkWrap unit
packageMaterial
 string Material of the package
Values: corrugated plastic plasticVacuumed standard wood
weightUOM
 string Unit of measure for weight
Values: pound kilogram
grossWeight
 string Gross weight including packaging
netWeight
 string Net weight of contents only
volumeUOM
 string Unit of measure for volume
Values: standardCubicFoot centiliter cubicDecimeter cubicCentimeter cubicFeet cubicInches cubicMeter cubicYard deciliter fluidOunce gallon halfGallon kiloliter kilogramsPerCubicMeter liter milliliter netGallons pint halfPint quart
volume
 string Volume value
length
 string Length dimension
width
 string Width dimension
height
 string Height dimension
dimensionUOM
 string Unit of measure for dimensions
Values: standardCubicFoot boardFeet hundredBoardFeet cubicDecimeter cubicCentimeter cubicFeet cubicInches centimeter cubicMeter cubicYard decimeter foot hundredFeet hundredFeetLinear hundredSquareFeet hundredYards inch linearFoot linearMeter linearYard millimeter meter squareFoot squareInches squareMeter squareYard thousandSquareInches thousandFeetLinear thousandFeetBoard tenSquareFeet thousandSquareFeet yard
packageId
 string Package identifier
basebox
 string Billable quantity in baseboxes (tin plate industry unit: 112 sheets × 14"×20" = 31,360 sq in)
baseboxBasisWeight
 string Basis weight in pounds per base box — the standard steel mill weight specification unit
sublineItems
 array Subline items for component or kit details
sublineId
 string Subline item identifier
quantity
 object Quantity for the subline item
value
 string ✓ Numeric quantity value
unitOfMeasure
 string Unit of measure for the quantity
Values: assembly assortment bag bale ball bar barrel belt bin block boardFeet bolt book bottle box bulk bundle bushel cake can card carton cartridge case cassette celsius cell centigram centiliter centimeter coil combo cone container count cover display dozen drum each flakeTon foot gallon gram gramsPerLiter inch kilogram kit knots linearFoot liter meter milliliter monetaryValue ocularInsertSystem order ounce packPAK package pad pail pair pairInches palletLift palletUnitLoad person piece pint pound poundEquivalent poundGross quart reel roll section set sheet sixPack squareFoot syringe thousand threePack tote tube unit vial
unitCostPrice
 string Unit cost price for the subline item
unitPriceBasis
 string Basis for the unit price
Values: advise beforeDiscount discount net noCharge perHundred perThousand perDozen perEach perFoot perGram perKilogram perTen perOunce perPound perTenThousand perUOM promotion standard suggestedRetail wholesale wholesalePerEach
productIds
 object ✓ Product identifiers for the subline item
buyerItemNumber
 string Buyer-assigned item number
vendorItemNumber
 string Vendor-assigned item number (EDIFACT LIN/PIA supplier's item number)
gtin12
 string GTIN-12 (UPC-A) barcode
gtin13
 string GTIN-13 (EAN) barcode
gtin14
 string GTIN-14 (ITF-14) case code barcode
caseCode
 string Case code identifier
drugCode
 string National Drug Code (NDC)
standardBookNumber
 string ISBN or standard book number
buyerItemIds
 array Additional buyer product identifiers
type
 string ✓ Type of product identifier
Values: catalog manufacturerPart sku style
value
 string ✓ Product identifier value
vendorItemIds
 array Additional vendor product identifiers
type
 string ✓ Type of product identifier
Values: catalog manufacturerPart sku style
value
 string ✓ Product identifier value
productAttributes
 object Product attributes for the subline item
description
 string General product description. Sourced from X12 PID05 when PID02="08" (Product Description, general) or when PID02 is absent. In EDIFACT, sourced from EVERY IMD composite for this line item where itemDescriptionCode="SP" (Product) — there may be MULTIPLE matching IMD repetitions per line item, and ALL of them must be included. Within each matching IMD, concatenate itemDescription + itemDescription_1 (the continuation field) with a single space; then $join those per-IMD strings across ALL matching IMDs with a single space separator. Do NOT pick only the first matching IMD — partners commonly split a long description across multiple IMD segments because each itemDescription element is capped at 35 characters. The qualifier code "SP" (or X12 "08") is positional — it identifies which IMDs carry the product description, and must NOT be reported as a schema gap.
shortDescription
 string {"description":"Short product description"}
brand
 string Brand or label name for the product
colorCode
 string Color code identifier
colorDescription
 string Color description text
sizeCode
 string Size code identifier
sizeDescription
 string Size description text
materialCode
 string Material code identifier
materialDescription
 string Material description text
materialAttributes
 object
type
 string Material type or classification
grade
 string Material grade or quality tier (e.g., prime, excessPrime, waste)
annealMethod
 string Annealing method applied to the material
temper
 string Heat treatment or mechanical processing state of the material
finish
 string Surface finish or texture applied to the material
outerCoating
 string Outer surface coating or plating
innerCoating
 string Inner surface coating or plating
surfaceProtection
 string Surface protection method or specification
treatment
 string Chemical or mechanical treatment applied to the material
weld
 string Welding specification or classification for the material
processCode
 string Process code identifier
processDescription
 string Process description text
height
 string Product height dimension
length
 string Product length dimension
width
 string Product width dimension
dimensionUOM
 string Unit of measure for product dimensions
Values: standardCubicFoot boardFeet hundredBoardFeet cubicDecimeter cubicCentimeter cubicFeet cubicInches centimeter cubicMeter cubicYard decimeter foot hundredFeet hundredFeetLinear hundredSquareFeet hundredYards inch linearFoot linearMeter linearYard millimeter meter squareFoot squareInches squareMeter squareYard thousandSquareInches thousandFeetLinear thousandFeetBoard tenSquareFeet thousandSquareFeet yard
lotNumber
 string Lot or batch number for the subline item
assertions
 array Assertions or special conditions for this item
isDirectPurchase
 object Indicates that the item was purchased directly from the manufacturer
value
 boolean ✓
isDirectPurchaseStatementReceived
 object Indicates that a direct purchase statement has been received
value
 boolean ✓ 
{
  "type": "856_SHIP_NOTICE_MANIFEST",
  "stream": "test",
  "senderId": "SELLERISA",
  "receiverId": "BUYERISA",
  "message": {
    "purpose": "original",
    "shipmentId": "SHP-2026-0219-4875905",
    "carrierDetails": {
      "quantityAndWeight": [
        {
          "packageForm": "carton",
          "weightUOM": "pound",
          "grossWeight": "285.00"
        }
      ],
      "routing": [
        {
          "sequenceType": "origin",
          "standardCarrierAlphaCode": "FEDX",
          "transportationMethod": "commonCarrier",
          "serviceLevel": "ground"
        }
      ],
      "equipment": {
        "equipmentType": "trailer",
        "equipmentId": "FEDX-TRL-88412"
      },
      "freeOnBoard": [
        {
          "methodOfPayment": "mutuallyAgreed"
        }
      ]
    },
    "references": {
      "billOfLadingNumber": {
        "value": "BOL-2026-0219-001"
      },
      "proNumber": {
        "value": "PRO7742859301"
      },
      "vendorNumber": {
        "value": "4875905"
      }
    },
    "dates": {
      "shipDate": "2026-02-19",
      "deliveryDate": "2026-02-21"
    },
    "parties": {
      "shipFrom": {
        "name": "Toothpaste Warehouse West",
        "identificationCode": "WH-WEST-01",
        "identificationCodeType": "warehouse",
        "addressLine1": "2200 Distribution Pkwy",
        "city": "Edison",
        "stateOrProvinceCode": "NJ",
        "postalCode": "08817",
        "countryCode": "US",
        "contacts": [
          {
            "type": "shipping",
            "name": "Fulfillment Desk",
            "phoneNumber": "732-555-0100",
            "email": "[email protected]"
          }
        ]
      },
      "shipTo": {
        "name": "Retail Integration Testing",
        "identificationCode": "5438",
        "identificationCodeType": "sendersId",
        "addressLine1": "4055 MAIN ST",
        "city": "NEW YORK",
        "stateOrProvinceCode": "NY",
        "postalCode": "10001",
        "countryCode": "US"
      },
      "supplier": {
        "name": "Toothpaste Co.",
        "identificationCode": "4875905",
        "identificationCodeType": "sendersId"
      }
    },
    "orders": [
      {
        "purchaseOrderNumber": "PO5786344061670677",
        "purchaseOrderDate": "2026-02-12",
        "pallets": [
          {
            "palletType": "standard",
            "serialShippingId": "00100487590500000101",
            "layersPerPallet": 2,
            "cartonsPerLayer": 1,
            "cartons": [
              {
                "serialShippingId": "00100487590500000201",
                "trackingNumber": "794644790132",
                "items": [
                  {
                    "purchaseOrderLineId": "1",
                    "productIds": {
                      "buyerItemNumber": "10000002",
                      "gtin12": "002837465832"
                    },
                    "productAttributes": {
                      "description": "Green toothpaste"
                    },
                    "quantityShipped": {
                      "value": "5",
                      "unitOfMeasure": "each"
                    },
                    "outerPack": {
                      "numberOfUnits": "10"
                    },
                    "innerPack": {
                      "numberOfUnits": "10"
                    }
                  }
                ]
              },
              {
                "serialShippingId": "00100487590500000202",
                "trackingNumber": "794644790133",
                "items": [
                  {
                    "purchaseOrderLineId": "2",
                    "productIds": {
                      "buyerItemNumber": "10000004",
                      "gtin12": "002837465837"
                    },
                    "productAttributes": {
                      "description": "Orange toothpaste"
                    },
                    "quantityShipped": {
                      "value": "20",
                      "unitOfMeasure": "each"
                    },
                    "outerPack": {
                      "numberOfUnits": "8"
                    },
                    "innerPack": {
                      "numberOfUnits": "8"
                    }
                  }
                ]
              }
            ]
          },
          {
            "palletType": "standard",
            "serialShippingId": "00100487590500000102",
            "layersPerPallet": 2,
            "cartonsPerLayer": 1,
            "cartons": [
              {
                "serialShippingId": "00100487590500000203",
                "trackingNumber": "794644790134",
                "items": [
                  {
                    "purchaseOrderLineId": "4",
                    "productIds": {
                      "buyerItemNumber": "10000001",
                      "gtin12": "002837465831"
                    },
                    "productAttributes": {
                      "description": "Yellow toothpaste"
                    },
                    "quantityShipped": {
                      "value": "10",
                      "unitOfMeasure": "each"
                    },
                    "outerPack": {
                      "numberOfUnits": "10"
                    },
                    "innerPack": {
                      "numberOfUnits": "10"
                    }
                  }
                ]
              },
              {
                "serialShippingId": "00100487590500000204",
                "trackingNumber": "794644790135",
                "items": [
                  {
                    "purchaseOrderLineId": "5",
                    "productIds": {
                      "buyerItemNumber": "ORDERFUL-TEST-SKU-005A",
                      "gtin12": "012345678015"
                    },
                    "productAttributes": {
                      "description": "Placeholder product for scenario testing"
                    },
                    "quantityShipped": {
                      "value": "5",
                      "unitOfMeasure": "each"
                    },
                    "outerPack": {
                      "numberOfUnits": "1"
                    },
                    "innerPack": {
                      "numberOfUnits": "1"
                    }
                  }
                ]
              }
            ]
          }
        ]
      },
      {
        "purchaseOrderNumber": "PO9921004488220031",
        "purchaseOrderDate": "2026-02-10",
        "parties": {
          "markFor": {
            "name": "Metals Distribution Center",
            "identificationCode": "MDC-044",
            "identificationCodeType": "sendersId"
          }
        },
        "pallets": [
          {
            "palletType": "steel",
            "serialShippingId": "00100487590500000301",
            "cartons": [
              {
                "serialShippingId": "00100487590500000309",
                "items": [
                  {
                    "purchaseOrderLineId": "1",
                    "references": {
                      "heatCode": {
                        "value": "HT-2026-A4819"
                      },
                      "billOfMaterial": {
                        "value": "BOM-SS304-COIL-48"
                      }
                    },
                    "productIds": {
                      "vendorItemNumber": "SS304-48-020"
                    },
                    "productAttributes": {
                      "description": "304 Stainless Steel Coil 48in x 0.020in",
                      "materialAttributes": {
                        "type": "304 Stainless Steel",
                        "annealMethod": "bright anneal",
                        "temper": "quarter hard",
                        "finish": "2B",
                        "surfaceProtection": "PVC film"
                      }
                    },
                    "coilNumber": "COIL-2026-SS304-00219",
                    "quantityShipped": {
                      "value": "12000",
                      "unitOfMeasure": "pound"
                    },
                    "manufactureDate": "2026-01-28",
                    "countryOfOrigin": "US"
                  },
                  {
                    "purchaseOrderLineId": "2",
                    "references": {
                      "heatCode": {
                        "value": "HT-2026-A4820"
                      },
                      "barCode": {
                        "value": "SN00100487590500000302"
                      }
                    },
                    "productIds": {
                      "vendorItemNumber": "CS1018-36-125"
                    },
                    "productAttributes": {
                      "description": "1018 Carbon Steel Sheet 36in x 0.125in",
                      "materialAttributes": {
                        "type": "1018 Carbon Steel",
                        "temper": "hot rolled",
                        "finish": "mill",
                        "outerCoating": "oil",
                        "treatment": "pickled"
                      }
                    },
                    "coilNumber": "COIL-2026-CS1018-00084",
                    "quantityShipped": {
                      "value": "8500",
                      "unitOfMeasure": "pound"
                    },
                    "manufactureDate": "2026-02-03",
                    "countryOfOrigin": "US"
                  }
                ]
              }
            ]
          }
        ]
      }
    ]
  }
}
File Description Download
sample.json Sample JSON payload Download
schema.json JSON Schema for validation Download

Updated 5 days ago

Did this page help you?

Updated 5 days ago

Did this page help you?