List a gift certificate's allocations

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/gift_certificates/gc_5b2e8f1a7c3d4e9b0a6f2c4d8e1b3a7f/allocations?limit=20" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

from exsited import build_client

client = build_client()

response = client.gift_certificates.get_gift_certificate_allocations(
    "gc_5b2e8f1a7c3d4e9b0a6f2c4d8e1b3a7f", {"limit": 20}
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.giftCertificates.getGiftCertificateAllocations('gc_5b2e8f1a7c3d4e9b0a6f2c4d8e1b3a7f', {
    limit: 20,
});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->giftCertificates->getGiftCertificateAllocations(
    'gc_5b2e8f1a7c3d4e9b0a6f2c4d8e1b3a7f',
    ['limit' => 20],
);
print_r($response->data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.gift_certificates.gift_certificates_dto.GiftCertificatesDto.GiftCertificateAllocations;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<GiftCertificateAllocations> response = client.giftCertificates().getGiftCertificateAllocations(
        "gc_5b2e8f1a7c3d4e9b0a6f2c4d8e1b3a7f",
        Map.of("limit", 20));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.GiftCertificates.GetGiftCertificateAllocationsAsync(
    "gc_5b2e8f1a7c3d4e9b0a6f2c4d8e1b3a7f",
    new Dictionary<string, object?> { ["limit"] = 20 });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.giftCertificates.getGiftCertificateAllocations(
  'gc_5b2e8f1a7c3d4e9b0a6f2c4d8e1b3a7f',
  queryParams: {'limit': 20},
);
print(response.map);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.GiftCertificates().GetGiftCertificateAllocations(context.Background(), "gc_5b2e8f1a7c3d4e9b0a6f2c4d8e1b3a7f", map[string]any{"limit": 20}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "data": [
    {
      "account": {
        "object": "<string>",
        "id": "<string>",
        "name": "<string>",
        "href": "<string>"
      },
      "created_by": "<unknown>",
      "created_on": "<string>",
      "date": "<string>",
      "href": "<string>",
      "id": "<string>",
      "last_updated_by": "<unknown>",
      "last_updated_on": "<string>",
      "object": "<string>",
      "status": "<string>",
      "type": "<string>",
      "version": 123
    }
  ],
  "object": "<string>",
  "pagination": {
    "limit": 123,
    "has_more": true,
    "next_cursor": "<string>",
    "prev_cursor": "<string>",
    "links": {
      "next": "<string>",
      "prev": "<string>"
    }
  },
  "url": "<string>"
}

GET

gift_certificates

{gc_id}

allocations

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/gift_certificates/gc_5b2e8f1a7c3d4e9b0a6f2c4d8e1b3a7f/allocations?limit=20" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

from exsited import build_client

client = build_client()

response = client.gift_certificates.get_gift_certificate_allocations(
    "gc_5b2e8f1a7c3d4e9b0a6f2c4d8e1b3a7f", {"limit": 20}
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.giftCertificates.getGiftCertificateAllocations('gc_5b2e8f1a7c3d4e9b0a6f2c4d8e1b3a7f', {
    limit: 20,
});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->giftCertificates->getGiftCertificateAllocations(
    'gc_5b2e8f1a7c3d4e9b0a6f2c4d8e1b3a7f',
    ['limit' => 20],
);
print_r($response->data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.gift_certificates.gift_certificates_dto.GiftCertificatesDto.GiftCertificateAllocations;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<GiftCertificateAllocations> response = client.giftCertificates().getGiftCertificateAllocations(
        "gc_5b2e8f1a7c3d4e9b0a6f2c4d8e1b3a7f",
        Map.of("limit", 20));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.GiftCertificates.GetGiftCertificateAllocationsAsync(
    "gc_5b2e8f1a7c3d4e9b0a6f2c4d8e1b3a7f",
    new Dictionary<string, object?> { ["limit"] = 20 });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.giftCertificates.getGiftCertificateAllocations(
  'gc_5b2e8f1a7c3d4e9b0a6f2c4d8e1b3a7f',
  queryParams: {'limit': 20},
);
print(response.map);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.GiftCertificates().GetGiftCertificateAllocations(context.Background(), "gc_5b2e8f1a7c3d4e9b0a6f2c4d8e1b3a7f", map[string]any{"limit": 20}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "data": [
    {
      "account": {
        "object": "<string>",
        "id": "<string>",
        "name": "<string>",
        "href": "<string>"
      },
      "created_by": "<unknown>",
      "created_on": "<string>",
      "date": "<string>",
      "href": "<string>",
      "id": "<string>",
      "last_updated_by": "<unknown>",
      "last_updated_on": "<string>",
      "object": "<string>",
      "status": "<string>",
      "type": "<string>",
      "version": 123
    }
  ],
  "object": "<string>",
  "pagination": {
    "limit": 123,
    "has_more": true,
    "next_cursor": "<string>",
    "prev_cursor": "<string>",
    "links": {
      "next": "<string>",
      "prev": "<string>"
    }
  },
  "url": "<string>"
}

The records are under data, each naming the account, the allocation type, its status and date. A certificate with no allocations returns an empty data.

The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set host to your Exsited API host name and paste an access token from Get an access token.

Authorizations

Authorization

string

header

required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Path Parameters

gc_id

string

required

The gift certificate's id.

Query Parameters

limit

integer

The most records to return on one page.

Example:

20

cursor

string

The next_cursor from the previous page, to fetch the page after it.

sort

string

The field to sort by. Prefix it with - to sort in descending order.

Example:

"-created_on"

Response

200 - application/json

One page of allocations, under data.

data

object[]

Show child attributes

object

string

pagination

object

Cursor paging for the listing.

Show child attributes

url

string

Guides

API reference

List a gift certificate's allocations

Authorizations

Path Parameters

Query Parameters

Response