Retrieve a list of shipping rates

Retrieve a list of shipping rates.

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

The collection items limit.

offset
integer >= 0

The collection items offset.

filter
string

The collection items filter requires a special format. Use "," for multiple allowed values. Use ";" for multiple fields. See the filter guide for more options and examples about this format.

sort
Array of strings

The collection items sort field and order (prefix with "-" for descending sort).

q
string

The partial search of the text fields.

Responses
200

A list of shipping rates was retrieved successfully.

Response Headers
Pagination-Total
integer

Total items count.

Example: 332
Pagination-Limit
integer

Items per page limit.

Example: 100
Pagination-Offset
integer

Pagination offset.

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

The shipping rate name.

price
required
number <double>

The shipping rate price - 0 is a valid value (for free).

currency
required
string = 3 characters

ISO 4217 alphabetic currency code.

id
string <= 50 characters

The shipping rate identifier string.

descriptions
string

The shipping rate description.

filter
string
Default: ""

A filter based on the invoice's properties which is used to determine when the rate is applicable. Empty filter will match any case.

status
string
Default: "active"

If inactive, the shipping rate will not be matched in any case.

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

The shipping rate created time.

updatedTime
string <date-time> (UpdatedTime)

Read-only timestamp updates when the resource is updated.

401

Unauthorized access, invalid credentials were 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
[
  • {
    }
]