Skip to content

Delete a shipping rate

DELETE
/stores/{storeRef}/shipping-zones/{zoneId}/rates/{id}
curl --request DELETE \
--url https://apibase.ecomweb.app/api/v1/stores/example/shipping-zones/1/rates/1 \
--header 'x-api-key: <x-api-key>'

Soft-deletes the rate so it is no longer offered. The response body is empty. The zone in the path is not checked against the rate, which is looked up by its own ID.

Required scopes: write:shippings

id
required
integer

The shipping rate ID.

zoneId
required
integer

The ID of the shipping zone the rate belongs to.

storeRef
required
string

The store’s ref, as returned by GET /stores.

The rate was deleted. The body is empty.

Media typeapplication/json

The response body is empty.

string
0

Example generated

example

The request is malformed or failed validation.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The key is missing, invalid, revoked or expired.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The key may not do this: a missing scope, a readonly key, a publishable key on a Store API route, or a disallowed origin.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The resource does not exist in this store.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}