Retrieve shipping rates

Retrieves a list of shipping rates.

SecuritySecretApiKey or JWT
Request
query Parameters
limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer >= 0

Specifies the starting point within the collection of items to be returned.

filter
string

Filters the collection items. This field requires a special format. Use , for multiple allowed values. Use ; for multiple fields.

For more information, see Using filter with collections.

sort
Array of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -.

q
string

Use this field to perform a partial search of text fields.

Responses
200

List of shipping rates retrieved.

Response Headers
Pagination-Total
integer

Total number of items.

Example: 332
Pagination-Limit
integer

Maximum number of items per page.

Example: 100
Pagination-Offset
integer

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example: 2
Response Schema: application/json
Array
name
required
string

Name of the shipping rate.

price
required
number <double>

Price of the shipping rate. If price is 0, shipping is free.

currency
required
string = 3 characters

Currency code in ISO 4217 format.

id
string <= 50 characters

ID of the shipping rate.

descriptions
string

Description of the shipping rate.

filter
string
Default: ""

Filter based on invoice properties that is used to determine when the rate is applicable. If no filters are used, the rate is always applicable.

status
string
Default: "active"

Status of the shipping rate. If status is inactive the shipping rate is not applied.

Enum: "active" "inactive"
createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

get/shipping-rates
Request samples
// all parameters are optional
const firstCollection = await api.shippingRates.getAll();

// alternatively you can specify one or more of them
const params = {limit: 20, offset: 100, sort: '-createdTime'};
const secondCollection = await api.shippingRates.getAll(params);

// access the collection items, each item is a ShippingRate
secondCollection.items.forEach(shippingRate => console.log(shippingRate.fields.name));
Response samples
application/json
[
  • {
    }
]