Skip to main content
GET
/
open-api
/
v1.0
/
gift-purchase
/
{giftPurchaseId}
Get gift purchase by id
curl --request GET \
  --url https://api.fourthwall.com/open-api/v1.0/gift-purchase/{giftPurchaseId} \
  --header 'Authorization: Basic <encoded-value>'
{ "id": "giv_EdJvIXu3SEiXe_QkPavHSA", "friendlyId": "D3XZFWPP", "shopId": "sh_c689d374-22ca-43d3-8d29-9ef0805cc4cb", "offer": { "id": "00aa4abd-5778-4199-8161-0b49b2f212e5", "name": "My t-shirt", "slug": "my-t-shirt", "description": "My t-shirt description", "primaryImage": { "id": "00aa4abd-5778-4199-8161-0b49b2f212e5", "url": "https://fourthwall.com/image.png", "width": 800, "height": 600, "transformedUrl": "https://fourthwall.com/image.png" } }, "amounts": { "subtotal": { "value": 10, "currency": "USD" }, "tax": { "value": 10, "currency": "USD" }, "total": { "value": 10, "currency": "USD" }, "profit": { "value": 10, "currency": "USD" }, "prepaidShipping": { "value": 10, "currency": "USD" } }, "email": "supporter@fourthwall.com", "quantity": 123, "gifts": [ { "id": "gft_EdJvIXu3SEiXe_QkPavHSA", "orderId": "00aa4abd-5778-4199-8161-0b49b2f212e5", "orderFriendlyId": "D3XZFWPP", "winner": { "selectedAt": "2020-08-13T09:05:36.939Z", "email": "supporter@fourthwall.com", "username": "Johnny123" }, "status": "<string>" } ], "createdAt": "2023-11-07T05:31:56Z", "username": "Johnny123", "message": "Sample message" }

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

​
giftPurchaseId
string
required

Response

OK

​
id
string
required
Example:

"giv_EdJvIXu3SEiXe_QkPavHSA"

​
friendlyId
string
required
Example:

"D3XZFWPP"

​
shopId
string
required
Example:

"sh_c689d374-22ca-43d3-8d29-9ef0805cc4cb"

​
offer
Offer Gift Purchase · object
required
​
amounts
Amounts · object
required
​
email
string
required
Example:

"supporter@fourthwall.com"

​
quantity
integer<int32>
required
​
gifts
Available · object · Available · object · Available · object · Available · object · Cancelled · object · Changed To Promotion · object · Redeemed · object[]
required
​
createdAt
string<date-time>
required
​
username
string
Example:

"Johnny123"

​
message
string
Example:

"Sample message"