Retrieve a list of shipping rates

GET

/shipping-rates

const url = 'https://acme.mykreezalid.com/api/v1/shipping-rates?page=1&limit=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?page=1&limit=1' \
  --header 'Authorization: Basic <credentials>'

Returns your shipping rates in their display order. Pages hold a single rate unless you set limit.

Authorizations

basic

Parameters

Query Parameters

page

integer

default: 1

Page to return, starting at 1.

limit

integer

default: 1 <= 100

Number of rates per page, at most 100.

fields

string

Comma-separated list of the fields to return for each rate, e.g. id,title,price.

Responses

200

A page of shipping rates

application/json

object

shipping_rates

Array<object>

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

pagination

Paging information, added next to the results of a paginated list. Request another page with the page query parameter and change the page size with limit (at most 100).

object

totalResultsCount

Number of results across all pages.

integer

currentPage

Number of the page returned, starting at 1.

integer

nextPage

Whether a next page exists.

boolean

prevPage

Whether a previous page exists.

boolean

resultOnPageCount

Number of results on this page.

integer

pageCount

Number of pages.

integer

Example

{
  "shipping_rates": [
    {
      "id": 432424,
      "object": "ShippingRate",
      "title": "Standard",
      "price": 6.95,
      "step_price": 1.45,
      "restricted_countries": [
        "FR",
        "BE"
      ],
      "sort_priority": 0,
      "external_id": "ABC123"
    }
  ],
  "pagination": {
    "totalResultsCount": 137,
    "currentPage": 1,
    "resultOnPageCount": 25,
    "pageCount": 6
  }
}