Create gift card

POST 
/openapi/2025-06/gift_cards

Creates a new gift card for a specific customer or store.

Request

application/json

Body

Bodyrequired

gift_card objectrequired

Gift card information

codestringrequired

The gift card code, which is a string of alphanumeric characters. Must be between 8 and 20 characters

initial_valuestringrequired

The initial value of the gift card when it was created (e.g., 200.00)

expires_onstring

The expiration date of the gift card (e.g., 2018-11-02T12:30:10Z)

notestring

An optional note that a merchant can attach to the gift card that isn't visible to customers

customer_idstring

The ID of the customer associated with this gift card

template_suffixstring

The suffix of the Liquid template that's used to render the gift card online

send_emailboolean

Whether to send a notification email to the customer. Defaults to true

currencystring

ISO 4217 currency code for the gift card (e.g., USD, EUR, CNY)

Example

{
  "gift_card": {
    "code": "string",
    "initial_value": "string",
    "expires_on": "string",
    "note": "string",
    "customer_id": "string",
    "template_suffix": "string",
    "send_email": true,
    "currency": "string"
  }
}

Responses

200

OK

application/json

Schema

Schema

codestring

error code

messagestring

error message

data object

gift_card object

Gift card

idstring

Gift card ID

last_charactersstring

Last four characters of the gift card code

balancestring

Current balance of the gift card

initial_valuestring

The initial value of the gift card

notestring

Note attached to the gift card

expires_onstring

Expiration date of the gift card (e.g., 2018-11-02T12:30:10Z)

disabled_atstring

Time when the gift card was disabled (e.g., 2018-11-02T12:30:10Z)

enabledboolean

Whether the gift card is currently enabled

created_atstring

Time when the gift card was created (e.g., 2018-11-02T12:30:10Z)

updated_atstring

Time when the gift card was last updated (e.g., 2018-11-02T12:30:10Z)

statusstring

Status of the gift card:

• enable: gift card is active and usable
• disable: gift card is disabled and cannot be used

currencystring

Currency in which the gift card is denominated

line_item_idstring

ID of the line item associated with the gift card

order_idstring

ID of the order associated with the gift card

user_idstring

User ID of the creator or owner of the gift card

template_suffixstring

Suffix of the template used to render the gift card online

customer_idstring

Customer ID associated with the gift card

codestring

The gift card code, consisting of alphanumeric characters (minimum: 8 characters, maximum: 20 characters)

Example

{
  "code": "string",
  "message": "string",
  "data": {
    "gift_card": {
      "id": "string",
      "last_characters": "string",
      "balance": "string",
      "initial_value": "string",
      "note": "string",
      "expires_on": "string",
      "disabled_at": "string",
      "enabled": true,
      "created_at": "string",
      "updated_at": "string",
      "status": "string",
      "currency": "string",
      "line_item_id": "string",
      "order_id": "string",
      "user_id": "string",
      "template_suffix": "string",
      "customer_id": "string",
      "code": "string"
    }
  }
}