Retrieve a shipping rate

GET

/shipping-rates/{id}

const url = 'https://acme.mykreezalid.com/api/v1/shipping-rates/1';
const options = {method: 'GET', headers: {Authorization: 'Basic <credentials>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://acme.mykreezalid.com/api/v1/shipping-rates/1 \
  --header 'Authorization: Basic <credentials>'

Retrieves a shipping rate from its unique identifier.

Authorizations

basic

Parameters

Path Parameters

required

integer

ID of your shipping rate.

Responses

200

The shipping rate

application/json

object

shipping_rate

A shipping rate customers can choose at checkout.

object

Shipping rate’s unique identifier

integer

object

string

title

Name shown to customers

string

nullable

description

Short description

string

nullable

details_in_cart

Details shown in the cart

string

nullable

price

Price of the shipping

number

nullable

step_price

Price added for each additional item

number

nullable

always_selected

Whether the rate is selected by default

boolean

nullable

is_online

Whether the rate is offered

boolean

nullable

pickup_delivery

Whether the customer collects the order in person, so that no shipping address is needed

boolean

nullable

shipping_fees_paid_out_to_supplier

Whether the shipping fees are paid out to the vendor (otherwise they go to the marketplace)

boolean

nullable

apply_to_all_countries

Whether the rate applies to every country

boolean

nullable

restricted_countries

Countries the rate is restricted to, when it does not apply to every country

Array<string>

nullable

carrier_alias

Identifier of the carrier

string

nullable

tracking_number_pattern

Expected format of the tracking numbers

string

nullable

tracking_url

Tracking URL of the carrier

string

nullable

sort_priority

Position of the rate in lists, lowest first

integer

nullable

external_id

Your own identifier for this rate

string

nullable

Example

{
  "shipping_rate": {
    "id": 432424,
    "object": "ShippingRate",
    "title": "Standard",
    "price": 6.95,
    "step_price": 1.45,
    "restricted_countries": [
      "FR",
      "BE"
    ],
    "sort_priority": 0,
    "external_id": "ABC123"
  }
}

404

No shipping rate has this identifier.