Skip to main content
GET
/
api
/
campaigns
/
gifts
/
{giftId}
Get a gift by ID
curl --request GET \
  --url https://apiv1.delightloop.ai/api/campaigns/gifts/{giftId} \
  --header 'x-api-key: <x-api-key>'
{
  "giftId": "<string>",
  "organizationId": "<string>",
  "name": "<string>",
  "price": 123,
  "currency": "<string>",
  "inventory": {
    "total": 123,
    "available": 123,
    "reserved": 123
  },
  "status": "available",
  "isDelightloop": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "shortDescription": "<string>",
  "description": "<string>",
  "imageUrls": [
    "<string>"
  ],
  "dimensions": {
    "height": 123,
    "width": 123,
    "length": 123,
    "unit": "inch"
  },
  "weight": {
    "weight": 123,
    "unit": "pound"
  }
}

Headers

x-api-key
string
required

auth key

Path Parameters

giftId
string
required

Gift ID

Response

Gift retrieved successfully

giftId
string
required

Gift ID

organizationId
string
required

Organization ID

name
string
required

Gift name

price
number
required

Price of the gift

currency
string
required

Currency code

inventory
object
required

Inventory details

status
enum<string>
required

Gift status

Available options:
available,
pending,
in_transit,
delivered
isDelightloop
boolean
required

Whether this is a Delightloop gift

createdAt
string<date-time>
required

Creation date

updatedAt
string<date-time>
required

Last update date

shortDescription
string

Short description of the gift

description
string

Detailed description of the gift

imageUrls
string[]

Array of image URLs

dimensions
object

Gift dimensions

weight
object

Gift weight