PUT
/
offer
/
promotions
/
{id}
curl --request PUT \
  --url https://services.commercengine.dev/api/v1/x2yh61zw4k/admin/offer/promotions/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "promotion_type": "discount",
  "details": {
    "discount_type": "percentage",
    "discount_percent": 0,
    "fixed_discount_amount": 0,
    "max_discount_amount": 123,
    "products": [
      {
        "product_id": "<string>",
        "minimum_price": 0,
        "minimum_value": 0,
        "minimum_quantity": 0
      }
    ],
    "category_id": [
      "<string>"
    ]
  },
  "tags": [
    "<string>"
  ],
  "status": "draft",
  "customer_eligibility": "all",
  "customer_id": [
    "<string>"
  ],
  "segment_id": [
    "<string>"
  ],
  "applies_to_product": "all",
  "has_redemption_limit": false,
  "redemption_limit": 0,
  "require_minimum_order_total": false,
  "minimum_order_total": 0,
  "for_first_time_customer_only": false,
  "can_be_used_with_promotion": false,
  "starts_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z"
}'
{
  "message": "<string>",
  "success": true,
  "content": {
    "promotion": {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "promotion_type": "discount",
      "details": {
        "discount_type": "percentage",
        "discount_percent": 0,
        "fixed_discount_amount": 0,
        "max_discount_amount": 123,
        "products": [
          {
            "product_id": "<string>",
            "minimum_price": 0,
            "minimum_value": 0,
            "minimum_quantity": 0
          }
        ],
        "category_id": [
          "<string>"
        ]
      },
      "tags": [
        "<string>"
      ],
      "active": true,
      "status": "draft",
      "customer_eligibility": "all",
      "customer_id": [
        "<string>"
      ],
      "segment_id": [
        "<string>"
      ],
      "applies_to_product": "all",
      "has_redemption_limit": false,
      "redemption_limit": 0,
      "redemption_count": 123,
      "require_minimum_order_total": false,
      "minimum_order_total": 0,
      "for_first_time_customer_only": false,
      "can_be_used_with_promotion": false,
      "starts_at": "2023-11-07T05:31:56Z",
      "expires_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "terms_and_conditions": [
        "<string>"
      ]
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

promotion id

Body

application/json
​
name
string
required
​
promotion_type
enum<string>
required
Available options:
discount,
free-goods,
fixed-price,
free-shipping,
buy-x-get-y,
volume-based
​
details
object
required
​
status
enum<string>
required

this key is ignored in create promotion api and draft status will be added by default. required in update promotion api only.

Available options:
draft,
live,
stopped,
expired
​
customer_eligibility
enum<string>
required
Available options:
all,
customer,
segment
​
starts_at
string
required
​
description
string
​
tags
string[] | null
​
customer_id
string[]

required if customer_eligibility = customer

​
segment_id
string[]

required if customer_eligibility = segment

​
applies_to_product
enum<string>
Available options:
all,
product,
category
​
has_redemption_limit
boolean
default:
false
​
redemption_limit
integer
default:
0
​
require_minimum_order_total
boolean
default:
false
​
minimum_order_total
integer
default:
0
​
for_first_time_customer_only
boolean
default:
false
​
can_be_used_with_promotion
boolean
default:
false
​
expires_at
string | null

Response

200 - application/json
OK
​
message
string
​
success
boolean
​
content
object