A Warehouse Shipping Advice (945) is sent by a warehouse to notify a depositor that goods have been shipped.
| Field | Type | Required | Description |
|---|---|---|---|
shipmentStatus |
string | Indicates whether this is a complete, partial, or replacement shipment Values: complete partial reshipment |
|
shippingOrderNumber |
string | ✓ | Unique identifier for the shipping order - links to the 940 shippingOrderNumber |
shipmentIdentificationNumber |
string | Unique identifier for this shipment assigned by the warehouse | |
purchaseOrderNumber |
string | The originating purchase order number | |
shipmentSequenceNumber |
string | Sequence number when a 940 is fulfilled across multiple shipments (e.g., 2 of 3) | |
parties |
object | Parties involved in the shipment | |
shipTo |
object | Ship-to location - where the goods were 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. | |
shipFrom |
object | Warehouse/ship-from location - where the goods 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 |
|
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. | |
billTo |
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 |
|
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/depositor - the party who owns inventory at the warehouse and sent the 940 shipping 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. | |
buyer |
object | Buying party who placed the original 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. | |
dates |
object | Key dates for the shipping advice | |
shipDate |
unknown | Actual date the shipment was shipped | |
deliveryDate |
unknown | Estimated delivery date at destination | |
references |
object | Header-level reference numbers | |
vendorNumber |
object | Internal vendor or customer reference number | |
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 | |
departmentNumber |
object | Department 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 | |
agentShipmentNumber |
object | Shipment identifier assigned by a third-party agent such as a freight broker or 3PL coordinator | |
value |
string | The reference identifier value | |
description |
string | Additional description or context for the reference | |
carrierDetails |
object | Carrier and shipping details | |
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) | |
volume |
object | Total volume of the shipment | |
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 |
|
routing |
array | Carrier routing information | |
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 | |
billOfLadingNumber |
string | Bill of lading number for the shipment | |
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 | |
Structure Variant |
union | This schema has 4 structural variants ("flat line items (no container grouping)", "Pallets → Items", "Pallets → Cartons → Items", "Cartons → Items"). Each shares the common fields below but differs in how items are organized. Expand a variant to see its specific fields. | |
lineItems |
array | Line items that were shipped from the warehouse | |
purchaseOrderLineId |
string | Line item identifier from the originating purchase order | |
shippingOrderLineId |
string | Line item identifier from the originating 940 shipping order — links this shipped item back to the requested line | |
status |
string | Shipment status of this line item Values: complete partial |
|
quantityOrdered |
object | Original quantity ordered | |
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 |
|
quantityShipped |
object | Quantity actually shipped | |
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 |
|
productIds |
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 | |
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 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 | |
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 |
|
warehouseLotNumber |
string | Reference number assigned by the warehouse for inventory tracking | |
physicalDetails |
object | Physical details for the line item (weight, volume, dimensions) | |
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 | |
dates |
object | Date information for the line item | |
expirationDate |
unknown | Product expiration date | |
manufactureDate |
unknown | Product manufacture date | |
references |
object | Reference numbers for the line item | |
lotNumber |
string | Lot number for the product | |
pickUpReference |
object | Pick-up reference number | |
value |
string | The reference identifier value | |
description |
string | Additional description or context for the reference | |
vendorContractNumber |
object | Vendor contract number | |
value |
string | The reference identifier value | |
description |
string | Additional description or context for the reference | |
billOfLadingNumber |
object | Bill of lading number for this line item | |
value |
string | The reference identifier value | |
description |
string | Additional description or context for the reference | |
pallets |
array | Pallets containing items shipped from the warehouse | |
serialShippingId |
string | Serial Shipping Container Code (SSCC-18) for the pallet | |
trackingNumber |
string | Carrier-assigned tracking number for the pallet | |
physicalDetails |
object | Physical details of the pallet (weight, volume, dimensions) | |
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 | ✓ | Line items loaded directly on this pallet |
purchaseOrderLineId |
string | Line item identifier from the originating purchase order | |
shippingOrderLineId |
string | Line item identifier from the originating 940 shipping order — links this shipped item back to the requested line | |
status |
string | Shipment status of this line item Values: complete partial |
|
quantityOrdered |
object | Original quantity ordered | |
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 |
|
quantityShipped |
object | Quantity actually shipped | |
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 |
|
productIds |
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 | |
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 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 | |
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 |
|
warehouseLotNumber |
string | Reference number assigned by the warehouse for inventory tracking | |
physicalDetails |
object | Physical details for the line item (weight, volume, dimensions) | |
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 | |
dates |
object | Date information for the line item | |
expirationDate |
unknown | Product expiration date | |
manufactureDate |
unknown | Product manufacture date | |
references |
object | Reference numbers for the line item | |
lotNumber |
string | Lot number for the product | |
pickUpReference |
object | Pick-up reference number | |
value |
string | The reference identifier value | |
description |
string | Additional description or context for the reference | |
vendorContractNumber |
object | Vendor contract number | |
value |
string | The reference identifier value | |
description |
string | Additional description or context for the reference | |
billOfLadingNumber |
object | Bill of lading number for this line item | |
value |
string | The reference identifier value | |
description |
string | Additional description or context for the reference | |
pallets |
array | Pallets containing cartons of items shipped from the warehouse | |
serialShippingId |
string | Serial Shipping Container Code (SSCC-18) for the pallet | |
trackingNumber |
string | Carrier-assigned tracking number for the pallet | |
physicalDetails |
object | Physical details of the pallet (weight, volume, dimensions) | |
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 |
serialShippingId |
string | Serial Shipping Container Code (SSCC-18) for the carton | |
trackingNumber |
string | Carrier-assigned tracking number for the carton | |
physicalDetails |
object | Physical details of the carton (weight, volume, dimensions) | |
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 | ✓ | Line items contained in this carton |
purchaseOrderLineId |
string | Line item identifier from the originating purchase order | |
shippingOrderLineId |
string | Line item identifier from the originating 940 shipping order — links this shipped item back to the requested line | |
status |
string | Shipment status of this line item Values: complete partial |
|
quantityOrdered |
object | Original quantity ordered | |
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 |
|
quantityShipped |
object | Quantity actually shipped | |
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 |
|
productIds |
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 | |
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 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 | |
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 |
|
warehouseLotNumber |
string | Reference number assigned by the warehouse for inventory tracking | |
physicalDetails |
object | Physical details for the line item (weight, volume, dimensions) | |
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 | |
dates |
object | Date information for the line item | |
expirationDate |
unknown | Product expiration date | |
manufactureDate |
unknown | Product manufacture date | |
references |
object | Reference numbers for the line item | |
lotNumber |
string | Lot number for the product | |
pickUpReference |
object | Pick-up reference number | |
value |
string | The reference identifier value | |
description |
string | Additional description or context for the reference | |
vendorContractNumber |
object | Vendor contract number | |
value |
string | The reference identifier value | |
description |
string | Additional description or context for the reference | |
billOfLadingNumber |
object | Bill of lading number for this line item | |
value |
string | The reference identifier value | |
description |
string | Additional description or context for the reference | |
cartons |
array | Cartons containing items shipped from the warehouse | |
serialShippingId |
string | Serial Shipping Container Code (SSCC-18) for the carton | |
trackingNumber |
string | Carrier-assigned tracking number for the carton | |
physicalDetails |
object | Physical details of the carton (weight, volume, dimensions) | |
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 | ✓ | Line items contained in this carton |
purchaseOrderLineId |
string | Line item identifier from the originating purchase order | |
shippingOrderLineId |
string | Line item identifier from the originating 940 shipping order — links this shipped item back to the requested line | |
status |
string | Shipment status of this line item Values: complete partial |
|
quantityOrdered |
object | Original quantity ordered | |
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 |
|
quantityShipped |
object | Quantity actually shipped | |
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 |
|
productIds |
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 | |
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 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 | |
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 |
|
warehouseLotNumber |
string | Reference number assigned by the warehouse for inventory tracking | |
physicalDetails |
object | Physical details for the line item (weight, volume, dimensions) | |
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 | |
dates |
object | Date information for the line item | |
expirationDate |
unknown | Product expiration date | |
manufactureDate |
unknown | Product manufacture date | |
references |
object | Reference numbers for the line item | |
lotNumber |
string | Lot number for the product | |
pickUpReference |
object | Pick-up reference number | |
value |
string | The reference identifier value | |
description |
string | Additional description or context for the reference | |
vendorContractNumber |
object | Vendor contract number | |
value |
string | The reference identifier value | |
description |
string | Additional description or context for the reference | |
billOfLadingNumber |
object | Bill of lading number for this line item | |
value |
string | The reference identifier value | |
description |
string | Additional description or context for the reference |
{
"shipmentStatus": "partial",
"shippingOrderNumber": "WSO-2026-001234",
"shipmentIdentificationNumber": "SHP-2026-001234-01",
"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"
},
"supplier": {
"name": "GreenLeaf Consumer Goods",
"identificationCode": "987654321",
"identificationCodeType": "duns",
"addressLine1": "200 Brand Avenue",
"city": "Chicago",
"stateOrProvinceCode": "IL",
"postalCode": "60601",
"countryCode": "US",
"contacts": [
{
"type": "primary",
"name": "David Chen",
"phoneNumber": "312-555-7890",
"email": "[email protected]"
}
]
},
"buyer": {
"name": "Acme Retail Purchasing",
"identificationCode": "123456789",
"identificationCodeType": "duns",
"contacts": [
{
"type": "primary",
"name": "Sarah Johnson",
"phoneNumber": "479-555-4567",
"email": "[email protected]"
}
]
}
},
"dates": {
"shipDate": "2026-01-20",
"deliveryDate": "2026-01-23"
},
"references": {
"vendorNumber": {
"value": "VND-GL-4420",
"description": "GreenLeaf vendor account"
},
"loadPlanningNumber": {
"value": "LP-2026-0120-DFW",
"description": "DFW distribution centre load plan"
},
"departmentNumber": {
"value": "DEPT-42",
"description": "Electronics Department"
},
"proNumber": {
"value": "PRO-556789012",
"description": "FedEx progressive number"
},
"agentShipmentNumber": {
"value": "3PL-NATDIST-78901"
}
},
"carrierDetails": {
"routing": [
{
"sequenceType": "origin",
"standardCarrierAlphaCode": "FEDX",
"transportationMethod": "commonCarrier",
"serviceLevel": "ground",
"description": "FedEx Ground Service",
"transitTimeType": "workingDays",
"transitTime": "3"
}
],
"billOfLadingNumber": "BOL-789012",
"equipment": {
"equipmentType": "trailer",
"equipmentId": "FEDX-TRL-44201",
"sealNumber": "SEAL-88321"
},
"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 for health supplements"
}
],
"quantityAndWeight": [
{
"packageForm": "pallet",
"grossWeight": "45.5",
"weightUOM": "pound"
}
],
"volume": {
"value": "18.0",
"unitOfMeasure": "squareFoot"
}
},
"pallets": [
{
"serialShippingId": "003760001234567890",
"physicalDetails": {
"grossWeight": "37.5",
"weightUOM": "pound"
},
"cartons": [
{
"serialShippingId": "003760001234567892",
"physicalDetails": {
"grossWeight": "15.5",
"weightUOM": "pound"
},
"items": [
{
"shippingOrderLineId": "001",
"status": "complete",
"quantityOrdered": {
"value": "24",
"unitOfMeasure": "each"
},
"quantityShipped": {
"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"
},
"warehouseLotNumber": "LOT-2026-01-A1",
"physicalDetails": {
"grossWeight": "15.5",
"netWeight": "15.0",
"weightUOM": "pound"
},
"dates": {
"expirationDate": "2028-01-20",
"manufactureDate": "2025-11-15"
},
"references": {
"lotNumber": "LOT-2026-01-A1",
"pickUpReference": {
"value": "PU-DFW-20260120-001"
},
"vendorContractNumber": {
"value": "VC-GL-2026-Q1"
},
"billOfLadingNumber": {
"value": "BOL-789012"
}
}
}
]
},
{
"serialShippingId": "003760001234567893",
"physicalDetails": {
"grossWeight": "22.0",
"weightUOM": "pound"
},
"items": [
{
"shippingOrderLineId": "002",
"status": "partial",
"quantityOrdered": {
"value": "48",
"unitOfMeasure": "each"
},
"quantityShipped": {
"value": "36",
"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"
},
"warehouseLotNumber": "LOT-2026-01-B3",
"physicalDetails": {
"grossWeight": "22.0",
"netWeight": "18.0",
"weightUOM": "pound"
},
"dates": {
"manufactureDate": "2025-12-01"
},
"references": {
"lotNumber": "LOT-2026-01-B3"
}
}
]
}
]
},
{
"serialShippingId": "003760001234567891",
"physicalDetails": {
"grossWeight": "8.0",
"weightUOM": "pound"
},
"cartons": [
{
"serialShippingId": "003760001234567894",
"physicalDetails": {
"grossWeight": "8.0",
"weightUOM": "pound"
},
"items": [
{
"shippingOrderLineId": "003",
"status": "partial",
"quantityOrdered": {
"value": "100",
"unitOfMeasure": "each"
},
"quantityShipped": {
"value": "0",
"unitOfMeasure": "each"
},
"productIds": {
"buyerItemNumber": "ACM-SKU-11111",
"gtin12": "111111111111",
"drugCode": "12345-6789-01"
},
"productAttributes": {
"description": "Health Supplement - 30 Count Bottle"
},
"warehouseLotNumber": "LOT-2026-01-PHARMA",
"dates": {
"expirationDate": "2027-06-30",
"manufactureDate": "2025-06-30"
},
"references": {
"lotNumber": "LOT-2026-01-PHARMA"
}
}
]
}
]
}
]
}

