Skip to content
EventPoint Developer Documentation

List event inventory

GET
/api/events/{eventid}/inventory
curl --request GET \
  --url https://api.eventpoint.io/api/events/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/inventory \
  --header 'x-api-key: <x-api-key>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
eventid
required
string format: uuid

The event identifier.

Query Parameters

Section titled “Query Parameters”
inventoryTypeId
string format: uuid

The inventory type identifier.

Responses

Section titled “Responses”

200

Section titled “200”

OK

Array<object>
object
inventory
object
id
string format: uuid
created
string format: date-time
modified
string format: date-time
etag
null | string
projectId
string format: uuid
organizationId
null | string format: uuid
parentId
null | string format: uuid
topLevelId
string format: uuid
currentLevel
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
kind
string
status
Allowed values: None Available Reserved Purchased Hidden OutOfStock
name
null | string
code
null | string
description
null | string
url
null | string
isLocked
boolean
publish
boolean
openDate
null | string format: date-time
closeDate
null | string format: date-time
price
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
currency
null | string
quantity
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
numberRemaining
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
style
object
hasStyle
boolean
primaryColor
null | string
secondaryColor
null | string
backgroundColor
null | string
textColor
null | string
contrastColor
null | string
fontFamily
null | string
secondaryContrastColor
null | string
imageUrl
null | string
imageAssetId
null | string format: uuid
descriptors
null | string
meta
null | object
profileImages
object
defaultOriginal
null | string
defaultLarge
null | string
defaultMedium
null | string
defaultSmall
null | string
thumbnailSmall
null | string
thumbnailLarge
null | string
totalPaid
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
isTransferrable
boolean
canCancel
boolean
cancelByDate
null | string format: date-time
canAutoRefund
boolean
autoRefundByDate
null | string format: date-time
minutesAllowedInCart
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
preAllocated
boolean
amountPerToHio
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
amountPerToUser
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
numberReserved
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
numberUsed
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
requirePayment
boolean
maxItems
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
minItems
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
useSysPayment
boolean
paymentType
string
usePaymentCode
boolean
itemOrder
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
lineItemTemplate
null | string
type
object
id
string format: uuid
created
string format: date-time
modified
string format: date-time
etag
null | string
projectId
string format: uuid
organizationId
null | string format: uuid
name
null | string
description
null | string
publish
boolean
itemOrder
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
hasChecklist
boolean
meta
null | object
style
object
hasStyle
boolean
primaryColor
null | string
secondaryColor
null | string
backgroundColor
null | string
textColor
null | string
contrastColor
null | string
fontFamily
null | string
secondaryContrastColor
null | string
imageUrl
null | string
imageAssetId
null | string format: uuid
profileImages
object
defaultOriginal
null | string
defaultLarge
null | string
defaultMedium
null | string
defaultSmall
null | string
thumbnailSmall
null | string
thumbnailLarge
null | string
details
object
id
string format: uuid
created
string format: date-time
modified
string format: date-time
etag
null | string
projectId
string format: uuid
eventId
string format: uuid
inventoryId
string format: uuid
typeId
null | string format: uuid
status
Allowed values: None Available Reserved Purchased Hidden OutOfStock
isLocked
boolean
publish
boolean
openDate
null | string format: date-time
closeDate
null | string format: date-time
price
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
currency
null | string
quantity
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
numberRemaining
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
itemOrder
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detailsDifferentThanMain
boolean
mainControlsAttributes
boolean
totalPaid
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
isTransferrable
boolean
canCancel
boolean
cancelByDate
null | string format: date-time
canAutoRefund
boolean
autoRefundByDate
null | string format: date-time
minutesAllowedInCart
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
preAllocated
boolean
amountPerToHio
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
amountPerToUser
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
numberReserved
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
numberUsed
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
requirePayment
boolean
maxItems
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
minItems
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
useSysPayment
boolean
paymentType
string
usePaymentCode
boolean
lineItemTemplate
null | string
settings
object
amountPerToHio
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
amountPerToUser
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
closeDate
null | string format: date-time
price
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
currency
null | string
isLocked
boolean
isTransferrable
boolean
canCancel
boolean
canAutoRefund
boolean
cancelByDate
null | string format: date-time
autoRefundByDate
null | string format: date-time
numberUsed
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
numberReserved
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
numberRemaining
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
openDate
null | string format: date-time
projectId
string format: uuid
publish
boolean
quantity
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
preAllocated
boolean
status
Allowed values: None Available Reserved Purchased Hidden OutOfStock
totalPaid
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
maxItems
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
minItems
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
lineItemTemplate
null | string

403

Section titled “403”

Forbidden

object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string