Update a shipping rate

Updates an existing shipping rate. Country cannot be changed after creation.

put/shipping-rates/{id}

Request

Base URL
https://api.ecommerceapi.uk/v1
URL
https://api.ecommerceapi.uk/v1/shipping-rates/{id}
Auth
HTTP basic

Path parameters

idinteger required

The unique identifier of the shipping rate.

Request body

statesstring[]

List of state IDs (for US).

postcodesstring[]

List of postcodes (for UK).

namestring

The name of the shipping rate.

criteria'price' | 'weight'

fromnumber

The starting value for the criteria.

tonumber

The end value for the criteria (0 for unlimited).

costnumber

The cost of the shipping rate.

vatExclusiveboolean

Whether the shipping rate is VAT exempt / zero rated.

enabledboolean

Whether the shipping rate is enabled.

Response

Shipping rate updated successfully.

idinteger

Unique identifier for the shipping rate.

namestring

The name of the shipping rate.

criteriastring

The criteria for the shipping rate (price or weight).