Voucher

Create voucher

Create voucher

post/shops/{SHOP_ID}/vouchers

Request

  • Base URL
    https://pos.pages.fm/api/v1
  • Auth
    API key in query parameter api_key

Path parameters

SHOP_IDinteger required
Example:4

Shop ID

Request body

namestring required

Voucher name

is_free_shippingboolean

Is free shipping

is_activatedboolean

Is activated

customer_tagsstring[]

Customer tags

start_timestring date-time required

Voucher start time

end_timestring date-time required

Voucher end time

Example request

{
  "name": "test_voucher_5",
  "promo_code_info": {
    "discount": 53635,
    "is_percent": false
  },
  "is_free_shipping": false,
  "is_activated": true,
  "customer_tags": [
    "New tag"
  ],
  "start_time": "2021-12-09T04:27:23",
  "end_time": "2021-12-10T04:27:26"
}

Response

Success

successboolean

Success status

Changes

No recorded changes to this operation across all 20 revisions of this API.