Get Fulfillment Requests

{
  "get": {
    "summary": "Get Fulfillment Requests",
    "description": "This endpoint will retrieve back Fulfillment Requests.\nFulfillment Requests can be retrieved using an Account or Source token. \nIf an Account Token is used, eligible Fulfillment Requests for the account will be fetched.\nWith a source token, Fulfillment Requests for the source can only be retrieved.\n\nAll filter parameters are optional. Passing a null or an empty value will ignore filtering for the specified conditions.\n\n",
    "parameters": [
      {
        "schema": {
          "type": "integer"
        },
        "in": "query",
        "name": "findOrderId",
        "description": "Filter Fulfillment Requests by Order ID."
      },
      {
        "schema": {
          "type": "integer"
        },
        "in": "query",
        "name": "sinceId",
        "description": "If passed, returns results with an ID greater than this.",
        "allowEmptyValue": true
      },
      {
        "schema": {
          "type": "array",
          "maxItems": 50,
          "example": "PO123,PO456,PO789",
          "uniqueItems": true,
          "items": {
            "type": "string"
          },
          "deprecated": true
        },
        "in": "query",
        "name": "poNumbers",
        "description": "deprecated use `frNumbers`. Finds elements matching these Fulfillment Request Numbers. Max 50",
        "style": "form",
        "deprecated": true
      },
      {
        "schema": {
          "type": "array",
          "maxItems": 50,
          "example": "PO123,PO456,PO789",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "in": "query",
        "name": "frNumbers",
        "description": "Finds elements matching these Fulfillment Request Numbers. Max 50",
        "style": "form",
        "explode": false
      },
      {
        "schema": {
          "type": "integer"
        },
        "in": "query",
        "name": "filterSourceId",
        "description": "Filter Fulfillment Requests by Source ID."
      },
      {
        "schema": {
          "type": "string",
          "enum": [
            "Awaiting Shipment",
            "Shipped",
            "Partially Shipped",
            "Canceled"
          ]
        },
        "in": "query",
        "name": "filterFulfilmentStatus",
        "description": "Filter Fulfillment Requests by Fulfillment \"Shipped\" Status. Accepts a comma-separated list to filter on multiple statuses at once."
      },
      {
        "schema": {
          "type": "boolean"
        },
        "in": "query",
        "name": "filterInvoiced",
        "description": "Filter Fulfillment Requests that have source invoice available."
      },
      {
        "schema": {
          "type": "integer",
          "default": 1
        },
        "in": "query",
        "name": "filterPageNumber",
        "description": "Current Page"
      },
      {
        "schema": {
          "type": "integer",
          "default": 20,
          "minimum": 1,
          "maximum": 100
        },
        "in": "query",
        "name": "filterPageSize",
        "description": "Number of entries per page"
      },
      {
        "schema": {
          "type": "string",
          "enum": [
            "Unprocessed",
            "Processed",
            "Acknowledged",
            "Canceled",
            "Failed",
            "Voided",
            "Processing",
            "Additional Info Required",
            "PO/FR # Exceeds Max Length",
            "Duplicate PO/FR #",
            "Cross Docked"
          ]
        },
        "in": "query",
        "name": "filterStatus",
        "description": "Filter Fulfillment Requests by Fulfillment Requests Status. Accepts a comma-separated list to filter on multiple statuses at once."
      },
      {
        "schema": {
          "type": "boolean"
        },
        "in": "query",
        "name": "filterIsAcknowledged",
        "description": "Filters Fulfillment Requests based on whether or they were acknowledged (true returns only acknowledged, false only those that are not acknowledged)."
      },
      {
        "schema": {
          "type": "string",
          "format": "date-time",
          "example": "2023-04-25T13:56:22.014Z"
        },
        "in": "query",
        "name": "filterAcknowledgedAfter",
        "description": "Filter Fulfillment Requests that were acknowledged after this date-time."
      },
      {
        "schema": {
          "type": "boolean"
        },
        "in": "query",
        "name": "filterIsSent",
        "description": "Filters Fulfillment Requests based on whether or they have been sent to the source (true returns only those that have been sent, false only those that have not yet been sent)."
      },
      {
        "schema": {
          "type": "string",
          "format": "date-time",
          "example": "2023-04-25T13:56:22.014Z"
        },
        "in": "query",
        "name": "filterSentAfter",
        "description": "Filter Fulfillment Requests that were sent from Flxpoint to the source after this date-time. FRs processed outside of Flxpoint will most likely not have a time set."
      },
      {
        "schema": {
          "type": "string",
          "format": "date-time",
          "example": "2023-04-25T13:56:22.014Z"
        },
        "in": "query",
        "name": "filterGeneratedAfter",
        "description": "Filter Fulfillment Requests that were generated after this date-time."
      },
      {
        "schema": {
          "type": "boolean"
        },
        "in": "query",
        "name": "filterIsCanceled",
        "description": "Filters Fulfillment Requests based on whether or they were canceled (true returns only canceled, false only those that are not canceled)."
      },
      {
        "schema": {
          "type": "string",
          "format": "date-time",
          "example": "2023-04-25T13:56:22.014Z"
        },
        "in": "query",
        "name": "filterCanceledAfter",
        "description": "Filters Fulfillment Requests that were canceled after this date-time."
      },
      {
        "schema": {
          "type": "boolean"
        },
        "in": "query",
        "name": "filterIsVoided",
        "description": "Filters Fulfillment Requests based on whether or they were voided (true returns only voided, false only those that are not voided)."
      },
      {
        "schema": {
          "type": "string",
          "format": "date-time",
          "example": "2023-04-25T13:56:22.014Z"
        },
        "in": "query",
        "name": "filterVoidedAfter",
        "description": "Filters Fulfillment Requests that were voided after this date-time."
      },
      {
        "schema": {
          "type": "boolean"
        },
        "in": "query",
        "name": "filterIsHeld",
        "description": "Filters Fulfillment Requests based on whether or not they are held.  When `true` is passed, it retrieves Fulfillment Requests that have hold until time set. When `false` is passed, it retrieves Fulfillment Requests that have no hold until time set or ones whose hold until time has elapsed (current time is after the `hold until` time)"
      },
      {
        "schema": {
          "type": "boolean"
        },
        "in": "query",
        "name": "filterHasError",
        "description": "Filters Fulfillment Requests based on whether or they have a processing error (true returns only those with errors, false only those without errors)."
      },
      {
        "schema": {
          "type": "boolean"
        },
        "in": "query",
        "name": "filterEligibleForProcessing",
        "description": "Use this to filter Fulfillment Requests that are eligible for processing. Passing true will return FRs only where the related order (if applicable) is in Open or Not Managed status and the FR is in Unprocessed status. Passing false will return FRs where the order (if applicable) is not in either of those statuses, or if so the FR has been transitioned out of Unprocessed status. Passing \"null\" or an empty value will not filter FRs based on order or FR status."
      },
      {
        "schema": {
          "type": "array",
          "example": "1234,1235,1257",
          "uniqueItems": true,
          "items": {
            "type": "integer"
          },
          "deprecated": true,
          "maxItems": 4
        },
        "in": "query",
        "name": "filterPurchaseOrderTypeIds",
        "description": "deprecated use `filterFulfillmentRequestType` Filter Fulfillment Requests by type id, using ids from the PurchaseOrderType Enum.",
        "style": "form",
        "deprecated": true
      },
      {
        "schema": {
          "type": "array",
          "enum": [
            "Purchase Order",
            "Fulfillment Order",
            "Transfer Order",
            "Stocking Purchase Order"
          ],
          "example": "Fulfillment Order, Transfer Order",
          "uniqueItems": true,
          "maxItems": 4,
          "items": {
            "type": "string"
          }
        },
        "in": "query",
        "name": "filterFulfillmentRequestType",
        "description": "Filter Fulfillment Requests by Type, Accepts a comma-separated list to filter on multiple types at once.",
        "explode": true
      },
      {
        "schema": {
          "type": "boolean"
        },
        "in": "query",
        "name": "isPurchaseOrderAccountingSynced",
        "description": "deprecated use `isFulfillmentRequestAccountingSynced`. Filter to only include or exclude Fulfillment Requests that have been synced to an Accounting Integration.",
        "deprecated": true
      },
      {
        "schema": {
          "type": "boolean"
        },
        "in": "query",
        "name": "isFulfillmentRequestAccountingSynced",
        "description": "Filter to only include or exclude Fulfillment Requests that have been synced to an Accounting Integration"
      },
      {
        "schema": {
          "type": "boolean"
        },
        "in": "query",
        "name": "isOrderAccountingSynced",
        "description": "Filter to only include or exclude those created for Orders that have been synced to an Accounting Integration. Does not relate to the whether or not the Fulfillment Requests has been synced."
      },
      {
        "schema": {
          "type": "boolean"
        },
        "in": "query",
        "name": "hasAccountingError",
        "description": "Filter to include or exclude Fulfillment Requests based on whether or not they have a previous error saved while sending to an Accounting Integration"
      },
      {
        "schema": {
          "type": "boolean"
        },
        "in": "query",
        "name": "filterOrderInvoiced",
        "description": "Filter to only include or exclude those created for Orders that have invoices. Does not relate to the whether or not the Fulfillment Requests has been invoiced."
      },
      {
        "schema": {
          "type": "boolean",
          "default": "false"
        },
        "in": "query",
        "name": "includeTags",
        "description": "Determines if \"tags\" are returned in the response "
      },
      {
        "schema": {
          "type": "string"
        },
        "in": "query",
        "name": "hasTag",
        "description": "Only returns Fulfillment Requests that have the matching tag"
      },
      {
        "schema": {
          "type": "boolean"
        },
        "in": "query",
        "name": "filterStockCommitted",
        "description": "Filter Fulfillment Requests that have stock committed."
      },
      {
        "schema": {
          "type": "string",
          "enum": [
            "Open",
            "Closed",
            "On Hold",
            "Failed",
            "No Shipping Method",
            "Canceled",
            "Not Managed"
          ]
        },
        "in": "query",
        "name": "filterOrderStatus",
        "description": "Only returns Fulfillment Requests associated with orders that have the matching status."
      }
    ],
    "responses": {
      "200": {
        "description": "OK",
        "content": {
          "application/json": {
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/FulfillmentRequest"
              }
            }
          }
        }
      },
      "400": {
        "description": "Bad Request",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/GenericApiError"
            }
          }
        }
      },
      "401": {
        "description": "Unauthorized"
      },
      "404": {
        "description": "Not Found"
      }
    }
  }
}