Represents the inventory specification.
KEY | TYPE | NULL/EMPTY | DESCRIPTION |
---|---|---|---|
startDateTime | string | no | Start local date time for the inventory. This may even specify the opening local date time for the variant. Format: fm-date-time. Ref: inventory.startDateTime |
endDateTime | string | no | End local date time for the inventory. This may even specify the closing local date time for the variant. Format: fm-date-time. Ref: inventory.endDateTime |
availability | enum | no | Specifies the type of availability for the inventory. enum: LIMITED, UNLIMITED, CLOSED . Ref: inventory.availability |
remaining | int | no | The total number of seats left which can be booked for this inventory. |
pricing | pricing |
no | The pricing specifiction for the inventory. |
This denotes the start time of the inventory for the variant concerned, if the variant has an inventoryType
of FIXED_START_FIXED_DURATION
or FIXED_START_FLEXIBLE_DURATION
.
If the inventoryType
is FLEXIBLE_START_FIXED_DURATION
or FLEXIBLE_START_FLEXIBLE_DURATION
, then it means that the variant does not have a fixed start time ever. In such a case this can be interpreted as the opening time for the variant's inventory. For eg: Disneyland will have an inventoryType
of FLEXIBLE_START_FLEXIBLE_DURATION
and it's startDateTime
will be 8:00am which signifies it's opening time. If this inventory is bought, the customer can still enter after 8:00am.
Ref: product-variant.inventoryType
This denotes the end time of the inventory for the variant concerned, if the variant has an inventoryType
of FIXED_START_FIXED_DURATION
.
If the inventoryType
is FIXED_START_FLEXIBLE_DURATION
, FLEXIBLE_START_FIXED_DURATION
or FLEXIBLE_START_FLEXIBLE_DURATION
, then it means that the variant does not have a fixed end time ever. In such a case this can be interpreted as the closing time for the variant's inventory. For eg: A Hot-air balloon ride might have an inventoryType
of FLEXIBLE_START_FIXED_DURATION
and it's endDateTime
will be 7:00pm which signifies it's end time. If this inventory is bought, the customer can enter anytime after the startDateTime
and before endDateTime
the the hot air balloon ride being of fixed duration.
Ref: product-variant.inventoryType
LIMITED
: Specifies that there is limited availability for this inventory and the remaining seats can be fetched frominventory.remaining
UNLIMITED
: Specifies that there is unlimited availability for this inventory and can be booked any number of times.CLOSED
: Specified that the inventory is closed.
KEY | TYPE | NULL/EMPTY | DESCRIPTION |
---|---|---|---|
persons | array[pricing-person ] |
yes | Specifies the specification for per person pricing. This is non-empty only if priceType for the variant of the inventory is PER_PERSON . Ref: product-variant.priceType |
groups | array[pricing-group ] |
yes | Specifies the specification for per person pricing. This is non-empty only if priceType for the variant of the inventory is PER_GROUP . Ref: product-variant.priceType |
Specifies the specification for per person pricing. This is only applicable for PER_PERSON
price types.
KEY | TYPE | NULL/EMPTY | DESCRIPTION |
---|---|---|---|
type | string | no | The person type. Eg: ADULT , CHILD etc. |
name | string | no | The displayable name for the person. Ex: Adult , Child , Senior |
ageFrom | int | yes | The minimum age for the type. If this not specified then there is no minimum age. |
ageTo | int | yes | The maximum age for the type. If this is not specified then there is no macimum age. |
price | float | no | The price payable for this type. |
originalPrice | float | no | The original (retail) price of for this type |
Specifies the specification for per group pricing. This is only applicable for PER_GROUP
price types.
KEY | TYPE | NULL/EMPTY | DESCRIPTION |
---|---|---|---|
size | int | no | The upper bound of the size of this group. The lower bound is the next lowest size overall from this size plus 1. |
price | float | no | The price payable for this type. |
originalPrice | float | no | The original (retail) price for this type |
(Assume all currency is in dollars)
size=4, price=100, originalPrice=120
means headout price for 1-4 persons is 100$ while retail price is $120 (i.e. 20% discount)size=7, price=120, originalPrice=120
means headout price for 1-7 people is 120$ and is same as retail price (no discount)