Langsung ke konten utama
POST
/
v3
/
pages
/
{page_unique_id}
/
discount-codes
/
check
Check an HTML Mode discount code
curl --request POST \
  --url https://api.scalev.com/v3/pages/{page_unique_id}/discount-codes/check \
  --header 'Content-Type: application/json' \
  --header 'X-Scalev-Page-Api-Key: <x-scalev-page-api-key>' \
  --data '
{
  "code": "SAVE10",
  "gross_revenue": "<string>",
  "net_product_price": "<string>",
  "shipping_cost": "<string>",
  "payment_method": "bank_transfer",
  "domain": "<string>"
}
'
{
  "discount_code": {
    "id": 123,
    "business_id": 123,
    "is_enabled": true,
    "code": "<string>",
    "applied_to": "<string>",
    "amount_type": "<string>",
    "percentage": "<string>",
    "is_max_amount": true,
    "max_amount": "<string>",
    "amount": "<string>",
    "is_usage_limit": true,
    "usage_limit": 123,
    "current_usage": 123,
    "is_expiry": true,
    "expiry_time": "2023-11-07T05:31:56Z",
    "is_limited_to_pages": true,
    "pages": [
      {}
    ],
    "is_limited_to_payment_methods": true,
    "payment_methods": [
      "<string>"
    ],
    "is_minimum_revenue": true,
    "minimum_revenue": "<string>",
    "inserted_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "eligibility_details": {},
  "is_eligible": true,
  "discount_code_discount": "<string>"
}

Header

X-Scalev-Page-Api-Key
string
wajib

Publishable page public API key for the page_unique_id path page. Storefront public API keys are not accepted on page-scoped public routes.

Parameter Path

page_unique_id
string
wajib

Public page unique ID.

Contoh:

"page_540f48019f525f41"

Body

application/json

HTML Mode discount check payload used by Scalev.checkout.validateDiscount(payload).

code
string
wajib
Contoh:

"SAVE10"

gross_revenue
net_product_price
shipping_cost
payment_method
string
Contoh:

"bank_transfer"

domain
string | null

Browser hostname supplied by the runtime.

Respons

Discount code validation result

discount_code
object
wajib
eligibility_details
object
wajib
is_eligible
boolean
wajib
discount_code_discount
wajib