Freelance Workspace

Getting Started

Introduction

Creating an Account

Activate your Account

API Reference Guide

Basics of APIs

Base URL

Authentication

Rest API Reference

Company

Locations

Orders

Items

Gift Cards

Blank

Giftees

The Giftees API empowers developers and merchants to seamlessly integrate digital gift card solutions into their platforms. With robust features for creating, managing, and redeeming gift cards, Giftees makes it easy to offer personalized and location-based gifting experiences.

Giftees API Documentation

Production

Sandbox

<p class="slate-p " >Welcome to the <strong class="slate-bold">Giftees API</strong>! This API enables merchants, partners, and developers to seamlessly integrate Giftees&apos; digital gifting platform into their applications, websites, and systems. With Giftees API, you can create, manage, and track digital gift cards, allowing you to provide a smooth and delightful gifting experience for your customers.</p><p class="slate-p " >Whether you&apos;re building a simple e-commerce integration or a full-scale gifting solution, the Giftees API provides the flexibility and tools you need. This documentation will guide you through the core concepts, endpoints, and best practices for using our API.</p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

! This API enables merchants, partners, and developers to seamlessly integrate Giftees' digital gifting platform into their applications, websites, and systems. With Giftees API, you can create, manage, and track digital gift cards, allowing you to provide a smooth and delightful gifting experience for your customers.

Whether you're building a simple e-commerce integration or a full-scale gifting solution, the Giftees API provides the flexibility and tools you need. This documentation will guide you through the core concepts, endpoints, and best practices for using our API.

<p class="slate-p " ><p class="slate-p " >To explore Giftees&apos; services, you must create a <span style="color:rgba(255, 255, 255, 0.84)"><strong class="slate-bold">Giftees</strong></span> account through our Dashboard. During the account creation process, Giftees will generate both a <span style="color:rgba(255, 255, 255, 0.84)"><strong class="slate-bold">user account</strong></span> and a <span style="color:rgba(255, 255, 255, 0.84)"><strong class="slate-bold">company account</strong></span> for you.</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">The <strong class="slate-bold">user account</strong> is used to log in to the Dashboard and manage your settings.</div></li><li class="slate-li " ><div style="position:relative">The <strong class="slate-bold">company account</strong> represents your business and is required for managing gift card offerings and processing transactions.</div></li></ul><p class="slate-p slate-indent-0" style="0px">Once you&apos;ve created your account, you’ll have full access to explore the Giftees platform in <strong class="slate-bold">test mode</strong>. This allows you to simulate key features, such as creating and redeeming gift cards, without involving real transactions.</p><p class="slate-p " >When you&apos;re confident with your setup and ready to offer real digital gift cards, you can proceed with <strong class="slate-bold">account activation</strong> to go live and start processing real transactions.</p><p class="slate-p " >Getting started with Giftees is quick and simple—your business will be ready to provide delightful gifting experiences in no time!</p></p><p class="slate-p " ></p>

<p class="slate-p " >To process real transactions for digital gift cards, you must activate your <strong class="slate-bold">Giftees</strong> account.</p><p class="slate-p " ></p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=info ><div class="callout-icon"><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><h4 class="slate-h4 " >Integrate before Activating your Account</h4><p class="slate-p " >You don’t need to activate your account immediately during the integration process. If you haven’t created your Giftees account yet, refer to the <a href="6783be06d45e47dc084d276e/6785582d39e1c2df205e3d3b" target="">Creating an Account</a> guide.</p></div></div><p class="slate-p " ></p><h3 class="slate-h3 " >Account Activation</h3><p class="slate-p slate-indent-0" style="0px">Activate your Giftees account by completing the <a href="https://app.giftees.io/activate" target=""><strong class="slate-bold">activation application</strong></a>. We’ll request some basic information about your business, your products or services, and your personal relationship with the business. Once you submit your application, our team will review the details. Upon approval, you can immediately start processing real digital gift card transactions and go live.</p><p class="slate-p " >Giftees complies with &quot;Know Your Customer&quot; (KYC) obligations, which require us to collect and verify this information. These regulations, established by our partners and regulatory authorities, help protect our platform from fraudulent activity and misuse. The information you provide is internally reviewed to ensure compliance with our terms of service.</p><p class="slate-p " >If any issues arise during the review, our team will contact you to request additional information.</p><p class="slate-p " ></p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=warning ><div class="callout-icon"><svg width="18" height="16" viewBox="0 0 18 16" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M0.916637 15.5009C0.791637 15.5009 0.683998 15.4732 0.59372 15.4176C0.503443 15.362 0.430526 15.2857 0.37497 15.1884C0.319415 15.0912 0.288165 14.9905 0.28122 14.8864C0.274276 14.7822 0.305526 14.6745 0.37497 14.5634L8.4583 0.605103C8.52775 0.493991 8.60761 0.41413 8.69789 0.365519C8.78816 0.316908 8.88886 0.292603 8.99997 0.292603C9.11108 0.292603 9.21178 0.316908 9.30205 0.365519C9.39233 0.41413 9.47219 0.493991 9.54164 0.605103L17.625 14.5634C17.6944 14.6745 17.7257 14.7822 17.7187 14.8864C17.7118 14.9905 17.6805 15.0912 17.625 15.1884C17.5694 15.2857 17.4965 15.362 17.4062 15.4176C17.3159 15.4732 17.2083 15.5009 17.0833 15.5009H0.916637ZM1.99997 14.2509H16L8.99997 2.1676L1.99997 14.2509ZM9.0833 13.0634C9.26386 13.0634 9.41316 13.0044 9.53122 12.8864C9.64928 12.7683 9.7083 12.619 9.7083 12.4384C9.7083 12.2579 9.64928 12.1086 9.53122 11.9905C9.41316 11.8725 9.26386 11.8134 9.0833 11.8134C8.90275 11.8134 8.75344 11.8725 8.63539 11.9905C8.51733 12.1086 8.4583 12.2579 8.4583 12.4384C8.4583 12.619 8.51733 12.7683 8.63539 12.8864C8.75344 13.0044 8.90275 13.0634 9.0833 13.0634ZM9.0833 10.7509C9.26386 10.7509 9.41316 10.6919 9.53122 10.5739C9.64928 10.4558 9.7083 10.3065 9.7083 10.1259V6.70927C9.7083 6.52871 9.64928 6.37941 9.53122 6.26135C9.41316 6.1433 9.26386 6.08427 9.0833 6.08427C8.90275 6.08427 8.75344 6.1433 8.63539 6.26135C8.51733 6.37941 8.4583 6.52871 8.4583 6.70927V10.1259C8.4583 10.3065 8.51733 10.4558 8.63539 10.5739C8.75344 10.6919 8.90275 10.7509 9.0833 10.7509Z" fill="#F1C21B"></path></svg></div><div ><h4 class="slate-h4 " >Important</h4><p class="slate-p " >Our <a href="https://giftees.io/privacy" target="">Privacy Policy</a> explains how and why we collect, use, store, and safeguard any personal information you provide during account activation.</p></div></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

To process real transactions for digital gift cards, you must activate your 

Activate your Giftees account by completing the 

. We’ll request some basic information about your business, your products or services, and your personal relationship with the business. Once you submit your application, our team will review the details. Upon approval, you can immediately start processing real digital gift card transactions and go live.

Giftees complies with "Know Your Customer" (KYC) obligations, which require us to collect and verify this information. These regulations, established by our partners and regulatory authorities, help protect our platform from fraudulent activity and misuse. The information you provide is internally reviewed to ensure compliance with our terms of service.

If any issues arise during the review, our team will contact you to request additional information.

<p class="slate-p slate-indent-0" style="0px">Giftees offers a comprehensive and flexible selection of API formats and collection types to meet diverse integration and development needs. Our platform supports various API formats, such as REST, SOAP, GraphQL, and Async APIs, each designed for specific use cases and requirements. We also provide compatibility with multiple API specification collections, ensuring smooth integration and an efficient development process.</p><p class="slate-p " ></p><h3 class="slate-h3 " >HTTP Methods</h3><p class="slate-p " >HTTP methods, or verbs, denote actions performed on resources. Giftees APIs support various HTTP methods:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">GET:</strong> Retrieve a representation of a specific resource.</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Example: Retrieving transaction details.</div></li></ul></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">POST:</strong> Submit data to create a new resource or trigger a state change.</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Example: Creating a new customer profile.</div></li></ul></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">PUT:</strong> Replace all representations of a target resource with the provided payload.</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Example: Updating a subscription plan.</div></li></ul></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">DELETE:</strong> Remove a specified resource.</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Example: Deleting a stored card.</div></li></ul></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">PATCH:</strong> Apply partial modifications to a resource.</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Example: Changing the status of an existing order.</div></li></ul></li></ul><p class="slate-p " ></p><h3 class="slate-h3 " >Parameters</h3><p class="slate-p " >Parameters allow customization of API requests and responses. Giftees APIs support four types of parameters:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Path Parameters:</strong> Integral parts of the endpoint URL, identifying specific resources.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Query Parameters:</strong> Appended to the endpoint URL to filter or paginate results.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Request Body Parameters:</strong> Included in the request body, transmitting data to the API server.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Response Body Parameters:</strong> Represent data returned by the server in response to a request.</div></li></ul><p class="slate-p " ></p><h3 class="slate-h3 " >HTTP Status Codes</h3><p class="slate-p " >HTTP status codes communicate the outcome of client requests. Giftees employs HTTP status codes categorized into the following classes:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Success (200):</strong> The request was successfully processed.</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Example: Successfully retrieved a resource or completed an action.</div></li></ul></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">400 (Bad Request):</strong> The server could not understand the request due to invalid syntax.</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Example: Missing required parameters in the request.</div></li></ul></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">401 (Unauthorized):</strong> Authentication is required and has failed or has not yet been provided.</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Example: Invalid or missing API key.</div></li></ul></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">402 (Request Failed):</strong> The parameters were valid but the request failed.</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Example: Insufficient funds or expired credit card.</div></li></ul></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">403 (Forbidden):</strong> The client does not have access rights to the content.</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Example: Attempting to access a resource without the necessary permissions.</div></li></ul></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">404 (Not Found):</strong> The server can not find the requested resource.</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Example: Trying to access an endpoint that does not exist.</div></li></ul></li></ul><p class="slate-p " ></p><p class="slate-p " ></p>

Giftees offers a comprehensive and flexible selection of API formats and collection types to meet diverse integration and development needs. Our platform supports various API formats, such as REST, SOAP, GraphQL, and Async APIs, each designed for specific use cases and requirements. We also provide compatibility with multiple API specification collections, ensuring smooth integration and an efficient development process.

HTTP methods, or verbs, denote actions performed on resources. Giftees APIs support various HTTP methods:

Parameters allow customization of API requests and responses. Giftees APIs support four types of parameters:

HTTP status codes communicate the outcome of client requests. Giftees employs HTTP status codes categorized into the following classes:

The request was unacceptable, often due to missing a required parameter.

The parameters were valid but the request failed.

The API key doesnt have permissions to perform the request.

<p class="slate-p slate-indent-0" style="0px">The <strong class="slate-bold">Base URL</strong> is a crucial component for making API calls, as it defines the root URL for all requests. When making API calls, you combine the base URL with the specific endpoint path to form the complete request URL.</p><p class="slate-p slate-indent-0" style="0px">It supports multiple environments, such as <strong class="slate-bold">sandbox</strong> and <strong class="slate-bold">production</strong>. Additionally, the base URL is integrated with the <strong class="slate-bold">API Explorer</strong>, enabling you to seamlessly switch between environments like <strong class="slate-bold">Sandbox</strong> and <strong class="slate-bold">Production</strong> while testing API calls.</p><p class="slate-p " ></p>

 is a crucial component for making API calls, as it defines the root URL for all requests. When making API calls, you combine the base URL with the specific endpoint path to form the complete request URL.

It supports multiple environments, such as 

. Additionally, the base URL is integrated with the 

, enabling you to seamlessly switch between environments like 

<p class="slate-p " ><p class="slate-p " >When it comes to interacting with APIs, authentication is a critical step to ensure secure communication between your application and the API service. API authentication is performed via HTTP Basic Auth, which involves including your API key in the HTTP request headers. This method verifies your identity and grants you access to the API&apos;s resources, ensuring that only authorized users can make requests.</p></p><p class="slate-p " >Giftees Sample API uses <span style="color:var(--dark-text-content-color)"><code class="slate-code">API keys</code></span> to authenticate requests.</p><p class="slate-p " ></p><h3 class="slate-h3 " >To retrieve your API key from app.giftees.io, follow these steps:</h3><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Sign in</strong>: Navigate to app.giftees.io and sign in with your credentials.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">User Settings</strong>: Once logged in, locate the user settings.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Tools &amp; Integrations Tab</strong>: Within the user settings, find the &quot;Tools &amp; Integrations&quot; tab. Click on it to access settings related to integrations and tools.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Locate API Key</strong>: In the Tools &amp; Integrations tab, you should find your API key listed.</div></li></ol><p class="slate-p " ></p><h3 class="slate-h3 " >Add headers to an HTTP request</h3><p class="slate-p " >Giftees uses <strong class="slate-bold">API keys</strong> to grant access to the API. You can generate a new API key in the <strong class="slate-bold">Giftees Dashboard</strong>. The API key must be included in all API requests to the server, using a header formatted as follows:</p><p class="slate-p " ><code class="slate-code">Authorization: Bearere {{apiKey}}</code></p><div class="slate-code_line"></div><h3 class="slate-h3 " >Content Types</h3><p class="slate-p " ><code class="slate-code">Accepts: application/json</code></p><p class="slate-p " ><code class="slate-code">Content-Type: application/json</code></p><p class="slate-p " ><code class="slate-code">Content-Type: application/json-patch+json</code></p><p class="slate-p " ></p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=warning ><div class="callout-icon"><svg width="18" height="16" viewBox="0 0 18 16" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M0.916637 15.5009C0.791637 15.5009 0.683998 15.4732 0.59372 15.4176C0.503443 15.362 0.430526 15.2857 0.37497 15.1884C0.319415 15.0912 0.288165 14.9905 0.28122 14.8864C0.274276 14.7822 0.305526 14.6745 0.37497 14.5634L8.4583 0.605103C8.52775 0.493991 8.60761 0.41413 8.69789 0.365519C8.78816 0.316908 8.88886 0.292603 8.99997 0.292603C9.11108 0.292603 9.21178 0.316908 9.30205 0.365519C9.39233 0.41413 9.47219 0.493991 9.54164 0.605103L17.625 14.5634C17.6944 14.6745 17.7257 14.7822 17.7187 14.8864C17.7118 14.9905 17.6805 15.0912 17.625 15.1884C17.5694 15.2857 17.4965 15.362 17.4062 15.4176C17.3159 15.4732 17.2083 15.5009 17.0833 15.5009H0.916637ZM1.99997 14.2509H16L8.99997 2.1676L1.99997 14.2509ZM9.0833 13.0634C9.26386 13.0634 9.41316 13.0044 9.53122 12.8864C9.64928 12.7683 9.7083 12.619 9.7083 12.4384C9.7083 12.2579 9.64928 12.1086 9.53122 11.9905C9.41316 11.8725 9.26386 11.8134 9.0833 11.8134C8.90275 11.8134 8.75344 11.8725 8.63539 11.9905C8.51733 12.1086 8.4583 12.2579 8.4583 12.4384C8.4583 12.619 8.51733 12.7683 8.63539 12.8864C8.75344 13.0044 8.90275 13.0634 9.0833 13.0634ZM9.0833 10.7509C9.26386 10.7509 9.41316 10.6919 9.53122 10.5739C9.64928 10.4558 9.7083 10.3065 9.7083 10.1259V6.70927C9.7083 6.52871 9.64928 6.37941 9.53122 6.26135C9.41316 6.1433 9.26386 6.08427 9.0833 6.08427C8.90275 6.08427 8.75344 6.1433 8.63539 6.26135C8.51733 6.37941 8.4583 6.52871 8.4583 6.70927V10.1259C8.4583 10.3065 8.51733 10.4558 8.63539 10.5739C8.75344 10.6919 8.90275 10.7509 9.0833 10.7509Z" fill="#F1C21B"></path></svg></div><div ><p class="slate-p " ><strong class="slate-bold">Important</strong></p><p class="slate-p " >Your API keys grant significant access, so it’s crucial to keep them safe! Avoid sharing your secret API keys in public places like GitHub, client-side code, and similar locations.</p></div></div><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=error ><div class="callout-icon"><svg width="18" height="18" viewBox="0 0 18 18" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M9.08366 9.9801C9.25033 9.9801 9.39269 9.92107 9.51074 9.80302C9.6288 9.68496 9.68783 9.53566 9.68783 9.3551V5.31344C9.68783 5.14677 9.62533 5.00441 9.50033 4.88635C9.37533 4.7683 9.22949 4.70927 9.06283 4.70927C8.88227 4.70927 8.73296 4.7683 8.61491 4.88635C8.49685 5.00441 8.43783 5.15371 8.43783 5.33427V9.37594C8.43783 9.5426 8.50033 9.68496 8.62533 9.80302C8.75033 9.92107 8.9031 9.9801 9.08366 9.9801ZM9.00033 13.1676C9.19477 13.1676 9.35796 13.1016 9.48991 12.9697C9.62185 12.8377 9.68783 12.6745 9.68783 12.4801C9.68783 12.2857 9.62185 12.1225 9.48991 11.9905C9.35796 11.8586 9.19477 11.7926 9.00033 11.7926C8.80588 11.7926 8.64269 11.8586 8.51074 11.9905C8.3788 12.1225 8.31283 12.2857 8.31283 12.4801C8.31283 12.6745 8.3788 12.8377 8.51074 12.9697C8.64269 13.1016 8.80588 13.1676 9.00033 13.1676ZM9.00033 17.3343C7.81977 17.3343 6.72255 17.1225 5.70866 16.6989C4.69477 16.2752 3.81283 15.6884 3.06283 14.9384C2.31283 14.1884 1.72602 13.3065 1.30241 12.2926C0.878798 11.2787 0.666992 10.1815 0.666992 9.00094C0.666992 7.83427 0.878798 6.74399 1.30241 5.7301C1.72602 4.71621 2.31283 3.83427 3.06283 3.08427C3.81283 2.33427 4.69477 1.74399 5.70866 1.31344C6.72255 0.88288 7.81977 0.667603 9.00033 0.667603C10.167 0.667603 11.2573 0.88288 12.2712 1.31344C13.285 1.74399 14.167 2.33427 14.917 3.08427C15.667 3.83427 16.2573 4.71621 16.6878 5.7301C17.1184 6.74399 17.3337 7.83427 17.3337 9.00094C17.3337 10.1815 17.1184 11.2787 16.6878 12.2926C16.2573 13.3065 15.667 14.1884 14.917 14.9384C14.167 15.6884 13.285 16.2752 12.2712 16.6989C11.2573 17.1225 10.167 17.3343 9.00033 17.3343ZM9.00033 16.0843C10.9448 16.0843 12.6114 15.3898 14.0003 14.0009C15.3892 12.612 16.0837 10.9454 16.0837 9.00094C16.0837 7.05649 15.3892 5.38982 14.0003 4.00094C12.6114 2.61205 10.9448 1.9176 9.00033 1.9176C7.05588 1.9176 5.38921 2.61205 4.00033 4.00094C2.61144 5.38982 1.91699 7.05649 1.91699 9.00094C1.91699 10.9454 2.61144 12.612 4.00033 14.0009C5.38921 15.3898 7.05588 16.0843 9.00033 16.0843Z" fill="#E90005"></path></svg></div><div ><p class="slate-p " >API requests without authentication will fail.</p></div></div><p class="slate-p " >
</p>

To retrieve your API key from app.giftees.io, follow these steps:

 to grant access to the API. You can generate a new API key in the 

. The API key must be included in all API requests to the server, using a header formatted as follows:

Content-Type: application/json-patch+json

<p class="slate-p " ><p class="slate-p " >A company in Giftees is also referred to as a <strong class="slate-bold">Giftees account</strong>. Multiple users can be granted access to manage a single Giftees company account.</p></p><p class="slate-p " ><div class="slate-div"></div></p>

<p class="slate-p " >In Giftees, orders contain the transaction details related to the purchase of gift cards. Each order can include one or more gift cards.</p><p class="slate-p " ></p>

In Giftees, orders contain the transaction details related to the purchase of gift cards. Each order can include one or more gift cards.

<p class="slate-p " ><p class="slate-p " >Retrieves the details of an order.</p></p>

Get Order

User-Agent

Authorization

Create an Order

skip_sending_emails

purchaser_email

purchaser_name

recipient_name

recipient_email

message

referrer

discount

shipping_fee

selected_recipient

items

metadata

Content-Type

<p class="slate-p " ><p class="slate-p " >Update an existing order containing one or more gift cards. You can only modify the name and email of the purchaser of the order.</p></p><p class="slate-p " ></p>

Update an Order

<p class="slate-p " ><p class="slate-p " >Add note to an order</p></p><p class="slate-p " ></p>

Add Notes

note

<p class="slate-p " ><p class="slate-p " >Manage gift card items available for sale. You can create, update, or deactivate gift card offerings, specifying details such as the gift card value, description, and availability.</p></p>

<p class="slate-p " ><p class="slate-p " >In Giftees, a <strong class="slate-bold">gift card</strong> is the thoughtful surprise sent to a recipient when someone places an order through the Giftees checkout or issues it via the dashboard or API. Each gift card carries its own unique <strong class="slate-bold">code</strong> and <strong class="slate-bold">balance</strong> (referred to as <code class="slate-code">remaining_value</code> in our API), along with additional properties that make each gift card special.</p><p class="slate-p " >At the heart of every gift card is an <strong class="slate-bold">order</strong>—the parent entity that holds all the details of the transaction. A single order can include multiple gift cards, making Giftees perfect for everything from single gifts to bulk gifting occasions.</p><p class="slate-p " >Giftees makes gifting more than just a transaction—it’s a way to create memorable moments for recipients, while giving businesses a powerful and flexible tool to manage every step of the gifting experience.</p></p>

Sections