Warehouse Shipping Order

Warehouse Shipping Order (940)

A Warehouse Shipping Order (940) is sent by a depositor to a warehouse to request shipment of goods.

Schema Overview Sample Downloads

Field	Type	Required	Description
purpose	string	✓	Intended purpose of the warehouse shipping order Values: `original` `change` `cancel`
supplierOrderNumber	string	✓	Depositor's unique identifier for this warehouse shipping order
purchaseOrderNumber	string		The originating purchase order number
shipmentSequenceNumber	string		Sequence number when a single purchase order is fulfilled via multiple shipments (e.g., 1 of 3)
partiesshow child fieldshide child fields	object		Parties involved in the shipping order
shipToshow child fieldshide child fields	object		Ship-to location - where the goods should be 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`
contactsshow child fieldshide child fields	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.
shipFromshow child fieldshide child fields	object		Warehouse/ship-from location - where the goods are shipped from
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`
contactsshow child fieldshide child fields	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.
billToshow child fieldshide child fields	object		Bill-to party for freight charges
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`
contactsshow child fieldshide child fields	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.
buyershow child fieldshide child fields	object		Buying party who placed 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`
contactsshow child fieldshide child fields	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.
notesshow child fieldshide child fields	object		Notes and special instructions for the warehouse
generalshow child fieldshide child fields	object		Generic notes or standard legal agreements
description	string		Brief description or title of the note
text	array of string		Array of text lines for the note content
packingInstructionsshow child fieldshide child fields	object		Instructions for how to pack the shipment
description	string		Brief description or title of the note
text	array of string		Array of text lines for the note content
shippingInstructionsshow child fieldshide child fields	object		Instructions for how to ship (carrier, handling, delivery)
description	string		Brief description or title of the note
text	array of string		Array of text lines for the note content
packingSlipMessageshow child fieldshide child fields	object		Message to appear on the packing slip
description	string		Brief description or title of the note
text	array of string		Array of text lines for the note content
referencesshow child fieldshide child fields	object		Reference numbers for cross-referencing related documents
customerOrderNumbershow child fieldshide child fields	object		Customer order number for cross-referencing
value	string		The reference identifier value
description	string		Additional description or context for the reference
departmentNumbershow child fieldshide child fields	object		Department number for routing or allocation
value	string		The reference identifier value
description	string		Additional description or context for the reference
billOfLadingNumbershow child fieldshide child fields	object		Bill of lading number for the shipment
value	string		The reference identifier value
description	string		Additional description or context for the reference
warehouseBuyerIdshow child fieldshide child fields	object		Buyer identifier used by the warehouse operator to apply retailer-specific fulfillment requirements (labels, carrier, EDI profile)
value	string		The reference identifier value
description	string		Additional description or context for the reference
datesshow child fieldshide child fields	object		Key dates for the shipping order
requestedShipDate	unknown		Requested date for the warehouse to ship the order
earliestShipDate	unknown		Earliest acceptable ship date (do not ship before)
latestShipDate	unknown		Latest acceptable ship date (must ship by)
requestedDeliveryDate	unknown		Requested delivery date at the destination
carrierDetailsshow child fieldshide child fields	object		Carrier and shipping details
routingshow child fieldshide child fields	array		Carrier routing instructions
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
freeOnBoardshow child fieldshide child fields	array		F.O.B. and payment terms
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
specialHandlingshow child fieldshide child fields	array		Special handling requirements (hazmat, temperature, etc.)
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
palletExchangeType	string		Pallet exchange or return arrangement Values: `noExchangeOrReturn` `exchange` `return` `customerPurchase` `thirdPartyExchange`
unitLoadOption	string		How the shipment is arranged for loading/unloading (determines equipment needed) Values: `palletized` `floorStack` `mixed` `slipSheet` `module` `clampable` `bopSheet` `airbagSlipSheetCombo` `cargoQuilt` `shrinkWrap` `loadLock`
lineItemsshow child fieldshide child fields	array		Line items to be shipped from the warehouse
shippingOrderLineId	string		Line item identifier for this shipping order — used by the 945 response to link back to this line
purchaseOrderLineId	string		Line identifier from the originating purchase order (not necessarily the same as lineNumber)
quantityshow child fieldshide child fields	object		Quantity to ship
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`
productIdsshow child fieldshide child fields	object		Product identification codes (UPC, SKU, vendor item number, etc.)
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
buyerItemIdsshow child fieldshide child fields	array		Additional buyer product identifiers
type	string	✓	Type of product identifier Values: `catalog` `manufacturerPart` `sku` `style`
value	string	✓	Product identifier value
vendorItemIdsshow child fieldshide child fields	array		Additional vendor product identifiers
type	string	✓	Type of product identifier Values: `catalog` `manufacturerPart` `sku` `style`
value	string	✓	Product identifier value
productAttributesshow child fieldshide child fields	object		Product characteristics and description (colour, size, material, etc.)
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
materialAttributesshow child fieldshide child fields	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`
outerPackshow child fieldshide child fields	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
innerPackshow child fieldshide child fields	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
lotNumber	string		Lot or batch number for the product
freightClassCode	string		NMFC freight class code for LTL shipping rate calculation (e.g., "50", "70", "100")
standardTransportationCommodityCode	string		Standard Transportation Commodity Code for rail/intermodal freight classification (7-digit)
unitCostPrice	string		Unit cost/price for inventory valuation or declared value (e.g., insurance, customs)

{
  "purpose": "original",
  "supplierOrderNumber": "WSO-2026-001234",
  "purchaseOrderNumber": "PO-98765",
  "shipmentSequenceNumber": "1",
  "parties": {
    "shipTo": {
      "name": "Acme Retail Store #142",
      "additionalName1": "Receiving Department",
      "identificationCode": "0078742035291",
      "identificationCodeType": "globalLocationId",
      "addressLine1": "1234 Commerce Blvd",
      "addressLine2": "Suite 100",
      "city": "Dallas",
      "stateOrProvinceCode": "TX",
      "postalCode": "75201",
      "countryCode": "US",
      "contacts": [
        {
          "type": "receiving",
          "name": "John Smith",
          "phoneNumber": "214-555-1234",
          "email": "[email protected]"
        }
      ]
    },
    "shipFrom": {
      "name": "National Distribution Center",
      "identificationCode": "WH-DFW-001",
      "identificationCodeType": "warehouse",
      "addressLine1": "5000 Logistics Parkway",
      "city": "Fort Worth",
      "stateOrProvinceCode": "TX",
      "postalCode": "76177",
      "countryCode": "US",
      "contacts": [
        {
          "type": "shipping",
          "name": "Maria Garcia",
          "phoneNumber": "817-555-9876",
          "email": "[email protected]"
        }
      ]
    },
    "billTo": {
      "name": "Acme Retail Corporate",
      "identificationCode": "ACME001",
      "identificationCodeType": "sendersId",
      "addressLine1": "500 Corporate Drive",
      "city": "Bentonville",
      "stateOrProvinceCode": "AR",
      "postalCode": "72712",
      "countryCode": "US"
    },
    "buyer": {
      "name": "Acme Retail Purchasing",
      "identificationCode": "123456789",
      "identificationCodeType": "duns",
      "contacts": [
        {
          "type": "primary",
          "name": "Sarah Johnson",
          "phoneNumber": "479-555-4567",
          "email": "[email protected]"
        }
      ]
    }
  },
  "references": {
    "customerOrderNumber": {
      "value": "CO-2026-00567",
      "description": "Customer order reference"
    },
    "departmentNumber": {
      "value": "DEPT-42",
      "description": "Electronics Department"
    },
    "billOfLadingNumber": {
      "value": "BOL-789012",
      "description": "Carrier bill of lading"
    }
  },
  "dates": {
    "requestedShipDate": "2026-01-20",
    "earliestShipDate": "2026-01-18",
    "latestShipDate": "2026-01-22",
    "requestedDeliveryDate": "2026-01-25"
  },
  "notes": {
    "general": {
      "description": "Order Notes",
      "text": [
        "Priority customer - handle with care",
        "Contact buyer if any items are unavailable"
      ]
    },
    "packingInstructions": {
      "description": "Packing Requirements",
      "text": [
        "Use double-wall corrugated boxes for fragile items",
        "Include packing slip in each carton",
        "Do not exceed 50 lbs per carton"
      ]
    },
    "shippingInstructions": {
      "description": "Delivery Instructions",
      "text": [
        "Deliver to receiving dock B",
        "Call 30 minutes before arrival",
        "Appointment required - reference APT-12345"
      ]
    },
    "packingSlipMessage": {
      "description": "Packing Slip",
      "text": ["Thank you for your order!", "Questions? Call 1-800-555-ACME"]
    }
  },
  "carrierDetails": {
    "routing": [
      {
        "sequenceType": "origin",
        "standardCarrierAlphaCode": "FEDX",
        "transportationMethod": "commonCarrier",
        "serviceLevel": "ground",
        "description": "FedEx Ground Service",
        "transitTimeType": "workingDays",
        "transitTime": "3"
      }
    ],
    "freeOnBoard": [
      {
        "methodOfPayment": "prepaidBySeller",
        "locationType": "origin",
        "locationDescription": "Fort Worth, TX",
        "transportationTermsSource": "incoTerms",
        "transportationTerms": "freeOnBoard",
        "description": "FOB Origin - Freight Prepaid"
      }
    ],
    "specialHandling": [
      {
        "handlingType": "fragile",
        "description": "Contains electronic equipment - handle with care"
      },
      {
        "handlingType": "temperatureControl",
        "description": "Maintain between 50-80°F"
      }
    ],
    "palletExchangeType": "noExchangeOrReturn",
    "unitLoadOption": "palletized"
  },
  "lineItems": [
    {
      "shippingOrderLineId": "001",
      "quantity": {
        "value": "24",
        "unitOfMeasure": "each"
      },
      "productIds": {
        "buyerItemNumber": "ACM-SKU-12345",
        "vendorItemNumber": "VND-WIDGET-001",
        "gtin12": "012345678901",
        "gtin14": "10012345678901",
        "caseCode": "012345678901",
        "buyerItemIds": [
          {
            "type": "sku",
            "value": "SKU-WIDGET-BLK-LG"
          },
          {
            "type": "style",
            "value": "STYLE-2026-SPRING"
          }
        ],
        "vendorItemIds": [
          {
            "type": "manufacturerPart",
            "value": "MFG-PART-98765"
          }
        ]
      },
      "productAttributes": {
        "description": "Premium Widget - Large Black",
        "sizeDescription": "Large",
        "colorDescription": "Black"
      },
      "outerPack": {
        "numberOfUnits": "6",
        "size": "12",
        "sizeUOM": "ounce",
        "grossWeight": "15.5",
        "weightUOM": "pound",
        "volume": "2.5",
        "volumeUOM": "cubicFeet"
      },
      "lotNumber": "LOT-2026-01-A1",
      "freightClassCode": "70",
      "standardTransportationCommodityCode": "3714110"
    },
    {
      "shippingOrderLineId": "002",
      "quantity": {
        "value": "48",
        "unitOfMeasure": "each"
      },
      "productIds": {
        "buyerItemNumber": "ACM-SKU-67890",
        "vendorItemNumber": "VND-GADGET-002",
        "gtin12": "098765432109",
        "buyerItemIds": [
          {
            "type": "sku",
            "value": "SKU-GADGET-WHT-SM"
          }
        ]
      },
      "productAttributes": {
        "description": "Standard Gadget - Small White",
        "sizeDescription": "Small",
        "colorDescription": "White"
      },
      "outerPack": {
        "numberOfUnits": "12",
        "size": "8",
        "sizeUOM": "ounce",
        "grossWeight": "22.0",
        "weightUOM": "pound"
      },
      "lotNumber": "LOT-2026-01-B3"
    },
    {
      "shippingOrderLineId": "003",
      "quantity": {
        "value": "100",
        "unitOfMeasure": "each"
      },
      "productIds": {
        "buyerItemNumber": "ACM-SKU-11111",
        "gtin12": "111111111111",
        "drugCode": "12345-6789-01"
      },
      "productAttributes": {
        "description": "Health Supplement - 30 Count Bottle"
      },
      "outerPack": {
        "numberOfUnits": "24",
        "netWeight": "8.0",
        "weightUOM": "pound"
      },
      "lotNumber": "LOT-2026-01-PHARMA"
    }
  ]
}

File	Description	Download
sample.json	Sample JSON payload	Download
schema.json	JSON Schema for validation	Download