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.

CreateOrder

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
  3. Same product but different case quantity cannot be out-bounded in a single order
  4. Shipping partner can only be FLEXPORT for now (ie shipping can only be done via FLEXPORT)

SecurityBEARER
Request
Request Body schema: application/json
required
distributionChannel
required
string (Channel)

Distribution Channel to which you want to send to. Currently only supports WHOLESALE

Value: "WHOLESALE"
required
Array of objects (ReplenishmentOrderItem)

List of items to be sent.

  1. logistics sku of the product
  2. units per pack
  3. total units multiple same products with different case quantity are not allowed in the same order
Array
logisticsSku
required
string

Logistics sku of the product

unitsPerPack
required
number <double>

Case pack quantity of the product

totalUnits
required
number <double>

Total units to sent

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 (ShippingPreferences)

Shipping preferences contain

  1. Shipping Partner - Only FLEXPORT is supported for now
  2. Shipping Type - LTL, FTL, PARCEL
shippingPartner
required
string (Partner)

Only FLEXPORT is supported

Value: "FLEXPORT"
shippingType
required
string (ShippingType)

Type of shipping eg LTL, FTL, PARCEL

Enum: "LTL" "FTL" "PARCEL"
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

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

originWarehouseId
string

Warehouse from which the order will be sent

distributionChannelOrderId
string

External channel's order id

distributionChannel
required
string (Channel)

Distribution channel for which the order is created

Value: "WHOLESALE"
orderStatus
required
string (OrderStatus)

Current status of the order

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

Items in the order

Array
logisticsSku
required
string

Logistics sku of the product

unitsPerPack
required
number <double>

Case pack quantity of the product

totalUnits
required
number <double>

Total units to sent

required
Array of objects (ReplenishmentShipment)

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"
destinationWarehouseId
string

Warehouse ID to which the order is being sent

distributionChannelShipmentId
string

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

distributionChannelReferenceNumber
string

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

shipmentId
required
string

Shipment Id of the shipment

object (DeliverrAddress)

Address where the shipment is being sent

shippingPartner
string (Partner)

Shipping partner of the shipment

Value: "FLEXPORT"
shippingType
string (ShippingType)

Shipping type of the shipment

Enum: "LTL" "FTL" "PARCEL"
carrierName
string
Deprecated
trackingNumber
string
Deprecated
Array of objects (ShipmentTrackingDetail)

Tracking details of the shipment

required
Array of objects (ReplenishmentShipmentItem)

Items in the shipment

shipBy
string <date-time>

Ship by date provided by the external system in the request

401

Unauthorized

post/logistics/api/2024-07/orders/rs
Request samples
application/json
{
  • "distributionChannel": "WHOLESALE",
  • "orderItems": [
    • {
      • "logisticsSku": "string",
      • "unitsPerPack": 0,
      • "totalUnits": 0
      }
    ],
  • "to": {
    • "name": "string",
    • "company": "string",
    • "street1": "string",
    • "street2": "string",
    • "city": "string",
    • "zip": "string",
    • "state": "string",
    • "country": "string",
    • "phone": "string",
    • "email": "string",
    • "isResidential": true
    },
  • "shippingPreferences": {
    • "shippingPartner": "FLEXPORT",
    • "shippingType": "LTL"
    },
  • "externalId": "string",
  • "shipBy": "2019-08-24T14:15:22Z"
}
Response samples
application/json
{
  • "orderId": "string",
  • "externalId": "string",
  • "originWarehouseId": "string",
  • "distributionChannelOrderId": "string",
  • "distributionChannel": "WHOLESALE",
  • "orderStatus": "BOOKED",
  • "orderItems": [
    • {
      • "logisticsSku": "string",
      • "unitsPerPack": 0,
      • "totalUnits": 0
      }
    ],
  • "shipments": [
    • {
      • "status": "CANCELLED",
      • "destinationWarehouseId": "string",
      • "distributionChannelShipmentId": "string",
      • "distributionChannelReferenceNumber": "string",
      • "shipmentId": "string",
      • "destinationWarehouseAddress": {
        },
      • "shippingPartner": "FLEXPORT",
      • "shippingType": "LTL",
      • "carrierName": "string",
      • "trackingNumber": "string",
      • "trackingDetails": [
        ],
      • "shipmentItems": [
        ]
      }
    ],
  • "shipBy": "2019-08-24T14:15:22Z"
}

GetOrder

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

originWarehouseId
string

Warehouse from which the order will be sent

distributionChannelOrderId
string

External channel's order id

distributionChannel
required
string (Channel)

Distribution channel for which the order is created

Value: "WHOLESALE"
orderStatus
required
string (OrderStatus)

Current status of the order

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

Items in the order

Array
logisticsSku
required
string

Logistics sku of the product

unitsPerPack
required
number <double>

Case pack quantity of the product

totalUnits
required
number <double>

Total units to sent

required
Array of objects (ReplenishmentShipment)

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"
destinationWarehouseId
string

Warehouse ID to which the order is being sent

distributionChannelShipmentId
string

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

distributionChannelReferenceNumber
string

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

shipmentId
required
string

Shipment Id of the shipment

object (DeliverrAddress)

Address where the shipment is being sent

shippingPartner
string (Partner)

Shipping partner of the shipment

Value: "FLEXPORT"
shippingType
string (ShippingType)

Shipping type of the shipment

Enum: "LTL" "FTL" "PARCEL"
carrierName
string
Deprecated
trackingNumber
string
Deprecated
Array of objects (ShipmentTrackingDetail)

Tracking details of the shipment

required
Array of objects (ReplenishmentShipmentItem)

Items in the shipment

shipBy
string <date-time>

Ship by date provided by the external system in the request

401

Unauthorized

404

Not Found

get/logistics/api/2024-07/orders/rs/{orderId}
Response samples
application/json
{
  • "orderId": "string",
  • "externalId": "string",
  • "originWarehouseId": "string",
  • "distributionChannelOrderId": "string",
  • "distributionChannel": "WHOLESALE",
  • "orderStatus": "BOOKED",
  • "orderItems": [
    • {
      • "logisticsSku": "string",
      • "unitsPerPack": 0,
      • "totalUnits": 0
      }
    ],
  • "shipments": [
    • {
      • "status": "CANCELLED",
      • "destinationWarehouseId": "string",
      • "distributionChannelShipmentId": "string",
      • "distributionChannelReferenceNumber": "string",
      • "shipmentId": "string",
      • "destinationWarehouseAddress": {
        },
      • "shippingPartner": "FLEXPORT",
      • "shippingType": "LTL",
      • "carrierName": "string",
      • "trackingNumber": "string",
      • "trackingDetails": [
        ],
      • "shipmentItems": [
        ]
      }
    ],
  • "shipBy": "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