Get gift by id

Response body

object

companyId

string

The company id

campaignId

string

The campaign identifier

status

string

The status of the gift.

budgetPlan

number

The budget plan of the gift.

sendingMethod

string

Defaults to link

The sending method of the gift.

mail sms mailAndSms link

sendingChannels

array of strings

id

string

required

The gift identifier

tyn

string

A Thank You Note sent by the end client.

estimatedCost

object

The estimated cost of the gift including estimated tax and fee.

budget

number

required

The gift budget as defined in the campaign.

estimatedFee

number

required

The estimated fee cost according to the gift budget.

estimatedTax

number

required

The estimated tax cost according to the gift budget.

estimatedTotalCost

number

required

The estimated cost of the gift including tax and fee.

expirationDate

string

When the gift will be expired.
Date Format: YYYY-MM-DDThh:mm:ss.sZ.

createdAt

string

When the gift was originally created.
Date Format: YYYY-MM-DDThh:mm:ss.sZ. e.g. 2022-12-06T09:50:38.536Z

link

string

The link used to redeem the gift.

success

boolean

The success of the gift creation

deliveryDetails

object

The Delivery Details object.

carrier

string

required

The specific carrier for the claimed gift.

trackingNumber

string

required

The tracking number identifier.

status

string

required

The shipping status.

orderReceived processing inTransit outForDelivery delivered

trackingLink

string

required

A link to track the gift for the specific carrier.

deliveredAt

string

The date the gift was actually delivered by the carrier.
Date Format: YYYY-MM-DDThh:mm:ss.sZ.
Relevant only when the status is delivered

outForDelivery

string

The date the gift was sent out for delivery by the carrier.
Date Format: YYYY-MM-DDThh:mm:ss.sZ.
Relevant only when the status is 'outForDelivery'.

outForDeliveryDate

string

The date the gift was sent for delivery by the carrier.
Date Format: YYYY-MM-DDThh:mm:ss.sZ.
Relevant only when the status is 'outForDelivery'.

finalCost

object

The final cost of the gift including tax and fee.

cost

number

required

The actual cost of the specific gift that was chosen by the gift receiver.

finalFee

number

required

The final fee cost.

finalTax

number

required

The final tax cost according to the address provided by the gift receiver.

totalFinalCost

number

required

The final cost of the gift including tax and fee.

recipient

object

The Recipient object.

firstname

string

The first name of the recipient.

lastname

string

The last name of the recipient.

externalId

string

The id of the recipient in your own system.

phone

string

The phone number that the gift will be sent to.
('+' at the beginning is optional). Format: E.164.

email

string

The email address that the gift will be sent to.
This field is mandatory if you send gifts via 'mail' or 'mailAndSms'

key

string

An optional security UUID for the gift sending, used to avoid duplicated gifts sending to the same recipients when not intending to,
For example, if you implement a retry mechanism and want to avoid sending the same gift.

customization

object