The Inbounds API allows you to create, track, and update inbound shipments.
You can also request and purchase rate quotes for those shipments.
Inbounds created using the API can either be sent to our LAX forwarding facility or a select reserve-storage facility.
You cannot use the API to create an inbound that is sent directly to a specific Fulfillment-Network warehouse.
Create an inbounding shipment.
Inbound Shipment created.
Bad Request
Unauthorized
Forbidden
{- "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",
- "quantity": 0
}
], - "packages": [
- {
- "length": 12,
- "width": 3,
- "height": 5,
- "weight": 3,
- "dimensionUnit": "in",
- "weightUnit": "oz",
- "items": [
- {
- "logisticsSku": "string",
- "quantity": 0
}
], - "numberOfIdenticalPkgs": 0
}
], - "prep": {
- "boxContentLabels": true
}
}
{- "id": "string",
- "receivingId": "string",
- "status": "PENDING",
- "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
}
}
], - "packages": [
- {
- "length": 12,
- "width": 3,
- "height": 5,
- "weight": 3,
- "dimensionUnit": "in",
- "weightUnit": "oz",
- "id": "string",
- "identicalPackageConfigIdentifer": "string",
- "items": [
- {
- "logisticsSku": "string",
- "quantity": 0
}
]
}
], - "arrivedAt": "2019-08-24T14:15:22Z",
- "completedAt": "2019-08-24T14:15:22Z",
- "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"
}
]
}, - "prep": {
- "boxContentLabels": true
}, - "shippingPlanId": "string"
}
Get inbounding shipments based on the provided shipmentIds.
Ok
id required | string |
receivingId required | string |
status required | string (LogisticsInboundShipmentStatus) Enum: "PENDING" "READY_TO_SHIP" "IN_TRANSIT" "ARRIVED" "PREPARING_FOR_DISTRIBUTION" "IN_PREP" "FORWARDING" "RECEIVING" "COMPLETED" |
required | object (AddressesOutput) |
Array of objects (ItemOutputUnstable) | |
Array of objects (PackageOutputUnstable) | |
arrivedAt | string <date-time> |
completedAt | string <date-time> |
object (ShopifyFreightResponse) | |
required | object (PrepRequestData) |
shippingPlanId required | string |
Bad Request
Unauthorized
Forbidden
Shipment not found
[- {
- "id": "string",
- "receivingId": "string",
- "status": "PENDING",
- "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
}
}
], - "packages": [
- {
- "length": 12,
- "width": 3,
- "height": 5,
- "weight": 3,
- "dimensionUnit": "in",
- "weightUnit": "oz",
- "id": "string",
- "identicalPackageConfigIdentifer": "string",
- "items": [
- {
- "logisticsSku": "string",
- "quantity": 0
}
]
}
], - "arrivedAt": "2019-08-24T14:15:22Z",
- "completedAt": "2019-08-24T14:15:22Z",
- "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"
}
]
}, - "prep": {
- "boxContentLabels": true
}, - "shippingPlanId": "string"
}
]
Get an inbounding shipment.
Ok
id required | string | ||||||||||||||||||
receivingId required | string | ||||||||||||||||||
status required | string (LogisticsInboundShipmentStatus) Enum: "PENDING" "READY_TO_SHIP" "IN_TRANSIT" "ARRIVED" "PREPARING_FOR_DISTRIBUTION" "IN_PREP" "FORWARDING" "RECEIVING" "COMPLETED" | ||||||||||||||||||
required | object (AddressesOutput) | ||||||||||||||||||
| |||||||||||||||||||
Array of objects (ItemOutputUnstable) | |||||||||||||||||||
Array of objects (PackageOutputUnstable) | |||||||||||||||||||
Array
| |||||||||||||||||||
arrivedAt | string <date-time> | ||||||||||||||||||
completedAt | string <date-time> | ||||||||||||||||||
object (ShopifyFreightResponse) | |||||||||||||||||||
| |||||||||||||||||||
required | object (PrepRequestData) | ||||||||||||||||||
shippingPlanId required | string |
Unauthorized
Forbidden
Shipment not found
{- "id": "string",
- "receivingId": "string",
- "status": "PENDING",
- "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
}
}
], - "packages": [
- {
- "length": 12,
- "width": 3,
- "height": 5,
- "weight": 3,
- "dimensionUnit": "in",
- "weightUnit": "oz",
- "id": "string",
- "identicalPackageConfigIdentifer": "string",
- "items": [
- {
- "logisticsSku": "string",
- "quantity": 0
}
]
}
], - "arrivedAt": "2019-08-24T14:15:22Z",
- "completedAt": "2019-08-24T14:15:22Z",
- "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"
}
]
}, - "prep": {
- "boxContentLabels": true
}, - "shippingPlanId": "string"
}
Update an inbounding shipment.
object (InboundAddress) | |||||||||||||||||||||||
| |||||||||||||||||||||||
shippingOption | string (InboundShippingOption) Enum: "SPD_EXTERNAL" "FREIGHT_EXTERNAL" "LTL_EXTERNAL" "LTL_INTERNAL" "FTL_INTERNAL" "SPD_INTERNAL" | ||||||||||||||||||||||
Array of objects (UpdatePackageInput) | |||||||||||||||||||||||
Array
| |||||||||||||||||||||||
object (UpdateFreightInputV3) | |||||||||||||||||||||||
packageTrackingNumber | string | ||||||||||||||||||||||
object (PrepRequestData) | |||||||||||||||||||||||
Array of objects (PackageInputUnstable) | |||||||||||||||||||||||
Array
|
Ok
id required | string | ||||||||||||||||||
receivingId required | string | ||||||||||||||||||
status required | string (LogisticsInboundShipmentStatus) Enum: "PENDING" "READY_TO_SHIP" "IN_TRANSIT" "ARRIVED" "PREPARING_FOR_DISTRIBUTION" "IN_PREP" "FORWARDING" "RECEIVING" "COMPLETED" | ||||||||||||||||||
required | object (AddressesOutput) | ||||||||||||||||||
| |||||||||||||||||||
Array of objects (ItemOutputUnstable) | |||||||||||||||||||
Array of objects (PackageOutputUnstable) | |||||||||||||||||||
Array
| |||||||||||||||||||
arrivedAt | string <date-time> | ||||||||||||||||||
completedAt | string <date-time> | ||||||||||||||||||
object (ShopifyFreightResponse) | |||||||||||||||||||
| |||||||||||||||||||
required | object (PrepRequestData) | ||||||||||||||||||
shippingPlanId required | string |
Unauthorized
Forbidden
Shipment not found
{- "from": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "countryCode": "AF",
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "provinceCode": "string",
- "zip": "string"
}, - "shippingOption": "SPD_EXTERNAL",
- "packages": [
- {
- "length": 12,
- "width": 3,
- "height": 5,
- "weight": 3,
- "dimensionUnit": "in",
- "weightUnit": "oz",
- "ids": [
- "string"
], - "shippingProvider": "string",
- "trackingNumber": "string"
}
], - "freightDetails": {
- "pallets": [
- {
- "length": 0,
- "width": 0,
- "height": 0,
- "dimensionUnit": "string",
- "weight": 0,
- "weightUnit": "string",
- "numberOfIdenticalPallets": 0
}
], - "pickup": {
- "readyDate": "2019-08-24T14:15:22Z",
- "facilityHoursStart": "string",
- "facilityHoursEnd": "string",
- "contactName": "string",
- "contactPhone": "string",
- "contactEmail": "string",
- "liftGate": true,
- "customerReferenceNumber": "string"
}, - "bolId": "string",
- "shippingProvider": "string",
- "proId": "string",
- "estimatedShipDate": "2019-08-24T14:15:22Z"
}, - "packageTrackingNumber": "string",
- "prep": {
- "boxContentLabels": true
}, - "createPackages": [
- {
- "length": 12,
- "width": 3,
- "height": 5,
- "weight": 3,
- "dimensionUnit": "in",
- "weightUnit": "oz",
- "items": [
- {
- "logisticsSku": "string",
- "quantity": 0
}
], - "numberOfIdenticalPkgs": 0
}
]
}
{- "id": "string",
- "receivingId": "string",
- "status": "PENDING",
- "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
}
}
], - "packages": [
- {
- "length": 12,
- "width": 3,
- "height": 5,
- "weight": 3,
- "dimensionUnit": "in",
- "weightUnit": "oz",
- "id": "string",
- "identicalPackageConfigIdentifer": "string",
- "items": [
- {
- "logisticsSku": "string",
- "quantity": 0
}
]
}
], - "arrivedAt": "2019-08-24T14:15:22Z",
- "completedAt": "2019-08-24T14:15:22Z",
- "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"
}
]
}, - "prep": {
- "boxContentLabels": true
}, - "shippingPlanId": "string"
}
Get result of asynchronous request for quotes. Returns quotes once asynchronous request is complete.
Ok
object (InboundExternalRateError) | |||||||||||||||||||||
required | Array of objects (RateQuoteWithPurchased) | ||||||||||||||||||||
Array
|
Unauthorized
Forbidden
Shipment not found
{- "error": {
- "code": "string",
- "subcode": "string"
}, - "quotes": [
- {
- "id": 0,
- "rateShoppingMethod": "CHEAPEST",
- "amount": 0,
- "fullAmount": 0,
- "currency": "string",
- "shippingProvider": "string",
- "providerMethod": "string",
- "purchased": true,
- "estimatedTimeOfArrival": "2019-08-24T14:15:22Z",
- "shippingOption": "SPD_EXTERNAL"
}
]
}
Asynchronous endpoint for starting a request for quotes on an inbounding shipment. Returns success if request was accepted.
Accepted
Unauthorized
Forbidden
Shipment not found
{- "quotes": [
- {
- "shippingOption": "SPD",
- "rateShoppingMethod": "CHEAPEST",
- "amount": 0,
- "fullAmount": 0,
- "currency": "string",
- "shippingProvider": "string",
- "providerMethod": "string",
- "externalEstimateDays": 0,
- "externalEta": "2019-08-24T14:15:22Z",
- "id": 0
}
], - "error": {
- "code": "string",
- "subcode": "string"
}
}
Asynchronous endpoint for starting a request to buy quotes on an inbounding shipment. Returns success if request was accepted.
Accepted
Unauthorized
Forbidden
Shipment not found
{- "quoteIds": [
- 0
]
}
{- "transactions": [
- {
- "quoteId": 0,
- "shippingOption": "SPD",
- "rateShoppingMethod": "CHEAPEST",
- "amount": 0,
- "currency": "string",
- "shippingProvider": "string",
- "providerMethod": "string",
- "externalEstimateDays": 0,
- "externalEta": "2019-08-24T14:15:22Z"
}
], - "error": {
- "code": "string",
- "subcode": "string"
}
}
Get result of asynchronous request to buy quotes. Returns quotes once asynchronous request is complete.
Ok
object (InboundExternalRateError) | |||||||||||||||||||||
required | Array of objects (RateQuoteWithPurchased) | ||||||||||||||||||||
Array
|
Unauthorized
Forbidden
Shipment not found
{- "error": {
- "code": "string",
- "subcode": "string"
}, - "quotes": [
- {
- "id": 0,
- "rateShoppingMethod": "CHEAPEST",
- "amount": 0,
- "fullAmount": 0,
- "currency": "string",
- "shippingProvider": "string",
- "providerMethod": "string",
- "purchased": true,
- "estimatedTimeOfArrival": "2019-08-24T14:15:22Z",
- "shippingOption": "SPD_EXTERNAL"
}
]
}