v2

latestOpenAPI 3.1.02026-07-26102336742.6 KB
Promotions

Update a promotion

Rate limit: 100 requests / 10 seconds per shop. See Rate limiting.

Updates an existing promotion's configuration. Only provided fields are updated; omitted fields remain unchanged. Status changes (activate/deactivate) are part of the same update call.

put/open-api/v1.0/promotions/{promotionId}

Path parameters

promotionIdstring required

Request body

status'LIVE' | 'ENDED'

Example request

{
  "requirements": {
    "minimumOrderValue": {
      "value": 10,
      "currency": "USD"
    }
  }
}

Response

OK

OR
OR
OR
OR

Example response

{
  "discount": {
    "money": {
      "value": 10,
      "currency": "USD"
    }
  },
  "requirements": {
    "minimumOrderValue": {
      "value": 10,
      "currency": "USD"
    }
  }
}