Vouchers

Import vouchers from the site's voucher processor

Kicks off an asynchronous import that pulls the latest catalogue of vouchers from the site's configured voucher processor (e.g. GiftPro) and reconciles them with Trybe's local Voucher records. Vouchers present in the source system but missing in Trybe are created; existing records are updated to reflect any changes to name, price, currency, or redemption rules.

The endpoint returns a QueuedJob immediately — poll the queued job's status to track completion. The import does not block the request, so newly synced vouchers may not appear in listVouchers for a few seconds after the job completes.

Requires the SETTINGS_MANAGE permission on the target site.

get/shop/vouchers/import

Query parameters

site_idstring required

Filter results by the site they belong to

Response

The job was successfully queued

Example response

{
  "data": {
    "created_at": "2023-11-07T00:00:00+00:00",
    "updated_at": "2023-11-07T01:00:00+00:00"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.