Skip to main content
POST
/
admin
/
gift-cards
cURL
curl -X POST '{backend_url}/admin/gift-cards' \
-H 'Authorization: Bearer {jwt_token}' \
-H 'Content-Type: application/json' \
--data-raw '{
  "code": "{value}",
  "value": 19,
  "currency_code": "bwp",
  "expires_at": "2025-07-20T15:47:23.951Z",
  "reference_id": "{value}",
  "reference": "{value}",
  "line_item_id": "{value}",
  "customer_id": "{value}",
  "metadata": {}
}'
{
  "gift_card": {
    "line_item": {
      "id": "<string>",
      "title": "<string>",
      "subtitle": "<string>",
      "thumbnail": "<string>",
      "variant_id": "<string>",
      "product_id": "<string>",
      "product_title": "<string>",
      "product_description": "<string>",
      "product_subtitle": "<string>",
      "product_type": "<string>",
      "product_collection": "<string>",
      "product_handle": "<string>",
      "variant_sku": "<string>",
      "variant_barcode": "<string>",
      "variant_title": "<string>",
      "variant_option_values": {
        "Color": "Blue"
      },
      "requires_shipping": true,
      "is_discountable": true,
      "is_tax_inclusive": true,
      "unit_price": 123,
      "quantity": 123,
      "detail": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "metadata": {},
      "original_total": 123,
      "original_subtotal": 123,
      "original_tax_total": 123,
      "item_total": 123,
      "item_subtotal": 123,
      "item_tax_total": 123,
      "total": 123,
      "subtotal": 123,
      "tax_total": 123,
      "discount_total": 123,
      "discount_tax_total": 123,
      "refundable_total": 123,
      "refundable_total_per_unit": 123,
      "product_type_id": "<string>",
      "variant": {
        "prices": [
          {
            "id": "<string>",
            "title": "<string>",
            "currency_code": "usd",
            "amount": 123,
            "raw_amount": {},
            "min_quantity": 123,
            "max_quantity": 123,
            "price_set_id": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "deleted_at": "2023-11-07T05:31:56Z"
          }
        ],
        "id": "<string>",
        "title": "<string>",
        "sku": "<string>",
        "barcode": "<string>",
        "ean": "<string>",
        "upc": "<string>",
        "allow_backorder": true,
        "manage_inventory": true,
        "hs_code": "<string>",
        "origin_country": "<string>",
        "mid_code": "<string>",
        "material": "<string>",
        "weight": 123,
        "length": 123,
        "height": 123,
        "width": 123,
        "options": [
          {
            "id": "<string>",
            "value": "<string>",
            "option": {
              "id": "<string>",
              "title": "<string>",
              "product": {},
              "product_id": "<string>",
              "values": [
                {}
              ],
              "metadata": {},
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z",
              "deleted_at": "2023-11-07T05:31:56Z"
            },
            "option_id": "<string>",
            "metadata": {},
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "deleted_at": "2023-11-07T05:31:56Z"
          }
        ],
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "deleted_at": "2023-11-07T05:31:56Z",
        "images": [
          {
            "id": "<string>",
            "url": "<string>",
            "rank": 123,
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "deleted_at": "2023-11-07T05:31:56Z",
            "metadata": {}
          }
        ],
        "thumbnail": "<string>",
        "inventory_quantity": 123,
        "variant_rank": 123,
        "product": {},
        "product_id": "<string>",
        "calculated_price": {
          "id": "<string>",
          "calculated_amount": 123,
          "original_amount": 123,
          "currency_code": "usd",
          "original_amount_with_tax": 123,
          "original_amount_without_tax": 123,
          "is_calculated_price_price_list": true,
          "is_calculated_price_tax_inclusive": true,
          "calculated_amount_with_tax": 123,
          "calculated_amount_without_tax": 123,
          "is_original_price_price_list": true,
          "is_original_price_tax_inclusive": true,
          "calculated_price": {},
          "original_price": {}
        },
        "metadata": {},
        "inventory_items": [
          {
            "id": "<string>",
            "variant_id": "<string>",
            "inventory_item_id": "<string>",
            "variant": {},
            "inventory": {
              "id": "<string>",
              "requires_shipping": true,
              "sku": "<string>",
              "origin_country": "<string>",
              "hs_code": "<string>",
              "mid_code": "<string>",
              "material": "<string>",
              "weight": 123,
              "length": 123,
              "height": 123,
              "width": 123,
              "title": "<string>",
              "description": "<string>",
              "thumbnail": "<string>",
              "metadata": {},
              "location_levels": [
                {
                  "id": "<string>",
                  "created_at": "2023-11-07T05:31:56Z",
                  "updated_at": "2023-11-07T05:31:56Z",
                  "deleted_at": "2023-11-07T05:31:56Z",
                  "inventory_item_id": "<string>",
                  "location_id": "<string>",
                  "stocked_quantity": 123,
                  "reserved_quantity": 123,
                  "incoming_quantity": 123,
                  "metadata": {},
                  "available_quantity": 123,
                  "inventory_item": {}
                }
              ]
            },
            "required_quantity": 123
          }
        ],
        "translations": [
          {
            "id": "<string>",
            "reference_id": "prod_123",
            "reference": "product",
            "locale_code": "fr-FR",
            "translations": {
              "title": "Chaussures",
              "description": "Des chaussures élégantes."
            },
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "deleted_at": "2023-11-07T05:31:56Z"
          }
        ]
      },
      "product": {
        "variants": [
          {
            "prices": [
              {
                "id": "<string>",
                "title": "<string>",
                "currency_code": "usd",
                "amount": 123,
                "raw_amount": {},
                "min_quantity": 123,
                "max_quantity": 123,
                "price_set_id": "<string>",
                "created_at": "2023-11-07T05:31:56Z",
                "updated_at": "2023-11-07T05:31:56Z",
                "deleted_at": "2023-11-07T05:31:56Z"
              }
            ],
            "id": "<string>",
            "title": "<string>",
            "sku": "<string>",
            "barcode": "<string>",
            "ean": "<string>",
            "upc": "<string>",
            "allow_backorder": true,
            "manage_inventory": true,
            "hs_code": "<string>",
            "origin_country": "<string>",
            "mid_code": "<string>",
            "material": "<string>",
            "weight": 123,
            "length": 123,
            "height": 123,
            "width": 123,
            "options": [
              {
                "id": "<string>",
                "value": "<string>",
                "option": {
                  "id": "<string>",
                  "title": "<string>",
                  "product": {},
                  "product_id": "<string>",
                  "values": [
                    {}
                  ],
                  "metadata": {},
                  "created_at": "2023-11-07T05:31:56Z",
                  "updated_at": "2023-11-07T05:31:56Z",
                  "deleted_at": "2023-11-07T05:31:56Z"
                },
                "option_id": "<string>",
                "metadata": {},
                "created_at": "2023-11-07T05:31:56Z",
                "updated_at": "2023-11-07T05:31:56Z",
                "deleted_at": "2023-11-07T05:31:56Z"
              }
            ],
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "deleted_at": "2023-11-07T05:31:56Z",
            "images": [
              {
                "id": "<string>",
                "url": "<string>",
                "rank": 123,
                "created_at": "2023-11-07T05:31:56Z",
                "updated_at": "2023-11-07T05:31:56Z",
                "deleted_at": "2023-11-07T05:31:56Z",
                "metadata": {}
              }
            ],
            "thumbnail": "<string>",
            "inventory_quantity": 123,
            "variant_rank": 123,
            "product": {},
            "product_id": "<string>",
            "calculated_price": {
              "id": "<string>",
              "calculated_amount": 123,
              "original_amount": 123,
              "currency_code": "usd",
              "original_amount_with_tax": 123,
              "original_amount_without_tax": 123,
              "is_calculated_price_price_list": true,
              "is_calculated_price_tax_inclusive": true,
              "calculated_amount_with_tax": 123,
              "calculated_amount_without_tax": 123,
              "is_original_price_price_list": true,
              "is_original_price_tax_inclusive": true,
              "calculated_price": {},
              "original_price": {}
            },
            "metadata": {},
            "inventory_items": [
              {
                "id": "<string>",
                "variant_id": "<string>",
                "inventory_item_id": "<string>",
                "variant": {},
                "inventory": {
                  "id": "<string>",
                  "requires_shipping": true,
                  "sku": "<string>",
                  "origin_country": "<string>",
                  "hs_code": "<string>",
                  "mid_code": "<string>",
                  "material": "<string>",
                  "weight": 123,
                  "length": 123,
                  "height": 123,
                  "width": 123,
                  "title": "<string>",
                  "description": "<string>",
                  "thumbnail": "<string>",
                  "metadata": {},
                  "location_levels": [
                    {
                      "id": "<string>",
                      "created_at": "2023-11-07T05:31:56Z",
                      "updated_at": "2023-11-07T05:31:56Z",
                      "deleted_at": "2023-11-07T05:31:56Z",
                      "inventory_item_id": "<string>",
                      "location_id": "<string>",
                      "stocked_quantity": 123,
                      "reserved_quantity": 123,
                      "incoming_quantity": 123,
                      "metadata": {},
                      "available_quantity": 123,
                      "inventory_item": {}
                    }
                  ]
                },
                "required_quantity": 123
              }
            ],
            "translations": [
              {
                "id": "<string>",
                "reference_id": "prod_123",
                "reference": "product",
                "locale_code": "fr-FR",
                "translations": {
                  "title": "Chaussures",
                  "description": "Des chaussures élégantes."
                },
                "created_at": "2023-11-07T05:31:56Z",
                "updated_at": "2023-11-07T05:31:56Z",
                "deleted_at": "2023-11-07T05:31:56Z"
              }
            ]
          }
        ],
        "type": {
          "id": "<string>",
          "value": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "deleted_at": "2023-11-07T05:31:56Z",
          "metadata": {},
          "translations": [
            {
              "id": "<string>",
              "reference_id": "prod_123",
              "reference": "product",
              "locale_code": "fr-FR",
              "translations": {
                "title": "Chaussures",
                "description": "Des chaussures élégantes."
              },
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z",
              "deleted_at": "2023-11-07T05:31:56Z"
            }
          ]
        },
        "length": 123,
        "title": "<string>",
        "status": "draft",
        "options": [
          {
            "id": "<string>",
            "title": "<string>",
            "product": {},
            "product_id": "<string>",
            "values": [
              {}
            ],
            "metadata": {},
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "deleted_at": "2023-11-07T05:31:56Z"
          }
        ],
        "description": "<string>",
        "id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "handle": "<string>",
        "subtitle": "<string>",
        "is_giftcard": true,
        "thumbnail": "<string>",
        "width": 123,
        "weight": 123,
        "height": 123,
        "origin_country": "<string>",
        "hs_code": "<string>",
        "mid_code": "<string>",
        "material": "<string>",
        "collection_id": "<string>",
        "type_id": "<string>",
        "images": [
          {
            "id": "<string>",
            "url": "<string>",
            "rank": 123,
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "deleted_at": "2023-11-07T05:31:56Z",
            "metadata": {},
            "product": {},
            "variants": [
              {}
            ]
          }
        ],
        "discountable": true,
        "external_id": "<string>",
        "deleted_at": "2023-11-07T05:31:56Z",
        "collection": {
          "id": "<string>",
          "title": "<string>",
          "handle": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "deleted_at": "2023-11-07T05:31:56Z",
          "metadata": {},
          "products": [
            {
              "variants": [
                {}
              ],
              "length": 123,
              "title": "<string>",
              "status": "draft",
              "options": [
                {
                  "id": "<string>",
                  "title": "<string>",
                  "product": {},
                  "product_id": "<string>",
                  "values": [
                    {
                      "id": "<string>",
                      "value": "<string>",
                      "option": {},
                      "option_id": "<string>",
                      "metadata": {},
                      "created_at": "2023-11-07T05:31:56Z",
                      "updated_at": "2023-11-07T05:31:56Z",
                      "deleted_at": "2023-11-07T05:31:56Z"
                    }
                  ],
                  "metadata": {},
                  "created_at": "2023-11-07T05:31:56Z",
                  "updated_at": "2023-11-07T05:31:56Z",
                  "deleted_at": "2023-11-07T05:31:56Z"
                }
              ],
              "description": "<string>",
              "id": "<string>",
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z",
              "handle": "<string>",
              "subtitle": "<string>",
              "is_giftcard": true,
              "thumbnail": "<string>",
              "width": 123,
              "weight": 123,
              "height": 123,
              "origin_country": "<string>",
              "hs_code": "<string>",
              "mid_code": "<string>",
              "material": "<string>",
              "collection_id": "<string>",
              "type_id": "<string>",
              "images": [
                {
                  "id": "<string>",
                  "url": "<string>",
                  "rank": 123,
                  "created_at": "2023-11-07T05:31:56Z",
                  "updated_at": "2023-11-07T05:31:56Z",
                  "deleted_at": "2023-11-07T05:31:56Z",
                  "metadata": {}
                }
              ],
              "discountable": true,
              "external_id": "<string>",
              "deleted_at": "2023-11-07T05:31:56Z",
              "collection": {
                "id": "<string>",
                "title": "<string>",
                "handle": "<string>",
                "created_at": "2023-11-07T05:31:56Z",
                "updated_at": "2023-11-07T05:31:56Z",
                "deleted_at": "2023-11-07T05:31:56Z",
                "metadata": {},
                "products": [
                  {}
                ]
              },
              "categories": [
                {
                  "category_children": [
                    {
                      "category_children": [
                        {}
                      ],
                      "parent_category": {},
                      "name": "<string>",
                      "description": "<string>",
                      "id": "<string>",
                      "created_at": "2023-11-07T05:31:56Z",
                      "updated_at": "2023-11-07T05:31:56Z",
                      "handle": "<string>",
                      "deleted_at": "2023-11-07T05:31:56Z",
                      "is_active": true,
                      "is_internal": true,
                      "rank": 123,
                      "parent_category_id": "<string>",
                      "products": [
                        {}
                      ],
                      "metadata": {}
                    }
                  ],
                  "parent_category": {
                    "category_children": [
                      {}
                    ],
                    "parent_category": {},
                    "name": "<string>",
                    "description": "<string>",
                    "id": "<string>",
                    "created_at": "2023-11-07T05:31:56Z",
                    "updated_at": "2023-11-07T05:31:56Z",
                    "handle": "<string>",
                    "deleted_at": "2023-11-07T05:31:56Z",
                    "is_active": true,
                    "is_internal": true,
                    "rank": 123,
                    "parent_category_id": "<string>",
                    "products": [
                      {}
                    ],
                    "metadata": {}
                  },
                  "name": "<string>",
                  "description": "<string>",
                  "id": "<string>",
                  "created_at": "2023-11-07T05:31:56Z",
                  "updated_at": "2023-11-07T05:31:56Z",
                  "handle": "<string>",
                  "deleted_at": "2023-11-07T05:31:56Z",
                  "is_active": true,
                  "is_internal": true,
                  "rank": 123,
                  "parent_category_id": "<string>",
                  "products": [
                    {}
                  ],
                  "metadata": {}
                }
              ],
              "type": {
                "id": "<string>",
                "value": "<string>",
                "created_at": "2023-11-07T05:31:56Z",
                "updated_at": "2023-11-07T05:31:56Z",
                "deleted_at": "2023-11-07T05:31:56Z",
                "metadata": {}
              },
              "tags": [
                {
                  "id": "<string>",
                  "value": "<string>",
                  "created_at": "2023-11-07T05:31:56Z",
                  "updated_at": "2023-11-07T05:31:56Z",
                  "deleted_at": "2023-11-07T05:31:56Z",
                  "metadata": {}
                }
              ],
              "metadata": {}
            }
          ],
          "translations": [
            {
              "id": "<string>",
              "reference_id": "prod_123",
              "reference": "product",
              "locale_code": "fr-FR",
              "translations": {
                "title": "Chaussures",
                "description": "Des chaussures élégantes."
              },
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z",
              "deleted_at": "2023-11-07T05:31:56Z"
            }
          ]
        },
        "categories": [
          {
            "category_children": [
              {}
            ],
            "parent_category": {},
            "name": "<string>",
            "description": "<string>",
            "id": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "handle": "<string>",
            "deleted_at": "2023-11-07T05:31:56Z",
            "is_active": true,
            "is_internal": true,
            "rank": 123,
            "parent_category_id": "<string>",
            "products": [
              {}
            ],
            "metadata": {}
          }
        ],
        "sales_channels": [
          {
            "id": "<string>",
            "name": "<string>",
            "description": "<string>",
            "is_disabled": true,
            "metadata": {},
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "deleted_at": "2023-11-07T05:31:56Z"
          }
        ],
        "tags": [
          {
            "id": "<string>",
            "value": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "deleted_at": "2023-11-07T05:31:56Z",
            "metadata": {},
            "translations": [
              {
                "id": "<string>",
                "reference_id": "prod_123",
                "reference": "product",
                "locale_code": "fr-FR",
                "translations": {
                  "title": "Chaussures",
                  "description": "Des chaussures élégantes."
                },
                "created_at": "2023-11-07T05:31:56Z",
                "updated_at": "2023-11-07T05:31:56Z",
                "deleted_at": "2023-11-07T05:31:56Z"
              }
            ]
          }
        ],
        "metadata": {},
        "shipping_profile": {
          "id": "<string>",
          "name": "<string>",
          "type": "<string>",
          "metadata": {},
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "deleted_at": "2023-11-07T05:31:56Z"
        },
        "translations": [
          {
            "id": "<string>",
            "reference_id": "prod_123",
            "reference": "product",
            "locale_code": "fr-FR",
            "translations": {
              "title": "Chaussures",
              "description": "Des chaussures élégantes."
            },
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "deleted_at": "2023-11-07T05:31:56Z"
          }
        ]
      },
      "compare_at_unit_price": 123,
      "tax_lines": [
        {
          "item": {},
          "item_id": "<string>",
          "total": 123,
          "subtotal": 123,
          "id": "<string>",
          "code": "<string>",
          "rate": 123,
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "description": "<string>",
          "tax_rate_id": "<string>",
          "provider_id": "<string>"
        }
      ],
      "adjustments": [
        {
          "item": {},
          "item_id": "<string>",
          "id": "<string>",
          "amount": 123,
          "order_id": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "code": "<string>",
          "description": "<string>",
          "promotion_id": "<string>",
          "provider_id": "<string>"
        }
      ]
    },
    "customer": {
      "id": "<string>",
      "has_account": true,
      "email": "jsmith@example.com",
      "default_billing_address_id": "<string>",
      "default_shipping_address_id": "<string>",
      "company_name": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "addresses": [
        {
          "id": "<string>",
          "address_name": "<string>",
          "is_default_shipping": true,
          "is_default_billing": true,
          "customer_id": "<string>",
          "company": "<string>",
          "first_name": "<string>",
          "last_name": "<string>",
          "address_1": "<string>",
          "address_2": "<string>",
          "city": "<string>",
          "country_code": "us",
          "province": "us-ca",
          "postal_code": "<string>",
          "phone": "<string>",
          "metadata": {},
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ],
      "groups": [
        {
          "id": "<string>",
          "name": "<string>",
          "customers": [
            {}
          ],
          "metadata": {},
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ],
      "phone": "<string>",
      "metadata": {},
      "created_by": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "deleted_at": "2023-11-07T05:31:56Z"
    },
    "id": "<string>",
    "code": "<string>",
    "status": "pending",
    "value": 123,
    "currency_code": "usd",
    "customer_id": "<string>",
    "reference_id": "<string>",
    "note": "<string>",
    "reference": "<string>",
    "expires_at": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
fields
string

Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields. Comma-separated fields that should be included in the returned data. If a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. Without prefix it will replace the entire default fields.

Body

application/json

The details of the gift card to create.

​
code
string
required

The gift card's code.

​
value
number
required

The gift card's amount.

Example:

20

​
currency_code
string
required

The gift card's currency code.

Example:

"usd"

​
expires_at
string
required

The date the gift card expires at.

​
reference_id
string
required

The gift card's reference ID.

​
reference
string
required

The gift card's reference.

​
line_item_id
string
required

The ID of the line item associated with the gift card.

​
customer_id
string
required

The ID of the customer associated with the gift card.

​
metadata
object
required

The gift card's metadata, can hold custom key-value pairs.

Response

OK

The gift card's details.

​
gift_card
object
required

The gift card's details.