Skip to content
EventPoint Developer Documentation

List project inventory

GET
/api/inventory/inventory-for-project
curl --request GET \
  --url https://api.eventpoint.io/api/inventory/inventory-for-project \
  --header 'x-api-key: <x-api-key>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
projectid
string format: uuid

The project identifier.

inventorydescriptorid
string format: uuid

The optional inventory descriptor identifier.

Responses

Section titled “Responses”

200

Section titled “200”

OK

object
page
null | integer | string format: int64
/^-?(?:0|[1-9]\d*)$/
itemsPerPage
null | integer | string format: int64
/^-?(?:0|[1-9]\d*)$/
continuationToken
null | string
cacheToken
null | string
count
integer | string format: int64
/^-?(?:0|[1-9]\d*)$/
numberOfPages
integer | string format: int64
/^-?(?:0|[1-9]\d*)$/
data
Array<object> | null
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
sort
null | string
sortDir
One of:
null
request
object
page
integer | string format: int64
/^-?(?:0|[1-9]\d*)$/
itemsPerPage
integer | string format: int64
/^-?(?:0|[1-9]\d*)$/
continuationToken
null | string
sort
null | string
sortDir
One of:
null
terms
null | string
categories
Array<string> | null
dateLow
null | string format: date-time
dateHigh
null | string format: date-time

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

404

Section titled “404”

Not Found

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