Skip to main content
POST
/
store
/
carts
/
{id}
/
gift-cards
cURL
curl -X POST '{backend_url}/store/carts/{id}/gift-cards' \
-H 'x-publishable-api-key: {your_publishable_api_key}' \
-H 'Content-Type: application/json' \
--data-raw '{
  "code": "{value}"
}'
{ "cart": { "id": "<string>", "currency_code": "usd", "original_item_total": 123, "original_item_subtotal": 123, "original_item_tax_total": 123, "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, "gift_card_total": 123, "gift_card_tax_total": 123, "shipping_total": 123, "shipping_subtotal": 123, "shipping_tax_total": 123, "original_shipping_total": 123, "original_shipping_subtotal": 123, "original_shipping_tax_total": 123, "promotions": [ { "id": "<string>", "code": "<string>", "is_automatic": true, "application_method": { "value": "<string>", "type": "fixed", "currency_code": "<string>" } } ], "region": { "id": "<string>", "name": "<string>", "currency_code": "usd", "automatic_taxes": true, "countries": [ { "id": "<string>", "iso_2": "us", "iso_3": "usa", "num_code": 840, "name": "<string>", "display_name": "<string>" } ], "payment_providers": [ { "id": "<string>", "is_enabled": true } ], "metadata": {}, "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z" }, "region_id": "<string>", "customer_id": "<string>", "sales_channel_id": "<string>", "email": "jsmith@example.com", "shipping_address": { "id": "<string>", "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "customer_id": "<string>", "first_name": "<string>", "last_name": "<string>", "phone": "<string>", "company": "<string>", "address_1": "<string>", "address_2": "<string>", "city": "<string>", "country_code": "us", "province": "us-ca", "postal_code": "<string>", "metadata": {} }, "billing_address": { "id": "<string>", "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "customer_id": "<string>", "first_name": "<string>", "last_name": "<string>", "phone": "<string>", "company": "<string>", "address_1": "<string>", "address_2": "<string>", "city": "<string>", "country_code": "us", "province": "us-ca", "postal_code": "<string>", "metadata": {} }, "items": [ { "id": "<string>", "title": "<string>", "quantity": 123, "requires_shipping": true, "is_discountable": true, "is_tax_inclusive": true, "unit_price": 123, "cart": {}, "cart_id": "<string>", "subtitle": "<string>", "thumbnail": "<string>", "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": {} } ] }, "product_id": "<string>", "product_title": "<string>", "product_description": "<string>", "product_subtitle": "<string>", "product_type": "<string>", "product_collection": "<string>", "product_handle": "<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": {} } }, "variant_id": "<string>", "variant_sku": "<string>", "variant_barcode": "<string>", "variant_title": "<string>", "variant_option_values": { "Color": "Red" }, "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, "cart_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>" } ], "metadata": {}, "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "deleted_at": "2023-11-07T05:31:56Z", "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 } ], "shipping_methods": [ { "id": "<string>", "cart_id": "<string>", "name": "<string>", "amount": 123, "is_tax_inclusive": true, "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "description": "<string>", "shipping_option_id": "<string>", "data": {}, "metadata": {}, "tax_lines": [ { "shipping_method": {}, "shipping_method_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": [ { "shipping_method": {}, "id": "<string>", "amount": 123, "cart_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>" } ], "original_total": 123, "original_subtotal": 123, "original_tax_total": 123, "total": 123, "subtotal": 123, "tax_total": 123, "discount_total": 123, "discount_tax_total": 123 } ], "payment_collection": { "id": "<string>", "currency_code": "<string>", "amount": 123, "status": "canceled", "payment_providers": [ { "id": "<string>" } ], "authorized_amount": 123, "captured_amount": 123, "refunded_amount": 123, "completed_at": "2023-11-07T05:31:56Z", "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "metadata": {}, "payment_sessions": [ { "id": "<string>", "amount": 123, "currency_code": "usd", "provider_id": "<string>", "data": {}, "status": "authorized", "context": { "customer": { "id": "cus_123" } }, "authorized_at": "2023-11-07T05:31:56Z", "payment_collection": {}, "payment": { "id": "<string>", "amount": 123, "currency_code": "<string>", "provider_id": "<string>", "authorized_amount": 123, "data": {}, "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "captured_at": "2023-11-07T05:31:56Z", "canceled_at": "2023-11-07T05:31:56Z", "captured_amount": 123, "refunded_amount": 123, "captures": [ { "id": "<string>", "amount": 123, "created_at": "2023-11-07T05:31:56Z", "payment": {}, "created_by": "<string>" } ], "refunds": [ { "id": "<string>", "amount": 123, "created_at": "2023-11-07T05:31:56Z", "payment": {}, "refund_reason_id": "<string>", "note": "<string>", "created_by": "<string>", "refund_reason": { "id": "<string>", "label": "<string>", "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "code": "<string>", "description": "<string>", "metadata": {} } } ], "payment_collection": {}, "payment_session": {} } } ], "payments": [ { "id": "<string>", "amount": 123, "currency_code": "<string>", "provider_id": "<string>", "authorized_amount": 123, "data": {}, "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "captured_at": "2023-11-07T05:31:56Z", "canceled_at": "2023-11-07T05:31:56Z", "captured_amount": 123, "refunded_amount": 123, "captures": [ { "id": "<string>", "amount": 123, "created_at": "2023-11-07T05:31:56Z", "payment": {}, "created_by": "<string>" } ], "refunds": [ { "id": "<string>", "amount": 123, "created_at": "2023-11-07T05:31:56Z", "payment": {}, "refund_reason_id": "<string>", "note": "<string>", "created_by": "<string>", "refund_reason": { "id": "<string>", "label": "<string>", "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "code": "<string>", "description": "<string>", "metadata": {} } } ], "payment_collection": {}, "payment_session": {} } ] }, "metadata": {}, "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "completed_at": "2023-11-07T05:31:56Z" } }

Headers

​
x-publishable-api-key
string
required

Publishable API Key created in the Medusa Admin.

Path Parameters

​
id
string
required

The cart's ID.

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 to add a gift card to the cart.

​
code
string
required

The gift card's code.

Response

OK

The cart's details.

​
cart
object
required

The cart's details.