FlxpointAPI Help CenterBeta

Get Fulfillment Request In Processing

gethttps://api.flxpoint.com/fulfillment-requests/processing

Use this when you want to pull fulfillment request 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 a list of Fulfillment Requests AND `Update the Fulfillment Requests to Processed`

NOTE : This means, if our API times out for you - those Fulfillment Requests may transition into a "Processed" state despite you not receiving them.

It's not recommended to use this endpoint, and it may be deprecated in the near future. We'd recommend using `GET /fulfillment-requests` to retrieve and `PATCH /fulfillment-requests/{fulfillmentRequestId}/acknowledge` to respond

Request

Query parameters
  • filterSourceIdqueryinteger

    filter Fulfillment Request by Source ID

Example request

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

Responses

200OKapplication/json
array[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
shippingCarrierobject
idinteger
namestring
handlestring
shipEngineSupportedboolean
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.
dimensionUnitobject
handlestring
allowedinchcentimeter
abbreviatedHandlestring
allowedincm
weightnumber
The weight of the package itself (excluding any contents).
weightUnitobject
handlestring
allowedpoundouncegramkilogram
abbreviatedHandlestring
allowedlbozgkg
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.
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).
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.
idinteger
fulfillmentRequestItemIdinteger
keystring
valuestring
bundleComponentsarray[FulfillmentRequestItemBundleComponent]
fulfillmentRequestItemIdintegerrequired
orderItemBundleComponentIdintegerrequired
lineItemNumberinteger
customFieldsarray[FulfillmentRequestItemAttribute]
idinteger
fulfillmentRequestItemIdinteger
keystring
valuestring
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]
idinteger
skustring
quantityinteger
shipmentIdinteger
inventoryVariantIdinteger (int64)
partialboolean
orderItemIdinteger
purchaseOrderItemIdinteger
this field will soon be deprecated, please start using `fulfillmentRequestItemId` instead. there are basically the same thing, just there has been a terminology change.
fulfillmentRequestItemIdinteger
committedStockReleasedQuantityinteger
rmaItemIdinteger
customFieldsarray[ShipmentCustomField]
customFieldsarray[ShipmentCustomField]
idinteger
namestring
valuestring
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]
idinteger
invoiceIdinteger
invoiceItemTypeobjectrequired
namestring
allowedProductShippingFeeTaxOther
handlestring
allowedproductshippingfeetaxother
sourceVariantIdinteger (int64)
costnumber
skustringrequired
titlestring
quantityinteger
perUnitCostnumber
externalAccountingItemIdstring
customFieldsarray[Source Invoice Custom Field]
totalCreditCostnumber
customFieldsarray[Source Invoice Custom Field]
idinteger
namestring
valuestring
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.
Example response
[
  {
    "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": 0,
      "name": "Joe Smith",
      "addressLine1": "120 1st Lane",
      "addressLine2": "Suite 123",
      "city": "Jacksonville",
      "state": "Florida",
      "country": "United States",
      "stateCode": "FL",
      "countryCode": "US",
      "postal": "12345",
      "email": "person@example.com",
      "phone": "1-555-123-4567",
      "companyName": "string",
      "firstName": "Joe",
      "lastName": "Smith",
      "redacted": true,
      "hash": "string"
    },
    "billingAddress": {
      "id": 0,
      "name": "Joe Smith",
      "addressLine1": "120 1st Lane",
      "addressLine2": "Suite 123",
      "city": "Jacksonville",
      "state": "Florida",
      "country": "United States",
      "stateCode": "FL",
      "countryCode": "US",
      "postal": "12345",
      "email": "person@example.com",
      "phone": "1-555-123-4567",
      "companyName": "string",
      "firstName": "Joe",
      "lastName": "Smith",
      "redacted": true,
      "hash": "string"
    },
    "shippingText": "string",
    "note": "string",
    "confirmationNumber": "string",
    "shippedStatus": "Not Started",
    "fulfillmentRequestStatus": {
      "name": "Unprocessed",
      "handle": "unprocessed"
    },
    "fulfillmentRequestFulfillmentStatus": {
      "name": "Awaiting Shipment",
      "handle": "awaiting_shipment"
    },
    "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": 0,
      "sourceId": 0,
      "description": "string",
      "carrier": "string",
      "method": "string",
      "shippingCode": "string",
      "shippingPolicy": {
        "id": 0,
        "name": "string",
        "deletedAt": "2026-04-20T00:00:00Z"
      },
      "deletedAt": "2026-04-20T00:00:00Z",
      "shippingCarrier": {
        "id": 0,
        "name": "string",
        "handle": "string",
        "shipEngineSupported": true
      },
      "shippingCarrierMethod": {
        "id": 0,
        "shippingCarrier": {
          "id": null,
          "name": null,
          "handle": null,
          "shipEngineSupported": null
        },
        "name": "string",
        "handle": "string"
      },
      "shippingLabelCode": "string",
      "defaultCarrierCode": "string",
      "defaultMethodCode": "string",
      "overrideDefaultCodes": true,
      "filterCarriersAndMethods": true,
      "shippingCarriers": [
        {
          "id": null,
          "name": null,
          "handle": null,
          "shipEngineSupported": null
        }
      ],
      "shippingCarrierMethods": [
        {
          "id": null,
          "shippingCarrier": null,
          "name": null,
          "handle": null
        }
      ],
      "useBestFitPackage": true,
      "commonPackages": [
        {
          "id": null,
          "length": null,
          "width": null,
          "height": null,
          "dimensionUnit": null,
          "weight": null,
          "weightUnit": null
        }
      ],
      "customPackages": [
        {
          "id": null,
          "name": null,
          "length": null,
          "width": null,
          "height": null,
          "dimensionUnit": null,
          "weight": null,
          "weightUnit": null,
          "createdAt": null,
          "createdByUserEmail": null,
          "updatedAt": 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": "inch",
      "abbreviatedHandle": "in"
    },
    "packageLength": 0,
    "packageWidth": 0,
    "packageHeight": 0,
    "packageWeightUnit": {
      "handle": "pound",
      "abbreviatedHandle": "lb"
    },
    "packageWeight": 0,
    "channelId": 0,
    "crossDockPurchaseOrderId": 0,
    "voidedReason": "string",
    "processingErrorReason": "string",
    "cancelReason": "string",
    "fulfillmentRequestItems": [
      {
        "id": 0,
        "sku": "string",
        "quantity": 0,
        "cost": 0,
        "itemReferenceId": "string",
        "referenceId": "string",
        "fulfillmentRequestId": 0,
        "shippedQuantity": 0,
        "voidedQuantity": 0,
        "acknowledgedQuantity": 0,
        "secondaryAcknowledgedQuantity": 0,
        "inventoryVariantId": 0,
        "orderItemId": 0,
        "title": "string",
        "externalAccountingItemId": "string",
        "canceledQuantity": 0,
        "weightUnit": {
          "handle": null,
          "abbreviatedHandle": null
        },
        "weight": 0,
        "dimensionUnit": {
          "handle": null,
          "abbreviatedHandle": null
        },
        "length": 0,
        "width": 0,
        "height": 0,
        "upc": "string",
        "mpn": "string",
        "attributes": [
          null
        ],
        "bundleComponents": [
          null
        ],
        "lineItemNumber": 0,
        "customFields": [
          null
        ],
        "binLocation": "string",
        "subtotal": 0
      }
    ],
    "shipments": [
      {
        "id": 0,
        "note": "string",
        "trackingUrl": "string",
        "trackingNumber": "string",
        "carrier": "string",
        "method": "string",
        "shippedAt": "2026-04-20T00:00:00Z",
        "insertedAt": "2026-04-20T00:00:00Z",
        "shippingCost": 0,
        "orderId": 0,
        "purchaseOrderId": 0,
        "fulfillmentRequestId": 0,
        "rmaId": 0,
        "sourceId": 0,
        "accountId": 0,
        "partial": true,
        "suppressed": true,
        "syncedToChannel": true,
        "syncError": "string",
        "crossDockPurchaseOrderId": 0,
        "shipmentItems": [
          null
        ],
        "customFields": [
          null
        ],
        "updatedAt": "2026-04-20T00:00:00Z",
        "accountingSynced": true
      }
    ],
    "invoices": [
      {
        "id": 0,
        "invoiceStatus": {
          "name": null,
          "handle": null
        },
        "insertedAt": "2026-04-20T00:00:00Z",
        "updatedAt": "2026-04-20T00:00:00Z",
        "purchaseOrderId": 0,
        "fulfillmentRequestId": 0,
        "rmaId": 0,
        "sourceId": 0,
        "purchaseOrderNumber": "string",
        "fulfillmentRequestNumber": "string",
        "invoiceNumber": "string",
        "invoiceDate": "2026-04-20T00:00:00Z",
        "totalCost": 0,
        "totalProductCost": 0,
        "totalShippingCost": 0,
        "totalFeeCost": 0,
        "totalTaxCost": 0,
        "totalOtherCost": 0,
        "totalQuantity": 0,
        "accountingSynced": true,
        "accountingSyncError": "string",
        "externalAccountingId": "string",
        "invoiceItems": [
          null
        ],
        "totalCreditCost": 0,
        "customFields": [
          null
        ],
        "commission": 0,
        "vendorPayoutId": 0
      }
    ],
    "fulfillmentRequestAttributes": [
      {
        "id": 0,
        "fulfillmentRequestId": 0,
        "key": "string",
        "value": "string"
      }
    ],
    "fulfillmentRequestType": {
      "id": 1,
      "name": "Purchase Order",
      "abbreviation": "PO",
      "handle": "purchase_order"
    },
    "shippingAddressId": 0,
    "billingAddressId": 0,
    "sourceShippingMethodId": 0,
    "shippingDistance": 0,
    "fulfillmentRequestReceivedStatus": {
      "handle": "awaiting_to_receive"
    },
    "carrierCode": "string",
    "methodCode": "string",
    "fulfillmentRequestPackage": {
      "id": 0,
      "fulfillmentRequestId": 0,
      "rateId": "string",
      "shipFromAddress": {
        "id": 0,
        "name": "Joe Smith",
        "addressLine1": "120 1st Lane",
        "addressLine2": "Suite 123",
        "city": "Jacksonville",
        "state": "Florida",
        "country": "United States",
        "stateCode": "FL",
        "countryCode": "US",
        "postal": "12345",
        "email": "person@example.com",
        "phone": "1-555-123-4567",
        "companyName": "string",
        "firstName": "Joe",
        "lastName": "Smith",
        "redacted": true,
        "hash": "string"
      },
      "shipToAddress": {
        "id": 0,
        "name": "Joe Smith",
        "addressLine1": "120 1st Lane",
        "addressLine2": "Suite 123",
        "city": "Jacksonville",
        "state": "Florida",
        "country": "United States",
        "stateCode": "FL",
        "countryCode": "US",
        "postal": "12345",
        "email": "person@example.com",
        "phone": "1-555-123-4567",
        "companyName": "string",
        "firstName": "Joe",
        "lastName": "Smith",
        "redacted": true,
        "hash": "string"
      },
      "createShipmentPostProcessing": true,
      "updateShipmentOnPurchase": true,
      "shippingDate": "2026-04-20T00:00:00Z",
      "length": 0,
      "width": 0,
      "height": 0,
      "dimensionUnit": {
        "handle": "inch",
        "abbreviatedHandle": "in"
      },
      "totalWeight": 0,
      "weightUnit": {
        "handle": "pound",
        "abbreviatedHandle": "lb"
      },
      "shippingCarrierMethod": {
        "id": 0,
        "shippingCarrier": {
          "id": null,
          "name": null,
          "handle": null,
          "shipEngineSupported": null
        },
        "name": "string",
        "handle": "string"
      },
      "rateShoppingProvider": {
        "id": 0,
        "name": "string",
        "handle": "string",
        "supportsLabelGeneration": true
      },
      "rateShoppingProviderLabelSize": "4x6",
      "commonPackage": {
        "id": 0,
        "length": 0,
        "width": 0,
        "height": 0,
        "dimensionUnit": {
          "handle": null,
          "abbreviatedHandle": null
        },
        "weight": 0,
        "weightUnit": {
          "handle": null,
          "abbreviatedHandle": null
        }
      },
      "customPackage": {
        "id": 0,
        "name": "string",
        "length": 0,
        "width": 0,
        "height": 0,
        "dimensionUnit": {
          "handle": null,
          "abbreviatedHandle": null
        },
        "weight": 0,
        "weightUnit": {
          "handle": null,
          "abbreviatedHandle": null
        },
        "createdAt": "2026-04-20T00:00:00Z",
        "createdByUserEmail": "string",
        "updatedAt": "2026-04-20T00:00:00Z"
      },
      "items": [
        {
          "id": null,
          "fulfillmentRequestPackageId": null,
          "fulfillmentRequestItemId": null,
          "quantity": null
        }
      ]
    },
    "buyShippingLabel": true,
    "orderFFL": {
      "id": 0,
      "orderId": 0,
      "crossDockPurchaseOrderId": 0,
      "licenseNumber": "string",
      "name": "string",
      "addressLine1": "string",
      "addressLine2": "string",
      "city": "string",
      "state": "string",
      "postal": "string",
      "phone": "string",
      "imageUrl": "string",
      "expiresAt": "2026-04-20T00:00:00Z",
      "companyName": "string"
    },
    "totalWeight": 0,
    "customFields": [
      {
        "id": 0,
        "fulfillmentRequestId": 0,
        "key": "string",
        "value": "string"
      }
    ],
    "attachmentLinks": [
      "string"
    ],
    "shippingLabelAttachmentLink": "string",
    "packingSlipAttachmentLink": "string",
    "tags": [
      "string"
    ],
    "fullyReceivedAt": "2026-04-20T00:00:00Z"
  }
]
400Bad Request

No schema documented for this status.

401Unauthorized

No schema documented for this status.

OpenAPI fragment
{
  "get": {
    "summary": "Get Fulfillment Request In Processing",
    "description": "This endpoint will retrieve a list of Fulfillment Requests AND `Update the Fulfillment Requests to Processed`\n\nNOTE : This means, if our API times out for you - those Fulfillment Requests may transition into a \"Processed\" state despite you not receiving them. \n\nIt's not recommended to use this endpoint, and it may be deprecated in the near future. We'd recommend using `GET /fulfillment-requests` to retrieve and `PATCH /fulfillment-requests/{fulfillmentRequestId}/acknowledge` to respond",
    "parameters": [
      {
        "schema": {
          "type": "integer"
        },
        "in": "query",
        "name": "filterSourceId",
        "description": "filter Fulfillment Request by Source ID"
      }
    ],
    "responses": {
      "200": {
        "description": "OK",
        "content": {
          "application/json": {
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/FulfillmentRequest"
              }
            }
          }
        }
      },
      "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