List gifts with filters

GET

/v2/gifts

const url = 'https://api-crm-staging.divinea.com/api/v2/gifts?count=10&excludeStates=draft&page=0&sortBy=createdAt%2CDESC&wineryId=example';
const options = {method: 'GET', headers: {APIKey: '<APIKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api-crm-staging.divinea.com/api/v2/gifts?count=10&excludeStates=draft&page=0&sortBy=createdAt%2CDESC&wineryId=example' \
  --header 'APIKey: <APIKey>'

Authorizations

ApiKey

Parameters

Query Parameters

beneficiaryName

string

Name of Beneficiary

buyerName

string

Name of Buyer

contactId

integer format: int64

Contact identifier

count

integer format: int32

default: 10

Items per page (default 10)

createdAt

string format: date

createdUntil

string format: date

excludeStates

Array<string>

Allowed values: draft paid rejected redeemed expired

Excluded States of Gift (It’s the not in)

experienceDate

string format: date

experienceDateEnd

string format: date

experienceId

Array<string>

List of experiences Id

expirationDate

string format: date

expirationDateEnd

string format: date

giftId

string

Gift identifier

integer format: int64

lang

string

Sorting language

page

integer format: int32

Page (starting from 0)

redemptionDate

string format: date

redemptionDateEnd

string format: date

sortBy

string

default: createdAt,DESC

Sort String (default ‘createdAt,DESC’)

wineryId

required

string

Winery identifier

Responses

200

*/*

Page«GiftDTO»

object

content

Array<object>

GiftDTO

object

aasmState

string

Allowed values: draft paid rejected redeemed expired

adults

integer format: int32

amountCents

integer format: int32

amountCurrency

string

beneficiaryEmail

string

beneficiaryFirstname

string

beneficiaryLastname

string

beneficiaryNotified

boolean

beneficiaryNotifyAt

string format: date

children

integer format: int32

contactId

integer format: int64

createdAt

string format: date-time

defaultMinParties

integer format: int32

email

string

experiencePriceLabels

Array<object>

Map«string,object»

object

key

additional properties

object

expiresAt

string format: date

extraData

object

firstname

string

giftId

string format: uuid

integer format: int64

lastname

string

message

string

phone

string

redemptionDate

string format: date-time

reservationId

string format: uuid

updatedAt

string format: date-time

wineryId

string format: uuid

empty

boolean

first

boolean

last

boolean

number

integer format: int32

numberOfElements

integer format: int32

pageable

Pageable

object

offset

integer format: int64

pageNumber

integer format: int32

pageSize

integer format: int32

paged

boolean

sort

Sort

object

empty

boolean

sorted

boolean

unsorted

boolean

unpaged

boolean

size

integer format: int32

sort

Sort

object

empty

boolean

sorted

boolean

unsorted

boolean

totalElements

integer format: int64

totalPages

integer format: int32