/

Single endpoint to get shipping speed options

Partner API (v1)

Download OpenAPI description

Servers

Sandbox server

https://sandbox.bikeflights.com/

Authentication

Operations

Data

Operations

Labels

Operations

Order

Operations

PackageLocation

Operations

ShopRate

Operations

Single endpoint to get shipping speed options

Request

Get shipping rates between two locations for up to twenty five packages

Body

The Core.DTO.GetShopRatesRequest rate request with all shipment properties.

shopNamestringnon-emptyrequired

stageobject(StageRequest)required

stage.dateTypestring or null

stage.actionDatestring(date)

stage.purposeOptionobject(DataList)

stage.purposeCodestring or null

stage.stageinteger(int32)

stage.fromobject(AddressRequest)required

stage.from.companystring or null

Example: "BIKEFLIGHTS LLC"

stage.from.firstNamestring or null

Example: "Travis"

stage.from.lastNamestring or null

Example: "Hawkins"

stage.from.phoneNumberstring or null

Example: "16505555555"

stage.from.address1stringnon-emptyrequired

Example: "8000 N Fowler Ave"

stage.from.address2string or null

Example: "Unit 5"

stage.from.address3string or null

Example: "ATTN Jeff"

stage.from.citystringnon-emptyrequired

Example: "Portland"

stage.from.statestring or null

Example: "OR"

stage.from.postalCodestringnon-emptyrequired

Example: "97217"

stage.from.countryCodestringnon-emptyrequired

Example: "US"

stage.from.isResidentialboolean

Example: false

stage.from.passedAvsboolean

Example: true

stage.toobject(AddressRequest)required

stage.to.companystring or null

Example: "BIKEFLIGHTS LLC"

stage.to.firstNamestring or null

Example: "Travis"

stage.to.lastNamestring or null

Example: "Hawkins"

stage.to.phoneNumberstring or null

Example: "16505555555"

stage.to.address1stringnon-emptyrequired

Example: "8000 N Fowler Ave"

stage.to.address2string or null

Example: "Unit 5"

stage.to.address3string or null

Example: "ATTN Jeff"

stage.to.citystringnon-emptyrequired

Example: "Portland"

stage.to.statestring or null

Example: "OR"

stage.to.postalCodestringnon-emptyrequired

Example: "97217"

stage.to.countryCodestringnon-emptyrequired

Example: "US"

stage.to.isResidentialboolean

Example: false

stage.to.passedAvsboolean

Example: true

stage.isPickupboolean

purposeCodestringnon-emptyrequired

packagesArray of objects(PackageRequest)required

packages[].namestring or null

packages[].lengthnumber(double)

packages[].heightnumber(double)

packages[].widthnumber(double)

packages[].linearUnitstring or null

packages[].weightnumber(double)

packages[].weightUnitstring or null

packages[].valuenumber(double)

packages[].coveragenumber(double)

packages[].protectionFeenumber or null(double)

packages[].contentOptionobject(DataList)

packages[].contentCodestring or null

packages[].insideDescriptionstring or null

packages[].outsideDescriptionstring or null

providersArray of objects or null(GetShopRatesProviderFilterItem)

curl -i -X POST \
  https://sandbox.bikeflights.com/api/ShopRate \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "shopName": "TestShop",
    "stage": {
      "dateType": "S",
      "actionDate": "2025-04-24",
      "stage": 0,
      "from": {
        "firstName": "Travis",
        "lastName": "Hawkins",
        "phoneNumber": "+15555555555",
        "address1": "701 Maple St",
        "city": "San Mateo",
        "state": "CA",
        "postalCode": "94401",
        "countryCode": "US",
        "isResidential": true,
        "passedAvs": true
      },
      "to": {
        "company": "Bikeflights",
        "firstName": "William",
        "lastName": "Alcorn",
        "phoneNumber": "+18885555555",
        "address1": "3505 Calle Cuervo",
        "address2": "#315",
        "city": "Albuquerque",
        "state": "NM",
        "postalCode": "87124",
        "countryCode": "US",
        "isResidential": true,
        "passedAvs": true
      },
      "isPickup": true
    },
    "purposeCode": "4001",
    "packages": [
      {
        "name": "Custom",
        "length": 45,
        "height": 30,
        "width": 12,
        "linearUnit": "IN",
        "weight": 65,
        "weightUnit": "LB",
        "value": 1000,
        "coverage": 1000,
        "protectionFee": 0,
        "contentCode": "8000",
        "insideDescription": "Theres a bike in the box",
        "outsideDescription": "Cardboard box with bikeflights logo"
      }
    ]
  }'

Responses

Rates Response

Bodyapplication/json

object(ApiExamples_GetShopRatesResponse)

Response

application/json

{
  "rates": [
    { … },
    { … },
    { … }
  ],
  "requestId": "ZdZ1bL97kQQg4mhXXrPX"
}