Skip to main content
POST
/
store
/
gift-cards
/
{idOrCode}
/
redeem
cURL
curl -X POST '{backend_url}/store/gift-cards/{idOrCode}/redeem' \
-H 'Authorization: Bearer {jwt_token}' \
-H 'x-publishable-api-key: {your_publishable_api_key}'
{
  "gift_card": {
    "customer": {
      "id": "<string>",
      "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": "usd",
          "province": "us-ca",
          "postal_code": "<string>",
          "phone": "<string>",
          "metadata": {},
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ],
      "phone": "<string>",
      "metadata": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "deleted_at": "2023-11-07T05:31:56Z"
    },
    "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": {
        "id": "<string>",
        "item_id": "<string>",
        "item": {
          "detail": {
            "id": "<string>",
            "item_id": "<string>",
            "item": {},
            "quantity": 123,
            "fulfilled_quantity": 123,
            "delivered_quantity": 123,
            "shipped_quantity": 123,
            "return_requested_quantity": 123,
            "return_received_quantity": 123,
            "return_dismissed_quantity": 123,
            "written_off_quantity": 123,
            "metadata": {},
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z"
          },
          "title": "<string>",
          "id": "<string>",
          "metadata": {},
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "item_total": 123,
          "item_subtotal": 123,
          "item_tax_total": 123,
          "original_total": 123,
          "original_subtotal": 123,
          "original_tax_total": 123,
          "total": 123,
          "subtotal": 123,
          "tax_total": 123,
          "discount_total": 123,
          "discount_tax_total": 123,
          "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": {},
          "requires_shipping": true,
          "is_discountable": true,
          "is_tax_inclusive": true,
          "unit_price": 123,
          "quantity": 123,
          "refundable_total": 123,
          "refundable_total_per_unit": 123,
          "variant": {
            "options": [
              {}
            ],
            "length": 123,
            "title": "<string>",
            "id": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "width": 123,
            "weight": 123,
            "height": 123,
            "origin_country": "<string>",
            "hs_code": "<string>",
            "mid_code": "<string>",
            "material": "<string>",
            "deleted_at": "2023-11-07T05:31:56Z",
            "sku": "<string>",
            "barcode": "<string>",
            "ean": "<string>",
            "upc": "<string>",
            "allow_backorder": true,
            "manage_inventory": true,
            "product": {},
            "metadata": {},
            "product_id": "<string>",
            "inventory_quantity": 123,
            "variant_rank": 123,
            "calculated_price": {}
          },
          "product": {
            "variants": [
              {}
            ],
            "options": [
              {}
            ],
            "images": [
              {}
            ],
            "length": 123,
            "title": "<string>",
            "status": "draft",
            "description": "<string>",
            "id": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "subtitle": "<string>",
            "thumbnail": "<string>",
            "handle": "<string>",
            "is_giftcard": true,
            "width": 123,
            "weight": 123,
            "height": 123,
            "origin_country": "<string>",
            "hs_code": "<string>",
            "mid_code": "<string>",
            "material": "<string>",
            "collection_id": "<string>",
            "type_id": "<string>",
            "discountable": true,
            "external_id": "<string>",
            "deleted_at": "2023-11-07T05:31:56Z",
            "collection": {},
            "categories": [
              {}
            ],
            "type": {},
            "tags": [
              {}
            ],
            "metadata": {}
          },
          "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>"
            }
          ],
          "compare_at_unit_price": 123
        },
        "quantity": 123,
        "fulfilled_quantity": 123,
        "delivered_quantity": 123,
        "shipped_quantity": 123,
        "return_requested_quantity": 123,
        "return_received_quantity": 123,
        "return_dismissed_quantity": 123,
        "written_off_quantity": 123,
        "metadata": {},
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "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": {
        "options": [
          {
            "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"
          }
        ],
        "length": 123,
        "title": "<string>",
        "id": "<string>",
        "width": 123,
        "weight": 123,
        "height": 123,
        "origin_country": "<string>",
        "hs_code": "<string>",
        "mid_code": "<string>",
        "material": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "deleted_at": "2023-11-07T05:31:56Z",
        "sku": "<string>",
        "barcode": "<string>",
        "ean": "<string>",
        "upc": "<string>",
        "allow_backorder": true,
        "manage_inventory": true,
        "thumbnail": "<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": {},
        "metadata": {},
        "product_id": "<string>",
        "inventory_quantity": 123,
        "variant_rank": 123,
        "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": {}
        }
      },
      "product": {
        "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",
        "variants": [
          {
            "options": [
              {
                "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"
              }
            ],
            "length": 123,
            "title": "<string>",
            "id": "<string>",
            "width": 123,
            "weight": 123,
            "height": 123,
            "origin_country": "<string>",
            "hs_code": "<string>",
            "mid_code": "<string>",
            "material": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "deleted_at": "2023-11-07T05:31:56Z",
            "sku": "<string>",
            "barcode": "<string>",
            "ean": "<string>",
            "upc": "<string>",
            "allow_backorder": true,
            "manage_inventory": true,
            "thumbnail": "<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": {},
            "metadata": {},
            "product_id": "<string>",
            "inventory_quantity": 123,
            "variant_rank": 123,
            "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": {}
            }
          }
        ],
        "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",
        "categories": [
          {}
        ],
        "type": {
          "id": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "value": "<string>",
          "metadata": {},
          "deleted_at": "2023-11-07T05:31:56Z"
        },
        "metadata": {},
        "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": [
            {}
          ]
        },
        "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": {}
          }
        ]
      },
      "compare_at_unit_price": 123,
      "tax_lines": [
        {
          "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": {},
            "requires_shipping": true,
            "is_discountable": true,
            "is_tax_inclusive": true,
            "unit_price": 123,
            "quantity": 123,
            "detail": {
              "id": "<string>",
              "item_id": "<string>",
              "item": {},
              "quantity": 123,
              "fulfilled_quantity": 123,
              "delivered_quantity": 123,
              "shipped_quantity": 123,
              "return_requested_quantity": 123,
              "return_received_quantity": 123,
              "return_dismissed_quantity": 123,
              "written_off_quantity": 123,
              "metadata": {},
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z"
            },
            "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,
            "variant": {
              "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": [
                {}
              ],
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z",
              "deleted_at": "2023-11-07T05:31:56Z",
              "inventory_quantity": 123,
              "variant_rank": 123,
              "product": {},
              "product_id": "<string>",
              "calculated_price": {},
              "metadata": {}
            },
            "product": {
              "id": "<string>",
              "title": "<string>",
              "handle": "<string>",
              "subtitle": "<string>",
              "description": "<string>",
              "is_giftcard": true,
              "status": "draft",
              "thumbnail": "<string>",
              "width": 123,
              "weight": 123,
              "length": 123,
              "height": 123,
              "origin_country": "<string>",
              "hs_code": "<string>",
              "mid_code": "<string>",
              "material": "<string>",
              "collection_id": "<string>",
              "type_id": "<string>",
              "variants": [
                {}
              ],
              "options": [
                {}
              ],
              "images": [
                {}
              ],
              "discountable": true,
              "external_id": "<string>",
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z",
              "deleted_at": "2023-11-07T05:31:56Z",
              "collection": {},
              "categories": [
                {}
              ],
              "type": {},
              "tags": [
                {}
              ],
              "metadata": {}
            },
            "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>"
              }
            ]
          },
          "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": {
            "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": {},
            "requires_shipping": true,
            "is_discountable": true,
            "is_tax_inclusive": true,
            "unit_price": 123,
            "quantity": 123,
            "detail": {
              "id": "<string>",
              "item_id": "<string>",
              "item": {},
              "quantity": 123,
              "fulfilled_quantity": 123,
              "delivered_quantity": 123,
              "shipped_quantity": 123,
              "return_requested_quantity": 123,
              "return_received_quantity": 123,
              "return_dismissed_quantity": 123,
              "written_off_quantity": 123,
              "metadata": {},
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z"
            },
            "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,
            "variant": {
              "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": [
                {}
              ],
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z",
              "deleted_at": "2023-11-07T05:31:56Z",
              "inventory_quantity": 123,
              "variant_rank": 123,
              "product": {},
              "product_id": "<string>",
              "calculated_price": {},
              "metadata": {}
            },
            "product": {
              "id": "<string>",
              "title": "<string>",
              "handle": "<string>",
              "subtitle": "<string>",
              "description": "<string>",
              "is_giftcard": true,
              "status": "draft",
              "thumbnail": "<string>",
              "width": 123,
              "weight": 123,
              "length": 123,
              "height": 123,
              "origin_country": "<string>",
              "hs_code": "<string>",
              "mid_code": "<string>",
              "material": "<string>",
              "collection_id": "<string>",
              "type_id": "<string>",
              "variants": [
                {}
              ],
              "options": [
                {}
              ],
              "images": [
                {}
              ],
              "discountable": true,
              "external_id": "<string>",
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z",
              "deleted_at": "2023-11-07T05:31:56Z",
              "collection": {},
              "categories": [
                {}
              ],
              "type": {},
              "tags": [
                {}
              ],
              "metadata": {}
            },
            "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>"
              }
            ]
          },
          "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>"
        }
      ]
    },
    "id": "<string>",
    "code": "<string>",
    "status": "pending",
    "value": 123,
    "currency_code": "usd",
    "customer_id": "<string>",
    "reference_id": "<string>",
    "note": "<string>",
    "reference": "<string>",
    "expires_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
connect.sid
string
cookie
required

Headers

​
x-publishable-api-key
string
required

Publishable API Key created in the Medusa Admin.

Path Parameters

​
idOrCode
string
required

The gift card's ID or code.

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.

Response

OK

The gift card's details.

​
gift_card
object
required

The gift card's details.