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

Currently only supports wholesale orders (vendor-routed orders to Amazon and Walmart are not supported)
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.

logistics sku of the product
quantity
quantity unit of measure
quantity per pack
line item id
lot number
unit price
total price
currency code
product data required only if logistics sku is not present

Notes:

Duplicate skus are not allowed.
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

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

Notes:

Carrier account details are not required if shipping partner is FLEXPORT or SELLER
For THIRD_PARTY and RECEIVER all fields of carrier account details are required
For THIRD_PARTY and RECEIVER shipping type should always be PARCEL
For COLLECT only FEDEX is supported and other fields of carrier account details are not required
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: Shipping speed affects final delivery cost. 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

Responses

200

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"

401

Unauthorized

post/logistics/api/2026-02/orders/rs

Request samples

Payload

application/json

{"type": "B2B",
"orderItems": [{"logisticsSku": "string",
"quantity": 0,
"quantityUOM": "EACH",
"quantityPerPack": 0,
"lineItemId": "string",
"lotNumber": "string",
"unitPrice": 0,
"totalPrice": 0,
"discount": 0,
"productData": {"upc": "string",
"buyerPartNumber": "string",
"sku": "string",
"gtin": 0
}
}
],
"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": {"carrierName": "string",
"dutyPaymentAccountId": "string",
"country": "string",
"postalCode": "string"
},
"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": [{"type": "string",
"value": 0
}
],
"charges": [{"type": "string",
"value": 0
}
],
"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"
}
}

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": {"upc": "string",
"buyerPartNumber": "string",
"sku": "string",
"gtin": 0
}
}
],
"shipments": [{"status": "CANCELLED",
"externalChannelShipmentId": "string",
"externalChannelReferenceNumber": "string",
"shipmentId": "string",
"shipmentChargedWeight": 0,
"shipmentChargedWeightUnit": "oz",
"shipFromAddress": {"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"zip": "string",
"state": "string",
"country": "string",
"phone": "string",
"email": "string",
"isResidential": true
},
"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": {"carrierName": "string",
"dutyPaymentAccountId": "string",
"country": "string",
"postalCode": "string"
},
"incoterm": "DAP",
"eelPfc": "string"
},
"shippingMethod": "string",
"shippingSpeed": "ONE_DAY"
},
"packDetails": [{"packItems": [{"logisticsSku": "string",
"quantity": 0,
"quantityUOM": "EACH"
}
],
"carrierName": "string",
"carrierSCAC": "string",
"trackingNumber": "string",
"packageStatus": "PRE_TRANSIT",
"sscc": "string",
"packDims": {"length": 0,
"width": 0,
"height": 0,
"lengthUnit": "in",
"weight": 0,
"weightUnit": "oz"
},
"boxId": "string"
}
],
"freightDetails": [{"bolId": "string",
"proNumber": "string",
"carrierName": "string",
"carrierSCAC": "string"
}
],
"shipmentItems": [{"logisticsSku": "string",
"quantity": 0,
"shippedQuantity": 0,
"quantityUOM": "EACH",
"quantityPerPack": 0,
"lineItemId": "string",
"lotNumber": "string",
"unitPrice": 0,
"totalPrice": 0,
"discount": 0
}
]
}
],
"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": [{"type": "string",
"value": 0
}
],
"charges": [{"type": "string",
"value": 0
}
],
"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"
}

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

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"

401

Unauthorized

404

Not Found

get/logistics/api/2026-02/orders/rs/{orderId}

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": {"upc": "string",
"buyerPartNumber": "string",
"sku": "string",
"gtin": 0
}
}
],
"shipments": [{"status": "CANCELLED",
"externalChannelShipmentId": "string",
"externalChannelReferenceNumber": "string",
"shipmentId": "string",
"shipmentChargedWeight": 0,
"shipmentChargedWeightUnit": "oz",
"shipFromAddress": {"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"zip": "string",
"state": "string",
"country": "string",
"phone": "string",
"email": "string",
"isResidential": true
},
"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": {"carrierName": "string",
"dutyPaymentAccountId": "string",
"country": "string",
"postalCode": "string"
},
"incoterm": "DAP",
"eelPfc": "string"
},
"shippingMethod": "string",
"shippingSpeed": "ONE_DAY"
},
"packDetails": [{"packItems": [{"logisticsSku": "string",
"quantity": 0,
"quantityUOM": "EACH"
}
],
"carrierName": "string",
"carrierSCAC": "string",
"trackingNumber": "string",
"packageStatus": "PRE_TRANSIT",
"sscc": "string",
"packDims": {"length": 0,
"width": 0,
"height": 0,
"lengthUnit": "in",
"weight": 0,
"weightUnit": "oz"
},
"boxId": "string"
}
],
"freightDetails": [{"bolId": "string",
"proNumber": "string",
"carrierName": "string",
"carrierSCAC": "string"
}
],
"shipmentItems": [{"logisticsSku": "string",
"quantity": 0,
"shippedQuantity": 0,
"quantityUOM": "EACH",
"quantityPerPack": 0,
"lineItemId": "string",
"lotNumber": "string",
"unitPrice": 0,
"totalPrice": 0,
"discount": 0
}
]
}
],
"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": [{"type": "string",
"value": 0
}
],
"charges": [{"type": "string",
"value": 0
}
],
"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"
}

Get Order By External ID

Get order information for an order created via the "Create order" endpoint, using the external ID given during order creation.

SecurityBEARER

Request

path Parameters

externalId

required

string

The external ID given during order creation.

Responses

200

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"

401

Unauthorized

404

Not Found

get/logistics/api/2026-02/orders/rs/external_id/{externalId}

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": {"upc": "string",
"buyerPartNumber": "string",
"sku": "string",
"gtin": 0
}
}
],
"shipments": [{"status": "CANCELLED",
"externalChannelShipmentId": "string",
"externalChannelReferenceNumber": "string",
"shipmentId": "string",
"shipmentChargedWeight": 0,
"shipmentChargedWeightUnit": "oz",
"shipFromAddress": {"name": "string",
"company": "string",
"street1": "string",
"street2": "string",
"city": "string",
"zip": "string",
"state": "string",
"country": "string",
"phone": "string",
"email": "string",
"isResidential": true
},
"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": {"carrierName": "string",
"dutyPaymentAccountId": "string",
"country": "string",
"postalCode": "string"
},
"incoterm": "DAP",
"eelPfc": "string"
},
"shippingMethod": "string",
"shippingSpeed": "ONE_DAY"
},
"packDetails": [{"packItems": [{"logisticsSku": "string",
"quantity": 0,
"quantityUOM": "EACH"
}
],
"carrierName": "string",
"carrierSCAC": "string",
"trackingNumber": "string",
"packageStatus": "PRE_TRANSIT",
"sscc": "string",
"packDims": {"length": 0,
"width": 0,
"height": 0,
"lengthUnit": "in",
"weight": 0,
"weightUnit": "oz"
},
"boxId": "string"
}
],
"freightDetails": [{"bolId": "string",
"proNumber": "string",
"carrierName": "string",
"carrierSCAC": "string"
}
],
"shipmentItems": [{"logisticsSku": "string",
"quantity": 0,
"shippedQuantity": 0,
"quantityUOM": "EACH",
"quantityPerPack": 0,
"lineItemId": "string",
"lotNumber": "string",
"unitPrice": 0,
"totalPrice": 0,
"discount": 0
}
]
}
],
"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": [{"type": "string",
"value": 0
}
],
"charges": [{"type": "string",
"value": 0
}
],
"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"
}

Get Shipment Attachment Url

Get shipment attachment url for uploading shipment attachment document.

SecurityBEARER

Request

path Parameters

shipmentId

required

string

The unique shipment id returned during creation process.

Request Body schema: application/json
required

The request object for getting upload url for uploading shipment attachment document.

attachmentType required	string (AttachmentType) Type of the attachment, e.g. "SHIPPING_LABELS", "COMMERCIAL_INVOICE", etc. Enum: "CASE_LABELS" "SHIPPING_LABELS" "PALLET_LABELS" "COMMERCIAL_INVOICE" "BILL_OF_LADING"
contentType required	string Content type of the attachment. Only "application/pdf" is supported for now.

Responses

200

Response Schema: application/json

uploadUrl required	string Upload url for uploading shipment attachment document.
attachmentType required	string (AttachmentType) Type of the attachment, e.g. "SHIPPING_LABELS", "COMMERCIAL_INVOICE", etc. Enum: "CASE_LABELS" "SHIPPING_LABELS" "PALLET_LABELS" "COMMERCIAL_INVOICE" "BILL_OF_LADING"
expirationTime required	string <date-time> The ISO 8601 timestamp string indicating when the upload URL will expire. The URL is valid for one hour after generation. Example: "2025-05-10T10:00:00Z"

401

Unauthorized

post/logistics/api/2026-02/orders/rs/{shipmentId}/attachments

Request samples

Payload

application/json

{"attachmentType": "CASE_LABELS",
"contentType": "string"
}

Response samples

application/json

{"uploadUrl": "string",
"attachmentType": "CASE_LABELS",
"expirationTime": "2019-08-24T14:15:22Z"
}

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

401

Unauthorized

404

Not Found

post/logistics/api/2026-02/orders/rs/{orderId}/cancel

Response samples

application/json

{"status": 401,
"type": "string",
"title": "string",
"detail": "string",
"instance": "string",
"code": 401,
"message": "string"
}

➔ Next to Parcels

Outbounds

Create Order

Request Body schema: application/jsonrequired

Response Schema: application/json

Get Order

path Parameters

Response Schema: application/json

Get Order By External ID

path Parameters

Response Schema: application/json

Get Shipment Attachment Url

path Parameters

Request Body schema: application/jsonrequired

Response Schema: application/json

Cancel Order

path Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required