logo

Outbounds

The Outbounds API allows you to create and manage B2B (wholesale) outbound orders. Orders ship from a Flexport warehouse, either a Reserve Storage facility (bulk pallet/case-pack inventory) or a DTC fulfilment center (individual unit inventory), resolved automatically from your account configuration. The APIs also let you track order status, upload shipment documents, and cancel orders.

Create Order

Creates a B2B (wholesale) outbound order. The origin warehouse (a Flexport Reserve Storage or DTC fulfilment center) is resolved automatically from your account configuration. You do not specify a warehouse type in the request.

Limitations

  1. Currently only supports wholesale orders (vendor-routed orders to Amazon and Walmart are not supported)
  2. All line items in a single order must be available in one warehouse location

SecurityBEARER
Request
Request Body schema: application/json
required
type
required
string (Type)

Type of the order, e.g. B2B, EDI, DROP_SHIP. Currently, only B2B is supported

Value: "B2B"
required
Array of objects (ReplenishmentOrderItemV2)

List of items to be sent.

  1. logistics sku of the product
  2. quantity
  3. quantity unit of measure
  4. quantity per pack
  5. line item id
  6. lot number
  7. unit price
  8. total price
  9. currency code
  10. product data required only if logistics sku is not present

Notes:

  1. Duplicate skus are not allowed.
  2. Maximum 1000 items are allowed per order.
Array
logisticsSku
string

Logistics sku of the product

quantity
required
number <double>

Total quantity to sent

quantityUOM
required
string (QuantityUom)

Unit of measure of the qty included, can be either EACH or CASE. Whether EACH (individual units) or CASE (case-pack) quantities are accepted depends on your account/warehouse configuration.

Enum: "EACH" "CASE"
quantityPerPack
number <double>

Case pack quantity of the product

lineItemId
string

A line item identifier meaningful to the external system creating the outbound

lotNumber
string

Lot number assigned to the product by seller

unitPrice
number <double>

Price associated with each unit of product

totalPrice
number <double>

Total price of all units of product (totalPrice = unitPrice * quantity)

discount
number <double>

Absolute value of discount given by seller on all units of product (not in percentage)

object (ProductData)

Product data relating to the item. Required if the logisticSku is not provided for the item

required
object (DeliverrAddress)

Address where this order should be delivered

name
required
string
company
string
street1
required
string
street2
string
city
required
string
zip
required
string
state
required
string
country
required
string
phone
string
email
string
isResidential
boolean
required
object (TransportationDetails)

Shipping preferences contain

  1. Shipping Partner - FLEXPORT, THIRD_PARTY, RECEIVER, COLLECT, SELLER is supported.
  2. Shipping Type - LTL, FTL, PARCEL

Notes:

  1. Carrier account details are not required if shipping partner is FLEXPORT or SELLER
  2. For THIRD_PARTY and RECEIVER all fields of carrier account details are required
  3. For THIRD_PARTY and RECEIVER shipping type should always be PARCEL
  4. For COLLECT only FEDEX is supported and other fields of carrier account details are not required
  5. Shipping method takes precedence over shipping speed.
shippingPartner
required
string (PartnerV2)

FLEXPORT, THIRD_PARTY, RECEIVER, COLLECT, SELLER is supported

Enum: "FLEXPORT" "THIRD_PARTY" "RECEIVER" "COLLECT" "SELLER"
shippingType
string (ShippingType)

Type of shipping eg LTL, FTL, PARCEL

Enum: "LTL" "FTL" "PARCEL"
object (CarrierAccountDetails)

Carrier account details of the carrier. Required if shipping THIRD_PARTY, RECEIVER or COLLECT

object (Duties)

Duties related data tied to the shipment

shippingMethod
string (ShippingMethod)

Shipping method for the shipment (e.g. UPS.GROUND, FEDEX.GROUND). Takes precedence over shippingSpeed when both are provided.

shippingSpeed
string (ShippingSpeed)

Specifies the delivery speed option for orders fulfilled through Flexport's parcel shipping service. Notes:

  1. Shipping speed affects final delivery cost.
  2. Not all speeds may be available for all destinations.
Enum: "ONE_DAY" "TWO_DAY" "THREE_DAY" "STANDARD"
currencyCode
string (CurrencyCode)

The three-letter code for the currency associated with the order. e.g. USD

Enum: "LTL" "AED" "AFN" "ALL" "ANG" "AOA" "ARS" "AUD" "AWG" "AZN" "BAM" "BBD" "BDT" "BGN" "BHD" "BIF" "BMD" "BND" "BOB" "BRL" "BSD" "BTN" "BWP" "BYR" "BZD" "CAD" "CDF" "CHF" "CLP" "CNY" "COP" "CRC" "CUP" "CVE" "CZK" "DJF" "DKK" "DOP" "DZD" "EEK" "EGP" "ERN" "ETB" "EUR" "FJD" "FKP" "GBP" "GEL" "GHS" "GIP" "GMD" "GNF" "GTQ" "GYD" "HKD" "HNL" "HRK" "HTG" "HUF" "IDR" "ILS" "INR" "IQD" "IRR" "ISK" "JMD" "JOD" "JPY" "KES" "KGS" "KHR" "KMF" "KPW" "KRW" "KWD" "KYD" "KZT" "LAK" "LBP" "LKR" "LRD" "LSL" "LVL" "LYD" "MAD" "MDL" "MGA" "MKD" "MMK" "MNT" "MOP" "MRO" "MUR" "MVR" "MWK" "MXN" "MYR" "MZN" "NAD" "NGN" "NIO" "NOK" "NPR" "NZD" "OMR" "PAB" "PEN" "PGK" "PHP" "PKR" "PLN" "PYG" "QAR" "RON" "RSD" "RUB" "RWF" "SAR" "SBD" "SCR" "SDG" "SEK" "SGD" "SHP" "SLL" "SOS" "SRD" "STD" "SVC" "SYP" "SZL" "THB" "TJS" "TND" "TOP" "TRY" "TTD" "TWD" "TZS" "UAH" "UGX" "USD" "UYU" "UZS" "VED" "VEF" "VES" "VND" "VUV" "WST" "XAF" "XCD" "XOF" "XPF" "YER" "ZAR" "ZMK" "ZWD"
externalId
string

A unique order reference meaningful to the external system submitting the order.

shipBy
string <date-time>

A custom ship by date in ISO 8601 (YYYY-MM-DD) to schedule future orders. Must be at least three business days after the current UTC date. The ship by date is in UTC timezone and warehouse will only ship during working hours.

notes
string

Additional notes to be provided along with the order

locationId
string

Unique identifier of the origin warehouse.

object (RetailerData)

Additional Data required for EDI and DROP_SHIP orders

retailer
string

Name of retailer

purchaseOrderNumber
string

Purchase order number

tradingPartnerId
string

Trading partner id

customerPoNumber
string

Customer purchase order number

invoiceNumber
string

Invoice number

markForStore
string

Mark for store

department
string

Department

object (DeliverrAddress)

Delivery address

Array of objects (Discount)

Discount associated with the order

Array of objects (ChargeV2)

Charges associated with the order

object (PaymentTerms)

Payment terms specific to invoice

deliveryDate
string <date-time>

iso string for delivery date

shipByDate
string <date-time>

A custom ship by date in ISO 8601 (YYYY-MM-DD) to schedule future orders. Must be at least three business days after the current UTC date. The ship by date is in UTC timezone and warehouse will only ship during working hours.

shipAfterDate
string <date-time>

A custom ship after date in ISO 8601 (YYYY-MM-DD) to schedule future orders. The ship after date is in UTC timezone and warehouse will only ship during working hours

ingestionChannel
string (IngestionChannel)

Ingestion channel of the order

Enum: "SPS" "SPS_TEST" "SHOPIFY_V3" "SELLERCLOUD" "NETSUITE"
object (VasData)

Vas data for the order

code
string

Vas code for the order

object (OutboundChannelAttributes)

Outbound channel configuration. Set fba to route the order as an Amazon FBA replenishment.

object (FbaChannelAttributes)

Amazon FBA attributes. When present, the order is routed as an FBA replenishment.

fbaShipmentId
required
string

Amazon FBA shipment identifier. Required for all FBA shipments.

amazonReferenceId
string

Amazon reference identifier. Required for LTL/FTL, optional for PARCEL.

Responses
200

Ok

Response Schema: application/json
orderId
required
string

Id generated after successfully creating the order

externalId
string

External id submitted by the external system when creating the order

externalChannelId
string

External channel's order id

locationId
string

Warehouse id from which the order will be sent

type
required
string (Type)

Type of the order, e.g. B2B, EDI, DROP_SHIP. Currently, only B2B is supported

Value: "B2B"
orderStatus
required
string (OrderStatus)

Current status of the order

Enum: "BOOKED" "CANCELLED" "COMPLETED" "ERROR" "IN_PROGRESS" "LOST_DAMAGED" "PLANNED" "TENDERED"
required
Array of objects (ReplenishmentOrderItemV2)

Items in the order

Array
logisticsSku
string

Logistics sku of the product

quantity
required
number <double>

Total quantity to sent

quantityUOM
required
string (QuantityUom)

Unit of measure of the qty included, can be either EACH or CASE. Whether EACH (individual units) or CASE (case-pack) quantities are accepted depends on your account/warehouse configuration.

Enum: "EACH" "CASE"
quantityPerPack
number <double>

Case pack quantity of the product

lineItemId
string

A line item identifier meaningful to the external system creating the outbound

lotNumber
string

Lot number assigned to the product by seller

unitPrice
number <double>

Price associated with each unit of product

totalPrice
number <double>

Total price of all units of product (totalPrice = unitPrice * quantity)

discount
number <double>

Absolute value of discount given by seller on all units of product (not in percentage)

object (ProductData)

Product data relating to the item. Required if the logisticSku is not provided for the item

required
Array of objects (ReplenishmentShipmentV2)

Shipments created related to the order

Array
status
required
string (ShipmentStatus)

Shipment status

Enum: "CANCELLED" "ERROR" "CREATED" "NOT_SYNCED" "OVER_SHIPPED" "PARTIALLY_SHIPPED" "SHIPPED" "WAREHOUSE"
externalChannelShipmentId
string

Shipment ID of the external channel where the order is being sent

externalChannelReferenceNumber
string

Reference number of the external channel where the order is being sent

shipmentId
required
string

Shipment Id of the shipment

shipmentChargedWeight
required
number <double>

Total weight of all items in the shipment (which are billed).

shipmentChargedWeightUnit
required
string (WeightUnit)

Unit of measure for shipment charged weight

Enum: "oz" "kg" "lb" "g"
object (DeliverrAddress)

Address from where the shipment being sent

object (DeliverrAddress)

Address where the shipment is being sent

required
object (TransportationDetails)

Transportation details of shipment

Array of objects (PackDetails)

Tracking details of the shipment when shipping type is PARCEL

Array of objects (FreightDetails)

Tracking details of the shipment for Freight Orders (LTL, FTL)

required
Array of objects (ReplenishmentShipmentItemV2)

Items in the shipment

shipBy
string <date-time>

Ship by date provided by the external system in the request

notes
string

Additional notes to be provided along with the order

object (RetailerData)

Additional Data required for EDI and DROP_SHIP orders

retailer
string

Name of retailer

purchaseOrderNumber
string

Purchase order number

tradingPartnerId
string

Trading partner id

customerPoNumber
string

Customer purchase order number

invoiceNumber
string

Invoice number

markForStore
string

Mark for store

department
string

Department

object (DeliverrAddress)

Delivery address

Array of objects (Discount)

Discount associated with the order

Array of objects (ChargeV2)

Charges associated with the order

object (PaymentTerms)

Payment terms specific to invoice

deliveryDate
string <date-time>

iso string for delivery date

shipByDate
string <date-time>

A custom ship by date in ISO 8601 (YYYY-MM-DD) to schedule future orders. Must be at least three business days after the current UTC date. The ship by date is in UTC timezone and warehouse will only ship during working hours.

shipAfterDate
string <date-time>

A custom ship after date in ISO 8601 (YYYY-MM-DD) to schedule future orders. The ship after date is in UTC timezone and warehouse will only ship during working hours

ingestionChannel
string (IngestionChannel)

Ingestion channel of the order

Enum: "SPS" "SPS_TEST" "SHOPIFY_V3" "SELLERCLOUD" "NETSUITE"
object (OutboundChannelAttributes)

Outbound channel configuration. Present when the order was routed to a distribution channel such as Amazon FBA.

object (FbaChannelAttributes)

Amazon FBA attributes. When present, the order is routed as an FBA replenishment.

fbaShipmentId
required
string

Amazon FBA shipment identifier. Required for all FBA shipments.

amazonReferenceId
string

Amazon reference identifier. Required for LTL/FTL, optional for PARCEL.

401

Unauthorized

post/logistics/api/2024-07/orders/rs
Request samples
application/json
{
  • "type": "B2B",
  • "orderItems": [
    • {
      • "logisticsSku": "string",
      • "quantity": 0,
      • "quantityUOM": "EACH",
      • "quantityPerPack": 0,
      • "lineItemId": "string",
      • "lotNumber": "string",
      • "unitPrice": 0,
      • "totalPrice": 0,
      • "discount": 0,
      • "productData": {
        }
      }
    ],
  • "shipToAddress": {
    • "name": "string",
    • "company": "string",
    • "street1": "string",
    • "street2": "string",
    • "city": "string",
    • "zip": "string",
    • "state": "string",
    • "country": "string",
    • "phone": "string",
    • "email": "string",
    • "isResidential": true
    },
  • "transportationDetails": {
    • "shippingPartner": "FLEXPORT",
    • "shippingType": "LTL",
    • "carrierAccountDetails": {
      • "carrierName": "string",
      • "carrierAccountId": "string",
      • "country": "string",
      • "postalCode": "string"
      },
    • "duties": {
      • "dutyPaymentAccountDetails": {
        },
      • "incoterm": "DAP",
      • "eelPfc": "string"
      },
    • "shippingMethod": "string",
    • "shippingSpeed": "ONE_DAY"
    },
  • "currencyCode": "LTL",
  • "externalId": "string",
  • "shipBy": "2019-08-24T14:15:22Z",
  • "notes": "string",
  • "locationId": "string",
  • "retailerData": {
    • "retailer": "string",
    • "purchaseOrderNumber": "string",
    • "tradingPartnerId": "string",
    • "customerPoNumber": "string",
    • "invoiceNumber": "string",
    • "markForStore": "string",
    • "department": "string",
    • "address": {
      • "name": "string",
      • "company": "string",
      • "street1": "string",
      • "street2": "string",
      • "city": "string",
      • "zip": "string",
      • "state": "string",
      • "country": "string",
      • "phone": "string",
      • "email": "string",
      • "isResidential": true
      },
    • "discounts": [
      • {
        }
      ],
    • "charges": [
      • {
        }
      ],
    • "paymentTerms": {
      • "term": "string",
      • "dueDate": "2019-08-24T14:15:22Z"
      },
    • "deliveryDate": "2019-08-24T14:15:22Z",
    • "shipByDate": "2019-08-24T14:15:22Z",
    • "shipAfterDate": "2019-08-24T14:15:22Z"
    },
  • "ingestionChannel": "SPS",
  • "vasData": {
    • "code": "string"
    },
  • "outboundChannelAttributes": {
    • "fba": {
      • "fbaShipmentId": "string",
      • "amazonReferenceId": "string"
      }
    }
}
Response samples
application/json
{
  • "orderId": "string",
  • "externalId": "string",
  • "externalChannelId": "string",
  • "locationId": "string",
  • "type": "B2B",
  • "orderStatus": "BOOKED",
  • "orderItems": [
    • {
      • "logisticsSku": "string",
      • "quantity": 0,
      • "quantityUOM": "EACH",
      • "quantityPerPack": 0,
      • "lineItemId": "string",
      • "lotNumber": "string",
      • "unitPrice": 0,
      • "totalPrice": 0,
      • "discount": 0,
      • "productData": {
        }
      }
    ],
  • "shipments": [
    • {
      • "status": "CANCELLED",
      • "externalChannelShipmentId": "string",
      • "externalChannelReferenceNumber": "string",
      • "shipmentId": "string",
      • "shipmentChargedWeight": 0,
      • "shipmentChargedWeightUnit": "oz",
      • "shipFromAddress": {
        },
      • "shipToAddress": {
        },
      • "transportationDetails": {
        },
      • "packDetails": [
        ],
      • "freightDetails": [
        ],
      • "shipmentItems": [
        ]
      }
    ],
  • "shipBy": "2019-08-24T14:15:22Z",
  • "notes": "string",
  • "retailerData": {
    • "retailer": "string",
    • "purchaseOrderNumber": "string",
    • "tradingPartnerId": "string",
    • "customerPoNumber": "string",
    • "invoiceNumber": "string",
    • "markForStore": "string",
    • "department": "string",
    • "address": {
      • "name": "string",
      • "company": "string",
      • "street1": "string",
      • "street2": "string",
      • "city": "string",
      • "zip": "string",
      • "state": "string",
      • "country": "string",
      • "phone": "string",
      • "email": "string",
      • "isResidential": true
      },
    • "discounts": [
      • {
        }
      ],
    • "charges": [
      • {
        }
      ],
    • "paymentTerms": {
      • "term": "string",
      • "dueDate": "2019-08-24T14:15:22Z"
      },
    • "deliveryDate": "2019-08-24T14:15:22Z",
    • "shipByDate": "2019-08-24T14:15:22Z",
    • "shipAfterDate": "2019-08-24T14:15:22Z"
    },
  • "ingestionChannel": "SPS",
  • "outboundChannelAttributes": {
    • "fba": {
      • "fbaShipmentId": "string",
      • "amazonReferenceId": "string"
      }
    }
}

Get Order

Get order information for a B2B outbound order by orderId.

SecurityBEARER
Request
path Parameters
orderId
required
string

The unique order id returned during creation process.

Responses
200

OK

Response Schema: application/json
orderId
required
string

Id generated after successfully creating the order

externalId
string

External id submitted by the external system when creating the order

externalChannelId
string

External channel's order id

locationId
string

Warehouse id from which the order will be sent

type
required
string (Type)

Type of the order, e.g. B2B, EDI, DROP_SHIP. Currently, only B2B is supported

Value: "B2B"
orderStatus
required
string (OrderStatus)

Current status of the order

Enum: "BOOKED" "CANCELLED" "COMPLETED" "ERROR" "IN_PROGRESS" "LOST_DAMAGED" "PLANNED" "TENDERED"
required
Array of objects (ReplenishmentOrderItemV2)

Items in the order

Array
logisticsSku
string

Logistics sku of the product

quantity
required
number <double>

Total quantity to sent

quantityUOM
required
string (QuantityUom)

Unit of measure of the qty included, can be either EACH or CASE. Whether EACH (individual units) or CASE (case-pack) quantities are accepted depends on your account/warehouse configuration.

Enum: "EACH" "CASE"
quantityPerPack
number <double>

Case pack quantity of the product

lineItemId
string

A line item identifier meaningful to the external system creating the outbound

lotNumber
string

Lot number assigned to the product by seller

unitPrice
number <double>

Price associated with each unit of product

totalPrice
number <double>

Total price of all units of product (totalPrice = unitPrice * quantity)

discount
number <double>

Absolute value of discount given by seller on all units of product (not in percentage)

object (ProductData)

Product data relating to the item. Required if the logisticSku is not provided for the item

required
Array of objects (ReplenishmentShipmentV2)

Shipments created related to the order

Array
status
required
string (ShipmentStatus)

Shipment status

Enum: "CANCELLED" "ERROR" "CREATED" "NOT_SYNCED" "OVER_SHIPPED" "PARTIALLY_SHIPPED" "SHIPPED" "WAREHOUSE"
externalChannelShipmentId
string

Shipment ID of the external channel where the order is being sent

externalChannelReferenceNumber
string

Reference number of the external channel where the order is being sent

shipmentId
required
string

Shipment Id of the shipment

shipmentChargedWeight
required
number <double>

Total weight of all items in the shipment (which are billed).

shipmentChargedWeightUnit
required
string (WeightUnit)

Unit of measure for shipment charged weight

Enum: "oz" "kg" "lb" "g"
object (DeliverrAddress)

Address from where the shipment being sent

object (DeliverrAddress)

Address where the shipment is being sent

required
object (TransportationDetails)

Transportation details of shipment

Array of objects (PackDetails)

Tracking details of the shipment when shipping type is PARCEL

Array of objects (FreightDetails)

Tracking details of the shipment for Freight Orders (LTL, FTL)

required
Array of objects (ReplenishmentShipmentItemV2)

Items in the shipment

shipBy
string <date-time>

Ship by date provided by the external system in the request

notes
string

Additional notes to be provided along with the order

object (RetailerData)

Additional Data required for EDI and DROP_SHIP orders

retailer
string

Name of retailer

purchaseOrderNumber
string

Purchase order number

tradingPartnerId
string

Trading partner id

customerPoNumber
string

Customer purchase order number

invoiceNumber
string

Invoice number

markForStore
string

Mark for store

department
string

Department

object (DeliverrAddress)

Delivery address

Array of objects (Discount)

Discount associated with the order

Array of objects (ChargeV2)

Charges associated with the order

object (PaymentTerms)

Payment terms specific to invoice

deliveryDate
string <date-time>

iso string for delivery date

shipByDate
string <date-time>

A custom ship by date in ISO 8601 (YYYY-MM-DD) to schedule future orders. Must be at least three business days after the current UTC date. The ship by date is in UTC timezone and warehouse will only ship during working hours.

shipAfterDate
string <date-time>

A custom ship after date in ISO 8601 (YYYY-MM-DD) to schedule future orders. The ship after date is in UTC timezone and warehouse will only ship during working hours

ingestionChannel
string (IngestionChannel)

Ingestion channel of the order

Enum: "SPS" "SPS_TEST" "SHOPIFY_V3" "SELLERCLOUD" "NETSUITE"
object (OutboundChannelAttributes)

Outbound channel configuration. Present when the order was routed to a distribution channel such as Amazon FBA.

object (FbaChannelAttributes)

Amazon FBA attributes. When present, the order is routed as an FBA replenishment.

fbaShipmentId
required
string

Amazon FBA shipment identifier. Required for all FBA shipments.

amazonReferenceId
string

Amazon reference identifier. Required for LTL/FTL, optional for PARCEL.

401

Unauthorized

404

Not Found

get/logistics/api/2024-07/orders/rs/{orderId}
Request samples 
curl --request GET \
  --url 'https://logistics-api.flexport.com/logistics/api/2024-07/orders/rs/{orderId}' \
  --header 'Authorization: Bearer <token>'
Response samples
application/json
{
  • "orderId": "string",
  • "externalId": "string",
  • "externalChannelId": "string",
  • "locationId": "string",
  • "type": "B2B",
  • "orderStatus": "BOOKED",
  • "orderItems": [
    • {
      • "logisticsSku": "string",
      • "quantity": 0,
      • "quantityUOM": "EACH",
      • "quantityPerPack": 0,
      • "lineItemId": "string",
      • "lotNumber": "string",
      • "unitPrice": 0,
      • "totalPrice": 0,
      • "discount": 0,
      • "productData": {
        }
      }
    ],
  • "shipments": [
    • {
      • "status": "CANCELLED",
      • "externalChannelShipmentId": "string",
      • "externalChannelReferenceNumber": "string",
      • "shipmentId": "string",
      • "shipmentChargedWeight": 0,
      • "shipmentChargedWeightUnit": "oz",
      • "shipFromAddress": {
        },
      • "shipToAddress": {
        },
      • "transportationDetails": {
        },
      • "packDetails": [
        ],
      • "freightDetails": [
        ],
      • "shipmentItems": [
        ]
      }
    ],
  • "shipBy": "2019-08-24T14:15:22Z",
  • "notes": "string",
  • "retailerData": {
    • "retailer": "string",
    • "purchaseOrderNumber": "string",
    • "tradingPartnerId": "string",
    • "customerPoNumber": "string",
    • "invoiceNumber": "string",
    • "markForStore": "string",
    • "department": "string",
    • "address": {
      • "name": "string",
      • "company": "string",
      • "street1": "string",
      • "street2": "string",
      • "city": "string",
      • "zip": "string",
      • "state": "string",
      • "country": "string",
      • "phone": "string",
      • "email": "string",
      • "isResidential": true
      },
    • "discounts": [
      • {
        }
      ],
    • "charges": [
      • {
        }
      ],
    • "paymentTerms": {
      • "term": "string",
      • "dueDate": "2019-08-24T14:15:22Z"
      },
    • "deliveryDate": "2019-08-24T14:15:22Z",
    • "shipByDate": "2019-08-24T14:15:22Z",
    • "shipAfterDate": "2019-08-24T14:15:22Z"
    },
  • "ingestionChannel": "SPS",
  • "outboundChannelAttributes": {
    • "fba": {
      • "fbaShipmentId": "string",
      • "amazonReferenceId": "string"
      }
    }
}

Cancel Order

Cancel a B2B outbound order using order id. Only orders in PLANNED or BOOKED status can be cancelled; once the warehouse begins processing (IN_PROGRESS or later) the order can no longer be cancelled.

SecurityBEARER
Request
path Parameters
orderId
required
string

The unique order id returned during creation process.

Responses
200

OK

401

Unauthorized

404

Not Found

post/logistics/api/2024-07/orders/rs/{orderId}/cancel
Request samples 
curl --request POST \
  --url 'https://logistics-api.flexport.com/logistics/api/2024-07/orders/rs/{orderId}/cancel' \
  --header 'Authorization: Bearer <token>'
Response samples
application/json
{
  • "status": 401,
  • "type": "string",
  • "title": "string",
  • "detail": "string",
  • "instance": "string",
  • "code": 401,
  • "message": "string"
}
➔ Next to Events