Create a gift card sale invoice after using a gift card template
You must specify appropriate details for the request body parameters, and this API generates an invoice by booking the gift cards and returns a unique invoice ID as the response.
Before you begin
- You need a valid API key or access token. See Set up API authentication.
Permission: Manage API Keys (on the Administrator security object) — Required to access Zenoti APIs.
Endpoint
POST /v1/invoices/giftcards
Base URL: https://api.zenoti.com
Request
Headers
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | bearer {{access_token}} |
Request body
| Field | Type | Required | Description |
|---|---|---|---|
| RAW_BODY | object | No |
Response
Success (201 Created)
{
"invoice_id": "1471fa74-eeb7-4209-a856-d8a20ab48bca"
}
Response fields
| Field | Type | Description |
|---|---|---|
| invoice_id | string |
Example
curl --request POST \
--url 'https://api.zenoti.com/v1/invoices/giftcards' \
--header 'Authorization: bearer {{access_token}}' \
--header 'Content-Type: application/json' \
--data '{
"RAW_BODY": {}
}'
const response = await fetch('https://api.zenoti.com/v1/invoices/giftcards', {
method: 'POST',
headers: {
'Authorization': 'bearer {{access_token}}',
'Content-Type': 'application/json'
},
body: JSON.stringify({
RAW_BODY: {}
})
});
const data = await response.json();
import requests
response = requests.post(
'https://api.zenoti.com/v1/invoices/giftcards',
headers={
'Authorization': 'bearer {{access_token}}',
},
json={'RAW_BODY': {}}
)
data = response.json()
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "bearer {{access_token}}");
var content = new StringContent(
JsonSerializer.Serialize(new {
RAW_BODY = new { }
}),
Encoding.UTF8, "application/json");
var response = await client.PostAsync(
"https://api.zenoti.com/v1/invoices/giftcards", content);
var data = await response.Content.ReadAsStringAsync();
require 'net/http'
require 'json'
uri = URI('https://api.zenoti.com/v1/invoices/giftcards')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri)
request['Authorization'] = 'bearer {{access_token}}'
request['Content-Type'] = 'application/json'
request.body = { RAW_BODY: {} }.to_json
response = http.request(request)
data = JSON.parse(response.body)
Error codes
| Status | Description |
|---|---|
| 400 | 400 |
| 401 | Unauthorized -- invalid or expired access token |
| 429 | Too many requests -- rate limit exceeded |