Retrieve a shipping rate

Retrieve a shipping rate with specified identifier string.

SecuritySecretApiKey or JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

The resource identifier string.

Responses
200

Shipping rate was retrieved successfully.

Response Schema: application/json
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.

404

Resource was not found.

get/shipping-rates/{id}
Request samples
const shippingRate = await api.shippingRates.get({id: 'foobar-001'});
console.log(shippingRate.fields.name);
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "name": "string",
  • "descriptions": "string",
  • "price": 0,
  • "currency": "USD",
  • "filter": "deliveryAddress.country:US,CA,RU;amount:100..1000",
  • "status": "active",
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z"
}