Themes built on the Twig templating engine are now deprecated and require migration to Vitrin to ensure continued support and compatibility with Zid.

Add Gift Card

POST

{store_url}/api/v1/cart/gift-cards

Adds a gift card to the current shopping cart, including recipient details, optional message, and card design (URL-based or uploaded file).

This endpoint is typically used in gift card purchase flows, where customers personalize the gift before adding it to the cart.

Request

Body Params multipart/form-dataRequired

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --globoff '{store_url}/api/v1/cart/gift-cards' \
--form 'receiver_name="Ahmed Ali"' \
--form 'sender_name="Sara Ali"' \
--form 'media_link="https://example.com/video.mp4"' \
--form 'gift_message="Happy Birthday\! Enjoy your gift 🎉"' \
--form 'card_design="https://cdn.example.com/designs/card-1.png"' \
--form 'recipient_country_code="+966"' \
--form 'recipient_mobile="501234567"' \
--form 'card_design_file=@"custom_card.png"'

Responses

🟢201Success

application/json

Bodyapplication/json

Example

"Gift card added successfully"

🟠422Validation Error

🟠401Unauthorized

🔴500Internal Server error

Modified at 2026-02-19 10:43:45

Upload Cart Input Field

Remove Gift Card