eBay · Schema

GiftDetails

This type contains information about a digital gift card line item that was purchased as a gift and sent to the recipient by email.

Note: GiftDetails will not be returned for any order that is more than 90 days old.

AuctionsCommerceProductsMarketplaceFortune 500

Properties

Name Type Description
message string This field contains the gift message from the buyer to the gift recipient. This field is only returned if the buyer of the gift included a message for the gift.

recipientEmail string The email address of the gift recipient. The seller will send the digital gift card to this email address.

Note: The recipientEmail will not be r
senderName string The name of the buyer, which will appear on the email that is sent to the gift recipient.

Note: The senderName will not be returned for any order
View JSON Schema on GitHub

JSON Schema

ebay-giftdetails-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GiftDetails",
  "title": "GiftDetails",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "This field contains the gift message from the buyer to the gift recipient. This field is only returned if the buyer of the gift included a message for the gift.<br><br><span class=\"tablenote\"><strong>Note:</strong> The <b>message</b> will not be returned for any order that is more than 90 days old.</span>"
    },
    "recipientEmail": {
      "type": "string",
      "description": "The email address of the gift recipient. The seller will send the digital gift card to this email address.<br><br><span class=\"tablenote\"><strong>Note:</strong> The <b>recipientEmail</b> will not be returned for any order that is more than 90 days old.</span>"
    },
    "senderName": {
      "type": "string",
      "description": "The name of the buyer, which will appear on the email that is sent to the gift recipient.<br><br><span class=\"tablenote\"><strong>Note:</strong> The <b>senderName</b> will not be returned for any order that is more than 90 days old.</span>"
    }
  },
  "description": "This type contains information about a digital gift card line item that was purchased as a gift and sent to the recipient by email.<br><br><span class=\"tablenote\"><strong>Note:</strong> <b>GiftDetails</b> will not be returned for any order that is more than 90 days old.</span>"
}