Set the status of a basket offer

Changes the status of a single basket offer.

An offer whose current status is used cannot be changed; the request is rejected with a validation error.

patch

/basket_offers/{id}/set_status/

Authorizations

AuthorizationstringRequired

Token credential sent in the Authorization header, in the form: Token <your-token>. Requires a staff (admin) account.

Path parameters

idintegerRequired

The unique identifier of the basket offer.

Body

statusstring · enumRequired

The lifecycle status of a basket offer.

• active — eligible for application on the storefront
• passive — disabled (expired offers are moved here automatically)
• used — single-use offer that has been consumed; cannot be changed again
• revoked — withdrawn

Possible values:

Responses

200

The status was changed. The response body is an empty object.

application/json

objectOptional

400

The request contains invalid or missing data.

application/json

401

Authentication credentials were not provided or are invalid.

application/json

403

The authenticated user does not have administrator privileges.

application/json

404

The requested basket offer does not exist.

application/json

patch/basket_offers/{id}/set_status/

PATCH /api/remote/1/basket_offers/{id}/set_status/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "status": "active"
}

{}