Get Orders
get
https://api.flxpoint.com/ordersUse this when you want to pull 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 will retrieve back Orders
Request
Query parameters
pagequeryintegerpage number
pageSizequeryintegernumber of elements per page
channelIdqueryintegerID of the Channel. This will be default applied for Channel API Tokens
orderedAfterquerystring (date-time)Only returns Orders that have been ordered after this time.
sinceIdqueryinteger (int64)If passed, returns results with an id greater than this
hasTagquerystringOnly returns Orders that have the matching tag
idsqueryarray[integer]Finds elements matching these IDs. Max 50
orderNumbersqueryarray[string]Finds records matching these Order Numbers. Max 50
referenceNumbersqueryarray[string]Finds records matching these Reference Numbers. Max 50
statusquerystringOnly returns Orders that have the matching status.
allowedOpenClosedOn HoldFailedNo Shipping MethodCanceledNot ManagedshipmentStatusquerystringOnly returns Orders that have the matching shipment status
allowedNot StartedPartially CompletedCompletedchannelInvoiceStatusquerystringOnly returns Orders that have the matching channel invoice status.
allowedNot AuthorizedAuthorizedPaidDeferredRefundedCreditedAwaiting ClearanceDeclinedRefund PendingRefund FailedpaymentStatusqueryarray[any]Only returns Orders that match one of the input payment statuses.
accountingSyncedquerybooleanFilters based on whether or not order accounting is synced
includeShippingPolicyquerybooleanDetermines if "shipping policy" is returned in the response
includeChannelShippingMethodquerybooleanDetermines if "channel shipping method" is returned in the response
includeChannelInvoicequerybooleanDetermines if "channel invoice" is returned in the response
includePosquerybooleanDetermines if "purchase orders" are returned in the response. Only applicable if using an account token type. Will never be included for channel token types.
includeShipmentsquerybooleanDetermines if "shipments" are returned in the response.
hasShipmentsquerybooleanFilters orders based on whether or not they have at least one shipment.
shipmentSyncedToChannelquerybooleanFilters returned "shipments" based on whether or not they have been synced to the channel. If this is passed as true, both "includeShipments" and "isShipped" will be set to true.
shipmentSuppressedquerybooleanFilters returned "shipments" based on whether or not they have been suppressed. If this is passed as true, both "includeShipments" and "isShipped" will be set to true.
shipmentHasErrorquerybooleanFilters returned "shipments" based on whether or not they have been they had an error saved when syncing to the channel. If this is passed as true, both "includeShipments" and "isShipped" will be set to true.
includeSourceInvoicesquerybooleanDetermines if "source invoices" are returned in the response. Only applicable if using an account token type. Will never be included for channel token types.
includeStatusHistoryquerybooleanDetermines if "order status history" are returned in the response
includeTagsquerybooleanDetermines if "tags" are returned in the response
includeFFLquerybooleanDetermines if "Order FFL" (if available) is included in the response
includeReturnsquerybooleanDetermines if "Order returns" are returned in the response.
updatedAfterquerystring (date-time)Only returns Orders that have been updated after this time
includeCancelledOrdersquerybooleanInclude cancelled orders in the response.
allocationStatusquerystringFilter on Allocation Status
allowedNot StartedPartially CompletedCompletedshipmentAccountingSyncedquerybooleanShipment Accounting Synced Filter
orderModifiedAfterquerystring (date-time)Only show orders where the order or any of its sub-components have been modified after this time. (Please see the modifiedAt field of the order object for a list of all sub-components)
Example request
get
/orderscurl -X GET "https://api.flxpoint.com/orders" \
-H "Accept: application/json" \
-H "X-API-TOKEN: YOUR_TOKEN"Responses
200OKapplication/json
array[Order]
idintegerorderNumberstringreferenceNumberstringorderTotalnumbernotestringimportedFromintegerorderedAtstring (date-time)insertedAtstring (date-time)updatedAtstring (date-time)shippingTextstringacknowledgedStatusCompletionStatusallowed
Not StartedPartially CompletedCompletedshippedStatusCompletionStatusallowed
Not StartedPartially CompletedCompletedorderStatusOrderStatusallowed
OpenClosedOn HoldFailedNo Shipping MethodCanceledNot ManagedDraftshippingAddressobjectidintegernamestringField 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.
dealerAddressobjectidintegernamestringField 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.
channelIdintegerresellerobjectidintegeraccountIdintegeremailstringbillingAddressIdintegerchannelIdintegeraccountDealerStatusIdintegertotalOrdersintegertotalSpentnumberlastOrderOnstring (date-time)firstNamestringlastNamestringinsertedAtstring (date-time)companyNamestringphonestringdealerGroupIdintegercreditAvailablenumbercreditUsednumbertaxIdstringexternalIdstringwebsitestringapiTokenEnabledStateBeforeAccountLockbooleanreleasedbooleanaccountIdintegerpaymentStatusPaymentStatusallowed
Not AuthorizedAuthorizedPaidDeferredRefundedCreditedAwaiting ClearanceDeclinedRefund PendingRefund FailedallocatedStatusCompletionStatusallowed
Not StartedPartially CompletedCompletedcanceledAtstring (date-time)totalOrderItemsintegerdefault
0totalQuantityintegerdefault
0totalWeightnumberpaymentRefundStatusPaymentRefundStatusallowed
NonePartiallyFullypaymentCreditStatusPaymentRefundStatusallowed
NonePartiallyFullypurchaseOrderStatusCompletionStatusallowed
Not StartedPartially CompletedCompletedpurchaseOrderProcessStatusCompletionStatusallowed
Not StartedPartially CompletedCompletedpurchaseOrderFailedStatusCompletionStatusallowed
Not StartedPartially CompletedCompletedpurchaseOrderCanceledStatusCompletionStatusallowed
Not StartedPartially CompletedCompletedpurchaseOrderVoidedStatusCompletionStatusallowed
Not StartedPartially CompletedCompletedpaymentDeferredAtstring (date-time)paymentDeferredUntilstring (date-time)channelInvoiceReceiptQueuedIdstringchannelShippingMethodobjectidintegerchannelIdintegernamestringshippingPolicyIdintegerdeletedAtstring (date-time)totalPosintegerdefault
0shippingPolicyobjectidintegernamestringrequireddeletedAtstring (date-time)poTotalCostnumbersourceInvoiceTotalCostnumberprofitAmountnumberprofitMarginnumbersourceInvoiceStatusCompletionStatusallowed
Not StartedPartially CompletedCompletedaccountingSyncedbooleanexternalAccountingIdstringpiiRetentionPolicyTypeobjecthandlestringallowed
30_days_after_shipment60_days_after_shipment90_days_after_shipmentnonenamestringallowed
30 days After Shipment60 days After Shipment90 days After ShipmentIndefinitelypiiRetentionPolicyAppliedbooleanorderItemsarray[OrderItem]idintegerskustringquantityintegerrequiredcostnumberpricenumberdiscountnumbersubtotalnumberacknowledgedQuantityintegerdefault
0shippedQuantityintegerdefault
0orderIdintegershippedStatusCompletionStatusallowed
Not StartedPartially CompletedCompletedacknowledgedStatusCompletionStatusallowed
Not StartedPartially CompletedCompletedtitlestringweightnumberimagestringallocatedQuantityintegerdefault
0allocatedStatusCompletionStatusallowed
Not StartedPartially CompletedCompletedorderedQuantityintegerdefault
0virtualVariantIdintegerlistingVariantIdintegerexternalListingIdstringexternalOrderItemIdstringexternalAccountingItemIdstringbundlebooleanweightUnitobjecthandlestringallowed
poundouncegramkilogramabbreviatedHandlestringallowed
lbozgkgnotShippablebooleanbundleComponentsarray[OrderItemBundleComponent]idintegerorderItemIdintegercomponentVirtualVariantIdintegercomponentQuantityintegerquantityintegerrequiredskustringcostnumbershippedQuantityintegershippedStatusCompletionStatusallowed
Not StartedPartially CompletedCompletedallocatedQuantityintegerallocatedStatusCompletionStatusallowed
Not StartedPartially CompletedCompletedacknowledgedQuantityintegeracknowledgedStatusCompletionStatusallowed
Not StartedPartially CompletedCompletedattributesarray[OrderItemAttribute]requiredidintegerorderItemIdintegerkeystringvaluestringrestockingInventoryVariantIdinteger (int64)canceledQuantityintegerdefault
0fulfillableQuantityintegerdefault
0returnedQuantityintegerdefault
0usingProductAlternativebooleanSignifies whether the item has been replaced.
default
falseshippingAddressobjectidintegernamestringField 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.
externalAccountingItemMappingbooleanshipByDatestring (date)The date by which this line item must be shipped.
purchaseOrdersarray[PurchaseOrder]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.
idintegershippingCarrierShippingCarriernamestringhandlestringuseBestFitPackagebooleanUse 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.
dimensionUnitDimensionUnitweightnumberThe weight of the package itself (excluding any contents).
weightUnitWeightUnitcustomPackagesarray[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.
dimensionUnitDimensionUnitweightnumberThe weight of the package itself (excluding any contents).
weightUnitWeightUnitcreatedAtstring (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]bundleComponentsarray[PurchaseOrderItemBundleComponent]lineItemNumberintegerbinLocationstringsubtotalstringshipmentsarray[Shipment]idintegernotestringtrackingUrlstringtrackingNumberstringcarrierstringmethodstringshippedAtstring (date-time)insertedAtstring (date-time)shippingCostnumberorderIdintegerpurchaseOrderIdintegerfulfillmentRequestIdintegerrmaIdintegersourceIdintegeraccountIdintegerpartialbooleansuppressedbooleansyncedToChannelbooleansyncErrorstringcrossDockPurchaseOrderIdintegershipmentItemsarray[ShipmentItem]customFieldsarray[ShipmentCustomField]updatedAtstring (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]totalCreditCostnumbercustomFieldsarray[Source Invoice Custom Field]commissionnumberdeprecatedvendorPayoutIdintegerpurchaseOrderAttributesarray[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.
fulfillmentRequestsarray[FulfillmentRequest]idintegerA unique identifier for the fulfillment request.
fulfillmentRequestNumberstringorderIdintegerThe unique identifier for the order associated with the fulfillment request. This field is used to link the fulfillment request to the specific order that it is fulfilling. The orderId can be used to retrieve information about the order, such as the customer information, the items purchased, and the shipping address. It can also be used to track the status of the order and its associated fulfillment requests.
sentAtstring (date-time) The date and time when it was sent to the supplier
sourceIdintegerUnique identifier of the source which will fulfill this Fulfillment Request.
acknowledgedAtstring (date-time)The acknowledgedAt field refers to the date and time when a vendor or supplier that is responsible for fulfilling the order has acknowledged or accepted the fulfillment request.
secondaryAcknowledgedAtstring (date-time)canceledAtstring (date-time)The date and time when the fulfillment request was canceled.
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
confirmationNumberstringA unique identifier returned from the source for indicating receipt and identifying the Fulfillment Request once it has been processed and acknowledged on their side.
shippedStatusCompletionStatusallowed
Not StartedPartially CompletedCompletedfulfillmentRequestStatusobjectnamestringallowed
UnprocessedProcessedAcknowledgedCanceledVoidedProcessingAdditional Info RequiredTransferredPO/FR # Exceeds Max LengthDuplicate PO/FR #Processing ErrorCross DockedFulfillment Request # Exceeds Max LengthDuplicate Fulfillment Request #handlestringallowed
unprocessedprocessedacknowledgedcanceledvoidedprocessingadditional_info_requiredtransferredpo_number_exceeds_max_lengthduplicateprocessing_errorcross_dockedfulfillmentRequestFulfillmentStatusobjectnamestringallowed
Awaiting ShipmentShippedPartially ShippedCanceledhandlestringallowed
awaiting_shipmentshippedpartially_shippedcanceledgeneratedAtstring (date-time)The date and time when this Fulfillment Request was generated.
voidedAtstring (date-time)The date and time when this Fulfillment Request was voided.
accountIdintegerdeprecatedtotalItemsintegerTotal Number of Fulfillment Request Items.
totalCostnumberTotal cost of the Fulfillment Request Items
totalQuantityinteger Total quantity of the Fulfillment Request Items.
shippedQuantityintegerTotal quantity of the Fulfillment Request Items that has been shipped.
estimatedShippingCostnumberestimatedDropshipFeenumbersourceShippingMethodobject<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.
idintegershippingCarrierShippingCarriernamestringhandlestringuseBestFitPackagebooleanUse 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.
dimensionUnitDimensionUnitweightnumberThe weight of the package itself (excluding any contents).
weightUnitWeightUnitcustomPackagesarray[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.
dimensionUnitDimensionUnitweightnumberThe weight of the package itself (excluding any contents).
weightUnitWeightUnitcreatedAtstring (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).
suppressTrackingbooleanIndicates whether or not tracking information should be suppressed for the associated fulfillment request. If this field is set to true, it means that tracking information for the fulfillment request will not be synced to the channel from where the order originated.
beingProcessedbooleantotalSourceInvoicesintegerfflInfoRequiredbooleanlastModifiedAtstring (date-time)accountingSyncedbooleanexternalAccountingIdstringholdUntilstring (date-time)rateShoppedIdstringpackageDimensionUnitobjecthandlestringallowed
inchcentimeterabbreviatedHandlestringallowed
incmpackageLengthnumberpackageWidthnumberpackageHeightnumberpackageWeightUnitobjecthandlestringallowed
poundouncegramkilogramabbreviatedHandlestringallowed
lbozgkgpackageWeightnumberchannelIdintegercrossDockPurchaseOrderIdintegerThe unique identifier for the Cross Dock Purchase Order associated with the Fulfillment Request. A Cross Dock Purchase Order is used to consolidate multiple FRs across a single or multiple orders into a single FR for fulfilling from a single source.
voidedReasonstring The reason why the Fulfillment Request was voided.
processingErrorReasonstringThe reason this purchase order could not be processed
cancelReasonstringThe reason why the Fulfillment Request was canceled.
fulfillmentRequestItemsarray[FulfillmentRequestItem]idintegerskustringquantityintegercostnumberitemReferenceIdstringreferenceIdstringfulfillmentRequestIdintegershippedQuantityintegerdefault
0voidedQuantityintegerdefault
0acknowledgedQuantityintegerdefault
0secondaryAcknowledgedQuantityintegerdefault
0inventoryVariantIdinteger (int64)orderItemIdintegertitlestringexternalAccountingItemIdstringcanceledQuantityintegerweightUnitobjecthandlestringallowed
poundouncegramkilogramabbreviatedHandlestringallowed
lbozgkgweightnumberdimensionUnitobjecthandlestringallowed
inchcentimeterabbreviatedHandlestringallowed
incmlengthnumberwidthnumberheightnumberupcstringmpnstringattributesarray[FulfillmentRequestItemAttribute]deprecatedDeprecated -- use `customFields` instead.
bundleComponentsarray[FulfillmentRequestItemBundleComponent]lineItemNumberintegercustomFieldsarray[FulfillmentRequestItemAttribute]binLocationstringsubtotalnumbershipmentsarray[Shipment]idintegernotestringtrackingUrlstringtrackingNumberstringcarrierstringmethodstringshippedAtstring (date-time)insertedAtstring (date-time)shippingCostnumberorderIdintegerpurchaseOrderIdintegerfulfillmentRequestIdintegerrmaIdintegersourceIdintegeraccountIdintegerpartialbooleansuppressedbooleansyncedToChannelbooleansyncErrorstringcrossDockPurchaseOrderIdintegershipmentItemsarray[ShipmentItem]customFieldsarray[ShipmentCustomField]updatedAtstring (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]totalCreditCostnumbercustomFieldsarray[Source Invoice Custom Field]commissionnumberdeprecatedvendorPayoutIdintegerfulfillmentRequestAttributesarray[object]deprecatedDeprecated -- use `customFields` instead.
idintegerfulfillmentRequestIdintegerkeystringvaluestringfulfillmentRequestTypeobject"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_ordershippingAddressIdintegerbillingAddressIdintegersourceShippingMethodIdintegershippingDistancenumberfulfillmentRequestReceivedStatusobjecthandlestringallowed
awaiting_to_receivepartially_receivedreceivedvoidedcarrierCodestringmethodCodestringfulfillmentRequestPackageobjectA Fulfillment Request Package contains all metadata needed to buy a shipping label.
idintegerThe ID of the Purchase Order Package.
fulfillmentRequestIdintegerrequiredThe 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 Fulfillment Request 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[FulfillmentRequestPackageItem]Metadata related to the items to be shipped in the package.
idintegerfulfillmentRequestPackageIdintegerfulfillmentRequestItemIdintegerquantityintegerbuyShippingLabelbooleandefault
falseorderFFLobjectidintegerrequiredorderIdintegercrossDockPurchaseOrderIdintegerlicenseNumberstringrequirednamestringaddressLine1stringrequiredaddressLine2stringcitystringstatestringpostalstringphonestringimageUrlstringexpiresAtstring (date-time)companyNamestringtotalWeightnumbercustomFieldsarray[object]idintegerfulfillmentRequestIdintegerkeystringvaluestringattachmentLinksarray[string]A list of URLs containing each file attached to this Fulfillment Request. These include both shipping labels and packing slips.
string
shippingLabelAttachmentLinkstringURL for downloading the Shipping Label for this FR 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 FR (regardless of type).
packingSlipAttachmentLinkstringURL for downloading the Packing Slip for this FR 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 FR (regardless of type).
tagsarray[string]string
fullyReceivedAtstring (date-time)The date and time when this Fulfillment Request was fully received.
orderInvoiceobjectidintegersubtotalnumbertotalnumberdropshipFeenumbershippingCostnumberinvoicedAtstring (date-time)createdAtstring (date-time)paidbooleanrequiredpaidAtstring (date-time)purchaseOrderIdintegerorderIdintegerinvoiceNumberstringauthorizedIpAddressstringcapturedIpAddressstringrefundedAmountnumberrefundedLastAtstring (date-time)refundedNumberOfTimesintegercreditedAmountnumbercreditedLastAtstring (date-time)creditedNumberOfTimesintegercreditAppliedTowardsTotalnumberreceiptSentAtstring (date-time)taxTitlestringtaxCostnumberotherTitlestringotherCostnumbershippingTitlestringdropshipFeeTitlestringdiscountTotalnumberdiscountDescriptionstringorderStatusHistoryarray[OrderStatusHistory]idintegerorderIdintegerrequiredchangeTimestring (date-time)fromOrderStatusOrderStatusrequiredallowed
OpenClosedOn HoldFailedNo Shipping MethodCanceledNot ManagedDrafttoOrderStatusOrderStatusrequiredallowed
OpenClosedOn HoldFailedNo Shipping MethodCanceledNot ManagedDraftuserIdintegerorderHistoryTypeobjectnamestringallowed
Status ChangedSource Invoice AddedShipment AddedPayment Status ChangedAddress ChangedChannel Invoice ChangedShipping Policy ChangedFFL Information ChangedSource Invoice ChangedShipment ChangedOrder SubmittedOrder Not ManagedRoadblock in order fulfillmentShipping Label PurchasedShipping Label VoidedCleared error messagesChannel Invoice PDF GeneratedOrder Line Item AddedOrder Line Item CanceledAdjusted Acknowledged PO Line Item QuantityPacking Slip GeneratedReturn AddedRMA AddedReturn Status ChangedRMA Status ChangedRMA Line Item DeletedReturn To Address UpdatedReturn Destination UpdatedRMA Shipment AddedRMA Shipment Status ChangedRefund Synced to OrderCredit Synced to OrderFulfillment Request Status ChangedFulfillment Request AddedFulfillment Request ChangedFulfillment Request Received Status ChangedClosed Status SyncedOrder Line Item Replacedhandlestringallowed
status_changedsource_invoice_addedshipment_addedpayment_status_changedaddress_changedchannel_invoice_changedshipping_policy_changedffl_info_changedsource_invoice_changedshipment_changedorder_submittedorder_not_managedorder_fulfillment_roadblockshipping_label_purchasedshipping_label_voidedclear_order_errorspo_status_changedpo_addedpurchase_order_changedchannel_invoice_pdf_generatedpo_received_status_changedorder_line_item_addedorder_line_item_canceledadjusted_acknowledged_quantitypacking_slip_generatedreturn_addedrma_addedreturn_status_changedrma_status_changedrma_line_item_deletedreturn_to_address_updatedreturn_destination_updatedrma_shipment_addedrma_shipment_status_changedrefund_synced_to_ordercredit_synced_to_orderclosed_status_syncedorder_line_item_replacednotestringchangeByDealerbooleanvendorUserIdintegersourceIdintegerorderInteractionTypeobjectnamestringallowed
Source APIChannel APIDealer APIDealer PortalVendor PortalSource IntegrationChannel IntegrationUserSource API via OceanXSource API via DuoplaneAPISystemhandlestringallowed
source_apichannel_apidealer_apidealer_portalvendor_portalsource_integrationchannel_integrationuseroceanxduoplaneapisystemtagsarray[string]string
attributesarray[OrderAttribute]idintegerorderIdintegerkeystringvaluestringsourceIdintegerorderFFLobjectidintegerrequiredorderIdintegercrossDockPurchaseOrderIdintegerlicenseNumberstringrequirednamestringaddressLine1stringrequiredaddressLine2stringcitystringstatestringpostalstringphonestringimageUrlstringexpiresAtstring (date-time)companyNamestringreturnsarray[ReturnModel]idintegerorderIdintegerreturnNumberstringaccountIdintegertotalReturnItemsintegertotalRmasintegerchannelIdintegeritemsarray[ReturnItem]idintegerreturnIdintegerorderItemIdintegerskustringreturnQuantityintegerreturnReasonstringreturnConditionstringsalesPricenumbertitlestringrefundedAmountnumberbundleComponentsarray[OrderItemBundleComponent]rmasarray[Rma]idintegerreturnIdintegersourceIdintegerrmaNumberstringaccountIdintegerreturnToAddressobjectidintegernamestringField 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.
itemsarray[RmaItem]totalRmaItemsintegercreatedAtstring (date-time)updatedAtstring (date-time)rmaStatusRmaStatusallowed
WaitingApprovedVoidedDeniedPartially ApprovedCanceledrmaShipmentsarray[RmaShipment]creditSubtotalnumbercreditAdjustmentnumbercreditTotalnumbercreditLastSyncedAtstring (date-time)syncCreditChangesToOrderbooleanshipmentReceivedStatusShipmentReceivedStatusallowed
not_receivedpartially_receivedfully_receivedaccountingSyncedAtstring (date-time)accountingErrorstringreturnTotalnumberstatusReturnStatusallowed
openclosedcancelledupdatedAtstring (date-time)insertedAtstring (date-time)refundAdjustmentnumberrefundSubtotalnumbersum of refunded_amount for all return_items on the return
refundTotalnumberrefundSubtotal + refundAdjustment
refundLastSyncedAtstring (date-time)syncRefundChangesToOrderbooleanshipmentReceivedStatusShipmentReceivedStatusallowed
not_receivedpartially_receivedfully_receivedpoLogsarray[PurchaseOrderLog]typestringrequiredallowed
infowarnsuccesserrorsnapshotmessagestringrequiredpositionintegerorderIdintegerjsonstringtotalReturnsintegerorderTypeOrderTypeallowed
OnlinePOSManualdefault
"Online"fulfillmentTypeFulfillmentTypeallowed
ShippingIn-Store Purchasedefault
"Shipping"syncedClosedAtstring (date-time)resellerIdintegerorderCommentsarray[OrderComment]idintegeremailstringcommentstringrequiredinsertedAtstring (date-time)orderIdintegerrequiredaccountingSyncErrorstringshippingPolicyIdintegermodifiedAtstring (date-time)The timestamp of the last time this order or any of its sub-components have been modified. Sub-components include :
Line Items
FFL
Shipping Address
Billing Address
FR/PR/SPO/TO
Shipments
Source Invoices
Returns
RMAs
Example response
[
{
"id": 0,
"orderNumber": "string",
"referenceNumber": "string",
"orderTotal": 0,
"note": "string",
"importedFrom": 0,
"orderedAt": "2026-04-20T00:00:00Z",
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"shippingText": "string",
"acknowledgedStatus": "Not Started",
"shippedStatus": "Not Started",
"orderStatus": "Open",
"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"
},
"dealerAddress": {
"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"
},
"channelId": 0,
"reseller": {
"id": 0,
"accountId": 0,
"email": "string",
"billingAddressId": 0,
"channelId": 0,
"accountDealerStatusId": 0,
"totalOrders": 0,
"totalSpent": 0,
"lastOrderOn": "2026-04-20T00:00:00Z",
"firstName": "string",
"lastName": "string",
"insertedAt": "2026-04-20T00:00:00Z",
"companyName": "string",
"phone": "string",
"dealerGroupId": 0,
"creditAvailable": 0,
"creditUsed": 0,
"taxId": "string",
"externalId": "string",
"website": "string",
"apiTokenEnabledStateBeforeAccountLock": true
},
"released": true,
"accountId": 0,
"paymentStatus": "Not Authorized",
"allocatedStatus": "Not Started",
"canceledAt": "2026-04-20T00:00:00Z",
"totalOrderItems": 0,
"totalQuantity": 0,
"totalWeight": 0,
"paymentRefundStatus": "None",
"paymentCreditStatus": "None",
"purchaseOrderStatus": "Not Started",
"purchaseOrderProcessStatus": "Not Started",
"purchaseOrderFailedStatus": "Not Started",
"purchaseOrderCanceledStatus": "Not Started",
"purchaseOrderVoidedStatus": "Not Started",
"paymentDeferredAt": "2026-04-20T00:00:00Z",
"paymentDeferredUntil": "2026-04-20T00:00:00Z",
"channelInvoiceReceiptQueuedId": "string",
"channelShippingMethod": {
"id": 0,
"channelId": 0,
"name": "string",
"shippingPolicyId": 0,
"deletedAt": "2026-04-20T00:00:00Z"
},
"totalPos": 0,
"shippingPolicy": {
"id": 0,
"name": "string",
"deletedAt": "2026-04-20T00:00:00Z"
},
"poTotalCost": 0,
"sourceInvoiceTotalCost": 0,
"profitAmount": 0,
"profitMargin": 0,
"sourceInvoiceStatus": "Not Started",
"accountingSynced": true,
"externalAccountingId": "string",
"piiRetentionPolicyType": {
"handle": "30_days_after_shipment",
"name": "30 days After Shipment"
},
"piiRetentionPolicyApplied": true,
"orderItems": [
{
"id": 0,
"sku": "string",
"quantity": 0,
"cost": 0,
"price": 0,
"discount": 0,
"subtotal": 0,
"acknowledgedQuantity": 0,
"shippedQuantity": 0,
"orderId": 0,
"shippedStatus": "Not Started",
"acknowledgedStatus": "Not Started",
"title": "string",
"weight": 0,
"image": "string",
"allocatedQuantity": 0,
"allocatedStatus": "Not Started",
"orderedQuantity": 0,
"virtualVariantId": 0,
"listingVariantId": 0,
"externalListingId": "string",
"externalOrderItemId": "string",
"externalAccountingItemId": "string",
"bundle": true,
"weightUnit": {
"handle": null,
"abbreviatedHandle": null
},
"notShippable": true,
"bundleComponents": [
null
],
"attributes": [
null
],
"restockingInventoryVariantId": 0,
"canceledQuantity": 0,
"fulfillableQuantity": 0,
"returnedQuantity": 0,
"usingProductAlternative": true,
"shippingAddress": {
"id": null,
"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": null,
"firstName": "Joe",
"lastName": "Smith",
"redacted": null,
"hash": null
},
"externalAccountingItemMapping": true,
"shipByDate": "2026-04-20"
}
],
"purchaseOrders": [
{
"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": null,
"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": null,
"firstName": "Joe",
"lastName": "Smith",
"redacted": null,
"hash": null
},
"billingAddress": {
"id": null,
"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": null,
"firstName": "Joe",
"lastName": "Smith",
"redacted": null,
"hash": null
},
"shippingText": "string",
"note": "string",
"confirmationNumber": "string",
"shippedStatus": "Not Started",
"purchaseOrderStatus": {
"name": null,
"handle": null
},
"purchaseOrderFulfillmentStatus": {
"name": null,
"handle": null
},
"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": null,
"sourceId": null,
"description": null,
"carrier": null,
"method": null,
"shippingCode": null,
"shippingPolicy": null,
"deletedAt": null,
"shippingCarrier": null,
"shippingCarrierMethod": null,
"shippingLabelCode": null,
"defaultCarrierCode": null,
"defaultMethodCode": null,
"overrideDefaultCodes": null,
"filterCarriersAndMethods": null,
"shippingCarriers": null,
"shippingCarrierMethods": null,
"useBestFitPackage": null,
"commonPackages": null,
"customPackages": null
},
"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": null,
"abbreviatedHandle": null
},
"packageLength": 0,
"packageWidth": 0,
"packageHeight": 0,
"packageWeightUnit": {
"handle": null,
"abbreviatedHandle": null
},
"packageWeight": 0,
"channelId": 0,
"crossDockPurchaseOrderId": 0,
"voidedReason": "string",
"processingErrorReason": "string",
"cancelReason": "string",
"purchaseOrderItems": [
null
],
"shipments": [
null
],
"invoices": [
null
],
"purchaseOrderAttributes": [
null
],
"purchaseOrderType": {
"id": null,
"name": null,
"abbreviation": null,
"handle": null
},
"shippingAddressId": 0,
"billingAddressId": 0,
"sourceShippingMethodId": 0,
"shippingDistance": 0,
"purchaseOrderReceivedStatus": {
"handle": null
},
"carrierCode": "string",
"methodCode": "string",
"purchaseOrderPackage": {
"id": null,
"purchaseOrderId": null,
"rateId": null,
"shipFromAddress": null,
"shipToAddress": null,
"createShipmentPostProcessing": null,
"updateShipmentOnPurchase": null,
"shippingDate": null,
"length": null,
"width": null,
"height": null,
"dimensionUnit": null,
"totalWeight": null,
"weightUnit": null,
"shippingCarrierMethod": null,
"rateShoppingProvider": null,
"rateShoppingProviderLabelSize": null,
"commonPackage": null,
"customPackage": null,
"items": null
},
"buyShippingLabel": true,
"orderFFL": {
"id": null,
"orderId": null,
"crossDockPurchaseOrderId": null,
"licenseNumber": null,
"name": null,
"addressLine1": null,
"addressLine2": null,
"city": null,
"state": null,
"postal": null,
"phone": null,
"imageUrl": null,
"expiresAt": null,
"companyName": null
},
"totalWeight": 0,
"attachmentLinks": [
null
],
"shippingLabelAttachmentLink": "string",
"packingSlipAttachmentLink": "string",
"tags": [
null
],
"fullyReceivedAt": "2026-04-20T00:00:00Z"
}
],
"fulfillmentRequests": [
{
"id": 0,
"fulfillmentRequestNumber": "string",
"orderId": 0,
"sentAt": "2023-04-25T13:56:22.014Z",
"sourceId": 0,
"acknowledgedAt": "2023-04-25T13:56:22.014Z",
"secondaryAcknowledgedAt": "2026-04-20T00:00:00Z",
"canceledAt": "2023-04-25T13:56:22.014Z",
"shippingAddress": {
"id": null,
"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": null,
"firstName": "Joe",
"lastName": "Smith",
"redacted": null,
"hash": null
},
"billingAddress": {
"id": null,
"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": null,
"firstName": "Joe",
"lastName": "Smith",
"redacted": null,
"hash": null
},
"shippingText": "string",
"note": "string",
"confirmationNumber": "string",
"shippedStatus": "Not Started",
"fulfillmentRequestStatus": {
"name": null,
"handle": null
},
"fulfillmentRequestFulfillmentStatus": {
"name": null,
"handle": null
},
"generatedAt": "2023-04-25T13:56:22.014Z",
"voidedAt": "2023-04-25T13:56:22.014Z",
"accountId": 0,
"totalItems": 0,
"totalCost": 0,
"totalQuantity": 0,
"shippedQuantity": 0,
"estimatedShippingCost": 0,
"estimatedDropshipFee": 0,
"sourceShippingMethod": {
"id": null,
"sourceId": null,
"description": null,
"carrier": null,
"method": null,
"shippingCode": null,
"shippingPolicy": null,
"deletedAt": null,
"shippingCarrier": null,
"shippingCarrierMethod": null,
"shippingLabelCode": null,
"defaultCarrierCode": null,
"defaultMethodCode": null,
"overrideDefaultCodes": null,
"filterCarriersAndMethods": null,
"shippingCarriers": null,
"shippingCarrierMethods": null,
"useBestFitPackage": null,
"commonPackages": null,
"customPackages": null
},
"suppressTracking": true,
"beingProcessed": true,
"totalSourceInvoices": 0,
"fflInfoRequired": true,
"lastModifiedAt": "2023-04-25T13:56:22.014Z",
"accountingSynced": true,
"externalAccountingId": "string",
"holdUntil": "2026-04-20T00:00:00Z",
"rateShoppedId": "string",
"packageDimensionUnit": {
"handle": null,
"abbreviatedHandle": null
},
"packageLength": 0,
"packageWidth": 0,
"packageHeight": 0,
"packageWeightUnit": {
"handle": null,
"abbreviatedHandle": null
},
"packageWeight": 0,
"channelId": 0,
"crossDockPurchaseOrderId": 0,
"voidedReason": "string",
"processingErrorReason": "string",
"cancelReason": "string",
"fulfillmentRequestItems": [
null
],
"shipments": [
null
],
"invoices": [
null
],
"fulfillmentRequestAttributes": [
null
],
"fulfillmentRequestType": {
"id": null,
"name": null,
"abbreviation": null,
"handle": null
},
"shippingAddressId": 0,
"billingAddressId": 0,
"sourceShippingMethodId": 0,
"shippingDistance": 0,
"fulfillmentRequestReceivedStatus": {
"handle": null
},
"carrierCode": "string",
"methodCode": "string",
"fulfillmentRequestPackage": {
"id": null,
"fulfillmentRequestId": null,
"rateId": null,
"shipFromAddress": null,
"shipToAddress": null,
"createShipmentPostProcessing": null,
"updateShipmentOnPurchase": null,
"shippingDate": null,
"length": null,
"width": null,
"height": null,
"dimensionUnit": null,
"totalWeight": null,
"weightUnit": null,
"shippingCarrierMethod": null,
"rateShoppingProvider": null,
"rateShoppingProviderLabelSize": null,
"commonPackage": null,
"customPackage": null,
"items": null
},
"buyShippingLabel": true,
"orderFFL": {
"id": null,
"orderId": null,
"crossDockPurchaseOrderId": null,
"licenseNumber": null,
"name": null,
"addressLine1": null,
"addressLine2": null,
"city": null,
"state": null,
"postal": null,
"phone": null,
"imageUrl": null,
"expiresAt": null,
"companyName": null
},
"totalWeight": 0,
"customFields": [
null
],
"attachmentLinks": [
null
],
"shippingLabelAttachmentLink": "string",
"packingSlipAttachmentLink": "string",
"tags": [
null
],
"fullyReceivedAt": "2026-04-20T00:00:00Z"
}
],
"orderInvoice": {
"id": 0,
"subtotal": 0,
"total": 0,
"dropshipFee": 0,
"shippingCost": 0,
"invoicedAt": "2026-04-20T00:00:00Z",
"createdAt": "2026-04-20T00:00:00Z",
"paid": true,
"paidAt": "2026-04-20T00:00:00Z",
"purchaseOrderId": 0,
"orderId": 0,
"invoiceNumber": "string",
"authorizedIpAddress": "string",
"capturedIpAddress": "string",
"refundedAmount": 0,
"refundedLastAt": "2026-04-20T00:00:00Z",
"refundedNumberOfTimes": 0,
"creditedAmount": 0,
"creditedLastAt": "2026-04-20T00:00:00Z",
"creditedNumberOfTimes": 0,
"creditAppliedTowardsTotal": 0,
"receiptSentAt": "2026-04-20T00:00:00Z",
"taxTitle": "string",
"taxCost": 0,
"otherTitle": "string",
"otherCost": 0,
"shippingTitle": "string",
"dropshipFeeTitle": "string",
"discountTotal": 0,
"discountDescription": "string"
},
"orderStatusHistory": [
{
"id": 0,
"orderId": 0,
"changeTime": "2026-04-20T00:00:00Z",
"fromOrderStatus": "Open",
"toOrderStatus": "Open",
"userId": 0,
"orderHistoryType": {
"name": null,
"handle": null
},
"note": "string",
"changeByDealer": true,
"vendorUserId": 0,
"sourceId": 0,
"orderInteractionType": {
"name": null,
"handle": null
}
}
],
"tags": [
"string"
],
"attributes": [
{
"id": 0,
"orderId": 0,
"key": "string",
"value": "string"
}
],
"sourceId": 0,
"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"
},
"returns": [
{
"id": 0,
"orderId": 0,
"returnNumber": "string",
"accountId": 0,
"totalReturnItems": 0,
"totalRmas": 0,
"channelId": 0,
"items": [
null
],
"rmas": [
null
],
"returnTotal": 0,
"status": "open",
"updatedAt": "2026-04-20T00:00:00Z",
"insertedAt": "2026-04-20T00:00:00Z",
"refundAdjustment": 0,
"refundSubtotal": 0,
"refundTotal": 0,
"refundLastSyncedAt": "2026-04-20T00:00:00Z",
"syncRefundChangesToOrder": true,
"shipmentReceivedStatus": "not_received"
}
],
"poLogs": [
{
"type": "info",
"message": "string",
"position": 0,
"orderId": 0,
"json": "string"
}
],
"totalReturns": 0,
"orderType": "Online",
"fulfillmentType": "Shipping",
"syncedClosedAt": "2026-04-20T00:00:00Z",
"resellerId": 0,
"orderComments": [
{
"id": 0,
"email": "string",
"comment": "string",
"insertedAt": "2026-04-20T00:00:00Z",
"orderId": 0
}
],
"accountingSyncError": "string",
"shippingPolicyId": 0,
"modifiedAt": "2026-04-20T00:00:00Z"
}
]400Bad Request
No schema documented for this status.
401Unauthorized
No schema documented for this status.
OpenAPI fragment
{
"get": {
"summary": "Get Orders",
"description": "This endpoint will retrieve back Orders",
"parameters": [
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 1
},
"description": "page number"
},
{
"name": "pageSize",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 50,
"maximum": 100
},
"description": "number of elements per page"
},
{
"schema": {
"type": "integer"
},
"in": "query",
"name": "channelId",
"description": "ID of the Channel. This will be default applied for Channel API Tokens"
},
{
"schema": {
"type": "string",
"format": "date-time",
"example": "2020-10-14T16:05:00.000Z"
},
"in": "query",
"name": "orderedAfter",
"description": "Only returns Orders that have been ordered after this time."
},
{
"name": "sinceId",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int64",
"default": 1
},
"description": "If passed, returns results with an id greater than this"
},
{
"schema": {
"type": "string"
},
"in": "query",
"name": "hasTag",
"description": "Only returns Orders that have the matching tag"
},
{
"schema": {
"type": "array",
"maxItems": 50,
"example": "123,456,789",
"uniqueItems": true,
"items": {
"type": "integer"
}
},
"in": "query",
"name": "ids",
"description": "Finds elements matching these IDs. Max 50",
"style": "form",
"explode": false
},
{
"schema": {
"type": "array",
"maxItems": 50,
"example": "O123,O456,O789",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"in": "query",
"name": "orderNumbers",
"description": "Finds records matching these Order Numbers. Max 50",
"style": "form",
"explode": false
},
{
"schema": {
"type": "array",
"maxItems": 50,
"example": "o55a2f,refABC,sh9339",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"in": "query",
"name": "referenceNumbers",
"description": "Finds records matching these Reference Numbers. Max 50",
"style": "form",
"explode": false
},
{
"schema": {
"type": "string",
"enum": [
"Open",
"Closed",
"On Hold",
"Failed",
"No Shipping Method",
"Canceled",
"Not Managed"
]
},
"in": "query",
"name": "status",
"description": "Only returns Orders that have the matching status."
},
{
"schema": {
"type": "string",
"enum": [
"Not Started",
"Partially Completed",
"Completed"
]
},
"in": "query",
"name": "shipmentStatus",
"description": "Only returns Orders that have the matching shipment status"
},
{
"schema": {
"type": "string",
"enum": [
"Not Authorized",
"Authorized",
"Paid",
"Deferred",
"Refunded",
"Credited",
"Awaiting Clearance",
"Declined",
"Refund Pending",
"Refund Failed"
]
},
"in": "query",
"name": "channelInvoiceStatus",
"description": "Only returns Orders that have the matching channel invoice status."
},
{
"schema": {
"type": "array",
"maxItems": 50,
"example": "O123,O456,O789",
"uniqueItems": true,
"items": {
"enum": [
"Not Authorized",
"Authorized",
"Paid",
"Deferred",
"Refunded",
"Credited",
"Awaiting Clearance",
"Declined",
"Refund Pending",
"Refund Failed"
]
}
},
"in": "query",
"name": "paymentStatus",
"description": "Only returns Orders that match one of the input payment statuses.",
"style": "form",
"explode": false
},
{
"schema": {
"type": "boolean"
},
"in": "query",
"name": "accountingSynced",
"description": "Filters based on whether or not order accounting is synced"
},
{
"schema": {
"type": "boolean",
"default": true
},
"in": "query",
"name": "includeShippingPolicy",
"description": "Determines if \"shipping policy\" is returned in the response"
},
{
"schema": {
"type": "boolean",
"default": true
},
"in": "query",
"name": "includeChannelShippingMethod",
"description": "Determines if \"channel shipping method\" is returned in the response"
},
{
"schema": {
"type": "boolean",
"default": false
},
"in": "query",
"name": "includeChannelInvoice",
"description": "Determines if \"channel invoice\" is returned in the response"
},
{
"schema": {
"type": "boolean",
"default": false
},
"in": "query",
"name": "includePos",
"description": "Determines if \"purchase orders\" are returned in the response. Only applicable if using an account token type. Will never be included for channel token types."
},
{
"schema": {
"type": "boolean",
"default": false
},
"in": "query",
"description": "Determines if \"shipments\" are returned in the response.",
"name": "includeShipments"
},
{
"schema": {
"type": "boolean",
"default": false
},
"in": "query",
"description": "Filters orders based on whether or not they have at least one shipment.",
"name": "hasShipments"
},
{
"schema": {
"type": "boolean"
},
"in": "query",
"description": "Filters returned \"shipments\" based on whether or not they have been synced to the channel. If this is passed as true, both \"includeShipments\" and \"isShipped\" will be set to true.",
"name": "shipmentSyncedToChannel"
},
{
"schema": {
"type": "boolean"
},
"in": "query",
"description": "Filters returned \"shipments\" based on whether or not they have been suppressed. If this is passed as true, both \"includeShipments\" and \"isShipped\" will be set to true.",
"name": "shipmentSuppressed"
},
{
"schema": {
"type": "boolean"
},
"in": "query",
"description": "Filters returned \"shipments\" based on whether or not they have been they had an error saved when syncing to the channel. If this is passed as true, both \"includeShipments\" and \"isShipped\" will be set to true.",
"name": "shipmentHasError"
},
{
"schema": {
"type": "boolean",
"default": false
},
"in": "query",
"description": "Determines if \"source invoices\" are returned in the response. Only applicable if using an account token type. Will never be included for channel token types.",
"name": "includeSourceInvoices"
},
{
"schema": {
"type": "boolean",
"default": false
},
"in": "query",
"description": "Determines if \"order status history\" are returned in the response",
"name": "includeStatusHistory"
},
{
"schema": {
"type": "boolean",
"default": false
},
"in": "query",
"name": "includeTags",
"description": "Determines if \"tags\" are returned in the response"
},
{
"schema": {
"type": "boolean",
"default": false
},
"in": "query",
"name": "includeFFL",
"description": "Determines if \"Order FFL\" (if available) is included in the response"
},
{
"schema": {
"type": "boolean"
},
"in": "query",
"name": "includeReturns",
"description": "Determines if \"Order returns\" are returned in the response."
},
{
"schema": {
"type": "string",
"format": "date-time"
},
"in": "query",
"name": "updatedAfter",
"description": "Only returns Orders that have been updated after this time"
},
{
"schema": {
"type": "boolean",
"default": true
},
"in": "query",
"name": "includeCancelledOrders",
"description": "Include cancelled orders in the response. "
},
{
"schema": {
"type": "string",
"enum": [
"Not Started",
"Partially Completed",
"Completed"
]
},
"in": "query",
"name": "allocationStatus",
"description": "Filter on Allocation Status"
},
{
"schema": {
"type": "boolean"
},
"in": "query",
"name": "shipmentAccountingSynced",
"description": "Shipment Accounting Synced Filter"
},
{
"schema": {
"type": "string",
"format": "date-time"
},
"in": "query",
"name": "orderModifiedAfter",
"description": "Only show orders where the order or any of its sub-components have been modified after this time. (Please see the modifiedAt field of the order object for a list of all sub-components)"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Order"
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthorized"
}
}
}
}Ready to run it? Send the curl from your terminal or Postman, or use the interactive tester in Stoplight.Open in Stoplight