logo

Outbounds

Outbounds API allows you to create outbound orders from reserve storage warehouses to fulfilment centres. The APIs also allow you to track the status of the reserve storage outbound orders and cancel them.

Create Order

Creates an outbound order from reserve storage

Limitations

  1. Currently only supports wholesale orders (sending to Amazon and Walmart is not supported)
  2. All products must be available in a single reserve storage warehouse

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. product data required only if logistics sku is not present
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

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

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 is supported for now
  2. Shipping Type - LTL, FTL, PARCEL
shippingPartner
required
string (Partner)

FLEXPORT, THIRD_PARTY, RECEIVER, COLLECT is supported

Value: "FLEXPORT"
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 partner is not FLEXPORT

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 should be atleast two days after current 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

purchaseOrderNumber
string

purchase order number

retailerProgramType
string

retailer program type

markForStore
string

mark for store

department
string

department

deliveryDate
string <date-time>

iso string for delivery date

object (DeliverrAddress)

Delivery address

shipByDate
string <date-time>

A custom ship by date in ISO 8601 (YYYY-MM-DD) to schedule future orders should be atleast two days after current 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

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

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

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

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

purchaseOrderNumber
string

purchase order number

retailerProgramType
string

retailer program type

markForStore
string

mark for store

department
string

department

deliveryDate
string <date-time>

iso string for delivery date

object (DeliverrAddress)

Delivery address

shipByDate
string <date-time>

A custom ship by date in ISO 8601 (YYYY-MM-DD) to schedule future orders should be atleast two days after current 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

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",
      • "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"
      }
    },
  • "externalId": "string",
  • "shipBy": "2019-08-24T14:15:22Z",
  • "notes": "string",
  • "locationId": "string",
  • "retailerData": {
    • "purchaseOrderNumber": "string",
    • "retailerProgramType": "string",
    • "markForStore": "string",
    • "department": "string",
    • "deliveryDate": "2019-08-24T14:15:22Z",
    • "address": {
      • "name": "string",
      • "company": "string",
      • "street1": "string",
      • "street2": "string",
      • "city": "string",
      • "zip": "string",
      • "state": "string",
      • "country": "string",
      • "phone": "string",
      • "email": "string",
      • "isResidential": true
      },
    • "shipByDate": "2019-08-24T14:15:22Z",
    • "shipAfterDate": "2019-08-24T14:15:22Z"
    }
}
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",
      • "productData": {
        }
      }
    ],
  • "shipments": [
    • {
      • "status": "CANCELLED",
      • "externalChannelShipmentId": "string",
      • "externalChannelReferenceNumber": "string",
      • "shipmentId": "string",
      • "shipmentChargedWeight": 0,
      • "shipmentChargedWeightUnit": "oz",
      • "shipFromAddress": {
        },
      • "shipToAddress": {
        },
      • "transportationDetails": {
        },
      • "packDetails": [
        ],
      • "shipmentItems": [
        ]
      }
    ],
  • "shipBy": "2019-08-24T14:15:22Z",
  • "notes": "string",
  • "retailerData": {
    • "purchaseOrderNumber": "string",
    • "retailerProgramType": "string",
    • "markForStore": "string",
    • "department": "string",
    • "deliveryDate": "2019-08-24T14:15:22Z",
    • "address": {
      • "name": "string",
      • "company": "string",
      • "street1": "string",
      • "street2": "string",
      • "city": "string",
      • "zip": "string",
      • "state": "string",
      • "country": "string",
      • "phone": "string",
      • "email": "string",
      • "isResidential": true
      },
    • "shipByDate": "2019-08-24T14:15:22Z",
    • "shipAfterDate": "2019-08-24T14:15:22Z"
    }
}

Get Order

Get order information for a reserve storage 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

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

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

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

purchaseOrderNumber
string

purchase order number

retailerProgramType
string

retailer program type

markForStore
string

mark for store

department
string

department

deliveryDate
string <date-time>

iso string for delivery date

object (DeliverrAddress)

Delivery address

shipByDate
string <date-time>

A custom ship by date in ISO 8601 (YYYY-MM-DD) to schedule future orders should be atleast two days after current 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

401

Unauthorized

404

Not Found

get/logistics/api/2024-07/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",
      • "productData": {
        }
      }
    ],
  • "shipments": [
    • {
      • "status": "CANCELLED",
      • "externalChannelShipmentId": "string",
      • "externalChannelReferenceNumber": "string",
      • "shipmentId": "string",
      • "shipmentChargedWeight": 0,
      • "shipmentChargedWeightUnit": "oz",
      • "shipFromAddress": {
        },
      • "shipToAddress": {
        },
      • "transportationDetails": {
        },
      • "packDetails": [
        ],
      • "shipmentItems": [
        ]
      }
    ],
  • "shipBy": "2019-08-24T14:15:22Z",
  • "notes": "string",
  • "retailerData": {
    • "purchaseOrderNumber": "string",
    • "retailerProgramType": "string",
    • "markForStore": "string",
    • "department": "string",
    • "deliveryDate": "2019-08-24T14:15:22Z",
    • "address": {
      • "name": "string",
      • "company": "string",
      • "street1": "string",
      • "street2": "string",
      • "city": "string",
      • "zip": "string",
      • "state": "string",
      • "country": "string",
      • "phone": "string",
      • "email": "string",
      • "isResidential": true
      },
    • "shipByDate": "2019-08-24T14:15:22Z",
    • "shipAfterDate": "2019-08-24T14:15:22Z"
    }
}

CancelOrder

Cancel a reserve storage outbound order using order id. Only order in submitted state is allowed to 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
Response samples
application/json
{
  • "status": 401,
  • "type": "string",
  • "title": "string",
  • "detail": "string",
  • "instance": "string",
  • "code": 401,
  • "message": "string"
}
➔ Next to Events