Purchase Order

Purchase Order (850)

A Purchase Order is sent by a buyer to a supplier to request goods or services.

Field Type Required Description
purpose
string Intended purpose of the purchase order transaction (BEG01)
Values: original cancellation change replace confirmation
purchaseOrderType
string Type of purchase order issued (BEG02)
Values: blanketEstimated blanketFirm confirmation consignment containerFloor floorSample dropship preCommitment release rushOrder shippedOrder standalone
purchaseOrderNumber
string Unique purchase order number assigned by the buyer
purchaseOrderDate
unknown Date the purchase order was issued
contractNumber
string Contract number associated with the purchase order
releaseNumber
string Release number for blanket or contract orders
acknowledgmentType
string BEG07 When used to request a response to the 860
Values: withDetail withExceptionDetail productReplenishment notRequired
conditionsAndRestrictions
array Order-level conditions and restrictions such as backorder policy
conditionType
string
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 Buying party who is purchasing the product or service. Header PER with contactFunctionCode=BD or IC merges into buyer.contacts (the buyer is the 850 sender, so a generic
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 850 sender, so a generic
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 N103: Codes 91 and 92 are specific to the direction of the transaction. Retail Example: For the 850 92 maps to sender and 91 maps to receiver. For the 856, 810 - sender maps to 91 and receiver maps to 92
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
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.
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 N103: Codes 91 and 92 are specific to the direction of the transaction. Retail Example: For the 850 92 maps to sender and 91 maps to receiver. For the 856, 810 - sender maps to 91 and receiver maps to 92
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
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.
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 N103: Codes 91 and 92 are specific to the direction of the transaction. Retail Example: For the 850 92 maps to sender and 91 maps to receiver. For the 856, 810 - sender maps to 91 and receiver maps to 92
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
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.
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 N103: Codes 91 and 92 are specific to the direction of the transaction. Retail Example: For the 850 92 maps to sender and 91 maps to receiver. For the 856, 810 - sender maps to 91 and receiver maps to 92
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
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.
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 N103: Codes 91 and 92 are specific to the direction of the transaction. Retail Example: For the 850 92 maps to sender and 91 maps to receiver. For the 856, 810 - sender maps to 91 and receiver maps to 92
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
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.
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 N103: Codes 91 and 92 are specific to the direction of the transaction. Retail Example: For the 850 92 maps to sender and 91 maps to receiver. For the 856, 810 - sender maps to 91 and receiver maps to 92
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
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.
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 N103: Codes 91 and 92 are specific to the direction of the transaction. Retail Example: For the 850 92 maps to sender and 91 maps to receiver. For the 856, 810 - sender maps to 91 and receiver maps to 92
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
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.
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. Default for CTB02 when CTB01=OR. MSG/MTX free-form text (segments named messageText/text in the input JSON) may also route here when the guideline note indicates order instructions — 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
shippingInstructions
object Special instructions for shipping the order. Default for CTB02 when CTB01=SR. MSG/MTX free-form text (segments named messageText/text in the input JSON) may also route here when the guideline note indicates shipping instructions — 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
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 PWK01
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
Values: containerShape hazardousMaterial packageSpecifications packing palletType productMarking shippingPackageLabeling typeOfPackage wrappingMaterial
agencyType
string
Values: uniformCodeCouncil
descriptionType
string Type of description
description
string Packaging description
unitLoadOption
string
Values: palletized floorStack mixed slipSheet module clampable bopSheet airbagSlipSheetCombo cargoQuilt shrinkWrap loadLock
termsOfSale
object Payment terms and conditions for the order
type
string
Values: basic basicDiscountOffered discountNotApplicable endOfMonth endOfMonth10 extended instant fixedDate proximo mutuallyDefined
basisDate
string
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
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
freightPayerReference
object Freight payer reference number
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
pricingQuote
object Pricing quote reference number
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. Covers both 063 (
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
requestedShipDate
unknown Requested date for shipment
requestedDeliveryWeekOfDate
unknown Week during which delivery is requested
carrierDetails
object Quantity and weight details for the shipment
quantityAndWeight
array Quantity and weight details for the shipment
packageForm
string
Values: bag carton case coil pallet
packageMaterial
string
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
Values: cubicFeet cubicInches cubicMeter cubicYard gallon liter
dimensionUOM
string
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
ladingQuantity
string Number of units (pallets, cartons, etc.) in the shipment
routing
array Carrier routing and transportation method details
sequenceType
string
Values: origin 1stAfterOrigin 4thAfterOrigin haulage
standardCarrierAlphaCode
string SCAC code identifying the carrier
customCarrierCode
string Custom carrier identifier
transportationMethod
string
Values: air airExpress airFreightForward backhaul bestWay commonCarrier consolidation customerPickup expeditedTruck lessThanTrailerLoad mail ocean oceanContainerized parcelPost privateCarrier rail shipperAgent supplierTruck trailer mutuallyDefined
locationType
string
Values: inStore receiversLocation allPoints portOfArrival portOfEmbarkation origin mutuallyDefined
location
string Routing location identifier or name
description
string Description of routing details
serviceLevel
string
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
Values: shipCompleteOnDate complete partialShipment shipPartialBackorderToShipOnDate partialShipOnDate shipped backordered mutuallyDefined availableScheduledToShip availableNoShipSchedule multiPickup availableToShipUnBilledQuantity stopOff
transitDirectionType
string
Values: buyerToSeller sellerToBuyer subcontractorToSeller sellerToDropShipLocation sellToForwarder sellerToSubcontractor mutuallyDefined
transitTimeType
string These may be sent on the PO but for Outbound we can calculate based on shipDate and deliveryDate
Values: calendarDays hours workingDays
transitTime
string Expected transit time value
freeOnBoard
array FOB (Free on Board) terms and conditions
methodOfPayment
string
Values: airCollect airPrepaid paidByBuyer collect mutuallyAgreed portOfCall halfPrepaid mixed serviceFreightNoCharge advancePrepaid customerPickupBackhaul prepaidChargeCustomer prepaidBySeller paidBySeller pickup thirdPartyPay
locationType
string
Values: cityAndState country destination origin stateProvince warehouse
locationDescription
string Description of FOB location
titlePassageType
string
Values: cityAndState country destination origin stateProvince warehouse
titlePassageDescription
string Description of title passage location
transportationTermsSource
string
Values: incoTerms tradeTerms mutuallyDefined
transportationTerms
string
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
Values: toDestinationBuyer toFreightEqPointSeller toPoolPointSeller toDestinationSeller mutuallyDefined
description
string Additional FOB description
specialHandling
array Special handling requirements for the shipment
handlingType
string
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
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
Values: collect paidByVendor paidByCustomer prepaid
description
string Description of the allowance or charge
charges
array Additional charges applied to the order
type
string
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
Values: collect paidByVendor paidByCustomer prepaid
description
string Description of the allowance or charge
monetaryAmounts
object Net monetary amount 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
countyTax
object County-level tax information
amount
string Tax amount
percent
string Tax percentage rate
taxIdNumber
string Tax identification number
locationId
string Tax location identifier
exemptionCode
string
Values: exempt notExempt notTaxable
jurisdictionType
string Type of tax jurisdiction
jurisdictionCode
string Tax jurisdiction code
assignedId
string Assigned tax identifier
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
Values: exempt notExempt notTaxable
jurisdictionType
string Type of tax jurisdiction
jurisdictionCode
string Tax jurisdiction code
assignedId
string Assigned tax identifier
goodsAndServicesTax
object Goods and services tax (GST) or value-added tax (VAT) information
amount
string Tax amount
percent
string Tax percentage rate
taxIdNumber
string Tax identification number
locationId
string Tax location identifier
exemptionCode
string
Values: exempt notExempt notTaxable
jurisdictionType
string Type of tax jurisdiction
jurisdictionCode
string Tax jurisdiction code
assignedId
string Assigned tax identifier
harmonizedSalesTax
object Harmonized sales tax (HST) information
amount
string Tax amount
percent
string Tax percentage rate
taxIdNumber
string Tax identification number
locationId
string Tax location identifier
exemptionCode
string
Values: exempt notExempt notTaxable
jurisdictionType
string Type of tax jurisdiction
jurisdictionCode
string Tax jurisdiction code
assignedId
string Assigned tax identifier
preThresholdTax
object Tax applied before a threshold amount
amount
string Tax amount
percent
string Tax percentage rate
taxIdNumber
string Tax identification number
locationId
string Tax location identifier
exemptionCode
string
Values: exempt notExempt notTaxable
jurisdictionType
string Type of tax jurisdiction
jurisdictionCode
string Tax jurisdiction code
assignedId
string Assigned tax identifier
postThresholdTax
object Tax applied after a threshold amount
amount
string Tax amount
percent
string Tax percentage rate
taxIdNumber
string Tax identification number
locationId
string Tax location identifier
exemptionCode
string
Values: exempt notExempt notTaxable
jurisdictionType
string Type of tax jurisdiction
jurisdictionCode
string Tax jurisdiction code
assignedId
string Assigned tax identifier
stateProvincialTax
object State or provincial sales tax (PST/QST) information
amount
string Tax amount
percent
string Tax percentage rate
taxIdNumber
string Tax identification number
locationId
string Tax location identifier
exemptionCode
string
Values: exempt notExempt notTaxable
jurisdictionType
string Type of tax jurisdiction
jurisdictionCode
string Tax jurisdiction code
assignedId
string Assigned tax identifier
stateProvincialTaxOnGoods
object State or provincial tax on goods
amount
string Tax amount
percent
string Tax percentage rate
taxIdNumber
string Tax identification number
locationId
string Tax location identifier
exemptionCode
string
Values: exempt notExempt notTaxable
jurisdictionType
string Type of tax jurisdiction
jurisdictionCode
string Tax jurisdiction code
assignedId
string Assigned tax identifier
stateProvincialTaxOnServices
object State or provincial tax on services
amount
string Tax amount
percent
string Tax percentage rate
taxIdNumber
string Tax identification number
locationId
string Tax location identifier
exemptionCode
string
Values: exempt notExempt notTaxable
jurisdictionType
string Type of tax jurisdiction
jurisdictionCode
string Tax jurisdiction code
assignedId
string Assigned tax identifier
localTax
object Local tax information
amount
string Tax amount
percent
string Tax percentage rate
taxIdNumber
string Tax identification number
locationId
string Tax location identifier
exemptionCode
string
Values: exempt notExempt notTaxable
jurisdictionType
string Type of tax jurisdiction
jurisdictionCode
string Tax jurisdiction code
assignedId
string Assigned tax identifier
lineItems
array Line items included in the purchase order
purchaseOrderLineId
string Unique identifier for the line item within the purchase order. Usually a simple counter, this number should be kept consistent when referencing a specific line item on return documents.
quantity
object Quantity ordered for this line 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 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
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
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
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
Values: catalog manufacturerPart sku style
value
string Product identifier value
vendorItemIds
array Additional vendor product identifiers
type
string
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
shortDescription
string 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 Material type or classification
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
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
Values: bag box carton case cassette each fluidOunce gram kilogram liter milliliter ounce packPAK package pair pound roll tote unit
packageForm
string
Values: bag bottle box can carton coil container pallet shrinkWrap unit
packageMaterial
string
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
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
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
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
Values: bag box carton case cassette each fluidOunce gram kilogram liter milliliter ounce packPAK package pair pound roll tote unit
packageForm
string
Values: bag bottle box can carton coil container pallet shrinkWrap unit
packageMaterial
string
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
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
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
baseboxBasisWeight
string Basis weight in pounds per base box — the standard steel mill weight specification unit
packaging
array Packaging and marking requirements
characteristicType
string
Values: containerShape hazardousMaterial packageSpecifications packing palletType productMarking shippingPackageLabeling typeOfPackage wrappingMaterial
agencyType
string
Values: uniformCodeCouncil
descriptionType
string Type of description
description
string Packaging description
unitLoadOption
string
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. Covers both 063 (
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
requestedShipDate
unknown Requested date for shipment
requestedDeliveryWeekOfDate
unknown Week during which delivery is requested
references
object Reference numbers specific to this line item
contractNumber
object Contract number for this line item
value
string The reference identifier value
description
string Additional description or context for the reference
customerOrderLineNumber
object Customer order line number for this line item
value
string The reference identifier value
description
string Additional description or context for the reference
customerOrderNumber
object Customer order number for this line item
value
string The reference identifier value
description
string Additional description or context for the reference
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
pricingQuote
object Pricing quote reference 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
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
object Destination location identifier
destinationId
string Destination location identifier
quantity
string Quantity for this destination
allowances
array Allowances or discounts applied to this line item
type
string
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
Values: collect paidByVendor paidByCustomer prepaid
description
string Description of the allowance or charge
charges
array Additional charges applied to this line item
type
string
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
Values: collect paidByVendor paidByCustomer prepaid
description
string Description of the allowance or charge
monetaryAmounts
object Gross monetary amount 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
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
Values: catalog manufacturerPart sku style
value
string Product identifier value
vendorItemIds
array Additional vendor product identifiers
type
string
Values: catalog manufacturerPart sku style
value
string Product identifier value
productAttributes
object Product attributes for the subline item
description
string General product description
shortDescription
string 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 Material type or classification
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
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. Default for CTB02 when CTB01=OR. MSG/MTX free-form text (segments named messageText/text in the input JSON) may also route here when the guideline note indicates order instructions — 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
shippingInstructions
object Special instructions for shipping the order. Default for CTB02 when CTB01=SR. MSG/MTX free-form text (segments named messageText/text in the input JSON) may also route here when the guideline note indicates shipping instructions — 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
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 PWK01
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
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 routing information for this line item
routing
array Carrier routing information for this line item
sequenceType
string
Values: origin 1stAfterOrigin 4thAfterOrigin haulage
standardCarrierAlphaCode
string SCAC code identifying the carrier
customCarrierCode
string Custom carrier identifier
transportationMethod
string
Values: air airExpress airFreightForward backhaul bestWay commonCarrier consolidation customerPickup expeditedTruck lessThanTrailerLoad mail ocean oceanContainerized parcelPost privateCarrier rail shipperAgent supplierTruck trailer mutuallyDefined
locationType
string
Values: inStore receiversLocation allPoints portOfArrival portOfEmbarkation origin mutuallyDefined
location
string Routing location identifier or name
description
string Description of routing details
serviceLevel
string
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
Values: shipCompleteOnDate complete partialShipment shipPartialBackorderToShipOnDate partialShipOnDate shipped backordered mutuallyDefined availableScheduledToShip availableNoShipSchedule multiPickup availableToShipUnBilledQuantity stopOff
transitDirectionType
string
Values: buyerToSeller sellerToBuyer subcontractorToSeller sellerToDropShipLocation sellToForwarder sellerToSubcontractor mutuallyDefined
transitTimeType
string These may be sent on the PO but for Outbound we can calculate based on shipDate and deliveryDate
Values: calendarDays hours workingDays
transitTime
string Expected transit time value
freeOnBoard
array FOB (Free on Board) terms for this line item
methodOfPayment
string
Values: airCollect airPrepaid paidByBuyer collect mutuallyAgreed portOfCall halfPrepaid mixed serviceFreightNoCharge advancePrepaid customerPickupBackhaul prepaidChargeCustomer prepaidBySeller paidBySeller pickup thirdPartyPay
locationType
string
Values: cityAndState country destination origin stateProvince warehouse
locationDescription
string Description of FOB location
titlePassageType
string
Values: cityAndState country destination origin stateProvince warehouse
titlePassageDescription
string Description of title passage location
transportationTermsSource
string
Values: incoTerms tradeTerms mutuallyDefined
transportationTerms
string
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
Values: toDestinationBuyer toFreightEqPointSeller toPoolPointSeller toDestinationSeller mutuallyDefined
description
string Additional FOB description
taxes
object Tax information for the line item
countyTax
object County-level tax information
amount
string Tax amount
percent
string Tax percentage rate
taxIdNumber
string Tax identification number
locationId
string Tax location identifier
exemptionCode
string
Values: exempt notExempt notTaxable
jurisdictionType
string Type of tax jurisdiction
jurisdictionCode
string Tax jurisdiction code
assignedId
string Assigned tax identifier
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
Values: exempt notExempt notTaxable
jurisdictionType
string Type of tax jurisdiction
jurisdictionCode
string Tax jurisdiction code
assignedId
string Assigned tax identifier
goodsAndServicesTax
object Goods and services tax (GST) or value-added tax (VAT) information
amount
string Tax amount
percent
string Tax percentage rate
taxIdNumber
string Tax identification number
locationId
string Tax location identifier
exemptionCode
string
Values: exempt notExempt notTaxable
jurisdictionType
string Type of tax jurisdiction
jurisdictionCode
string Tax jurisdiction code
assignedId
string Assigned tax identifier
harmonizedSalesTax
object Harmonized sales tax (HST) information
amount
string Tax amount
percent
string Tax percentage rate
taxIdNumber
string Tax identification number
locationId
string Tax location identifier
exemptionCode
string
Values: exempt notExempt notTaxable
jurisdictionType
string Type of tax jurisdiction
jurisdictionCode
string Tax jurisdiction code
assignedId
string Assigned tax identifier
preThresholdTax
object Tax applied before a threshold amount
amount
string Tax amount
percent
string Tax percentage rate
taxIdNumber
string Tax identification number
locationId
string Tax location identifier
exemptionCode
string
Values: exempt notExempt notTaxable
jurisdictionType
string Type of tax jurisdiction
jurisdictionCode
string Tax jurisdiction code
assignedId
string Assigned tax identifier
postThresholdTax
object Tax applied after a threshold amount
amount
string Tax amount
percent
string Tax percentage rate
taxIdNumber
string Tax identification number
locationId
string Tax location identifier
exemptionCode
string
Values: exempt notExempt notTaxable
jurisdictionType
string Type of tax jurisdiction
jurisdictionCode
string Tax jurisdiction code
assignedId
string Assigned tax identifier
stateProvincialTax
object State or provincial sales tax (PST/QST) information
amount
string Tax amount
percent
string Tax percentage rate
taxIdNumber
string Tax identification number
locationId
string Tax location identifier
exemptionCode
string
Values: exempt notExempt notTaxable
jurisdictionType
string Type of tax jurisdiction
jurisdictionCode
string Tax jurisdiction code
assignedId
string Assigned tax identifier
stateProvincialTaxOnGoods
object State or provincial tax on goods
amount
string Tax amount
percent
string Tax percentage rate
taxIdNumber
string Tax identification number
locationId
string Tax location identifier
exemptionCode
string
Values: exempt notExempt notTaxable
jurisdictionType
string Type of tax jurisdiction
jurisdictionCode
string Tax jurisdiction code
assignedId
string Assigned tax identifier
stateProvincialTaxOnServices
object State or provincial tax on services
amount
string Tax amount
percent
string Tax percentage rate
taxIdNumber
string Tax identification number
locationId
string Tax location identifier
exemptionCode
string
Values: exempt notExempt notTaxable
jurisdictionType
string Type of tax jurisdiction
jurisdictionCode
string Tax jurisdiction code
assignedId
string Assigned tax identifier
localTax
object Local tax information
amount
string Tax amount
percent
string Tax percentage rate
taxIdNumber
string Tax identification number
locationId
string Tax location identifier
exemptionCode
string
Values: exempt notExempt notTaxable
jurisdictionType
string Type of tax jurisdiction
jurisdictionCode
string Tax jurisdiction code
assignedId
string Assigned tax identifier
{
  "type": "850_PURCHASE_ORDER",
  "stream": "test",
  "senderId": "BUYERISA",
  "receiverId": "SELLERISA",
  "message": {
    "purpose": "original",
    "purchaseOrderType": "standalone",
    "purchaseOrderNumber": "PO5786344061670677",
    "purchaseOrderDate": "2026-02-12",
    "releaseNumber": "004010",
    "conditionsAndRestrictions": [
      {
        "conditionType": "doNotBackorder"
      }
    ],
    "parties": {
      "buyer": {
        "name": "Retail Integration Testing",
        "identificationCode": "5438",
        "identificationCodeType": "sendersId"
      },
      "shipTo": {
        "name": "Retail Integration Testing",
        "identificationCode": "5438",
        "identificationCodeType": "sendersId",
        "addressLine1": "4055 MAIN ST",
        "city": "NEW YORK",
        "stateOrProvinceCode": "NY",
        "postalCode": "10001",
        "countryCode": "US"
      },
      "billTo": {
        "name": "Retail Integration Testing",
        "identificationCode": "5438",
        "identificationCodeType": "sendersId",
        "addressLine1": "4055 MAIN ST",
        "city": "NEW YORK",
        "stateOrProvinceCode": "NY",
        "postalCode": "10001",
        "countryCode": "US"
      }
    },
    "termsOfSale": {
      "type": "basic",
      "basisDate": "deliveryDate",
      "discountPercent": "1",
      "discountDaysDue": 45,
      "description": "Net 45 Days"
    },
    "references": {
      "vendorNumber": {
        "value": "4875905"
      },
      "departmentNumber": {
        "value": "011"
      }
    },
    "dates": {
      "earliestShipDate": "2026-02-17",
      "latestShipDate": "2026-02-22"
    },
    "carrierDetails": {
      "routing": [
        {
          "description": "2"
        }
      ],
      "freeOnBoard": [
        {
          "methodOfPayment": "mutuallyAgreed"
        }
      ]
    },
    "allowances": [
      {
        "type": "discount",
        "amount": "196.2475",
        "description": "Discount"
      }
    ],
    "charges": [
      {
        "type": "freight",
        "amount": "784.99",
        "description": "Freight Charge"
      }
    ],
    "lineItems": [
      {
        "purchaseOrderLineId": "1",
        "quantity": {
          "value": "5",
          "unitOfMeasure": "each"
        },
        "unitCostPrice": "101.00",
        "productIds": {
          "buyerItemNumber": "10000002",
          "gtin12": "002837465832",
          "caseCode": "002837465832"
        },
        "productAttributes": {
          "description": "Green toothpaste"
        },
        "outerPack": {
          "numberOfUnits": "10"
        },
        "innerPack": {
          "numberOfUnits": "10"
        }
      },
      {
        "purchaseOrderLineId": "2",
        "quantity": {
          "value": "20",
          "unitOfMeasure": "each"
        },
        "unitCostPrice": "88.00",
        "productIds": {
          "buyerItemNumber": "10000004",
          "gtin12": "002837465837",
          "caseCode": "002837465837"
        },
        "productAttributes": {
          "description": "Orange toothpaste"
        },
        "outerPack": {
          "numberOfUnits": "8"
        },
        "innerPack": {
          "numberOfUnits": "8"
        }
      },
      {
        "purchaseOrderLineId": "3",
        "quantity": {
          "value": "5",
          "unitOfMeasure": "each"
        },
        "unitCostPrice": "112.00",
        "productIds": {
          "buyerItemNumber": "10000003",
          "gtin12": "002837465836",
          "caseCode": "002837465836"
        },
        "productAttributes": {
          "description": "Purple toothpaste"
        },
        "outerPack": {
          "numberOfUnits": "12"
        },
        "innerPack": {
          "numberOfUnits": "12"
        }
      },
      {
        "purchaseOrderLineId": "4",
        "quantity": {
          "value": "10",
          "unitOfMeasure": "each"
        },
        "unitCostPrice": "100.00",
        "productIds": {
          "buyerItemNumber": "10000001",
          "gtin12": "002837465831",
          "caseCode": "002837465831"
        },
        "productAttributes": {
          "description": "Yellow toothpaste"
        },
        "outerPack": {
          "numberOfUnits": "10"
        },
        "innerPack": {
          "numberOfUnits": "10"
        }
      },
      {
        "purchaseOrderLineId": "5",
        "quantity": {
          "value": "5",
          "unitOfMeasure": "each"
        },
        "unitCostPrice": "19.99",
        "productIds": {
          "buyerItemNumber": "ORDERFUL-TEST-SKU-005",
          "gtin12": "012345678005",
          "caseCode": "012345678005"
        },
        "productAttributes": {
          "description": "Placeholder product for scenario testing"
        },
        "outerPack": {
          "numberOfUnits": "1"
        },
        "innerPack": {
          "numberOfUnits": "1"
        }
      }
    ]
  }
}
File Description Download
sample.json Sample JSON payload Download
schema.json JSON Schema (draft-07), served live from the Orderful API Download