List All GiftCards

Request a list of all giftcards available for a given client/cart(request).


REQUEST BODY

Name Type Mandatory Description
cart object Yes
id string
grandTotal number
relationName string
redemptionCode string Minimum of six characters
discounts number
shipping number
taxes number
items array
     ↳ productId string
     ↳ id string
     ↳ refId string
     ↳ name string
     ↳ price number
     ↳ sellingPrice number
     ↳ sellerId string
     ↳ quantity integer
     ↳ totalShippingDiscount number
     ↳ totalDiscount number
     ↳ components object (item)
     ↳ sellerChain array of string
payments array
     ↳ paymentSystem string
     ↳ name string
     ↳ referenceValue number
     ↳ value number
     ↳ bin string
     ↳ lastDigits string
sc string Sales channel
itemsTotal number
shippingData object
     ↳ receiverName string
     ↳ postalCode string
     ↳ city string
     ↳ state string
     ↳ country string
     ↳ street string
     ↳ number string
     ↳ neighborhood string
     ↳ complement string
     ↳ reference string
client object Yes
id string
email string
name string
ip string
userAgent string
document string
documentType string
corporateName string
tradeName string
corporateDocument string

RESPONSE

RESPONSE HEADERS
Name Mandatory Example Obs
REST-Content-Range Yes resources 0-1/5 Must follow the format resources {from}-{to}/{total}

RESPONSE BODY (array of)

GIFT CARD SUMMARY OBJECTS

Name Type Mandatory Description
id string Yes Gift card id
provider string Yes provider name
balance number Yes Gift card current balance
totalBalance number
relationName string Represents the relationship between the client and the store
caption string The caption of the card
groupName string
_self object Yes
href string Yes Resource URL (see example)
Language
Authentication
URL
Click Try It! to start a request and see the response here!