Flexport Logistics API

https://docs.logistics-api.flexport.com/2026-02
Admin
Flexport Logistics API is a REST API that provides access to Flexport's logistics network for order...
Tokens:130,658
Snippets:325
Trust Score:10
Update:7 months ago
Show doc for...
Tokens:
Raw
### GET /products

Source: https://docs.logistics-api.flexport.com/2026-02/tag/Products

Retrieves a list of products currently registered in the system.

```APIDOC
## GET /products

### Description
Retrieves a paginated list of all products associated with the account.

### Method
GET

### Endpoint
/products

### Query Parameters
- **limit** (integer) - Optional - Number of records to return
- **offset** (integer) - Optional - Number of records to skip

### Response
#### Success Response (200)
- **products** (array) - List of product objects

#### Response Example
{
  "products": [
    {
      "id": "prod_12345",
      "sku": "PROD-001"
    }
  ]
}
```

--------------------------------

### Inventory Response Schema Example (JSON)

Source: https://docs.logistics-api.flexport.com/2026-02/tag/Products

An example of the JSON response structure for inventory data, detailing fields like logisticsSku, onHand, available, unavailable, unitsPerPack, lotTrackingDetails, and breakdown. Includes nested structures for lot tracking and pack inventory breakdowns.

```json
[
  {
    "logisticsSku": "stringstrin",
    "onHand": 0,
    "available": 0,
    "unavailable": 0,
    "unitsPerPack": 0,
    "lotTrackingDetails": [
      {
        "lotNumber": "string",
        "expirationDate": "2019-08-24T14:15:22Z",
        "available": 0
      }
    ],
    "breakdown": [
      {
        "logisticsSku": "string",
        "onHand": 0,
        "available": 0,
        "unavailable": 0,
        "unitsPerPack": 0,
        "lotTrackingDetails": [
          {
            "lotNumber": "string",
            "expirationDate": "2019-08-24T14:15:22Z",
            "available": 0
          }
        ],
        "dimensions": {
          "height": 0,
          "length": 0,
          "lengthUnit": "in",
          "weight": 0,
          "weightUnit": "oz",
          "width": 0
        }
      }
    ]
  }
]
```

--------------------------------

### Get Inbound Shipment Details (JSON Response)

Source: https://docs.logistics-api.flexport.com/2026-02/tag/Inbounds

Example JSON response for retrieving details of an inbound shipment. This schema includes shipment status, package dimensions and contents, freight information, destination and origin addresses, and container details.

```json
{
  "status": "PENDING",
  "packages": [
    {
      "length": 12,
      "width": 3,
      "height": 5,
      "weight": 3,
      "dimensionUnit": "in",
      "weightUnit": "oz",
      "id": "string",
      "identicalPackageConfigIdentifer": "string",
      "items": [
        {
          "logisticsSku": "string",
          "quantity": 0,
          "lotNumber": "string",
          "expirationDate": "2019-08-24",
          "lineItemId": "string"
}
],
      "sellerLPN": "string"
}
],
  "id": "string",
  "prep": {
    "boxContentLabels": true
},
  "shippingPlanExternalId": "string",
  "shippingPlanName": "string",
  "bookingId": "string",
  "shippingPlanId": "string",
  "freight": {
    "pickup": {
      "id": 0,
      "contactName": "string",
      "contactPhone": "string",
      "contactEmail": "string",
      "liftGate": true,
      "pickupDate": "2019-08-24T14:15:22Z",
      "customerReferenceNumber": "string",
      "facilityOperatingHours": {
        "startTime": "string",
        "endTime": "string"
}
},
    "pallets": [
      {
        "id": 0,
        "palletConfigId": "string",
        "length": 0,
        "width": 0,
        "height": 0,
        "dimensionUnit": "string",
        "weight": 0,
        "weightUnit": "string"
}
],
    "bolId": "string",
    "shippingProvider": "string",
    "proId": "string",
    "estimatedShipDate": "2019-08-24T14:15:22Z",
    "carrierEmailAddress": "string"
},
  "arrivedAt": "2019-08-24T14:15:22Z",
  "completedAt": "2019-08-24T14:15:22Z",
  "shipmentDestination": "NETWORK",
  "cargoType": "PALLETIZED",
  "container": {
    "size": "GENERAL_20FT",
    "id": "string"
},
  "shippingOption": "SPD_EXTERNAL",
  "receivingId": "string",
  "addresses": {
    "to": {
      "address1": "string",
      "address2": "string",
      "city": "string",
      "company": "string",
      "countryCode": "AF",
      "name": "string",
      "firstName": "string",
      "lastName": "string",
      "phone": "string",
      "provinceCode": "string",
      "zip": "string"
},
    "from": {
      "address1": "string"
}
}
}
```

--------------------------------

### GET /logistics/api/2026-02/returns

Source: https://docs.logistics-api.flexport.com/2026-02/tag/Returns

Retrieves a list of all logistics returns.

```APIDOC
## GET /logistics/api/2026-02/returns

### Description
Retrieves a list of returns associated with the account.

### Method
GET

### Endpoint
/logistics/api/2026-02/returns

### Response
#### Success Response (200)
- **id** (number) - Unique identifier of the return.
- **status** (string) - Current status (CREATED, SHIPPED, RECEIVED_FOR_PROCESSING, PROCESSED, CANCELLED).
- **rma** (string) - RMA of the return.
- **externalReturnId** (string) - Unique reference to the return order.

#### Response Example
[
  {
    "id": 0,
    "status": "CREATED",
    "rma": "string",
    "externalReturnId": "string"
  }
]
```

--------------------------------

### GetAllInventoryByCursor Endpoint (API Request Example)

Source: https://docs.logistics-api.flexport.com/2026-02/tag/Products

Demonstrates how to call the GetAllInventoryByCursor endpoint to retrieve a cursor-paginated list of inventory information. It highlights the use of query parameters like 'limit', 'cursor', and 'poolName' for filtering and pagination. The 'poolName' parameter can be set to 'STORAGE' to include reserve storage quantities.

```http
GET /logistics/api/2026-02/products/inventory/all?limit=20&cursor=string&poolName=DEFAULT HTTP/1.1
Host: api.flexport.com
Authorization: BEARER <your_access_token>
```

--------------------------------

### POST /products

Source: https://docs.logistics-api.flexport.com/2026-02/tag/Products

Creates a new product record in the system. Product records are required for tracking physical attributes and inbounding inventory.

```APIDOC
## POST /products

### Description
Creates a new product record. Product records are the primary entities for tracking physical product attributes, including inventory and dimensions.

### Method
POST

### Endpoint
/products

### Request Body
- **title** (string) - Required - The name of the product
- **sku** (string) - Required - Unique identifier for the product
- **weight** (number) - Optional - Weight of the product
- **dimensions** (object) - Optional - Length, width, and height of the product

### Request Example
{
  "title": "Example Product",
  "sku": "PROD-001",
  "weight": 1.5
}

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the created product
- **dimsLocked** (boolean) - Indicates if dimensions are verified and locked

#### Response Example
{
  "id": "prod_12345",
  "dimsLocked": false
}
```

--------------------------------

### Returns API

Source: https://docs.logistics-api.flexport.com/2026-02/tag/Bundles

Endpoints for managing product returns.

```APIDOC
## POST /returns/orders

### Description
Create a return order.

### Method
POST

### Endpoint
/returns/orders

### Request Body
- **order_id** (string) - Required - The ID of the original order.
- **items** (array) - Required - A list of items to return.
```

```APIDOC
## GET /returns/orders

### Description
Get a list of return orders.

### Method
GET

### Endpoint
/returns/orders
```

```APIDOC
## POST /returns/orders/{returnId}/cancel

### Description
Cancel a return order.

### Method
POST

### Endpoint
/returns/orders/{returnId}/cancel

### Parameters
#### Path Parameters
- **returnId** (string) - Required - The ID of the return order to cancel.
```

```APIDOC
## GET /returns/orders/{returnId}

### Description
Get details for a specific return order.

### Method
GET

### Endpoint
/returns/orders/{returnId}

### Parameters
#### Path Parameters
- **returnId** (string) - Required - The ID of the return order.
```

--------------------------------

### GET /logistics/api/2026-02/bundles

Source: https://docs.logistics-api.flexport.com/2026-02/tag/Bundles

Retrieves a paginated list of all bundles associated with the account.

```APIDOC
## GET /logistics/api/2026-02/bundles

### Description
Returns a list of bundles. Supports pagination via limit and cursor parameters.

### Method
GET

### Endpoint
/logistics/api/2026-02/bundles

### Parameters
#### Query Parameters
- **limit** (number) - Optional - Number of bundles to return (default 20, max 100).
- **cursor** (string) - Optional - Cursor for fetching the next set of results.

### Response
#### Success Response (200)
- **bundles** (Array) - List of bundle objects.
- **nextCursor** (string) - Cursor for the next page of results.

#### Response Example
{
  "bundles": [{
    "externalBundleId": "ext-123",
    "title": "Starter Kit",
    "sku": "SKU-KIT-001",
    "bundleContents": [{"productId": "D1234567890", "quantity": 1}],
    "bundleId": "B1234567890",
    "createdAt": "2019-08-24T14:15:22Z"
  }],
  "nextCursor": "eyJhbGciOiJIUzI1NiJ9"
}
```

--------------------------------

### Inbound Shipment Creation Response (JSON)

Source: https://docs.logistics-api.flexport.com/2026-02/tag/Inbounds

Example JSON response for a successful inbound shipment creation (201 Created). It includes shipment details, item information, package details, and timestamps.

```json
{
  "id": "string",
  "receivingId": "string",
  "status": "PENDING",
  "items": [
    {
      "logisticsSku": "string",
      "shipmentItemId": "string",
      "counts": {
        "sellable": 0,
        "damaged": 0,
        "expected": 0
      },
      "lineItemId": "string",
      "merchantSku": "string"
    }
  ],
  "packages": [
    {
      "length": 12,
      "width": 3,
      "height": 5,
      "weight": 3,
      "dimensionUnit": "in",
      "weightUnit": "oz",
      "id": "string",
      "identicalPackageConfigIdentifer": "string",
      "items": [
        {
          "logisticsSku": "string",
          "quantity": 0,
          "lotNumber": "string",
          "expirationDate": "2019-08-24",
          "lineItemId": "string"
        }
      ],
      "sellerLPN": "string"
    }
  ],
  "arrivedAt": "2019-08-24T14:15:22Z",
  "completedAt": "2019-08-24T14:15:22Z",
  "shippingPlanId": "string",
  "shippingPlanExternalId": "string",
  "shippingPlanName": "string",
  "bookingId": "string",
  "shippingOption": "SPD_EXTERNAL",
  "addresses": {
    "to": {
      "address1": "string",
      "address2": "string",
      "city": "string",
      "company": "string",
      "countryCode": "AF",
      "name": "string",
      "firstName": "string",
      "lastName": "string",
      "phone": "string",
      "provinceCode": "string",
      "zip": "string"
    },
    "from": {
      "address1": "string",
      "address2": "string",
      "city": "string",
      "company": "string",
      "countryCode": "AF",
      "name": "string"
    }
  }
}
```

--------------------------------

### GET /logistics/api/2026-02/webhooks

Source: https://docs.logistics-api.flexport.com/2026-02/tag/Webhooks

Retrieves a list of all currently registered and active webhooks.

```APIDOC
## GET /logistics/api/2026-02/webhooks

### Description
Retrieves a list of all currently registered and active webhooks.

### Method
GET

### Endpoint
/logistics/api/2026-02/webhooks

### Parameters
#### Query Parameters
None

### Response
#### Success Response (200)
- An array of webhook objects, each containing:
  - **type** (string) - Type of the webhook.
  - **url** (string) - URL of the webhook.
  - **method** (string) - HTTP method of the webhook.
  - **authMethod** (string) - Authentication method used.
  - **username** (string) - Username if BASIC_AUTH is used.
  - **password** (string) - Password if BASIC_AUTH is used.
  - **token** (string) - Token if TOKEN auth is used.
  - **tokenHeader** (string) - Token header if TOKEN auth is used.
  - **id** (number) - Unique identifier for the webhook.

#### Response Example
```json
[
  {
    "type": "Order.Shipped",
    "url": "https://example.com/webhook",
    "method": "POST",
    "authMethod": "TOKEN",
    "token": "your_secret_token",
    "tokenHeader": "X-API-Key",
    "id": 123
  }
]
```

#### Error Responses
- **401** Unauthorized
```

--------------------------------

### GET /logistics/api/2026-02/inbounds/shipments

Source: https://docs.logistics-api.flexport.com/2026-02/tag/Inbounds

Retrieves a list of inbound shipments. Supports filtering and pagination.

```APIDOC
## GET /logistics/api/2026-02/inbounds/shipments

### Description
Retrieves a list of inbound shipments. This endpoint allows you to fetch details about shipments that are inbound to your logistics network.

### Method
GET

### Endpoint
/logistics/api/2026-02/inbounds/shipments

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - The maximum number of shipments to return.
- **offset** (integer) - Optional - The number of shipments to skip before starting to collect the result set.
- **status** (string) - Optional - Filters shipments by their current status. Possible values: "PENDING", "READY_TO_SHIP", "IN_TRANSIT", "ARRIVED", "PREPARING_FOR_DISTRIBUTION", "IN_PREP", "FORWARDING", "RECEIVING", "COMPLETED".

### Request Example
```
GET /logistics/api/2026-02/inbounds/shipments?limit=10&status=IN_TRANSIT
```

### Response
#### Success Response (200)
- **status** (string) - The current status of the shipment. Enum: "PENDING", "READY_TO_SHIP", "IN_TRANSIT", "ARRIVED", "PREPARING_FOR_DISTRIBUTION", "IN_PREP", "FORWARDING", "RECEIVING", "COMPLETED".
- **packages** (Array of objects) - An array of package details for the shipment.
  - **id** (string) - Unique identifier for the package.
  - **prep** (object) - Preparation details for the package.
  - **shippingPlanExternalId** (string) - The external shipment ID provided in the request.
  - **shippingPlanName** (string) - The name of the shipping plan.
  - **bookingId** (string) - The booking ID associated with the shipment.
  - **shippingPlanId** (string) - The unique identifier for the shipping plan.
  - **freight** (object) - Freight details for the shipment.
  - **arrivedAt** (string) - The date and time the shipment arrived.
  - **completedAt** (string) - The date and time the shipment was completed.
  - **shipmentDestination** (string) - The destination of the shipment. Enum: "NETWORK", "STORAGE".
  - **cargoType** (string) - The type of cargo. Enum: "PALLETIZED", "FLOOR_LOADED_CONTAINER".
  - **container** (object) - Container details if applicable.
  - **shippingOption** (string) - The shipping option selected. Enum: "SPD_EXTERNAL", "FREIGHT_EXTERNAL", "LTL_EXTERNAL", "LTL_INTERNAL", "FTL_INTERNAL", "SPD_INTERNAL".
  - **receivingId** (string) - The ID for receiving the shipment.
  - **addresses** (object) - Address details for the shipment.
  - **items** (Array of objects) - An array of item details within the shipment.

#### Response Example
```json
[
  {
    "status": "PENDING",
    "packages": [
      {
        "length": 12,
        "width": 3,
        "height": 5,
        "weight": 3,
        "dimensionUnit": "in",
        "weightUnit": "oz",
        "id": "string",
        "identicalPackageConfigIdentifer": "string",
        "items": [
          {
            "logisticsSku": "string",
            "quantity": 0,
            "lotNumber": "string",
            "expirationDate": "2019-08-24",
            "lineItemId": "string"
          }
        ],
        "sellerLPN": "string"
      }
    ],
    "id": "string",
    "prep": {
      "boxContentLabels": true
    },
    "shippingPlanExternalId": "string",
    "shippingPlanName": "string",
    "bookingId": "string",
    "shippingPlanId": "string",
    "freight": {
      "pickup": {
        "id": 0,
        "contactName": "string",
        "contactPhone": "string",
        "contactEmail": "string",
        "liftGate": true,
        "pickupDate": "2019-08-24T14:15:22Z",
        "customerReferenceNumber": "string",
        "facilityOperatingHours": {
          "startTime": "string",
          "endTime": "string"
        }
      },
      "pallets": [
        {
          "id": 0,
          "palletConfigId": "string",
          "length": 0,
          "width": 0,
          "height": 0,
          "dimensionUnit": "string",
          "weight": 0,
          "weightUnit": "string"
        }
      ],
      "bolId": "string",
      "shippingProvider": "string",
      "proId": "string",
      "estimatedShipDate": "2019-08-24T14:15:22Z",
      "carrierEmailAddress": "string"
    },
    "arrivedAt": "2019-08-24T14:15:22Z",
    "completedAt": "2019-08-24T14:15:22Z",
    "shipmentDestination": "NETWORK",
    "cargoType": "PALLETIZED",
    "container": {
      "size": "GENERAL_20FT",
      "id": "string"
    },
    "shippingOption": "SPD_EXTERNAL",
    "receivingId": "string",
    "addresses": {
      "to": {
        "address1": "string",
        "address2": "string",
        "city": "string",
        "company": "string",
        "countryCode": "AF",
        "name": "string",
        "firstName": "string",
        "lastName": "string",
        "phone": "string",
        "provinceCode": "string",
        "zip": "string"
      },
      "from": {
        "address1": "string",
        "address2": "string",
        "city": "string",
        "company": "string",
        "countryCode": "AF",
        "name": "string",
        "firstName": "string",
        "lastName": "string",
        "phone": "string",
        "provinceCode": "string",
        "zip": "string"
      }
    },
    "items": [
      {
        "logisticsSku": "string",
        "shipmentItemId": "string",
        "counts": {
          "sellable": 0,
          "damaged": 0,
          "expected": 0
        },
        "lineItemId": "string",
        "merchantSku": "string",
        "packOfDsku": "string",
        "caseQty": 0
      }
    ]
  }
]
```

#### Error Responses
- **400** Bad Request
- **401** Unauthorized
- **403** Forbidden
- **404** Shipment not found
```

--------------------------------

### Products API

Source: https://docs.logistics-api.flexport.com/2026-02/tag/Bundles

Endpoints for managing products and inventory.

```APIDOC
## POST /products

### Description
Create a new product.

### Method
POST

### Endpoint
/products

### Request Body
- **name** (string) - Required - The name of the product.
- **sku** (string) - Required - The Stock Keeping Unit for the product.
```

```APIDOC
## GET /products

### Description
Get a list of products.

### Method
GET

### Endpoint
/products
```

```APIDOC
## GET /products/{productId}

### Description
Get details for a specific product.

### Method
GET

### Endpoint
/products/{productId}

### Parameters
#### Path Parameters
- **productId** (string) - Required - The ID of the product.
```

```APIDOC
## GET /products/aliases

### Description
Get product aliases.

### Method
GET

### Endpoint
/products/aliases
```

```APIDOC
## GET /products/inventory

### Description
Get inventory information for products.

### Method
GET

### Endpoint
/products/inventory
```

```APIDOC
## GET /products/inventory/all

### Description
Get all inventory information for products.

### Method
GET

### Endpoint
/products/inventory/all
```

```APIDOC
## GET /products/inventory/all/cursor

### Description
Get all inventory information for products using cursor-based pagination.

### Method
GET

### Endpoint
/products/inventory/all/cursor
```

```APIDOC
## POST /products/warehouse-details

### Description
Get warehouse details for products.

### Method
POST

### Endpoint
/products/warehouse-details

### Request Body
- **product_ids** (array of strings) - Required - A list of product IDs.
```

```APIDOC
## POST /products/barcodes

### Description
Create a product barcode.

### Method
POST

### Endpoint
/products/barcodes

### Request Body
- **product_id** (string) - Required - The ID of the product.
- **barcode** (string) - Required - The barcode value.
```

```APIDOC
## PATCH /products/{productId}

### Description
Update an existing product.

### Method
PATCH

### Endpoint
/products/{productId}

### Parameters
#### Path Parameters
- **productId** (string) - Required - The ID of the product to update.

### Request Body
- **name** (string) - Optional - The new name of the product.
- **description** (string) - Optional - The new description of the product.
```

--------------------------------

### GET /logistics/api/2026-02/returns/{returnId}

Source: https://docs.logistics-api.flexport.com/2026-02/tag/Returns

Retrieves detailed information for a specific return by its ID.

```APIDOC
## GET /logistics/api/2026-02/returns/{returnId}

### Description
Get return by returnId. This will include ReturnOrder, ReturnItems with inspection status and ShippingLabel.

### Method
GET

### Endpoint
/logistics/api/2026-02/returns/{returnId}

### Parameters
#### Path Parameters
- **returnId** (number) - Required - Unique ID used to track the return.

### Response
#### Success Response (200)
- **id** (number) - Return ID.
- **status** (string) - Current status.
- **shippingLabel** (object) - Label details.
- **returnItems** (Array) - List of items in the return.

#### Response Example
{
  "id": 0,
  "status": "CREATED",
  "rma": "string",
  "fulfillmentOrderId": "string"
}
```

--------------------------------

### Order Schema Example (JSON)

Source: https://docs.logistics-api.flexport.com/2026-02/tag/Outbounds

This JSON object represents a sample response schema for an order created via the Logistics API. It includes details such as order ID, external references, order type, status, and a list of order items.

```json
{
  "orderId": "string",
  "externalId": "string",
  "externalChannelId": "string",
  "locationId": "string",
  "type": "B2B",
  "orderStatus": "BOOKED",
  "orderItems": [
    {
      "logisticsSku": "string",
      "quantity": 0,
      "quantityUOM": "EACH",
      "quantityPerPack": 0,
      "lineItemId": "string"
    }
  ]
}
```

--------------------------------

### GET /logistics/api/2026-02/inbounds/shipments/{shipmentId}

Source: https://docs.logistics-api.flexport.com/2026-02/tag/Inbounds

Retrieves the details of a specific inbound shipment by its unique identifier.

```APIDOC
## GET /logistics/api/2026-02/inbounds/shipments/{shipmentId}

### Description
Get an existing inbounding shipment by its ID.

### Method
GET

### Endpoint
/logistics/api/2026-02/inbounds/shipments/{shipmentId}

### Parameters
#### Path Parameters
- **shipmentId** (integer) - Required - The unique identifier of the shipment.

### Response
#### Success Response (200)
- **shipment** (object) - The shipment details object.

#### Response Example
{
  "id": "12345",
  "status": "PENDING"
}
```

--------------------------------

### GET /logistics/api/2026-02/products/inventory/all

Source: https://docs.logistics-api.flexport.com/2026-02/tag/Products

Retrieves a cursor-paginated list of inventory information for all products. Supports filtering by inventory pool and pagination using a cursor.

```APIDOC
## GET /logistics/api/2026-02/products/inventory/all

### Description
Get a cursor-paginated list of available inventory information for products. To obtain reserve storage quantities, the poolName parameter can be set to 'STORAGE'. This endpoint uses cursor-based pagination for efficient iteration through large result sets. The cursor is the logisticsSku of the last item in the current page. When nextCursor is undefined, there are no more pages.

### Method
GET

### Endpoint
/logistics/api/2026-02/products/inventory/all

### Parameters
#### Query Parameters
- **limit** (number) - Optional - The number of records to return, defaults to 20, capped at 100.
- **cursor** (string) - Optional - The cursor from the previous page's nextCursor field, omit for the first page.
- **poolName** (string) - Optional - Specifies the inventory pool to query. Enum: "DEFAULT", "UNALLOCATED", "STORAGE", "PREP".

### Request Example
```json
{
  "limit": 50,
  "cursor": "PREVIOUS_CURSOR_VALUE",
  "poolName": "STORAGE"
}
```

### Response
#### Success Response (200)
- **logisticsSku** (string) - The globally unique product identifier created by Flexport.
- **onHand** (integer) - The calculation of on-hand quantity for pickable and shippable products.
- **available** (integer) - The number of units available for sale, not reserved for open orders.
- **unavailable** (integer) - The number of units not available for sale.
- **unitsPerPack** (number) - The number of units per pack.
- **lotTrackingDetails** (Array of objects) - Details about lot tracking.
  - **lotNumber** (string) - The lot number.
  - **expirationDate** (string) - The expiration date in ISO 8601 format.
  - **available** (integer) - The available quantity for this lot.
- **breakdown** (Array of objects) - Detailed breakdown of inventory.
  - **logisticsSku** (string) - The product SKU for the breakdown item.
  - **onHand** (integer) - On-hand quantity for the breakdown item.
  - **available** (integer) - Available quantity for the breakdown item.
  - **unavailable** (integer) - Unavailable quantity for the breakdown item.
  - **unitsPerPack** (number) - Units per pack for the breakdown item.
  - **lotTrackingDetails** (Array of objects) - Lot tracking details for the breakdown item.
    - **lotNumber** (string) - The lot number.
    - **expirationDate** (string) - The expiration date in ISO 8601 format.
    - **available** (integer) - The available quantity for this lot.
  - **dimensions** (object) - Physical dimensions of the inventory item.
    - **height** (number) - Height of the item.
    - **length** (number) - Length of the item.
    - **lengthUnit** (string) - Unit of length (e.g., "in").
    - **weight** (number) - Weight of the item.
    - **weightUnit** (string) - Unit of weight (e.g., "oz").
    - **width** (number) - Width of the item.

#### Response Example (200)
```json
[
  {
    "logisticsSku": "stringstrin",
    "onHand": 0,
    "available": 0,
    "unavailable": 0,
    "unitsPerPack": 0,
    "lotTrackingDetails": [
      {
        "lotNumber": "string",
        "expirationDate": "2019-08-24T14:15:22Z",
        "available": 0
      }
    ],
    "breakdown": [
      {
        "logisticsSku": "string",
        "onHand": 0,
        "available": 0,
        "unavailable": 0,
        "unitsPerPack": 0,
        "lotTrackingDetails": [
          {
            "lotNumber": "string",
            "expirationDate": "2019-08-24T14:15:22Z",
            "available": 0
          }
        ],
        "dimensions": {
          "height": 0,
          "length": 0,
          "lengthUnit": "in",
          "weight": 0,
          "weightUnit": "oz",
          "width": 0
        }
      }
    ]
  }
]
```

#### Error Response (401)
Unauthorized

#### Error Response (403)
Forbidden
```

--------------------------------

### GET /logistics/api/2026-02/orders/rs/{orderId}

Source: https://docs.logistics-api.flexport.com/2026-02/tag/Outbounds

Retrieves the details of a specific order using its order ID.

```APIDOC
## GET /logistics/api/2026-02/orders/rs/{orderId}

### Description
Retrieves the details of a specific order using its unique order ID.

### Method
GET

### Endpoint
`/logistics/api/2026-02/orders/rs/{orderId}`

### Parameters
#### Path Parameters
- **orderId** (string) - Required - The unique identifier of the order to retrieve.

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **orderId** (string) - The unique identifier generated after successfully creating the order.
- **externalId** (string) - The external ID submitted by the external system when creating the order.
- **externalChannelId** (string) - The external channel's order ID.
- **locationId** (string) - The warehouse ID from which the order will be sent.
- **type** (string) - The type of the order (e.g., B2B, EDI, DROP_SHIP). Currently, only 'B2B' is supported.
- **orderStatus** (string) - The current status of the order. Enum: "BOOKED", "CANCELLED", "COMPLETED", "ERROR", "IN_PROGRESS", "LOST_DAMAGED", "PLANNED", "TENDERED".
- **orderItems** (Array of objects) - Items included in the order.
  - **logisticsSku** (string) - The logistics SKU of the product.
  - **quantity** (number) - The total quantity to be sent.
  - **quantityUOM** (string) - The unit of measure for the quantity. Enum: "EACH", "CASE".
  - **quantityPerPack** (number) - The case pack quantity of the product.
  - **lineItemId** (string) - A line item identifier meaningful to the external system creating the outbound.
  - **lotNumber** (string) - The lot number assigned to the product by the seller.
  - **unitPrice** (number) - The price associated with each unit of the product.
  - **totalPrice** (number) - The total price of all units of the product.
  - **discount** (number) - The absolute value of the discount given by the seller on all units of the product.
  - **productData** (object) - Product data relating to the item. Required if `logisticsSku` is not provided.
- **shipments** (Array of objects) - Shipments created related to the order.
  - **status** (string) - The shipment status. Enum: "CANCELLED", "ERROR", "CREATED", "NOT_SYNCED", "OVER_SHIPPED", "PARTIALLY_SHIPPED", "SHIPPED", "WAREHOUSE".
  - **externalChannelShipmentId** (string) - The shipment ID of the external channel where the order is being sent.
  - **externalChannelReferenceNumber** (string) - The reference number of the external channel where the order is being sent.
  - **shipmentId** (string) - The shipment ID of the shipment.
  - **shipmentChargedWeight** (number) - The total weight of all items in the shipment that are billed.
  - **shipmentChargedWeightUnit** (string) - The unit of measure for the shipment charged weight. Enum: "oz", "kg", "lb", "g".
  - **shipFromAddress** (object) - The address from where the shipment is being sent.
  - **shipToAddress** (object) - The address where the shipment is being sent.
  - **transportationDetails** (object) - Transportation details of the shipment.
  - **packDetails** (Array of objects) - Tracking details of the shipment when shipping type is PARCEL.
  - **freightDetails** (Array of objects) - Tracking details of the shipment for Freight Orders (LTL, FTL).
  - **shipmentItems** (Array of objects) - Items in the shipment.
  - **shipBy** (string) - Ship by date provided by the external system in the request.
- **notes** (string) - Additional notes to be provided along with the order.
- **retailerData** (object) - Additional data required for EDI and DROP_SHIP orders.
  - **retailer** (string) - The name of the retailer.
  - **purchaseOrderNumber** (string) - The purchase order number.
  - **tradingPartnerId** (string) - The trading partner ID.
  - **customerPoNumber** (string) - The customer purchase order number.
  - **invoiceNumber** (string) - The invoice number.
  - **markForStore** (string) - Mark for store.
  - **department** (string) - The department.
  - **address** (object) - The delivery address.
- **discounts** (Array of objects) - Discounts associated with the order.
- **charges** (Array of objects) - Charges associated with the order.
- **paymentTerms** (object) - Payment terms specific to the invoice.
- **deliveryDate** (string) - ISO string for the delivery date.
- **shipByDate** (string) - A custom ship by date in ISO 8601 (YYYY-MM-DD) to schedule future orders. Should be at least two days after the current date. The ship by date is in UTC timezone and the warehouse will only ship during working hours.
- **shipAfterDate** (string) - A custom ship after date in ISO 8601 (YYYY-MM-DD) to schedule future orders. The ship after date is in UTC timezone and the warehouse will only ship during working hours.
- **ingestionChannel** (string) - The ingestion channel of the order. Enum: "SPS", "SPS_TEST", "SHOPIFY_V3", "SELLERCLOUD", "NETSUITE".

#### Response Example
```json
{
  "orderId": "string",
  "externalId": "string",
  "externalChannelId": "string",
  "locationId": "string",
  "type": "B2B",
  "orderStatus": "BOOKED",
  "orderItems": [
    {
      "logisticsSku": "string",
      "quantity": 0,
      "quantityUOM": "EACH",
      "quantityPerPack": 0,
      "lineItemId": "string"
    }
  ],
  "shipments": [
    {
      "status": "CREATED",
      "shipmentId": "string",
      "shipmentChargedWeight": 0.0,
      "shipmentChargedWeightUnit": "kg",
      "shipFromAddress": {},
      "shipToAddress": {},
      "transportationDetails": {},
      "shipmentItems": []
    }
  ],
  "shipByDate": "2026-02-15T00:00:00Z",
  "shipAfterDate": "2026-02-10T00:00:00Z",
  "ingestionChannel": "SHOPIFY_V3"
}
```

#### Error Responses
- **401 Unauthorized**: Returned if the request lacks valid authentication credentials.
- **404 Not Found**: Returned if the order with the specified `orderId` does not exist.
```

--------------------------------

### Create Bundle Response (JSON)

Source: https://docs.logistics-api.flexport.com/2026-02/tag/Bundles

This JSON response is returned upon successful creation of a bundle. It includes all the details from the request payload, along with the newly generated bundleId and the creation timestamp (createdAt).

```json
{
  "externalBundleId": "string",
  "title": "string",
  "sku": "string",
  "bundleContents": [
    {
      "productId": "stringstrin",
      "quantity": 0
    }
  ],
  "bundleId": "stringstrin",
  "createdAt": "2019-08-24T14:15:22Z"

}
```

--------------------------------

### GET /logistics/api/2026-02/products

Source: https://docs.logistics-api.flexport.com/2026-02/tag/Products

Retrieves a paginated list of products currently stored in the logistics system.

```APIDOC
## GET /logistics/api/2026-02/products

### Description
Returns a paginated list of products. Supports limit and offset parameters for navigation.

### Method
GET

### Endpoint
/logistics/api/2026-02/products

### Parameters
#### Query Parameters
- **limit** (number) - Optional - Number of records to return (default 20, max 100).
- **offset** (number) - Optional - Number of records to skip (default 0).

### Response
#### Success Response (200)
- **products** (array) - List of product objects.

#### Response Example
{
  "products": [
    {
      "name": "Example Product",
      "logisticsSku": "LOG-SKU-123"
    }
  ]
}
```

--------------------------------

### Begin Asynchronous Request to Buy a Quote for a Shipment

Source: https://docs.logistics-api.flexport.com/2026-02/tag/Inbounds

Initiates an asynchronous request to buy quotes on an inbounding shipment. Returns success if the request was accepted.

```APIDOC
## POST /logistics/api/2026-02/inbounds/shipments/{shipmentId}/buy

### Description
Asynchronous endpoint for starting a request to buy quotes on an inbounding shipment. Returns success if request was accepted.

### Method
POST

### Endpoint
/logistics/api/2026-02/inbounds/shipments/{shipmentId}/buy

### Parameters
#### Path Parameters
- **shipmentId** (integer) - Required - The ID of the shipment.

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (202 Accepted)
(Details for success response not provided in the input text.)

#### Error Responses
(Details for error responses not provided in the input text.)
```

--------------------------------

### POST /logistics/api/2026-02/returns

Source: https://docs.logistics-api.flexport.com/2026-02/tag/Returns

Creates a new return order in the system. You can either provide a source address for the system to purchase a label or provide an external label directly.

```APIDOC
## POST /logistics/api/2026-02/returns

### Description
Creates a new return order. If an external label is not provided, the system will purchase one based on the provided source address.

### Method
POST

### Endpoint
/logistics/api/2026-02/returns

### Request Body
- **sourceAddress** (object) - Optional - Address where the return is shipped from.
- **returnItems** (Array) - Required - List of items being returned.
- **externalReturnId** (string) - Required - Unique reference to the return in the external system.
- **rma** (string) - Required - RMA generated by the merchant.
- **externalLabel** (object) - Optional - Details of a pre-purchased shipping label.

### Request Example
{
  "sourceAddress": {
    "name": "John Doe",
    "street1": "123 Main St",
    "city": "Anytown",
    "zip": "12345",
    "state": "NY",
    "country": "USA"
  },
  "returnItems": [
    {
      "identifier": "SKU-123",
      "type": "SKU",
      "quantity": 1
    }
  ],
  "externalReturnId": "RET-999",
  "rma": "RMA-123"
}

### Response
#### Success Response (201)
- **id** (integer) - The system-generated return ID.
- **status** (string) - Current status of the return.

#### Response Example
{
  "id": 1001,
  "status": "CREATED"
}
```

--------------------------------

### GET /logistics/api/2026-02/bulk-jobs/{id}

Source: https://docs.logistics-api.flexport.com/2026-02/tag/Parcels

Retrieves the status and details of a bulk parcel processing job.

```APIDOC
## GET /logistics/api/2026-02/bulk-jobs/{id}

### Description
Fetch the Bulk Parcel Job for the specified ID.

### Method
GET

### Endpoint
/logistics/api/2026-02/bulk-jobs/{id}

### Parameters
#### Path Parameters
- **id** (number) - Required - The Bulk Parcel Job ID.

### Response
#### Success Response (200)
- **status** (string) - Current status (CREATING, COMPLETED, PARTIALLY_COMPLETED, FAILED).
```

--------------------------------

### GET /logistics/api/2026-02/reports/{reportReference}

Source: https://docs.logistics-api.flexport.com/2026-02/tag/Reports

Retrieves the status and download URL for a previously requested report.

```APIDOC
## GET /logistics/api/2026-02/reports/{reportReference}

### Description
Retrieves the current status of a report generation task and provides a download URL if the report is ready.

### Method
GET

### Endpoint
/logistics/api/2026-02/reports/{reportReference}

### Parameters
#### Path Parameters
- **reportReference** (string) - Required - The unique reference ID of the report.

### Response
#### Success Response (200)
- **status** (string) - The current status (PENDING, SUCCESS, ERROR, EMPTY_REPORT_GENERATED).
- **urlExpiration** (string) - Date-time of download URL expiration in GMT.
- **url** (string) - URL to download the report as a CSV file.
- **errorMessage** (string) - Error description if status is ERROR.

#### Response Example
{
  "status": "PENDING",
  "urlExpiration": "2019-08-24T14:15:22Z",
  "url": "string",
  "errorMessage": "string"
}
```

--------------------------------

### Get Bundle Inventory Response (JSON)

Source: https://docs.logistics-api.flexport.com/2026-02/tag/Bundles

This JSON response provides the available inventory for a specified bundle. It includes the bundleId and the number of available units that are ready for sale and not reserved for open orders.

```json
{
  "bundleId": "stringstrin",
  "availableUnits": 0

}
```
Tokens:
Raw