Skip to content

Delete a promotion

DELETE
/stores/{storeRef}/promotions/{id}
curl --request DELETE \
--url https://apibase.ecomweb.app/api/v1/stores/example/promotions/1 \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--data '{}'

Deletes a promotion. It is marked as deleted rather than removed, so it stops appearing in reads and no longer applies, while orders that used it keep their record. The request takes no body.

Required scopes: write:promotions

id
required
integer

The promotion ID.

storeRef
required
string

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

Media typeapplication/json
object

Example generated

{}
Media typeapplication/json
object
type
required

Always soft: the promotion is marked as deleted and no longer returned.

string
Allowed values: soft
success
required

Always true.

boolean
message
required

A readable confirmation.

string
promotion_id
required

ID of the deleted promotion.

number
deleted_at
required

When the promotion was deleted, as an ISO 8601 timestamp.

string

Example

{
"type": "soft"
}

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"
}