Shipping rates

Use these operations to manage shipping rates. A shipping rate contains a filter and a pricing for a specific shipping destination.

Operations

Retrieve shipping rates

Request

Retrieves a list of shipping rates.

Security
SecretApiKey or JWT
Query
limitinteger, [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offsetinteger, [ 0 .. 1000 ]

Specifies the starting point within the collection of items to be returned.

filterstring

Criteria for filtering collection items. This field requires a special format. Use , to specify multiple allowed values. Use ; to specify multiple fields.

For more information, see Search filters.

sortArray of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -. Multiple fields can be sorted by separating each with ,.

qstring

Use this field to perform a partial search of text fields.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/shipping-rates?limit=1000&offset=1000&filter=string&sort=string&q=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

List of shipping rates retrieved.

Headers
Pagination-Totalinteger

Total number of items.

Example:332
Pagination-Limitinteger

Maximum number of items per page.

Example:100
Pagination-Offsetinteger

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example:2
Bodyapplication/json
Array [
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": [ … ]
  }
]