FlxpointAPI Help CenterBeta

[Deprecated] List Orders

gethttps://api.flxpoint.com/orders/listDeprecated

Use 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 is deprecated, please use `GET /orders` instead

This endpoint will retrieve back Orders

- Params starting with **filter*** will filter the results down - Params starting with **include*** will determine the metadata returned

Request

Query parameters
  • filterStatusquerystring

    Filters down to Orders that match this status.

    allowedOpenClosedOn HoldFailedNo Shipping MethodCanceledNot Managed
  • filterOrderedAfterquerystring (date-time)

    Filters down to Orders that were ordered after this datetime.

  • filterStatusHasChangedSincequerystring (date-time)

    Returns any orders that have had a status change since this datetime.

  • filterHasTagquerystring

    Filters orders that has tag

  • filterShipmentStatusquerystring

    Filters down to Orders that has this shipment status

    allowedNot StartedPartially CompletedCompleted
  • filterChannelInvoiceStatusquerystring

    Filters down to Orders that are in this channel invoice status.

    allowedNot AuthorizedAuthorizedPaidDeferredRefundedCreditedAwaiting ClearanceDeclinedRefund PendingRefund Failed
  • includeChannelInvoicequeryboolean

    Determines if "channel invoice" are returned in the response

  • includePosqueryboolean

    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.

  • includeShipmentsqueryboolean

    Determines if "shipments" are returned in the response.

  • includeSourceInvoicesqueryboolean

    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.

  • includeStatusHistoryqueryboolean

    Determines if "order status history" are returned in the response

  • includeTagsqueryboolean

    Determines if "tags" are returned in the response

  • filterPageSizequeryinteger (int32)

    Number of entries per page

  • filterPageNumberqueryinteger (int32)

    Current Page

  • filterByChannelIdqueryinteger

    Retrieve orders of a specific channel

  • filterByIdsqueryarray[integer]

    A list of Order IDs to filter on. Max 50 IDs. Recommended to not include full metadata while using this. This will work in conjunction with the other `filter` params

  • includeFFLqueryboolean

    Determines if "Order FFL" (if available) is included in the response

  • includeReturnsqueryboolean

    Determines if "Order returns" are returned in the response

Example request

get/orders/list
curl -X GET "https://api.flxpoint.com/orders/list" \
  -H "Accept: application/json" \
  -H "X-API-TOKEN: YOUR_TOKEN"

Responses

200OKapplication/json
array[Order]
idinteger
orderNumberstring
referenceNumberstring
orderTotalnumber
notestring
importedFrominteger
orderedAtstring (date-time)
insertedAtstring (date-time)
updatedAtstring (date-time)
shippingTextstring
acknowledgedStatusCompletionStatus
allowedNot StartedPartially CompletedCompleted
shippedStatusCompletionStatus
allowedNot StartedPartially CompletedCompleted
orderStatusOrderStatus
allowedOpenClosedOn HoldFailedNo Shipping MethodCanceledNot ManagedDraft
shippingAddressobject
idinteger
namestring
Field created real-time by concatenating "firstName" and "lastName"
addressLine1string
addressLine2string
citystring
statestring
countrystring
stateCodestring
countryCodestring
postalstring
Postal / Zip Code of address
emailstring
phonestring
Free form string field, format isn't enforced
companyNamestring
firstNamestring
lastNamestring
redactedboolean
Represents 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.
hashstring
Represents a unique hash of this address.
billingAddressobject
idinteger
namestring
Field created real-time by concatenating "firstName" and "lastName"
addressLine1string
addressLine2string
citystring
statestring
countrystring
stateCodestring
countryCodestring
postalstring
Postal / Zip Code of address
emailstring
phonestring
Free form string field, format isn't enforced
companyNamestring
firstNamestring
lastNamestring
redactedboolean
Represents 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.
hashstring
Represents a unique hash of this address.
dealerAddressobject
idinteger
namestring
Field created real-time by concatenating "firstName" and "lastName"
addressLine1string
addressLine2string
citystring
statestring
countrystring
stateCodestring
countryCodestring
postalstring
Postal / Zip Code of address
emailstring
phonestring
Free form string field, format isn't enforced
companyNamestring
firstNamestring
lastNamestring
redactedboolean
Represents 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.
hashstring
Represents a unique hash of this address.
channelIdinteger
resellerobject
idinteger
accountIdinteger
emailstring
billingAddressIdinteger
channelIdinteger
accountDealerStatusIdinteger
totalOrdersinteger
totalSpentnumber
lastOrderOnstring (date-time)
firstNamestring
lastNamestring
insertedAtstring (date-time)
companyNamestring
phonestring
dealerGroupIdinteger
creditAvailablenumber
creditUsednumber
taxIdstring
externalIdstring
websitestring
apiTokenEnabledStateBeforeAccountLockboolean
releasedboolean
accountIdinteger
paymentStatusPaymentStatus
allowedNot AuthorizedAuthorizedPaidDeferredRefundedCreditedAwaiting ClearanceDeclinedRefund PendingRefund Failed
allocatedStatusCompletionStatus
allowedNot StartedPartially CompletedCompleted
canceledAtstring (date-time)
totalOrderItemsinteger
default 0
totalQuantityinteger
default 0
totalWeightnumber
paymentRefundStatusPaymentRefundStatus
allowedNonePartiallyFully
paymentCreditStatusPaymentRefundStatus
allowedNonePartiallyFully
purchaseOrderStatusCompletionStatus
allowedNot StartedPartially CompletedCompleted
purchaseOrderProcessStatusCompletionStatus
allowedNot StartedPartially CompletedCompleted
purchaseOrderFailedStatusCompletionStatus
allowedNot StartedPartially CompletedCompleted
purchaseOrderCanceledStatusCompletionStatus
allowedNot StartedPartially CompletedCompleted
purchaseOrderVoidedStatusCompletionStatus
allowedNot StartedPartially CompletedCompleted
paymentDeferredAtstring (date-time)
paymentDeferredUntilstring (date-time)
channelInvoiceReceiptQueuedIdstring
channelShippingMethodobject
idinteger
channelIdinteger
namestring
shippingPolicyIdinteger
deletedAtstring (date-time)
totalPosinteger
default 0
shippingPolicyobject
idinteger
namestringrequired
deletedAtstring (date-time)
poTotalCostnumber
sourceInvoiceTotalCostnumber
profitAmountnumber
profitMarginnumber
sourceInvoiceStatusCompletionStatus
allowedNot StartedPartially CompletedCompleted
accountingSyncedboolean
externalAccountingIdstring
piiRetentionPolicyTypeobject
handlestring
allowed30_days_after_shipment60_days_after_shipment90_days_after_shipmentnone
namestring
allowed30 days After Shipment60 days After Shipment90 days After ShipmentIndefinitely
piiRetentionPolicyAppliedboolean
orderItemsarray[OrderItem]
idinteger
skustring
quantityintegerrequired
costnumber
pricenumber
discountnumber
subtotalnumber
acknowledgedQuantityinteger
default 0
shippedQuantityinteger
default 0
orderIdinteger
shippedStatusCompletionStatus
allowedNot StartedPartially CompletedCompleted
acknowledgedStatusCompletionStatus
allowedNot StartedPartially CompletedCompleted
titlestring
weightnumber
imagestring
allocatedQuantityinteger
default 0
allocatedStatusCompletionStatus
allowedNot StartedPartially CompletedCompleted
orderedQuantityinteger
default 0
virtualVariantIdinteger
listingVariantIdinteger
externalListingIdstring
externalOrderItemIdstring
externalAccountingItemIdstring
bundleboolean
weightUnitobject
handlestring
allowedpoundouncegramkilogram
abbreviatedHandlestring
allowedlbozgkg
notShippableboolean
bundleComponentsarray[OrderItemBundleComponent]
idinteger
orderItemIdinteger
componentVirtualVariantIdinteger
componentQuantityinteger
quantityintegerrequired
skustring
costnumber
shippedQuantityinteger
shippedStatusCompletionStatus
allowedNot StartedPartially CompletedCompleted
allocatedQuantityinteger
allocatedStatusCompletionStatus
allowedNot StartedPartially CompletedCompleted
acknowledgedQuantityinteger
acknowledgedStatusCompletionStatus
allowedNot StartedPartially CompletedCompleted
attributesarray[OrderItemAttribute]required
idinteger
orderItemIdinteger
keystring
valuestring
restockingInventoryVariantIdinteger (int64)
canceledQuantityinteger
default 0
fulfillableQuantityinteger
default 0
returnedQuantityinteger
default 0
usingProductAlternativeboolean
Signifies whether the item has been replaced.
default false
shippingAddressobject
idinteger
namestring
Field created real-time by concatenating "firstName" and "lastName"
addressLine1string
addressLine2string
citystring
statestring
countrystring
stateCodestring
countryCodestring
postalstring
Postal / Zip Code of address
emailstring
phonestring
Free form string field, format isn't enforced
companyNamestring
firstNamestring
lastNamestring
redactedboolean
Represents 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.
hashstring
Represents a unique hash of this address.
externalAccountingItemMappingboolean
shipByDatestring (date)
The date by which this line item must be shipped.
purchaseOrdersarray[PurchaseOrder]
idinteger
purchaseOrderNumberstring
orderIdinteger
sentAtstring (date-time)
sourceIdinteger
acknowledgedAtstring (date-time)
secondaryAcknowledgedAtstring (date-time)
canceledAtstring (date-time)
shippingAddressobject
idinteger
namestring
Field created real-time by concatenating "firstName" and "lastName"
addressLine1string
addressLine2string
citystring
statestring
countrystring
stateCodestring
countryCodestring
postalstring
Postal / Zip Code of address
emailstring
phonestring
Free form string field, format isn't enforced
companyNamestring
firstNamestring
lastNamestring
redactedboolean
Represents 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.
hashstring
Represents a unique hash of this address.
billingAddressobject
idinteger
namestring
Field created real-time by concatenating "firstName" and "lastName"
addressLine1string
addressLine2string
citystring
statestring
countrystring
stateCodestring
countryCodestring
postalstring
Postal / Zip Code of address
emailstring
phonestring
Free form string field, format isn't enforced
companyNamestring
firstNamestring
lastNamestring
redactedboolean
Represents 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.
hashstring
Represents a unique hash of this address.
shippingTextstringdeprecated
notestring
A note that can optionally be passed through all the way to the source
confirmationNumberstring
shippedStatusCompletionStatus
allowedNot StartedPartially CompletedCompleted
purchaseOrderStatusobject
namestring
`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.
allowedUnprocessedProcessedAcknowledgedCanceledVoidedProcessingAdditional Info RequiredTransferredPO/FR # Exceeds Max LengthDuplicate PO/FR #Processing ErrorFulfillment Request # Exceeds Max LengthDuplicate Fulfillment Request #Cross Docked
handlestring
allowedunprocessedprocessedacknowledgedcanceledvoidedprocessingadditional_info_requiredtransferredpo_number_exceeds_max_lengthduplicateprocessing_errorcross_docked
purchaseOrderFulfillmentStatusobject
namestring
allowedAwaiting ShipmentShippedPartially ShippedCanceled
handlestring
allowedawaiting_shipmentshippedpartially_shippedcanceled
generatedAtstring (date-time)
voidedAtstring (date-time)
accountIdinteger
totalItemsinteger
totalCostnumber
totalQuantityinteger
shippedQuantityinteger
estimatedShippingCostnumber
estimatedDropshipFeenumber
sourceShippingMethodobject
<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.
idinteger
sourceIdinteger
descriptionstring
carrierstring
methodstring
shippingCodestringdeprecated
Deprecated. Use `defaultMethodCode` instead.
shippingPolicyobject
idinteger
namestringrequired
deletedAtstring (date-time)
deletedAtstring (date-time)
shippingCarrierobject
idinteger
namestring
handlestring
shipEngineSupportedboolean
shippingCarrierMethodobject
idinteger
shippingCarrierobject
idinteger
namestring
handlestring
shipEngineSupportedboolean
namestring
handlestring
shippingLabelCodestring
It is used to specify the preferred Delivery Service during the purchase of a shipping label when a Fulfillment Request is not rate shopped
defaultCarrierCodestring
The code (text) that your source recognizes for this shipping carrier.
defaultMethodCodestring
Formally known as "Shipping Code". The code (text) that your source recognizes for this shipping method.
overrideDefaultCodesboolean
Use codes provided by ShipEngine to send to your source based on the carrier and method with the best shipping rate.
default false
filterCarriersAndMethodsboolean
Filter to include only some carriers and methods you've connected to ShipEngine.
default false
shippingCarriersarray[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.
idinteger
namestring
handlestring
shipEngineSupportedboolean
shippingCarrierMethodsarray[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.
idinteger
shippingCarrierShippingCarrier
namestring
handlestring
useBestFitPackageboolean
Use 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 true
commonPackagesarray[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.
idinteger
A unique, numerical identifier for the package.
lengthnumber
The length dimension of the package.
widthnumber
The width dimension of the package.
heightnumber
The height dimension of the package.
dimensionUnitDimensionUnit
weightnumber
The weight of the package itself (excluding any contents).
weightUnitWeightUnit
customPackagesarray[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.
idinteger
A unique, numerical identifier for the package.
namestring
Your name for the package.
lengthnumber
The length dimension of the package.
widthnumber
The width dimension of the package.
heightnumber
The height dimension of the package.
dimensionUnitDimensionUnit
weightnumber
The weight of the package itself (excluding any contents).
weightUnitWeightUnit
createdAtstring (date-time)
The time that the package was created by an account user.
createdByUserEmailstring
The 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).
suppressTrackingboolean
beingProcessedboolean
totalSourceInvoicesinteger
fflInfoRequiredboolean
lastModifiedAtstring (date-time)
accountingSyncedboolean
externalAccountingIdstring
holdUntilstring (date-time)
rateShoppedIdstring
packageDimensionUnitobject
handlestring
allowedinchcentimeter
abbreviatedHandlestring
allowedincm
packageLengthnumber
packageWidthnumber
packageHeightnumber
packageWeightUnitobject
handlestring
allowedpoundouncegramkilogram
abbreviatedHandlestring
allowedlbozgkg
packageWeightnumber
channelIdinteger
crossDockPurchaseOrderIdinteger
Establish this PO as part of a cross docking request by providing the cross dock PO ID
voidedReasonstring
processingErrorReasonstring
The reason this purchase order could not be processed
cancelReasonstring
purchaseOrderItemsarray[PurchaseOrderItem]
idinteger
skustring
quantityinteger
costnumber
itemReferenceIdstring
referenceIdstring
purchaseOrderIdinteger
shippedQuantityinteger
default 0
voidedQuantityinteger
default 0
acknowledgedQuantityinteger
default 0
secondaryAcknowledgedQuantityinteger
default 0
inventoryVariantIdinteger (int64)
orderItemIdinteger
titlestring
externalAccountingItemIdstring
canceledQuantityinteger
weightUnitobject
handlestring
allowedpoundouncegramkilogram
abbreviatedHandlestring
allowedlbozgkg
weightnumber
dimensionUnitobject
handlestring
allowedinchcentimeter
abbreviatedHandlestring
allowedincm
lengthnumber
widthnumber
heightnumber
upcstring
mpnstring
attributesarray[PurchaseOrderItemAttribute]
bundleComponentsarray[PurchaseOrderItemBundleComponent]
lineItemNumberinteger
binLocationstring
subtotalstring
shipmentsarray[Shipment]
idinteger
notestring
trackingUrlstring
trackingNumberstring
carrierstring
methodstring
shippedAtstring (date-time)
insertedAtstring (date-time)
shippingCostnumber
orderIdinteger
purchaseOrderIdinteger
fulfillmentRequestIdinteger
rmaIdinteger
sourceIdinteger
accountIdinteger
partialboolean
suppressedboolean
syncedToChannelboolean
syncErrorstring
crossDockPurchaseOrderIdinteger
shipmentItemsarray[ShipmentItem]
customFieldsarray[ShipmentCustomField]
updatedAtstring (date-time)
accountingSyncedboolean
invoicesarray[Invoice]
idinteger
invoiceStatusobject
namestring
allowedUnpaidPaidCreditedRefunded
handlestring
allowedunpaidpaidcreditedrefunded
insertedAtstring (date-time)
updatedAtstring (date-time)
purchaseOrderIdinteger
this field is deprecated, please use `fulfillmentRequestId`. The two fields are same.
fulfillmentRequestIdinteger
rmaIdinteger
sourceIdinteger
purchaseOrderNumberstring
this field is deprecated, please start using `fulfillmentRequestNumber`. The two fields are essentially same.
fulfillmentRequestNumberstring
invoiceNumberstring
invoiceDatestring (date-time)
totalCostnumber
totalProductCostnumber
totalShippingCostnumber
totalFeeCostnumber
totalTaxCostnumber
totalOtherCostnumber
totalQuantityinteger
accountingSyncedboolean
accountingSyncErrorstring
externalAccountingIdstring
invoiceItemsarray[InvoiceItem]
totalCreditCostnumber
customFieldsarray[Source Invoice Custom Field]
commissionnumberdeprecated
vendorPayoutIdinteger
purchaseOrderAttributesarray[PurchaseOrderAttribute]
idinteger
purchase_order_idinteger
keystring
valuestring
purchaseOrderTypeobject
"Fulfillment Request" name and "FR" abbreviation are now deprecated. Use "Fulfillment Order" name and "FO" abbreviation instead.
idinteger
allowed1234
namestring
allowedPurchase OrderFulfillment RequestTransfer OrderStocking Purchase OrderFulfillment Order
abbreviationstring
allowedPOFRTOSPOFO
handlestring
allowedpurchase_orderfulfillment_requesttransfer_orderstocking_purchase_order
shippingAddressIdinteger
billingAddressIdinteger
sourceShippingMethodIdinteger
shippingDistancenumber
purchaseOrderReceivedStatusobject
handlestring
allowedawaiting_to_receivepartially_receivedreceivedvoided
carrierCodestring
methodCodestring
purchaseOrderPackageobject
A Purchase Order Package contains all metadata needed to buy a shipping label.
idinteger
The ID of the Purchase Order Package.
purchaseOrderIdintegerrequired
The ID of the Purchase Order to buy a shipping label for.
rateIdstring
The Rate Shopping Provider's ID of the rate found that can be used to purchase the shipping label with.
shipFromAddressobject
idinteger
namestring
Field created real-time by concatenating "firstName" and "lastName"
addressLine1string
addressLine2string
citystring
statestring
countrystring
stateCodestring
countryCodestring
postalstring
Postal / Zip Code of address
emailstring
phonestring
Free form string field, format isn't enforced
companyNamestring
firstNamestring
lastNamestring
redactedboolean
Represents 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.
hashstring
Represents a unique hash of this address.
shipToAddressobject
idinteger
namestring
Field created real-time by concatenating "firstName" and "lastName"
addressLine1string
addressLine2string
citystring
statestring
countrystring
stateCodestring
countryCodestring
postalstring
Postal / Zip Code of address
emailstring
phonestring
Free form string field, format isn't enforced
companyNamestring
firstNamestring
lastNamestring
redactedboolean
Represents 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.
hashstring
Represents a unique hash of this address.
createShipmentPostProcessingboolean
This 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.
updateShipmentOnPurchaseboolean
If 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.
lengthnumber
Length of the package to ship with this label.
widthnumber
Width of the package to ship with this label.
heightnumber
Height of the package to ship with this label.
dimensionUnitobject
handlestring
allowedinchcentimeter
abbreviatedHandlestring
allowedincm
totalWeightnumber
Total weight of the package with all of its items included to be shipped with this label.
weightUnitobject
handlestring
allowedpoundouncegramkilogram
abbreviatedHandlestring
allowedlbozgkg
shippingCarrierMethodobject
idinteger
shippingCarrierobject
idinteger
namestring
handlestring
shipEngineSupportedboolean
namestring
handlestring
rateShoppingProviderobject
idinteger
namestring
handlestring
supportsLabelGenerationboolean
rateShoppingProviderLabelSizestring
The preferred size of the shipping label.
allowed4x6letter
default "4x6"
commonPackageobject
This is a standard package in Flxpoint that can be associated to a Source Shipping Method for using to ship out orders in.
idinteger
A unique, numerical identifier for the package.
lengthnumber
The length dimension of the package.
widthnumber
The width dimension of the package.
heightnumber
The height dimension of the package.
dimensionUnitobject
handlestring
allowedinchcentimeter
abbreviatedHandlestring
allowedincm
weightnumber
The weight of the package itself (excluding any contents).
weightUnitobject
handlestring
allowedpoundouncegramkilogram
abbreviatedHandlestring
allowedlbozgkg
customPackageobject
This 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.
idinteger
A unique, numerical identifier for the package.
namestring
Your name for the package.
lengthnumber
The length dimension of the package.
widthnumber
The width dimension of the package.
heightnumber
The height dimension of the package.
dimensionUnitobject
handlestring
allowedinchcentimeter
abbreviatedHandlestring
allowedincm
weightnumber
The weight of the package itself (excluding any contents).
weightUnitobject
handlestring
allowedpoundouncegramkilogram
abbreviatedHandlestring
allowedlbozgkg
createdAtstring (date-time)
The time that the package was created by an account user.
createdByUserEmailstring
The 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.
idinteger
purchaseOrderPackageIdinteger
purchaseOrderItemIdinteger
quantityinteger
buyShippingLabelboolean
default false
orderFFLobject
idintegerrequired
orderIdinteger
crossDockPurchaseOrderIdinteger
licenseNumberstringrequired
namestring
addressLine1stringrequired
addressLine2string
citystring
statestring
postalstring
phonestring
imageUrlstring
expiresAtstring (date-time)
companyNamestring
totalWeightnumber
attachmentLinksarray[string]
A list of URLs containing each file attached to this Purchase Order. These include both shipping labels and packing slips.
string
shippingLabelAttachmentLinkstring
URL 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).
packingSlipAttachmentLinkstring
URL 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]
idinteger
A unique identifier for the fulfillment request.
fulfillmentRequestNumberstring
orderIdinteger
The 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
sourceIdinteger
Unique 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.
shippingAddressobject
idinteger
namestring
Field created real-time by concatenating "firstName" and "lastName"
addressLine1string
addressLine2string
citystring
statestring
countrystring
stateCodestring
countryCodestring
postalstring
Postal / Zip Code of address
emailstring
phonestring
Free form string field, format isn't enforced
companyNamestring
firstNamestring
lastNamestring
redactedboolean
Represents 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.
hashstring
Represents a unique hash of this address.
billingAddressobject
idinteger
namestring
Field created real-time by concatenating "firstName" and "lastName"
addressLine1string
addressLine2string
citystring
statestring
countrystring
stateCodestring
countryCodestring
postalstring
Postal / Zip Code of address
emailstring
phonestring
Free form string field, format isn't enforced
companyNamestring
firstNamestring
lastNamestring
redactedboolean
Represents 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.
hashstring
Represents a unique hash of this address.
shippingTextstringdeprecated
notestring
A note that can optionally be passed through all the way to the source
confirmationNumberstring
A unique identifier returned from the source for indicating receipt and identifying the Fulfillment Request once it has been processed and acknowledged on their side.
shippedStatusCompletionStatus
allowedNot StartedPartially CompletedCompleted
fulfillmentRequestStatusobject
namestring
allowedUnprocessedProcessedAcknowledgedCanceledVoidedProcessingAdditional Info RequiredTransferredPO/FR # Exceeds Max LengthDuplicate PO/FR #Processing ErrorCross DockedFulfillment Request # Exceeds Max LengthDuplicate Fulfillment Request #
handlestring
allowedunprocessedprocessedacknowledgedcanceledvoidedprocessingadditional_info_requiredtransferredpo_number_exceeds_max_lengthduplicateprocessing_errorcross_docked
fulfillmentRequestFulfillmentStatusobject
namestring
allowedAwaiting ShipmentShippedPartially ShippedCanceled
handlestring
allowedawaiting_shipmentshippedpartially_shippedcanceled
generatedAtstring (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.
accountIdintegerdeprecated
totalItemsinteger
Total Number of Fulfillment Request Items.
totalCostnumber
Total cost of the Fulfillment Request Items
totalQuantityinteger
Total quantity of the Fulfillment Request Items.
shippedQuantityinteger
Total quantity of the Fulfillment Request Items that has been shipped.
estimatedShippingCostnumber
estimatedDropshipFeenumber
sourceShippingMethodobject
<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.
idinteger
sourceIdinteger
descriptionstring
carrierstring
methodstring
shippingCodestringdeprecated
Deprecated. Use `defaultMethodCode` instead.
shippingPolicyobject
idinteger
namestringrequired
deletedAtstring (date-time)
deletedAtstring (date-time)
shippingCarrierobject
idinteger
namestring
handlestring
shipEngineSupportedboolean
shippingCarrierMethodobject
idinteger
shippingCarrierobject
idinteger
namestring
handlestring
shipEngineSupportedboolean
namestring
handlestring
shippingLabelCodestring
It is used to specify the preferred Delivery Service during the purchase of a shipping label when a Fulfillment Request is not rate shopped
defaultCarrierCodestring
The code (text) that your source recognizes for this shipping carrier.
defaultMethodCodestring
Formally known as "Shipping Code". The code (text) that your source recognizes for this shipping method.
overrideDefaultCodesboolean
Use codes provided by ShipEngine to send to your source based on the carrier and method with the best shipping rate.
default false
filterCarriersAndMethodsboolean
Filter to include only some carriers and methods you've connected to ShipEngine.
default false
shippingCarriersarray[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.
idinteger
namestring
handlestring
shipEngineSupportedboolean
shippingCarrierMethodsarray[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.
idinteger
shippingCarrierShippingCarrier
namestring
handlestring
useBestFitPackageboolean
Use 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 true
commonPackagesarray[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.
idinteger
A unique, numerical identifier for the package.
lengthnumber
The length dimension of the package.
widthnumber
The width dimension of the package.
heightnumber
The height dimension of the package.
dimensionUnitDimensionUnit
weightnumber
The weight of the package itself (excluding any contents).
weightUnitWeightUnit
customPackagesarray[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.
idinteger
A unique, numerical identifier for the package.
namestring
Your name for the package.
lengthnumber
The length dimension of the package.
widthnumber
The width dimension of the package.
heightnumber
The height dimension of the package.
dimensionUnitDimensionUnit
weightnumber
The weight of the package itself (excluding any contents).
weightUnitWeightUnit
createdAtstring (date-time)
The time that the package was created by an account user.
createdByUserEmailstring
The 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).
suppressTrackingboolean
Indicates 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.
beingProcessedboolean
totalSourceInvoicesinteger
fflInfoRequiredboolean
lastModifiedAtstring (date-time)
accountingSyncedboolean
externalAccountingIdstring
holdUntilstring (date-time)
rateShoppedIdstring
packageDimensionUnitobject
handlestring
allowedinchcentimeter
abbreviatedHandlestring
allowedincm
packageLengthnumber
packageWidthnumber
packageHeightnumber
packageWeightUnitobject
handlestring
allowedpoundouncegramkilogram
abbreviatedHandlestring
allowedlbozgkg
packageWeightnumber
channelIdinteger
crossDockPurchaseOrderIdinteger
The 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.
processingErrorReasonstring
The reason this purchase order could not be processed
cancelReasonstring
The reason why the Fulfillment Request was canceled.
fulfillmentRequestItemsarray[FulfillmentRequestItem]
idinteger
skustring
quantityinteger
costnumber
itemReferenceIdstring
referenceIdstring
fulfillmentRequestIdinteger
shippedQuantityinteger
default 0
voidedQuantityinteger
default 0
acknowledgedQuantityinteger
default 0
secondaryAcknowledgedQuantityinteger
default 0
inventoryVariantIdinteger (int64)
orderItemIdinteger
titlestring
externalAccountingItemIdstring
canceledQuantityinteger
weightUnitobject
handlestring
allowedpoundouncegramkilogram
abbreviatedHandlestring
allowedlbozgkg
weightnumber
dimensionUnitobject
handlestring
allowedinchcentimeter
abbreviatedHandlestring
allowedincm
lengthnumber
widthnumber
heightnumber
upcstring
mpnstring
attributesarray[FulfillmentRequestItemAttribute]deprecated
Deprecated -- use `customFields` instead.
bundleComponentsarray[FulfillmentRequestItemBundleComponent]
lineItemNumberinteger
customFieldsarray[FulfillmentRequestItemAttribute]
binLocationstring
subtotalnumber
shipmentsarray[Shipment]
idinteger
notestring
trackingUrlstring
trackingNumberstring
carrierstring
methodstring
shippedAtstring (date-time)
insertedAtstring (date-time)
shippingCostnumber
orderIdinteger
purchaseOrderIdinteger
fulfillmentRequestIdinteger
rmaIdinteger
sourceIdinteger
accountIdinteger
partialboolean
suppressedboolean
syncedToChannelboolean
syncErrorstring
crossDockPurchaseOrderIdinteger
shipmentItemsarray[ShipmentItem]
customFieldsarray[ShipmentCustomField]
updatedAtstring (date-time)
accountingSyncedboolean
invoicesarray[Invoice]
idinteger
invoiceStatusobject
namestring
allowedUnpaidPaidCreditedRefunded
handlestring
allowedunpaidpaidcreditedrefunded
insertedAtstring (date-time)
updatedAtstring (date-time)
purchaseOrderIdinteger
this field is deprecated, please use `fulfillmentRequestId`. The two fields are same.
fulfillmentRequestIdinteger
rmaIdinteger
sourceIdinteger
purchaseOrderNumberstring
this field is deprecated, please start using `fulfillmentRequestNumber`. The two fields are essentially same.
fulfillmentRequestNumberstring
invoiceNumberstring
invoiceDatestring (date-time)
totalCostnumber
totalProductCostnumber
totalShippingCostnumber
totalFeeCostnumber
totalTaxCostnumber
totalOtherCostnumber
totalQuantityinteger
accountingSyncedboolean
accountingSyncErrorstring
externalAccountingIdstring
invoiceItemsarray[InvoiceItem]
totalCreditCostnumber
customFieldsarray[Source Invoice Custom Field]
commissionnumberdeprecated
vendorPayoutIdinteger
fulfillmentRequestAttributesarray[object]deprecated
Deprecated -- use `customFields` instead.
idinteger
fulfillmentRequestIdinteger
keystring
valuestring
fulfillmentRequestTypeobject
"Fulfillment Request" name and "FR" abbreviation are now deprecated. Use "Fulfillment Order" name and "FO" abbreviation instead.
idinteger
allowed1234
namestring
allowedPurchase OrderFulfillment RequestTransfer OrderStocking Purchase OrderFulfillment Order
abbreviationstring
allowedPOFRTOSPOFO
handlestring
allowedpurchase_orderfulfillment_requesttransfer_orderstocking_purchase_order
shippingAddressIdinteger
billingAddressIdinteger
sourceShippingMethodIdinteger
shippingDistancenumber
fulfillmentRequestReceivedStatusobject
handlestring
allowedawaiting_to_receivepartially_receivedreceivedvoided
carrierCodestring
methodCodestring
fulfillmentRequestPackageobject
A Fulfillment Request Package contains all metadata needed to buy a shipping label.
idinteger
The ID of the Purchase Order Package.
fulfillmentRequestIdintegerrequired
The ID of the Purchase Order to buy a shipping label for.
rateIdstring
The Rate Shopping Provider's ID of the rate found that can be used to purchase the shipping label with.
shipFromAddressobject
idinteger
namestring
Field created real-time by concatenating "firstName" and "lastName"
addressLine1string
addressLine2string
citystring
statestring
countrystring
stateCodestring
countryCodestring
postalstring
Postal / Zip Code of address
emailstring
phonestring
Free form string field, format isn't enforced
companyNamestring
firstNamestring
lastNamestring
redactedboolean
Represents 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.
hashstring
Represents a unique hash of this address.
shipToAddressobject
idinteger
namestring
Field created real-time by concatenating "firstName" and "lastName"
addressLine1string
addressLine2string
citystring
statestring
countrystring
stateCodestring
countryCodestring
postalstring
Postal / Zip Code of address
emailstring
phonestring
Free form string field, format isn't enforced
companyNamestring
firstNamestring
lastNamestring
redactedboolean
Represents 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.
hashstring
Represents a unique hash of this address.
createShipmentPostProcessingboolean
This 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.
updateShipmentOnPurchaseboolean
If 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.
lengthnumber
Length of the package to ship with this label.
widthnumber
Width of the package to ship with this label.
heightnumber
Height of the package to ship with this label.
dimensionUnitobject
handlestring
allowedinchcentimeter
abbreviatedHandlestring
allowedincm
totalWeightnumber
Total weight of the package with all of its items included to be shipped with this label.
weightUnitobject
handlestring
allowedpoundouncegramkilogram
abbreviatedHandlestring
allowedlbozgkg
shippingCarrierMethodobject
idinteger
shippingCarrierobject
idinteger
namestring
handlestring
shipEngineSupportedboolean
namestring
handlestring
rateShoppingProviderobject
idinteger
namestring
handlestring
supportsLabelGenerationboolean
rateShoppingProviderLabelSizestring
The preferred size of the shipping label.
allowed4x6letter
default "4x6"
commonPackageobject
This is a standard package in Flxpoint that can be associated to a Source Shipping Method for using to ship out orders in.
idinteger
A unique, numerical identifier for the package.
lengthnumber
The length dimension of the package.
widthnumber
The width dimension of the package.
heightnumber
The height dimension of the package.
dimensionUnitobject
handlestring
allowedinchcentimeter
abbreviatedHandlestring
allowedincm
weightnumber
The weight of the package itself (excluding any contents).
weightUnitobject
handlestring
allowedpoundouncegramkilogram
abbreviatedHandlestring
allowedlbozgkg
customPackageobject
This 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.
idinteger
A unique, numerical identifier for the package.
namestring
Your name for the package.
lengthnumber
The length dimension of the package.
widthnumber
The width dimension of the package.
heightnumber
The height dimension of the package.
dimensionUnitobject
handlestring
allowedinchcentimeter
abbreviatedHandlestring
allowedincm
weightnumber
The weight of the package itself (excluding any contents).
weightUnitobject
handlestring
allowedpoundouncegramkilogram
abbreviatedHandlestring
allowedlbozgkg
createdAtstring (date-time)
The time that the package was created by an account user.
createdByUserEmailstring
The 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.
idinteger
fulfillmentRequestPackageIdinteger
fulfillmentRequestItemIdinteger
quantityinteger
buyShippingLabelboolean
default false
orderFFLobject
idintegerrequired
orderIdinteger
crossDockPurchaseOrderIdinteger
licenseNumberstringrequired
namestring
addressLine1stringrequired
addressLine2string
citystring
statestring
postalstring
phonestring
imageUrlstring
expiresAtstring (date-time)
companyNamestring
totalWeightnumber
customFieldsarray[object]
idinteger
fulfillmentRequestIdinteger
keystring
valuestring
attachmentLinksarray[string]
A list of URLs containing each file attached to this Fulfillment Request. These include both shipping labels and packing slips.
string
shippingLabelAttachmentLinkstring
URL 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).
packingSlipAttachmentLinkstring
URL 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.
orderInvoiceobject
idinteger
subtotalnumber
totalnumber
dropshipFeenumber
shippingCostnumber
invoicedAtstring (date-time)
createdAtstring (date-time)
paidbooleanrequired
paidAtstring (date-time)
purchaseOrderIdinteger
orderIdinteger
invoiceNumberstring
authorizedIpAddressstring
capturedIpAddressstring
refundedAmountnumber
refundedLastAtstring (date-time)
refundedNumberOfTimesinteger
creditedAmountnumber
creditedLastAtstring (date-time)
creditedNumberOfTimesinteger
creditAppliedTowardsTotalnumber
receiptSentAtstring (date-time)
taxTitlestring
taxCostnumber
otherTitlestring
otherCostnumber
shippingTitlestring
dropshipFeeTitlestring
discountTotalnumber
discountDescriptionstring
orderStatusHistoryarray[OrderStatusHistory]
idinteger
orderIdintegerrequired
changeTimestring (date-time)
fromOrderStatusOrderStatusrequired
allowedOpenClosedOn HoldFailedNo Shipping MethodCanceledNot ManagedDraft
toOrderStatusOrderStatusrequired
allowedOpenClosedOn HoldFailedNo Shipping MethodCanceledNot ManagedDraft
userIdinteger
orderHistoryTypeobject
namestring
allowedStatus 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 Replaced
handlestring
allowedstatus_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_replaced
notestring
changeByDealerboolean
vendorUserIdinteger
sourceIdinteger
orderInteractionTypeobject
namestring
allowedSource APIChannel APIDealer APIDealer PortalVendor PortalSource IntegrationChannel IntegrationUserSource API via OceanXSource API via DuoplaneAPISystem
handlestring
allowedsource_apichannel_apidealer_apidealer_portalvendor_portalsource_integrationchannel_integrationuseroceanxduoplaneapisystem
tagsarray[string]
string
attributesarray[OrderAttribute]
idinteger
orderIdinteger
keystring
valuestring
sourceIdinteger
orderFFLobject
idintegerrequired
orderIdinteger
crossDockPurchaseOrderIdinteger
licenseNumberstringrequired
namestring
addressLine1stringrequired
addressLine2string
citystring
statestring
postalstring
phonestring
imageUrlstring
expiresAtstring (date-time)
companyNamestring
returnsarray[ReturnModel]
idinteger
orderIdinteger
returnNumberstring
accountIdinteger
totalReturnItemsinteger
totalRmasinteger
channelIdinteger
itemsarray[ReturnItem]
idinteger
returnIdinteger
orderItemIdinteger
skustring
returnQuantityinteger
returnReasonstring
returnConditionstring
salesPricenumber
titlestring
refundedAmountnumber
bundleComponentsarray[OrderItemBundleComponent]
rmasarray[Rma]
idinteger
returnIdinteger
sourceIdinteger
rmaNumberstring
accountIdinteger
returnToAddressobject
idinteger
namestring
Field created real-time by concatenating "firstName" and "lastName"
addressLine1string
addressLine2string
citystring
statestring
countrystring
stateCodestring
countryCodestring
postalstring
Postal / Zip Code of address
emailstring
phonestring
Free form string field, format isn't enforced
companyNamestring
firstNamestring
lastNamestring
redactedboolean
Represents 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.
hashstring
Represents a unique hash of this address.
itemsarray[RmaItem]
totalRmaItemsinteger
createdAtstring (date-time)
updatedAtstring (date-time)
rmaStatusRmaStatus
allowedWaitingApprovedVoidedDeniedPartially ApprovedCanceled
rmaShipmentsarray[RmaShipment]
creditSubtotalnumber
creditAdjustmentnumber
creditTotalnumber
creditLastSyncedAtstring (date-time)
syncCreditChangesToOrderboolean
shipmentReceivedStatusShipmentReceivedStatus
allowednot_receivedpartially_receivedfully_received
accountingSyncedAtstring (date-time)
accountingErrorstring
returnTotalnumber
statusReturnStatus
allowedopenclosedcancelled
updatedAtstring (date-time)
insertedAtstring (date-time)
refundAdjustmentnumber
refundSubtotalnumber
sum of refunded_amount for all return_items on the return
refundTotalnumber
refundSubtotal + refundAdjustment
refundLastSyncedAtstring (date-time)
syncRefundChangesToOrderboolean
shipmentReceivedStatusShipmentReceivedStatus
allowednot_receivedpartially_receivedfully_received
poLogsarray[PurchaseOrderLog]
typestringrequired
allowedinfowarnsuccesserrorsnapshot
messagestringrequired
positioninteger
orderIdinteger
jsonstring
totalReturnsinteger
orderTypeOrderType
allowedOnlinePOSManual
default "Online"
fulfillmentTypeFulfillmentType
allowedShippingIn-Store Purchase
default "Shipping"
syncedClosedAtstring (date-time)
resellerIdinteger
orderCommentsarray[OrderComment]
idinteger
emailstring
commentstringrequired
insertedAtstring (date-time)
orderIdintegerrequired
accountingSyncErrorstring
shippingPolicyIdinteger
modifiedAtstring (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": "[Deprecated] List Orders",
    "description": "This endpoint is deprecated, please use `GET /orders` instead\n\nThis endpoint will retrieve back Orders\n\n- Params starting with **filter*** will filter the results down\n- Params starting with **include*** will determine the metadata returned",
    "parameters": [
      {
        "schema": {
          "type": "string",
          "enum": [
            "Open",
            "Closed",
            "On Hold",
            "Failed",
            "No Shipping Method",
            "Canceled",
            "Not Managed"
          ]
        },
        "in": "query",
        "name": "filterStatus",
        "description": "Filters down to Orders that match this status."
      },
      {
        "schema": {
          "type": "string",
          "format": "date-time",
          "example": "2020-10-14T16:05:00.000Z"
        },
        "in": "query",
        "name": "filterOrderedAfter",
        "description": "Filters down to Orders that were ordered after this datetime."
      },
      {
        "schema": {
          "type": "string",
          "format": "date-time",
          "example": "2020-10-14T16:05:00.000Z"
        },
        "in": "query",
        "name": "filterStatusHasChangedSince",
        "description": "Returns any orders that have had a status change since this datetime."
      },
      {
        "schema": {
          "type": "string"
        },
        "in": "query",
        "name": "filterHasTag",
        "description": "Filters orders that has tag"
      },
      {
        "schema": {
          "type": "string",
          "enum": [
            "Not Started",
            "Partially Completed",
            "Completed"
          ]
        },
        "in": "query",
        "name": "filterShipmentStatus",
        "description": "Filters down to Orders that has this shipment status"
      },
      {
        "schema": {
          "type": "string",
          "enum": [
            "Not Authorized",
            "Authorized",
            "Paid",
            "Deferred",
            "Refunded",
            "Credited",
            "Awaiting Clearance",
            "Declined",
            "Refund Pending",
            "Refund Failed"
          ]
        },
        "in": "query",
        "name": "filterChannelInvoiceStatus",
        "description": "Filters down to Orders that are in this channel invoice status."
      },
      {
        "schema": {
          "type": "boolean",
          "default": false
        },
        "in": "query",
        "name": "includeChannelInvoice",
        "description": "Determines if \"channel invoice\" are 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": "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": "integer",
          "format": "int32",
          "default": 20,
          "minimum": 1,
          "maximum": 100
        },
        "in": "query",
        "name": "filterPageSize",
        "description": "Number of entries per page"
      },
      {
        "schema": {
          "type": "integer",
          "format": "int32",
          "default": 1
        },
        "in": "query",
        "name": "filterPageNumber",
        "description": "Current Page"
      },
      {
        "schema": {
          "type": "integer"
        },
        "in": "query",
        "name": "filterByChannelId",
        "description": "Retrieve orders of a specific channel"
      },
      {
        "schema": {
          "type": "array",
          "maxItems": 50,
          "example": "123,456,789",
          "uniqueItems": true,
          "items": {
            "type": "integer"
          }
        },
        "in": "query",
        "name": "filterByIds",
        "description": "A list of Order IDs to filter on. Max 50 IDs. Recommended to not include full metadata while using this. This will work in conjunction with the other `filter` params",
        "style": "form",
        "explode": false
      },
      {
        "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"
      }
    ],
    "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