Skip to content
BolderBolder Developers
Esc
↑↓navigate↵open⌘Jpreview

Get a shipping option

GET/shipping_options/{id}
Authorization
AuthorizationBearer token (JWT) · headerrequired
Path parameters
idintegerrequired
Responses
200

Shipping option

namestring

Name shown to buyers at checkout. Required on create.

rate_modestring

Required on create.

Allowed:flatby-weightby-stretchby-distanceby-weight-step
activeboolean
default: true
courierstring | null
exclusiveboolean

When true, buyers in this option's regions/localities don't see broader options. Only for region or locality zones, and not overlapping another exclusive option of the table.

price_list_idinteger | null

Only for orders with this price list. -1 any price list, -2 orders without a price list, null all orders.

base_rateinteger
rate_per_kminteger | null
rate_per_weight_stepinteger | null
weight_step_in_grinteger | null
over_weight_amount_per_kginteger

Amount per extra kg over max_allowed_weight_in_gr (or the last rate). -1 means heavier orders can't use this option.

default: -1
max_allowed_weight_in_grinteger | null
min_days_to_deliveryinteger | null

Business days. Must be lower than max_days_to_delivery.

max_days_to_deliveryinteger | null
cutoff_timestring | null
availability_schedule_idinteger | null

Must belong to the seller.

delivery_window_schedule_idinteger | null

Must belong to the seller.

polygon_set_idinteger | null

Polygon set limiting the zone. Must belong to the seller.

polygons_exclude_modeboolean

Exclude (instead of include) the polygon set area.

shipping_zonesShippingZone[]

Zones covered, all at the same level: country (only country_code), region (country_code + region_code, one country) or locality (all three, one country and region). Required on create; on update it replaces the zones.

Show properties
Array of ShippingZone
idinteger
country_codestringrequired

ISO 3166 alpha-2 country code (upcased on input)

region_codestring | null

Region code within the country. Set it on every zone for a region-level option.

locality_idinteger | null

Locality (comuna) ID. Set it on every zone for a locality-level option.

shipping_ratesShippingRate[]

Only for by-weight and by-stretch (required for them on create, or when switching to them). On update it replaces all rates.

Show properties
Array of ShippingRate
idinteger
tonumberrequired

Upper bound of the range, in grams (by-weight) or km (by-stretch). Ranges start at 0 or at the previous to.

amountintegerrequired

Amount charged for the range, in the seller's currency.

_linksHalLinks
idinteger
shipping_table_idinteger
created_atstring<date-time>
updated_atstring<date-time>
_embeddedobject
Show properties
shipping_zonesShippingZone[]
Show properties
Array of ShippingZone
idinteger
country_codestringrequired

ISO 3166 alpha-2 country code (upcased on input)

region_codestring | null

Region code within the country. Set it on every zone for a region-level option.

locality_idinteger | null

Locality (comuna) ID. Set it on every zone for a locality-level option.

shipping_ratesShippingRate[]
Show properties
Array of ShippingRate
idinteger
tonumberrequired

Upper bound of the range, in grams (by-weight) or km (by-stretch). Ranges start at 0 or at the previous to.

amountintegerrequired

Amount charged for the range, in the seller's currency.

404

Shipping option not found

Try it
Server
Authorization
Parameters
Request
curl -X GET 'https://api.onbolder.com/v2/shipping_options/0' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "name": "string",
  "rate_mode": "flat",
  "active": true,
  "courier": "string",
  "exclusive": true,
  "price_list_id": 0,
  "base_rate": 0,
  "rate_per_km": 0,
  "rate_per_weight_step": 0,
  "weight_step_in_gr": 0,
  "over_weight_amount_per_kg": -1,
  "max_allowed_weight_in_gr": 0,
  "min_days_to_delivery": 0,
  "max_days_to_delivery": 0,
  "cutoff_time": "14:00",
  "availability_schedule_id": 0,
  "delivery_window_schedule_id": 0,
  "polygon_set_id": 0,
  "polygons_exclude_mode": true,
  "shipping_zones": [
    {
      "id": 0,
      "country_code": "CL",
      "region_code": "RM",
      "locality_id": 13101
    }
  ],
  "shipping_rates": [
    {
      "id": 0,
      "to": 1000,
      "amount": 2500
    }
  ],
  "_links": {
    "property1": {
      "href": "string",
      "templated": true,
      "method": "get",
      "title": "string",
      "type": "string"
    },
    "property2": {
      "href": "string",
      "templated": true,
      "method": "get",
      "title": "string",
      "type": "string"
    }
  },
  "id": 0,
  "shipping_table_id": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "_embedded": {
    "shipping_zones": [
      {
        "id": 0,
        "country_code": "CL",
        "region_code": "RM",
        "locality_id": 13101
      }
    ],
    "shipping_rates": [
      {
        "id": 0,
        "to": 1000,
        "amount": 2500
      }
    ]
  }
}

Was this page helpful?