[Deprecated] Adjust Purchase Order
post
https://api.flxpoint.com/purchase-orders/{purchaseOrderId}/adjustDeprecatedUse this when you want to create purchase order data through the API.
🔑 X-API-TOKEN⏱ 2 req/sToken: Account · Source · Channel
This page explains the endpoint. To send a live test request, use the interactive tester in Stoplight or your own Postman / HTTP client.
This endpoint allows for partial acknowledgements and/or cancellations by specifying items.
Request
Body
application/jsonPass a null or empty value for `items` to acknowledge all PO Line item quantities which are not already acknowledged/canceled. Secondary Acknowledgements will not be updated when omitting line items.
itemsarray[PurchaseOrderItemAcknowledgementRequest]skustringThe SKU of the item to adjust. This field is required if the ID is not specified and other item fields are passed. ID will be prioritized over SKU if both are included.
acknowledgedQuantityintegersecondaryAcknowledgedQuantityintegerWhen providing secondary acknowledgements if this value is greater than the acknowledged quantity the acknowledged quantity will automatically be adjusted to match up to the secondary acknowledged quantity
cancelledQuantityintegeridintegerThe ID of the item to adjust. This field is required when there are duplicate SKUs present in the fulfillment, or if the SKU is not specified and other item fields are passed. ID will be prioritized over SKU if both are included.
killOrFillTypestring`killOrFillType` can be either `fill` Or `kill`. By default it will be `fill`.
- `fill` : This will unallocate the quantities from the order item level so that another PO can be generated for alternative fulfillment.
- `kill` : This will cancel the quantities at the order item level indicating no further fulfillment should occur.
allowed
fillkilldefault
"fill"cancelUnacknowledgedItemQuantitybooleanIndicate whether or not remaining unacknowledged quantity should be canceled. Passing a `null` value here will use the existing saved setting for the source to determine how this should be handled.
Example request
post
/purchase-orders/{purchaseOrderId}/adjustcurl -X POST "https://api.flxpoint.com/purchase-orders/{purchaseOrderId}/adjust" \
-H "Accept: application/json" \
-H "X-API-TOKEN: YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"items": [
{
"sku": "string",
"acknowledgedQuantity": 0,
"secondaryAcknowledgedQuantity": 0,
"cancelledQuantity": 0,
"id": 0
}
],
"killOrFillType": "fill",
"cancelUnacknowledgedItemQuantity": true
}'Example body · application/json
{
"items": [
{
"sku": "string",
"acknowledgedQuantity": 0,
"secondaryAcknowledgedQuantity": 0,
"cancelledQuantity": 0,
"id": 0
}
],
"killOrFillType": "fill",
"cancelUnacknowledgedItemQuantity": true
}Responses
200OKapplication/json
idintegerpurchaseOrderNumberstringorderIdintegersentAtstring (date-time)sourceIdintegeracknowledgedAtstring (date-time)secondaryAcknowledgedAtstring (date-time)canceledAtstring (date-time)shippingAddressobjectidintegernamestringField created real-time by concatenating "firstName" and "lastName"
addressLine1stringaddressLine2stringcitystringstatestringcountrystringstateCodestringcountryCodestringpostalstringPostal / Zip Code of address
emailstringphonestringFree form string field, format isn't enforced
companyNamestringfirstNamestringlastNamestringredactedbooleanRepresents if the address information was related to an Order with a PII (Personably Identifiable Information) retention policy attached. If the Order exceeds the PII retention period, this address will have information redacted.
hashstringRepresents a unique hash of this address.
billingAddressobjectidintegernamestringField created real-time by concatenating "firstName" and "lastName"
addressLine1stringaddressLine2stringcitystringstatestringcountrystringstateCodestringcountryCodestringpostalstringPostal / Zip Code of address
emailstringphonestringFree form string field, format isn't enforced
companyNamestringfirstNamestringlastNamestringredactedbooleanRepresents if the address information was related to an Order with a PII (Personably Identifiable Information) retention policy attached. If the Order exceeds the PII retention period, this address will have information redacted.
hashstringRepresents a unique hash of this address.
shippingTextstringdeprecatednotestringA note that can optionally be passed through all the way to the source
confirmationNumberstringshippedStatusCompletionStatusallowed
Not StartedPartially CompletedCompletedpurchaseOrderStatusobjectnamestring`PO/FR # Exceeds Max Length` and `Duplicate PO/FR #` are now deprecated, and will be referred to as `Fulfillment Request # Exceeds Max Length` and `Duplicate Fulfillment Request #` respectively going forward.
allowed
UnprocessedProcessedAcknowledgedCanceledVoidedProcessingAdditional Info RequiredTransferredPO/FR # Exceeds Max LengthDuplicate PO/FR #Processing ErrorFulfillment Request # Exceeds Max LengthDuplicate Fulfillment Request #Cross Dockedhandlestringallowed
unprocessedprocessedacknowledgedcanceledvoidedprocessingadditional_info_requiredtransferredpo_number_exceeds_max_lengthduplicateprocessing_errorcross_dockedpurchaseOrderFulfillmentStatusobjectnamestringallowed
Awaiting ShipmentShippedPartially ShippedCanceledhandlestringallowed
awaiting_shipmentshippedpartially_shippedcanceledgeneratedAtstring (date-time)voidedAtstring (date-time)accountIdintegertotalItemsintegertotalCostnumbertotalQuantityintegershippedQuantityintegerestimatedShippingCostnumberestimatedDropshipFeenumbersourceShippingMethodobject<b>NOTE</b>: The `shippingCarrier` and `shippingCarrierMethod` fields are now deprecated.
To get the associated shipping carrier(s) and/or shipping carrier method(s), use the array versions named `shippingCarriers` and `shippingCarrierMethods` instead.
idintegersourceIdintegerdescriptionstringcarrierstringmethodstringshippingCodestringdeprecatedDeprecated. Use `defaultMethodCode` instead.
shippingPolicyobjectidintegernamestringrequireddeletedAtstring (date-time)deletedAtstring (date-time)shippingCarrierobjectidintegernamestringhandlestringshipEngineSupportedbooleanshippingCarrierMethodobjectidintegershippingCarrierobjectidintegernamestringhandlestringshipEngineSupportedbooleannamestringhandlestringshippingLabelCodestringIt is used to specify the preferred Delivery Service during the purchase of a shipping label when a Fulfillment Request is not rate shopped
defaultCarrierCodestringThe code (text) that your source recognizes for this shipping carrier.
defaultMethodCodestringFormally known as "Shipping Code". The code (text) that your source recognizes for this shipping method.
overrideDefaultCodesbooleanUse codes provided by ShipEngine to send to your source based on the carrier and method with the best shipping rate.
default
falsefilterCarriersAndMethodsbooleanFilter to include only some carriers and methods you've connected to ShipEngine.
default
falseshippingCarriersarray[ShippingCarrier]When filtering shipping carriers and methods (i.e. filterCarriersAndMethods = true), this is the list of eligible shipping carriers that may be used for shipping.
<b>Note:</b> When filterCarriersAndMethods = false, this list will be empty, but <b>all</b> carriers will be considered for rate shopping.
idintegernamestringhandlestringshipEngineSupportedbooleanshippingCarrierMethodsarray[ShippingCarrierMethod]When filtering shipping carriers and methods (i.e. filterCarriersAndMethods = true), this is the list of eligible methods that may be used for shipping.
<b>Note:</b> When filterCarriersAndMethods = false, this list will be empty, but <b>all</b> methods for all carriers will be considered for rate shopping.
idintegershippingCarrierobjectidintegernamestringhandlestringshipEngineSupportedbooleannamestringhandlestringuseBestFitPackagebooleanUse Flxpoint's predefined package sizes to fit all PO/FR line items in a single package. The largest box possible will be used for oversized PO/FRs.
When false, package sizes must be configured for eligibility during rate shopping. You may select any number of common packages and/or use your own custom packages.
default
truecommonPackagesarray[CommonPackage]This will contain the <b>standard</b> package selections enabled for use with this shipping method when configured to use specific packages for shipping, rather than Flxpoint's predefined "Best Fit" package sizes (i.e. useBestFitPackage = false).
<b>Note:</b> When useBestFitPackage = true, this list will be empty, and Flxpoint's predefined list of packages will be considered instead.
idintegerA unique, numerical identifier for the package.
lengthnumberThe length dimension of the package.
widthnumberThe width dimension of the package.
heightnumberThe height dimension of the package.
dimensionUnitobjecthandlestringallowed
inchcentimeterabbreviatedHandlestringallowed
incmweightnumberThe weight of the package itself (excluding any contents).
weightUnitobjecthandlestringallowed
poundouncegramkilogramabbreviatedHandlestringallowed
lbozgkgcustomPackagesarray[CustomPackage]This will contain the <b>unique</b> package selections enabled for use with this shipping method when configured to use specific packages for shipping, rather than Flxpoint's predefined "Best Fit" package sizes (i.e. useBestFitPackage = false).
<b>Note:</b> When useBestFitPackage = true, this list will be empty, and Flxpoint's predefined list of packages will be considered instead.
idintegerA unique, numerical identifier for the package.
namestringYour name for the package.
lengthnumberThe length dimension of the package.
widthnumberThe width dimension of the package.
heightnumberThe height dimension of the package.
dimensionUnitobjecthandlestringallowed
inchcentimeterabbreviatedHandlestringallowed
incmweightnumberThe weight of the package itself (excluding any contents).
weightUnitobjecthandlestringallowed
poundouncegramkilogramabbreviatedHandlestringallowed
lbozgkgcreatedAtstring (date-time)The time that the package was created by an account user.
createdByUserEmailstringThe email address of the user who created the package.
updatedAtstring (date-time)The last time the package details were modified (will be null if never changed).
suppressTrackingbooleanbeingProcessedbooleantotalSourceInvoicesintegerfflInfoRequiredbooleanlastModifiedAtstring (date-time)accountingSyncedbooleanexternalAccountingIdstringholdUntilstring (date-time)rateShoppedIdstringpackageDimensionUnitobjecthandlestringallowed
inchcentimeterabbreviatedHandlestringallowed
incmpackageLengthnumberpackageWidthnumberpackageHeightnumberpackageWeightUnitobjecthandlestringallowed
poundouncegramkilogramabbreviatedHandlestringallowed
lbozgkgpackageWeightnumberchannelIdintegercrossDockPurchaseOrderIdintegerEstablish this PO as part of a cross docking request by providing the cross dock PO ID
voidedReasonstringprocessingErrorReasonstringThe reason this purchase order could not be processed
cancelReasonstringpurchaseOrderItemsarray[PurchaseOrderItem]idintegerskustringquantityintegercostnumberitemReferenceIdstringreferenceIdstringpurchaseOrderIdintegershippedQuantityintegerdefault
0voidedQuantityintegerdefault
0acknowledgedQuantityintegerdefault
0secondaryAcknowledgedQuantityintegerdefault
0inventoryVariantIdinteger (int64)orderItemIdintegertitlestringexternalAccountingItemIdstringcanceledQuantityintegerweightUnitobjecthandlestringallowed
poundouncegramkilogramabbreviatedHandlestringallowed
lbozgkgweightnumberdimensionUnitobjecthandlestringallowed
inchcentimeterabbreviatedHandlestringallowed
incmlengthnumberwidthnumberheightnumberupcstringmpnstringattributesarray[PurchaseOrderItemAttribute]idintegerpurchaseOrderItemIdintegerkeystringvaluestringbundleComponentsarray[PurchaseOrderItemBundleComponent]purchaseOrderItemIdintegerrequiredorderItemBundleComponentIdintegerrequiredlineItemNumberintegerbinLocationstringsubtotalstringshipmentsarray[Shipment]idintegernotestringtrackingUrlstringtrackingNumberstringcarrierstringmethodstringshippedAtstring (date-time)insertedAtstring (date-time)shippingCostnumberorderIdintegerpurchaseOrderIdintegerfulfillmentRequestIdintegerrmaIdintegersourceIdintegeraccountIdintegerpartialbooleansuppressedbooleansyncedToChannelbooleansyncErrorstringcrossDockPurchaseOrderIdintegershipmentItemsarray[ShipmentItem]idintegerskustringquantityintegershipmentIdintegerinventoryVariantIdinteger (int64)partialbooleanorderItemIdintegerpurchaseOrderItemIdintegerthis field will soon be deprecated, please start using `fulfillmentRequestItemId` instead.
there are basically the same thing, just there has been a terminology change.
fulfillmentRequestItemIdintegercommittedStockReleasedQuantityintegerrmaItemIdintegercustomFieldsarray[ShipmentCustomField]idintegernamestringvaluestringcustomFieldsarray[ShipmentCustomField]idintegernamestringvaluestringupdatedAtstring (date-time)accountingSyncedbooleaninvoicesarray[Invoice]idintegerinvoiceStatusobjectnamestringallowed
UnpaidPaidCreditedRefundedhandlestringallowed
unpaidpaidcreditedrefundedinsertedAtstring (date-time)updatedAtstring (date-time)purchaseOrderIdintegerthis field is deprecated, please use `fulfillmentRequestId`. The two fields are same.
fulfillmentRequestIdintegerrmaIdintegersourceIdintegerpurchaseOrderNumberstringthis field is deprecated, please start using `fulfillmentRequestNumber`. The two fields are essentially same.
fulfillmentRequestNumberstringinvoiceNumberstringinvoiceDatestring (date-time)totalCostnumbertotalProductCostnumbertotalShippingCostnumbertotalFeeCostnumbertotalTaxCostnumbertotalOtherCostnumbertotalQuantityintegeraccountingSyncedbooleanaccountingSyncErrorstringexternalAccountingIdstringinvoiceItemsarray[InvoiceItem]idintegerinvoiceIdintegerinvoiceItemTypeobjectrequirednamestringallowed
ProductShippingFeeTaxOtherhandlestringallowed
productshippingfeetaxothersourceVariantIdinteger (int64)costnumberskustringrequiredtitlestringquantityintegerperUnitCostnumberexternalAccountingItemIdstringcustomFieldsarray[Source Invoice Custom Field]idintegernamestringvaluestringtotalCreditCostnumbercustomFieldsarray[Source Invoice Custom Field]idintegernamestringvaluestringcommissionnumberdeprecatedvendorPayoutIdintegerpurchaseOrderAttributesarray[PurchaseOrderAttribute]idintegerpurchase_order_idintegerkeystringvaluestringpurchaseOrderTypeobject"Fulfillment Request" name and "FR" abbreviation are now deprecated. Use "Fulfillment Order" name and "FO" abbreviation instead.
idintegerallowed
1234namestringallowed
Purchase OrderFulfillment RequestTransfer OrderStocking Purchase OrderFulfillment Orderabbreviationstringallowed
POFRTOSPOFOhandlestringallowed
purchase_orderfulfillment_requesttransfer_orderstocking_purchase_ordershippingAddressIdintegerbillingAddressIdintegersourceShippingMethodIdintegershippingDistancenumberpurchaseOrderReceivedStatusobjecthandlestringallowed
awaiting_to_receivepartially_receivedreceivedvoidedcarrierCodestringmethodCodestringpurchaseOrderPackageobjectA Purchase Order Package contains all metadata needed to buy a shipping label.
idintegerThe ID of the Purchase Order Package.
purchaseOrderIdintegerrequiredThe ID of the Purchase Order to buy a shipping label for.
rateIdstringThe Rate Shopping Provider's ID of the rate found that can be used to purchase the shipping label with.
shipFromAddressobjectidintegernamestringField created real-time by concatenating "firstName" and "lastName"
addressLine1stringaddressLine2stringcitystringstatestringcountrystringstateCodestringcountryCodestringpostalstringPostal / Zip Code of address
emailstringphonestringFree form string field, format isn't enforced
companyNamestringfirstNamestringlastNamestringredactedbooleanRepresents if the address information was related to an Order with a PII (Personably Identifiable Information) retention policy attached. If the Order exceeds the PII retention period, this address will have information redacted.
hashstringRepresents a unique hash of this address.
shipToAddressobjectidintegernamestringField created real-time by concatenating "firstName" and "lastName"
addressLine1stringaddressLine2stringcitystringstatestringcountrystringstateCodestringcountryCodestringpostalstringPostal / Zip Code of address
emailstringphonestringFree form string field, format isn't enforced
companyNamestringfirstNamestringlastNamestringredactedbooleanRepresents if the address information was related to an Order with a PII (Personably Identifiable Information) retention policy attached. If the Order exceeds the PII retention period, this address will have information redacted.
hashstringRepresents a unique hash of this address.
createShipmentPostProcessingbooleanThis will enable the automatic creation of a shipment with the tracking information from the purchased shipping label. It will be created once the Purchase Order is processed or acknowledged.
updateShipmentOnPurchasebooleanIf true, we will update the order with shipment details immediately after purchasing the label.
shippingDatestring (date-time)The date that the shipment should be sent.
lengthnumberLength of the package to ship with this label.
widthnumberWidth of the package to ship with this label.
heightnumberHeight of the package to ship with this label.
dimensionUnitobjecthandlestringallowed
inchcentimeterabbreviatedHandlestringallowed
incmtotalWeightnumberTotal weight of the package with all of its items included to be shipped with this label.
weightUnitobjecthandlestringallowed
poundouncegramkilogramabbreviatedHandlestringallowed
lbozgkgshippingCarrierMethodobjectidintegershippingCarrierobjectidintegernamestringhandlestringshipEngineSupportedbooleannamestringhandlestringrateShoppingProviderobjectidintegernamestringhandlestringsupportsLabelGenerationbooleanrateShoppingProviderLabelSizestringThe preferred size of the shipping label.
allowed
4x6letterdefault
"4x6"commonPackageobjectThis is a standard package in Flxpoint that can be associated to a Source Shipping Method for using to ship out orders in.
idintegerA unique, numerical identifier for the package.
lengthnumberThe length dimension of the package.
widthnumberThe width dimension of the package.
heightnumberThe height dimension of the package.
dimensionUnitobjecthandlestringallowed
inchcentimeterabbreviatedHandlestringallowed
incmweightnumberThe weight of the package itself (excluding any contents).
weightUnitobjecthandlestringallowed
poundouncegramkilogramabbreviatedHandlestringallowed
lbozgkgcustomPackageobjectThis is a specific package created by an account user in Flxpoint that can be associated to a Source Shipping Method for using to ship out orders in.
idintegerA unique, numerical identifier for the package.
namestringYour name for the package.
lengthnumberThe length dimension of the package.
widthnumberThe width dimension of the package.
heightnumberThe height dimension of the package.
dimensionUnitobjecthandlestringallowed
inchcentimeterabbreviatedHandlestringallowed
incmweightnumberThe weight of the package itself (excluding any contents).
weightUnitobjecthandlestringallowed
poundouncegramkilogramabbreviatedHandlestringallowed
lbozgkgcreatedAtstring (date-time)The time that the package was created by an account user.
createdByUserEmailstringThe email address of the user who created the package.
updatedAtstring (date-time)The last time the package details were modified (will be null if never changed).
itemsarray[PurchaseOrderPackageItem]Metadata related to the items to be shipped in the package.
idintegerpurchaseOrderPackageIdintegerpurchaseOrderItemIdintegerquantityintegerbuyShippingLabelbooleandefault
falseorderFFLobjectidintegerrequiredorderIdintegercrossDockPurchaseOrderIdintegerlicenseNumberstringrequirednamestringaddressLine1stringrequiredaddressLine2stringcitystringstatestringpostalstringphonestringimageUrlstringexpiresAtstring (date-time)companyNamestringtotalWeightnumberattachmentLinksarray[string]A list of URLs containing each file attached to this Purchase Order. These include both shipping labels and packing slips.
string
shippingLabelAttachmentLinkstringURL for downloading the Shipping Label for this PO if one is attached. If more than one shipping label attachment exists, the first will be provided. See `attachmentLinks` for a full list of all attachment URLs for this PO (regardless of type).
packingSlipAttachmentLinkstringURL for downloading the Packing Slip for this PO if one is attached. If more than one packing slip attachment exists, the first will be provided. See `attachmentLinks` for a full list of all attachment URLs for this PO (regardless of type).
tagsarray[string]string
fullyReceivedAtstring (date-time)The date and time when this Purchase Order was fully received.
Example response
{
"id": 0,
"purchaseOrderNumber": "string",
"orderId": 0,
"sentAt": "2026-04-20T00:00:00Z",
"sourceId": 0,
"acknowledgedAt": "2026-04-20T00:00:00Z",
"secondaryAcknowledgedAt": "2026-04-20T00:00:00Z",
"canceledAt": "2026-04-20T00:00:00Z",
"shippingAddress": {
"id": 0,
"name": "Joe Smith",
"addressLine1": "120 1st Lane",
"addressLine2": "Suite 123",
"city": "Jacksonville",
"state": "Florida",
"country": "United States",
"stateCode": "FL",
"countryCode": "US",
"postal": "12345",
"email": "person@example.com",
"phone": "1-555-123-4567",
"companyName": "string",
"firstName": "Joe",
"lastName": "Smith",
"redacted": true,
"hash": "string"
},
"billingAddress": {
"id": 0,
"name": "Joe Smith",
"addressLine1": "120 1st Lane",
"addressLine2": "Suite 123",
"city": "Jacksonville",
"state": "Florida",
"country": "United States",
"stateCode": "FL",
"countryCode": "US",
"postal": "12345",
"email": "person@example.com",
"phone": "1-555-123-4567",
"companyName": "string",
"firstName": "Joe",
"lastName": "Smith",
"redacted": true,
"hash": "string"
},
"shippingText": "string",
"note": "string",
"confirmationNumber": "string",
"shippedStatus": "Not Started",
"purchaseOrderStatus": {
"name": "Unprocessed",
"handle": "unprocessed"
},
"purchaseOrderFulfillmentStatus": {
"name": "Awaiting Shipment",
"handle": "awaiting_shipment"
},
"generatedAt": "2026-04-20T00:00:00Z",
"voidedAt": "2026-04-20T00:00:00Z",
"accountId": 0,
"totalItems": 0,
"totalCost": 0,
"totalQuantity": 0,
"shippedQuantity": 0,
"estimatedShippingCost": 0,
"estimatedDropshipFee": 0,
"sourceShippingMethod": {
"id": 0,
"sourceId": 0,
"description": "string",
"carrier": "string",
"method": "string",
"shippingCode": "string",
"shippingPolicy": {
"id": 0,
"name": "string",
"deletedAt": "2026-04-20T00:00:00Z"
},
"deletedAt": "2026-04-20T00:00:00Z",
"shippingCarrier": {
"id": 0,
"name": "string",
"handle": "string",
"shipEngineSupported": true
},
"shippingCarrierMethod": {
"id": 0,
"shippingCarrier": {
"id": 0,
"name": "string",
"handle": "string",
"shipEngineSupported": true
},
"name": "string",
"handle": "string"
},
"shippingLabelCode": "string",
"defaultCarrierCode": "string",
"defaultMethodCode": "string",
"overrideDefaultCodes": true,
"filterCarriersAndMethods": true,
"shippingCarriers": [
{
"id": 0,
"name": "string",
"handle": "string",
"shipEngineSupported": true
}
],
"shippingCarrierMethods": [
{
"id": 0,
"shippingCarrier": {
"id": null,
"name": null,
"handle": null,
"shipEngineSupported": null
},
"name": "string",
"handle": "string"
}
],
"useBestFitPackage": true,
"commonPackages": [
{
"id": 0,
"length": 0,
"width": 0,
"height": 0,
"dimensionUnit": {
"handle": null,
"abbreviatedHandle": null
},
"weight": 0,
"weightUnit": {
"handle": null,
"abbreviatedHandle": null
}
}
],
"customPackages": [
{
"id": 0,
"name": "string",
"length": 0,
"width": 0,
"height": 0,
"dimensionUnit": {
"handle": null,
"abbreviatedHandle": null
},
"weight": 0,
"weightUnit": {
"handle": null,
"abbreviatedHandle": null
},
"createdAt": "2026-04-20T00:00:00Z",
"createdByUserEmail": "string",
"updatedAt": "2026-04-20T00:00:00Z"
}
]
},
"suppressTracking": true,
"beingProcessed": true,
"totalSourceInvoices": 0,
"fflInfoRequired": true,
"lastModifiedAt": "2026-04-20T00:00:00Z",
"accountingSynced": true,
"externalAccountingId": "string",
"holdUntil": "2026-04-20T00:00:00Z",
"rateShoppedId": "string",
"packageDimensionUnit": {
"handle": "inch",
"abbreviatedHandle": "in"
},
"packageLength": 0,
"packageWidth": 0,
"packageHeight": 0,
"packageWeightUnit": {
"handle": "pound",
"abbreviatedHandle": "lb"
},
"packageWeight": 0,
"channelId": 0,
"crossDockPurchaseOrderId": 0,
"voidedReason": "string",
"processingErrorReason": "string",
"cancelReason": "string",
"purchaseOrderItems": [
{
"id": 0,
"sku": "string",
"quantity": 0,
"cost": 0,
"itemReferenceId": "string",
"referenceId": "string",
"purchaseOrderId": 0,
"shippedQuantity": 0,
"voidedQuantity": 0,
"acknowledgedQuantity": 0,
"secondaryAcknowledgedQuantity": 0,
"inventoryVariantId": 0,
"orderItemId": 0,
"title": "string",
"externalAccountingItemId": "string",
"canceledQuantity": 0,
"weightUnit": {
"handle": "pound",
"abbreviatedHandle": "lb"
},
"weight": 0,
"dimensionUnit": {
"handle": "inch",
"abbreviatedHandle": "in"
},
"length": 0,
"width": 0,
"height": 0,
"upc": "string",
"mpn": "string",
"attributes": [
{
"id": null,
"purchaseOrderItemId": null,
"key": null,
"value": null
}
],
"bundleComponents": [
{
"purchaseOrderItemId": null,
"orderItemBundleComponentId": null
}
],
"lineItemNumber": 0,
"binLocation": "string",
"subtotal": "string"
}
],
"shipments": [
{
"id": 0,
"note": "string",
"trackingUrl": "string",
"trackingNumber": "string",
"carrier": "string",
"method": "string",
"shippedAt": "2026-04-20T00:00:00Z",
"insertedAt": "2026-04-20T00:00:00Z",
"shippingCost": 0,
"orderId": 0,
"purchaseOrderId": 0,
"fulfillmentRequestId": 0,
"rmaId": 0,
"sourceId": 0,
"accountId": 0,
"partial": true,
"suppressed": true,
"syncedToChannel": true,
"syncError": "string",
"crossDockPurchaseOrderId": 0,
"shipmentItems": [
{
"id": null,
"sku": null,
"quantity": null,
"shipmentId": null,
"inventoryVariantId": null,
"partial": null,
"orderItemId": null,
"purchaseOrderItemId": null,
"fulfillmentRequestItemId": null,
"committedStockReleasedQuantity": null,
"rmaItemId": null,
"customFields": null
}
],
"customFields": [
{
"id": null,
"name": null,
"value": null
}
],
"updatedAt": "2026-04-20T00:00:00Z",
"accountingSynced": true
}
],
"invoices": [
{
"id": 0,
"invoiceStatus": {
"name": "Unpaid",
"handle": "unpaid"
},
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"purchaseOrderId": 0,
"fulfillmentRequestId": 0,
"rmaId": 0,
"sourceId": 0,
"purchaseOrderNumber": "string",
"fulfillmentRequestNumber": "string",
"invoiceNumber": "string",
"invoiceDate": "2026-04-20T00:00:00Z",
"totalCost": 0,
"totalProductCost": 0,
"totalShippingCost": 0,
"totalFeeCost": 0,
"totalTaxCost": 0,
"totalOtherCost": 0,
"totalQuantity": 0,
"accountingSynced": true,
"accountingSyncError": "string",
"externalAccountingId": "string",
"invoiceItems": [
{
"id": null,
"invoiceId": null,
"invoiceItemType": null,
"sourceVariantId": null,
"cost": null,
"sku": null,
"title": null,
"quantity": null,
"perUnitCost": null,
"externalAccountingItemId": null,
"customFields": null
}
],
"totalCreditCost": 0,
"customFields": [
{
"id": null,
"name": null,
"value": null
}
],
"commission": 0,
"vendorPayoutId": 0
}
],
"purchaseOrderAttributes": [
{
"id": 0,
"purchase_order_id": 0,
"key": "string",
"value": "string"
}
],
"purchaseOrderType": {
"id": 1,
"name": "Purchase Order",
"abbreviation": "PO",
"handle": "purchase_order"
},
"shippingAddressId": 0,
"billingAddressId": 0,
"sourceShippingMethodId": 0,
"shippingDistance": 0,
"purchaseOrderReceivedStatus": {
"handle": "awaiting_to_receive"
},
"carrierCode": "string",
"methodCode": "string",
"purchaseOrderPackage": {
"id": 0,
"purchaseOrderId": 0,
"rateId": "string",
"shipFromAddress": {
"id": 0,
"name": "Joe Smith",
"addressLine1": "120 1st Lane",
"addressLine2": "Suite 123",
"city": "Jacksonville",
"state": "Florida",
"country": "United States",
"stateCode": "FL",
"countryCode": "US",
"postal": "12345",
"email": "person@example.com",
"phone": "1-555-123-4567",
"companyName": "string",
"firstName": "Joe",
"lastName": "Smith",
"redacted": true,
"hash": "string"
},
"shipToAddress": {
"id": 0,
"name": "Joe Smith",
"addressLine1": "120 1st Lane",
"addressLine2": "Suite 123",
"city": "Jacksonville",
"state": "Florida",
"country": "United States",
"stateCode": "FL",
"countryCode": "US",
"postal": "12345",
"email": "person@example.com",
"phone": "1-555-123-4567",
"companyName": "string",
"firstName": "Joe",
"lastName": "Smith",
"redacted": true,
"hash": "string"
},
"createShipmentPostProcessing": true,
"updateShipmentOnPurchase": true,
"shippingDate": "2026-04-20T00:00:00Z",
"length": 0,
"width": 0,
"height": 0,
"dimensionUnit": {
"handle": "inch",
"abbreviatedHandle": "in"
},
"totalWeight": 0,
"weightUnit": {
"handle": "pound",
"abbreviatedHandle": "lb"
},
"shippingCarrierMethod": {
"id": 0,
"shippingCarrier": {
"id": 0,
"name": "string",
"handle": "string",
"shipEngineSupported": true
},
"name": "string",
"handle": "string"
},
"rateShoppingProvider": {
"id": 0,
"name": "string",
"handle": "string",
"supportsLabelGeneration": true
},
"rateShoppingProviderLabelSize": "4x6",
"commonPackage": {
"id": 0,
"length": 0,
"width": 0,
"height": 0,
"dimensionUnit": {
"handle": "inch",
"abbreviatedHandle": "in"
},
"weight": 0,
"weightUnit": {
"handle": "pound",
"abbreviatedHandle": "lb"
}
},
"customPackage": {
"id": 0,
"name": "string",
"length": 0,
"width": 0,
"height": 0,
"dimensionUnit": {
"handle": "inch",
"abbreviatedHandle": "in"
},
"weight": 0,
"weightUnit": {
"handle": "pound",
"abbreviatedHandle": "lb"
},
"createdAt": "2026-04-20T00:00:00Z",
"createdByUserEmail": "string",
"updatedAt": "2026-04-20T00:00:00Z"
},
"items": [
{
"id": 0,
"purchaseOrderPackageId": 0,
"purchaseOrderItemId": 0,
"quantity": 0
}
]
},
"buyShippingLabel": true,
"orderFFL": {
"id": 0,
"orderId": 0,
"crossDockPurchaseOrderId": 0,
"licenseNumber": "string",
"name": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postal": "string",
"phone": "string",
"imageUrl": "string",
"expiresAt": "2026-04-20T00:00:00Z",
"companyName": "string"
},
"totalWeight": 0,
"attachmentLinks": [
"string"
],
"shippingLabelAttachmentLink": "string",
"packingSlipAttachmentLink": "string",
"tags": [
"string"
],
"fullyReceivedAt": "2026-04-20T00:00:00Z"
}400Bad Request
No schema documented for this status.
401Unauthorized
No schema documented for this status.
404Not Found
No schema documented for this status.
OpenAPI fragment
{
"post": {
"summary": "[Deprecated] Adjust Purchase Order",
"description": "This endpoint allows for partial acknowledgements and/or cancellations by specifying items.",
"parameters": [],
"requestBody": {
"description": "Pass a null or empty value for `items` to acknowledge all PO Line item quantities which are not already acknowledged/canceled. Secondary Acknowledgements will not be updated when omitting line items.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PurchaseOrderAcknowledgementRequest"
},
"examples": {}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PurchaseOrder"
}
}
}
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not Found"
}
}
}
}Ready to run it? Send the curl from your terminal or Postman, or use the interactive tester in Stoplight.Open in Stoplight