FlxpointAPI Help CenterBeta

Get Inbound Shipments

gethttps://api.flxpoint.com/inbound-shipments

Use this when you want to pull inbound shipments data through the API.

🔑 X-API-TOKEN⏱ 2 req/sToken: Account · Source · Channel

This page explains the endpoint. To send a live test request, use the interactive tester in Stoplight or your own Postman / HTTP client.

This endpoint allows you to get a list of ”inbound”, shipments from Stocking Purchase Orders and Transfer Orders. <br/><br/> Use the source token or an account token along with the sourceId to see the inbound shipments going to that source.

Request

Query parameters
  • sourceIdqueryinteger

    This field will automatically be populated if you are using a Source API Token. If you are using an Account API Token, this field is required.

  • receivedStatusquerystring

    status string signifying how much restocking has been done

    allowedawaiting_to_receivepartially_receivedreceivedvoided
  • shippedStatusquerystring

    status string to filter inbound shipments on the basis of their shipped status

    allowednot_startedpartially_completedcompleted
  • createdAfterquerystring (date-time)

    Filters down to Inbound Shipments that have been created after this timestamp. (Timestamp in UTC)

  • pagequeryinteger

    if not specified, defaults to: 1

  • pageSizequeryinteger

    If not provided, this field will be defaulted to "20"

  • sourceNamequerystring

    filter inbound shipments on the basis of source name. If sourceId and sourceName, both are provided, preference will be give to sourceId

Example request

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

Responses

200OKapplication/json
array[InboundShipment]
idinteger
purchaseOrderNumberstring
orderIdinteger
sourceIdinteger
generatedAtstring (date-time)
sentAtstring (date-time)
acknowledgedAtstring (date-time)
voidedAtstring (date-time)
canceledAtstring (date-time)
lastModifiedAtstring (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.
shippingAddressIdinteger
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.
billingAddressIdinteger
notestring
A note that can optionally be passed through all the way to the source
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
purchaseOrderReceivedStatusobject
handlestring
allowedawaiting_to_receivepartially_receivedreceivedvoided
totalCostnumber
totalQuantityinteger
shippedQuantityinteger
estimatedShippingCostnumber
estimatedDropshipFeenumber
beingProcessedboolean
packageDimensionUnitobject
handlestring
allowedinchcentimeter
abbreviatedHandlestring
allowedincm
packageLengthnumber
packageWidthnumber
packageHeightnumber
packageWeightUnitobject
handlestring
allowedpoundouncegramkilogram
abbreviatedHandlestring
allowedlbozgkg
packageWeightnumber
voidedReasonstring
processingErrorReasonstring
The reason this purchase order could not be processed
cancelReasonstring
itemsarray[InboundShipmentItem]
idinteger
orderItemIdinteger
purchaseOrderIdinteger
inventoryVariantIdinteger (int64)
restockingInventoryVariantIdinteger (int64)
skustring
This field represents the `originating sku` based on where this item is coming from. See `restockingSku` for the `destination sku` if available.
upcstring
While often the same, this represents the `originating UPC` based on where this item is coming from.
mpnstring
This represents the `originating MPN` based on where this item is coming from.
restockingSkustring
This field represents the `destination sku`. If no destination sku is provided, please revert back to the `sku` field (this means that we do not have a reference to this item in Flxpoint)
quantityinteger
acknowledgedQuantityinteger
default 0
shippedQuantityinteger
default 0
receivedQuantityinteger
default 0
voidedQuantityinteger
default 0
costnumber
canceledQuantityinteger
titlestring
weightnumber
weightUnitobject
handlestring
allowedpoundouncegramkilogram
abbreviatedHandlestring
allowedlbozgkg
lengthnumber
widthnumber
heightnumber
dimensionUnitobject
handlestring
allowedinchcentimeter
abbreviatedHandlestring
allowedincm
bundleComponentsarray[PurchaseOrderItemBundleComponent]
purchaseOrderItemIdintegerrequired
orderItemBundleComponentIdintegerrequired
purchaseOrderAttributesarray[PurchaseOrderAttribute]
idinteger
purchase_order_idinteger
keystring
valuestring
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
sourceNamestring
Example response
[
  {
    "id": 0,
    "purchaseOrderNumber": "string",
    "orderId": 0,
    "sourceId": 0,
    "generatedAt": "2026-04-20T00:00:00Z",
    "sentAt": "2026-04-20T00:00:00Z",
    "acknowledgedAt": "2026-04-20T00:00:00Z",
    "voidedAt": "2026-04-20T00:00:00Z",
    "canceledAt": "2026-04-20T00:00:00Z",
    "lastModifiedAt": "2026-04-20T00:00:00Z",
    "shippingAddress": {
      "id": 0,
      "name": "Joe Smith",
      "addressLine1": "120 1st Lane",
      "addressLine2": "Suite 123",
      "city": "Jacksonville",
      "state": "Florida",
      "country": "United States",
      "stateCode": "FL",
      "countryCode": "US",
      "postal": "12345",
      "email": "person@example.com",
      "phone": "1-555-123-4567",
      "companyName": "string",
      "firstName": "Joe",
      "lastName": "Smith",
      "redacted": true,
      "hash": "string"
    },
    "shippingAddressId": 0,
    "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"
    },
    "billingAddressId": 0,
    "note": "string",
    "shippedStatus": "Not Started",
    "purchaseOrderStatus": {
      "name": "Unprocessed",
      "handle": "unprocessed"
    },
    "purchaseOrderReceivedStatus": {
      "handle": "awaiting_to_receive"
    },
    "totalCost": 0,
    "totalQuantity": 0,
    "shippedQuantity": 0,
    "estimatedShippingCost": 0,
    "estimatedDropshipFee": 0,
    "beingProcessed": true,
    "packageDimensionUnit": {
      "handle": "inch",
      "abbreviatedHandle": "in"
    },
    "packageLength": 0,
    "packageWidth": 0,
    "packageHeight": 0,
    "packageWeightUnit": {
      "handle": "pound",
      "abbreviatedHandle": "lb"
    },
    "packageWeight": 0,
    "voidedReason": "string",
    "processingErrorReason": "string",
    "cancelReason": "string",
    "items": [
      {
        "id": 0,
        "orderItemId": 0,
        "purchaseOrderId": 0,
        "inventoryVariantId": 0,
        "restockingInventoryVariantId": 0,
        "sku": "string",
        "upc": "string",
        "mpn": "string",
        "restockingSku": "string",
        "quantity": 0,
        "acknowledgedQuantity": 0,
        "shippedQuantity": 0,
        "receivedQuantity": 0,
        "voidedQuantity": 0,
        "cost": 0,
        "canceledQuantity": 0,
        "title": "string",
        "weight": 0,
        "weightUnit": {
          "handle": null,
          "abbreviatedHandle": null
        },
        "length": 0,
        "width": 0,
        "height": 0,
        "dimensionUnit": {
          "handle": null,
          "abbreviatedHandle": null
        },
        "bundleComponents": [
          null
        ]
      }
    ],
    "purchaseOrderAttributes": [
      {
        "id": 0,
        "purchase_order_id": 0,
        "key": "string",
        "value": "string"
      }
    ],
    "shipments": [
      {
        "id": 0,
        "note": "string",
        "trackingUrl": "string",
        "trackingNumber": "string",
        "carrier": "string",
        "method": "string",
        "shippedAt": "2026-04-20T00:00:00Z",
        "insertedAt": "2026-04-20T00:00:00Z",
        "shippingCost": 0,
        "orderId": 0,
        "purchaseOrderId": 0,
        "fulfillmentRequestId": 0,
        "rmaId": 0,
        "sourceId": 0,
        "accountId": 0,
        "partial": true,
        "suppressed": true,
        "syncedToChannel": true,
        "syncError": "string",
        "crossDockPurchaseOrderId": 0,
        "shipmentItems": [
          null
        ],
        "customFields": [
          null
        ],
        "updatedAt": "2026-04-20T00:00:00Z",
        "accountingSynced": true
      }
    ],
    "sourceName": "string"
  }
]
400Bad Request

No schema documented for this status.

401Unauthorizedapplication/json
No properties documented.
Example response
{}
OpenAPI fragment
{
  "get": {
    "summary": "Get Inbound Shipments",
    "description": "This endpoint allows you to get a list of ”inbound”, shipments from Stocking Purchase Orders and Transfer Orders. \n<br/><br/>\nUse the source token or an account token along with the sourceId to see the inbound shipments going to that source.",
    "parameters": [
      {
        "schema": {
          "type": "integer"
        },
        "in": "query",
        "name": "sourceId",
        "description": "This field will automatically be populated if you are using a Source API Token. If you are using an Account API Token, this field is required."
      },
      {
        "schema": {
          "type": "string",
          "enum": [
            "awaiting_to_receive",
            "partially_received",
            "received",
            "voided"
          ]
        },
        "in": "query",
        "name": "receivedStatus",
        "description": "status string signifying how much restocking has been done"
      },
      {
        "schema": {
          "type": "string",
          "enum": [
            "not_started",
            "partially_completed",
            "completed"
          ]
        },
        "in": "query",
        "name": "shippedStatus",
        "description": "status string to filter inbound shipments on the basis of their shipped status"
      },
      {
        "schema": {
          "type": "string",
          "format": "date-time",
          "example": "2020-10-14T16:05:00.000Z"
        },
        "in": "query",
        "name": "createdAfter",
        "description": "Filters down to Inbound Shipments that have been created after this timestamp. (Timestamp in UTC)"
      },
      {
        "schema": {
          "type": "integer",
          "default": 1
        },
        "in": "query",
        "name": "page",
        "description": "if not specified, defaults to: 1"
      },
      {
        "schema": {
          "type": "integer",
          "default": 20
        },
        "in": "query",
        "name": "pageSize",
        "description": "If not provided, this field will be defaulted to \"20\""
      },
      {
        "schema": {
          "type": "string"
        },
        "in": "query",
        "name": "sourceName",
        "description": "filter inbound shipments on the basis of source name. If sourceId and sourceName, both are provided, preference will be give to sourceId"
      }
    ],
    "responses": {
      "200": {
        "description": "OK",
        "content": {
          "application/json": {
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/InboundShipment"
              }
            }
          }
        }
      },
      "400": {
        "description": "Bad Request"
      },
      "401": {
        "description": "Unauthorized",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {}
            }
          }
        }
      }
    }
  }
}
Ready to run it? Send the curl from your terminal or Postman, or use the interactive tester in Stoplight.Open in Stoplight