Send a gift card to 1 or more recipients. [Authenticated; Perm: System Integrator]

post

https://qa-api.giftlocal.com/api/integration/gifting/send-gift

The endpoint assumes payment was captured externally.

This endpoint can also be used to simply generate a gift card code without delivery by setting the delivery method to 3 (our indicator for hand delivered gifts).

The request object is used by several of our APIs - but this particular endpoint enforces an External Transaction paymentMethodID (2) and requires supplying the externalTransaction fields and externalStorefrontID.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

externalStorefrontID

uuid

For external transactions from integrators - a storefront ID must be specified for non-promotional gifts.

externalTransactionCustomerEmailAddress

string

For external transactions, the customer's email address.

externalTransactionCustomerFirstName

string

For external transactions, the customer's first name.

externalTransactionCustomerLastName

string

For external transactions, the customer's last name.

externalTransactionReferenceNumber

string

A reference number of an external transaction that was used to pay for these gifts.

itemGift

object

A simplied request objects used in the API for creating gifted items.

monetaryGift

object

A simplied request objects used in the API for creating gift cards.

notes

string

Notes explaining why this gift(s) were sent.

paymentMethodID

int32

How these gifts will be "paid" for.

promotionalTerms

string

For promotional gifts - any related terms.

promotionID

uuid

For promotional gifts - a promotion ID must be specified.

recipients

array of objects

recipients

relatedOrderID

uuid

A related Order ID - when related to an existing Order. Either the ID or Number can be specified. Preference given to ID if both are provided.

relatedOrderNumber

string

A related Order Number - when related to an existing Order. Either the ID or Number can be specified. Preference given to ID if both are provided.

senderDescription

string

Sender description. Will default to the account name.

validForDays

int32

For promotional gifts - the number of days after the start date the gift is good for.

validStarting

date-time

For promotional gifts - when the gift is valid starting. Will default to beginning of today - location local time.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

200OK