Developer docs
/
Rebilly API
/
Shipping rates
/
Retrieve a shipping rate

Retrieve a shipping rate

Retrieves a shipping rate with a specified ID.

SecurityAPI Key: SecretApiKey or HTTP: JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

ID of the resource.

get
/shipping-rates/{id}
Request samples
const shippingRate = await api.shippingRates.get({id: 'foobar-001'});
console.log(shippingRate.fields.name);
Responses

200

Shipping rate retrieved.

Response Schema: application/json
id
string <= 50 characters

ID of the shipping rate.

name
required
string

Name of the shipping rate.

description
string or null

Description of the shipping rate.

price
required
number <double>

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

currency
required
string (CurrencyCode) = 3 characters

Currency code in ISO 4217 format.

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.

Array of objects (SelfLink)

Related links.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

Response samples
application/json
{
"id": "ship_rate_0YVDN408G4DQE9G1RV1QCFHJ3P",
"name": "string",
"description": "string",
"price": 0.1,
"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",
"_links": [

]
}