Purchase Order Change

Purchase Order Change (860)

A Purchase Order Change (860) is sent by a buyer to modify, cancel, or update an existing purchase order.

Field Type Required Description
purpose
string Intended purpose of the purchase order change transaction (e.g., original, change, cancellation)
Values: original cancellation change replace confirmation completion
purchaseOrderType
string Type of purchase order issued (e.g., standalone, dropship, release)
Values: blanketEstimated blanketFirm dropship release rushOrder standalone
purchaseOrderChangeType
string Type of purchase order change
Values: order productOrService
purchaseOrderNumber
string Unique purchase order number assigned by the buyer
purchaseOrderDate
unknown Date the original purchase order was issued
purchaseOrderChangeDate
unknown Date the purchase order change request was issued. Sourced from BCH11; when BCH11 is absent, defaults to the current date (the date the change is processed).
releaseNumber
string Release number for blanket or contract orders
changeSequenceNumber
string Sequence number for tracking multiple changes to the same order
contractNumber
string Contract number associated with the purchase order
acknowledgmentType
string Type of acknowledgment requested from the supplier
Values: withDetail withExceptionDetail productReplenishment notRequired
conditionsAndRestrictions
array Order-level conditions and restrictions such as backorder policy
conditionType
string Type of order condition or restriction
Values: backorderAllowed substitutionsAllowed doNotSubstitute doNotBackorder shipComplete shipPartialCancelBalance shipASAP standard quickResponse speed
action
string Action to take on the order
Values: confirm holdUntilReleased
services
string Service level requirement
Values: oneDayService twoDayService
maxOrderValue
string Maximum order value limit
parties
object Parties involved in the purchase order change transaction. Includes contact information where available
buyer
object Buying party who is purchasing the product or service. Header PER with contactFunctionCode=BD or IC merges into buyer.contacts (the buyer is the 860 sender, so a generic 'Information Contact' defaults to the buyer). If the partner's guideline notes route IC elsewhere, follow the notes — they override this default.
name
string Party name or company name
additionalName1
string Additional name line 1
additionalName2
string Additional name line 2
identificationCode
string Party identification code value
identificationCodeType
string Type of identification code
Values: sendersId receiversId duns plantCode dunsPlus4 drugEnforcementAdmin telephone federalReserveRouting standardAddressSAN healthIndustryHIN warehouse schoolId memberId stateLicenseId globalLocationId
addressLine1
string Street address line 1
addressLine2
string Street address line 2
addressLine3
string Street address line 3
addressLine4
string Street address line 4
city
string City name
stateOrProvinceCode
string State or province code
postalCode
string Postal or ZIP code
countryCode
string Country code (ISO)
zoneType
string Address zone type
Values: residential commercial
contacts
array Contact persons for this party
type
string Type of contact. Default to 'primary' for party-level (N1_loop) PER segments and context-routed header-level PER segments — the parent party's role provides the context. Use other types only to distinguish multiple contacts within a single party (e.g. 'hazmat' for HM, 'shipping' for SD).
Values: primary customerRelations orderInquiry department shipping receiving hazmat
name
string Contact person name
phoneNumber
string Contact phone number. Default source is the comm-number paired with a TE qualifier (PER03/04, PER05/06, or PER07/08). If the partner guideline note on the comm-number element labels the value as a different comm type (e.g. "Fax #", "Email"), follow the note and route accordingly.
faxNumber
string Contact fax number. Default source is the comm-number paired with an FX qualifier (PER03/04, PER05/06, or PER07/08). If the partner guideline note on a comm-number element labels its value as fax even when the qualifier is TE/EM, follow the note and route the value here.
email
string Contact email address. Default source is the comm-number paired with an EM qualifier (PER03/04, PER05/06, or PER07/08). If the partner guideline note on the comm-number element labels the value as a different comm type, follow the note and route accordingly.
shipTo
object Ship-to location where goods 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
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 location for invoicing
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 Ship-from location where goods originate
name
string Party name or company name
additionalName1
string Additional name line 1
additionalName2
string Additional name line 2
identificationCode
string Party identification code value
identificationCodeType
string Type of identification code
Values: sendersId receiversId duns plantCode dunsPlus4 drugEnforcementAdmin telephone federalReserveRouting standardAddressSAN healthIndustryHIN warehouse schoolId memberId stateLicenseId globalLocationId
addressLine1
string Street address line 1
addressLine2
string Street address line 2
addressLine3
string Street address line 3
addressLine4
string Street address line 4
city
string City name
stateOrProvinceCode
string State or province code
postalCode
string Postal or ZIP code
countryCode
string Country code (ISO)
zoneType
string Address zone type
Values: residential commercial
contacts
array Contact persons for this party
type
string Type of contact. Default to 'primary' for party-level (N1_loop) PER segments and context-routed header-level PER segments — the parent party's role provides the context. Use other types only to distinguish multiple contacts within a single party (e.g. 'hazmat' for HM, 'shipping' for SD).
Values: primary customerRelations orderInquiry department shipping receiving hazmat
name
string Contact person name
phoneNumber
string Contact phone number. Default source is the comm-number paired with a TE qualifier (PER03/04, PER05/06, or PER07/08). If the partner guideline note on the comm-number element labels the value as a different comm type (e.g. "Fax #", "Email"), follow the note and route accordingly.
faxNumber
string Contact fax number. Default source is the comm-number paired with an FX qualifier (PER03/04, PER05/06, or PER07/08). If the partner guideline note on a comm-number element labels its value as fax even when the qualifier is TE/EM, follow the note and route the value here.
email
string Contact email address. Default source is the comm-number paired with an EM qualifier (PER03/04, PER05/06, or PER07/08). If the partner guideline note on the comm-number element labels the value as a different comm type, follow the note and route accordingly.
accountsPayable
object Accounts payable party for invoice processing
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.
soldTo
object Sold-to party, the entity to whom goods are sold
name
string Party name or company name
additionalName1
string Additional name line 1
additionalName2
string Additional name line 2
identificationCode
string Party identification code value
identificationCodeType
string Type of identification code
Values: sendersId receiversId duns plantCode dunsPlus4 drugEnforcementAdmin telephone federalReserveRouting standardAddressSAN healthIndustryHIN warehouse schoolId memberId stateLicenseId globalLocationId
addressLine1
string Street address line 1
addressLine2
string Street address line 2
addressLine3
string Street address line 3
addressLine4
string Street address line 4
city
string City name
stateOrProvinceCode
string State or province code
postalCode
string Postal or ZIP code
countryCode
string Country code (ISO)
zoneType
string Address zone type
Values: residential commercial
contacts
array Contact persons for this party
type
string Type of contact. Default to 'primary' for party-level (N1_loop) PER segments and context-routed header-level PER segments — the parent party's role provides the context. Use other types only to distinguish multiple contacts within a single party (e.g. 'hazmat' for HM, 'shipping' for SD).
Values: primary customerRelations orderInquiry department shipping receiving hazmat
name
string Contact person name
phoneNumber
string Contact phone number. Default source is the comm-number paired with a TE qualifier (PER03/04, PER05/06, or PER07/08). If the partner guideline note on the comm-number element labels the value as a different comm type (e.g. "Fax #", "Email"), follow the note and route accordingly.
faxNumber
string Contact fax number. Default source is the comm-number paired with an FX qualifier (PER03/04, PER05/06, or PER07/08). If the partner guideline note on a comm-number element labels its value as fax even when the qualifier is TE/EM, follow the note and route the value here.
email
string Contact email address. Default source is the comm-number paired with an EM qualifier (PER03/04, PER05/06, or PER07/08). If the partner guideline note on the comm-number element labels the value as a different comm type, follow the note and route accordingly.
supplier
object Supplier or vendor fulfilling the order
name
string Party name or company name
additionalName1
string Additional name line 1
additionalName2
string Additional name line 2
identificationCode
string Party identification code value
identificationCodeType
string Type of identification code
Values: sendersId receiversId duns plantCode dunsPlus4 drugEnforcementAdmin telephone federalReserveRouting standardAddressSAN healthIndustryHIN warehouse schoolId memberId stateLicenseId globalLocationId
addressLine1
string Street address line 1
addressLine2
string Street address line 2
addressLine3
string Street address line 3
addressLine4
string Street address line 4
city
string City name
stateOrProvinceCode
string State or province code
postalCode
string Postal or ZIP code
countryCode
string Country code (ISO)
zoneType
string Address zone type
Values: residential commercial
contacts
array Contact persons for this party
type
string Type of contact. Default to 'primary' for party-level (N1_loop) PER segments and context-routed header-level PER segments — the parent party's role provides the context. Use other types only to distinguish multiple contacts within a single party (e.g. 'hazmat' for HM, 'shipping' for SD).
Values: primary customerRelations orderInquiry department shipping receiving hazmat
name
string Contact person name
phoneNumber
string Contact phone number. Default source is the comm-number paired with a TE qualifier (PER03/04, PER05/06, or PER07/08). If the partner guideline note on the comm-number element labels the value as a different comm type (e.g. "Fax #", "Email"), follow the note and route accordingly.
faxNumber
string Contact fax number. Default source is the comm-number paired with an FX qualifier (PER03/04, PER05/06, or PER07/08). If the partner guideline note on a comm-number element labels its value as fax even when the qualifier is TE/EM, follow the note and route the value here.
email
string Contact email address. Default source is the comm-number paired with an EM qualifier (PER03/04, PER05/06, or PER07/08). If the partner guideline note on the comm-number element labels the value as a different comm type, follow the note and route accordingly.
buyersCurrency
object Currency used by the buyer for the transaction
currencyCode
string ISO currency code (e.g., USD, EUR)
exchangeRate
string Exchange rate for currency conversion
sellersCurrency
object Currency used by the seller for the transaction
currencyCode
string ISO currency code (e.g., USD, EUR)
exchangeRate
string Exchange rate for currency conversion
notes
object Notes and instructions for the order
general
object Generic notes or standard legal agreements. Default for N9+L1 unless the guideline note or a different qualifier points elsewhere — pick the best-fitting field.
description
string Brief description or title of the note
text
array of string Array of text lines for the note content
orderInstructions
object Special instructions for processing the order
description
string Brief description or title of the note
text
array of string Array of text lines for the note content
shippingInstructions
object Special instructions for shipping the order
description
string Brief description or title of the note
text
array of string Array of text lines for the note content
giftMessage
object Message for the recipient, typically used in gift or dropship orders
description
string Brief description or title of the note
text
array of string Array of text lines for the note content
packingSlipMessage
object Message to be printed 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
paperwork
array Paperwork and documentation requirements
reportType
string Type of report or document required
Values: purchasingSpecification storageInquiry technicalInformation billOfLading orderAttachment materialDataSheet materialCertification
reportTransmissionType
string Method by which the report should be transmitted
Values: withShipmentPackage
copiesNeeded
integer Number of copies of the document required
isoLanguageCode
string ISO language code for the document
url
string URL where the document can be accessed
action
string Action to be taken with the paperwork
Values: generate
description
string Description or additional details about the paperwork
packaging
array Packaging and marking requirements for the order
characteristicType
string Type of packaging characteristic
Values: containerShape hazardousMaterial packageSpecifications packing palletType productMarking shippingPackageLabeling typeOfPackage wrappingMaterial
agencyType
string Agency defining the packaging standard
Values: uniformCodeCouncil
descriptionType
string Type of description
description
string Packaging description
unitLoadOption
string Unit load configuration option - how the shipment is physically arranged
Values: palletized floorStack mixed slipSheet module clampable bopSheet airbagSlipSheetCombo cargoQuilt shrinkWrap loadLock
termsOfSale
object Payment terms and conditions for the order
type
string Type of payment terms
Values: basic basicDiscountOffered discountNotApplicable endOfMonth endOfMonth10 extended instant fixedDate proximo mutuallyDefined
basisDate
string Date basis for calculating payment terms
Values: invoiceDate receiptOfGoods deliveryDate shipDate mutuallyDefined gageApprovalDate specifiedDate acceptanceDate invoiceTransmissionDate effectiveDate
discountPercent
string Discount percentage if paid early
discountDaysDue
integer Number of days to qualify for discount
discountDueDate
unknown Date by which payment must be made for discount
dayOfMonth
integer Day of month for payment
netDaysDue
integer Number of days until payment is due
netDueDate
unknown Date when payment is due
discountAmount
string Fixed discount amount
description
string Description of payment terms
paymentMethodType
string Method of payment
Values: check letterOfCredit wireTransfer corporateTradePayment specialAccount directPayOthers
references
object Reference numbers associated with the order
accountNumber
object Account number or credit reference for the order
value
string The reference identifier value
description
string Additional description or context for the reference
arrivalCode
object Code indicating arrival information or instructions
value
string The reference identifier value
description
string Additional description or context for the reference
associatedPurchaseOrderNumber
object Related or parent purchase order number
value
string The reference identifier value
description
string Additional description or context for the reference
reservationNumber
object Reservation number
value
string The reference identifier value
description
string Additional description or context for the reference
customerOrderNumber
object Customer-assigned order number for tracking
value
string The reference identifier value
description
string Additional description or context for the reference
deliveryReference
object Reference number for delivery coordination
value
string The reference identifier value
description
string Additional description or context for the reference
divisionId
object Identifier for the business division placing the order
value
string The reference identifier value
description
string Additional description or context for the reference
departmentNumber
object Department number within the buying organization
value
string The reference identifier value
description
string Additional description or context for the reference
internalCustomerNumber
object Internal customer identifier used by the buyer
value
string The reference identifier value
description
string Additional description or context for the reference
vendorNumber
object Vendor or supplier identifier assigned by the buyer
value
string The reference identifier value
description
string Additional description or context for the reference
merchandiseTypeCode
object Code classifying the type of merchandise
value
string The reference identifier value
description
string Additional description or context for the reference
promotionNumber
object Promotional campaign or deal identifier
value
string The reference identifier value
description
string Additional description or context for the reference
storeNumber
object Retail store location identifier
value
string The reference identifier value
description
string Additional description or context for the reference
thirdPartyReferenceNumber
object Reference number from a third-party system
value
string The reference identifier value
description
string Additional description or context for the reference
warehouseStorageLocation
object Warehouse or storage location identifier
value
string The reference identifier value
description
string Additional description or context for the reference
dates
object Important dates for the order such as purchase order date, ship date, and requested delivery date
cancelAfterDate
unknown Date after which the order should be cancelled if not fulfilled
customerOrderDate
unknown Date when the customer originally placed the order
earliestDeliveryDate
unknown Earliest acceptable date for delivery
earliestShipDate
unknown Earliest acceptable date for shipment
latestShipDate
unknown Latest acceptable date for shipment
latestDeliveryDate
unknown Latest acceptable date for delivery
pickupDate
unknown Scheduled date for pickup
promotionStartDate
unknown Start date of the promotional period
purchaseOrderDate
unknown Date of the original purchase order, used on release orders
requestedDeliveryDate
unknown Requested date for delivery
requestedDeliveryWeekOfDate
unknown Week during which delivery is requested
requestedShipDate
unknown Requested date for shipment
carrierDetails
object Carrier and shipping details for the order
routing
array Carrier routing and transportation method details
sequenceType
string Sequence in the routing chain
Values: origin 1stAfterOrigin 4thAfterOrigin haulage
standardCarrierAlphaCode
string SCAC code identifying the carrier
customCarrierCode
string Custom carrier identifier
transportationMethod
string Method of transportation. EDIFACT: prefer C001.8179 (transportMeansDescriptionCode) — its means/vessel-level codes match this enum directly. Fall back to C220.8067 (transportModeNameCode) ONLY when 8179 is absent; 8067 carries broad-mode codes only (1=Maritime, 2=Rail, 3=Road, 4=Air, 5=Mail, 6=Multimodal, 7=Fixed installation, 8=Inland water) which map loosely: 1→ocean, 2→rail, 3→supplierTruck, 4→air. Granular enum values (airExpress, oceanContainerized, trailer, etc.) cannot be recovered from 8067 — emit a SCHEMA GAP if neither path carries the partner value.
Values: air airExpress airFreightForward backhaul bestWay commonCarrier consolidation customerPickup expeditedTruck lessThanTrailerLoad mail ocean oceanContainerized parcelPost privateCarrier rail shipperAgent supplierTruck trailer mutuallyDefined
locationType
string Type of routing location
Values: inStore receiversLocation allPoints portOfArrival portOfEmbarkation origin mutuallyDefined
location
string Routing location identifier or name
description
string Description of routing details
serviceLevel
string Service level for shipping
Values: deliveryConfirmation doorService economy eveningService expedited firstClass ground groundHundredWeight international metro morning nextDayAir nextDayHundredWeight nextDayEvening nextDayMorning1030 nextDayMorning930 nextDaySaturday overnight poBoxZipCode priorityMail priorityMailInsured proofOfDelivery sameDay saturdayService secondDay secondDayHundredWeight secondDayAir secondDaySaturday standard standardGround threeDay
orderStatus
string Order shipping status
Values: shipCompleteOnDate complete partialShipment shipPartialBackorderToShipOnDate partialShipOnDate shipped backordered mutuallyDefined availableScheduledToShip availableNoShipSchedule multiPickup availableToShipUnBilledQuantity stopOff
transitDirectionType
string Direction of transit
Values: buyerToSeller sellerToBuyer subcontractorToSeller sellerToDropShipLocation sellToForwarder sellerToSubcontractor mutuallyDefined
transitTimeType
string Unit for transit time
Values: calendarDays hours workingDays
transitTime
string Expected transit time value
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
quantityAndWeight
array Shipment weight, volume, and unit-of-measure details
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)
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
allowances
array Allowances or discounts applied to the order
type
string Type of allowance or charge
Values: advertising defectiveAllowance discount freight handling newStore other promotionalAllowance quantityDiscount rebate restocking serviceAtPickupOrDelivery shipping shippingAndHandling swell unsaleableMerchandiseAllowance volume warehouse
amount
string Fixed amount of allowance or charge
percent
string Percentage of allowance or charge
percentBasis
string Basis for calculating percentage
Values: basePrice
methodOfHandling
string How the charge is handled
Values: collect paidByVendor paidByCustomer prepaid
description
string Description of the allowance or charge
charges
array Additional charges applied to the order
type
string Type of allowance or charge
Values: advertising defectiveAllowance discount freight handling newStore other promotionalAllowance quantityDiscount rebate restocking serviceAtPickupOrDelivery shipping shippingAndHandling swell unsaleableMerchandiseAllowance volume warehouse
amount
string Fixed amount of allowance or charge
percent
string Percentage of allowance or charge
percentBasis
string Basis for calculating percentage
Values: basePrice
methodOfHandling
string How the charge is handled
Values: collect paidByVendor paidByCustomer prepaid
description
string Description of the allowance or charge
monetaryAmounts
object Monetary amounts for the order
net
string Net monetary amount for the order
gross
string Gross monetary amount for the order
taxes
object Tax information for the order
generalTaxInformation
object General tax information when no specific tax type applies
amount
string Tax amount
percent
string Tax percentage rate
taxIdNumber
string Tax identification number
locationId
string Tax location identifier
exemptionCode
string Tax exemption status
Values: exempt notExempt notTaxable
jurisdictionType
string Type of tax jurisdiction
jurisdictionCode
string Tax jurisdiction code
assignedId
string Assigned tax identifier — partner-internal accounting reference for this tax line
lineItems
array Line items included in the purchase order change
purchaseOrderLineId
string Unique identifier for the line item within the purchase order
changeReason
string Reason for the line item change
Values: addItem deleteItem changeToItem
originalQuantity
object Original quantity before the change
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
changeInQuantity
object Amount of change in quantity. Negative if decreasing, positive if increasing
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
quantity
object Updated quantity after the change
value
string Numeric quantity value
unitOfMeasure
string Unit of measure for the quantity
Values: assembly assortment bag bale ball bar barrel belt bin block boardFeet bolt book bottle box bulk bundle bushel cake can card carton cartridge case cassette celsius cell centigram centiliter centimeter coil combo cone container count cover display dozen drum each flakeTon foot gallon gram gramsPerLiter inch kilogram kit knots linearFoot liter meter milliliter monetaryValue ocularInsertSystem order ounce packPAK package pad pail pair pairInches palletLift palletUnitLoad person piece pint pound poundEquivalent poundGross quart reel roll section set sheet sixPack squareFoot syringe thousand threePack tote tube unit vial
unitCostPrice
string Unit price or cost for the item
unitPriceBasis
string Basis on which the unit price is calculated
Values: advise beforeDiscount discount net noCharge perHundred perThousand perDozen perEach perFoot perGram perKilogram perTen perOunce perPound perTenThousand perUOM promotion standard suggestedRetail wholesale wholesalePerEach
additionalPricing
array Additional pricing information such as list price or promotional pricing
priceType
string Type of price
Values: discountAllowed highValuePrice listCost retail promotional purchase
unitPrice
string Unit price value
unitPriceBasis
string Basis for the unit price
Values: advise beforeDiscount discount net noCharge perHundred perThousand perDozen perEach perFoot perGram perKilogram perTen perOunce perPound perTenThousand perUOM promotion standard suggestedRetail wholesale wholesalePerEach
quantityPerUnitPrice
string Quantity per unit price
discountMultiplier
string Discount multiplier factor applied to the unit price to derive the net cost (e.g., 0.57 means a 43% discount). The actual discount percent is 1 minus this value.
productIds
object Product identification codes such as UPC, SKU, or vendor item number
buyerItemNumber
string Buyer-assigned item number
vendorItemNumber
string Vendor-assigned item number (EDIFACT LIN/PIA supplier's item number)
gtin12
string GTIN-12 (UPC-A) barcode
gtin13
string GTIN-13 (EAN) barcode
gtin14
string GTIN-14 (ITF-14) case code barcode
caseCode
string Case code identifier
drugCode
string National Drug Code (NDC)
standardBookNumber
string ISBN or standard book number
buyerItemIds
array Additional buyer product identifiers
type
string Type of product identifier
Values: catalog manufacturerPart sku style
value
string Product identifier value
vendorItemIds
array Additional vendor product identifiers
type
string Type of product identifier
Values: catalog manufacturerPart sku style
value
string Product identifier value
productAttributes
object Product attributes such as color, size, and description
description
string General product description. Sourced from X12 PID05 when PID02="08" (Product Description, general) or when PID02 is absent. In EDIFACT, sourced from EVERY IMD composite for this line item where itemDescriptionCode="SP" (Product) — there may be MULTIPLE matching IMD repetitions per line item, and ALL of them must be included. Within each matching IMD, concatenate itemDescription + itemDescription_1 (the continuation field) with a single space; then $join those per-IMD strings across ALL matching IMDs with a single space separator. Do NOT pick only the first matching IMD — partners commonly split a long description across multiple IMD segments because each itemDescription element is capped at 35 characters. The qualifier code "SP" (or X12 "08") is positional — it identifies which IMDs carry the product description, and must NOT be reported as a schema gap.
shortDescription
string {"description":"Short product description"}
brand
string Brand or label name for the product
colorCode
string Color code identifier
colorDescription
string Color description text
sizeCode
string Size code identifier
sizeDescription
string Size description text
materialCode
string Material code identifier
materialDescription
string Material description text
materialAttributes
object
type
string Material type or classification
grade
string Material grade or quality tier (e.g., prime, excessPrime, waste)
annealMethod
string Annealing method applied to the material
temper
string Heat treatment or mechanical processing state of the material
finish
string Surface finish or texture applied to the material
outerCoating
string Outer surface coating or plating
innerCoating
string Inner surface coating or plating
surfaceProtection
string Surface protection method or specification
treatment
string Chemical or mechanical treatment applied to the material
weld
string Welding specification or classification for the material
processCode
string Process code identifier
processDescription
string Process description text
height
string Product height dimension
length
string Product length dimension
width
string Product width dimension
dimensionUOM
string Unit of measure for product dimensions
Values: standardCubicFoot boardFeet hundredBoardFeet cubicDecimeter cubicCentimeter cubicFeet cubicInches centimeter cubicMeter cubicYard decimeter foot hundredFeet hundredFeetLinear hundredSquareFeet hundredYards inch linearFoot linearMeter linearYard millimeter meter squareFoot squareInches squareMeter squareYard thousandSquareInches thousandFeetLinear thousandFeetBoard tenSquareFeet thousandSquareFeet yard
outerPack
object Physical details for the outer packaging (case/carton level)
numberOfUnits
string Number of units in the package
size
string Size value of the package
sizeUOM
string Unit of measure for size
Values: bag box carton case cassette each fluidOunce gram kilogram liter milliliter ounce packPAK package pair pound roll tote unit
packageForm
string Form of the package
Values: bag bottle box can carton coil container pallet shrinkWrap unit
packageMaterial
string Material of the package
Values: corrugated plastic plasticVacuumed standard wood
weightUOM
string Unit of measure for weight
Values: pound kilogram
grossWeight
string Gross weight including packaging
netWeight
string Net weight of contents only
volumeUOM
string Unit of measure for volume
Values: standardCubicFoot centiliter cubicDecimeter cubicCentimeter cubicFeet cubicInches cubicMeter cubicYard deciliter fluidOunce gallon halfGallon kiloliter kilogramsPerCubicMeter liter milliliter netGallons pint halfPint quart
volume
string Volume value
length
string Length dimension
width
string Width dimension
height
string Height dimension
dimensionUOM
string Unit of measure for dimensions
Values: standardCubicFoot boardFeet hundredBoardFeet cubicDecimeter cubicCentimeter cubicFeet cubicInches centimeter cubicMeter cubicYard decimeter foot hundredFeet hundredFeetLinear hundredSquareFeet hundredYards inch linearFoot linearMeter linearYard millimeter meter squareFoot squareInches squareMeter squareYard thousandSquareInches thousandFeetLinear thousandFeetBoard tenSquareFeet thousandSquareFeet yard
packageId
string Package identifier
basebox
string Billable quantity in baseboxes (tin plate industry unit: 112 sheets × 14"×20" = 31,360 sq in)
baseboxBasisWeight
string Basis weight in pounds per base box — the standard steel mill weight specification unit
innerPack
object Physical details for the inner packaging
numberOfUnits
string Number of units in the package
size
string Size value of the package
sizeUOM
string Unit of measure for size
Values: bag box carton case cassette each fluidOunce gram kilogram liter milliliter ounce packPAK package pair pound roll tote unit
packageForm
string Form of the package
Values: bag bottle box can carton coil container pallet shrinkWrap unit
packageMaterial
string Material of the package
Values: corrugated plastic plasticVacuumed standard wood
weightUOM
string Unit of measure for weight
Values: pound kilogram
grossWeight
string Gross weight including packaging
netWeight
string Net weight of contents only
volumeUOM
string Unit of measure for volume
Values: standardCubicFoot centiliter cubicDecimeter cubicCentimeter cubicFeet cubicInches cubicMeter cubicYard deciliter fluidOunce gallon halfGallon kiloliter kilogramsPerCubicMeter liter milliliter netGallons pint halfPint quart
volume
string Volume value
length
string Length dimension
width
string Width dimension
height
string Height dimension
dimensionUOM
string Unit of measure for dimensions
Values: standardCubicFoot boardFeet hundredBoardFeet cubicDecimeter cubicCentimeter cubicFeet cubicInches centimeter cubicMeter cubicYard decimeter foot hundredFeet hundredFeetLinear hundredSquareFeet hundredYards inch linearFoot linearMeter linearYard millimeter meter squareFoot squareInches squareMeter squareYard thousandSquareInches thousandFeetLinear thousandFeetBoard tenSquareFeet thousandSquareFeet yard
packageId
string Package identifier
basebox
string Billable quantity in baseboxes (tin plate industry unit: 112 sheets × 14"×20" = 31,360 sq in)
baseboxBasisWeight
string Basis weight in pounds per base box — the standard steel mill weight specification unit
packaging
array Packaging and marking requirements
characteristicType
string Type of packaging characteristic
Values: containerShape hazardousMaterial packageSpecifications packing palletType productMarking shippingPackageLabeling typeOfPackage wrappingMaterial
agencyType
string Agency defining the packaging standard
Values: uniformCodeCouncil
descriptionType
string Type of description
description
string Packaging description
unitLoadOption
string Unit load configuration option - how the shipment is physically arranged
Values: palletized floorStack mixed slipSheet module clampable bopSheet airbagSlipSheetCombo cargoQuilt shrinkWrap loadLock
dates
object Date requirements specific to this line item
cancelAfterDate
unknown Date after which the order should be cancelled if not fulfilled
customerOrderDate
unknown Date when the customer originally placed the order
earliestDeliveryDate
unknown Earliest acceptable date for delivery
earliestShipDate
unknown Earliest acceptable date for shipment
latestShipDate
unknown Latest acceptable date for shipment
latestDeliveryDate
unknown Latest acceptable date for delivery
pickupDate
unknown Scheduled date for pickup
promotionStartDate
unknown Start date of the promotional period
purchaseOrderDate
unknown Date of the original purchase order, used on release orders
requestedDeliveryDate
unknown Requested date for delivery
requestedDeliveryWeekOfDate
unknown Week during which delivery is requested
requestedShipDate
unknown Requested date for shipment
references
object Reference numbers specific to this line item
reservationNumber
object Reservation number for this line item
value
string The reference identifier value
description
string Additional description or context for the reference
divisionId
object Business division identifier for this line item
value
string The reference identifier value
description
string Additional description or context for the reference
departmentNumber
object Department number for this line item
value
string The reference identifier value
description
string Additional description or context for the reference
merchandiseTypeCode
object Merchandise classification code for this line item
value
string The reference identifier value
description
string Additional description or context for the reference
promotionNumber
object Promotional campaign identifier for this line item
value
string The reference identifier value
description
string Additional description or context for the reference
storeNumber
object Store location identifier for this line item
value
string The reference identifier value
description
string Additional description or context for the reference
destinationQuantities
object Quantity distribution across multiple destinations
locationType
string Type of location identifier
Values: sendersId receiversId duns dunsPlus4 standardAddressSAN warehouse globalLocationId
unitOfMeasure
string Unit of measure for quantities
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
quantityByLocation
array Quantity breakdown by destination
destinationId
string Destination location identifier
quantity
string Quantity for this destination
allowances
array Allowances or discounts applied to this line item
type
string Type of allowance or charge
Values: advertising defectiveAllowance discount freight handling newStore other promotionalAllowance quantityDiscount rebate restocking serviceAtPickupOrDelivery shipping shippingAndHandling swell unsaleableMerchandiseAllowance volume warehouse
amount
string Fixed amount of allowance or charge
percent
string Percentage of allowance or charge
percentBasis
string Basis for calculating percentage
Values: basePrice
methodOfHandling
string How the charge is handled
Values: collect paidByVendor paidByCustomer prepaid
description
string Description of the allowance or charge
charges
array Additional charges applied to this line item
type
string Type of allowance or charge
Values: advertising defectiveAllowance discount freight handling newStore other promotionalAllowance quantityDiscount rebate restocking serviceAtPickupOrDelivery shipping shippingAndHandling swell unsaleableMerchandiseAllowance volume warehouse
amount
string Fixed amount of allowance or charge
percent
string Percentage of allowance or charge
percentBasis
string Basis for calculating percentage
Values: basePrice
methodOfHandling
string How the charge is handled
Values: collect paidByVendor paidByCustomer prepaid
description
string Description of the allowance or charge
monetaryAmounts
object Monetary amounts for the line item
gross
string Gross monetary amount for the line item
net
string Net monetary amount for the line item
sublineItems
array Subline items for component or kit details
sublineId
string Subline item identifier
quantity
object Quantity for the subline item
value
string Numeric quantity value
unitOfMeasure
string Unit of measure for the quantity
Values: assembly assortment bag bale ball bar barrel belt bin block boardFeet bolt book bottle box bulk bundle bushel cake can card carton cartridge case cassette celsius cell centigram centiliter centimeter coil combo cone container count cover display dozen drum each flakeTon foot gallon gram gramsPerLiter inch kilogram kit knots linearFoot liter meter milliliter monetaryValue ocularInsertSystem order ounce packPAK package pad pail pair pairInches palletLift palletUnitLoad person piece pint pound poundEquivalent poundGross quart reel roll section set sheet sixPack squareFoot syringe thousand threePack tote tube unit vial
unitCostPrice
string Unit cost price for the subline item
unitPriceBasis
string Basis for the unit price
Values: advise beforeDiscount discount net noCharge perHundred perThousand perDozen perEach perFoot perGram perKilogram perTen perOunce perPound perTenThousand perUOM promotion standard suggestedRetail wholesale wholesalePerEach
productIds
object Product identifiers for the subline item
buyerItemNumber
string Buyer-assigned item number
vendorItemNumber
string Vendor-assigned item number (EDIFACT LIN/PIA supplier's item number)
gtin12
string GTIN-12 (UPC-A) barcode
gtin13
string GTIN-13 (EAN) barcode
gtin14
string GTIN-14 (ITF-14) case code barcode
caseCode
string Case code identifier
drugCode
string National Drug Code (NDC)
standardBookNumber
string ISBN or standard book number
buyerItemIds
array Additional buyer product identifiers
type
string Type of product identifier
Values: catalog manufacturerPart sku style
value
string Product identifier value
vendorItemIds
array Additional vendor product identifiers
type
string Type of product identifier
Values: catalog manufacturerPart sku style
value
string Product identifier value
productAttributes
object Product attributes for the subline item
description
string General product description. Sourced from X12 PID05 when PID02="08" (Product Description, general) or when PID02 is absent. In EDIFACT, sourced from EVERY IMD composite for this line item where itemDescriptionCode="SP" (Product) — there may be MULTIPLE matching IMD repetitions per line item, and ALL of them must be included. Within each matching IMD, concatenate itemDescription + itemDescription_1 (the continuation field) with a single space; then $join those per-IMD strings across ALL matching IMDs with a single space separator. Do NOT pick only the first matching IMD — partners commonly split a long description across multiple IMD segments because each itemDescription element is capped at 35 characters. The qualifier code "SP" (or X12 "08") is positional — it identifies which IMDs carry the product description, and must NOT be reported as a schema gap.
shortDescription
string {"description":"Short product description"}
brand
string Brand or label name for the product
colorCode
string Color code identifier
colorDescription
string Color description text
sizeCode
string Size code identifier
sizeDescription
string Size description text
materialCode
string Material code identifier
materialDescription
string Material description text
materialAttributes
object
type
string Material type or classification
grade
string Material grade or quality tier (e.g., prime, excessPrime, waste)
annealMethod
string Annealing method applied to the material
temper
string Heat treatment or mechanical processing state of the material
finish
string Surface finish or texture applied to the material
outerCoating
string Outer surface coating or plating
innerCoating
string Inner surface coating or plating
surfaceProtection
string Surface protection method or specification
treatment
string Chemical or mechanical treatment applied to the material
weld
string Welding specification or classification for the material
processCode
string Process code identifier
processDescription
string Process description text
height
string Product height dimension
length
string Product length dimension
width
string Product width dimension
dimensionUOM
string Unit of measure for product dimensions
Values: standardCubicFoot boardFeet hundredBoardFeet cubicDecimeter cubicCentimeter cubicFeet cubicInches centimeter cubicMeter cubicYard decimeter foot hundredFeet hundredFeetLinear hundredSquareFeet hundredYards inch linearFoot linearMeter linearYard millimeter meter squareFoot squareInches squareMeter squareYard thousandSquareInches thousandFeetLinear thousandFeetBoard tenSquareFeet thousandSquareFeet yard
lotNumber
string Lot or batch number for the subline item
notes
object Notes and instructions for this line item
general
object Generic notes or standard legal agreements. Default for N9+L1 unless the guideline note or a different qualifier points elsewhere — pick the best-fitting field.
description
string Brief description or title of the note
text
array of string Array of text lines for the note content
orderInstructions
object Special instructions for processing the order
description
string Brief description or title of the note
text
array of string Array of text lines for the note content
shippingInstructions
object Special instructions for shipping the order
description
string Brief description or title of the note
text
array of string Array of text lines for the note content
giftMessage
object Message for the recipient, typically used in gift or dropship orders
description
string Brief description or title of the note
text
array of string Array of text lines for the note content
packingSlipMessage
object Message to be printed 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
paperwork
array Paperwork requirements for this line item
reportType
string Type of report or document required
Values: purchasingSpecification storageInquiry technicalInformation billOfLading orderAttachment materialDataSheet materialCertification
reportTransmissionType
string Method by which the report should be transmitted
Values: withShipmentPackage
copiesNeeded
integer Number of copies of the document required
isoLanguageCode
string ISO language code for the document
url
string URL where the document can be accessed
action
string Action to be taken with the paperwork
Values: generate
description
string Description or additional details about the paperwork
conditionsAndRestrictions
array Conditions and restrictions for this line item
conditionType
string Type of order condition or restriction
Values: backorderAllowed substitutionsAllowed doNotSubstitute doNotBackorder shipComplete shipPartialCancelBalance shipASAP standard quickResponse speed
action
string Action to take on the order
Values: confirm holdUntilReleased
services
string Service level requirement
Values: oneDayService twoDayService
maxOrderValue
string Maximum order value limit
carrierDetails
object Carrier and shipping details for this line item
routing
array Carrier routing information for this line item
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
freeOnBoard
array FOB (Free on Board) terms for this line item
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
{
  "purpose": "change",
  "purchaseOrderType": "standalone",
  "purchaseOrderChangeType": "order",
  "purchaseOrderNumber": "PO-2024-001234",
  "purchaseOrderDate": "2024-01-10",
  "purchaseOrderChangeDate": "2024-01-15",
  "changeSequenceNumber": "001",
  "acknowledgmentType": "withDetail",
  "parties": {
    "buyer": {
      "name": "Retail Corp",
      "identificationCode": "RETAILCORP",
      "identificationCodeType": "receiversId",
      "addressLine1": "100 Commerce Street",
      "city": "New York",
      "stateOrProvinceCode": "NY",
      "postalCode": "10001",
      "countryCode": "US",
      "contacts": [
        {
          "type": "primary",
          "name": "Jane Doe",
          "email": "[email protected]",
          "phoneNumber": "555-987-6543"
        }
      ]
    },
    "shipTo": {
      "name": "Retail Corp - Distribution Center",
      "identificationCode": "DC-EAST-01",
      "identificationCodeType": "warehouse",
      "addressLine1": "500 Warehouse Blvd",
      "city": "Newark",
      "stateOrProvinceCode": "NJ",
      "postalCode": "07101",
      "countryCode": "US"
    },
    "supplier": {
      "name": "Acme Products LLC",
      "identificationCode": "ACMEPRODUCTS",
      "identificationCodeType": "sendersId"
    }
  },
  "buyersCurrency": {
    "currencyCode": "USD"
  },
  "notes": {
    "general": {
      "description": "Order modification",
      "text": ["Increasing quantity on line 1, cancelling line 3"]
    },
    "shippingInstructions": {
      "text": ["Please expedite shipment due to increased demand"]
    }
  },
  "termsOfSale": {
    "type": "basic",
    "basisDate": "invoiceDate",
    "discountPercent": "2",
    "discountDaysDue": 10,
    "netDaysDue": 30
  },
  "references": {
    "departmentNumber": {
      "value": "DEPT-200"
    },
    "vendorNumber": {
      "value": "VN-12345"
    }
  },
  "dates": {
    "requestedDeliveryDate": "2024-02-01",
    "cancelAfterDate": "2024-02-15"
  },
  "carrierDetails": {
    "routing": [
      {
        "transportationMethod": "lessThanTrailerLoad",
        "standardCarrierAlphaCode": "UPSN",
        "serviceLevel": "ground"
      }
    ],
    "freeOnBoard": [
      {
        "methodOfPayment": "prepaidBySeller",
        "locationType": "destination"
      }
    ]
  },
  "lineItems": [
    {
      "purchaseOrderLineId": "001",
      "changeReason": "changeToItem",
      "originalQuantity": {
        "value": "100",
        "unitOfMeasure": "each"
      },
      "changeInQuantity": {
        "value": "50",
        "unitOfMeasure": "each"
      },
      "quantity": {
        "value": "150",
        "unitOfMeasure": "each"
      },
      "unitCostPrice": "25.00",
      "unitPriceBasis": "perEach",
      "productIds": {
        "buyerItemNumber": "SKU-WIDGET-001",
        "vendorItemNumber": "ACME-W100",
        "gtin12": "012345678901"
      },
      "productAttributes": {
        "description": "Premium Widget - Standard",
        "colorDescription": "Black"
      },
      "dates": {
        "requestedShipDate": "2024-01-25"
      }
    },
    {
      "purchaseOrderLineId": "002",
      "changeReason": "addItem",
      "quantity": {
        "value": "75",
        "unitOfMeasure": "each"
      },
      "unitCostPrice": "18.50",
      "unitPriceBasis": "perEach",
      "productIds": {
        "buyerItemNumber": "SKU-GADGET-002",
        "vendorItemNumber": "ACME-G200",
        "gtin12": "012345678902"
      },
      "productAttributes": {
        "description": "Deluxe Gadget - New Item"
      },
      "notes": {
        "general": {
          "text": ["New item added to order"]
        }
      }
    },
    {
      "purchaseOrderLineId": "003",
      "changeReason": "deleteItem",
      "originalQuantity": {
        "value": "50",
        "unitOfMeasure": "each"
      },
      "quantity": {
        "value": "0",
        "unitOfMeasure": "each"
      },
      "productIds": {
        "buyerItemNumber": "SKU-TOOL-003",
        "vendorItemNumber": "ACME-T300"
      },
      "productAttributes": {
        "description": "Basic Tool - Cancelled"
      }
    }
  ]
}
File Description Download
sample.json Sample JSON payload Download
schema.json JSON Schema for validation Download