Skip to main content

CartResponse

success boolean

Indicates whether the request was processed successfully

message string

Additional message or error information

checkout_url string

URL for the checkout page where the customer can complete the purchase of the gift cards in the cart

checkout_url_accessed boolean

Indicates whether the checkout URL has been accessed for this cart

data object
cart_id uuid

Unique identifier of the gift cart

partner_id string

Identifier of the gift card provider partner

gift_cards object[]

List of gift cards in the cart

  • Array [
  • gift_card_id uuid

    Unique identifier of the gift card

    delivery_type string

    Specifies how the purchaser intends to deliver the gift card to the recipient.

    redemption_method string

    Method used to redeem the gift card

    recipient_name string

    Name of the gift card recipient

    recipient_email email

    Email address of the recipient

    recipient_phone_number string

    Phone number of the recipient

    sender_name string

    Name of the sender

    sender_email email

    Email address of the sender

    custom_message string

    Custom message attached to the gift card

    value number

    Monetary value of the gift card (in cents).

    search_provider string

    Provider used to search for the business

    card_program string

    Gift card program name

    business_id string

    Identifier of the associated business

  • ]
  • CartResponse
    {
    "success": true,
    "message": "string",
    "checkout_url": "string",
    "checkout_url_accessed": true,
    "data": {
    "cart_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "partner_id": "string",
    "gift_cards": [
    {
    "gift_card_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "delivery_type": "string",
    "redemption_method": "string",
    "recipient_name": "string",
    "recipient_email": "user@example.com",
    "recipient_phone_number": "string",
    "sender_name": "string",
    "sender_email": "user@example.com",
    "custom_message": "string",
    "value": 0,
    "search_provider": "string",
    "card_program": "string",
    "business_id": "string"
    }
    ]
    }
    }