OpenAPI Specification
openapi: 3.0.0
info:
title: Orderful Conversion Transaction API
description: The official Orderful API documentation.
version: 2.15.0
contact:
name: Orderful
url: https://orderful.com
email: developers@orderful.com
termsOfService: https://orderful.com/terms-and-conditions/
servers:
- url: https://api.orderful.com
tags:
- name: Transaction
description: Create and manage EDI transactions.
paths:
/transactions:
post:
operationId: TransactionController_create
summary: Create a Transaction
description: 'Creates a Transaction. Only one Transaction can be posted at a time. For guidance on how to use this page, see the <a href="https://docs.orderful.com/docs/create-a-transaction#make-an-api-call-using-our-api-explorer" target="_blank">Create a Transaction guide</a>. Check the status field to determine if the transaction was successfully accepted for processing or failed.
'
tags:
- Transaction
parameters:
- name: orderful-api-version
in: header
description: Specifies the API version to use.
schema:
type: string
default: v4
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateTransactionBodyV4Dto'
examples:
purchaseOrder:
summary: Purchase Order (850)
value:
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: 2837465832
caseCode: 2837465832
productAttributes:
description: Green toothpaste
outerPack:
numberOfUnits: '10'
innerPack:
numberOfUnits: '10'
- purchaseOrderLineId: '2'
quantity:
value: '20'
unitOfMeasure: each
unitCostPrice: '88.00'
productIds:
buyerItemNumber: '10000004'
gtin12: 2837465837
caseCode: 2837465837
productAttributes:
description: Orange toothpaste
outerPack:
numberOfUnits: '8'
innerPack:
numberOfUnits: '8'
- purchaseOrderLineId: '3'
quantity:
value: '5'
unitOfMeasure: each
unitCostPrice: '112.00'
productIds:
buyerItemNumber: '10000003'
gtin12: 2837465836
caseCode: 2837465836
productAttributes:
description: Purple toothpaste
outerPack:
numberOfUnits: '12'
innerPack:
numberOfUnits: '12'
- purchaseOrderLineId: '4'
quantity:
value: '10'
unitOfMeasure: each
unitCostPrice: '100.00'
productIds:
buyerItemNumber: '10000001'
gtin12: 2837465831
caseCode: 2837465831
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: 12345678005
caseCode: 12345678005
productAttributes:
description: Placeholder product for scenario testing
outerPack:
numberOfUnits: '1'
innerPack:
numberOfUnits: '1'
poAcknowledgment:
summary: Purchase Order Acknowledgment (855)
value:
type: 855_PURCHASE_ORDER_ACKNOWLEDGMENT
stream: test
senderId: SELLERISA
receiverId: BUYERISA
message:
purchaseOrderNumber: PO5786344061670677
status: accepted
statusNote:
description: Order Confirmation
text:
- Order acknowledged with exceptions on lines 3 and 5.
- Purple toothpaste is out of stock and cannot be backordered per PO instructions.
- Placeholder SKU substituted with equivalent test product.
dates:
purchaseOrderDate: '2026-02-12'
scheduledShipDate: '2026-02-19'
estimatedDeliveryDate: '2026-02-21'
parties:
shipFrom:
name: Toothpaste Warehouse West
identificationCode: WH-WEST-01
identificationCodeType: warehouse
addressLine1: 2200 Distribution Pkwy
city: Edison
stateOrProvinceCode: NJ
postalCode: 8817
countryCode: US
contacts:
- type: shipping
name: Fulfillment Desk
phoneNumber: 732-555-0100
email: shipping@toothpastewarehouse.com
supplier:
name: Toothpaste Co.
identificationCode: '4875905'
identificationCodeType: sendersId
addressLine1: 500 Oral Care Blvd
city: Newark
stateOrProvinceCode: NJ
postalCode: '07102'
countryCode: US
contacts:
- type: primary
name: Order Management
phoneNumber: 973-555-0200
email: orders@toothpasteco.com
termsOfSale:
type: basic
basisDate: deliveryDate
discountPercent: '1'
discountDaysDue: 45
description: Net 45 Days
references:
vendorNumber:
value: '4875905'
departmentNumber:
value: '011'
lineItems:
- purchaseOrderLineId: '1'
productIds:
buyerItemNumber: '10000002'
gtin12: 2837465832
productAttributes:
description: Green toothpaste
actions:
- status: accepted
quantity:
value: '5'
unitOfMeasure: each
unitCostPrice: '101.00'
scheduledShipDate: '2026-02-19'
estimatedDeliveryDate: '2026-02-21'
- purchaseOrderLineId: '2'
productIds:
buyerItemNumber: '10000004'
gtin12: 2837465837
productAttributes:
description: Orange toothpaste
actions:
- status: accepted
quantity:
value: '20'
unitOfMeasure: each
unitCostPrice: '88.00'
scheduledShipDate: '2026-02-19'
estimatedDeliveryDate: '2026-02-21'
- purchaseOrderLineId: '3'
productIds:
buyerItemNumber: '10000003'
gtin12: 2837465836
productAttributes:
description: Purple toothpaste
actions:
- status: rejected
statusReasonCode: outOfStock
statusNote:
description: Out of Stock
text:
- Purple toothpaste is currently unavailable.
- Do-not-backorder instruction honored. Please reorder when stock replenishes.
quantity:
value: '5'
unitOfMeasure: each
- purchaseOrderLineId: '4'
productIds:
buyerItemNumber: '10000001'
gtin12: 2837465831
productAttributes:
description: Yellow toothpaste
actions:
- status: accepted
quantity:
value: '10'
unitOfMeasure: each
unitCostPrice: '95.00'
scheduledShipDate: '2026-02-19'
estimatedDeliveryDate: '2026-02-21'
statusNote:
description: Price Adjustment
text:
- Unit price reduced from $100.00 to $95.00 per promotional agreement.
- purchaseOrderLineId: '5'
productIds:
buyerItemNumber: ORDERFUL-TEST-SKU-005
gtin12: 12345678005
productAttributes:
description: Placeholder product for scenario testing
actions:
- status: accepted
quantity:
value: '5'
unitOfMeasure: each
unitCostPrice: '19.99'
scheduledShipDate: '2026-02-19'
estimatedDeliveryDate: '2026-02-21'
substitutedItem:
productIds:
buyerItemNumber: ORDERFUL-TEST-SKU-005A
gtin12: 12345678015
statusNote:
description: Substitution
text:
- Original test SKU replaced with updated revision SKU-005A at same price.
shipNotice:
summary: Ship Notice / ASN (856)
value:
type: 856_SHIP_NOTICE_MANIFEST
stream: test
senderId: SELLERISA
receiverId: BUYERISA
message:
purpose: original
shipmentId: SHP-2026-0219-4875905
carrierDetails:
quantityAndWeight:
- packageForm: carton
weightUOM: pound
grossWeight: '285.00'
routing:
- sequenceType: origin
standardCarrierAlphaCode: FEDX
transportationMethod: commonCarrier
serviceLevel: ground
equipment:
equipmentType: trailer
equipmentId: FEDX-TRL-88412
freeOnBoard:
- methodOfPayment: mutuallyAgreed
references:
billOfLadingNumber:
value: BOL-2026-0219-001
proNumber:
value: PRO7742859301
vendorNumber:
value: '4875905'
dates:
shipDate: '2026-02-19'
deliveryDate: '2026-02-21'
parties:
shipFrom:
name: Toothpaste Warehouse West
identificationCode: WH-WEST-01
identificationCodeType: warehouse
addressLine1: 2200 Distribution Pkwy
city: Edison
stateOrProvinceCode: NJ
postalCode: 8817
countryCode: US
contacts:
- type: shipping
name: Fulfillment Desk
phoneNumber: 732-555-0100
email: shipping@toothpastewarehouse.com
shipTo:
name: Retail Integration Testing
identificationCode: '5438'
identificationCodeType: sendersId
addressLine1: 4055 MAIN ST
city: NEW YORK
stateOrProvinceCode: NY
postalCode: '10001'
countryCode: US
supplier:
name: Toothpaste Co.
identificationCode: '4875905'
identificationCodeType: sendersId
orders:
- purchaseOrderNumber: PO5786344061670677
purchaseOrderDate: '2026-02-12'
pallets:
- palletType: standard
serialShippingId: 100487590500000100
layersPerPallet: 2
cartonsPerLayer: 1
cartons:
- serialShippingId: 100487590500000210
trackingNumber: '794644790132'
items:
- purchaseOrderLineId: '1'
productIds:
buyerItemNumber: '10000002'
gtin12: 2837465832
productAttributes:
description: Green toothpaste
quantityShipped:
value: '5'
unitOfMeasure: each
outerPack:
numberOfUnits: '10'
innerPack:
numberOfUnits: '10'
- serialShippingId: 100487590500000210
trackingNumber: '794644790133'
items:
- purchaseOrderLineId: '2'
productIds:
buyerItemNumber: '10000004'
gtin12: 2837465837
productAttributes:
description: Orange toothpaste
quantityShipped:
value: '20'
unitOfMeasure: each
outerPack:
numberOfUnits: '8'
innerPack:
numberOfUnits: '8'
- palletType: standard
serialShippingId: 100487590500000100
layersPerPallet: 2
cartonsPerLayer: 1
cartons:
- serialShippingId: 100487590500000210
trackingNumber: '794644790134'
items:
- purchaseOrderLineId: '4'
productIds:
buyerItemNumber: '10000001'
gtin12: 2837465831
productAttributes:
description: Yellow toothpaste
quantityShipped:
value: '10'
unitOfMeasure: each
outerPack:
numberOfUnits: '10'
innerPack:
numberOfUnits: '10'
- serialShippingId: 100487590500000210
trackingNumber: '794644790135'
items:
- purchaseOrderLineId: '5'
productIds:
buyerItemNumber: ORDERFUL-TEST-SKU-005A
gtin12: 12345678015
productAttributes:
description: Placeholder product for scenario testing
quantityShipped:
value: '5'
unitOfMeasure: each
outerPack:
numberOfUnits: '1'
innerPack:
numberOfUnits: '1'
- purchaseOrderNumber: PO9921004488220031
purchaseOrderDate: '2026-02-10'
parties:
markFor:
name: Metals Distribution Center
identificationCode: MDC-044
identificationCodeType: sendersId
pallets:
- palletType: steel
serialShippingId: 100487590500000300
items:
- purchaseOrderLineId: '1'
references:
heatCode:
value: HT-2026-A4819
billOfMaterial:
value: BOM-SS304-COIL-48
productIds:
vendorItemNumber: SS304-48-020
productAttributes:
description: 304 Stainless Steel Coil 48in x 0.020in
materialAttributes:
type: 304 Stainless Steel
annealMethod: bright anneal
temper: quarter hard
finish: 2B
surfaceProtection: PVC film
coilNumber: COIL-2026-SS304-00219
quantityShipped:
value: '12000'
unitOfMeasure: pound
manufactureDate: '2026-01-28'
countryOfOrigin: US
- purchaseOrderLineId: '2'
references:
heatCode:
value: HT-2026-A4820
barCode:
value: SN00100487590500000302
productIds:
vendorItemNumber: CS1018-36-125
productAttributes:
description: 1018 Carbon Steel Sheet 36in x 0.125in
materialAttributes:
type: 1018 Carbon Steel
temper: hot rolled
finish: mill
outerCoating: oil
treatment: pickled
coilNumber: COIL-2026-CS1018-00084
quantityShipped:
value: '8500'
unitOfMeasure: pound
manufactureDate: '2026-02-03'
countryOfOrigin: US
invoice:
summary: Invoice (810)
value:
type: 810_INVOICE
stream: test
senderId: SELLERISA
receiverId: BUYERISA
message:
invoiceDate: '2026-02-22'
invoiceNumber: INV-2026-0222-4875905
purchaseOrderNumber: PO5786344061670677
releaseNumber: '004010'
references:
vendorNumber:
value: '4875905'
departmentNumber:
value: '011'
billOfLadingNumber:
value: BOL-2026-0219-001
proNumber:
value: PRO7742859301
shipmentId:
value: SHP-2026-0219-4875905
dates:
shipDate: '2026-02-19'
deliveryDate: '2026-02-21'
parties:
buyer:
name: Retail Integration Testing
identificationCode: '5438'
identificationCodeType: receiversId
shipTo:
name: Retail Integration Testing
identificationCode: '5438'
identificationCodeType: receiversId
addressLine1: 4055 MAIN ST
city: NEW YORK
stateOrProvinceCode: NY
postalCode: '10001'
countryCode: US
billTo:
name: Retail Integration Testing
identificationCode: '5438'
identificationCodeType: receiversId
addressLine1: 4055 MAIN ST
city: NEW YORK
stateOrProvinceCode: NY
postalCode: '10001'
countryCode: US
accountsReceivable:
name: Toothpaste Co.
identificationCode: '4875905'
identificationCodeType: sendersId
addressLine1: 500 Oral Care Blvd
city: Newark
stateOrProvinceCode: NJ
postalCode: '07102'
countryCode: US
contacts:
- type: primary
name: Accounts Receivable
phoneNumber: 973-555-0300
email: ar@toothpasteco.com
termsOfSale:
type: basic
basisDate: deliveryDate
discountPercent: '1'
discountDaysDue: 45
description: Net 45 Days
carrierDetails:
quantityAndWeight:
- packageForm: carton
ladingQuantity: '4'
weightUOM: pound
grossWeight: '285.00'
routing:
- sequenceType: origin
standardCarrierAlphaCode: FEDX
transportationMethod: commonCarrier
serviceLevel: ground
equipment:
equipmentType: trailer
equipmentId: FEDX-TRL-88412
freeOnBoard:
- methodOfPayment: mutuallyAgreed
lineItems:
- purchaseOrderLineId: '1'
quantityInvoiced:
value: '5'
unitOfMeasure: each
unitPrice: '101.00'
productIds:
buyerItemNumber: '10000002'
gtin12: 2837465832
productAttributes:
description: Green toothpaste
outerPack:
numberOfUnits: '10'
innerPack:
numberOfUnits: '10'
- purchaseOrderLineId: '2'
quantityInvoiced:
value: '20'
unitOfMeasure: each
unitPrice: '88.00'
productIds:
buyerItemNumber: '10000004'
gtin12: 2837465837
productAttributes:
description: Orange toothpaste
outerPack:
numberOfUnits: '8'
innerPack:
numberOfUnits: '8'
- purchaseOrderLineId: '4'
quantityInvoiced:
value: '10'
unitOfMeasure: each
unitPrice: '95.00'
productIds:
buyerItemNumber: '10000001'
gtin12: 2837465831
productAttributes:
description: Yellow toothpaste
outerPack:
numberOfUnits: '10'
innerPack:
numberOfUnits: '10'
- purchaseOrderLineId: '5'
quantityInvoiced:
value: '5'
unitOfMeasure: each
unitPrice: '19.99'
productIds:
buyerItemNumber: ORDERFUL-TEST-SKU-005A
gtin12: 12345678015
productAttributes:
description: Placeholder product for scenario testing
outerPack:
numberOfUnits: '1'
innerPack:
numberOfUnits: '1'
allowances:
- type: discount
amount: '165.75'
description: Discount
charges:
- type: freight
amount: '784.99'
description: Freight Charge
invoiceSalesTotal: '3314.95'
invoiceTermsDiscount: '33.15'
invoiceTotal: '3934.19'
inventoryAdvice:
summary: Inventory Advice (846)
value:
type: 846_INVENTORY_ADVICE
stream: test
senderId: ACMEPRODUCTS
receiverId: RETAILPARTNER
message:
purpose: full
reportType: sellerInventory
reportNumber: INV-2024-001234
reportDate: '2024-01-15'
parties:
inventoryLocation:
name: West Coast Distribution Center
identificationCode: WH001
identificationCodeType: warehouse
addressLine1: 1234 Logistics Way
city: Los Angeles
stateOrProvinceCode: CA
postalCode: '90001'
countryCode: US
buyer:
name: Retail Partner Inc
identificationCode: RETAILPARTNER
identificationCodeType: receiversId
supplier:
name: Acme Products LLC
identificationCode: ACMEPRODUCTS
identificationCodeType: sendersId
contacts:
- type: primary
name: John Smith
email: inventory@acmeproducts.com
phoneNumber: 555-123-4567
references:
vendorNumber:
value: VN-98765
departmentNumber:
value: DEPT-100
dates:
reportStartDate: '2024-01-01'
reportEndDate: '2024-01-15'
sellersCurrency:
currencyCode: USD
notes:
general:
description: Weekly inventory snapshot
text:
- Full inventory count as of January 15, 2024
lineItems:
- lineNumber: '1'
productIds:
buyerItemNumber: SKU-ABC-001
vendorItemNumber: ACME-WIDGET-100
gtin12: 12345678901
productAttributes:
description: Premium Widget - Blue
colorDescription: Blue
sizeDescription: Large
itemStatus: inStock
unitOfMeasure: each
inventoryQuantities:
- locationId: WH001
type: available
quantity: '500'
availableDate: '2024-0
# --- truncated at 32 KB (97 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/orderful/refs/heads/main/openapi/orderful-transaction-api-openapi.yml