logo

Retrieve a shipping rate

Retrieves a shipping rate with a specified ID.

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

ID of the resource.

Responses
200

Shipping rate retrieved.

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

404

Resource 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"
}
➔ Next to Create a shipping rate with ID