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

Create a shipping rate

Creates a shipping rate.

SecurityAPI Key: SecretApiKey or HTTP: JWT
Request
Request Body schema: application/json
required

Shipping rate resource.

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"
post
/shipping-rates
Request samples
application/json
{
"name": "string",
"description": "string",
"price": 0.1,
"currency": "USD",
"filter": "deliveryAddress.country:US,CA,RU;amount:100..1000",
"status": "active"
}
Responses

201

Shipping rate created.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

422

Invalid data sent.

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": [

]
}