Apply Promo Code

Description

Applies a promo code to calculate discounted price.

Endpoint

• URL: /v1/promotions/apply/promo-code
• Method: POST

Required Headers

{
  "Authorization": "Bearer JWT_TOKEN",
  "X-MerchantApiKey": "MERCHANT_API_KEY",
  "Content-Type": "application/json"
}

📥 Request Body

Field Name	Type	Required	Description	Example
promoCode	string	No	The promo code to be applied
amount	double	No	The original amount before discount	0.0

Example API Call (Using Fetch)

fetch("https://api.shopsynch.com/v1/promotions/apply/promo-code", {
  method: "POST",
  headers: {
    "Authorization": "Bearer JWT_TOKEN",
    "X-MerchantApiKey": "MERCHANT_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "promoCode": "",
    "amount": 0.0
  })
})

Response-fields:

Field	Type	Description	Since	Example
status	boolean	No comments found.	-	true
message	string	No comments found.	-
data	double	No comments found.	-

Response-example:

{
    "status": true,
    "message": "Discount applied successfully",
    "data": {
        "discountAmount": 200.00,
        "promotion": {
            "id": "69b411c7a0216c6ea88794f7",
            "name": "TEY",
            "code": "ACT2026",
            "description": "test",
            "startDate": "2026-03-13T15:35:00",
            "endDate": "2026-04-20T01:00:00",
            "discount": 10,
            "discountValue": 10,
            "discountType": "PERCENTAGE",
            "maximumDiscountCap": null,
            "minimumOrderValue": null,
            "requiredQuantity": null,
            "freeQuantity": null,
            "usageLimit": null,
            "usageCount": 0,
            "perCustomerUsageLimit": null
        }
    }
}

Next Steps

• Learn more about Adding a Promo Code
• Learn more about Updating a Promo Code
• Learn more about Deleting a Promo Code