/
Retrieve a shipping rate

Retrieve a shipping rate

Request

Retrieves a shipping rate with a specified ID.

Security
SecretApiKey or JWT
Path
idstring, <= 50 characters^[@~\-\.\w]+$required

ID of the resource.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/shipping-rates/{id}' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

Shipping rate retrieved.

Bodyapplication/json
idstring, <= 50 charactersread-only

ID of the shipping rate.

Example:"ship_rate_0YVDN408G4DQE9G1RV1QCFHJ3P"
namestringrequired

Name of the shipping rate.

descriptionstring or null

Description of the shipping rate.

pricenumber, (double)required

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

currencystring, = 3 characters(CurrencyCode)required

Currency code in ISO 4217 format.

Example:"USD"
filterstring

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.

Default:""
Example:"deliveryAddress.country:US,CA,RU;amount:100..1000"
statusstring

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

Default:"active"
Enum:"active""inactive"
createdTimestring, (date-time)(CreatedTime)read-only

Date and time when the resource is created. This value is set automatically when the resource is created.

updatedTimestring, (date-time)(UpdatedTime)read-only

Date and time when the resource is updated. This value is set automatically when the resource is updated.

Response
{
  "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": [
    { … }
  ]
}