logo

Inbounds

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, a select reserve-storage facility, or direct to your assigned one-node facility (applies only to select Merchants). Unless you have an assigned one-node facility, you cannot use the API to create an inbound that is sent directly to a specific Fulfillment-Network warehouse.

Get a list of storage warehouses

Get storage-warehouses that can store products.

SecurityBEARER
Responses
200

Ok

Response Schema: application/json
Array
address1
required
string <= 255 characters

The first line of the address. Typically the street address or PO Box number.

address2
string <= 255 characters

The second line of the address. Typically the number of the apartment, suite, or unit.

city
required
string <= 255 characters

The name of the city, district, village, or town.

company
string <= 255 characters

The name of the customer's company or organization.

countryCode
required
string (CountryCode)

The two-letter code for the country of the address.

Enum: "AF" "AX" "AL" "DZ" "AS" "AD" "AO" "AI" "AQ" "AG" "AR" "AM" "AW" "AU" "AT" "AZ" "BS" "BH" "BD" "BB" "BY" "BE" "BZ" "BJ" "BM" "BT" "BO" "BQ" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "CV" "KH" "CM" "CA" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CW" "CY" "CZ" "DK" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "SZ" "ET" "FK" "FO" "FJ" "FI" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KP" "KR" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "MK" "MP" "NO" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "BL" "SH" "KN" "LC" "MF" "PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO" "ZA" "GS" "SS" "ES" "LK" "SD" "SR" "SJ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "US" "UM" "UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW"
name
string <= 255 characters

The full name of the customer.

firstName
string <= 255 characters
Deprecated

The first name of the customer.

lastName
string <= 255 characters
Deprecated

The last name of the customer.

phone
string

A unique phone number for the customer. Formatted using E.164 standard. For example, +16135551111.

provinceCode
required
string <= 30 characters

The code for the region of the address, such as the province, state, or district. For example QC for Quebec, Canada.

zip
required
string <= 30 characters

The zip or postal code of the address.

storageWarehouseId
required
string <= 50 characters

The unique id of a storage-warehouse.

401

Unauthorized

403

Forbidden

get/logistics/api/2025-03/inbounds/storage_warehouses
Response samples
application/json
[
  • {
    • "address1": "string",
    • "address2": "string",
    • "city": "string",
    • "company": "string",
    • "countryCode": "AF",
    • "name": "string",
    • "firstName": "string",
    • "lastName": "string",
    • "phone": "string",
    • "provinceCode": "string",
    • "zip": "string",
    • "storageWarehouseId": "string"
    }
]

Create a shipment

Create an inbounding shipment.

SecurityBEARER
Request
Request Body schema: application/json
required
palletCount
number <double>

only used by STORAGE shipments; required when cargoType is PALLETIZED

object (PrepRequestData)

only used by NETWORK shipments & required for NETWORK shipments

boxContentLabels
required
boolean
shippingPlanExternalId
string

Unique identifier for the shipment.

Recommended: Use an internal shipment ID or a UUID/GUID e.g., "SHIP-2024-001-abc123" or "550e8400-e29b-41d4-a716-446655440000"

On duplicates: Returns 400 Bad Request with the message:

A shipping plan with this external ID already exists. Please use a unique external ID and try again.

shippingPlanName
string
bookingId
string^[Ff][Ll][Ee][Xx]-

Booking ID is the FLEX-ID of a Flexport freight shipment in Core.

e.g., "FLEX-1234567890"

shipmentDestination
string (LogisticsInboundShipmentDestination)

defaults to NETWORK; Classify the destination of the shipment.

Enum: "NETWORK" "STORAGE"
storageWarehouseId
string

Mandatory for STORAGE shipments (shipmentDestination: "STORAGE"). Not applicable for NETWORK shipments.

The unique identifier of the storage-warehouse facility where the shipment will be stored.

Valid storageWarehouseIds can be retrieved using the GetStorageWarehouses operation.

cargoType
string (LogisticsInboundCargoType)

Required for STORAGE shipments (shipmentDestination: "STORAGE"). Optional for NETWORK shipments - if omitted, the default is PALLETIZED.

Indicates whether the shipment is loaded on pallets or floor-loaded (boxes placed directly into the container).

Enum: "PALLETIZED" "FLOOR_LOADED_CONTAINER"
object (ContainerInput)

Mandatory when cargoType is set to FLOOR_LOADED_CONTAINER. Not applicable for other cargo types.

size
required
string (LogisticsInboundContainerSize)
Enum: "GENERAL_20FT" "GENERAL_40FT"
id
string
shippingOption
string (InboundShippingOption)
Enum: "SPD_EXTERNAL" "FREIGHT_EXTERNAL" "LTL_EXTERNAL" "LTL_INTERNAL" "FTL_INTERNAL" "SPD_INTERNAL"
required
object (InboundAddressV2)
name
required
string <= 255 characters

The full name of the customer.

city
required
string <= 255 characters

The name of the city, district, village, or town.

zip
required
string <= 30 characters

The zip or postal code of the address.

address1
required
string <= 255 characters

The first line of the address. Typically the street address or PO Box number.

address2
string <= 255 characters

The second line of the address. Typically the number of the apartment, suite, or unit.

company
string <= 255 characters

The name of the customer's company or organization.

countryCode
required
string (CountryCode)

The two-letter code for the country of the address.

Enum: "AF" "AX" "AL" "DZ" "AS" "AD" "AO" "AI" "AQ" "AG" "AR" "AM" "AW" "AU" "AT" "AZ" "BS" "BH" "BD" "BB" "BY" "BE" "BZ" "BJ" "BM" "BT" "BO" "BQ" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "CV" "KH" "CM" "CA" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CW" "CY" "CZ" "DK" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "SZ" "ET" "FK" "FO" "FJ" "FI" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KP" "KR" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "MK" "MP" "NO" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "BL" "SH" "KN" "LC" "MF" "PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO" "ZA" "GS" "SS" "ES" "LK" "SD" "SR" "SJ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "US" "UM" "UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW"
firstName
string <= 255 characters
Deprecated

The first name of the customer.

lastName
string <= 255 characters
Deprecated

The last name of the customer.

phone
string

A unique phone number for the customer. Formatted using E.164 standard. For example, +16135551111.

provinceCode
required
string <= 30 characters

The code for the region of the address, such as the province, state, or district. For example QC for Quebec, Canada.

destinationWarehouseId
string

Required only for NETWORK shipments (shipmentDestination: "NETWORK"), and only when creating an inbound directly to a DTC fulfillment facility instead of using cross-docking for distribution.

This field is available only for merchants on Multi-Node Zone-Based Pricing.

Valid destinationWarehouseId values can be retrieved using the GetInboundsWarehouses operation.

Array of objects (ItemDataV4)

required for STORAGE shipments & optional for NETWORK shipments if packages are provided; The items on the shipment. Specify items if creating a blind inbound.

Array
logisticsSku
string

Required for STORAGE shipments. For NETWORK shipments, either logisticsSku or merchantSku must be provided.

merchantSku
string

Not applicable for STORAGE shipments. For NETWORK shipments, either logisticsSku or merchantSku must be provided.

quantity
required
integer <int32>

the total number of units for a given SKU; for STORAGE shipments the quantity must be a multiple of the unitsPerCase defined within the caseDetails

lotNumber
string
expirationDate
string <date>
lineItemId
string

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

object (CasePackTemplateV2)

only used by STORAGE shipments & required for STORAGE shipments

Array of objects (PackageInputV3)

only used by NETWORK shipments & optional if items are provided; The packages on the shipment. Packages do not need to be specified if creating an blind inbound where items are provided instead.

Array
required
Array of objects (ItemDataV3)
dimensionUnit
string (LengthUnitV2)

Which dimension measurement standards are being used for the package.

Enum: "in" "cm"
weight
number <float> >= 0.01

Weight of the package.

length
number <float> >= 0.01

Length of the package.

width
number <float> >= 0.01

Width of the package.

height
number <float> >= 0.01

Height of the package.

numberOfIdenticalPkgs
required
number <double>
sellerLPNs
Array of strings

The seller's unique identifier for the package. The length of sellerLPNs array must match the value specified in numberOfIdenticalPkgs.

weightUnit
string (WeightUnitV2)

Which weight measurement standards are being used for the package.

Enum: "lb" "kg"
Responses
201

Inbound Shipment created.

400

Bad Request

401

Unauthorized

403

Forbidden

post/logistics/api/2025-03/inbounds/shipments
Request samples
application/json
{
  • "shipmentDestination": "NETWORK",
  • "from": {
    • "name": "John Smith",
    • "address1": "123 Main St",
    • "city": "New York",
    • "provinceCode": "NY",
    • "countryCode": "US",
    • "zip": "10001"
    },
  • "shippingPlanExternalId": "plan-123",
  • "shippingPlanName": "My Shipping Plan",
  • "prep": {
    • "boxContentLabels": true
    },
  • "items": [
    • {
      • "logisticsSku": "D1234567890",
      • "quantity": 1,
      • "lineItemId": "10"
      }
    ]
}
Response samples
application/json
{
  • "id": "string",
  • "receivingId": "string",
  • "status": "PENDING",
  • "items": [
    • {
      • "logisticsSku": "string",
      • "shipmentItemId": "string",
      • "counts": {
        },
      • "lineItemId": "string",
      • "merchantSku": "string"
      }
    ],
  • "packages": [
    • {
      • "length": 12,
      • "width": 3,
      • "height": 5,
      • "weight": 3,
      • "dimensionUnit": "in",
      • "weightUnit": "oz",
      • "id": "string",
      • "identicalPackageConfigIdentifer": "string",
      • "items": [
        ],
      • "sellerLPN": "string"
      }
    ],
  • "arrivedAt": "2019-08-24T14:15:22Z",
  • "completedAt": "2019-08-24T14:15:22Z",
  • "shippingPlanId": "string",
  • "shippingPlanExternalId": "string",
  • "shippingPlanName": "string",
  • "bookingId": "string",
  • "shippingOption": "SPD_EXTERNAL",
  • "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"
      }
    },
  • "freight": {
    • "pickup": {
      • "id": 0,
      • "contactName": "string",
      • "contactPhone": "string",
      • "contactEmail": "string",
      • "liftGate": true,
      • "pickupDate": "2019-08-24T14:15:22Z",
      • "customerReferenceNumber": "string",
      • "facilityOperatingHours": {
        }
      },
    • "pallets": [
      • {
        }
      ],
    • "bolId": "string",
    • "shippingProvider": "string",
    • "proId": "string",
    • "estimatedShipDate": "2019-08-24T14:15:22Z",
    • "carrierEmailAddress": "string"
    },
  • "prep": {
    • "boxContentLabels": true
    },
  • "shipmentDestination": "NETWORK",
  • "cargoType": "PALLETIZED",
  • "container": {
    • "size": "GENERAL_20FT",
    • "id": "string"
    }
}

Get a list of shipments

Get inbounding shipments based on the provided shipmentIds.

SecurityBEARER
Request
query Parameters
shipmentIds
Array of integers <int32>

The shipmentIds to get shipments for. If this query parameter is not provided, a list of all shipments will be returned subject to limit and offset query parameters

limit
number <double>
Default: 20

The number of shipments to return. Only applies when shipmentIds is not passed in. Defaults to 20, capped at 100

offset
number <double>
Default: 0

The number of shipments to skip before returning. Only applies when shipmentIds is not passed in. Defaults to 0

statuses
Array of strings (LogisticsInboundShipmentStatus)

Array of statuses. Only return shipments with given statuses. If empty, return all shipments.

Items Enum: "PENDING" "READY_TO_SHIP" "IN_TRANSIT" "ARRIVED" "PREPARING_FOR_DISTRIBUTION" "IN_PREP" "FORWARDING" "RECEIVING" "COMPLETED"
bookingIds
Array of strings

Array of booking IDs to get shipments for. Can be used instead of or in combination with shipmentIds.

Responses
200

Ok

Response Schema: application/json
Array
status
required
string (LogisticsInboundShipmentStatus)
Enum: "PENDING" "READY_TO_SHIP" "IN_TRANSIT" "ARRIVED" "PREPARING_FOR_DISTRIBUTION" "IN_PREP" "FORWARDING" "RECEIVING" "COMPLETED"
Array of objects (PackageOutputUnstable)
id
required
string
object (PrepRequestData)
shippingPlanExternalId
string

The external shipment ID provided in the request.

shippingPlanName
string
bookingId
string
shippingPlanId
required
string
object (ShopifyFreightResponseV2)
arrivedAt
string <date-time>
completedAt
string <date-time>
shipmentDestination
required
string (LogisticsInboundShipmentDestination)
Enum: "NETWORK" "STORAGE"
cargoType
string (LogisticsInboundCargoType)
Enum: "PALLETIZED" "FLOOR_LOADED_CONTAINER"
object (ContainerOutput)
shippingOption
string (InboundShippingOption)
Enum: "SPD_EXTERNAL" "FREIGHT_EXTERNAL" "LTL_EXTERNAL" "LTL_INTERNAL" "FTL_INTERNAL" "SPD_INTERNAL"
receivingId
string
required
object (AddressesOutputUnstable)
Array of objects (ItemOutputUnstableV2)
400

Bad Request

401

Unauthorized

403

Forbidden

404

Shipment not found

get/logistics/api/2025-03/inbounds/shipments
Response samples
application/json
[
  • {
    • "status": "PENDING",
    • "packages": [
      • {
        }
      ],
    • "id": "string",
    • "prep": {
      • "boxContentLabels": true
      },
    • "shippingPlanExternalId": "string",
    • "shippingPlanName": "string",
    • "bookingId": "string",
    • "shippingPlanId": "string",
    • "freight": {
      • "pickup": {
        },
      • "pallets": [
        ],
      • "bolId": "string",
      • "shippingProvider": "string",
      • "proId": "string",
      • "estimatedShipDate": "2019-08-24T14:15:22Z",
      • "carrierEmailAddress": "string"
      },
    • "arrivedAt": "2019-08-24T14:15:22Z",
    • "completedAt": "2019-08-24T14:15:22Z",
    • "shipmentDestination": "NETWORK",
    • "cargoType": "PALLETIZED",
    • "container": {
      • "size": "GENERAL_20FT",
      • "id": "string"
      },
    • "shippingOption": "SPD_EXTERNAL",
    • "receivingId": "string",
    • "addresses": {
      • "to": {
        },
      • "from": {
        }
      },
    • "items": [
      • {
        }
      ]
    }
]

Create a shipment asynchronously

Create an inbound shipment asynchronously. This endpoint performs comprehensive synchronous validation of the request payload before accepting the creation request:

  • if all validations pass, a 202 Accepted response is returned and the request is queued for background processing (including downstream system integrations, which occur asynchronously);
  • if any validation fails, a 400 Bad Request is returned immediately with error details explaining the violated rule. After receiving a 202 response, shipment creation continues in the background and you can use the shippingPlanExternalId from the request to retrieve the shipment status via the Get Shipment endpoint once processing completes.

This endpoint is recommended for handling large shipments (up to 30,000 DSKUs) when you prefer a quick, non-blocking API response instead of waiting for shipment creation to complete, or when asynchronous processing is required for your integration.

SecurityBEARER
Request
Request Body schema: application/json
required
Array of objects (PackageInputV3)

only used by NETWORK shipments & optional if items are provided; The packages on the shipment. Packages do not need to be specified if creating an blind inbound where items are provided instead.

Array
required
Array of objects (ItemDataV3)
dimensionUnit
string (LengthUnitV2)

Which dimension measurement standards are being used for the package.

Enum: "in" "cm"
weight
number <float> >= 0.01

Weight of the package.

length
number <float> >= 0.01

Length of the package.

width
number <float> >= 0.01

Width of the package.

height
number <float> >= 0.01

Height of the package.

numberOfIdenticalPkgs
required
number <double>
sellerLPNs
Array of strings

The seller's unique identifier for the package. The length of sellerLPNs array must match the value specified in numberOfIdenticalPkgs.

weightUnit
string (WeightUnitV2)

Which weight measurement standards are being used for the package.

Enum: "lb" "kg"
palletCount
number <double>

only used by STORAGE shipments; required when cargoType is PALLETIZED

object (PrepRequestData)

only used by NETWORK shipments & required for NETWORK shipments

boxContentLabels
required
boolean
shippingPlanName
string
bookingId
string^[Ff][Ll][Ee][Xx]-

Booking ID is the FLEX-ID of a Flexport freight shipment in Core.

e.g., "FLEX-1234567890"

Array of objects (ItemDataV4)

required for STORAGE shipments & optional for NETWORK shipments if packages are provided; The items on the shipment. Specify items if creating a blind inbound.

Array
logisticsSku
string

Required for STORAGE shipments. For NETWORK shipments, either logisticsSku or merchantSku must be provided.

merchantSku
string

Not applicable for STORAGE shipments. For NETWORK shipments, either logisticsSku or merchantSku must be provided.

quantity
required
integer <int32>

the total number of units for a given SKU; for STORAGE shipments the quantity must be a multiple of the unitsPerCase defined within the caseDetails

lotNumber
string
expirationDate
string <date>
lineItemId
string

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

object (CasePackTemplateV2)

only used by STORAGE shipments & required for STORAGE shipments

required
object (InboundAddressV2)
name
required
string <= 255 characters

The full name of the customer.

city
required
string <= 255 characters

The name of the city, district, village, or town.

zip
required
string <= 30 characters

The zip or postal code of the address.

address1
required
string <= 255 characters

The first line of the address. Typically the street address or PO Box number.

address2
string <= 255 characters

The second line of the address. Typically the number of the apartment, suite, or unit.

company
string <= 255 characters

The name of the customer's company or organization.

countryCode
required
string (CountryCode)

The two-letter code for the country of the address.

Enum: "AF" "AX" "AL" "DZ" "AS" "AD" "AO" "AI" "AQ" "AG" "AR" "AM" "AW" "AU" "AT" "AZ" "BS" "BH" "BD" "BB" "BY" "BE" "BZ" "BJ" "BM" "BT" "BO" "BQ" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "CV" "KH" "CM" "CA" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CW" "CY" "CZ" "DK" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "SZ" "ET" "FK" "FO" "FJ" "FI" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KP" "KR" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "MK" "MP" "NO" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "BL" "SH" "KN" "LC" "MF" "PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO" "ZA" "GS" "SS" "ES" "LK" "SD" "SR" "SJ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "US" "UM" "UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW"
firstName
string <= 255 characters
Deprecated

The first name of the customer.

lastName
string <= 255 characters
Deprecated

The last name of the customer.

phone
string

A unique phone number for the customer. Formatted using E.164 standard. For example, +16135551111.

provinceCode
required
string <= 30 characters

The code for the region of the address, such as the province, state, or district. For example QC for Quebec, Canada.

shipmentDestination
string (LogisticsInboundShipmentDestination)

defaults to NETWORK; Classify the destination of the shipment.

Enum: "NETWORK" "STORAGE"
storageWarehouseId
string

Mandatory for STORAGE shipments (shipmentDestination: "STORAGE"). Not applicable for NETWORK shipments.

The unique identifier of the storage-warehouse facility where the shipment will be stored.

Valid storageWarehouseIds can be retrieved using the GetStorageWarehouses operation.

cargoType
string (LogisticsInboundCargoType)

Required for STORAGE shipments (shipmentDestination: "STORAGE"). Optional for NETWORK shipments - if omitted, the default is PALLETIZED.

Indicates whether the shipment is loaded on pallets or floor-loaded (boxes placed directly into the container).

Enum: "PALLETIZED" "FLOOR_LOADED_CONTAINER"
object (ContainerInput)

Mandatory when cargoType is set to FLOOR_LOADED_CONTAINER. Not applicable for other cargo types.

size
required
string (LogisticsInboundContainerSize)
Enum: "GENERAL_20FT" "GENERAL_40FT"
id
string
shippingOption
string (InboundShippingOption)
Enum: "SPD_EXTERNAL" "FREIGHT_EXTERNAL" "LTL_EXTERNAL" "LTL_INTERNAL" "FTL_INTERNAL" "SPD_INTERNAL"
destinationWarehouseId
string

Required only for NETWORK shipments (shipmentDestination: "NETWORK"), and only when creating an inbound directly to a DTC fulfillment facility instead of using cross-docking for distribution.

This field is available only for merchants on Multi-Node Zone-Based Pricing.

Valid destinationWarehouseId values can be retrieved using the GetInboundsWarehouses operation.

shippingPlanExternalId
required
string

A unique identifier for the shipment. This field is required when creating an asynchronous shipment and is used to retrieve the shipment.

Recommended: Use an internal shipment ID or a UUID/GUID e.g., "SHIP-2024-001-abc123" or "550e8400-e29b-41d4-a716-446655440000"

On duplicates: Returns 400 Bad Request with the message:

A shipping plan with this external ID already exists. Please use a unique external ID and try again.

Responses
202

Inbound Shipment creation accepted.

400

Bad Request

401

Unauthorized

403

Forbidden

post/logistics/api/2025-03/inbounds/async/shipments
Request samples
application/json
{
  • "shipmentDestination": "NETWORK",
  • "from": {
    • "name": "John Smith",
    • "address1": "123 Main St",
    • "city": "New York",
    • "provinceCode": "NY",
    • "countryCode": "US",
    • "zip": "10001"
    },
  • "shippingPlanExternalId": "plan-123",
  • "shippingPlanName": "My Shipping Plan",
  • "prep": {
    • "boxContentLabels": true
    },
  • "items": [
    • {
      • "logisticsSku": "D1234567890",
      • "quantity": 1,
      • "lineItemId": "10"
      }
    ]
}
Response samples
application/json
{
  • "status": 400,
  • "type": "string",
  • "title": "string",
  • "detail": "string",
  • "instance": "string"
}

Get a shipment

Get an inbounding shipment.

SecurityBEARER
Request
path Parameters
shipmentId
required
integer <int32>
Responses
200

Ok

Response Schema: application/json
status
required
string (LogisticsInboundShipmentStatus)
Enum: "PENDING" "READY_TO_SHIP" "IN_TRANSIT" "ARRIVED" "PREPARING_FOR_DISTRIBUTION" "IN_PREP" "FORWARDING" "RECEIVING" "COMPLETED"
Array of objects (PackageOutputUnstable)
Array
length
number <float> >= 0.01

Length of the package.

width
number <float> >= 0.01

Width of the package.

height
number <float> >= 0.01

Height of the package.

weight
number <float> >= 0.01

Weight of the package.

dimensionUnit
string (LengthUnit)

Which length measurement standards are being used for the package.

Enum: "in" "cm" "mm" "m"
weightUnit
string (WeightUnit)

Which weight measurement standards are being used for the package.

Enum: "oz" "kg" "lb" "g"
id
required
string
identicalPackageConfigIdentifer
string
required
Array of objects (ItemDataV2)
sellerLPN
string or null

The seller's unique identifier for the package.

id
required
string
object (PrepRequestData)
boxContentLabels
required
boolean
shippingPlanExternalId
string

The external shipment ID provided in the request.

shippingPlanName
string
bookingId
string
shippingPlanId
required
string
object (ShopifyFreightResponseV2)
object (FreightPickupResponse)
Array of objects (FreightPalletResponse)
bolId
string
shippingProvider
string
proId
string
estimatedShipDate
string <date-time>
carrierEmailAddress
string
arrivedAt
string <date-time>
completedAt
string <date-time>
shipmentDestination
required
string (LogisticsInboundShipmentDestination)
Enum: "NETWORK" "STORAGE"
cargoType
string (LogisticsInboundCargoType)
Enum: "PALLETIZED" "FLOOR_LOADED_CONTAINER"
object (ContainerOutput)
size
required
string (LogisticsInboundContainerSize)
Enum: "GENERAL_20FT" "GENERAL_40FT"
id
string
shippingOption
string (InboundShippingOption)
Enum: "SPD_EXTERNAL" "FREIGHT_EXTERNAL" "LTL_EXTERNAL" "LTL_INTERNAL" "FTL_INTERNAL" "SPD_INTERNAL"
receivingId
string
required
object (AddressesOutputUnstable)
required
object (InboundAddress)
required
InboundAddress (object) or WarehouseAddress (object)
Array of objects (ItemOutputUnstableV2)
Array
logisticsSku
required
string
shipmentItemId
required
string
required
object (CountsOutput)
lineItemId
string
merchantSku
string
packOfDsku
string
caseQty
number <double>
401

Unauthorized

403

Forbidden

404

Shipment not found

get/logistics/api/2025-03/inbounds/shipments/{shipmentId}
Response samples
application/json
{
  • "status": "PENDING",
  • "packages": [
    • {
      • "length": 12,
      • "width": 3,
      • "height": 5,
      • "weight": 3,
      • "dimensionUnit": "in",
      • "weightUnit": "oz",
      • "id": "string",
      • "identicalPackageConfigIdentifer": "string",
      • "items": [
        ],
      • "sellerLPN": "string"
      }
    ],
  • "id": "string",
  • "prep": {
    • "boxContentLabels": true
    },
  • "shippingPlanExternalId": "string",
  • "shippingPlanName": "string",
  • "bookingId": "string",
  • "shippingPlanId": "string",
  • "freight": {
    • "pickup": {
      • "id": 0,
      • "contactName": "string",
      • "contactPhone": "string",
      • "contactEmail": "string",
      • "liftGate": true,
      • "pickupDate": "2019-08-24T14:15:22Z",
      • "customerReferenceNumber": "string",
      • "facilityOperatingHours": {
        }
      },
    • "pallets": [
      • {
        }
      ],
    • "bolId": "string",
    • "shippingProvider": "string",
    • "proId": "string",
    • "estimatedShipDate": "2019-08-24T14:15:22Z",
    • "carrierEmailAddress": "string"
    },
  • "arrivedAt": "2019-08-24T14:15:22Z",
  • "completedAt": "2019-08-24T14:15:22Z",
  • "shipmentDestination": "NETWORK",
  • "cargoType": "PALLETIZED",
  • "container": {
    • "size": "GENERAL_20FT",
    • "id": "string"
    },
  • "shippingOption": "SPD_EXTERNAL",
  • "receivingId": "string",
  • "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": {
        },
      • "lineItemId": "string",
      • "merchantSku": "string",
      • "packOfDsku": "string",
      • "caseQty": 0
      }
    ]
}

Request document for a shipment

Request document for an inbounding shipment.

SecurityBEARER
Request
path Parameters
shipmentId
required
integer <int32>
query Parameters
documentOption
required
string (DocumentOption)
Enum: "BOX_CONTENT_LABEL" "SHIPPING_LABEL" "BILL_OF_LADING" "PALLET_LABEL"
documentFormat
required
string (BoxLabelsFormat)
Enum: "US_LETTER" "THERMAL_4_X_6" "A4_PAPER"
Responses
200

Ok

Response Schema: application/json
ready
required
boolean
url
required
string
401

Unauthorized

403

Forbidden

404

Document not found

get/logistics/api/2025-03/inbounds/shipments/{shipmentId}/document
Response samples
application/json
{
  • "ready": true,
  • "url": "string"
}

Update a shipment

Update an inbounding shipment.

SecurityBEARER
Request
path Parameters
shipmentId
required
integer <int32>
Request Body schema: application/json
required
object (InboundAddress)
address1
required
string <= 255 characters

The first line of the address. Typically the street address or PO Box number.

address2
string <= 255 characters

The second line of the address. Typically the number of the apartment, suite, or unit.

city
required
string <= 255 characters

The name of the city, district, village, or town.

company
string <= 255 characters

The name of the customer's company or organization.

countryCode
required
string (CountryCode)

The two-letter code for the country of the address.

Enum: "AF" "AX" "AL" "DZ" "AS" "AD" "AO" "AI" "AQ" "AG" "AR" "AM" "AW" "AU" "AT" "AZ" "BS" "BH" "BD" "BB" "BY" "BE" "BZ" "BJ" "BM" "BT" "BO" "BQ" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "CV" "KH" "CM" "CA" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CW" "CY" "CZ" "DK" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "SZ" "ET" "FK" "FO" "FJ" "FI" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KP" "KR" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "MK" "MP" "NO" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "BL" "SH" "KN" "LC" "MF" "PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO" "ZA" "GS" "SS" "ES" "LK" "SD" "SR" "SJ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "US" "UM" "UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW"
name
string <= 255 characters

The full name of the customer.

firstName
string <= 255 characters
Deprecated

The first name of the customer.

lastName
string <= 255 characters
Deprecated

The last name of the customer.

phone
string

A unique phone number for the customer. Formatted using E.164 standard. For example, +16135551111.

provinceCode
required
string <= 30 characters

The code for the region of the address, such as the province, state, or district. For example QC for Quebec, Canada.

zip
required
string <= 30 characters

The zip or postal code of the address.

shippingOption
string (InboundShippingOption)
Enum: "SPD_EXTERNAL" "FREIGHT_EXTERNAL" "LTL_EXTERNAL" "LTL_INTERNAL" "FTL_INTERNAL" "SPD_INTERNAL"
Array of objects (UpdatePackageInputV2)
Array
weight
number <float> >= 0.01

Weight of the package.

length
number <float> >= 0.01

Length of the package.

width
number <float> >= 0.01

Width of the package.

height
number <float> >= 0.01

Height of the package.

ids
required
Array of strings
shippingProvider
string
trackingNumber
string
weightUnit
string (WeightUnitV2)

Which weight measurement standards are being used for the package.

Enum: "lb" "kg"
dimensionUnit
string (LengthUnitV2)

Which dimension measurement standards are being used for the package.

Enum: "in" "cm"
object (UpdateFreightInputV3)
Array of objects (PalletInput)
object (PickupInputV3)
bolId
string
shippingProvider
string
proId
string
estimatedShipDate
string <date-time>
packageTrackingNumber
string
object (PrepRequestData)
boxContentLabels
required
boolean
Array of objects (PackageInputV1)
Array
length
number <float> >= 0.01

Length of the package.

width
number <float> >= 0.01

Width of the package.

height
number <float> >= 0.01

Height of the package.

weight
number <float> >= 0.01

Weight of the package.

dimensionUnit
string (LengthUnit)

Which length measurement standards are being used for the package.

Enum: "in" "cm" "mm" "m"
weightUnit
string (WeightUnit)

Which weight measurement standards are being used for the package.

Enum: "oz" "kg" "lb" "g"
required
Array of objects (ItemDataV2)
numberOfIdenticalPkgs
required
number <double>
sellerLPNs
Array of strings

The seller's unique identifier for the package. The length of sellerLPNs array must match the value specified in numberOfIdenticalPkgs.

Responses
200

Ok

Response Schema: application/json
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)
required
object (InboundAddress)
required
object (InboundAddress)
Array of objects (ItemOutputUnstable)
Array
logisticsSku
required
string
shipmentItemId
required
string
required
object (CountsOutput)
lineItemId
string
merchantSku
string
Array of objects (PackageOutputUnstable)
Array
length
number <float> >= 0.01

Length of the package.

width
number <float> >= 0.01

Width of the package.

height
number <float> >= 0.01

Height of the package.

weight
number <float> >= 0.01

Weight of the package.

dimensionUnit
string (LengthUnit)

Which length measurement standards are being used for the package.

Enum: "in" "cm" "mm" "m"
weightUnit
string (WeightUnit)

Which weight measurement standards are being used for the package.

Enum: "oz" "kg" "lb" "g"
id
required
string
identicalPackageConfigIdentifer
string
required
Array of objects (ItemDataV2)
sellerLPN
string or null

The seller's unique identifier for the package.

arrivedAt
string <date-time>
completedAt
string <date-time>
object (ShopifyFreightResponse)
object (FreightPickupResponse)
Array of objects (FreightPalletResponse)
required
object (PrepRequestData)
boxContentLabels
required
boolean
shippingPlanId
required
string
401

Unauthorized

403

Forbidden

404

Shipment not found

patch/logistics/api/2025-03/inbounds/shipments/{shipmentId}/update
Request samples
application/json
{
  • "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": [
    • {
      • "weight": 3,
      • "length": 12,
      • "width": 3,
      • "height": 5,
      • "ids": [
        ],
      • "shippingProvider": "string",
      • "trackingNumber": "string",
      • "weightUnit": "lb",
      • "dimensionUnit": "in"
      }
    ],
  • "freightDetails": {
    • "pallets": [
      • {
        }
      ],
    • "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": [
        ],
      • "numberOfIdenticalPkgs": 0,
      • "sellerLPNs": [
        ]
      }
    ]
}
Response samples
application/json
{
  • "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": {
        },
      • "lineItemId": "string",
      • "merchantSku": "string"
      }
    ],
  • "packages": [
    • {
      • "length": 12,
      • "width": 3,
      • "height": 5,
      • "weight": 3,
      • "dimensionUnit": "in",
      • "weightUnit": "oz",
      • "id": "string",
      • "identicalPackageConfigIdentifer": "string",
      • "items": [
        ],
      • "sellerLPN": "string"
      }
    ],
  • "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": {
        }
      },
    • "pallets": [
      • {
        }
      ]
    },
  • "prep": {
    • "boxContentLabels": true
    },
  • "shippingPlanId": "string"
}

Get quotes for a shipment

Get result of asynchronous request for quotes. Returns quotes once asynchronous request is complete.

SecurityBEARER
Request
path Parameters
shipmentId
required
integer <int32>
query Parameters
shippingOption
string (InboundShippingOption)
Enum: "SPD_EXTERNAL" "FREIGHT_EXTERNAL" "LTL_EXTERNAL" "LTL_INTERNAL" "FTL_INTERNAL" "SPD_INTERNAL"
Responses
200

Ok

Response Schema: application/json
object (InboundExternalRateError)
code
string
subcode
string
required
Array of objects (RateQuoteWithPurchased)
Array
id
required
number <double>
shippingProvider
required
string
rateShoppingMethod
required
string (InboundRateShoppingMethod)
Enum: "CHEAPEST" "FASTEST" "ERROR" "RACE"
amount
required
number <double>
fullAmount
number <double>
currency
required
string
providerMethod
required
string
purchased
required
boolean
estimatedTimeOfArrival
required
string <date-time>
shippingOption
required
string (InboundShippingOption)
Enum: "SPD_EXTERNAL" "FREIGHT_EXTERNAL" "LTL_EXTERNAL" "LTL_INTERNAL" "FTL_INTERNAL" "SPD_INTERNAL"
401

Unauthorized

403

Forbidden

404

Shipment not found

get/logistics/api/2025-03/inbounds/shipments/{shipmentId}/quotes
Response samples
application/json
{
  • "error": {
    • "code": "string",
    • "subcode": "string"
    },
  • "quotes": [
    • {
      • "id": 0,
      • "shippingProvider": "string",
      • "rateShoppingMethod": "CHEAPEST",
      • "amount": 0,
      • "fullAmount": 0,
      • "currency": "string",
      • "providerMethod": "string",
      • "purchased": true,
      • "estimatedTimeOfArrival": "2019-08-24T14:15:22Z",
      • "shippingOption": "SPD_EXTERNAL"
      }
    ]
}

Begin asynchronous request quotes for a shipment

Asynchronous endpoint for starting a request for quotes on an inbounding shipment. Returns success if request was accepted.

SecurityBEARER
Request
path Parameters
shipmentId
required
integer <int32>
query Parameters
shippingOption
string (InboundShippingOption)
Enum: "SPD_EXTERNAL" "FREIGHT_EXTERNAL" "LTL_EXTERNAL" "LTL_INTERNAL" "FTL_INTERNAL" "SPD_INTERNAL"
Responses
202

Accepted

401

Unauthorized

403

Forbidden

404

Shipment not found

post/logistics/api/2025-03/inbounds/shipments/{shipmentId}/quotes
Response samples
application/json
{
  • "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"
    }
}

Begin asynchronous request to buy a quote for a shipment

Asynchronous endpoint for starting a request to buy quotes on an inbounding shipment. Returns success if request was accepted.

SecurityBEARER
Request
path Parameters
shipmentId
required
integer <int32>
Request Body schema: application/json
required
quoteIds
required
Array of integers <int32>
Responses
202

Accepted

401

Unauthorized

403

Forbidden

404

Shipment not found

post/logistics/api/2025-03/inbounds/shipments/{shipmentId}/quotes/buy
Request samples
application/json
{
  • "quoteIds": [
    • 0
    ]
}
Response samples
application/json
{
  • "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 all quotes that have been successfully bought for a shipment

Get result of asynchronous request to buy quotes. Returns quotes once asynchronous request is complete.

SecurityBEARER
Request
path Parameters
shipmentId
required
integer <int32>
query Parameters
shippingOption
string (InboundShippingOption)
Enum: "SPD_EXTERNAL" "FREIGHT_EXTERNAL" "LTL_EXTERNAL" "LTL_INTERNAL" "FTL_INTERNAL" "SPD_INTERNAL"
Responses
200

Ok

Response Schema: application/json
object (InboundExternalRateError)
code
string
subcode
string
required
Array of objects (RateQuoteWithPurchased)
Array
id
required
number <double>
shippingProvider
required
string
rateShoppingMethod
required
string (InboundRateShoppingMethod)
Enum: "CHEAPEST" "FASTEST" "ERROR" "RACE"
amount
required
number <double>
fullAmount
number <double>
currency
required
string
providerMethod
required
string
purchased
required
boolean
estimatedTimeOfArrival
required
string <date-time>
shippingOption
required
string (InboundShippingOption)
Enum: "SPD_EXTERNAL" "FREIGHT_EXTERNAL" "LTL_EXTERNAL" "LTL_INTERNAL" "FTL_INTERNAL" "SPD_INTERNAL"
401

Unauthorized

403

Forbidden

404

Shipment not found

get/logistics/api/2025-03/inbounds/shipments/{shipmentId}/quotes/buy
Response samples
application/json
{
  • "error": {
    • "code": "string",
    • "subcode": "string"
    },
  • "quotes": [
    • {
      • "id": 0,
      • "shippingProvider": "string",
      • "rateShoppingMethod": "CHEAPEST",
      • "amount": 0,
      • "fullAmount": 0,
      • "currency": "string",
      • "providerMethod": "string",
      • "purchased": true,
      • "estimatedTimeOfArrival": "2019-08-24T14:15:22Z",
      • "shippingOption": "SPD_EXTERNAL"
      }
    ]
}

Get a list of inbounds warehouses

Get inbounds-warehouses that can store products.

SecurityBEARER
Request
query Parameters
fetchFulfillmentCentres
boolean
fetchStorageWarehouses
boolean
Responses
200

Ok

Response Schema: application/json
Array of objects (InboundWarehouseDetailsLogisticsApi)
Array
address1
required
string
address2
string
city
required
string
company
string
countryCode
required
string (CountryCode)
Enum: "AF" "AX" "AL" "DZ" "AS" "AD" "AO" "AI" "AQ" "AG" "AR" "AM" "AW" "AU" "AT" "AZ" "BS" "BH" "BD" "BB" "BY" "BE" "BZ" "BJ" "BM" "BT" "BO" "BQ" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "CV" "KH" "CM" "CA" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CW" "CY" "CZ" "DK" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "SZ" "ET" "FK" "FO" "FJ" "FI" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KP" "KR" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "MK" "MP" "NO" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "BL" "SH" "KN" "LC" "MF" "PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO" "ZA" "GS" "SS" "ES" "LK" "SD" "SR" "SJ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "US" "UM" "UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW"
name
string
firstName
string
lastName
string
phone
string
provinceCode
required
string
zip
required
string
warehouseId
required
string
warehouseName
required
string
isPrep
boolean
Array of objects (InboundWarehouseDetailsLogisticsApi)
Array
address1
required
string
address2
string
city
required
string
company
string
countryCode
required
string (CountryCode)
Enum: "AF" "AX" "AL" "DZ" "AS" "AD" "AO" "AI" "AQ" "AG" "AR" "AM" "AW" "AU" "AT" "AZ" "BS" "BH" "BD" "BB" "BY" "BE" "BZ" "BJ" "BM" "BT" "BO" "BQ" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "CV" "KH" "CM" "CA" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CW" "CY" "CZ" "DK" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "SZ" "ET" "FK" "FO" "FJ" "FI" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KP" "KR" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "MK" "MP" "NO" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "BL" "SH" "KN" "LC" "MF" "PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO" "ZA" "GS" "SS" "ES" "LK" "SD" "SR" "SJ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "US" "UM" "UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW"
name
string
firstName
string
lastName
string
phone
string
provinceCode
required
string
zip
required
string
warehouseId
required
string
warehouseName
required
string
isPrep
boolean
401

Unauthorized

403

Forbidden

get/logistics/api/2025-03/inbounds/warehouses
Response samples
application/json
{
  • "fulfillmentCentres": [
    • {
      • "address1": "string",
      • "address2": "string",
      • "city": "string",
      • "company": "string",
      • "countryCode": "AF",
      • "name": "string",
      • "firstName": "string",
      • "lastName": "string",
      • "phone": "string",
      • "provinceCode": "string",
      • "zip": "string",
      • "warehouseId": "string",
      • "warehouseName": "string",
      • "isPrep": true
      }
    ],
  • "storageWarehouses": [
    • {
      • "address1": "string",
      • "address2": "string",
      • "city": "string",
      • "company": "string",
      • "countryCode": "AF",
      • "name": "string",
      • "firstName": "string",
      • "lastName": "string",
      • "phone": "string",
      • "provinceCode": "string",
      • "zip": "string",
      • "warehouseId": "string",
      • "warehouseName": "string",
      • "isPrep": true
      }
    ]
}
➔ Next to OAuth