post https://{shopdomain}.myshoplaza.com/openapi/2022-01/gift_cards
Requires
price_rulesaccess scope. More access scope
The Create Gift Card API creates a new gift card for a specific customer or store, including details such as initial value, expiration date, and custom templates.
This API is especially useful for:
- Managing gift cards for customers.
- Issuing new gift cards with predefined values and conditions.
- Integrating gift card creation into e-commerce workflows.
Request Parameters
Public Request Parameters
Body Parameters
| Name | Type | Description | Example |
|---|---|---|---|
gift_card | object | Gift card information. | {...} |
gift_card.code | string | The gift card code, which is a string of alphanumeric characters. Must be between 8 and 20 characters. | ABCD1234 |
gift_card.initial_value | string | The initial value of the gift card when it was created. | 200.00 |
gift_card.expires_on | string | The expiration date of the gift card in ISO-8601 format. | 2022-11-01T00:00:00Z |
gift_card.note | string | An optional note that a merchant can attach to the gift card that isn't visible to customers. | This is a note. |
gift_card.customer_id | string | The ID of the customer associated with this gift card. | 2dd957e3-2051-4cdf-8584-9c0046b4d1ae |
gift_card.template_suffix | string | The suffix of the Liquid template that's used to render the gift card online. | template1 |
gift_card.send_email | boolean | Send notification email to customer, true is default. | true |
Response Explanation
Public Response Parameters
Success Response
| Name | Type | Description | Example |
|---|---|---|---|
gift_card.id | string | Unique identifier for the gift card. | 377026890382183978 |
gift_card.last_characters | string | The last characters of the gift card code. | 218p |
gift_card.balance | string | Current balance of the gift card. | 100.00 |
gift_card.initial_value | string | The initial value of the gift card when created. | 100.00 |
gift_card.note | string | Note attached to the gift card. | note |
gift_card.expires_on | string | Expiration date of the gift card in ISO-8601 format, if applicable. | null |
gift_card.disabled_at | string | Timestamp when the gift card was disabled, if applicable. | null |
gift_card.enabled | boolean | Whether the gift card is currently enabled. | true |
gift_card.created_at | string | Timestamp of when the gift card was created. | 2024-05-06T10:12:05Z |
gift_card.updated_at | string | Timestamp of when the gift card was last updated. | 2024-05-06T10:12:05Z |
gift_card.status | string | Current status of the gift card (enable or disable). | enable |
gift_card.currency | string | Currency in which the gift card is denominated. | USD |
gift_card.line_item_id | string | ID of the line item associated with the gift card, if applicable. | null |
gift_card.order_id | string | ID of the order associated with the gift card, if applicable. | null |
gift_card.user_id | string | User ID of the creator or owner of the gift card. | cba51e16-ac53-43d8-a7a3-161c5b1ecd8e |
gift_card.template_suffix | string | Suffix of the template used to render the gift card online. | null |
gift_card.customer_id | string | Customer ID associated with the gift card. | 2dd957e3-2051-4cdf-8584-9c0046b4d1ae |
Error Response
Error responses in the API can be represented using two different fields: errors and error. Both fields provide details about issues encountered during request processing. Below is an explanation of the fields with their respective examples and descriptions.
| Field | Type | Example | Description |
|---|---|---|---|
errors | Array | [ "invalid line_item id"] | A list of errors encountered during the request processing. |
| Field | Type | Example | Description |
|---|---|---|---|
error | String | "store is not active" | Indicates an error encountered during the process |
Error Detail
| Status Code | Message | Possible Reason | Example Response |
|---|---|---|---|
| 400 | Bad Request | Invalid input format or request structure (e.g., missing required fields or incorrect data types). | Bad Request |
| Unauthorized | The request is missing valid authentication credentials or the credentials provided are invalid. | Unauthorized | |
| 422 | "InitialValue is required” | Empty initial_value | "InitialValue is required” |
| "Code is required" | Empty code | "Code is required" | |
| cannot parse | invalid expires_on | cannot parse |