logo

Bundles

The Bundles API allows you to create and retrieve bundles.

GetBundle

Get bundle information for a bundle.

SecurityBEARER
Request
path Parameters
bundleId
required
string (products_BundleIdType) = 11 characters ^B[0-9a-zA-Z]+$

The globally unique bundle identifier created by Flexport and assigned on bundle creation. May be referred to in other documentation as the Flexport SKU or BSKU.

Responses
200

OK

Response Schema: application/json
externalBundleId
required
string (products_ExternalBundleIdType) [ 1 .. 255 ] characters

A permanent unique reference for this bundle generated by and meaningful to the API user. This value will be used when sending orders to identify the bundle to ship. This value must be unique among all bundles created via API.

title
required
string [ 3 .. 255 ] characters

The bundle title or short description. Should represent a single line of text suitable to identify the bundle or for search purposes.

sku
required
string (products_SkuType) [ 1 .. 255 ] characters

The human-readable Stock Keeping Unit (SKU) for reporting. This value may change over time.

required
Array of objects (products_BundleContent202310) [ 1 .. 250 ] items
Array ([ 1 .. 250 ] items)
productId
required
string (products_ProductIdType) = 11 characters ^D[0-9a-zA-Z]+$

The globally unique product identifier created by Flexport and assigned on product creation. May be referred to in other documentation as the Flexport SKU or DSKU.

quantity
required
number <double>

Provide the quantity of that product that will be part of the bundle being created.

bundleId
required
string (products_BundleIdType) = 11 characters ^B[0-9a-zA-Z]+$

The globally unique bundle identifier created by Flexport and assigned on bundle creation. May be referred to in other documentation as the Flexport SKU or BSKU.

createdAt
required
string <date-time> (products_CreationDate)

The timestamp of creation in RFC 3339 format. e.g. 2017-07-21T17:32:28Z

401

Unauthorized

403

Forbidden

404

No bundle found with the bundleId provided

get/logistics/api/2023-10/bundles/{bundleId}
Request samples 
curl --request GET \
  --url 'https://logistics-api.flexport.com/logistics/api/2023-10/bundles/{bundleId}' \
  --header 'Authorization: Bearer <token>'
Response samples
application/json
{
  • "externalBundleId": "string",
  • "title": "string",
  • "sku": "string",
  • "bundleContents": [
    • {
      • "productId": "stringstrin",
      • "quantity": 0
      }
    ],
  • "bundleId": "stringstrin",
  • "createdAt": "2019-08-24T14:15:22Z"
}

GetBundleInventory

Get available inventory information for the bundle. Standard bundles are limited by the scarcest required component. Mystery boxes use the sum of available candidate units. Both calculations use only component inventory in the requested country.

SecurityBEARER
Request
path Parameters
bundleId
required
string (BundleIdType) = 11 characters ^B[0-9a-zA-Z]+$

The globally unique bundle identifier created by Flexport and assigned on bundle creation. May be referred to in other documentation as the Flexport SKU or BSKU.

query Parameters
countryCode
string (InventoryCountryCode)

ISO 3166-1 alpha-2 country code to scope inventory, such as US or CA. Defaults to US.

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" "false" "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"
Responses
200

OK

Response Schema: application/json
bundleId
required
string (BundleIdType) = 11 characters ^B[0-9a-zA-Z]+$

The globally unique bundle identifier created by Flexport and assigned on bundle creation. May be referred to in other documentation as the Flexport SKU or BSKU.

availableUnits
required
number <double>

The number of bundles available for sale in the requested country (US by default), based on component ATP after inventory-state, warehouse-availability, and reservation filtering. Standard bundles require every component; mystery boxes can use any candidate, so their availability is the sum of candidate units. Availability does not guarantee immediate shipment.

401

Unauthorized

403

Forbidden

404

No bundle found with the bundleId provided

get/logistics/api/2023-10/bundles/{bundleId}/inventory
Request samples 
curl --request GET \
  --url 'https://logistics-api.flexport.com/logistics/api/2023-10/bundles/{bundleId}/inventory' \
  --header 'Authorization: Bearer <token>'
Response samples
application/json
{
  • "bundleId": "stringstrin",
  • "availableUnits": 0
}

CreateBundle

Creates a new bundle.

SecurityBEARER
Request
Request Body schema: application/json
required
externalBundleId
required
string (products_ExternalBundleIdType) [ 1 .. 255 ] characters

A permanent unique reference for this bundle generated by and meaningful to the API user. This value will be used when sending orders to identify the bundle to ship. This value must be unique among all bundles created via API.

title
required
string [ 3 .. 255 ] characters

The bundle title or short description. Should represent a single line of text suitable to identify the bundle or for search purposes.

sku
required
string (products_SkuType) [ 1 .. 255 ] characters

The human-readable Stock Keeping Unit (SKU) for reporting. This value may change over time.

required
Array of objects (products_BundleContent202310) [ 1 .. 250 ] items
Array ([ 1 .. 250 ] items)
productId
required
string (products_ProductIdType) = 11 characters ^D[0-9a-zA-Z]+$

The globally unique product identifier created by Flexport and assigned on product creation. May be referred to in other documentation as the Flexport SKU or DSKU.

quantity
required
number <double>

Provide the quantity of that product that will be part of the bundle being created.

Responses
202

Bundle has been created

401

Unauthorized

403

Forbidden

404

No bundle found with the bundleId provided

422

Unprocessable Entity

post/logistics/api/2023-10/bundles
Request samples
application/json
{
  • "externalBundleId": "string",
  • "title": "string",
  • "sku": "string",
  • "bundleContents": [
    • {
      • "productId": "stringstrin",
      • "quantity": 0
      }
    ]
}
Response samples
application/json
{
  • "externalBundleId": "string",
  • "title": "string",
  • "sku": "string",
  • "bundleContents": [
    • {
      • "productId": "stringstrin",
      • "quantity": 0
      }
    ],
  • "bundleId": "stringstrin",
  • "createdAt": "2019-08-24T14:15:22Z"
}
➔ Next to Inbounds