POST /sale-discount-codes.json

application/json

Body Required

amount number(float) Required

Amount
code string Required

Code
saleId integer(int32) Required

Sale
type string Required

Type

Values are percentage, shipping, or fixed_amount. Default value is fixed_amount.

Responses

200 application/json

Successful response
Hide response attributes Show response attributes object
- amount number(float) Required
  
  Amount
- code string Required
  
  Code
- createdAt string(date-time)
  
  Created at
- id integer(int32)
  
  Id
- saleId integer(int32) Required
  
  Sale
- type string Required
  
  Type
  
  Values are percentage, shipping, or fixed_amount. Default value is fixed_amount.
- updatedAt string(date-time)
  
  Updated at

POST /sale-discount-codes.json

curl \
 --request POST 'http://api.example.com/v1/sale-discount-codes.json' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"amount":42.0,"code":"string","saleId":42,"type":"fixed_amount"}'

Request examples

{
  "amount": 42.0,
  "code": "string",
  "saleId": 42,
  "type": "fixed_amount"
}

Response examples (200)

{
  "amount": 42.0,
  "code": "string",
  "createdAt": "2025-05-04T09:42:00Z",
  "id": 42,
  "saleId": 42,
  "type": "fixed_amount",
  "updatedAt": "2025-05-04T09:42:00Z"
}