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 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 a shipment

Create an inbounding shipment.

SecurityBEARER
Request
Request Body schema: application/json
required
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.

Array of objects (ItemDataV2)

(optional if packages are provided) The items on the shipment. Specify items if creating a blind inbound.

Array
logisticsSku
required
string
quantity
required
integer <int32>
Array of objects (PackageInputUnstable)

(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
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>
required
object (PrepRequestData)
boxContentLabels
required
boolean
shippingPlanExternalId
string
shippingPlanName
string
Responses
201

Inbound Shipment created.

400

Bad Request

401

Unauthorized

403

Forbidden

post/logistics/api/2024-04/inbounds/shipments
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"
    },
  • "items": [
    • {
      • "logisticsSku": "string",
      • "quantity": 0
      }
    ],
  • "packages": [
    • {
      • "length": 12,
      • "width": 3,
      • "height": 5,
      • "weight": 3,
      • "dimensionUnit": "in",
      • "weightUnit": "oz",
      • "items": [
        ],
      • "numberOfIdenticalPkgs": 0
      }
    ],
  • "prep": {
    • "boxContentLabels": true
    },
  • "shippingPlanExternalId": "string",
  • "shippingPlanName": "string"
}
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": {
        }
      }
    ],
  • "packages": [
    • {
      • "length": 12,
      • "width": 3,
      • "height": 5,
      • "weight": 3,
      • "dimensionUnit": "in",
      • "weightUnit": "oz",
      • "id": "string",
      • "identicalPackageConfigIdentifer": "string",
      • "items": [
        ]
      }
    ],
  • "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",
  • "shippingPlanExternalId": "string",
  • "shippingPlanName": "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"
Responses
200

Ok

Response Schema: application/json
Array
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
shippingPlanExternalId
string
shippingPlanName
string
400

Bad Request

401

Unauthorized

403

Forbidden

404

Shipment not found

get/logistics/api/2024-04/inbounds/shipments
Response samples
application/json
[
  • {
    • "id": "string",
    • "receivingId": "string",
    • "status": "PENDING",
    • "addresses": {
      • "to": {
        },
      • "from": {
        }
      },
    • "items": [
      • {
        }
      ],
    • "packages": [
      • {
        }
      ],
    • "arrivedAt": "2019-08-24T14:15:22Z",
    • "completedAt": "2019-08-24T14:15:22Z",
    • "freight": {
      • "pickup": {
        },
      • "pallets": [
        ]
      },
    • "prep": {
      • "boxContentLabels": true
      },
    • "shippingPlanId": "string",
    • "shippingPlanExternalId": "string",
    • "shippingPlanName": "string"
    }
]

Get a shipment

Get an inbounding shipment.

SecurityBEARER
Request
path Parameters
shipmentId
required
integer <int32>
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)
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)
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
shippingPlanExternalId
string
shippingPlanName
string
401

Unauthorized

403

Forbidden

404

Shipment not found

get/logistics/api/2024-04/inbounds/shipments/{shipmentId}
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": {
        }
      }
    ],
  • "packages": [
    • {
      • "length": 12,
      • "width": 3,
      • "height": 5,
      • "weight": 3,
      • "dimensionUnit": "in",
      • "weightUnit": "oz",
      • "id": "string",
      • "identicalPackageConfigIdentifer": "string",
      • "items": [
        ]
      }
    ],
  • "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",
  • "shippingPlanExternalId": "string",
  • "shippingPlanName": "string"
}

Request document for a shipment

Request document for an inbounding shipment.

SecurityBEARER
Request
path Parameters
shipmentId
required
integer <int32>
query Parameters
documentOption
required
string
documentFormat
required
string
Responses
200

Ok

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

Unauthorized

403

Forbidden

404

Document not found

get/logistics/api/2024-04/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 (UpdatePackageInput)
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"
ids
required
Array of strings
shippingProvider
string
trackingNumber
string
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 (PackageInputUnstable)
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>
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)
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)
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/2024-04/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": [
    • {
      • "length": 12,
      • "width": 3,
      • "height": 5,
      • "weight": 3,
      • "dimensionUnit": "in",
      • "weightUnit": "oz",
      • "ids": [
        ],
      • "shippingProvider": "string",
      • "trackingNumber": "string"
      }
    ],
  • "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
      }
    ]
}
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": {
        }
      }
    ],
  • "packages": [
    • {
      • "length": 12,
      • "width": 3,
      • "height": 5,
      • "weight": 3,
      • "dimensionUnit": "in",
      • "weightUnit": "oz",
      • "id": "string",
      • "identicalPackageConfigIdentifer": "string",
      • "items": [
        ]
      }
    ],
  • "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>
rateShoppingMethod
required
string (InboundRateShoppingMethod)
Enum: "CHEAPEST" "FASTEST" "ERROR" "RACE"
amount
required
number <double>
fullAmount
number <double>
currency
required
string
shippingProvider
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/2024-04/inbounds/shipments/{shipmentId}/quotes
Response samples
application/json
{
  • "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"
      }
    ]
}

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/2024-04/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/2024-04/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>
rateShoppingMethod
required
string (InboundRateShoppingMethod)
Enum: "CHEAPEST" "FASTEST" "ERROR" "RACE"
amount
required
number <double>
fullAmount
number <double>
currency
required
string
shippingProvider
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/2024-04/inbounds/shipments/{shipmentId}/quotes/buy
Response samples
application/json
{
  • "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"
      }
    ]
}