openapi: 3.0.3 info: title: api.rezio.io version: 1.0.0 description: "## Version\n\n中文版 Traditional Chinese
\n英文版 English\n\n## Overview\n\nRezio API allows you to read and possibly write resources linked to your Rezio account. `V1` provides the following operations:
\n\n\n\n## API\n\nRezio API is a REST based API that supports JSON formats. You must include Content-Type headers in your requests.
\n\n> `Content-Type` : application/json
\n> `X-Lang` : default language is `en`. Check other options in System Config::language
\n> `X-Auth-StoreUuid` : Your Store UUID in [Rezio](https://www.rezio.io). Available from [Admin](https://admin.rezio.io).
\n> `X-Auth-Key` : Your API Key. Obtain in [Rezio Admin](https://admin.rezio.io/myplan/token) if you are an administrator.\n\n### Versioning\n\nYou must include the version in the URL you're calling. The current version is `V1`
\n\n> `https://api.rezio.io/v1/product/list`\n\n### API Response\n\nThe API response is in **application/json** format. `code`, `codeMessage`, `data` and **UTF-8** should be used for all content encoding.\n\n```javascript\n{\n \"code\": \"S0000\",\n \"codeMessage\": \"\",\n \"data\": {}\n}\n```\n\nYou can expect the `code` of **S0000** as SUCCESS call; otherwise, please check `data` result and Response Codes.
\n\n### Environments\n\n+ We have both UAT and Production environments. Use UAT environment to test your integration to make sure it is ready before connecting to the Production server.\n\n+ Production and UAT environments are currently completely independent. Accounts and data are not replicated, so you will need to get Store UUID/ Key separately from Admin.\n\n+ Only `HTTPS` accepted, non-SSL port is not available. \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
EnvironmentAdmin URLAPI_URL
UAThttps://admin.uat.rezio.io/https://api.uat.rezio.io/
Productionhttps://admin.rezio.io/https://api.rezio.io/
\n\n### Response codes\n\n Possible response codes that may occur.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Response codeMeaning
service
S0000SUCCESS
A0006Missing verification parameters in the request body.
V0001Parameters were not included in the request.
V0002The format of parameters was not matched.
V0003Parameters were incomplete.
V0004The value of parameter was out of range.
V0005The length of parameters was exceeded.
V0006Illegal operation. There is a discontinuous time slot in one of your cancellation rules.
F0001Error result: {{result}}
" servers: - url: https://api.rezio.io description: Production - url: https://api.uat.rezio.io description: UAT paths: /v1/config: get: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string data: type: object properties: serverTime: type: string unixTimestamp: type: number version: type: string language: type: array items: type: object properties: uuid: type: string code: type: string label: type: string required: - uuid - code - label storeAcceptPayType: type: array items: type: object properties: value: type: number config: type: string required: - value - config dataOption: type: array items: type: string example: code: S0000 codeMessage: SUCCESS data: serverTime: '2019-05-14T06:28:47+00:00' unixTimestamp: 1557815327 version: v1 language: - uuid: 30eee82e-eccb-430b-9774-9a231a5f6b51 code: zh-TW label: Traditional Chinese - uuid: b13c043d-eace-400e-bb9c-ca342f1bb1f7 code: ja-JP label: Japanese - uuid: affd2a03-556b-43e5-b64b-022c0abd298f code: en label: English - uuid: 3a76a467-7629-455e-8fd4-d88bb041a9ea code: zh-CN label: Simplified Chinese storeAcceptPayType: - value: 1 config: 'Please transfer money to the following account: Bank: CTBC Bank code: 808 Account name: Rezio tour inc. Number: 550888066666 Please call or send email to inform us to make sure your money transfer succeed, thank you!' - value: 2 config: On site cash payment is fine, TW/US Dollar are accepted, and you will need to pay the full amount before the tour begins, thank you! dataOption: - category - country - countryAll - currency - language - languageAll - languageSpoken - timezone - region - identity - resourceType - feeOption - feeOptionGroup - tag summary: System Config operationId: get-v1-config description: "Get all Rezio API's config\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/config
HTTP MethodGET
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n#### Parameters\n\nNone\n\n#### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
dataobjectResponse data, check data for details
\n\n##### *data*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
serverTimedatetimeServer Time with timezone
unixTimestampunixtimeServer Unixtime
versionstringAPI version number
languagearraylanguage, check language for details
storeAcceptPayTypearrayAccepted Payment
\n 1: Bank Transfers/ATM
\n 2: Cash
dataOptionarraySystem Data options:
\n category Product Category
\n currency Currency
\n region Region/Continent
\n country Available Countries to Create Product
\n countryAll Countries
\n identity Identity, for pricing, e.g., Adult
\n timezone Timezone
\n resourceType Resource Type
\n languageAll Languages
\n languageSpoken Spoken Languages
\n feeOption Fee Options
\n feeOptionGroup Fee Options Group
\n tag Tags
\n landmark Landmarks\n
\n\n##### *language*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringLanguage code
labelstringLanguage name
" tags: - System Parameters /v1/dataOption: get: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string data: type: object properties: option: type: string list: type: array items: type: object properties: uuid: type: string code: type: string label: type: string symbol: type: string required: - uuid - code - label - symbol example: code: S0000 codeMessage: SUCCESS data: option: currency list: - uuid: b5317f07-b5a0-4525-8ff7-3fe55b4d96ec code: USD label: USD US Dollar symbol: $ - uuid: 5673fd73-41d8-4464-be9f-7bc9776301ab code: JPY label: JPY Japanese Yen symbol: ¥ - uuid: b5317f07-b5a0-4525-8ff7-3fe55b4d96ec code: TWD label: TWD Taiwan Dollar symbol: $ summary: System Data Option operationId: get-v1-dataOption description: "Get all Rezio API's Data options\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/dataOption
HTTP MethodGET
ParametersQuery string
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
optionstringYData options
\n Check /v1/config dataOption for details\n
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
dataobjectResponse data, check data for details
\n\n##### *data*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
optionstringData option name
listarrayAvailable options
\n If you request option=tag, check tag for details.
\n Other options, please check list for more detail.
\n\n##### *list*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
uuidUUIDOption UUID
codestringCode, available for language/country/countryAll/currency
labelstringOption name, language was presented by X-Lang: {Lang} in Headers.
symbolstringCurrency symbol, only available for currency
regionUuidUUIDRegion UUID, only available for country/countryAll
feeOptionGroupUuidUUIDFee Option group UUID, only available for feeOption
\n\n##### *tag*\n\nIf there is no tag suitable for you, please customize your tags on [Rezio Admin](https://admin.rezio.io/).\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
tagGroupUuidUUIDTag Group UUID
tagGroupLabelstringTag group name
maxSelectedCountintThe maximum value in the same tag group, and -1 is unlimited.
tagsarrayTag data, includes UUID and label name, check tags for details.
\n\ \n##### *tag - tags*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
uuidUUIDTag UUID
labelstringTag name, language was presented by X-Lang: {Lang} in Headers.
" tags: - System Parameters parameters: - name: option in: query description: System Data options required: true example: currency schema: type: string /v1/setting/pricePolicy: get: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string data: type: object properties: totalCount: type: number page: type: number itemPerPage: type: number list: type: array items: type: object properties: uuid: type: string label: type: string currencyUuid: type: string type: type: string config: type: array items: type: object properties: identityUuid: type: string isGroup: type: number from: type: number to: type: number cost: type: number originalPrice: type: number price: type: number required: - identityUuid - isGroup - from - to - cost - originalPrice - price bindingSalesOptionCnt: type: number required: - uuid - label - currencyUuid - type - config - bindingSalesOptionCnt example: code: S0000 codeMessage: SUCCESS data: totalCount: 2 page: 1 itemPerPage: 20 list: - uuid: 66457454-6730-470a-9926-a8e2a19d8cbe label: Day Tour - Weekend departures currencyUuid: b5317f07-b5a0-4525-8ff7-3fe55b4d96ec type: PERSON config: - identityUuid: d6871da2-c391-468e-ad9b-f8d5148fe0cd isGroup: 0 from: 3 to: 99 cost: 37.99 originalPrice: 37.99 price: 37.99 - identityUuid: 175087ec-03a7-4aa4-a288-29f65bb8966e isGroup: 0 from: 0 to: 2 cost: 6 originalPrice: 6 price: 6 bindingSalesOptionCnt: 1 - uuid: 33a6058e-232c-4fb1-9169-9607827d5614 label: Day Tour - Weekday departures currencyUuid: b5317f07-b5a0-4525-8ff7-3fe55b4d96ec type: PERSON config: - identityUuid: d6871da2-c391-468e-ad9b-f8d5148fe0cd isGroup: 0 from: 3 to: 99 cost: 29.99 originalPrice: 29.99 price: 29.99 - identityUuid: 175087ec-03a7-4aa4-a288-29f65bb8966e isGroup: 0 from: 0 to: 2 cost: 6 originalPrice: 6 price: 6 bindingSalesOptionCnt: 1 summary: List Pricing Policy operationId: get-v1-setting-pricePolicy description: "List all existing pricing policies. Filters such as currency are available.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/setting/pricePolicy
HTTP MethodGET
ParametersQuery string
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters- Query string\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
labelstring-Pricing policy name
currencystring/ UUID-Currency
\n Accept ISO-4217 Code or Rezio Currency UUID
\n Check/getDataOption?option=currency to get code/ UUID\n
typestring-Charge type
\n PERSON Charge by person
\n ITEM Charge by item\n
pageint-Pages. Default/minimum value is 1
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
dataobjectResponse data, check data for details
\n\n##### *data*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
totalCountintRecord counts
pageintCurrent page number
itemPerPageintRecord counts per page. Default/maximum value is 20
listarrayPricing policy data, check list for details
\n\n##### *list*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\ \ \n \n \n \n \n
NameTypeDescription
uuidUUIDPricing Policy UUID
labelstringName
currencyUuidUUIDCurrency UUID
\n Accept Rezio Currency UUID
\n Check/getDataOption?option=currency UUID for details\n
typestringCharge type
\n PERSON Charge by person
\n ITEM Charge by item\n
configarrayPricing policy rule. Check config for details.
bindingSalesOptionCntintUsed products
\n\n##### *config*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
identityUuidUUIDIdentity UUID
\n i.e. Adult, available for charge type PERSON
\n Check /getDataOption?option=identity for details\n
isGroupintSingle or Group rule?
\n 1 Yes, Group
\n 0 No, Single
\n Available for charge type PERSON\n
targetstringCharge target of Group rule
\n Available when charge type is PERSON AND isGroup = 1\n TOTAL charge by group
\n PERSON charge by person\n
minintMinimum required for a Group
\n Available when charge type is PERSON AND isGroup = 1\n
maxintMaximum capacity for a Group
\n Available when charge type is PERSON AND isGroup = 1\n
fromintMinimum age for the PERSON identity
\n Available when charge type is PERSON AND isGroup = 0\n
tointMaximum age for the PERSON identity
\n Available when charge type is PERSON AND isGroup = 0\n
itemUuidUUIDPricing Item UUID
\n Available when charge type is ITEM\n
labelstringPricing Item Name
\n Available when charge type is ITEM\n
costnumberCost
originalPricenumberOriginal Price
pricenumberPrice
" tags: - Setting - Pricing Policy parameters: - name: label in: query description: '' schema: type: string - name: currency in: query description: '' example: TWD schema: type: string - name: type in: query description: '' schema: type: string enum: - PERSON - ITEM - name: page in: query description: '' schema: type: string post: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string data: type: object properties: uuid: type: string example: code: S0000 codeMessage: SUCCESS data: uuid: 33a6058e-232c-4fb1-9169-9607827d5614 summary: Create Pricing Policy operationId: post-v1-setting-pricePolicy description: "Create a new pricing policy\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/setting/pricePolicy
HTTP MethodPOST
ParametersRaw Body
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeLimitRequiredDescription
labelstringLength limit
varchar(100)		YName
currencystring/ UUID-YCurrency
\n Accept ISO-4217 Code or Rezio Currency UUID
\n Check/getDataOption?option=currency to get code/ UUID\n
typestring-YCharge Type
\n PERSON Charge by person
\n ITEM Charge by item\n
configarray-YPricing policy rule, check config for details.
\n\n##### *config*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
identityUuidUUID-Identity UUID
\n i.e., Adult, available for charge type PERSON
\n Check /getDataOption?option=identity for details\n
isGroupint-Single or Group rule?
\n 1 Yes, Group
\n 0 No, Single
\n Required field when the charge type is PERSON \n
targetstring-Charge target of Group rule
\n TOTAL charge by group
\n PERSON charge by person
\n Required when charge type is PERSON AND isGroup = 1\n
minint-Minimum required for a Group
\n Available when charge type is PERSON AND isGroup = 1\n
maxint-Maximum capacity for a Group
\n Available when charge type is PERSON AND isGroup = 1\n
fromint-Minimum age for the PERSON identity
\n Available when charge type is PERSON AND isGroup = 0\n
toint-Maximum age for the PERSON identity
\n Available when charge type is PERSON AND isGroup = 0\n
labelstring-Pricing Item Name
\n Available when charge\ \ type is ITEM\n
costnumberYCost
originalPricenumberYOriginal Price
pricenumberYPrice
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
dataobjectResponse data, check data for details
\n\n##### *data*\n\n\n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
uuidUUIDPricing Policy UUID
" tags: - Setting - Pricing Policy requestBody: content: application/json: example: currency: USD label: Day Tour - Weekday departures type: PERSON config: - identityUuid: d6871da2-c391-468e-ad9b-f8d5148fe0cd cost: 29.99 originalPrice: 29.99 price: 29.99 seat: 1 isGroup: 0 from: 3 to: 99 - identityUuid: 175087ec-03a7-4aa4-a288-29f65bb8966e cost: 6 originalPrice: 6 price: 6 seat: 0 isGroup: 0 from: 0 to: 2 schema: type: object properties: currency: type: string label: type: string type: type: string config: type: array items: type: object properties: identityUuid: type: string cost: type: number originalPrice: type: number price: type: number seat: type: number isGroup: type: number from: type: number to: type: number required: - identityUuid - cost - originalPrice - price - seat - isGroup - from - to /v1/setting/pricePolicy/{pricePolicyUuid}: get: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string data: type: object properties: uuid: type: string currencyUuid: type: string label: type: string type: type: string config: type: array items: type: object properties: identityUuid: type: string cost: type: number originalPrice: type: number price: type: number seat: type: number isGroup: type: number from: type: number to: type: number required: - identityUuid - cost - originalPrice - price - seat - isGroup - from - to example: code: S0000 codeMessage: SUCCESS data: uuid: 33a6058e-232c-4fb1-9169-9607827d5614 currencyUuid: b5317f07-b5a0-4525-8ff7-3fe55b4d96ec label: Day Tour - Weekday departures type: PERSON config: - identityUuid: d6871da2-c391-468e-ad9b-f8d5148fe0cd cost: 29.99 originalPrice: 29.99 price: 29.99 seat: 1 isGroup: 0 from: 3 to: 99 - identityUuid: 175087ec-03a7-4aa4-a288-29f65bb8966e cost: 6 originalPrice: 6 price: 6 seat: 0 isGroup: 0 from: 0 to: 2 summary: Get Pricing Policy operationId: get-v1-setting-pricePolicy-pricePolicyUuid description: "Load an existing policy by pricePolicyUuid\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/setting/pricePolicy/{pricePolicyUuid}
HTTP MethodGET
ParametersIn Uri
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters- In Uri\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
pricePolicyUuidUUIDYPricing Policy UUID
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
dataobjectResponse data, check data for details
\n\n##### *data*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
uuidUUIDPricing Policy UUID
currencyUuidUUIDCurrency UUID
\n Accept Rezio Currency UUID
\n Check/getDataOption?option=currency UUID for details\n
labelstringName
typestringCharge type
\n PERSON Charge by person
\n ITEM Charge by item\n
configarrayPricing policy rule, check config for details.
\n\n##### *config*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
identityUuidUUIDIdentity UUID
\n i.e., Adult, available for charge type PERSON
\n Check /getDataOption?option=identity for details\n
isGroupintSingle or Group rule?
\n 1 Yes, Group
\n 0 No, Single
\n Available for charge type PERSON\n
targetstringCharge target of Group rule
\n Available when charge type is PERSON AND isGroup = 1\n TOTAL charge by group
\n PERSON charge by person\n
minintMinimum required for a Group
\n Available when charge type is PERSON AND isGroup = 1\n
maxintMaximum capacity for a Group
\n Available when charge type is PERSON AND isGroup = 1\n
fromintMinimum\ \ age for the PERSON identity
\n Available when charge type is PERSON AND isGroup = 0\n
tointMaximum age for the PERSON identity
\n Available when charge type is PERSON AND isGroup = 0\n
itemUuidUUIDPricing Item UUID
\n Available when charge type is ITEM\n
labelstringPricing Item Name
\n Available when charge type is ITEM\n
costnumberCost
originalPricenumberOriginal Price
pricenumberPrice
" tags: - Setting - Pricing Policy parameters: - name: pricePolicyUuid in: path description: '' required: true example: 33a6058e-232c-4fb1-9169-9607827d5614 schema: type: string put: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string example: code: S0000 codeMessage: SUCCESS summary: Update Pricing Policy operationId: put-v1-setting-pricePolicy-pricePolicyUuid description: "Update a pricing policy by pricePolicyUuid\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/setting/pricePolicy/{pricePolicyUuid}
HTTP MethodPUT
ParametersIn Uri & Raw Body
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters- In Uri\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
pricePolicyUuidUUIDYPricing Policy UUID
\n\n##### Parameters- Raw Body\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeLimitRequiredDescription
labelstringLength limit
varchar(100)		YName
currencystring/ UUID-YCurrency
\n Accept ISO-4217 Code or Rezio Currency UUID
\n Check/getDataOption?option=currency to get code/ UUID\n
typestring-YCharge type
\n PERSON Charge by person
\n ITEM Charge by item\n
configarray-YPricing policy rule, check config for details.
\n\n##### *config*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \ \ \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
identityUuidUUID-Identity UUID
\n i.e., Adult, available for charge type PERSON
\n Check /getDataOption?option=identity for details\n
isGroupint-Single or Group rule?
\n 1 Yes, Group
\n 0 No, Single
\n Required field when the charge type is PERSON \n
targetstring-Charge target of Group rule
\n TOTAL charge by group
\n PERSON charge by person
\n Required when charge type is PERSON AND isGroup = 1\n
minint-Minimum required for a Group
\n Available when charge type is PERSON AND isGroup = 1\n
maxint-Maximum capacity for a Group
\n Available when charge type is PERSON AND isGroup = 1\n
fromint-Minimum age for the PERSON identity
\n Available when charge type is PERSON AND isGroup = 0\n
toint-Maximum age for the PERSON identity
\n Available when charge type is PERSON AND isGroup = 0\n
itemUuidUUID-Pricing Item UUID
\n Available when charge type is ITEM
\n Leave it empty when create a new item\n
labelstring-Pricing Item Name
\n Available when charge type is ITEM\n
costnumberYCost
originalPricenumberYOriginal Price
pricenumberYPrice
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
" tags: - Setting - Pricing Policy parameters: - name: pricePolicyUuid in: path required: true schema: type: string requestBody: content: application/json: example: currency: USD label: Day Tour - Weekend departures type: PERSON config: - identityUuid: d6871da2-c391-468e-ad9b-f8d5148fe0cd cost: 38.99 originalPrice: 38.99 price: 38.99 seat: 1 isGroup: 0 from: 3 to: 80 - identityUuid: 175087ec-03a7-4aa4-a288-29f65bb8966e cost: 6.8 originalPrice: 6.8 price: 6.8 seat: 0 isGroup: 0 from: 0 to: 2 schema: type: object properties: currency: type: string label: type: string type: type: string config: type: array items: type: object properties: identityUuid: type: string cost: type: number originalPrice: type: number price: type: number seat: type: number isGroup: type: number from: type: number to: type: number required: - identityUuid - cost - originalPrice - price - seat - isGroup - from - to /v1/setting/feeNdTax: get: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string data: type: object properties: totalCount: type: number page: type: number itemPerPage: type: number list: type: array items: type: object properties: uuid: type: string label: type: string type: type: string currencyUuid: type: string charge: type: number rule: type: string included: type: number bindingProductCnt: type: number required: - uuid - label - type - currencyUuid - charge - rule - included - bindingProductCnt example: code: S0000 codeMessage: SUCCESS data: totalCount: 2 page: 1 itemPerPage: 20 list: - uuid: b350744d-2639-49d0-be0e-d05a6d524fbf label: Service fee type: FEE currencyUuid: b5317f07-b5a0-4525-8ff7-3fe55b4d96ec charge: 10 rule: PERCENTAGE-ORDER included: 0 bindingProductCnt: 0 - uuid: 2dbe92c2-bf7c-46f8-9566-30e313368124 label: Invoice Tax type: TAX currencyUuid: b5317f07-b5a0-4525-8ff7-3fe55b4d96ec charge: 5 rule: PERCENTAGE-ORDER included: 1 bindingProductCnt: 1 summary: List Tax & Fees operationId: get-v1-setting-feeNdTax description: "List all existing tax or fee items. Filters such as currency are available.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/setting/feeNdTax
HTTP MethodGET
ParametersQuery string
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters- Query string\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
labelstring-Name
typestring-Type
\n TAX Tax, i.e., invoice tax
\n FEE Fee, i.e., service fee\n
currencystring/ UUID-Currency
\n Accept ISO-4217 Code or Rezio Currency UUID
\n Check/getDataOption?option=currency to get code/ UUID\n
pageint-Pages. Default/minimum value is 1
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
dataobjectResponse data, check data for details
\n\n##### *data*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
totalCountintRecord counts
pageintCurrent page number
itemPerPageintRecord counts per page. Default/maximum value is 20
listarrayCheck list for details
\n\n##### *list*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\ \ \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
uuidUUIDTax & Fees Item UUID
labelstringName
typestringType
\n TAX Tax, i.e., invoice tax
\n FEE Fee, i.e., service fee\n
currencyUuidUUIDCurrency UUID
\n Rezio Currency UUID, check/getDataOption?option=currency UUID for details\n
chargenumberAmount or percentage
\n Example: 50%, charge = 50 AND rule = 'PERCENTAGE-ORDER'
rulestringRate rule
\n PERCENTAGE-ORDER Percentage of order total amount (%)
\n FIXED-HEAD Fix amount per person
\n FIXED-ORDER Fix amount per order\n
includedintDoes price include this tax or fee?
\n 1 included
\n 0 excluded (it will be added to the order during the booking process)\n
bindingProductCntintUsed products
" tags: - Setting - Tax & Fees parameters: - name: label in: query description: '' schema: type: string - name: type in: query description: '' schema: type: string enum: - FEE - TAX - name: currency in: query description: '' schema: type: string - name: page in: query description: '' schema: type: string post: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string data: type: object properties: uuid: type: string example: code: S0000 codeMessage: SUCCESS data: uuid: 2dbe92c2-bf7c-46f8-9566-30e313368124 summary: Create Tax or Fees operationId: post-v1-setting-feeNdTax description: "Create a new tax or fee item\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/setting/feeNdTax
HTTP MethodPOST
ParametersRaw Body
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters- Raw Body\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeLimitRequiredDescription
labelstringLength limit
varchar(200)		YName
typestring-YType
\n TAX Tax, i.e., invoice tax
\n FEE Fee, i.e., service fee\n
rulestring-YRate rule
\n PERCENTAGE-ORDER Percentage of order total amount (%)
\n FIXED-HEAD Fix amount per person
\n FIXED-ORDER Fix amount per order\n
chargenumber-Yamount or percentage
\n Example: 50%, charge = 50 AND rule = 'PERCENTAGE-ORDER'\n
currencystring/ UUID--Currency
\n Accept ISO-4217 Code or Rezio Currency UUID
\n Check/getDataOption?option=currency to get code/ UUID\n
includedint-YDoes price include this tax or fee?
\n 1 included
\n 0 excluded (it will be added to the order during the booking process)\n
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
dataobjectResponse data, check data for details
\n\n##### *data*\n\n\n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
uuidUUIDTax & Fees item UUID
" tags: - Setting - Tax & Fees requestBody: content: application/json: example: label: Invoice Tax type: TAX charge: 5 currency: TWD included: 1 rule: PERCENTAGE-ORDER schema: type: object properties: label: type: string type: type: string charge: type: number currency: type: string included: type: number rule: type: string /v1/setting/feeNdTax/{feeNdTaxUuid}: get: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string data: type: object properties: uuid: type: string label: type: string type: type: string charge: type: number currencyUuid: type: string included: type: number rule: type: string example: code: S0000 codeMessage: SUCCESS data: uuid: 2dbe92c2-bf7c-46f8-9566-30e313368124 label: Invoice Tax type: TAX charge: 5 currencyUuid: b5317f07-b5a0-4525-8ff7-3fe55b4d96ec included: 1 rule: PERCENTAGE-ORDER summary: Get Tax & Fees operationId: get-v1-setting-feeNdTax-feeNdTaxUuid description: "Load an existing tax or fee data by feeNdTaxUuid\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/setting/feeNdTax/{feeNdTaxUuid}
HTTP MethodGET
ParametersIn Uri
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters- In Uri\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
feeNdTaxUuidUUIDYTax & Fees UUID
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
dataobjectResponse data, check data for details
\n\n##### *data*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
uuidUUIDTax & Fees item UUID
labelstringName
typestringType
\n TAX Tax, i.e., invoice tax
\n FEE Fee, i.e., service fee\n
rulestringRate rule
\n PERCENTAGE-ORDER Percentage of order total amount (%)
\n FIXED-HEAD Fix amount per person
\n FIXED-ORDER Fix amount per order\n
chargenumberamount or percentage
\n Example: 50%, charge = 50 AND rule = 'PERCENTAGE-ORDER'\n
currencyUuidUUIDCurrency UUID
\n Rezio Currency UUID, check/getDataOption?option=currency UUID for details\n
includedintDoes price include this tax or fee?
\n 1 included
\n 0 excluded (it will be added to the order during the booking process)\n
" tags: - Setting - Tax & Fees parameters: - name: feeNdTaxUuid in: path description: '' required: true example: 2dbe92c2-bf7c-46f8-9566-30e313368124 schema: type: string put: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string example: code: S0000 codeMessage: SUCCESS summary: Update Tax or Fees operationId: put-v1-setting-feeNdTax-feeNdTaxUuid description: "Update a tax or fee item by feeNdTaxUuid\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/setting/feeNdTax/{feeNdTaxUuid}
HTTP MethodPUT
ParametersIn Uri & Raw Body
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters- In Uri\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
feeNdTaxUuidUUIDYTax & Fees item UUID
\n\n##### Parameters- Raw Body\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeLimitRequiredDescription
labelstringLength limit
varchar(200)		YName
typestring-YType
\n TAX Tax, i.e., invoice tax
\n FEE Fee, i.e., service fee\n
rulestring-YRate rule
\n PERCENTAGE-ORDER Percentage of order total amount (%)
\n FIXED-HEAD Fix amount per person
\n FIXED-ORDER Fix amount per order\n
chargenumber-Yamount or percentage
\n Example: 50%, charge = 50 AND rule = 'PERCENTAGE-ORDER'\n
currencystring/ UUID--Currency
\n Accept ISO-4217 Code or Rezio Currency UUID
\n Check/getDataOption?option=currency to get code/ UUID\n
includedint-YDoes price include this tax or fee?
\n 1 included
\n 0 excluded (it will be added to the order during the booking process)\n
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
" tags: - Setting - Tax & Fees parameters: - name: feeNdTaxUuid in: path required: true schema: type: string requestBody: content: application/json: example: label: Service fee type: FEE charge: 12 currency: USD included: 0 rule: PERCENTAGE-ORDER schema: type: object properties: label: type: string type: type: string charge: type: number currency: type: string included: type: number rule: type: string /v1/setting/cancelPolicy: get: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string data: type: object properties: totalCount: type: number page: type: number itemPerPage: type: number list: type: array items: type: object properties: uuid: type: string label: type: string currencyUuid: type: string policyRule: type: array items: type: object properties: from: type: number to: type: number periodUnit: type: string charge: type: number unit: type: string required: - from - to - periodUnit - charge - unit bindingProductCnt: type: number currency: type: string required: - uuid - label - currencyUuid - policyRule - bindingProductCnt example: code: S0000 codeMessage: SUCCESS data: totalCount: 1 page: 1 itemPerPage: 20 list: - uuid: 0a615273-be4d-4fd7-9260-77188f81e74b label: Non-refundable currencyUuid: '' policyRule: - from: -1 to: -1 periodUnit: DAY charge: 100 unit: PERCENTAGE bindingProductCnt: 0 - uuid: b95838ed-4942-4250-8a05-5183be475b58 label: Full refund currencyUuid: '' policyRule: - from: -1 to: -1 periodUnit: DAY charge: 0 unit: PERCENTAGE bindingProductCnt: 0 - uuid: 301646a7-3547-4fe9-bb50-a3c3860d895f label: Day Tour Cancel Rule currency: USD policyRule: - from: 33 to: -1 periodUnit: DAY charge: 0 unit: PERCENTAGE - from: 23 to: 33 periodUnit: DAY charge: 20 unit: PERCENTAGE - from: 16 to: 23 periodUnit: DAY charge: 30 unit: PERCENTAGE - from: 4 to: 16 periodUnit: DAY charge: 50 unit: PERCENTAGE - from: -1 to: 4 periodUnit: DAY charge: 100 unit: PERCENTAGE bindingProductCnt: 1 summary: List Cancellation Policy operationId: get-v1-setting-cancelPolicy description: "List all existing cancellation policies. Filters such as currency are available.
\nRezio provides 2 pre-defined settings: `Non-refundable` and `Full refund`\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/setting/cancelPolicy
HTTP MethodGET
ParametersQuery string
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters- Query string\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
labelstring-Name
currencystring/ UUID-Currency
\n Accept ISO-4217 Code or Rezio Currency UUID
\n Check/getDataOption?option=currency to get code/ UUID\n
pageint-Pages. Default/minimum value is 1
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
dataobjectResponse data, check data for details
\n\n##### *data*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
totalCountintRecord counts
pageintCurrent page number
itemPerPageintRecord counts per page. Default/maximum value is 20
listarrayCancel policy data, check list for details
\n\n##### *list*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
uuidUUIDCancel Policy UUID
labelstringName
currencyUuidUUIDCurrency UUID
\n Rezio Currency UUID, check/getDataOption?option=currency UUID for details\n
policyRulearrayThe rule of cancellation policy, check policyRule for details
bindingProductCntintUsed products
\n\n##### *policyRule*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
fromintRule\ \ start time
\n Start time is included. Example: 4 day(s) or more with 10% cancellation charge, then \"from\": 4, \"to\":-1 and the 4th day applied.
\n {from} <= Cancellation Date < {to}
\n Note: when from = -1 and to = -1, this rule can apply to anytime\n
tointRule end time
\n End time is excluded. Example: 2 ~ 4 day(s) with 20%/ 4 day(s) or more with 10% cancellation charge, then \"from\": 2, \"to\":4 and the 4th day applied to 10%.
\n {from} <= Cancellation Date < {to}
\n Note: when from = -1 and to = -1, this rule can apply to anytime \n
periodUnitstringRule period unit
\n DAY Day
\n HOUR Hour\n
chargenumberamount or percentage
\n Example: 50%, charge = 50 AND unit = 'PERCENTAGE'\n
unitstringCharge unit
\n PERCENTAGE Percentage of order total amount
\n FIXED Fix amount\n
" tags: - Setting - Cancellation Policy parameters: - name: label in: query description: '' schema: type: string - name: currency in: query description: '' example: TWD schema: type: string - name: page in: query description: '' schema: type: string post: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string data: type: object properties: uuid: type: string example: code: S0000 codeMessage: SUCCESS data: uuid: 301646a7-3547-4fe9-bb50-a3c3860d895f summary: Create Cancellation Policy operationId: post-v1-setting-cancelPolicy description: "Create a new cancellation policy\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/setting/cancelPolicy
HTTP MethodPOST
ParametersRaw Body
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeLimitRequiredDescription
labelstringLength limit
varchar(200)		YName
currencystring/ UUID-YCurrency
\n Accept ISO-4217 Code or Rezio Currency UUID
\n Check/getDataOption?option=currency to get code/ UUID\n
policyRulearray-YCancel policy rule, check policyRule for details
\n\n##### *policyRule*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
fromintYRule start time
\n Start time is included. Example: 4 day(s) or more with 10% cancellation charge, then \"from\": 4, \"to\":-1 and the 4th day applied.
\n {from} <= Cancellation Date < {to}
\n Note: when from = -1 and to = -1, this rule can apply to anytime\n
tointYRule end time
\n End time is excluded. Example: 2 ~ 4 day(s) with 20%/ 4 day(s) or more with 10% cancellation charge, then \"from\": 2, \"to\":4 and the 4th day applied to 10%.
\n {from} <= Cancellation Date < {to}
\n Note: when from = -1 and to = -1, this rule can apply to anytime \n
periodUnitstringYRule period unit
\n DAY Day
\n HOUR Hour\n
chargenumberYamount or percentage
\n Example: 50%, charge = 50 AND unit = 'PERCENTAGE'\n
unitstringYCharge unit
\n PERCENTAGE Percentage of order total amount
\n FIXED Fix amount\n
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
dataobjectResponse data, check data for details
\n\n##### *data*\n\n\n \n \n \n\ \ \n \n \n \n \n \n \n
NameTypeDescription
uuidUUIDCancel Policy UUID
" tags: - Setting - Cancellation Policy requestBody: content: application/json: example: label: Day Tour Cancel Rule currency: TWD policyRule: - from: 33 to: -1 periodUnit: DAY charge: 0 unit: PERCENTAGE - from: 23 to: 33 periodUnit: DAY charge: 20 unit: PERCENTAGE - from: 16 to: 23 periodUnit: DAY charge: 30 unit: PERCENTAGE - from: 4 to: 16 periodUnit: DAY charge: 50 unit: PERCENTAGE - from: -1 to: 4 periodUnit: DAY charge: 100 unit: PERCENTAGE schema: type: object properties: label: type: string currency: type: string policyRule: type: array items: type: object properties: from: type: number to: type: number periodUnit: type: string charge: type: number unit: type: string required: - from - to - periodUnit - charge - unit /v1/setting/cancelPolicy/{cancelPolicyUuid}: get: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string data: type: object properties: uuid: type: string label: type: string currencyUuid: type: string policyRule: type: array items: type: object properties: from: type: number to: type: number periodUnit: type: string charge: type: number unit: type: string required: - from - to - periodUnit - charge - unit example: code: S0000 codeMessage: SUCCESS data: uuid: 301646a7-3547-4fe9-bb50-a3c3860d895f label: Day Tour Cancel Rule currencyUuid: b5317f07-b5a0-4525-8ff7-3fe55b4d96ec policyRule: - from: 33 to: -1 periodUnit: DAY charge: 0 unit: PERCENTAGE - from: 23 to: 33 periodUnit: DAY charge: 20 unit: PERCENTAGE - from: 16 to: 23 periodUnit: DAY charge: 30 unit: PERCENTAGE - from: 4 to: 16 periodUnit: DAY charge: 50 unit: PERCENTAGE - from: -1 to: 4 periodUnit: DAY charge: 100 unit: PERCENTAGE summary: Get Cancellation Policy operationId: get-v1-setting-cancelPolicy-cancelPolicyUuid description: "Load an existing cancellation policy by cancelPolicyUuid\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/setting/cancelPolicy/{cancelPolicyUuid}
HTTP MethodGET
ParametersIn Uri
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters- In Uri\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
cancelPolicyUuidUUIDYCancel Policy UUID
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
dataobjectResponse data, check data for details
\n\n##### *data*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
uuidUUIDCancel Policy UUID
labelstringName
currencyUuidUUIDCurrency UUID
\n Rezio Currency UUID, check/getDataOption?option=currency UUID for details\n
policyRulearrayCancel policy rule, check policyRule for details
\n\n##### *policyRule*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
fromintRule start time
\n Start time is included. Example: 4 day(s) or more with 10% cancellation charge, then \"from\": 4, \"to\":-1 and the 4th day applied.
\n {from} <= Cancellation Date < {to}
\n Note: when from = -1 and to = -1, this rule can apply to anytime\n
tointRule end time
\n End time is excluded. Example: 2 ~ 4 day(s) with 20%/ 4 day(s) or more with 10% cancellation charge, then \"from\": 2, \"to\":4 and the 4th day applied to 10%.
\n {from} <= Cancellation Date < {to}
\n Note: when from = -1 and to = -1, this rule can apply to anytime \n
periodUnitstringRule period unit
\n DAY Day
\n HOUR Hour\n
chargenumberamount or percentage
\n Example: 50%, charge = 50 AND unit = 'PERCENTAGE'\n
unitstringCharge unit
\n PERCENTAGE Percentage of order total amount
\n FIXED Fix amount\n
" tags: - Setting - Cancellation Policy parameters: - name: cancelPolicyUuid in: path description: '' required: true example: 301646a7-3547-4fe9-bb50-a3c3860d895f schema: type: string put: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string example: code: S0000 codeMessage: SUCCESS summary: Update Cancellation Policy operationId: put-v1-setting-cancelPolicy-cancelPolicyUuid description: "Update a cancellation policy by cancelPolicyUuid\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/setting/cancelPolicy/{cancelPolicyUuid}
HTTP MethodPUT
ParametersIn Uri & Raw Body
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters- In Uri\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
cancelPolicyUuidUUIDYCancel Policy UUID
\n\n##### Parameters- Raw Body\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeLimitRequiredDescription
labelstringLength limit
varchar(200)		YName
currencystring/ UUID-YCurrency
\n Accept ISO-4217 Code or Rezio Currency UUID
\n Check/getDataOption?option=currency to get code/ UUID\n
policyRulearray-YCancel policy rule, check policyRule for details
\n\n##### *policyRule*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
fromintYRule start time
\n Start time is included. Example: 4 day(s) or more with 10% cancellation charge, then \"from\": 4, \"to\":-1 and the 4th day applied.
\n {from} <= Cancellation Date < {to}
\n Note: when from = -1 and to = -1, this rule can apply to anytime\n
tointYRule end time
\n End time is excluded. Example: 2 ~ 4 day(s) with 20%/ 4 day(s) or more with 10% cancellation charge, then \"from\": 2, \"to\":4 and the 4th day applied to 10%.
\n {from} <= Cancellation Date < {to}
\n Note: when from = -1 and to = -1, this rule can apply to anytime \n
periodUnitstringYRule period unit
\n DAY Day
\n HOUR Hour\n
chargenumberYamount or percentage
\n Example: 50%, charge = 50 AND unit = 'PERCENTAGE'\n
unitstringYCharge unit
\n PERCENTAGE Percentage of order total amount
\n FIXED Fix amount\n
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n\ \ \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
" tags: - Setting - Cancellation Policy parameters: - name: cancelPolicyUuid in: path required: true schema: type: string requestBody: content: application/json: example: label: Day Tour Cancel Rule currency: TWD policyRule: - from: 33 to: -1 periodUnit: DAY charge: 0 unit: PERCENTAGE - from: 28 to: 33 periodUnit: DAY charge: 10 unit: PERCENTAGE - from: 23 to: 28 periodUnit: DAY charge: 20 unit: PERCENTAGE - from: 16 to: 23 periodUnit: DAY charge: 30 unit: PERCENTAGE - from: 4 to: 16 periodUnit: DAY charge: 50 unit: PERCENTAGE - from: -1 to: 4 periodUnit: DAY charge: 100 unit: PERCENTAGE schema: type: object properties: label: type: string currency: type: string policyRule: type: array items: type: object properties: from: type: number to: type: number periodUnit: type: string charge: type: number unit: type: string required: - from - to - periodUnit - charge - unit /v1/setting/depositPolicy: get: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string data: type: object properties: totalCount: type: number page: type: number itemPerPage: type: number list: type: array items: type: object properties: uuid: type: string label: type: string currencyUuid: type: string policyType: type: number handlingCharge: type: number dueDays: type: number allowMinAlarm: type: number allowFullAmountPay: type: number bindingProductCnt: type: number required: - uuid - label - currencyUuid - policyType - handlingCharge - dueDays - allowMinAlarm - allowFullAmountPay - bindingProductCnt example: code: S0000 codeMessage: SUCCESS data: totalCount: 1 page: 1 itemPerPage: 20 list: - uuid: 18668dda-1a26-49c4-aea9-253eab173a7c label: No charge currencyUuid: '' policyType: 1 handlingCharge: 0 dueDays: 0 allowMinAlarm: 0 allowFullAmountPay: 0 bindingProductCnt: 0 - uuid: b309eb3a-15cb-4ddb-8938-2f01b667840f label: Full amount currencyUuid: '' policyType: 1 handlingCharge: 100 dueDays: 0 allowMinAlarm: 0 allowFullAmountPay: 0 bindingProductCnt: 1 - uuid: 4a957d29-f796-4f6c-8076-a4f6d6f05c4e label: Day Tour $100 Deposit per person currencyUuid: b5317f07-b5a0-4525-8ff7-3fe55b4d96ec policyType: 2 handlingCharge: 100 dueDays: 3 allowMinAlarm: 1 allowFullAmountPay: 0 bindingProductCnt: 0 summary: List Deposit Policy operationId: get-v1-setting-depositPolicy description: "List all existing deposit policies. Filters like currency are available.
\nRezio provides 2 pre-defined settings: `No charge` (customer can do reservation without prepayment), and `Full amount` (customer needs to prepay the full amount to submit a reservation).\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/setting/depositPolicy
HTTP MethodGET
ParametersQuery string
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters- Query string\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
labelstring-Name
currencystring/ UUID-Currency
\n Accept ISO-4217 Code or Rezio Currency UUID
\n Check/getDataOption?option=currency to get code/ UUID\n
pageint-Pages. Default/minimum value is 1
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
dataobjectDeposit policy data, check data for details
\n\n##### *data*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
totalCountintRecord counts
pageintCurrent page number
itemPerPageintRecord counts per page. Default/maximum value is 20
listarrayDeposit policy data, check list for details
\n\n##### *list*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
uuidUUIDDeposit Policy UUID
labelstringName
currencyUuidUUIDCurrency UUID
\n Rezio Currency UUID, check/getDataOption?option=currency UUID for details\n
policyTypeintDeposit policy type
\n 1 Percentage of order total amount (%)
\n 2 Fixed amount per person
\n 3 Fixed amount per order\n
handlingChargenumberAmount or percentage
\n Example: 50%, handlingCharge =\ \ 50 AND policyType = 1\n
allowMinAlarmintDo you need to setup the deposit cut-off date?
\n 1 Yes, thus dueDays is available
\n 0 No\n
dueDaysintThe cut-off days of deposit policy
\n Only available when allowMinAlarm = 1
\n Example, dueDays = 2 indicates deposit policy is applicable two days before the departure date. Within two days, full amount payment is essential.\n
allowFullAmountPayintDo you accept customer to pay full amount when deposit policy applied?
\n 1 Accepted, customer can pay full amount
\n 0 Not accepted, thus customer can only pay deposit when they do the online booking.\n
bindingProductCntintUsed products
" tags: - Setting - Deposit Policy parameters: - name: label in: query description: '' schema: type: string - name: currency in: query description: '' schema: type: string - name: page in: query description: '' schema: type: string post: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string data: type: object properties: uuid: type: string example: code: S0000 codeMessage: SUCCESS data: uuid: 4a957d29-f796-4f6c-8076-a4f6d6f05c4e summary: Create Deposit Policy operationId: post-v1-setting-depositPolicy description: "Create a new deposit policy\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/setting/depositPolicy
HTTP MethodPOST
ParametersRaw Body
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters- Raw Body\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeLimitRequiredDescription
labelstringLength limit
varchar(200)		YName
currencystring/ UUID--Currency
\n Accept ISO-4217 Code or Rezio Currency UUID
\n Check/getDataOption?option=currency to get code/ UUID\n
policyTypeint-YDeposit policy type
\n 1 Percentage of order total amount (%)
\n 2 Fixed amount per person
\n 3 Fixed amount per order\n
handlingChargenumber-YAmount or percentage
\n Example: 50%, handlingCharge = 50 AND policyType = 1\n
allowMinAlarmint-YDo you need to setup the deposit cut-off date?
\n 1 Yes, thus dueDays is available
\n 0 No\n
dueDaysint--The cut-off days of deposit policy
\n Only available when allowMinAlarm = 1
\n Example: dueDays = 2 indicates that deposit policy is appliable two days before the depatured date. Within two days, full amount payment is essential.\n
allowFullAmountPayint-YDo you accept customer to pay full amount when deposit policy applied?
\n 1 Accepted, customer can pay full amount
\n 0 Not accepted, thus customer can only pay deposit when they do the online booking.\n
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
dataobjectDeposit policy data, check data for details
\n\n##### *data*\n\n\n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
uuidUUIDDeposit Policy UUID
" tags: - Setting - Deposit Policy requestBody: content: application/json: example: label: Day Tour $100 Deposit per person currency: USD policyType: 2 handlingCharge: 100 allowFullAmountPay: 0 allowMinAlarm: 1 dueDays: 3 schema: type: object properties: label: type: string currency: type: string policyType: type: number handlingCharge: type: number allowFullAmountPay: type: number allowMinAlarm: type: number dueDays: type: number /v1/setting/depositPolicy/{depositPolicyUuid}: get: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string data: type: object properties: uuid: type: string label: type: string currencyUuid: type: string policyType: type: number handlingCharge: type: number allowFullAmountPay: type: number allowMinAlarm: type: number dueDays: type: number example: code: S0000 codeMessage: SUCCESS data: uuid: 4a957d29-f796-4f6c-8076-a4f6d6f05c4e label: Day Tour $100 Deposit per person currencyUuid: b5317f07-b5a0-4525-8ff7-3fe55b4d96ec policyType: 2 handlingCharge: 100 allowFullAmountPay: 0 allowMinAlarm: 1 dueDays: 3 summary: Get Deposit Policy operationId: get-v1-setting-depositPolicy-depositPolicyUuid description: "Load an existing deposit policy by depositPolicyUuid\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/setting/depositPolicy/{depositPolicyUuid}
HTTP MethodGET
ParametersIn Uri
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters- In Uri\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
depositPolicyUuidUUIDYDeposit Policy UUID
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
dataobjectDeposit policy data, check data for details
\n\n##### *data*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
uuidUUIDDeposit Policy UUID
labelstringName
currencyUuidUUIDCurrency UUID
\n Rezio Currency UUID, check/getDataOption?option=currency UUID for details\n
policyTypeintDeposit policy type
\n 1 Percentage of order total amount (%)
\n 2 Fixed amount per person
\n 3 Fixed amount per order\n
handlingChargenumberAmount or percentage
\n Example: 50%, handlingCharge = 50 AND policyType = 1\n
allowMinAlarmintDo you need to setup the deposit cut-off date?
\n 1 Yes, thus dueDays is available
\n 0 No\n
dueDaysintThe cut-off days of deposit policy
\n Only available when allowMinAlarm = 1
\n Example: dueDays = 2 indicates that deposit policy is appliable two days before the depatured date. Within two days, full amount payment is essential.\n
allowFullAmountPayintDo you accept customer to pay full amount when deposit policy applied?
\n 1 Accepted, customer can pay full amount
\n 0 Not accepted, thus customer can only pay deposit when they do the online booking.\n
" tags: - Setting - Deposit Policy parameters: - name: depositPolicyUuid in: path description: '' required: true example: 4a957d29-f796-4f6c-8076-a4f6d6f05c4e schema: type: string put: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string example: code: S0000 codeMessage: SUCCESS summary: Update Deposit Policy operationId: put-v1-setting-depositPolicy-depositPolicyUuid description: "Update a deposit policy by depositPolicyUuid\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/setting/depositPolicy/{depositPolicyUuid}
HTTP MethodPUT
ParametersIn Uri & Raw Body
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters- In Uri\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
depositPolicyUuidUUIDYDeposit Policy UUID
\n\n##### Parameters- Raw Body\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeLimitRequiredDescription
labelstringLength limit
varchar(200)		YName
currencyUuidUUID-YCurrency
\n Accept Rezio Currency UUID
\n Check/getDataOption?option=currency UUID for details\n
policyTypeint-YDeposit policy type
\n 1 Percentage of order total amount (%)
\n 2 Fixed amount per person
\n 3 Fixed amount per order\n
handlingChargenumber-YAmount or percentage
\n Example: 50%, handlingCharge = 50 AND policyType = 1\n
allowMinAlarmint-YDo you need to setup the deposit cut-off date?
\n 1 Yes, thus dueDays is available
\n 0 No\n
dueDaysint--The cut-off days of deposit policy
\n Only available when allowMinAlarm = 1
\n Example: dueDays = 2 indicates that deposit policy is appliable two days before the depatured date. Within two days, full amount payment is essential.\n
allowFullAmountPayint-YDo you accept customer to pay full amount when deposit policy applied?
\n 1 Accepted, customer can pay full amount
\n 0 Not accepted, thus customer can only pay deposit when they do the online booking.\n
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
" tags: - Setting - Deposit Policy parameters: - name: depositPolicyUuid in: path required: true schema: type: string requestBody: content: application/json: example: label: Day Tour $100 Deposit per person currency: USD policyType: 2 handlingCharge: 90 allowFullAmountPay: 0 allowMinAlarm: 1 dueDays: 2 schema: type: object properties: label: type: string currency: type: string policyType: type: number handlingCharge: type: number allowFullAmountPay: type: number allowMinAlarm: type: number dueDays: type: number /v1/setting/bookingInfo: get: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string data: type: object properties: totalCount: type: number page: type: number itemPerPage: type: number list: type: array items: type: object properties: uuid: type: string label: type: string bindingProductCnt: type: number example: code: S0000 codeMessage: SUCCESS data: totalCount: 1 page: 1 itemPerPage: 20 list: - uuid: 5dfa699c-bfe8-44f7-b7cb-3a53dbc423a1 label: Booking Data for Day Tour bindingProductCnt: 1 summary: List Booking Information operationId: get-v1-setting-bookingInfo description: "List all existing booking information. Filters like label name are available. This information is the required customer data. Example: passport number, shoe size, etc. Rezio provides customized booking information, so you can customize it and apply it to any product.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/setting/bookingInfo
HTTP MethodGET
ParametersQuery string
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters- Query string\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
labelstring-Name
pageint-Pages. Default/minimum value is 1
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
dataobjectResponse data, check data for details
\n\n##### *data*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
totalCountintRecord counts
pageintCurrent page number
itemPerPageintRecord counts per page. Default/maximum value is 20
listarrayBooking information data, check list for details
\n\n##### *list*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
uuidUUIDBooking information rule UUID
labelstringName of Booking information rule
bindingProductCntintUsed products
" tags: - Setting - Booking Information parameters: - name: label in: query description: '' schema: type: string - name: page in: query description: '' schema: type: string post: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string data: type: object properties: uuid: type: string example: code: S0000 codeMessage: SUCCESS data: uuid: 5dfa699c-bfe8-44f7-b7cb-3a53dbc423a1 summary: Create Booking Information operationId: post-v1-setting-bookingInfo description: "Create new booking information\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/setting/bookingInfo
HTTP MethodPOST
ParametersRaw Body
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters- Raw Body\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameType-RequiredDescription
labelstringLength limit
varchar(300)		YName
settingarray-YField setting
\n Check setting via List Booking Field for details
\n Required field when field type = contact, ask and display will be overwritten.\n
\n\n##### *setting*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
uuidUUIDYBooking Field UUID
\n Please check /v1/setting/bookingField to get UUID and more details.\n
categorystringYBooking filed category
\n Check /v1/setting/bookingField to get UUID
\n Please make sure the booking field UUID and category were matched according to /v1/setting/bookingField\n
configarrayYConfiguation or options for display usage, check config for details
\n\n##### *config*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
valuesarrayValues
\n Available when type = shoe, check shoe for details\n
askintAsk for everyone's data?
\n 1 Ask once per order
\n 2 Ask for everyone\n
displayobjectDisplay option
\n Check display for details
\n Note: The order created by Rezio API will be considered as website\n
\n\n##### *shoe*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \ \ \n \n
NameTypeDescription
typestringShoes type
\n Man
\n Woman
\n Kid\n
minintThe smallest size
\n Check shoe via List Booking Field to get available sizes.\n
maxintThe largest size
\n Check shoe via List Booking Field to get available sizes.\n
\n\n##### *display*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
websiteintIs required on website?
\n 0 Hide field/ Not required
\n 1 Optional
\n 2 Required
\n Check config/display/website via List Booking Field for details\n
internalintIs required on internal order (via Rezio Admin)?
\n 0 Hide field/ Not required
\n 1 Optional
\n 2 Required
\n Check config/display/internal via List Booking Field for details \n
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
dataobjectResponse data, check data for details
\n\n##### *data*\n\n\n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
uuidUUIDBooking information UUID
" tags: - Setting - Booking Information requestBody: content: application/json: example: label: Booking Data for Day Tour setting: - uuid: 5b9256e0-0442-470f-8e80-4587703c4470 category: contact config: values: [] ask: 1 display: website: 2 internal: 1 - uuid: adefb4ec-b408-4f5e-b71d-d1c79599cdbc category: contact config: values: [] ask: 1 display: website: 2 internal: 2 - uuid: bb3b43f7-996d-4e86-97b3-ffff35032e9a category: contact config: values: [] ask: 1 display: website: 2 internal: 2 - uuid: 2a3536a5-a94a-4619-9af7-a93e0110874b category: contact config: values: [] ask: 1 display: website: 2 internal: 2 - uuid: 57035281-8a2a-4c76-8a44-f9cfa3117654 category: contact config: values: [] ask: 1 display: website: 0 internal: 1 - uuid: b13428d9-b9ff-473c-a612-66b6637221ed category: contact config: values: [] ask: 1 display: website: 0 internal: 1 - uuid: 10662538-eef3-4171-9972-41300fa473d9 category: contact config: values: [] ask: 1 display: website: 0 internal: 1 - uuid: 251a6a27-7fbc-4411-83ec-dfd1e9b93b1b category: contact config: values: [] ask: 1 display: website: 0 internal: 1 - uuid: 4e34479f-fe84-4bd3-a443-bbd7df182537 category: contact config: values: [] ask: 1 display: website: 0 internal: 1 - uuid: 96e58831-e2df-453b-8a6e-4fd74da1dd64 category: contact config: values: [] ask: 1 display: website: 0 internal: 1 - uuid: 496a769e-ad54-48b3-a5eb-0a5c8b83395f category: contact config: values: [] ask: 1 display: website: 0 internal: 1 - uuid: 790ebdf2-7b60-4d02-851d-7c7a680f172b category: contact config: values: [] ask: 1 display: website: 0 internal: 1 - uuid: c570a05e-31dc-4f1c-9669-9facb038ea2e category: contact config: values: [] ask: 1 display: website: 0 internal: 1 - uuid: 3f61ae81-2738-46dd-a83d-b09bc596d763 category: contact config: values: [] ask: 1 display: website: 0 internal: 1 - uuid: 9665763e-7476-470a-9a65-a0bd3e062813 category: contact config: values: [] ask: 1 display: website: 0 internal: 1 - uuid: 8b2432a9-d76f-48aa-8eca-2e56a13ba6cd category: contact config: values: [] ask: 1 display: website: 0 internal: 0 - uuid: 133786cb-0c16-4ccd-bbd8-5c6d01077e2f category: contact config: values: [] ask: 1 display: website: 0 internal: 0 - uuid: 4646dc1b-9e03-47ab-b438-cddc40904fba category: contact config: values: [] ask: 1 display: website: 0 internal: 0 - uuid: 3d7db803-2456-427b-9969-5b1c5d19ce3b category: contact config: values: [] ask: 1 display: website: 0 internal: 0 - uuid: 6803a26b-4a15-435f-8b2a-b965c6657244 category: contact config: values: [] ask: 1 display: website: 0 internal: 0 - uuid: ba1b6736-2d5e-4987-8863-ed283a706a32 category: contact config: values: [] ask: 1 display: website: 0 internal: 0 - uuid: 3adfb028-3db6-46d9-920f-9234a1c2b8b5 category: participant config: values: [] ask: 2 display: website: 2 internal: 1 - uuid: 1d154db9-f77a-4233-9526-4aeba23efe69 category: participant config: values: [] ask: 2 display: website: 2 internal: 1 - uuid: 0774fe06-9d14-4d88-bd36-4eebe638f5b6 category: participant config: values: [] ask: 2 display: website: 2 internal: 1 - uuid: 8bac68fc-1711-4377-bd4f-8e1790d528c4 category: participant config: values: [] ask: 2 display: website: 2 internal: 1 - uuid: 0dabee8f-50fb-4114-b368-7c15a0604f37 category: participant config: values: [] ask: 2 display: website: 2 internal: 1 - uuid: 235b964b-7b1f-4cf3-b322-541079f0b333 category: participant config: values: [] ask: 2 display: website: 2 internal: 1 schema: type: object properties: label: type: string setting: type: array items: type: object properties: uuid: type: string category: type: string config: type: object properties: values: type: array items: {} ask: type: number display: type: object properties: website: type: number internal: type: number required: - uuid - category - config /v1/setting/bookingInfo/{bookingInfoUuid}: get: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string data: type: object properties: uuid: type: string label: type: string fields: type: array items: type: object properties: uuid: type: string category: type: string label: type: string type: type: string config: type: object properties: values: type: array items: {} ask: type: number display: type: object properties: website: type: number internal: type: number required: - uuid - category - label - type - config example: code: S0000 codeMessage: SUCCESS data: uuid: 5dfa699c-bfe8-44f7-b7cb-3a53dbc423a1 label: Booking Data for Day Tour fields: - uuid: 5b9256e0-0442-470f-8e80-4587703c4470 category: contact label: First Name type: input config: values: [] ask: 1 display: website: 2 internal: 1 - uuid: adefb4ec-b408-4f5e-b71d-d1c79599cdbc category: contact label: Last Name type: input config: values: [] ask: 1 display: website: 2 internal: 1 - uuid: bb3b43f7-996d-4e86-97b3-ffff35032e9a category: contact label: Email type: email config: values: [] ask: 1 display: website: 2 internal: 1 - uuid: 2a3536a5-a94a-4619-9af7-a93e0110874b category: contact label: Mobile type: phone config: values: [] ask: 1 display: website: 2 internal: 1 - uuid: 57035281-8a2a-4c76-8a44-f9cfa3117654 category: contact label: Phone type: phone config: values: [] ask: 1 display: website: 0 internal: 1 - uuid: b13428d9-b9ff-473c-a612-66b6637221ed category: contact label: Fax type: phone config: values: [] ask: 1 display: website: 0 internal: 1 - uuid: 10662538-eef3-4171-9972-41300fa473d9 category: contact label: Gender type: select config: values: [] ask: 1 display: website: 0 internal: 1 - uuid: 251a6a27-7fbc-4411-83ec-dfd1e9b93b1b category: contact label: Date of Birth type: date config: values: [] ask: 1 display: website: 0 internal: 1 - uuid: 4e34479f-fe84-4bd3-a443-bbd7df182537 category: contact label: Preferred Language type: language config: values: [] ask: 1 display: website: 0 internal: 1 - uuid: 96e58831-e2df-453b-8a6e-4fd74da1dd64 category: contact label: Company Name type: input config: values: [] ask: 1 display: website: 0 internal: 1 - uuid: 496a769e-ad54-48b3-a5eb-0a5c8b83395f category: contact label: Country/Territory type: country config: values: [] ask: 1 display: website: 0 internal: 1 - uuid: 790ebdf2-7b60-4d02-851d-7c7a680f172b category: contact label: State/County/Region type: state config: values: [] ask: 1 display: website: 0 internal: 1 - uuid: c570a05e-31dc-4f1c-9669-9facb038ea2e category: contact label: City/Town/Suburb type: city config: values: [] ask: 1 display: website: 0 internal: 1 - uuid: 3f61ae81-2738-46dd-a83d-b09bc596d763 category: contact label: Postcode/ZIP type: input config: values: [] ask: 1 display: website: 0 internal: 1 - uuid: 9665763e-7476-470a-9a65-a0bd3e062813 category: contact label: Address type: input config: values: [] ask: 1 display: website: 0 internal: 1 - uuid: 8b2432a9-d76f-48aa-8eca-2e56a13ba6cd category: contact config: values: [] ask: 1 display: website: 0 internal: 0 - uuid: 133786cb-0c16-4ccd-bbd8-5c6d01077e2f category: contact config: values: [] ask: 1 display: website: 0 internal: 0 - uuid: 4646dc1b-9e03-47ab-b438-cddc40904fba category: contact config: values: [] ask: 1 display: website: 0 internal: 0 - uuid: 3d7db803-2456-427b-9969-5b1c5d19ce3b category: contact config: values: [] ask: 1 display: website: 0 internal: 0 - uuid: 6803a26b-4a15-435f-8b2a-b965c6657244 category: contact config: values: [] ask: 1 display: website: 0 internal: 0 - uuid: ba1b6736-2d5e-4987-8863-ed283a706a32 category: contact config: values: [] ask: 1 display: website: 0 internal: 0 - uuid: 3adfb028-3db6-46d9-920f-9234a1c2b8b5 category: participant label: First Name type: input config: values: [] ask: 2 display: website: 2 internal: 1 - uuid: 1d154db9-f77a-4233-9526-4aeba23efe69 category: participant label: Last Name type: input config: values: [] ask: 2 display: website: 2 internal: 1 - uuid: 0774fe06-9d14-4d88-bd36-4eebe638f5b6 category: participant label: Gender type: select config: values: [] ask: 2 display: website: 2 internal: 1 - uuid: 8bac68fc-1711-4377-bd4f-8e1790d528c4 category: participant label: Date of Birth type: date config: values: [] ask: 2 display: website: 2 internal: 1 - uuid: 0dabee8f-50fb-4114-b368-7c15a0604f37 category: participant label: Nationality type: input config: values: [] ask: 2 display: website: 2 internal: 1 - uuid: 235b964b-7b1f-4cf3-b322-541079f0b333 category: participant label: Passport number type: input config: values: [] ask: 2 display: website: 2 internal: 1 summary: Get Booking Information operationId: get-v1-setting-bookingInfo-bookingInfoUuid description: "Load an existing booking information by bookingInfoUuid. Rezio provides various pre-defined datasets, including Contact/Delivery/Participant/Dietary/Flight fields and you can customize fields.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/setting/bookingInfo/{bookingInfoUuid}
HTTP MethodGET
ParametersIn Uri
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters- In Uri\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
bookingInfoUuidUUIDYBooking information UUID
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
dataobjectBooking information data, check data for details
\n\n##### *data*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
uuidUUIDBooking information rule UUID
labelstringName of Booking information rule
fieldsarrayField data, check fields for details
\n\n##### *fields*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
uuidUUIDBooking Field UUID\n
categorystringBooking field category
labelstringDisplay name of booking field
typestringField type, available input style:
\n input One-line text field
\n multi-line Multi-lines text field
\n text Text area
\n inline inline field
\n select Options. Check option to get list
\n checkbox Checkbox, 1 checked; 0 un-checked
\n email Email field
\n phone Phone field. Format is array, includes country code/ phone number. Check /v1/dataOption?option=countryAll iti for country code value
\n date Date picker. Format is YYYY-MM-DD
\n datetime Datetime picker. Format is YYYY-MM-DD HH:II:SS
\n shoe Shoes options, shoe type: Man/Woman/Kid; option provides shoe sizes
\n country UUID. Check /v1/dataOption?option=countryAll for details
\n state string, input address of State
\n city string, input address of City
\n language\ \ UUID. Check /v1/dataOption?option=language for details\n
configarrayConfiguation or options for display usage, check config for details
\n\n##### *config*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
valuesarrayValues
\n Available when type = shoe/select
\n Check shoe, check shoe/ select for details\n
askintAsk for everyone's data?
\n 1 Ask once per order
\n 2 Ask for everyone\n
displayobjectDisplay option
\n Check display for details
\n Note: The order created by Rezio API will be considered as website\n
\n\n##### *shoe*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
typestringShoes type
\n Man
\n Woman
\n Kid\n
sizearrayShoe sizes
\n\n##### *display*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
websiteintIs required on website?
\n 0 Hide field/ Not required
\n 1 Optional
\n 2 Required\n
internalintIs required on internal order (via Rezio Admin)?
\n 0 Hide field/ Not required
\n 1 Optional
\n 2 Required\n
" tags: - Setting - Booking Information parameters: - name: bookingInfoUuid in: path description: '' required: true example: 5dfa699c-bfe8-44f7-b7cb-3a53dbc423a1 schema: type: string put: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string example: code: S0000 codeMessage: SUCCESS summary: Update Booking Information operationId: put-v1-setting-bookingInfo-bookingInfoUuid description: "Update booking information by bookingInfoUuid\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/setting/bookingInfo
HTTP MethodPUT
ParametersIn Uri & Raw Body
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters- In Uri\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
bookingInfoUuidUUIDYBooking information UUID
\n\n##### Parameters- Raw Body\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeLimitRequiredDescription
labelstringLength limit
varchar(300)		YName
settingarray-YField setting
\n Check setting via List Booking Field for details
\n Required field when field type = contact, ask and display will be overwritten.\n
\n\n##### *setting*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
uuidUUIDYBooking field UUID
\n Check List Booking Field to get UUID.\n
categorystringYBooking filed category
\n Check /v1/setting/bookingField to get UUID
\n Please make sure the booking field UUID and category were matched according to /v1/setting/bookingField\n
configarrayYConfiguation or options for display usage, check config for details
\n\n##### *config*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
valuesarrayValues
\n Available when type = shoe, check shoe for details\n
askintAsk for everyone's data?
\n 1 Ask once per order
\n 2 Ask for everyone\n
displayobjectDisplay option
\n Check display for details
\n Note: The order created by Rezio API will be considered as website\n
\n\n##### *shoe*\n\n\n \n \n \n \n \n \n \n \n \n \n \n\ \ \n \n \n \n \n \n \n \n \n
NameTypeDescription
typestringShoes type
\n Man
\n Woman
\n Kid\n
minintThe smallest size
\n Check shoe via List Booking Field to get available sizes.\n
maxintThe largest size
\n Check shoe via List Booking Field to get available sizes.\n
\n\n##### *display*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
websiteintIs required on website?
\n 0 Hide field/ Not required
\n 1 Optional
\n 2 Required
\n Check config/display/website via List Booking Field for details\n
internalintIs required on internal order (via Rezio Admin)?
\n 0 Hide field/ Not required
\n 1 Optional
\n 2 Required
\n Check config/display/internal via List Booking Field for details \n
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
" tags: - Setting - Booking Information parameters: - name: bookingInfoUuid in: path required: true schema: type: string requestBody: content: application/json: example: label: Booking Data for Day Tour setting: - uuid: 5b9256e0-0442-470f-8e80-4587703c4470 category: contact config: values: [] ask: 1 display: website: 2 internal: 1 - uuid: adefb4ec-b408-4f5e-b71d-d1c79599cdbc category: contact config: values: [] ask: 1 display: website: 2 internal: 2 - uuid: bb3b43f7-996d-4e86-97b3-ffff35032e9a category: contact config: values: [] ask: 1 display: website: 2 internal: 2 - uuid: 2a3536a5-a94a-4619-9af7-a93e0110874b category: contact config: values: [] ask: 1 display: website: 2 internal: 2 - uuid: 57035281-8a2a-4c76-8a44-f9cfa3117654 category: contact config: values: [] ask: 1 display: website: 0 internal: 1 - uuid: b13428d9-b9ff-473c-a612-66b6637221ed category: contact config: values: [] ask: 1 display: website: 0 internal: 1 - uuid: 10662538-eef3-4171-9972-41300fa473d9 category: contact config: values: [] ask: 1 display: website: 0 internal: 1 - uuid: 251a6a27-7fbc-4411-83ec-dfd1e9b93b1b category: contact config: values: [] ask: 1 display: website: 0 internal: 1 - uuid: 4e34479f-fe84-4bd3-a443-bbd7df182537 category: contact config: values: [] ask: 1 display: website: 0 internal: 1 - uuid: 96e58831-e2df-453b-8a6e-4fd74da1dd64 category: contact config: values: [] ask: 1 display: website: 0 internal: 1 - uuid: 496a769e-ad54-48b3-a5eb-0a5c8b83395f category: contact config: values: [] ask: 1 display: website: 0 internal: 1 - uuid: 790ebdf2-7b60-4d02-851d-7c7a680f172b category: contact config: values: [] ask: 1 display: website: 0 internal: 1 - uuid: c570a05e-31dc-4f1c-9669-9facb038ea2e category: contact config: values: [] ask: 1 display: website: 0 internal: 1 - uuid: 3f61ae81-2738-46dd-a83d-b09bc596d763 category: contact config: values: [] ask: 1 display: website: 0 internal: 1 - uuid: 9665763e-7476-470a-9a65-a0bd3e062813 category: contact config: values: [] ask: 1 display: website: 0 internal: 1 - uuid: 3adfb028-3db6-46d9-920f-9234a1c2b8b5 category: participant config: values: [] ask: 2 display: website: 2 internal: 1 - uuid: 1d154db9-f77a-4233-9526-4aeba23efe69 category: participant config: values: [] ask: 2 display: website: 2 internal: 1 - uuid: 0774fe06-9d14-4d88-bd36-4eebe638f5b6 category: participant config: values: [] ask: 2 display: website: 2 internal: 1 - uuid: 8bac68fc-1711-4377-bd4f-8e1790d528c4 category: participant config: values: [] ask: 2 display: website: 2 internal: 1 - uuid: 0dabee8f-50fb-4114-b368-7c15a0604f37 category: participant config: values: [] ask: 2 display: website: 2 internal: 1 - uuid: 235b964b-7b1f-4cf3-b322-541079f0b333 category: participant config: values: [] ask: 2 display: website: 2 internal: 1 schema: type: object properties: label: type: string setting: type: array items: type: object properties: uuid: type: string category: type: string config: type: object properties: values: type: array items: {} ask: type: number display: type: object properties: website: type: number internal: type: number required: - uuid - category - config /v1/setting/bookingField: get: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string data: type: object properties: fields: type: array items: type: object properties: uuid: type: string category: type: string label: type: string type: type: string config: type: object properties: values: type: array items: type: object properties: label: type: string value: type: string type: type: string size: type: array items: type: number required: - label - value - type - size ask: type: array items: type: number display: type: object properties: website: type: array items: type: number internal: type: array items: type: number required: - uuid - category - label - type - config example: code: S0000 codeMessage: SUCCESS data: fields: - uuid: 5b9256e0-0442-470f-8e80-4587703c4470 category: contact label: First Name type: input config: values: [] ask: - 1 display: website: - 1 - 2 internal: - 1 - 2 - uuid: adefb4ec-b408-4f5e-b71d-d1c79599cdbc category: contact label: Last Name type: input config: values: [] ask: - 1 display: website: - 2 internal: - 2 - uuid: bb3b43f7-996d-4e86-97b3-ffff35032e9a category: contact label: Email type: email config: values: [] ask: - 1 display: website: - 2 internal: - 2 - uuid: 2a3536a5-a94a-4619-9af7-a93e0110874b category: contact label: Mobile type: phone config: values: [] ask: - 1 display: website: - 1 - 2 internal: - 1 - 2 - uuid: 57035281-8a2a-4c76-8a44-f9cfa3117654 category: contact label: Phone type: phone config: values: [] ask: - 1 display: website: - 0 - 1 - 2 internal: - 1 - 2 - uuid: b13428d9-b9ff-473c-a612-66b6637221ed category: contact label: Fax type: phone config: values: [] ask: - 1 display: website: - 0 - 1 - 2 internal: - 1 - 2 - uuid: 10662538-eef3-4171-9972-41300fa473d9 category: contact label: Gender type: select config: values: - label: Male value: ORDER.GENDER_MALE - label: Female value: ORDER.GENDER_FEMALE - label: Other value: ORDER.GENDER_OTHER - label: Refuse to answer value: ORDER.GENDER_REFUSE ask: - 1 display: website: - 0 - 1 - 2 internal: - 1 - 2 - uuid: 251a6a27-7fbc-4411-83ec-dfd1e9b93b1b category: contact label: Date of Birth type: date config: values: [] ask: - 1 display: website: - 0 - 1 - 2 internal: - 1 - 2 - uuid: 4e34479f-fe84-4bd3-a443-bbd7df182537 category: contact label: Preferred Language type: language config: values: [] ask: - 1 display: website: - 0 - 1 - 2 internal: - 1 - 2 - uuid: 96e58831-e2df-453b-8a6e-4fd74da1dd64 category: contact label: Company Name type: input config: values: [] ask: - 1 display: website: - 0 - 1 - 2 internal: - 1 - 2 - uuid: 496a769e-ad54-48b3-a5eb-0a5c8b83395f category: contact label: Country/Territory type: country config: values: [] ask: - 1 display: website: - 0 - 1 - 2 internal: - 1 - 2 - uuid: 790ebdf2-7b60-4d02-851d-7c7a680f172b category: contact label: State/County/Region type: state config: values: [] ask: - 1 display: website: - 0 - 1 - 2 internal: - 1 - 2 - uuid: c570a05e-31dc-4f1c-9669-9facb038ea2e category: contact label: City/Town/Suburb type: city config: values: [] ask: - 1 display: website: - 0 - 1 - 2 internal: - 1 - 2 - uuid: 3f61ae81-2738-46dd-a83d-b09bc596d763 category: contact label: Postcode/ZIP type: input config: values: [] ask: - 1 display: website: - 0 - 1 - 2 internal: - 1 - 2 - uuid: 9665763e-7476-470a-9a65-a0bd3e062813 category: contact label: Address type: input config: values: [] ask: - 1 display: website: - 0 - 1 - 2 internal: - 1 - 2 - uuid: 6889a024-c007-4697-8041-6284c46c5aeb category: delivery label: Recipient's Name type: input config: values: [] ask: - 0 - 1 - 2 display: website: - 0 - 1 - 2 internal: - 0 - 1 - 2 - uuid: f3692548-86fb-4f62-9e29-37c919aff31b category: delivery label: Contact Mobile/Phone type: phone config: values: [] ask: - 0 - 1 - 2 display: website: - 0 - 1 - 2 internal: - 0 - 1 - 2 - uuid: 3aa7ebe3-851f-452d-b620-6f1eaf67d52b category: delivery label: Country/Territory type: country config: values: [] ask: - 0 - 1 - 2 display: website: - 0 - 1 - 2 internal: - 0 - 1 - 2 - uuid: 149a0c53-84e2-4494-8868-a13c084acc04 category: delivery label: State/County/Region type: state config: values: [] ask: - 0 - 1 - 2 display: website: - 0 - 1 - 2 internal: - 0 - 1 - 2 - uuid: 6f460b27-1aa0-4fba-80c8-c779518df94e category: delivery label: City/Town/Suburb type: city config: values: [] ask: - 0 - 1 - 2 display: website: - 0 - 1 - 2 internal: - 0 - 1 - 2 - uuid: dd122da0-f5c9-4f23-8deb-7ccdb6263a66 category: delivery label: Postcode/ZIP type: input config: values: [] ask: - 0 - 1 - 2 display: website: - 0 - 1 - 2 internal: - 0 - 1 - 2 - uuid: 08d65ff5-0a6d-4893-a61c-23276aa7ec00 category: delivery label: Address type: input config: values: [] ask: - 0 - 1 - 2 display: website: - 0 - 1 - 2 internal: - 0 - 1 - 2 - uuid: 3adfb028-3db6-46d9-920f-9234a1c2b8b5 category: participant label: First Name type: input config: values: [] ask: - 0 - 1 - 2 display: website: - 0 - 1 - 2 internal: - 0 - 1 - 2 - uuid: 1d154db9-f77a-4233-9526-4aeba23efe69 category: participant label: Last Name type: input config: values: [] ask: - 0 - 1 - 2 display: website: - 0 - 1 - 2 internal: - 0 - 1 - 2 - uuid: 23ada713-3198-47cd-aa17-e926f21a0833 category: participant label: Phone type: phone config: values: [] ask: - 0 - 1 - 2 display: website: - 0 - 1 - 2 internal: - 0 - 1 - 2 - uuid: e1533953-2e56-4788-b720-823da230f972 category: participant label: Mobile type: phone config: values: [] ask: - 0 - 1 - 2 display: website: - 0 - 1 - 2 internal: - 0 - 1 - 2 - uuid: 26639e7f-4ad1-4899-8cd9-28efc66cfca8 category: participant label: Fax type: phone config: values: [] ask: - 0 - 1 - 2 display: website: - 0 - 1 - 2 internal: - 0 - 1 - 2 - uuid: cad6001e-7570-4ed4-b44a-6b82d8de6282 category: participant label: Email type: email config: values: [] ask: - 0 - 1 - 2 display: website: - 0 - 1 - 2 internal: - 0 - 1 - 2 - uuid: 0774fe06-9d14-4d88-bd36-4eebe638f5b6 category: participant label: Gender type: select config: values: - label: Male value: ORDER.GENDER_MALE - label: Female value: ORDER.GENDER_FEMALE - label: Other value: ORDER.GENDER_OTHER - label: Refuse to answer value: ORDER.GENDER_REFUSE ask: - 0 - 1 - 2 display: website: - 0 - 1 - 2 internal: - 0 - 1 - 2 - uuid: 8bac68fc-1711-4377-bd4f-8e1790d528c4 category: participant label: Date of Birth type: date config: values: [] ask: - 0 - 1 - 2 display: website: - 0 - 1 - 2 internal: - 0 - 1 - 2 - uuid: bdf4e4bb-3690-497d-bc9f-e464f0d5446d category: participant label: Preferred Language type: language config: values: [] ask: - 0 - 1 - 2 display: website: - 0 - 1 - 2 internal: - 0 - 1 - 2 - uuid: f379dbfc-4e0a-47f1-bb1a-d877f2765815 category: participant label: Company Name type: input config: values: [] ask: - 0 - 1 - 2 display: website: - 0 - 1 - 2 internal: - 0 - 1 - 2 - uuid: 0dabee8f-50fb-4114-b368-7c15a0604f37 category: participant label: Nationality type: input config: values: [] ask: - 0 - 1 - 2 display: website: - 0 - 1 - 2 internal: - 0 - 1 - 2 - uuid: 235b964b-7b1f-4cf3-b322-541079f0b333 category: participant label: Passport number type: input config: values: [] ask: - 0 - 1 - 2 display: website: - 0 - 1 - 2 internal: - 0 - 1 - 2 - uuid: 5dea397c-da90-49ed-a7a1-4522d3157565 category: participant label: Body Height (cm) type: input config: values: [] ask: - 0 - 1 - 2 display: website: - 0 - 1 - 2 internal: - 0 - 1 - 2 - uuid: 0de5e7aa-be96-4da3-a81d-c92f4fcc8742 category: participant label: Body Height (inch) type: input config: values: [] ask: - 0 - 1 - 2 display: website: - 0 - 1 - 2 internal: - 0 - 1 - 2 - uuid: 64b586ed-3ed9-43a4-88ed-e12879dbdb20 category: participant label: Body Weight (kg) type: input config: values: [] ask: - 0 - 1 - 2 display: website: - 0 - 1 - 2 internal: - 0 - 1 - 2 - uuid: 50338105-4905-4ffd-8c28-8fe66c6cf755 category: participant label: Body Weight (lb) type: input config: values: [] ask: - 0 - 1 - 2 display: website: - 0 - 1 - 2 internal: - 0 - 1 - 2 - uuid: 67617774-fd86-4053-8988-b2dde09b3ae1 category: participant label: Eyeglass Prescription type: input config: values: [] ask: - 0 - 1 - 2 display: website: - 0 - 1 - 2 internal: - 0 - 1 - 2 - uuid: 6ff2f952-74e4-44b6-8e8e-e4be129a0017 category: participant label: Shoe Size (mm) type: shoe config: values: - type: Man size: - 200 - 205 - 210 - 215 - 220 - 225 - 230 - 235 - 240 - 245 - 250 - 255 - 260 - 265 - 270 - 275 - 280 - 285 - 290 - 295 - 300 - 305 - 310 - 315 - 320 - type: Woman size: - 200 - 205 - 210 - 215 - 220 - 225 - 230 - 235 - 240 - 245 - 250 - 255 - 260 - 265 - 270 - 275 - 280 - 285 - 290 - 295 - 300 - 305 - 310 - 315 - 320 - type: Kid size: - 80 - 85 - 90 - 95 - 100 - 105 - 110 - 115 - 120 - 125 - 130 - 135 - 140 - 145 - 150 - 155 - 160 - 165 - 170 - 175 - 180 - 185 - 190 - 195 - 200 ask: - 0 - 1 - 2 display: website: - 0 - 1 - 2 internal: - 0 - 1 - 2 - uuid: 8f3ad124-51f7-4d99-9137-e7903dc377cf category: participant label: Shoe Size (US) type: shoe config: values: - type: Man size: - 1 - 1.5 - 2 - 2.5 - 3 - 3.5 - 4 - 4.5 - 5 - 5.5 - 6 - 6.5 - 7 - 7.5 - 8 - 8.5 - 9 - 9.5 - 10 - 10.5 - 11 - 11.5 - 12 - 12.5 - 13 - 13.5 - 14 - 14.5 - 15 - type: Woman size: - 2 - 2.5 - 3 - 3.5 - 4 - 4.5 - 5 - 5.5 - 6 - 6.5 - 7 - 7.5 - 8 - 8.5 - 9 - 9.5 - 10 - 10.5 - 11 - 11.5 - 12 - 12.5 - 13 - 13.5 - 14 - 14.5 - 15 - 15.5 - 16 - type: Kid size: - 1 - 1.5 - 2 - 2.5 - 3 - 3.5 - 4 - 4.5 - 5 - 5.5 - 6 - 6.5 - 7 - 7.5 - 8 - 8.5 - 9 - 9.5 - 10 - 10.5 - 11 - 11.5 - 12 - 12.5 - 13 ask: - 0 - 1 - 2 display: website: - 0 - 1 - 2 internal: - 0 - 1 - 2 - uuid: 7901ca25-b9b3-466a-a33d-e0c6156df754 category: participant label: Shoe Size (EUR) type: shoe config: values: - type: Man size: - 32 - 33 - 34 - 35 - 36 - 37 - 38 - 39 - 40 - 41 - 42 - 43 - 44 - 45 - 46 - 47 - 48 - 49 - type: Woman size: - 32 - 33 - 34 - 35 - 36 - 37 - 38 - 39 - 40 - 41 - 42 - 43 - 44 - 45 - 46 - 47 - 48 - 49 - type: Kid size: - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 30 - 31 ask: - 0 - 1 - 2 display: website: - 0 - 1 - 2 internal: - 0 - 1 - 2 - uuid: e7808532-d110-48f3-842d-a9724f26a430 category: participant label: Shoe Size (UK) type: shoe config: values: - type: Man size: - 0 - 0.5 - 1 - 1.5 - 2 - 2.5 - 3 - 3.5 - 4 - 4.5 - 5 - 5.5 - 6 - 6.5 - 7 - 7.5 - 8 - 8.5 - 9 - 9.5 - 10 - 10.5 - 11 - 11.5 - 12 - 12.5 - 13 - 13.5 - 14 - type: Woman size: - 0 - 0.5 - 1 - 1.5 - 2 - 2.5 - 3 - 3.5 - 4 - 4.5 - 5 - 5.5 - 6 - 6.5 - 7 - 7.5 - 8 - 8.5 - 9 - 9.5 - 10 - 10.5 - 11 - 11.5 - 12 - 12.5 - 13 - 13.5 - 14 - type: Kid size: - 0 - 0.5 - 1 - 1.5 - 2 - 2.5 - 3 - 3.5 - 4 - 4.5 - 5 - 5.5 - 6 - 6.5 - 7 - 7.5 - 8 - 8.5 - 9 - 9.5 - 10 - 10.5 - 11 - 11.5 - 12 - 12.5 - 13 ask: - 0 - 1 - 2 display: website: - 0 - 1 - 2 internal: - 0 - 1 - 2 - uuid: fb05be5f-799b-4abf-a5d9-03a066c75b18 category: dietary label: Vegan type: checkbox config: values: [] ask: - 0 - 1 - 2 display: website: - 0 - 1 - 2 internal: - 0 - 1 - 2 - uuid: 4ec014c2-0711-441f-a911-991a6ad0fade category: dietary label: Kosher Meals type: checkbox config: values: [] ask: - 0 - 1 - 2 display: website: - 0 - 1 - 2 internal: - 0 - 1 - 2 - uuid: 2ab085c6-fcc5-46ed-b8ae-6c73f0a0356a category: dietary label: Halal Meals type: checkbox config: values: [] ask: - 0 - 1 - 2 display: website: - 0 - 1 - 2 internal: - 0 - 1 - 2 - uuid: 12e4c604-6fa3-4710-98bb-d38c42bb67f1 category: dietary label: Gluten Free type: checkbox config: values: [] ask: - 0 - 1 - 2 display: website: - 0 - 1 - 2 internal: - 0 - 1 - 2 - uuid: 5d2ff20b-a317-4ebf-84f6-c1951c12630f category: dietary label: Egg Free type: checkbox config: values: [] ask: - 0 - 1 - 2 display: website: - 0 - 1 - 2 internal: - 0 - 1 - 2 - uuid: e5a67d5f-f1ce-4e23-bd31-b2e9f92b5803 category: dietary label: Fish Free type: checkbox config: values: [] ask: - 0 - 1 - 2 display: website: - 0 - 1 - 2 internal: - 0 - 1 - 2 - uuid: fdc7da68-740f-4ca0-9117-4e6b4712672a category: dietary label: Lactose Free type: checkbox config: values: [] ask: - 0 - 1 - 2 display: website: - 0 - 1 - 2 internal: - 0 - 1 - 2 - uuid: 0dd55e40-52f5-4cbb-a6ea-4fd9b3d0c123 category: dietary label: Peanut Free type: checkbox config: values: [] ask: - 0 - 1 - 2 display: website: - 0 - 1 - 2 internal: - 0 - 1 - 2 - uuid: 8415e556-1653-4bba-9aca-20a6d063e944 category: dietary label: Tree nut Free type: checkbox config: values: [] ask: - 0 - 1 - 2 display: website: - 0 - 1 - 2 internal: - 0 - 1 - 2 - uuid: 7a6c32df-c458-45bd-9f9f-af99748cc1b1 category: dietary label: Soy Free type: checkbox config: values: [] ask: - 0 - 1 - 2 display: website: - 0 - 1 - 2 internal: - 0 - 1 - 2 - uuid: 8167445f-8e7d-4d7a-bd68-a504ec9b5e3a category: dietary label: Corn Free type: checkbox config: values: [] ask: - 0 - 1 - 2 display: website: - 0 - 1 - 2 internal: - 0 - 1 - 2 - uuid: 47bf71ff-9b9f-4fb2-aa31-41f8750c5fd3 category: flight label: Arrival Airline type: input config: values: [] ask: - 0 - 1 - 2 display: website: - 0 - 1 - 2 internal: - 0 - 1 - 2 - uuid: 664e6664-b53c-49c9-8f81-646ee50271c4 category: flight label: Arrival Flight No. type: input config: values: [] ask: - 0 - 1 - 2 display: website: - 0 - 1 - 2 internal: - 0 - 1 - 2 - uuid: 3284387d-1fb6-46fa-b120-ca0fa6e56e1c category: flight label: Arrival Date and Time type: datetime config: values: [] ask: - 0 - 1 - 2 display: website: - 0 - 1 - 2 internal: - 0 - 1 - 2 - uuid: caf27900-8932-41fa-9737-6e87365f3b58 category: flight label: Arrival Terminal type: input config: values: [] ask: - 0 - 1 - 2 display: website: - 0 - 1 - 2 internal: - 0 - 1 - 2 - uuid: 73b61be6-bd43-467b-81a0-cbaae59d8b30 category: flight label: Departure Airline type: input config: values: [] ask: - 0 - 1 - 2 display: website: - 0 - 1 - 2 internal: - 0 - 1 - 2 - uuid: 23c1ab3e-d145-4921-9d10-6ea651f309db category: flight label: Departure Flight No. type: input config: values: [] ask: - 0 - 1 - 2 display: website: - 0 - 1 - 2 internal: - 0 - 1 - 2 - uuid: 15350f40-9613-42d1-a898-9cdaa41846d8 category: flight label: Departure Date and Time type: datetime config: values: [] ask: - 0 - 1 - 2 display: website: - 0 - 1 - 2 internal: - 0 - 1 - 2 - uuid: 20be164d-8ec4-4e60-9c6c-ffe9cf4d7a88 category: flight label: Departure Terminal type: input config: values: [] ask: - 0 - 1 - 2 display: website: - 0 - 1 - 2 internal: - 0 - 1 - 2 - uuid: c4a816c3-45a8-404b-b970-fcb8b3a23499 category: custom label: demo custom text field type: text config: values: [] ask: - 0 - 1 - 2 display: website: - 0 - 1 - 2 internal: - 0 - 1 - 2 summary: List Booking Field operationId: get-v1-setting-bookingField description: "Load all booking fields\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/setting/bookingField
HTTP MethodGET
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters\n\nNone\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
dataobjectResponse data, check data for details
\n\n##### *data*\n\n\n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
fieldsarrayCheck fields for details
\n\n##### *fields*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
uuidUUIDBooking field UUID
categorystringBooking field category
labelstringName
typestringField type, available input style:
\n input One-line text field
\n multi-line Multi-lines text field
\n text Text area
\n inline inline field
\n select Options. Check option to get list
\n checkbox Checkbox, 1 checked; 0 un-checked
\n email Email field
\n phone Phone field. Format is array, includes country code/ phone number. Check /v1/dataOption?option=countryAll iti for country code value
\n date Date picker. Format is YYYY-MM-DD
\n datetime Datetime picker. Format is YYYY-MM-DD HH:II:SS
\n shoe Shoes options, shoe type: Man/Woman/Kid; option provides shoe sizes
\n country UUID. Check /v1/dataOption?option=countryAll for details
\n state string, input address of State
\n city string, input address of City
\n language UUID. Check /v1/dataOption?option=language for details\n
configarrayConfiguration or options for display usage, check config for details
\n\n##### *config*\n\n\n \n \n \n \n \n \n \n \n \ \ \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
valuesarrayValues
\n Available when type = shoe/select
\n Check shoe, check shoe/ select for details\n
askintAsk for everyone's data?
\n 0 Hide/ Not required
\n 1 Ask once per order
\n 2 Ask for everyone\n
displayobjectDisplay option
\n Check display for details
\n Note: The order created by Rezio API will be considered as website\n
\n\n##### *shoe*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
typestringShoes type
\n Man
\n Woman
\n Kid\n
sizearrayShoe sizes
\n\n##### *display*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
websiteintIs required on website?
\n 0 Hide field/ Not required
\n 1 Optional
\n 2 Required\n
internalintIs required on internal order (via Rezio Admin)?
\n 0 Hide field/ Not required
\n 1 Optional
\n 2 Required\n
" tags: - Setting - Booking Information /v1/setting/pickup: get: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string data: type: object properties: totalCount: type: number page: type: number itemPerPage: type: number list: type: array items: type: object properties: uuid: type: string label: type: string locationCnt: type: number type: type: number duration: type: number bindingProductCnt: type: number required: - uuid - label - locationCnt - type - duration - bindingProductCnt example: code: S0000 codeMessage: SUCCESS data: totalCount: 2 page: 1 itemPerPage: 20 list: - uuid: a087e0de-2cc8-40b7-adb9-2e6a01dd14b7 label: Day Tour City Hotels Pickup locationCnt: 1 type: 2 duration: 0 bindingProductCnt: 0 - uuid: 9173c3f0-1734-4e4a-b402-293b46184205 label: Pickup from Taipei Train Station and Ximen MRT Station locationCnt: 2 type: 1 duration: 30 bindingProductCnt: 1 summary: List Pick Up operationId: get-v1-setting-pickup description: "List all existing pickup rules. Filters like label name are available.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/setting/pickup
HTTP MethodGET
ParametersQuery string
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
labelstring-Name
typeint-Route type
\n 1 Fixed pickup route
\n 2 Allow customer to input pickup request\n
pageint-Pages. Default/minimum value is 1
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
dataobjectResponse data, check data for details
\n\n##### *data*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
totalCountintRecord counts
pageintCurrent page number
itemPerPageintRecord counts per page. Default/maximum value is 20
listarrayPickup data, check list for details
\n\n##### *list*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
uuidUUIDPickup Rule UUID
labelstringName
typeintRoute type
\n 1 Fixed pickup route
\n 2 Allow customer to input pickup request\n
durationintTravel time from pickup location to meeting place or destination (in minutes)
locationCntintNumber of pickup locations
bindingProductCntintUsed products
" tags: - Setting - Pick Up parameters: - name: label in: query description: '' schema: type: string - name: type in: query description: '' schema: type: string enum: - '1' - '2' - name: page in: query description: '' schema: type: string post: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string data: type: object properties: uuid: type: string example: code: S0000 codeMessage: SUCCESS data: uuid: 9173c3f0-1734-4e4a-b402-293b46184205 summary: Create Pick Up operationId: post-v1-setting-pickup description: "Create a new pickup rule\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/setting/pickup
HTTP MethodPOST
ParametersRaw Body
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeLimitRequiredDescription
labelstringLength limit
varchar(200)		YName
typeint-YRoute type
\n 1 Fixed pickup route
\n 2 Allow customer to input pickup request\n
referenceTimestring--Reference time
\n Required when Route type = 1
\n Format is HH:mm. Range is HH 00~23; mm 00, 30\n
timeBeforeSessionint-YIs pickup ahead of schedule (tour departure time)?
\n 1 Yes, ahead
\n 0 No, behind\n
locationarray-YPickup location details
\n When Route type = 1, check location 1
\n When Route type = 2, check location 2\n
\n\n##### *location - type1*\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeLimitRequiredDescription
labelstringLength limit
varchar(100)		YLocation name, it's the option list of pickup when customer does a booking
instructionsstring--Location instructions
addressLinestringLength limit
varchar(200)		YReal address
pickupTimeint-YTravel time to pickup from this location (in minutes)
latitudenumber--Location latitude
longitudenumber--Location longitude
\n\n##### *location - type2*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\ \ \n \n \n \n \n \n \n \n
NameTypeLimitRequiredDescription
labelstringLength limit
varchar(100)		YLocation description for pickup
instructionsstring--Notes for location
vehiclestringLength limit
varchar(50)		-The vehicle for pickup, i.e., mini van
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
dataobjectPickup data, check data for details
\n\n##### *data*\n\n\n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
uuidUUIDPickup UUID
" tags: - Setting - Pick Up requestBody: content: application/json: example: label: Pickup from Taipei Train Station and Ximen MRT Station type: 1 referenceTime: 09:00 timeBeforeSession: 1 location: - label: Ximen MRT Station instructions: 'Ximen MRT Exit #5, Looking for the guide with yellow T-shirt.' addressLine: No.32-1, Baoqing Rd., Zhongzheng Dist., Taipei, Taiwan pickupTime: 20 latitude: '25.042887' longitude: '121.5082038' - label: Taipei Main Station (East Gate 3) instructions: Taipei Main Station, East Gate 3, Looking for the guide with yellow T-shirt. addressLine: No. 3, Beiping W. Rd., Zhongzheng Dist., Taipei, Taiwan pickupTime: 10 latitude: '25.0475267' longitude: '121.5159648' schema: type: object properties: label: type: string type: type: number referenceTime: type: string timeBeforeSession: type: number location: type: array items: type: object properties: label: type: string instructions: type: string addressLine: type: string pickupTime: type: number latitude: type: string longitude: type: string required: - label - instructions - addressLine - pickupTime - latitude - longitude /v1/setting/pickup/{pickupUuid}: get: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string data: type: object properties: uuid: type: string label: type: string type: type: number referenceTime: type: string timeBeforeSession: type: number location: type: array items: type: object properties: pickupLocationUuid: type: string label: type: string instructions: type: string addressLine: type: string pickupTime: type: number latitude: type: string longitude: type: string required: - pickupLocationUuid - label - instructions - addressLine - pickupTime - latitude - longitude example: code: S0000 codeMessage: SUCCESS data: uuid: 9173c3f0-1734-4e4a-b402-293b46184205 label: Pickup from Taipei Train Station and Ximen MRT Station type: 1 referenceTime: 09:00 timeBeforeSession: 1 location: - pickupLocationUuid: 060452d3-3271-49d9-bdf5-607596c63c39 label: Ximen MRT Station instructions: 'Ximen MRT Exit #5, Looking for the guide with yellow T-shirt.' addressLine: No.32-1, Baoqing Rd., Zhongzheng Dist., Taipei, Taiwan pickupTime: 20 latitude: '25.042887' longitude: '121.5082038' - pickupLocationUuid: 67de4120-2cce-409b-b6ea-ae257363e258 label: Taipei Main Station (East Gate 3) instructions: Taipei Main Station, East Gate 3, Looking for the guide with yellow T-shirt. addressLine: No. 3, Beiping W. Rd., Zhongzheng Dist., Taipei, Taiwan pickupTime: 10 latitude: '25.0475267' longitude: '121.5159648' summary: Get Pick Up operationId: get-v1-setting-pickup-pickupUuid description: "Load an existing pickup rules by pickupUuid\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/setting/pickup/{pickupUuid}
HTTP MethodGET
ParametersIn Uri
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
pickupUuidUUIDYPickup UUID
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
dataobjectResponse data, check data for details
\n\n##### *data*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
uuidUUIDPickup Rule UUID
labelstringName
typeintRoute type
\n 1 Relative time pickup route
\n 2 Allow customers to input pickup requests
\n 3 Fixed time pickup route
\n 4 No specified time pickup route\n
referenceTimestringReference time
\n Available when Route type = 1; format is HH:mm, i.e., 09:00\n
timeBeforeSessionintIs pickup ahead of schedule (tour departure time)?
\n 1 Yes, ahead
\n 0 No, behind
\n Available when Route type = 1, for example, tour from 08:00 AM, pickup at 07:45 AM, timeBeforeSession = 1; pickup at 08:15 AM, timeBeforeSession = 0.\n
locationarrayPickup location details
\n When Route type = 1, check location 1
\n When Route type = 2, check location 2\n
\n\n##### *location - type1*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\ \ \n \n \n \n \n \n
NameTypeDescription
pickupLocationUuidUUIDPickup location UUID
labelstringLocation name, it's the option list of pickup when customer does a booking
instructionsstringLocation instructions
addressLinestringReal address
pickupTimeintTravel time to pickup from this location (in minutes)
latitudestringLocation latitude
longitudestringLocation longitude
\n\n##### *location - type2*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
pickupLocationUuidUUIDPickup location UUID
labelstringLocation description for pickup
instructionsstringNotes for location
vehiclestringThe vehicle for pickup, e.g., mini van
" tags: - Setting - Pick Up parameters: - name: pickupUuid in: path description: '' required: true schema: type: string put: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string example: code: S0000 codeMessage: SUCCESS summary: Update Pick Up operationId: put-v1-setting-pickup-pickupUuid description: "Update a pickup rule by pickupUuid\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/setting/pickup
HTTP MethodPUT
ParametersIn Uri & Raw Body
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters- In Uri\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
pickupUuidUUIDYPickup Rule UUID
\n\n##### Parameters- Raw Body\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeLimitRequiredDescription
labelstringLength limit
varchar(200)		YName
typeint-YRoute type
\n 1 Fixed pickup route
\n 2 Allow customer to input pickup request\n
referenceTimestring--Reference time
\n Required when Route type = 1
\n Format is HH:mm. Range is HH 00~23; mm 00, 30\n
timeBeforeSessionint-YIs pickup ahead of schedule (tour departure time)?
\n 1 Yes, ahead
\n 0 No, behind\n
locationarray-YPickup location details
\n When Route type = 1, check location 1
\n When Route type = 2, check location 2\n
\n\n##### *location - type1*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\
NameTypeLimitRequiredDescription
pickupLocationUuidUUID-Y\n Pickup Location UUID
\n Leave it empty when create a new pickup location\n
labelstringLength limit
varchar(100)		YLocation name, it's the option list of pickup when customer does a booking
instructionsstring--Location instructions
addressLinestring-YReal address
pickupTimeint-YTravel time to pickup from this location (in minutes)
latitudenumber--Location latitude
longitudenumber--Location longitude
\n\n##### *location - type2*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeLimitRequiredDescription
pickupLocationUuidUUID-Y\n Pickup Location UUID
\n Leave it empty when create a new pickup location\n
labelstringLength limit
varchar(100)		YLocation description for pickup
instructionsstring--Notes for location
vehiclestringLength limit
varchar(50)		-The vehicle for pickup, i.e., mini van
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
" tags: - Setting - Pick Up parameters: - name: pickupUuid in: path description: '' required: true example: 9173c3f0-1734-4e4a-b402-293b46184205 schema: type: string requestBody: content: application/json: example: label: Pickup from Taipei Train Station and Ximen MRT Station type: 1 referenceTime: 09:00 timeBeforeSession: 1 location: - pickupLocationUuid: 060452d3-3271-49d9-bdf5-607596c63c39 label: Ximen MRT Station instructions: 'Ximen MRT Exit #5, Looking for the guide with yellow vest guide' addressLine: No.32-1, Baoqing Rd., Zhongzheng Dist., Taipei, Taiwan pickupTime: 25 latitude: '25.042887' longitude: '121.5082038' - pickupLocationUuid: 67de4120-2cce-409b-b6ea-ae257363e258 label: Taipei Main Station (East Gate 3) instructions: Taipei Main Station, East Gate 3, Looking for the guide with yellow T-shirt. addressLine: No. 3, Beiping W. Rd., Zhongzheng Dist., Taipei, Taiwan pickupTime: 10 latitude: '25.0475267' longitude: '121.5159648' schema: type: object properties: label: type: string type: type: number referenceTime: type: string timeBeforeSession: type: number location: type: array items: type: object properties: pickupLocationUuid: type: string label: type: string instructions: type: string addressLine: type: string pickupTime: type: number latitude: type: string longitude: type: string required: - pickupLocationUuid - label - instructions - addressLine - pickupTime - latitude - longitude /v1/setting/extra: get: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string data: type: object properties: totalCount: type: number page: type: number itemPerPage: type: number list: type: array items: type: object properties: uuid: type: string label: type: string currencyUuid: type: string priceType: type: number price: type: number imageUrl: type: string bindingProductCnt: type: number example: code: S0000 codeMessage: SUCCESS data: totalCount: 1 page: 1 itemPerPage: 20 list: - uuid: 82097bf2-d2a8-458a-b5f9-cc807a060c82 label: Tea Time Meal Set currencyUuid: b5317f07-b5a0-4525-8ff7-3fe55b4d96ec priceType: 2 price: 9.9 imageUrl: https://img.box.rezio.io/cebf3f02-f2e8-4bba-bff5-af7ab303255c/98530b7a-5eea-440e-a82c-f14a39277531.png bindingProductCnt: 1 summary: List Extras operationId: get-v1-setting-extra description: "List all existing extra items. Filters like label name are available.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/setting/extra
HTTP MethodGET
ParametersQuery string
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters- Query string\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
labelstring-Name
currencystring/ UUID-Currency
\n Accept ISO-4217 Code or Rezio Currency UUID
\n Check/getDataOption?option=currency to get code/ UUID\n
pageint-Pages. Default/minimum value is 1
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
dataobjectResponse data, check data for details
\n\n##### *data*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
totalCountintRecord counts
pageintCurrent page number
itemPerPageintRecord counts per page. Default/maximum value is 20
listarrayExtra data, check list for details
\n\n##### *list*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
uuidUUIDExtra item UUID
labelstringName
currencyUuidUUIDCurrency UUID
\n Rezio Currency UUID, check/getDataOption?option=currency UUID for details\n
priceTypeintPrice type of extra item
\n 1 Per order (1 order charge once)
\n 2 Per quantity (customers can decide how many items they need)\n
pricenumberPrice
imageUrlstringThe image URL of extra item
bindingProductCntintUsed products
" tags: - Setting - Extras parameters: - name: label in: query description: '' schema: type: string - name: currency in: query description: '' example: TWD schema: type: string - name: page in: query description: '' schema: type: string post: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string data: type: object properties: uuid: type: string example: code: S0000 codeMessage: SUCCESS data: uuid: 82097bf2-d2a8-458a-b5f9-cc807a060c82 summary: Create Extra operationId: post-v1-setting-extra description: "Create a new extra item\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/setting/extra
HTTP MethodPOST
ParametersRaw Body
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeLimitRequiredDescription
labelstringLength limit
varchar(255)		YName
currencystring/ UUID-YCurrency
\n Accept ISO-4217 Code or Rezio Currency UUID
\n Check/getDataOption?option=currency to get code/ UUID\n
priceTypeint-YPrice type of extra item
\n 1 Per order (1 order charge once)
\n 2 Per quantity (customers can decide how many items they need)\n
pricenumber-YPrice
descriptionstring--Item description
storeMediaUsageUuidUUID--Image UUID associated with extra item
\n Use Upload Extra Image to add image then get storeMediaUsageUuid in the response as parameter here.\n
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
dataobjectResponse data, check data for details
\n\n##### *data*\n\n\n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
uuidUUIDExtra item UUID
" tags: - Setting - Extras requestBody: content: application/json: example: label: Tea Time Meal Set priceType: 2 price: 9.9 currency: USD description: Famous tea restaurant in Jiufen Old Street, get extra deal to get 20% off discount! storeMediaUsageUuid: d745af31-40fd-4410-a7de-1ac211fc9e30 schema: type: object properties: label: type: string priceType: type: number price: type: number currency: type: string description: type: string storeMediaUsageUuid: type: string /v1/setting/extra/{extraUuid}: get: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string data: type: object properties: uuid: type: string label: type: string priceType: type: number price: type: number description: type: string currencyUuid: type: string imageUrl: type: string storeMediaUsageUuid: type: string example: code: S0000 codeMessage: SUCCESS data: uuid: 82097bf2-d2a8-458a-b5f9-cc807a060c82 label: Tea Time Meal Set priceType: 2 price: 9.9 description: Famous tea restaurant in Jiufen Old Street, get extra deal to get 20% off discount! currencyUuid: b5317f07-b5a0-4525-8ff7-3fe55b4d96ec imageUrl: https://img.box.rezio.io/cebf3f02-f2e8-4bba-bff5-af7ab303255c/98530b7a-5eea-440e-a82c-f14a39277531.png storeMediaUsageUuid: d745af31-40fd-4410-a7de-1ac211fc9e30 summary: Get Extra operationId: get-v1-setting-extra-extraUuid description: "Load an existing extra item by extraUuid\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/setting/extra/{extraUuid}
HTTP MethodGET
ParametersIn Uri
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters- In Uri\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
extraUuidUUIDYExtra item UUID
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
dataobjectResponse data, check data for details
\n\n##### *data*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
uuidUUIDResource UUID
labelstringName
priceTypeintPrice type of extra item
\n 1 Per order (1 order charge once)
\n 2 Per quantity (customers can decide how many items they need)\n
pricenumberPrice
descriptionstringItem description
currencyUuidUUIDCurrency UUID
\n Rezio Currency UUID, check/getDataOption?option=currency UUID for details\n
imageUrlstringThe image URL of extra item
storeMediaUsageUuidUUIDImage UUID associated with extra item
\n Check Upload Extra Image for more detail\n
" tags: - Setting - Extras parameters: - name: extraUuid in: path description: '' required: true example: 82097bf2-d2a8-458a-b5f9-cc807a060c82 schema: type: string put: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string example: code: S0000 codeMessage: SUCCESS summary: Update Extra operationId: put-v1-setting-extra-extraUuid description: "Update an extra item by extraUuid\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/setting/extra/{extraUuid}
HTTP MethodPUT
ParametersIn Uri & Raw Body
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters- In Uri\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
extraUuidUUIDYExtra UUID
\n\n##### Parameters- Raw Body\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeLimitRequiredDescription
labelstringLength limit
varchar(255)		YName
currencystring/ UUID-YCurrency
\n Accept ISO-4217 Code or Rezio Currency UUID
\n Check/getDataOption?option=currency to get code/ UUID\n
priceTypeint-YPrice type of extra item
\n 1 Per order (1 order charge once)
\n 2 Per quantity (customers can decide how many items they need)\n
pricenumber-YPrice
descriptionstring--Item description
storeMediaUsageUuidUUID--Image UUID associated with extra item
\n Use Upload Extra Image to add image then get storeMediaUsageUuid in the response as parameter here.\n
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
" tags: - Setting - Extras parameters: - name: extraUuid in: path required: true schema: type: string requestBody: content: application/json: example: label: Tea Time Meal Set priceType: 2 price: 7.9 currency: USD description: June Limit Sale, Down to $7.9!! Famous tea restaurant in Jiufen Old Street, get extra deal to get 20% off discount! storeMediaUsageUuid: d745af31-40fd-4410-a7de-1ac211fc9e30 schema: type: object properties: label: type: string priceType: type: number price: type: number currency: type: string description: type: string storeMediaUsageUuid: type: string /v1/setting/extra/image: post: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string data: type: object properties: file: type: object properties: storeMediaUsageUuid: type: string url: type: string example: code: S0000 codeMessage: SUCCESS data: file: storeMediaUsageUuid: d745af31-40fd-4410-a7de-1ac211fc9e30 url: https://img.box.rezio.io/cebf3f02-f2e8-4bba-bff5-af7ab303255c/98530b7a-5eea-440e-a82c-f14a39277531.png summary: Upload Extra Image operationId: post-v1-setting-extra-image description: "Add an image for extra item. File is mandatory and put in form-data parameter 'file'.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/setting/extra/image
HTTP MethodPOST
ParametersFile
HeadersX-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters- File\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
filefileYImage file\n
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
dataobjectResponse data, check data for details
\n\n##### *data*\n\n\n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
filearrayCheck file for details
\n\n##### *file*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
storeMediaUsageUuidUUIDImage UUID
urlstringURL of uploaded image
" tags: - Setting - Extras requestBody: required: true content: multipart/form-data: schema: type: object required: - file properties: file: type: string format: binary /v1/setting/resource: get: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string data: type: object properties: totalCount: type: number page: type: number itemPerPage: type: number list: type: array items: type: object properties: uuid: type: string label: type: string seat: type: number isGroup: type: number groupDetail: type: array items: type: object properties: uuid: type: string label: type: string seat: type: string required: - uuid - label - seat required: - uuid - label - seat - isGroup - groupDetail example: code: S0000 codeMessage: SUCCESS data: totalCount: 2 page: 1 itemPerPage: 20 list: - uuid: 194f23d4-06d8-4101-b902-a7ca20352d7c label: Safety helmet seat: 90 isGroup: 1 groupDetail: - uuid: 73b021e1-5d3b-483e-bc1e-e7155dfb0a47 label: Safety helmet - Small seat: '50' - uuid: 6fa655a3-5160-4c71-a1d0-4050f0345faa label: Safety helmet - Large seat: '40' - uuid: 6fd0646e-aeed-445c-b19f-5c0d5099ac17 label: Portable Translator (Multi-language) seat: 100 isGroup: 0 groupDetail: [] summary: List Resource operationId: get-v1-setting-resource description: "List all existing resources. Filters like label name are available.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/setting/resource
HTTP MethodGET
ParametersQuery string
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters- Query string\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
labelstring-Name
resourceTypeUuidUUID-Resource type
\n Check /v1/dataOption?option=resourceType for details\n
pageint-Pages. Default/minimum value is 1
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
dataobjectResponse data, check data for details
\n\n##### *data*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
totalCountintRecord counts
pageintCurrent page number
itemPerPageintRecord counts per page. Default/maximum value is 20
listarrayResource data, check list for details
\n\n##### *list*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
uuidUUIDResource UUID
labelstringName
seatintResource availability
\n Skip it when isGroup = 1, the value will be overwritten by the sum of group's children resource seats.\n
isGroupintSingle or Group resource?
\n 1 Yes, Group
\n 0 No, Single
\n
groupDetailarrayGroup resource details
\n Check groupDetail for details
\n\n##### *groupDetail*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\ \ \n \n \n \n \n \n
NameTypeDescription
uuidUUIDResource UUID
labelstringName
seatintResource availability
\n This value was summed up with other children's resources in the same group and overwrites the upper seat value.\n
" tags: - Setting - Resource parameters: - name: label in: query description: '' schema: type: string - name: resourceTypeUuid in: query description: '' schema: type: string - name: page in: query description: '' schema: type: string post: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string data: type: object properties: uuid: type: string example: code: S0000 codeMessage: SUCCESS data: uuid: 194f23d4-06d8-4101-b902-a7ca20352d7c summary: Create Resource operationId: post-v1-setting-resource description: "Create a new resource\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/setting/resource
HTTP MethodPOST
ParametersRaw Body
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeLimitRequiredDescription
labelstringLength limit
varchar(100)		YName
resourceTypeUuidUUID-YResource Type UUID
\n Check /getDataOption?option=resourceType for details
intervalobject-YThe interval time of resource usage
\n day Day
\n hour Hour
\n min Minute\n
startAtstring-YFirst available time of resource
\n Format is HH:mm
\n Range is HH 00~23; mm 00, 15, 30, 45\n
seatint--Resource availability
\n Skip it when isGroup = 1, the value will be overwritten by the sum of group's children resource seats.\n
isGroupint-YSingle or Group resource?
\n 1 Yes, Group
\n 0 No, Single\n
groupDetailarray-YGroup resource details
\n Check groupDetail for details
stockWarningobject-YLow availability display settings
\n Check stockWarning for details
\n\n##### *groupDetail*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
labelstringYName
seatintYResource availability
\n This value were summed up with other children resource in the same group and overwrite the upper seat value.\n
\n\n##### *stockWarning*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \ \ \n \n
NameTypeRequiredDescription
typeintYLow availability display settings type
\n 0 No specific
\n 1 By percentage
\n 2 By a specific amount
\n
numberintYPercentage/Number
\n Required when type = 1 or type = 2\n
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
dataobjectResponse data, check data for details
\n\n##### *data*\n\n\n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
uuidUUIDResource UUID
" tags: - Setting - Resource requestBody: content: application/json: example: label: Safety helmet resourceTypeUuid: 636bd039-7486-418b-84f6-518687619c46 seat: 90 isGroup: 1 startAt: 08:00 interval: day: 0 hour: 10 min: 0 groupDetail: - uuid: 73b021e1-5d3b-483e-bc1e-e7155dfb0a47 label: Safety helmet - Small seat: '50' - uuid: 6fa655a3-5160-4c71-a1d0-4050f0345faa label: Safety helmet - Large seat: '40' stockWarning: type: 0 schema: type: object properties: label: type: string resourceTypeUuid: type: string seat: type: number isGroup: type: number startAt: type: string interval: type: object properties: day: type: number hour: type: number min: type: number groupDetail: type: array items: type: object properties: uuid: type: string label: type: string seat: type: string required: - uuid - label - seat stockWarning: type: object properties: type: type: number /v1/setting/resource/{resourceUuid}: get: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string data: type: object properties: uuid: type: string label: type: string resourceTypeUuid: type: string seat: type: number isGroup: type: number groupDetail: type: array items: type: object properties: uuid: type: string label: type: string seat: type: string required: - uuid - label - seat startAt: type: string interval: type: object properties: day: type: number hour: type: number min: type: number stockWarning: type: object properties: type: type: number example: code: S0000 codeMessage: SUCCESS data: uuid: 194f23d4-06d8-4101-b902-a7ca20352d7c label: Safety helmet resourceTypeUuid: 636bd039-7486-418b-84f6-518687619c46 seat: 90 isGroup: 1 groupDetail: - uuid: 73b021e1-5d3b-483e-bc1e-e7155dfb0a47 label: Safety helmet - Small seat: '50' - uuid: 6fa655a3-5160-4c71-a1d0-4050f0345faa label: Safety helmet - Large seat: '40' startAt: 08:00 interval: day: 0 hour: 10 min: 0 stockWarning: type: 0 summary: Get Resource operationId: get-v1-setting-resource-resourceUuid description: "Load an existing resource by resourceUuid\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/setting/resource
HTTP MethodGET
ParametersIn Uri
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
resourceUuidUUIDYResource UUID
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
dataobjectRessource data, check data for details
\n\n##### *data*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
uuidUUIDResource UUID
labelstringName
resourceTypeUuidUUIDResource Type UUID
\n Check /getDataOption?option=resourceType for details
intervalobjectThe interval time of resource usage
\n day Day
\n hour Hour
\n min Minute\n
startAtstringFirst available time of resource
\n Format is HH:mm
\n Range is HH 00~23; mm 00, 15, 30, 45\n
seatintResource availability
\n Skip it when isGroup = 1, the value will be overwritten by the sum of group's children resource seats.\n
isGroupintSingle or Group resource?
\n 1 Yes, Group
\n 0 No, Single
\n
groupDetailarrayGroup resource details
\n Check groupDetail for details
stockWarningobjectLow availability display settings
\n Check stockWarning for details
\n\n##### *groupDetail*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
uuidUUIDResource UUID, group resource
labelstringName
seatintResource availability
\n This value was\ \ summed up with other children's resources in the same group and overwrites the upper seat value.\n
\n\n##### *stockWarning*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
typeintLow availability display settings type
\n 0 No specific
\n 1 By percentage
\n 2 By a specific amount
\n
numberintPercentage/Number
\n Required when type = 1 or type = 2\n
" tags: - Setting - Resource parameters: - name: resourceUuid in: path description: '' required: true schema: type: string put: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string example: code: S0000 codeMessage: SUCCESS summary: Update Resource operationId: put-v1-setting-resource-resourceUuid description: "Update a resource by resourceUuid (Updatable fields are restricted when the resource is applied to product)
\n\n> Updatable fields when the target resourceUuid was applied to products:\n> - `label`, `resourceTypeUuid`\n> - `label` in groupDetail of Group resource (isGroup = 1)\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/setting/resource
HTTP MethodPUT
ParametersIn Uri & Raw Body
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters- In Uri\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
resourceUuidUUIDYResource UUID
\n\n##### Parameters- Raw Body\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeLimitRequiredDescription
labelstringLength limit
varchar(100)		YName
resourceTypeUuidUUID-YResource Type UUID
\n Check /getDataOption?option=resourceType for details
intervalobject-YThe interval time of resource usage
\n day Day
\n hour Hour
\n min Minute\n
startAtstring-YFirst available time of resource
\n Format is HH:mm
\n Range is HH 00~23; mm 00, 15, 30, 45\n
seatint--Resource availability
\n Skip it when isGroup = 1, the value will be overwritten by the sum of group's children resource seats.\n
isGroupint-YSingle or Group resource?
\n 1 Yes, Group
\n 0 No, Single\n
groupDetailarray-YGroup resource details
\n Check groupDetail for details
stockWarningobject-YLow availability display settings
\n Check stockWarning for details
\n\n##### *groupDetail*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \ \ \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
uuidUUID-Resource item UUID, item of a group resource
\n Leave UUID empty will create a new group resource item. If you need to update an existing group resource, please check Get Resource to get UUIDs.\n
labelstringYName
seatintYResource availability
\n This value was summed up with other children's resources in the same group and overwrites the upper seat value.\n
\n\n##### *stockWarning*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
typeintYLow availability display settings type
\n 0 No specific
\n 1 By percentage
\n 2 By a specific amount
\n
numberintYPercentage/Number
\n Required when type = 1 or type = 2\n
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
" tags: - Setting - Resource parameters: - name: resourceUuid in: path required: true schema: type: string requestBody: content: application/json: example: label: Safety helmet (Yellow) resourceTypeUuid: 636bd039-7486-418b-84f6-518687619c46 seat: 90 isGroup: 1 startAt: 08:00 interval: day: 0 hour: 10 min: 0 groupDetail: - uuid: 73b021e1-5d3b-483e-bc1e-e7155dfb0a47 label: Safety helmet - Small seat: '50' - uuid: 6fa655a3-5160-4c71-a1d0-4050f0345faa label: Safety helmet - Large seat: '40' stockWarning: type: 2 number: 10 schema: type: object properties: label: type: string resourceTypeUuid: type: string seat: type: number isGroup: type: number startAt: type: string interval: type: object properties: day: type: number hour: type: number min: type: number groupDetail: type: array items: type: object properties: uuid: type: string label: type: string seat: type: string required: - uuid - label - seat stockWarning: type: object properties: type: type: number number: type: number /v1/product/list: get: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string data: type: object properties: totalCount: type: number page: type: number itemPerPage: type: number list: type: array items: type: object properties: uuid: type: string categoryUuid: type: string title: type: string productCode: type: string coverUrl: type: string salesOptionList: type: array items: type: string status: type: string statusAvailableUntil: type: string example: code: S0000 codeMessage: SUCCESS data: totalCount: 1 page: 1 itemPerPage: 20 list: - uuid: 597a8861-82ce-4770-892a-ab718f76a63c categoryUuid: 7b191497-9ef1-4c15-9231-fc4ac70ca4d9 title: 'Day Tour from Taipei: Jiufen Old Street, Golden Waterfall, and Bitou Cape' productCode: JIUFENA1 coverUrl: https://img.box.rezio.io/cebf3f02-f2e8-4bba-bff5-af7ab303255c/597a8861-82ce-4770-892a-ab718f76a63c/d46c6de8-32b6-409a-b403-318442fd0afc.png salesOptionList: - Day tour status: AVAILABLE_UNTIL statusAvailableUntil: '2019-06-25' summary: List Product operationId: get-v1-product-list description: "List all existing products. Filters like category or tag are available.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/product/list
HTTP MethodGET
ParametersQuery string
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
pageint-Pages. Default/minimum value is 1
itemPerPageint-Record counts per page. Default/maximum value is 20
textstring-Filter text, input product name or product code
categoryUuidUUID-Product Category UUID
\n Check /getDataOption?option=category for details\n
tagUuidUUID-Product Tag UUID
\n Check /getDataOption?option=tag for details\n
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
dataobjectProduct data, check data for details
\n\n##### *data*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
totalCountintRecord counts
pageintCurrent page number
itemPerPageintRecord counts per page. Default/maximum value is 20
listarrayProduct list, check list for details
\n\n##### *list*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\ \ \n \n \n \n \n \n \n \n
NameTypeDescription
uuidUUIDProduct UUID
categoryUuidUUIDProduct Category UUID
\n Check /getDataOption?option=category for details \n
titlestringProduct name
productCodestringProduct code
coverUrlstringURL of product cover image
salesOptionListarrayPackage list
statusstringProduct status
\n IN_PROGRESS Product is in editing, missing some required settings.
\n END_SELLING End of sale, no available future sessions.
\n FULLY_BOOKED Fully booked, capacity of all sessions is full.
\n DISCONTINUED Sale paused, all publishStatus of packages were turned off.
\n AVAILABLE_UNTIL Available until the last session date, normal product selling status.\n
statusAvailableUntilstringDate format YYYY-MM-DD, the last available session date.
Only available when status = 'AVAILABLE_UNTIL'
" tags: - Product List parameters: - name: page in: query description: '' example: '1' schema: type: string default: '1' - name: itemPerPage in: query description: '' example: '20' schema: type: string default: '20' - name: text in: query description: filter by product name, code schema: type: string - name: categoryUuid in: query description: product category UUID schema: type: string - name: tagUuid in: query description: product tag UUID schema: type: string /v1/product/{productUuid}/detail: get: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string data: type: object properties: uuid: type: string title: type: string brief: type: string description: type: string itinerary: type: array items: type: object properties: content: type: array items: type: object properties: uuid: type: string hour: type: string min: type: string type: type: number title: type: string storeMediaUsageUuid: type: string required: - uuid - hour - min - type - title - storeMediaUsageUuid warnings: type: string countryUuid: type: string currencyUuid: type: string priceStartAt: type: number categoryUuid: type: string languageUuid: type: string timezoneUuid: type: string productCode: type: string pickup: type: array items: type: object properties: uuid: type: string label: type: string direction: type: number type: type: number referenceTime: type: string timeBeforeSession: type: number location: type: array items: type: object properties: label: type: string instructions: type: string addressLine: type: string pickupTime: type: number latitude: type: string longitude: type: string pickupLocationUuid: type: string required: - label - instructions - addressLine - pickupTime - latitude - longitude - pickupLocationUuid required: - uuid - label - type - direction - referenceTime - timeBeforeSession - location translationLanguagesUuids: type: array items: {} guideLanguagesUuids: type: array items: type: string audioHeadsetLanguagesUuids: type: array items: {} writtenLanguagesUuids: type: array items: {} regionUuid: type: string duration: type: object properties: day: type: number hour: type: number min: type: number feeNdTax: type: array items: type: object properties: uuid: type: string label: type: string type: type: string charge: type: number included: type: number rule: type: string depositPolicy: type: object properties: uuid: type: string label: type: string policyType: type: number handlingCharge: type: number allowFullAmountPay: type: number allowMinAlarm: type: number dueDays: type: number cancelPolicy: type: object properties: uuid: type: string label: type: string policyRule: type: array items: type: object properties: from: type: number to: type: number periodUnit: type: string charge: type: number unit: type: string required: - from - to - periodUnit - charge - unit feeDetail: type: object properties: include: type: object properties: systemUuids: type: array items: type: string custom: type: array items: type: object properties: uuid: type: string label: type: string exclude: type: object properties: systemUuids: type: array items: type: string custom: type: array items: {} bookingInfo: type: object properties: uuid: type: string label: type: string storeUuid: type: string fields: type: array items: type: object properties: uuid: type: string category: type: string label: type: string type: type: string config: type: object properties: values: type: array items: {} ask: type: number display: type: object properties: website: type: number internal: type: number required: - uuid - category - label - type - config bookingCutline: type: object properties: bySessionTime: type: string type: type: string day: type: number time: type: string saleable: type: object properties: type: type: string day: type: number time: type: string location: type: object properties: destination: type: array items: type: object properties: uuid: type: string title: type: string address: type: string note: type: string display: type: number geo: type: object properties: lat: type: number lng: type: number storeMediaUsageUuid: {} regionUuid: type: string countryUuid: type: string landmarkUuid: type: string businessPhoneITI: type: number businessPhone: type: string businessWording: type: string isAllDay: type: boolean weekdays: type: object properties: Sun: type: object properties: from: type: string to: type: string last: type: string Mon: type: object properties: from: type: string to: type: string last: type: string Tue: type: object properties: from: type: string to: type: string last: type: string Wed: type: object properties: from: type: string to: type: string last: type: string Thu: type: object properties: from: type: string to: type: string last: type: string Fri: type: object properties: from: type: string to: type: string last: type: string Sat: type: object properties: from: type: string to: type: string last: type: string placeId: type: string placeIdTag: type: string mapSnapshotImage: type: string required: - uuid - title - address - note - display - geo - storeMediaUsageUuid - regionUuid - countryUuid - landmarkUuid - businessPhoneITI - businessPhone - businessWording - isAllDay - weekdays - placeId - placeIdTag - mapSnapshotImage meetPlace: type: array items: type: object properties: uuid: type: string title: type: string address: type: string note: type: string display: type: number geo: type: object properties: lat: type: number lng: type: number storeMediaUsageUuid: {} regionUuid: type: string countryUuid: type: string landmarkUuid: type: string businessPhoneITI: type: number businessPhone: type: string businessWording: type: string isAllDay: type: boolean weekdays: type: object properties: Sun: type: object properties: from: type: string to: type: string last: type: string Mon: type: object properties: from: type: string to: type: string last: type: string Tue: type: object properties: from: type: string to: type: string last: type: string Wed: type: object properties: from: type: string to: type: string last: type: string Thu: type: object properties: from: type: string to: type: string last: type: string Fri: type: object properties: from: type: string to: type: string last: type: string Sat: type: object properties: from: type: string to: type: string last: type: string placeId: type: string placeIdTag: type: string mapSnapshotImage: type: string exchange: type: array items: {} extra: type: array items: type: object properties: uuid: type: string label: type: string priceType: type: number price: type: number description: type: string imageUrl: type: string storeMediaUsageUuid: type: string acceptPayType: type: array items: type: number confirmType: type: number confirmHour: type: number confirmMode: type: number status: type: string statusAvailableUntil: type: string mainLandmarkUuid: type: string mainLandmark: type: string landmarkUuids: type: array items: {} voucherOptionUuid: type: string voucherDesc: type: string sendVoucherType: type: number sendVoucherHour: type: number sendVoucherMode: type: number example: code: S0000 codeMessage: SUCCESS data: uuid: 597a8861-82ce-4770-892a-ab718f76a63c title: 'Day Tour from Taipei: Jiufen Old Street, Golden Waterfall, and Bitou Cape' brief: Escape Taipei for a day to see Taiwan’s rugged beauty. Discover unique landscapes at Bitou Cape and Golden Waterfalls. Admire the historic Jiufen village and its rural charms. description: "－ Highlights － \n\n• Explore Bitou Cape, Nanya Rock Formations, and Golden Waterfalls\n• Delight in the mix of yellow and blue bay colors at Yin Yang Sea\n• Learn about the famous gold rush at the Gold Museum\n• Indulge in local delicacies along Jiufen’s ancient streets\n\n\n－ What You Can Expect － \n\nHead to Taiwan's northeastern coast for a day of scenic wonders. Visit Nanya Rock Formations and its sea-eroded coral shore. Check out charming stone patterns made by weathered sandstone. Observe steep cliffs, marine fossils, mushroom and honeycomb-shaped rocks at Bitou Cape. \n\nGaze upon the curious bay where yellow waters meet the blue ocean at Yin Yang Sea. Be mesmerized by Golden Waterfall’s waves cascading in spectacular fashion. This region was also once home to gold. Gain insight into the history of the gold rush, mining techniques, and tools,\n\nStroll the traditional village of Jiufen. Get surrounded by buildings and old streets bursting with character and culture. Browse stalls selling tasty delicacies to taste and interesting knick knacks. Discover Taiwan’s northern paradise today!\n\n\n－ Important Info －\n\n・Meeting Time: 8:50am - 9:00am\n・Last Departure Point: Taipei Main Station (East Gate 3)\n(Please look for our staff wearing Taiwan Tour Bus vests to confirm your attendance)\n・Duration: ~8 hrs\n・Returning Point: Taipei Main Station\n\n\n－ Additional Info －\n\n・The Gold Museum is closed on the first Monday of every month\n・Free admission for children under age 3, must be traveling with an adult and must not occupy a seat. Insurance must be purchased separately\n・Ages 3 and up will be charged an adult admission fee" itinerary: - content: - uuid: 816d6ec8-aece-435a-9524-7a1da5e44918 hour: 08 min: '40' type: 1 title: 'Pick up at Ximen MRT Exit #5 (Leave at 08:45)' - uuid: a9b02132-17bf-4692-8a2e-0482bbbd5558 hour: 08 min: '50' type: 1 title: Meet up at Taipei Main Station (East Gate 3) - uuid: 891d3a20-1cf0-44ba-955e-409f3606bc4d hour: 09 min: '00' type: 1 title: Depart to Bitou Cape storeMediaUsageUuid: '' - uuid: 7200bffb-7092-4fb2-87a7-7aa291a08e5c hour: '' min: '' type: 2 title: Stop at Bitou Cape storeMediaUsageUuid: '' - uuid: 4c8e517e-f188-4110-afc7-db6e27b9b9f0 hour: '' min: '' type: 2 title: Nan Ya Rock Formations storeMediaUsageUuid: 702b05c5-92ef-4694-ab11-2680bfbb4065 - uuid: 36c044b1-da9d-4928-86d4-4e1077103172 hour: '' min: '' type: 2 title: Yin Yang Sea storeMediaUsageUuid: 87f71476-3b35-4804-87c5-0085d903b5bc - uuid: b2f33b5e-6cb4-4fd3-b3dc-057a67b72cdf hour: '' min: '' type: 2 title: The Golden Waterfall storeMediaUsageUuid: a54007b7-8090-4c0f-a7f4-e283ce62376f - uuid: 609a7aab-7632-4027-887c-dfacd085f90d hour: '' min: '' type: 2 title: Gold Museum storeMediaUsageUuid: '' - uuid: 02d6ab27-2f11-4d67-b2ba-737cd21e0229 hour: '' min: '' type: 2 title: Lunch Time storeMediaUsageUuid: '' - uuid: 707194fc-5f80-4b68-bee0-4d8c0baac14c hour: '' min: '' type: 2 title: Jiufen Old Street storeMediaUsageUuid: 4dc2e817-cdbd-4f3c-9ab8-e8d5fa0e0c53 - uuid: 929db453-8530-40fc-8ee9-ab3ce6bbfbd8 hour: '17' min: '00' type: 1 title: Return to Taipei Main Station storeMediaUsageUuid: '' warnings: '・If total number of passengers is below 4 (the minimum requirement for this trip), you will be informed 3 days prior to departure ・Contact our customer service for refunds from schedule changes/cancellations due to traffic, weather, and other unexpected conditions ・Actual itinerary is dependent on weather/transportation conditions ・We will not provide refunds for missed tours due to late arrival ・Visitors to Taiwan must provide copies of their identification cards or passports for insurance purposes ・For English and Japanese service, there are tour guides and iPad guides available. The specific service cannot be selected by traveler, and is dependent on on-site availability' countryUuid: 23fdb4b8-0a8a-46aa-957a-e4d938d9866d currencyUuid: b5317f07-b5a0-4525-8ff7-3fe55b4d96ec priceStartAt: 29.99 categoryUuid: 7b191497-9ef1-4c15-9231-fc4ac70ca4d9 languageUuid: affd2a03-556b-43e5-b64b-022c0abd298f timezoneUuid: 6bda40f7-5e0c-4dbb-8c3f-63ef6db73363 productCode: JIUFENA1 pickup: - uuid: 9173c3f0-1734-4e4a-b402-293b46184205 label: Pickup from Taipei Train Station and Ximen MRT Station direction: 1 type: 1 referenceTime: 09:00 timeBeforeSession: 1 location: - label: Ximen MRT Station instructions: 'Ximen MRT Exit #5, Looking for the guide with yellow T-shirt.' addressLine: No.32-1, Baoqing Rd., Zhongzheng Dist., Taipei, Taiwan pickupTime: 20 latitude: '25.042887' longitude: '121.5082038' - label: Taipei Main Station (East Gate 3) instructions: Taipei Main Station, East Gate 3, Looking for the guide with yellow T-shirt. addressLine: No. 3, Beiping W. Rd., Zhongzheng Dist., Taipei, Taiwan pickupTime: 10 latitude: '25.0475267' longitude: '121.5159648' - uuid: 755e0377-e54b-4ea5-8039-7fd6e64fd533 label: Return to Taipei Main Station and Ximen MRT Station type: 1 direction: 2 referenceTime: '15:00' timeBeforeSession: 1 location: - pickupLocationUuid: 31e2bcd4-5613-4126-b619-c0e5eec10f55 label: Ximen MRT Station instructions: 'Ximen MRT Exit #5, Looking for the guide with yellow T-shirt.' addressLine: No.32-1, Baoqing Rd., Zhongzheng Dist., Taipei, Taiwan pickupTime: 20 latitude: '25.042887' longitude: '121.5082038' - pickupLocationUuid: defda692-e26b-4c82-b927-d78a2e37c44c label: Taipei Main Station (East Gate 3) instructions: Taipei Main Station, East Gate 3, Looking for the guide with yellow T-shirt. addressLine: No. 3, Beiping W. Rd., Zhongzheng Dist., Taipei, Taiwan pickupTime: 10 latitude: '25.034711' longitude: '121.521825' translationLanguagesUuids: [] guideLanguagesUuids: - 7e8eaa1f-330d-436a-b17d-bdbefe83ab20 - 18bf6598-1711-4296-b0b2-023479a016a8 - 8a6cc5a7-3890-4d73-b338-7eb209aa4b82 audioHeadsetLanguagesUuids: [] writtenLanguagesUuids: [] regionUuid: 8fefe93b-abdc-1778-7266-f2cdec9a00bb duration: day: 0 hour: 8 min: 0 feeNdTax: - uuid: 2dbe92c2-bf7c-46f8-9566-30e313368124 label: Invoice Tax type: TAX charge: 5 included: 1 rule: PERCENTAGE-ORDER depositPolicy: uuid: 4a957d29-f796-4f6c-8076-a4f6d6f05c4e label: Day Tour $100 Deposit per person policyType: 2 handlingCharge: 100 allowFullAmountPay: 0 allowMinAlarm: 1 dueDays: 3 cancelPolicy: uuid: 301646a7-3547-4fe9-bb50-a3c3860d895f label: Day Tour Cancel Rule policyRule: - from: 33 to: -1 periodUnit: DAY charge: 0 unit: PERCENTAGE - from: 23 to: 33 periodUnit: DAY charge: 20 unit: PERCENTAGE - from: 16 to: 23 periodUnit: DAY charge: 30 unit: PERCENTAGE - from: 4 to: 16 periodUnit: DAY charge: 50 unit: PERCENTAGE - from: -1 to: 4 periodUnit: DAY charge: 100 unit: PERCENTAGE feeDetail: include: systemUuids: - 2075baca-e1d3-4ca0-ae1b-3c77068e017a - 2a509272-0b12-498c-aa45-ea13fb38c30c custom: - uuid: 82534fee-89b0-41a0-863f-42b3cfe6d7cd label: Travel insurance (NT$2 million and medical fees at NT$30 thousand) exclude: systemUuids: - fa5e65c0-d5cc-4a77-a5c3-a2b2dd405446 - b2656af1-2bc8-4f2a-9fb9-6c3f545093fb custom: [] bookingInfo: uuid: 5dfa699c-bfe8-44f7-b7cb-3a53dbc423a1 label: Booking Data for Day Tour storeUuid: cebf3f02-f2e8-4bba-bff5-af7ab303255c fields: - uuid: 5b9256e0-0442-470f-8e80-4587703c4470 category: contact label: First Name type: input config: values: [] ask: 1 display: website: 2 internal: 1 - uuid: adefb4ec-b408-4f5e-b71d-d1c79599cdbc category: contact label: Last Name type: input config: values: [] ask: 1 display: website: 2 internal: 1 - uuid: bb3b43f7-996d-4e86-97b3-ffff35032e9a category: contact label: Email type: email config: values: [] ask: 1 display: website: 2 internal: 1 - uuid: 2a3536a5-a94a-4619-9af7-a93e0110874b category: contact label: Mobile type: phone config: values: [] ask: 1 display: website: 2 internal: 1 - uuid: 57035281-8a2a-4c76-8a44-f9cfa3117654 category: contact label: Phone type: phone config: values: [] ask: 1 display: website: 0 internal: 1 - uuid: b13428d9-b9ff-473c-a612-66b6637221ed category: contact label: Fax type: phone config: values: [] ask: 1 display: website: 0 internal: 1 - uuid: 10662538-eef3-4171-9972-41300fa473d9 category: contact label: Gender type: select config: values: [] ask: 1 display: website: 0 internal: 1 - uuid: 251a6a27-7fbc-4411-83ec-dfd1e9b93b1b category: contact label: Date of Birth type: date config: values: [] ask: 1 display: website: 0 internal: 1 - uuid: 4e34479f-fe84-4bd3-a443-bbd7df182537 category: contact label: Preferred Language type: language config: values: [] ask: 1 display: website: 0 internal: 1 - uuid: 96e58831-e2df-453b-8a6e-4fd74da1dd64 category: contact label: Company Name type: input config: values: [] ask: 1 display: website: 0 internal: 1 - uuid: 496a769e-ad54-48b3-a5eb-0a5c8b83395f category: contact label: Country/Territory type: country config: values: [] ask: 1 display: website: 0 internal: 1 - uuid: 790ebdf2-7b60-4d02-851d-7c7a680f172b category: contact label: State/County/Region type: state config: values: [] ask: 1 display: website: 0 internal: 1 - uuid: c570a05e-31dc-4f1c-9669-9facb038ea2e category: contact label: City/Town/Suburb type: city config: values: [] ask: 1 display: website: 0 internal: 1 - uuid: 3f61ae81-2738-46dd-a83d-b09bc596d763 category: contact label: Postcode/ZIP type: input config: values: [] ask: 1 display: website: 0 internal: 1 - uuid: 9665763e-7476-470a-9a65-a0bd3e062813 category: contact label: Address type: input config: values: [] ask: 1 display: website: 0 internal: 1 - uuid: 3adfb028-3db6-46d9-920f-9234a1c2b8b5 category: participant label: First Name type: input config: values: [] ask: 2 display: website: 2 internal: 1 - uuid: 1d154db9-f77a-4233-9526-4aeba23efe69 category: participant label: Last Name type: input config: values: [] ask: 2 display: website: 2 internal: 1 - uuid: 0774fe06-9d14-4d88-bd36-4eebe638f5b6 category: participant label: Gender type: select config: values: [] ask: 2 display: website: 2 internal: 1 - uuid: 8bac68fc-1711-4377-bd4f-8e1790d528c4 category: participant label: Date of Birth type: date config: values: [] ask: 2 display: website: 2 internal: 1 - uuid: 0dabee8f-50fb-4114-b368-7c15a0604f37 category: participant label: Nationality type: input config: values: [] ask: 2 display: website: 2 internal: 1 - uuid: 235b964b-7b1f-4cf3-b322-541079f0b333 category: participant label: Passport number type: input config: values: [] ask: 2 display: website: 2 internal: 1 bookingCutline: bySessionTime: START type: ABSOLUTE day: 2 time: '18:00' saleable: type: ABSOLUTE day: 30 time: '18:00' location: destination: - uuid: 404dfd5c-ab60-4c4c-a263-90516e0e2852 title: Jiufen address: Ruifang District, New Taipei City note: 九份老街 display: 1 geo: lat: 25.02622730382695 lng: 121.55901986176264 storeMediaUsageUuid: null regionUuid: 8fefe93b-abdc-1778-7266-f2cdec9a00bb countryUuid: 23fdb4b8-0a8a-46aa-957a-e4d938d9866d landmarkUuid: 9169c01f-54f4-4c44-936d-0dab6088ae4a businessPhoneITI: 886 businessPhone: '12334567' businessWording: 'Business hours: 10:00-17:00.' isAllDay: false weekdays: Sun: from: '10:00' to: '17:00' last: '16:00' Mon: from: '10:00' to: '17:00' last: '16:00' Tue: from: '10:00' to: '17:00' last: '16:00' Wed: from: '10:00' to: '17:00' last: '16:00' Thu: from: '10:00' to: '17:00' last: '16:00' Fri: from: '10:00' to: '17:00' last: '16:00' Sat: from: '10:00' to: '17:00' last: '16:00' placeId: ChIJcZT7-hdFXTQR0qekplqCFV8 placeIdTag: 九份老街 mapSnapshotImage: '' - uuid: 3e4f05f3-f91f-4447-98dd-77d6494c9a4d title: The Golden Waterfall address: Jinshui Rd., Ruifang Dist., New Taipei City note: '' display: 1 geo: lat: 25.013471245634832 lng: 121.55864331058858 storeMediaUsageUuid: null regionUuid: 8fefe93b-abdc-1778-7266-f2cdec9a00bb countryUuid: 23fdb4b8-0a8a-46aa-957a-e4d938d9866d landmarkUuid: 9169c01f-54f4-4c44-936d-0dab6088ae4a businessPhoneITI: 886 businessPhone: '12334567' businessWording: 'Business hours: 10:00-17:00.' isAllDay: false weekdays: Sun: from: '10:00' to: '17:00' last: '16:00' Mon: from: '10:00' to: '17:00' last: '16:00' Tue: from: '10:00' to: '17:00' last: '16:00' Wed: from: '10:00' to: '17:00' last: '16:00' Thu: from: '10:00' to: '17:00' last: '16:00' Fri: from: '10:00' to: '17:00' last: '16:00' Sat: from: '10:00' to: '17:00' last: '16:00' placeId: ChIJcZT7-hdFXTQR0qekplqCFV8 placeIdTag: 九份老街 mapSnapshotImage: '' meetPlace: - uuid: 046a152e-b6ed-4037-a856-4ad669cd199c title: Taipei Main Station address: No. 3, Beiping W. Rd., Zhongzheng Dist., Taipei, Taiwan note: East Gate 3 display: 1 geo: lat: 25.03396870000002 lng: 121.56228350000004 storeMediaUsageUuid: null regionUuid: 8fefe93b-abdc-1778-7266-f2cdec9a00bb countryUuid: 23fdb4b8-0a8a-46aa-957a-e4d938d9866d landmarkUuid: 9169c01f-54f4-4c44-936d-0dab6088ae4a businessPhoneITI: 886 businessPhone: '12334567' businessWording: 'Business hours: 10:00-17:00.' isAllDay: false weekdays: Sun: from: '10:00' to: '17:00' last: '16:00' Mon: from: '10:00' to: '17:00' last: '16:00' Tue: from: '10:00' to: '17:00' last: '16:00' Wed: from: '10:00' to: '17:00' last: '16:00' Thu: from: '10:00' to: '17:00' last: '16:00' Fri: from: '10:00' to: '17:00' last: '16:00' Sat: from: '10:00' to: '17:00' last: '16:00' placeId: ChIJcZT7-hdFXTQR0qekplqCFV8 placeIdTag: 九份老街 mapSnapshotImage: '' exchange: [] extra: - uuid: 82097bf2-d2a8-458a-b5f9-cc807a060c82 label: Tea Time Meal Set priceType: 2 price: 9.9 description: Famous tea restaurant in Jiufen Old Street, get extra deal to get 20% off discount! imageUrl: https://img.box.rezio.io/cebf3f02-f2e8-4bba-bff5-af7ab303255c/98530b7a-5eea-440e-a82c-f14a39277531.png storeMediaUsageUuid: d745af31-40fd-4410-a7de-1ac211fc9e30 acceptPayType: - 1 - 2 confirmType: 1 confirmHour: 48 confirmMode: 1 status: AVAILABLE_UNTIL statusAvailableUntil: '2019-06-25' mainLandmarkUuid: b1585f86-2a47-4ece-959c-4d720a0bb4c mainLandmark: 台北101 landmarkUuids: [] voucherOptionUuid: 2929d51e-64f5-4b46-87dc-4890c5ad39c2 voucherDesc: Voucher will be sent via email. Please show your e-voucher at designated location. sendVoucherType: 1 sendVoucherHour: 0 sendVoucherMode: 0 summary: Get Product operationId: get-v1-product-productUuid-detail description: "Load an existing product detail by productUuid\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/product/{productUuid}/detail
HTTP MethodGET
ParametersIn Uri
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters- In Uri\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
productUuidUUIDYProduct UUID
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
dataobjectResponse data, check data for details
\n\n##### *data*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\ \ \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
uuidUUIDProduct UUID
titlestringProduct name
briefstringProduct brief
featurestringProduct highlight
descriptionstringProduct description, introduce the product's attractions
itineraryarrayProduct itinerary, check itinerary for details
warningsstringProduct special terms and conditions, all warnings to be noted
purchaseSummarystringThe purchase notice
userRestrictionsarraySpecific user restrictions, check userRestrictions for details
countryUuidUUIDCountry UUID
\n Check /getDataOption?option=country to get UUID\n
currencyUuidUUIDCurrency UUID
\n Rezio Currency UUID, Check/getDataOption?option=currency UUID for details\n
priceStartAtnumberThe advertising price. It's the lowest adult price or your customized price.
categoryUuidUUIDProduct Category UUID
\n Check /getDataOption?option=category for details\n
languageUuidUUIDLanguage UUID
\n Check /getDataOption?option=language to get UUID\n
timezoneUuidUUIDTimezone UUID
\n Check /getDataOption?option=timezone to get UUID\n
productCodestringProduct code, allowed customized or unique 6 chars generated by Rezio
\n Note: customized code cannot be duplicated in your store
pickuparrayApplied pickup rule
\n Check pickup for details\n
onsiteLanguageUuidsarrayOn-site guide language UUIDs
\n Accept multiple spoken languages. Check /getDataOption?option=languageSpoken to get UUID\n
guideLanguageUuidsarrayGuide language UUIDs
\n Accept multiple spoken languages. Check /getDataOption?option=languageSpoken to get UUID\n
deviceLanguageUuidsarrayAudio guide device language UUIDs
\n Accept multiple spoken languages. Check /getDataOption?option=languageSpoken to get UUID\n
materialLanguageUuidsarrayPrinted material language UUIDs
\n Accept multiple languages. Check /getDataOption?option=languageAll to get UUID\n
regionUuidUUIDRegion UUID
\n Check /getDataOption?option=region to get UUID\n
durationobjectDuration time of product
\n day Day
\n hour Hour
\n min Minute\n
feeNdTaxarrayApplied tax & fees items
\n Check /v1/setting/feeNdTax ::data for details\n
depositPolicyobjectApplied deposit policy
\n Check /v1/setting/deposit ::data for details\n
cancelPolicyobjectApplied cancellation policy
\n Check /v1/setting/cancelPolicy ::data for details\n
feeDetailobjectIncluded and excluded fees, check feeDetail for details
bookingInfoobjectApplied booking information rule
\n Check /v1/setting/bookingInfo ::data for details\n
bookingCutlineobjectBooking cut-off time
\n Check bookingCutline for details
saleableobjectAvailable Booking Setting
\n Check saleable for details
locationobjectSupport multiple locations, including destination, meeting point, exchange point, check location for details
extraarrayApplied sellable extra items
\n Check /v1/setting/extra ::data for details\n
acceptPayTypearrayAccepted payment type (for official website)
\n 1 ATM/Bank Transfer
\n 2 Cash/On-site payment
\n 4 Online payment\n
confirmTypeintOrder confirmation
\n 1 Automatically confirmed
\n 2 Manually confirmed\n
confirmModeintConfirmed dates baseline
\n 1 By booking date
\n 2 Before departure date\n
confirmHourintConfirmation required time
\n Unit is hour, range: 0 ~ 72 hours
\n Note: when confirmType = 1 AND confirmHour = 0, it is an Instant Confirmation \n
statusstringProduct status
\n IN_PROGRESS Product is in editing, missing some required settings.
\n ARCHIVED Product in this status will not appear in the product list, no longer sellable and archived.
\n END_SELLING End of sale, no available future sessions
\n FULLY_BOOKED Fully booked, capacity of all sessions is full.
\n DISCONTINUED Sale paused, all publishStatus of packages were turned off.
\n AVAILABLE_UNTIL Available until the last session date, normal product selling status\n
statusAvailableUntilstringAvailable until the last session date, it's shown when status = 'AVAILABLE_UNTIL'
mainLandmarkUuidUUIDMain Landmark UUID
\n Check /getDataOption?option=landmark\n
mainLandmarkstringMain landmark label
landmarkUuidsarrayLandmark UUID
\n Check /getDataOption?option=landmark\n
voucherOptionUuidUUIDVoucher option UUID for instructions on how to use the voucher
\n Check /getDataOption?option=voucherOption\n
voucherDescstringVoucher usage instructions
sendVoucherTypeintVoucher delivery method
\n 1 Automatically send - sent together with the order confirmation email
\n 2 Automatically send - specified time
\n 3 Manual send\n
sendVoucherHourintTime required for voucher delivery, in hours
When sendVoucherType is 0, it is fixed at 0
sendVoucherModeintVoucher delivery date calculation baseline
\n 1 Based on the order creation date
\n 2 Based on the departure date
\n When sendVoucherType is 0, it is fixed at 0\n
\n\n##### *itinerary*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
breakfastint\n 1 Breakfast is included
\n 0 Breakfast is not included\n
lunchint\n 1 Lunch is included
\n 0 Lunch is not included\n
dinnerint\n 1 Dinner is included
\n 0 Dinner is not included\n
contentarrayItinerary content, check content for details
\n\n##### *itinerary - content*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
uuidUUIDListing UUID
typeintListing type
\n 1 With time slot
\n 2 Bullet points\n
hourintHour, range: 00~23
Required when type = 1
minintMinute(s)
Required when type = 1
titlestringContent name about what to do, i.e., Lunch Time
storeMediaUsageUuidstringImage UUID
\n\n##### *userRestrictions*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
includearrayFor the travelers of the nationalities only. Country UUID
\n Check /getDataOption?option=countryAll to get UUID\n
excludearrayFor the travelers who are not the nationalities. Country UUID
\n Check /getDataOption?option=countryAll to get UUID\n
customarrayCustom user restrictions.Check custom for details
\n\n##### *userRestrictions - custom*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
uuidUUIDCustom user restrictions UUID
labelstringCustom user restrictions label
\n\n##### *feeDetail*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
includeobjectFees included, check type for details
excludeobjectFees excluded, check type for details
\n\n##### *feeDetail - type*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
systemUuidsarrayFee UUID\ \ by system defined
\n Rezio provides various fees, check/getDataOption?option=feeOption for details\n
customarrayCustomized your own fees, check custom
\n\n##### *feeDetail - custom*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
uuidUUIDCustom item UUID
labelstringCustom item label
\n\n##### *location*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
destinationarrayDestination
\n Accept multiple destinations, check content for details
meetPlacearrayMeeting Point
\n Accept multiple meeting points, check content for details
exchangearrayAccept multiple exchange point, check content for details
\n\n##### *location - content*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\ \ \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
uuidUUIDLocation UUID
titlestringLocation name
addressstringLocation real address
notestringSupplementary note for location
displayintLocation display mode, using bitwise comparison
\n 1 Use Google Maps
\n 2 Use uploaded image
\n 4 Display business phone number
\n 8 Display business hours schedule
\n 16 Display business hours textual description\n
geoobjectGeographic information
\n Available for Google Maps when \"display\" contains 1, check geo for detail.\n
mapSnapshotImagestringURL of the image when the location is displayed on Google Maps, can be used when \"display\" contains 1
storeMediaUsageUuidUUIDImage UUID
\n Available for uploaded image when \"display\" contains 2
businessPhoneITIintBusiness phone ITI
\n Country code can be obtained from /v1/dataOption?option=countryAll with iti as the value option
\n Can be used when \"display\" contains 4
businessPhonestringBusiness phone number, can be used when \"display\" contains 4
isAllDayboolWhether the business hours are not divided into sessions, can be used when \"display\" contains 8
weekdaysobjectBusiness hours schedule
Can be set based on weekdays, keys allowed are Sun, Mon, Tue, Wed, Thu, Fri, Sat
\n Please refer to weekdays description for details
\n Can be used when \"display\" contains 8
businessWordingstringTextual description of the business hours, can be used when \"display\" contains 16
regionUuidUUIDRegion UUID
\n check/getDataOption?option=region\n
countryUuidUUIDCountry UUID
\n Check/getDataOption?option=country\n
landmarkUuidUUIDLandmark UUID
\n Check /getDataOption?option=landmark\n
placeIdstringUnique value of the Google location information
placeIdTagstringTag of the Google location information
\n\n##### *location - content - geo*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
latnumberYLatitude
lngnumberYLongitude
\n\n##### *location - content - weekdays*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
fromstringOpening time, formatted as HH:mm
tostringClosing time, formatted as HH:mm
laststringLast entry time, formatted as HH:mm
\n\n##### *bookingCutline*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
bySessionTimestringSession time baseline type
\n START Session start time
\n END Session end time\n
typestringCut-off time baseline type
\n ABSOLUTE Specific time
\n RELATIVE Relative time\n
dayintCut-off baseline, Day
\n Minimum value is 0\n
hourintCut-off baseline, Hour
\n Required when \"type\": \"RELATIVE\"
\n Range: 0~23\n
minintCut-off baseline, Minute, with 5-minute intervals.
\n Required when \"type\": \"RELATIVE\"
\n Value: 0, 5, 10, 15, 20, 25, 30, 35, 40, 45, 50, 55\n
timestringSpecific cut-off time
\n Required when \"type\": \"ABSOLUTE\"
\n Format is HH:mm
\n HH Range: 00~23
\n \ \ mm Range: 00~59\n
\n\n##### *saleable*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
typestringAvailable Booking time baseline type
\n UNLIMITED Unlimited
\n CURRENTDAY Only sessions on the day of booking
\n ABSOLUTE Specified
\n RELATIVE Relative\n
dayintAvailable Booking time baseline, Day
\n Required when \"type\": \"ABSOLUTE\" or \"RELATIVE\"\n
hourintAvailable Booking time baseline, Hour
\n Required when \"type\": \"RELATIVE\"
\n Range: 0~23\n
timestringSpecific time
\n Required when \"type\": \"ABSOLUTE\"
\n Format is HH:mm
\n HH Range: 00~23
\n mm Range: 00~59\n
\n\n##### *pickup*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
uuidUUIDPickup Rule UUID
labelstringName
typeintRoute type
\n 1 Fixed pickup route
\n 2 Allow customer to input pickup request\n
directionintDirection
\n 1 Outbound Pickup Route
\n 2 Return Pickup Route\n
referenceTimestringReferenceTime
\n Available when Route type = 1; format is HH:mm, i.e., 09:00\n
timeBeforeSessionintIs pickup ahead of schedule (tour departure time)?
\n 1 Yes, ahead
\n 0 No, behind
\n Available when Route type = 1.\n
locationarrayPickup location details
\n When Route type = 1, check location 1
\n When Route type = 2, check location 2\n
" tags: - Product List parameters: - name: productUuid in: path required: true schema: type: string /v1/product/{productUuid}/salesOption: get: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string data: type: array items: type: object properties: uuid: type: string title: type: string description: type: string publishStatus: type: number mysiteIsPublished: type: number sort: type: number storeMediaUsageUuid: type: string imageUrl: type: string priceStartAt: type: number ticketValidity: {} example: code: S0000 codeMessage: SUCCESS data: - uuid: c15d3c20-c548-42be-aa7b-b6ba53a41962 title: Day tour description: '' publishStatus: 1 mysiteIsPublished: 1 sort: 1 storeMediaUsageUuid: 497e52a7-5934-4cd0-88f8-acd6b8d442ac imageUrl: https://img.box.rezio.io/368d9a4d-06fc-41d6-a505-a982640d027f/40719e5e-877d-42a7-909a-853fb83403ad.jpeg priceStartAt: 650 ticketValidity: null summary: Get Product Packages operationId: get-v1-product-productUuid-salesOption description: "Load the existing product's packages by productUuid\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/product/{productUuid}/salesOption
HTTP MethodGET
ParametersIn Uri
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters- In Uri\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
productUuidUUIDYProduct UUID
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
dataobjectResponse data, check data for details
\n\n##### *data*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
uuidUUIDPackage UUID
titlestringPackage name
descriptionstringPackage description
publishStatusintPublish status of package
\n 1 Sale turned ON
\n 0 Sale turned OFF\n
mysiteIsPublishedintPublish status of MySite
\n 1 Sale turned ON
\n 0 Sale turned OFF\n
sortintSorting of packages in ascending order
storeMediaUsageUuidstringImage usage UUID
imageUrlstringPackage representative image URL
priceStartAtfloatCustom advertising price
ticketValidityobjectWhen the product type is a ticket, it provides information about package tickets, otherwise it is null.
\n Check ticketValidity for detail.\n
\n\n##### *ticketValidity*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
typestringTicket validity type
\n LIMIT - Can only be used during selected session time, cannot be used outside of specified session time
\n ABSOLUTE - Valid until a specified date
\n RANGE - Valid within a specified date range
\n RELATIVE - Valid for a certain period of time after purchase\n
allowExpiredRedemptionboolHandling of expired\ \ tickets
\n true - Allow redemption
\n false - Do not allow redemption\n
" tags: - Product List parameters: - name: productUuid in: path description: Product UUID required: true example: 597a8861-82ce-4770-892a-ab718f76a63c schema: type: string put: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string data: type: object properties: salesOptionUuids: type: array items: type: string example: code: S0000 codeMessage: SUCCESS data: salesOptionUuids: - c15d3c20-c548-42be-aa7b-b6ba53a41962 summary: Update Product Package operationId: put-v1-product-productUuid-salesOption description: "*` REQUIRED ` step of creating a product*
Update a product's package. In Rezio, package is the real field of pricing rule and session (availability).\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/product/{productUuid}/salesOption
HTTP MethodPUT
ParametersIn Uri & Raw Body
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters- In Uri\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
productUuidUUIDYProduct UUID
\n\n##### Parameters- Raw Body\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
salesOptionarrayYPackages
\n Check salesOption for details
\n\n##### *salesOption*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeLimitRequiredDescription
uuidUUID-YPackage UUID
\n Leave it empty when create a new package.
\n Update an existing package by package UUID.
\n Create a new package will retrieve UUID or use Get Product Packages to get UUID.\n
titlestringLength limit
varchar(300)		YPackage name
descriptionstring-YPackage description
publishStatusint-YPublish status of package
\n 1 Sale turned ON
\n 0 Sale turned OFF\n
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
dataobjectResponse data, check data for details
\n\n##### *data*\n\n\n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
salesOptionUuidsarrayPackage UUID
" tags: - Create Product parameters: - name: productUuid in: path description: '' required: true example: 597a8861-82ce-4770-892a-ab718f76a63c schema: type: string requestBody: content: application/json: example: salesOption: - uuid: c15d3c20-c548-42be-aa7b-b6ba53a41962 title: Day tour description: '' publishStatus: 1 schema: type: object properties: salesOption: type: array items: type: object properties: uuid: type: string title: type: string description: type: string publishStatus: type: number /v1/product/{productUuid}/mediaInfo: get: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string data: type: object properties: cover: type: array items: type: object properties: storeMediaUsageUuid: type: string url: type: string sort: type: number image: type: object properties: itinerary: type: array items: type: object properties: storeMediaUsageUuid: type: string url: type: string sort: type: number location: type: array items: type: object properties: storeMediaUsageUuid: type: string url: type: string sort: type: number extra: type: array items: type: object properties: storeMediaUsageUuid: type: string url: type: string sort: type: number salesOption: type: array items: type: object properties: storeMediaUsageUuid: type: string url: type: string sort: type: number video: type: array items: type: object properties: storeMediaUsageUuid: type: string url: type: string sort: type: number languageUuids: type: array items: type: string example: code: S0000 codeMessage: SUCCESS data: cover: - storeMediaUsageUuid: 87f71476-3b35-4804-87c5-0085d903b5bc url: https://img.box.rezio.io/cebf3f02-f2e8-4bba-bff5-af7ab303255c/597a8861-82ce-4770-892a-ab718f76a63c/d46c6de8-32b6-409a-b403-318442fd0afc.png sort: 0 image: itinerary: - storeMediaUsageUuid: 497e52a7-5934-4cd0-88f8-acd6b8d442ac url: https://img.box.rezio.io/368d9a4d-06fc-41d6-a505-a982640d027f/40719e5e-877d-42a7-909a-853fb83403ad.jpeg sort: 1 location: - storeMediaUsageUuid: 497e52a7-5934-4cd0-88f8-acd6b8d442ac url: https://img.box.rezio.io/368d9a4d-06fc-41d6-a505-a982640d027f/40719e5e-877d-42a7-909a-853fb83403ad.jpeg sort: 1 extra: - storeMediaUsageUuid: 6af3e37c-d681-4ad5-8874-6d9d2abcc5bd url: https://img.box.rezio.io/368d9a4d-06fc-41d6-a505-a982640d027f/2e96b75a-d7a6-4784-8884-b72a0c4cb38f.jpeg sort: 1 salesOption: - storeMediaUsageUuid: 497e52a7-5934-4cd0-88f8-acd6b8d442ac url: https://img.box.rezio.io/368d9a4d-06fc-41d6-a505-a982640d027f/40719e5e-877d-42a7-909a-853fb83403ad.jpeg sort: 1 video: - storeMediaUsageUuid: 89c4e617-fb7e-4b1b-87ce-9d7d32c12f2c url: https://youtu.be/_hlZMQZF4E0 sort: 1 languageUuids: - 30eee82e-eccb-430b-9774-9a231a5f6b51 summary: Get Media Items operationId: get-v1-product-productUuid-mediaInfo description: "Load the existing product's media items by productUuid\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/product/{productUuid}/mediaInfo
HTTP MethodGET
ParametersIn Uri
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters- In Uri\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
productUuidUUIDYProduct UUID
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
dataobjectResponse data, check data for details
\n\n##### *data*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
coverarrayThe cover image will show as the thumbnail and first image in product page of official website. Check cover for details
imagearrayCheck image for details
videoarrayCheck video for details
\n\n##### *cover*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
storeMediaUsageUuidUUIDImage UUID
urlstringURL of uploaded image
sortintSorting order
\n\n##### *image*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
itineraryarrayItinerary images, checkdescription for format
locationarrayLocation images, checkdescription for format
extraarrayExtra items images, checkdescription for format
salesOptionarrayPackage images, checkdescription for format
\n\n##### *image - detail*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \ \ \n \n \n \n \n \n \n
NameTypeDescription
storeMediaUsageUuidUUIDImage UUID
urlstringURL of uploaded image
sortintSorting order
\n\n##### *video*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
storeMediaUsageUuidUUIDVideo UUID
urlstringURL link of YouTube video
sortintSorting of video, in ascending order
languageUuidsarrayVideo language UUID
\n Check /getDataOption?option=languageAll to get UUID\n
" tags: - Product List parameters: - name: productUuid in: path description: Product countryUuid required: true schema: type: string /v1/product/create: post: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string data: type: object properties: uuid: type: string productPcode: type: string example: code: S0000 codeMessage: SUCCESS data: uuid: 690bec2c-cd52-47e7-b237-c2ead2966499 productPcode: JOUPZC summary: Create Product operationId: post-v1-product-create description: "Create a new product\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/product/create
HTTP MethodPOST
ParametersRaw Body
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeLimitRequiredDescription
categoryUuidUUID-YProduct Category UUID
\n Check /getDataOption?option=category for details \n
titlestringLength limit
varchar(300)		YProduct name
productCodestringLength limit
varchar(6~30)		-Product code, allowed customized or unique 6 chars generated by Rezio
\n Note: customized code cannot be duplicated in your store
mainLandmarkUuidUUID--Main Landmark UUID
\n Check /getDataOption?option=landmark\n
timezoneUuidUUID-YTimezone UUID
\n Check /getDataOption?option=timezone to get UUID\n
languagestring/ UUID-YLanguage
\n Accept ISO639-1 Code or Rezio Language UUID
\n Check /getDataOption?option=language to get code/ UUID\n
regionUuidUUID-YRegion (Continent) UUID
\n Check /getDataOption?option=region to get UUID\n
countrystring/ UUID--Country
\n Accept ISO3166-1 Code or Rezio Country UUID
\n Check /getDataOption?option=country to get code/ UUID
\n Note: country needs to match the region setting\n
currencystring/ UUID-YCurrency
\n Accept ISO-4217 Code or Rezio Currency UUID
\n Check/getDataOption?option=currency to get code/ UUID\n
aliasstringLength limit：
10 halfwidth forms char		-Product alias
\n\n##### Response\n\n\n \n \n \n \n \n \n \n\ \ \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
dataobjectResponse data, check data for details
\n\n##### *data*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
uuidUUIDProduct UUID
productCodestringProduct code
" tags: - Create Product requestBody: content: application/json: example: categoryUuid: 7b191497-9ef1-4c15-9231-fc4ac70ca4d9 title: product.sample timezoneUuid: 6bda40f7-5e0c-4dbb-8c3f-63ef6db73363 language: zh-TW regionUuid: 8fefe93b-abdc-1778-7266-f2cdec9a00bb country: TW productCode: '' currency: TWD mainLandmarkUuid: 48a6d747-528b-416b-a04c-d37622282b9a alias: ps schema: type: object properties: categoryUuid: type: string title: type: string timezoneUuid: type: string language: type: string regionUuid: type: string country: type: string productCode: type: string currency: type: string mainLandmarkUuid: type: string alias: type: string /v1/product/{productUuid}/intro: put: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string example: code: S0000 codeMessage: SUCCESS summary: Update Product Introduction operationId: put-v1-product-productUuid-intro description: "*` REQUIRED ` step of creating a product*
Update product's introduction, including brief, description, special terms and conditions.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/product/{productUuid}/intro
HTTP MethodPUT
ParametersIn Uri & Raw Body
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters- In Uri\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
productUuidUUIDYProduct UUID
\n\n##### Parameters- Raw Body\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
briefstringYProduct brief, highlights
（Include Markdown Syntax）
descriptionstringYProduct description, introduce the product's attractions
（Include Markdown Syntax）
warningsstring-Product special terms and conditions, all warnings to be noted
（Include Markdown Syntax）
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
" tags: - Create Product parameters: - name: productUuid in: path description: '' required: true example: 597a8861-82ce-4770-892a-ab718f76a63c schema: type: string requestBody: content: application/json: example: brief: Escape Taipei for a day to see Taiwan’s rugged beauty. Discover unique landscapes at Bitou Cape and Golden Waterfalls. Admire the historic Jiufen village and its rural charms. description: "－ Highlights － \n\n• Explore Bitou Cape, Nanya Rock Formations, and Golden Waterfalls\n• Delight in the mix of yellow and blue bay colors at Yin Yang Sea\n• Learn about the famous gold rush at the Gold Museum\n• Indulge in local delicacies along Jiufen’s ancient streets\n\n\n－ What You Can Expect － \n\nHead to Taiwan's northeastern coast for a day of scenic wonders. Visit Nanya Rock Formations and its sea-eroded coral shore. Check out charming stone patterns made by weathered sandstone. Observe steep cliffs, marine fossils, mushroom and honeycomb-shaped rocks at Bitou Cape. \n\nGaze upon the curious bay where yellow waters meet the blue ocean at Yin Yang Sea. Be mesmerized by Golden Waterfall’s waves cascading in spectacular fashion. This region was also once home to gold. Gain insight into the history of the gold rush, mining techniques, and tools,\n\nStroll the traditional village of Jiufen. Get surrounded by buildings and old streets bursting with character and culture. Browse stalls selling tasty delicacies to taste and interesting knick knacks. Discover Taiwan’s northern paradise today!\n\n\n－ Important Info －\n\n・Meeting Time: 8:50am - 9:00am\n・Last Departure Point: Taipei Main Station (East Gate 3)\n(Please look for our staff wearing Taiwan Tour Bus vests to confirm your attendance)\n・Duration: ~8 hrs\n・Returning Point: Taipei Main Station\n\n\n－ Additional Info －\n\n・The Gold Museum is closed on the first Monday of every month\n・Free admission for children under age 3, must be traveling with an adult and must not occupy a seat. Insurance must be purchased separately\n・Ages 3 and up will be charged an adult admission fee" warnings: '・If total number of passengers is below 4 (the minimum requirement for this trip), you will be informed 3 days prior to departure ・Contact our customer service for refunds from schedule changes/cancellations due to traffic, weather, and other unexpected conditions ・Actual itinerary is dependent on weather/transportation conditions ・We will not provide refunds for missed tours due to late arrival ・Visitors to Taiwan must provide copies of their identification cards or passports for insurance purposes ・For English and Japanese service, there are tour guides and iPad guides available. The specific service cannot be selected by traveler, and is dependent on on-site availability' schema: type: object properties: brief: type: string description: type: string warnings: type: string /v1/product/{productUuid}/feeNdTax: put: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string example: code: S0000 codeMessage: SUCCESS summary: Apply Product Tax or Fee operationId: put-v1-product-productUuid-feeNdTax description: "*` REQUIRED ` step of creating a product*
Apply multiple tax or fee items with feeNdTaxUuids.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/product/{productUuid}/feeNdTax
HTTP MethodPUT
ParametersIn Uri & Raw Body
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters- In Uri\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
productUuidUUIDYProduct UUID
\n\n##### Parameters- Raw Body\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
feeNdTaxUuidsarrayYTax & Fee UUID
\n Check /v1/setting/feeNdTax to get UUID\n
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
" tags: - Create Product parameters: - name: productUuid in: path description: '' required: true example: 597a8861-82ce-4770-892a-ab718f76a63c schema: type: string requestBody: content: application/json: example: feeNdTaxUuids: - 2dbe92c2-bf7c-46f8-9566-30e313368124 schema: type: object properties: feeNdTaxUuids: type: array items: type: string /v1/product/{productUuid}/cancelPolicy: put: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string example: code: S0000 codeMessage: SUCCESS summary: Apply Product Cancellation Policy operationId: put-v1-product-productUuid-cancelPolicy description: "*` REQUIRED ` step of creating a product*
Apply 1 cancellation policy with cancelPolicyUuid.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/product/{productUuid}/cancelPolicy
HTTP MethodPUT
ParametersIn Uri & Raw Body
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters- In Uri\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
productUuidUUIDYProduct UUID
\n\n##### Parameters- Raw Body\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
cancelPolicyUuidUUIDYCancel Policy UUID
\n Check /v1/setting/cancelPolicy to get UUID
\n Note: the currency of cancellation policy and product MUST be consistent.\n
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
" tags: - Create Product parameters: - name: productUuid in: path description: '' required: true example: 597a8861-82ce-4770-892a-ab718f76a63c schema: type: string requestBody: content: application/json: example: cancelPolicyUuid: 301646a7-3547-4fe9-bb50-a3c3860d895f schema: type: object properties: cancelPolicyUuid: type: string /v1/product/{productUuid}/depositPolicy: put: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string example: code: S0000 codeMessage: SUCCESS summary: Apply Product Deposit Policy operationId: put-v1-product-productUuid-depositPolicy description: "*` REQUIRED ` step of creating a product*
Apply 1 deposit policy with depositPolicyUuid.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/product/{productUuid}/depositPolicy
HTTP MethodPUT
ParametersIn Uri & Raw Body
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters- In Uri\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
productUuidUUIDYProduct UUID
\n\n##### Parameters- Raw Body\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
depositPolicyUuidUUIDYDeposit Policy UUID
\n Check /v1/setting/deposit to get UUID
\n Note: the currency of deposit policy and product MUST be consistent.\n
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
" tags: - Create Product parameters: - name: productUuid in: path description: '' required: true example: 597a8861-82ce-4770-892a-ab718f76a63c schema: type: string requestBody: content: application/json: example: depositPolicyUuid: b309eb3a-15cb-4ddb-8938-2f01b667840f schema: type: object properties: depositPolicyUuid: type: string /v1/product/{productUuid}/bookingInfo: put: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string example: code: S0000 codeMessage: SUCCESS summary: Apply Product Booking Information operationId: put-v1-product-productUuid-bookingInfo description: "*` REQUIRED ` step of creating a product*
Apply 1 deposit policy with bookingInfoUuid.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/product/{productUuid}/bookingInfo
HTTP MethodPUT
ParametersIn Uri & Raw Body
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters- In Uri\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
productUuidUUIDYProduct UUID
\n\n##### Parameters- Raw Body\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
bookingInfoUuidstringYBooking information UUID
\n Check /v1/setting/bokkingInfo to get UUID\n
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
" tags: - Create Product parameters: - name: productUuid in: path description: '' required: true example: 597a8861-82ce-4770-892a-ab718f76a63c schema: type: string requestBody: content: application/json: example: bookingInfoUuid: 5dfa699c-bfe8-44f7-b7cb-3a53dbc423a1 schema: type: object properties: bookingInfoUuid: type: string /v1/product/{productUuid}/feeDetail: put: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string example: code: S0000 codeMessage: SUCCESS summary: Update Product Fees operationId: put-v1-product-productUuid-feeDetail description: "*Optional step in creating a product*
Update a product's fee detail, including both included and excluded fees. Rezio provides pre-defined fees items, apply it with systemUuids.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/product/{productUuid}/feeDetail
HTTP MethodPUT
ParametersIn Uri & Raw Body
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters- In Uri\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
productUuidUUIDYProduct UUID
\n\n##### Parameters- Raw Body\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
includeobjectYFees included, check type for details
excludeobjectYFees excluded, check type for details
\n\n##### *feeDetail - type*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
systemUuidsarray-Fee UUID by system defined
\n Rezio provides various fees, check/getDataOption?option=feeOption for details\n
customarray-Customized your own fees, check custom
\n\n##### *feeDetail - custom*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
uuidUUID-Custom item UUID. Leave it empty when create a new item.
labelstringYCustom item label
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
" tags: - Create Product parameters: - name: productUuid in: path description: '' required: true example: 597a8861-82ce-4770-892a-ab718f76a63c schema: type: string requestBody: content: application/json: example: include: systemUuids: - 2075baca-e1d3-4ca0-ae1b-3c77068e017a - 2a509272-0b12-498c-aa45-ea13fb38c30c custom: - uuid: '' label: Travel insurance (NT$2 million and medical fees at NT$30 thousand) exclude: systemUuids: - fa5e65c0-d5cc-4a77-a5c3-a2b2dd405446 - b2656af1-2bc8-4f2a-9fb9-6c3f545093fb custom: [] schema: type: object properties: include: type: object properties: systemUuids: type: array items: type: string custom: type: array items: type: object properties: uuid: type: string label: type: string exclude: type: object properties: systemUuids: type: array items: type: string custom: type: array items: {} /v1/product/{productUuid}/publish: put: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string example: code: S0000 codeMessage: SUCCESS summary: Update Product Publish Rule operationId: put-v1-product-productUuid-publish description: "*` REQUIRED ` step of creating a product*
Update a product's publish rule, including confirmation method, cut-off time, available booking setting, payment type, etc.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/product/{productUuid}/publish
HTTP MethodPUT
ParametersIn Uri & Raw Body
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters- In Uri\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
productUuidUUIDYProduct UUID
\n\n##### Parameters- Raw Body\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
confirmTypeintYOrder confirmation
\n 1 Automatically confirmed
\n 2 Manually confirmed\n
confirmModeintYConfirmed dates baseline
\n 1 By booking date
\n 2 Before departure date\n
confirmHourintYConfirmation required time
\n Unit is hour, range: 0 ~ 72 hours
\n Note: when confirmType = 1 AND confirmHour = 0, it is an Instant Confirmation \n
bookingCutlineobjectYBooking cut-off time
\n Check bookingCutline for details
saleableobjectYAvailable Booking Setting
\n Check saleable for details
acceptPayTypearray-Accepted payment type
\n 1 ATM/Bank Transfer
\n 2 Cash/On-site payment
\n
voucherDescstringYvoucher rule
\n\n##### *bookingCutline*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \ \ \n \n \n
NameTypeDescription
bySessionTimestringSession time baseline type
\n START Session start time
\n END Session end time\n
typestringCut-off time baseline type
\n ABSOLUTE Specific time
\n RELATIVE Relative time\n
dayintCut-off baseline, Day
\n Minimum value is 0\n
hourintCut-off baseline, Hour
\n Range: 0~23\n
minintCut-off baseline, Minute, with 5-minute intervals.
\n Value: 0, 5, 10, 15, 20, 25, 30, 35, 40, 45, 50, 55\n
timestringSpecific cut-off time
\n Required when \"type\": \"ABSOLUTE\"
\n Format is HH:mm
\n HH Range: 00~23
\n mm Range: 00~59\n
\n\n##### *saleable*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
typestringAvailable Booking time baseline type
\n UNLIMITED Unlimited
\n CURRENTDAY Only sessions on the day of booking
\n ABSOLUTE Specified
\n RELATIVE Relative\n
dayintAvailable Booking time baseline, Day
\n Required when \"type\": \"ABSOLUTE\" or \"RELATIVE\"\n
hourintAvailable Booking time baseline, Hour
\n Required when \"type\": \"RELATIVE\"
\n Range: 0~23\n
timestringSpecific time
\n Required when \"type\": \"ABSOLUTE\"
\n Format is HH:mm
\n HH Range: 00~23
\n mm Range: 00~59\n
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
" tags: - Create Product parameters: - name: productUuid in: path description: '' required: true example: 597a8861-82ce-4770-892a-ab718f76a63c schema: type: string requestBody: content: application/json: example: confirmType: 1 confirmMode: 1 confirmHour: 48 bookingCutline: bySessionTime: START type: ABSOLUTE day: 2 time: '18:00' saleable: type: ABSOLUTE day: 30 time: '18:00' acceptPayType: - 1 - 2 schema: type: object properties: confirmType: type: number confirmMode: type: number confirmHour: type: number bookingCutline: type: object properties: bySessionTime: type: string type: type: string day: type: number time: type: string saleable: type: object properties: type: type: string day: type: number time: type: string acceptPayType: type: array items: type: number /v1/product/{productUuid}/image: post: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string data: type: object properties: file: type: object properties: storeMediaUsageUuid: type: string url: type: string example: code: S0000 codeMessage: SUCCESS data: file: storeMediaUsageUuid: 87f71476-3b35-4804-87c5-0085d903b5bc url: https://img.box.rezio.io/cebf3f02-f2e8-4bba-bff5-af7ab303255c/597a8861-82ce-4770-892a-ab718f76a63c/d46c6de8-32b6-409a-b403-318442fd0afc.png summary: Upload Product Image operationId: post-v1-product-productUuid-image description: "*Optional step in creating a product*
Add an image for product. File is mandatory and put in form-data parameter 'file'.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/product/{productUuid}/image
HTTP MethodPOST
ParametersFile
HeadersX-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters- File\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
filefileYImage file
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
dataobjectResponse data, check data for details
\n\n##### *data*\n\n\n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
filearrayImage file, check file for details
\n\n##### *file*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
storeMediaUsageUuidUUIDImage UUID
urlstringURL of image
" tags: - Create Product parameters: - name: productUuid in: path description: '' required: true example: 597a8861-82ce-4770-892a-ab718f76a63c schema: type: string requestBody: required: true content: multipart/form-data: schema: type: object required: - file properties: file: type: string format: binary /v1/product/{productUuid}/cover: put: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string example: code: S0000 codeMessage: SUCCESS summary: Apply Product Cover Photo operationId: put-v1-product-productUuid-cover description: "*Optional step in creating a product*
Assign one image as the product's cover photo with storeMediaUsageUuid. The cover will show as the thumbnail and first image in product page of official website.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/product/{productUuid}/cover
HTTP MethodPUT
ParametersIn Uri & Raw Body
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters- In Uri\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
productUuidUUIDYProduct UUID
\n\n##### Parameters- Raw Body\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
storeMediaUsageUuidUUIDYImage UUID
\n Use Upload Product Image to add image then get storeMediaUsageUuid in the response as parameter here.\n
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
" tags: - Create Product parameters: - name: productUuid in: path description: '' required: true example: 597a8861-82ce-4770-892a-ab718f76a63c schema: type: string requestBody: content: application/json: example: storeMediaUsageUuid: 87f71476-3b35-4804-87c5-0085d903b5bc schema: type: object properties: storeMediaUsageUuid: type: string /v1/product/{productUuid}/video: put: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string example: code: S0000 codeMessage: SUCCESS summary: Update Product Video URL operationId: put-v1-product-productUuid-video description: "*Optional step in creating a product*
Update a product's YouTube link URL and set the video lanaguage.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/product/{productUuid}/video
HTTP MethodPUT
ParametersIn Uri & Raw Body
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters- In Uri\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
productUuidUUIDYProduct UUID, pass it in uri
\n\n##### Parameters- Raw Body\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
videoarrayYAccept multiple video data, check video for details
\n\n##### *video*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeLimitRequiredDescription
urlstring\n Format request: https://youtu.be/{code}
\n Length limit of {code}
varchar(11)\n 		YURL link of YouTube video
languageUuidsUUID--Video language UUID
\n Check /getDataOption?option=language to get UUID\n
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
" tags: - Create Product parameters: - name: productUuid in: path description: '' required: true example: 597a8861-82ce-4770-892a-ab718f76a63c schema: type: string requestBody: content: application/json: example: video: - url: https://youtu.be/_hlZMQZF4E0 languageUuids: - 30eee82e-eccb-430b-9774-9a231a5f6b51 schema: type: object properties: video: type: array items: type: object properties: url: type: string languageUuids: type: array items: type: string /v1/product/{productUuid}/itinerary: put: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string example: code: S0000 codeMessage: SUCCESS summary: Update Product Itinerary operationId: put-v1-product-productUuid-itinerary description: "*Optional step in creating a product*
Update a product's itinerary.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/product/{productUuid}/itinerary
HTTP MethodPUT
ParametersIn Uri & Raw Body
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters- In Uri\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
productUuidUUIDYProduct UUID
\n\n##### Parameters- Raw Body\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
durationobjectYDuration time of product
\n day Day
\n hour Hour
\n min Minute\n
itineraryarrayYItinerary data, check itinerary for details
\n\n##### *itinerary*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
breakfastintY\n 1 Breakfast is included
\n 0 Breakfast is not included\n
lunchintY\n 1 Lunch is included
\n 0 Lunch is not included\n
dinnerintY\n 1 Dinner is included
\n 0 Dinner is not included\n
contentarrayYItinerary content, check content for details
\n\n##### *itinerary - content*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
uuidUUID-Listing UUID. Leave it empty when create a new item.
typeintYListing type
\n 1 With time slot
\n 2 Bullet points\n
hourint-Hour, range: 00~23
Required when type = 1
minint-Minute(s)
Required when type = 1
titlestringYContent name about what to do, i.e., Lunch Time
storeMediaUsageUuidstring-Image UUID
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
" tags: - Create Product parameters: - name: productUuid in: path description: '' required: true example: 597a8861-82ce-4770-892a-ab718f76a63c schema: type: string requestBody: content: application/json: example: duration: day: 0 hour: 8 min: 0 itinerary: - breakfast: 1 lunch: 1 dinner: 1 content: - uuid: '' hour: 08 min: '40' type: 1 title: 'Pick up at Ximen MRT Exit #5 (Leave at 08:45)' - uuid: '' hour: 08 min: '50' type: 1 title: Meet up at Taipei Main Station (East Gate 3) - uuid: '' hour: 09 min: '00' type: 1 title: Depart to Bitou Cape storeMediaUsageUuid: null - uuid: '' hour: '' min: '' type: 2 title: Stop at Bitou Cape storeMediaUsageUuid: null - uuid: '' hour: '' min: '' type: 2 title: Nan Ya Rock Formations storeMediaUsageUuid: 702b05c5-92ef-4694-ab11-2680bfbb4065 - uuid: '' hour: '' min: '' type: 2 title: Yin Yang Sea storeMediaUsageUuid: 87f71476-3b35-4804-87c5-0085d903b5bc - uuid: '' hour: '' min: '' type: 2 title: The Golden Waterfall storeMediaUsageUuid: a54007b7-8090-4c0f-a7f4-e283ce62376f - uuid: '' hour: '' min: '' type: 2 title: Gold Museum storeMediaUsageUuid: null - uuid: '' hour: '' min: '' type: 2 title: Lunch Time storeMediaUsageUuid: null - uuid: '' hour: '' min: '' type: 2 title: Jiufen Old Street storeMediaUsageUuid: 4dc2e817-cdbd-4f3c-9ab8-e8d5fa0e0c53 - uuid: '' hour: '17' min: '00' type: 1 title: Return to Taipei Main Station storeMediaUsageUuid: null schema: type: object properties: duration: type: object properties: day: type: number hour: type: number min: type: number itinerary: type: array items: type: object properties: breakfast: type: number lunch: type: number dinner: type: number content: type: array items: type: object properties: uuid: type: string hour: type: string min: type: string type: type: number title: type: string storeMediaUsageUuid: type: string nullable: true required: - uuid - hour - min - type - title - storeMediaUsageUuid /v1/product/{productUuid}/location: put: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string example: code: S0000 codeMessage: SUCCESS summary: Update Product Location operationId: put-v1-product-productUuid-location description: "*Optional step in creating a product*
Update a product's destination location, meeting place or redeem point. Rezio allows multiple locations.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/product/{productUuid}/location
HTTP MethodPUT
ParametersIn Uri & Raw Body
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters- In Uri\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
productUuidUUIDYProduct UUID
\n\n##### Parameters- Raw Body\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
destinationarrayYDestination
\n Accept multiple destinations, check content for more detail
meetPlacearrayYMeeting Point
\n Accept multiple meeting points, check content for more detail
exchangearrayYRedeem Point
\n Accept multiple redeem points, check content for more detail
\n\n##### *content*\n\n\n \n \n \n \n \n \n \n \n \n \n \n w\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
uuidUUIDY\n Location UUID
\n Leave it empty when create a new pickup location\n
titlestringYLocation name
addressstringYLocation real address
notestring-Supplementary note for location
geoobject-Geographic information
\n Available when you want to use Google Maps, check geo for detail.\n
storeMediaUsageUuidUUID-Image UUID
\n Available when you use uploaded image of location
regionUuidUUID-Region UUID
\n Check /getDataOption?option=region to get UUID\n
countryUuidUUID-Country UUID
\n Check /getDataOption?option=country to get UUID\n
landmarkUuidUUID-Landmark UUID
\n Check /getDataOption?option=landmark\n
\n\n##### *location - content - geo*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
latnumberYLatitude
lngnumberYLongitude
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
" tags: - Create Product parameters: - name: productUuid in: path description: '' required: true example: 597a8861-82ce-4770-892a-ab718f76a63c schema: type: string requestBody: content: application/json: example: destination: - uuid: 404dfd5c-ab60-4c4c-a263-90516e0e2852 title: Jiufen address: Ruifang District, New Taipei City note: '' geo: lat: 25.02622730382695 lng: 121.55901986176264 storeMediaUsageUuid: '' regionUuid: 8fefe93b-abdc-1778-7266-f2cdec9a00bb countryUuid: 23fdb4b8-0a8a-46aa-957a-e4d938d9866d landmarkUuid: 53323777-1112-4e27-850d-8d2df973d454 - uuid: 3e4f05f3-f91f-4447-98dd-77d6494c9a4d title: The Golden Waterfall address: Jinshui Rd., Ruifang Dist., New Taipei City note: '' display: 1 geo: lat: 25.013471245634832 lng: 121.55864331058858 storeMediaUsageUuid: '' regionUuid: 8fefe93b-abdc-1778-7266-f2cdec9a00bb countryUuid: 23fdb4b8-0a8a-46aa-957a-e4d938d9866d landmarkUuid: 53323777-1112-4e27-850d-8d2df973d454 meetPlace: - uuid: 046a152e-b6ed-4037-a856-4ad669cd199c title: Taipei Main Station address: No. 3, Beiping W. Rd., Zhongzheng Dist., Taipei, Taiwan note: East Gate 3 geo: lat: 25.03396870000002 lng: 121.56228350000004 storeMediaUsageUuid: '' regionUuid: 8fefe93b-abdc-1778-7266-f2cdec9a00bb countryUuid: 23fdb4b8-0a8a-46aa-957a-e4d938d9866d landmarkUuid: 53323777-1112-4e27-850d-8d2df973d454 exchange: [] schema: type: object properties: destination: type: array items: type: object properties: uuid: type: string title: type: string address: type: string note: type: string geo: type: object properties: lat: type: number lng: type: number storeMediaUsageUuid: type: string regionUuid: type: string countryUuid: type: string landmarkUuid: type: string display: type: number required: - uuid - title - address - note - geo - storeMediaUsageUuid - regionUuid - countryUuid - landmarkUuid meetPlace: type: array items: type: object properties: uuid: type: string title: type: string address: type: string note: type: string geo: type: object properties: lat: type: number lng: type: number storeMediaUsageUuid: type: string regionUuid: type: string countryUuid: type: string landmarkUuid: type: string exchange: type: array items: {} /v1/product/{productUuid}/pickup: put: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string example: code: S0000 codeMessage: SUCCESS summary: Apply Product Pick Up operationId: put-v1-product-productUuid-pickup description: "*Optional step in creating a product*
Apply pickup rules with pickupUuid.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/product/{productUuid}/pickup
HTTP MethodPUT
ParametersIn Uri & Raw Body
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters- In Uri\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
productUuidUUIDYProduct UUID
\n\n##### Parameters- Raw Body\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
typeintYPickup Type
\n 0 None
\n 1 Reach the designated location by yourself.
\n 2 Pickup services included in the itinerary.\n
locationstring-Reach the designated location by yourself. Required when pickup type is 1
\n destination Destination
\n meetPlace Meeting Point
\n exchange Redeem Point\n
pickupobject-Pickup services included in the itinerary. Required when pickup type is 2
\n Check pickup for details
\n\n##### *pickup - pickup*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
departureUuidUUID-Outbound Pickup Route - Pickup UUID
\n Check /v1/setting/pickup for details\n
returnUuidUUID-Return Pickup Route - Pickup UUID
\n Check /v1/setting/pickup for details\n
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
" tags: - Create Product parameters: - name: productUuid in: path description: '' required: true example: 597a8861-82ce-4770-892a-ab718f76a63c schema: type: string requestBody: content: application/json: example: type: 2 pickup: departureUuid: 9173c3f0-1734-4e4a-b402-293b46184205 returnUuid: 9173c3f0-1734-4e4a-b402-293b46184205 schema: type: object properties: type: type: number pickup: type: object properties: departureUuid: type: string returnUuid: type: string /v1/product/{productUuid}/guide: put: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string example: code: S0000 codeMessage: SUCCESS summary: Update Product Guide Service operationId: put-v1-product-productUuid-guide description: "*Optional step in creating a product*
Update a product's guide service, including language provided by guides, audio guide device, on-site guide and printed materials (booklet).\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/product/{productUuid}/guide
HTTP MethodPUT
ParametersIn Uri & Raw Body
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters- In Uri\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
productUuidUUIDYProduct UUID
\n\n##### Parameters- Raw Body\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
guideLanguagesUuidsarrayYLanguage of guide
\n Accept ISO-639-1 Code, ISO-639-3 Code or Rezio Language UUID
\n Check /getDataOption?option=languageSpoken to get code/ UUID\n
deviceLanguagesUuidsarrayYLanguage of audio guide device
\n Accept ISO639-1 Code or Rezio Language UUID
\n Check /getDataOption?option=languageSpoken to get code/ UUID\n
onsiteLanguagesUuidsarrayYLanguage of on-sute guide
\n Accept ISO639-1 Code or Rezio Language UUID
\n Check /getDataOption?option=languageSpoken to get code/ UUID\n
materialLanguagesUuidsarrayYLanguage of printed materials, i.e., booklet
\n Accept ISO639-1 Code or Rezio Language UUID
\n Check /getDataOption?option=languageAll to get code/ UUID\n
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
" tags: - Create Product parameters: - name: productUuid in: path description: '' required: true example: 597a8861-82ce-4770-892a-ab718f76a63c schema: type: string requestBody: content: application/json: example: guideLanguagesUuids: - 7e8eaa1f-330d-436a-b17d-bdbefe83ab20 - 18bf6598-1711-4296-b0b2-023479a016a8 - 8a6cc5a7-3890-4d73-b338-7eb209aa4b82 deviceLanguagesUuids: [] onsiteLanguagesUuids: [] materialLanguagesUuids: [] schema: type: object properties: guideLanguagesUuids: type: array items: type: string deviceLanguagesUuids: type: array items: {} onsiteLanguagesUuids: type: array items: {} materialLanguagesUuids: type: array items: {} /v1/product/{productUuid}/tag: put: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string example: code: S0000 codeMessage: SUCCESS summary: Update Product Tag operationId: put-v1-product-productUuid-tag description: "*Optional step in creating a product*
Update a product's tags, for example, activity type, intensity, suitable age, etc.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/product/{productUuid}/tag
HTTP MethodPUT
ParametersIn Uri & Raw Body
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters- In Uri\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
productUuidUUIDYProduct UUID
\n\n##### Parameters- Raw Body\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
tagsarrayYTags
\n Check tags for details
landmarkUuidsarrayY\n Landmark UUID
\n Check /v1/dataOption?option=landmark for details\n
\n\n##### *tags*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
tagGroupUuidUUIDYTag group UUID
\n Check /v1/dataOption?option=tag for details\n
tagUuidsarrayYTag UUIDs
\n Note: tags in the same group may limit by maxSelectedCount
\n Check/v1/dataOption?option=tag for limitation and details\n
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
" tags: - Create Product parameters: - name: productUuid in: path description: '' required: true example: 597a8861-82ce-4770-892a-ab718f76a63c schema: type: string requestBody: content: application/json: example: tags: - tagGroupUuid: a957ecc8-5efd-4159-8dae-6e60827f2efb tagUuids: - 87d7a0c9-88ae-4fb8-9c3b-b52740b45e96 - f7507a18-11cf-4c91-982c-086efc2e00d5 landmarkUuids: - 48a6d747-528b-416b-a04c-d37622282b9a schema: type: object properties: tags: type: array items: type: object properties: tagGroupUuid: type: string tagUuids: type: array items: type: string landmarkUuids: type: array items: type: string /v1/product/{productUuid}/extra: put: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string example: code: S0000 codeMessage: SUCCESS summary: Apply Product Extra operationId: put-v1-product-productUuid-extra description: "*Optional step in creating a product*
Apply multiple extra items with extraUuids.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/product/{productUuid}/extra
HTTP MethodPUT
ParametersIn Uri & Raw Body
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters- In Uri\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
productUuidUUIDYProduct UUID
\n\n##### Parameters- Raw Body\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
extraUuidsarrayYExtra UUID
\n Check /v1/setting/extra to get UUID\n
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
" tags: - Create Product parameters: - name: productUuid in: path description: '' required: true example: 597a8861-82ce-4770-892a-ab718f76a63c schema: type: string requestBody: content: application/json: example: extraUuids: - 82097bf2-d2a8-458a-b5f9-cc807a060c82 schema: type: object properties: extraUuids: type: array items: type: string /v1/publish/{productUuid}/pricePolicy: put: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string example: code: S0000 codeMessage: SUCCESS summary: Apply Pricing Policy operationId: put-v1-publish-productUuid-pricePolicy description: "*` REQUIRED ` step of creating a product*
Apply an existing policing policy to product\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/publish/{productUuid}/pricePolicy
HTTP MethodPUT
ParametersIn Uri & Raw Body
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters- In Uri\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
productUuidUUIDYProduct UUID
\n\n##### Parameters- Raw Body\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
priceStartAtnumber-The advertising price. You can enter a price for advertising purpose. Or leave it blank, system will generate the lowest price from binding prices (adult first).
salesOptionarrayYApply pricing policy to package
\n Check salesOption for details
\n\n##### *salesOption*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
uuidUUIDYPackage UUID
applyToarrayYTime which will be applied to
\n Check applyTo for details\n
maxQuotaPerBookingintYLimited quantity for single order
\n -1 indicates no limitation\n
limitarrayYLimited quantity of each identity
\n Check limit for details\n
constraintarrayYBooking constraints. Leave empty if there are no constraints.
\n This setting only works when identity data with isConstraint
\n Check constraint for details\n
singularstringYItem alias - singular
pluralstringYItem alias - plural
\n\n##### *salesOption - applyTo*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \ \ \n \n \n
NameTypeRequiredDescription
pricePolicyUuidUUIDYPricing Policy UUID
typestringYApply type
\n WEEKDAYS Repeated by weekdays
\n DATES By specific date\n
periodarrayYPeriod. Check period for details\n
\n\n##### *salesOption - applyTo - period*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
valuemultipleYWhen type = WEEKDAYS, weekday value list:
\n Mon Monday
\n Tue Tuesday
\n Wed Wednesday
\n Thu Thursday
\n Fri Friday
\n Sat Saturday
\n Sun Sunday
\n
\n When type = DATES, specific dates
\n Accept array, date format is YYYY-MM-DD, i.e., 2019-05-20\n
startTimestringYStart from, the price applied time. Format is HH:mm, i.e., 09:00
endTimestringYEnd to, the price applied time. Format is HH:mm, i.e., 18:00
\n\n##### *salesOption - limit*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
typestringYCharge type
\n PERSON Charge by person
\n ITEM Charge by item\n
identityUuidUUID-Identity UUID
\n Required when charge type is PERSON\n
labelstring-Item label name
\n Required when charge type is ITEM\n
minintYMinimum required quantity of this identity. Value was included
maxintYMaximum quantity of this identity. Value was NOT included
\n\n##### *salesOption - constraint*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
targetIdentityUuidUUIDYConstraint target identity UUID
\n Example: 1 child needs 1 adult, target identity is Child
\n Check /getDataOption?option=identity to get identity UUID.\n
targetNumintYQuantity of constraint target
needIdentityUuidUUIDYConstraint needed identity UUID
\n Example: 1 child needs 1 adult, needed identity is Adult
\n Check /getDataOption?option=identity to get identity UUID.\n
needNumintYQuantity of Constraint needed
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n\ \ \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
" tags: - Publish Settings parameters: - name: productUuid in: path description: Product UUID required: true example: 597a8861-82ce-4770-892a-ab718f76a63c schema: type: string requestBody: content: application/json: example: priceStartAt: 29.99 salesOption: - uuid: c15d3c20-c548-42be-aa7b-b6ba53a41962 maxQuotaPerBooking: -1 applyTo: - pricePolicyUuid: 33a6058e-232c-4fb1-9169-9607827d5614 type: WEEKDAYS period: - value: Mon startTime: 08:00 endTime: '17:00' - value: Tue startTime: 08:00 endTime: '17:00' - value: Wed startTime: 08:00 endTime: '17:00' - value: Thu startTime: 08:00 endTime: '17:00' - value: Fri startTime: 08:00 endTime: '17:00' limit: - type: PERSON identityUuid: d6871da2-c391-468e-ad9b-f8d5148fe0cd min: 1 max: 20 - type: PERSON identityUuid: 175087ec-03a7-4aa4-a288-29f65bb8966e min: 0 max: 20 constraint: - targetIdentityUuid: 175087ec-03a7-4aa4-a288-29f65bb8966e targetNum: 1 needIdentityUuid: d6871da2-c391-468e-ad9b-f8d5148fe0cd needNum: 1 plural: participant singular: participants schema: type: object properties: priceStartAt: type: number salesOption: type: array items: type: object properties: uuid: type: string maxQuotaPerBooking: type: number applyTo: type: array items: type: object properties: pricePolicyUuid: type: string type: type: string period: type: array items: type: object properties: value: type: string startTime: type: string endTime: type: string required: - value - startTime - endTime limit: type: array items: type: object properties: type: type: string identityUuid: type: string min: type: number max: type: number required: - type - identityUuid - min - max constraint: type: array items: type: object properties: targetIdentityUuid: type: string targetNum: type: number needIdentityUuid: type: string needNum: type: number plural: type: string singular: type: string /v1/publish/sessionSetting/{sessionSettingUuid}: get: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string data: type: object properties: uuid: type: string productUuid: type: string salesOptionUuid: type: string quotaTotal: type: number periodStartDate: type: string periodEndDate: type: string time: type: array items: type: object properties: start: type: string days: type: number hours: type: number mins: type: number weekdays: type: array items: type: object properties: value: type: string from: type: string to: type: string required: - value - from - to resourceUuids: type: array items: type: string example: code: S0000 codeMessage: SUCCESS data: uuid: e1c135dc-47ec-4d05-9c66-0eb4d73ef115 productUuid: 597a8861-82ce-4770-892a-ab718f76a63c salesOptionUuid: c15d3c20-c548-42be-aa7b-b6ba53a41962 quotaTotal: 10 periodStartDate: '2019-06-01' periodEndDate: '2019-12-31' time: - start: 09:00 days: 0 hours: 8 mins: 0 weekdays: - value: Mon from: 08:00 to: '17:00' - value: Tue from: 08:00 to: '17:00' - value: Wed from: 08:00 to: '17:00' - value: Thu from: 08:00 to: '17:00' - value: Fri from: 08:00 to: '17:00' - value: Sat from: 08:00 to: '17:00' - value: Sun from: 08:00 to: '17:00' resourceUuids: - 6fd0646e-aeed-445c-b19f-5c0d5099ac17 summary: Get Session Setting operationId: get-v1-publish-sessionSetting-sessionSettingUuid description: "Load an existing session setting by sessionSettingUuid.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/publish/sessionSetting/{sessionSettingUuid}
HTTP MethodGET
ParametersIn Uri
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters- In Uri\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
sessionSettingUuidUUIDYSession Setting UUID
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
dataobjectResponse data, check data for details
\n\n##### *data*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
uuidUUIDSession Setting UUID
productUuidUUIDProduct UUID
salesOptionUuidUUIDPackage UUID
quotaTotalintTotal available seats
periodStartDatestringPeriod start date. Format is YYYY-MM-DD
periodEndDatestringPeriod end date. Format is YYYY-MM-DD
timearrayCheck time for details
weekdaysarrayCheck weekdays for details
resourceUuidsarrayResource UUID
\n Check /v1/setting/resource for details\n
\n\n##### *time*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
startstringStart time slot in a day. Format is HH:mm, i.e., 09:00
daysintDuration in days from start time slot
hoursintDuration in hours from start time slot
minsintDuration in minutes from start time slot
\n\n##### *weekdays*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
valuestringWeekday list:
\n Mon Monday
\n Tue Tuesday
\n Wed Wednesday
\n Thu\ \ Thursday
\n Fri Friday
\n Sat Saturday
\n Sun Sunday\n
fromstringStart time, from. Format is HH:mm, i.e., 09:00
tostringEnd time, to. Format is HH:mm, i.e., 18:00
" tags: - Publish Settings parameters: - name: sessionSettingUuid in: path description: '' required: true example: e1c135dc-47ec-4d05-9c66-0eb4d73ef115 schema: type: string put: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string example: code: S0000 codeMessage: SUCCESS summary: Update Session Setting operationId: put-v1-publish-sessionSetting-sessionSettingUuid description: "Update a session setting by sessionSettingUuid.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/publish/sessionSetting/{sessionSettingUuid}
HTTP MethodPUT
ParametersIn Uri & Raw Body
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters- In Uri\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
sessionSettingUuidUUIDYSession Setting UUID
\n\n##### Parameters- Raw Body\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
sessionUuidUUIDYSession UUID
salesOptionUuidUUIDYPackage UUID
targetintYRange of editing operation for the same Session Setting
\n 1 This and the following sessions
\n 2 All sessions\n
quotaTotalintYTotal available seats
periodStartDatestringYStart selling date. Format is YYYY-MM-DD
periodEndDatestringYEnd of selling date. Format is YYYY-MM-DD
timearrayYCheck time for details
weekdaysarrayYCheck weekdays for details
resourceUuidsarray-Resource UUID
\n Check /v1/setting/resource for details\n
\n\n##### *time*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
startstringYStart time slot in a day. Format is HH:mm, i.e., 09:00
daysintYDuration in days
hoursintYDuration in hours
minsintYDuration in minutes
\n\n##### *weekdays*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
valuestringYWeekday value list:
\n Mon Monday
\n Tue Tuesday
\n Wed Wednesday
\n Thu Thursday
\n Fri Friday
\n Sat Saturday
\n Sun Sunday\n \ \
fromstringYStart time, from. Format is HH:mm, i.e., 09:00
tostringYEnd time, to. Format is HH:mm, i.e., 18:00
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
" tags: - Publish Settings parameters: - name: sessionSettingUuid in: path description: '' required: true example: e1c135dc-47ec-4d05-9c66-0eb4d73ef115 schema: type: string requestBody: content: application/json: example: sessionUuid: 3c83a3d9-dffe-4898-a234-2ffb52a9dcee salesOptionUuid: c15d3c20-c548-42be-aa7b-b6ba53a41962 target: 1 quotaTotal: 10 periodStartDate: '2019-06-01' periodEndDate: '2019-12-31' time: - start: 09:00 days: 0 hours: 8 mins: 0 weekdays: - value: Mon from: 08:00 to: '17:00' - value: Tue from: 08:00 to: '17:00' - value: Wed from: 08:00 to: '17:00' - value: Thu from: 08:00 to: '17:00' - value: Fri from: 08:00 to: '17:00' - value: Sat from: 08:00 to: '17:00' - value: Sun from: 08:00 to: '17:00' resourceUuids: - 6fd0646e-aeed-445c-b19f-5c0d5099ac17 schema: type: object properties: sessionUuid: type: string salesOptionUuid: type: string target: type: number quotaTotal: type: number periodStartDate: type: string periodEndDate: type: string time: type: array items: type: object properties: start: type: string days: type: number hours: type: number mins: type: number weekdays: type: array items: type: object properties: value: type: string from: type: string to: type: string required: - value - from - to resourceUuids: type: array items: type: string /v1/publish/sessionSetting: post: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string data: type: object properties: uuid: type: string example: code: S0000 codeMessage: SUCCESS data: uuid: e1c135dc-47ec-4d05-9c66-0eb4d73ef115 summary: Create Session Setting operationId: post-v1-publish-sessionSetting description: "*` REQUIRED ` step of creating a product*
Create a new session setting for product\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/publish/sessionSetting
HTTP MethodPOST
ParametersRaw Body
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters- Raw Body\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
productUuidUUIDYProduct UUID
\n Check /v1/product/list for more detail\n
salesOptionUuidUUIDYPackage UUID
\n Use Product UUID to get related packages by /v1/product/{productUuid}/salesOption\n
quotaTotalintYTotal available seats
periodStartDatestringYPeriod start date. Format is YYYY-MM-DD
periodEndDatestringYPeriod end date. Format is YYYY-MM-DD
timearrayYCheck time for details
weekdaysarrayYCheck weekdays for details
resourceUuidsarray-Resource UUID
\n Check /v1/setting/resource for details\n
\n\n##### *time*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
startstringYStart time slot in a day
\n Format is HH:mm
\n Range: HH 00~23; mm 00, 30\n
daysintYDuration in days. Range is 0~7
hoursintYDuration in hours. Range is 0~23
minsintYDuration in minutes, with 5-minute intervals. Value: 0, 5, 10, 15, 20, 25, 30, 35, 40, 45, 50, 55\n
\n\n##### *weekdays*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
valuestringYWeekday value list:
\n Mon Monday
\n Tue Tuesday
\n Wed Wednesday
\n Thu Thursday
\n Fri Friday
\n Sat Saturday
\n Sun Sunday\n
fromstringYStart time, from.\ \ Format is HH:mm, i.e., 09:00
tostringYEnd time, to. Format is HH:mm, i.e., 18:00
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
dataobjectResponse data, check data for details
\n\n##### *data*\n\n\n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
uuidUUIDSession Setting UUID
" tags: - Publish Settings requestBody: content: application/json: example: productUuid: 597a8861-82ce-4770-892a-ab718f76a63c salesOptionUuid: c15d3c20-c548-42be-aa7b-b6ba53a41962 quotaTotal: 10 periodStartDate: '2019-06-01' periodEndDate: '2019-12-31' time: - start: 09:00 days: 0 hours: 8 mins: 0 weekdays: - value: Mon from: 08:00 to: '17:00' - value: Tue from: 08:00 to: '17:00' - value: Wed from: 08:00 to: '17:00' - value: Thu from: 08:00 to: '17:00' - value: Fri from: 08:00 to: '17:00' - value: Sat from: 08:00 to: '17:00' - value: Sun from: 08:00 to: '17:00' resourceUuids: - 6fd0646e-aeed-445c-b19f-5c0d5099ac17 schema: type: object properties: productUuid: type: string salesOptionUuid: type: string quotaTotal: type: number periodStartDate: type: string periodEndDate: type: string time: type: array items: type: object properties: start: type: string days: type: number hours: type: number mins: type: number weekdays: type: array items: type: object properties: value: type: string from: type: string to: type: string required: - value - from - to resourceUuids: type: array items: type: string /v1/publish/session/{sessionUuid}: get: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string data: type: object properties: uuid: type: string sessionSettingUuid: type: string productUuid: type: string salesOptionUuid: type: string sessionStartDate: type: string sessionStartTime: type: string sessionWeekday: type: string sessionEndDate: type: string sessionEndTime: type: string resourceUuids: type: array items: type: string sessionPrice: type: array items: type: object properties: pricePolicyUuid: type: string pricePolicyLabel: type: string type: type: string currencyUuid: type: string policy: type: object properties: identityUuid: type: string itemUuid: type: string label: type: string price: type: number required: - pricePolicyUuid - pricePolicyLabel - type - currencyUuid - policy quotaTotal: type: number quotaBooked: type: number active: type: number example: code: S0000 codeMessage: SUCCESS data: uuid: 3c83a3d9-dffe-4898-a234-2ffb52a9dcee sessionSettingUuid: e1c135dc-47ec-4d05-9c66-0eb4d73ef115 productUuid: 597a8861-82ce-4770-892a-ab718f76a63c salesOptionUuid: c15d3c20-c548-42be-aa7b-b6ba53a41962 sessionStartDate: '2019-06-10' sessionStartTime: 09:00 sessionWeekday: Mon sessionEndDate: '2019-06-10' sessionEndTime: '17:00' resourceUuids: - 6fd0646e-aeed-445c-b19f-5c0d5099ac17 sessionPrice: - pricePolicyUuid: 33a6058e-232c-4fb1-9169-9607827d5614 pricePolicyLabel: Day Tour - Weekday departures type: PERSON currencyUuid: b5317f07-b5a0-4525-8ff7-3fe55b4d96ec policy: identityUuid: d6871da2-c391-468e-ad9b-f8d5148fe0cd itemUuid: '' label: '' price: 29.99 - pricePolicyUuid: 33a6058e-232c-4fb1-9169-9607827d5614 pricePolicyLabel: Day Tour - Weekday departures type: PERSON currencyUuid: b5317f07-b5a0-4525-8ff7-3fe55b4d96ec policy: identityUuid: 175087ec-03a7-4aa4-a288-29f65bb8966e itemUuid: '' label: '' price: 6 quotaTotal: 0 quotaBooked: 0 active: 1 summary: Get Session operationId: get-v1-publish-session-sessionUuid description: "Load an existing session by sessionUuid\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/publish/session/{sessionUuid}
HTTP MethodGET
ParametersIn Uri & Query String
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters- In Uri\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
sessionUuidUUIDYSession UUID
\n\n##### Parameters\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
productUuidUUIDYProduct UUID
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
dataobjectResponse data, check data for details
\n\n##### *data*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
uuidUUIDSession UUID
sessionSettingUuidUUIDSession Setting UUID
productUuidUUIDProduct UUID
\n Check /v1/product/list for more detail\n
salesOptionUuidUUIDPackage UUID
sessionStartDatestringSession start date. Format is YYYY-MM-DD (product timezone)
sessionStartTimestringStart time of session. Format is HH:mm, i.e., 09:00 (product timezone)
sessionWeekdaystringWeekday of session, value list:
\n Mon Monday
\n Tue Tuesday
\n Wed Wednesday
\n Thu Thursday
\n Fri Friday
\n Sat Saturday
\n Sun Sunday\n
sessionEndDatestringSession end date. Format is YYYY-MM-DD (product timezone)
sessionEndTimestringEnd time of session. Format is HH:mm, i.e., 18:00 (product timezone)
resourceUuidsarrayResource UUID
\n Check /v1/setting/resource for details\n
sessionPricearrayCheck sessionPrice for details\n
quotaTotalintTotal\ \ available seats
quotaBookedintSeats booked
activeintIs this session activated?
\n 1 Yes, active, available for booking
\n 0 No, inactive\n
\n\n##### *sessionPrice*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
pricePolicyUuidUUIDPricing Policy UUID
\n Check /v1/setting/pricePolicy for details\n
pricePolicyLabelstringLabel name of price policy
typestringCharge type
\n PERSON Charge by person
\n ITEM Charge by item\n
currencyUuidUUIDCurrency UUID
\n Rezio Currency UUID, check/getDataOption?option=currency UUID for details\n
policyarrayCheck policy for details
\n\n##### *sessionPrice - policy*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
identityUuidUUIDIdentity UUID
\n i.e., Adult, available for charge type PERSON
\n Check /getDataOption?option=identity for details\n
itemUuidUUIDPricing Item UUID
\n Available when charge type is ITEM\n
labelstringItem label name
\n Available and required when identity.type = ITEM\n
pricenumberPrice
" tags: - Publish Settings parameters: - name: sessionUuid in: path description: '' required: true example: 3c83a3d9-dffe-4898-a234-2ffb52a9dcee schema: type: string - name: productUuid in: query description: '' required: true example: 597a8861-82ce-4770-892a-ab718f76a63c schema: type: string put: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string example: code: S0000 codeMessage: SUCCESS summary: Update Session Availability or Price operationId: put-v1-publish-session-sessionUuid description: "Update a session availability or price by sessionUuid\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/publish/session/{sessionUuid}
HTTP MethodPUT
ParametersIn Uri & Raw Body
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters- In Uri\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
sessionUuidUUIDYSession UUID
\n\n##### Parameters- Raw Body\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
productUuidUUIDYProduct UUID
quotaTotalintYTotal available seats
pricearrayYPricing rule, check price for details
\n\n##### *price*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
typestringYCharge type
\n PERSON Charge by person
\n ITEM Charge by item\n
pricePolicyUuidUUID-Pricing Policy UUID
\n Check /v1/setting/pricePolicy to get UUID\n
valuearrayYPrice Setting
\n Check value for details
\n\n##### *price - value*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
identityUuidUUID-Identity UUID
\n i.e., Adult, available for charge type PERSON
\n Check /getDataOption?option=identity for details\n
labelstringYItem label name
\n Available and required when identity.type = ITEM\n
pricenumberYPrice
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
" tags: - Publish Settings parameters: - name: sessionUuid in: path description: '' required: true example: 3c83a3d9-dffe-4898-a234-2ffb52a9dcee schema: type: string requestBody: content: application/json: example: productUuid: 597a8861-82ce-4770-892a-ab718f76a63c quotaTotal: 10 price: - type: PERSON pricePolicyUuid: 33a6058e-232c-4fb1-9169-9607827d5614 value: - identityUuid: d6871da2-c391-468e-ad9b-f8d5148fe0cd price: 29.99 - identityUuid: 175087ec-03a7-4aa4-a288-29f65bb8966e price: 6 schema: type: object properties: productUuid: type: string quotaTotal: type: number price: type: array items: type: object properties: type: type: string pricePolicyUuid: type: string value: type: array items: type: object properties: identityUuid: type: string price: type: number required: - identityUuid - price /v1/publish/session/{sessionUuid}/active: put: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string example: code: S0000 codeMessage: SUCCESS summary: Active Session operationId: put-v1-publish-session-sessionUuid-active description: "Turn on or turn off a session by sessionUuid\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/publish/session/{sessionUuid}/active
HTTP MethodPUT
ParametersIn Uri & Raw Body
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters- In Uri\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
sessionUuidUUIDYSession UUID
\n\n##### Parameters- Raw Body\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
productUuidUUIDYProduct UUID
targetintYRange of editing operation for the same Session Setting
\n 1 This and the following sessions
\n 2 All sessions
\n 3 This session\n
activeintYIs this session activated?
\n 1 Yes, active, available for booking
\n 0 No, inactive\n
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
" tags: - Publish Settings parameters: - name: sessionUuid in: path description: '' required: true example: 3c83a3d9-dffe-4898-a234-2ffb52a9dcee schema: type: string requestBody: content: application/json: example: productUuid: 597a8861-82ce-4770-892a-ab718f76a63c target: 3 active: 0 schema: type: object properties: productUuid: type: string target: type: number active: type: number /v1/publish/calendar: get: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string data: type: object properties: availableDate: type: array items: type: string availableTimeInDate: type: object properties: '2019-06-10': type: array items: type: string '2019-06-11': type: array items: type: string sessionData: type: object properties: '201906100900': type: array items: type: object properties: productUuid: type: string productTitle: type: string salesOptionUuid: type: string salesOptionTitle: type: string publishStatus: type: number sessionUuid: type: string sessionStartDate: type: string sessionStartTime: type: string sessionEndDate: type: string sessionEndTime: type: string sessionPrice: type: array items: type: object properties: pricePolicyUuid: type: string pricePolicyLabel: type: string type: type: string policy: type: array items: type: object properties: identityUuid: type: string itemUuid: type: string label: type: string price: type: number required: - identityUuid - itemUuid - label - price currencyUuid: type: string quotaTotal: type: number quotaBooked: type: number quotaAvailable: type: number active: type: number '201906110900': type: array items: type: object properties: productUuid: type: string productTitle: type: string salesOptionUuid: type: string salesOptionTitle: type: string publishStatus: type: number sessionUuid: type: string sessionStartDate: type: string sessionStartTime: type: string sessionEndDate: type: string sessionEndTime: type: string sessionPrice: type: array items: type: object properties: pricePolicyUuid: type: string pricePolicyLabel: type: string type: type: string policy: type: array items: type: object properties: identityUuid: type: string itemUuid: type: string label: type: string price: type: number required: - identityUuid - itemUuid - label - price currencyUuid: type: string quotaTotal: type: number quotaBooked: type: number quotaAvailable: type: number active: type: number example: code: S0000 codeMessage: SUCCESS data: availableDate: - '2019-06-10' - '2019-06-11' availableTimeInDate: '2019-06-10': - 09:00 '2019-06-11': - 09:00 sessionData: '201906100900': - productUuid: 597a8861-82ce-4770-892a-ab718f76a63c productTitle: 'Day Tour from Taipei: Jiufen Old Street, Golden Waterfall, and Bitou Cape' salesOptionUuid: c15d3c20-c548-42be-aa7b-b6ba53a41962 salesOptionTitle: Day tour publishStatus: 1 sessionUuid: 3c83a3d9-dffe-4898-a234-2ffb52a9dcee sessionStartDate: '2019-06-10' sessionStartTime: 09:00 sessionEndDate: '2019-06-10' sessionEndTime: '17:00' sessionPrice: - pricePolicyUuid: 33a6058e-232c-4fb1-9169-9607827d5614 pricePolicyLabel: Day Tour - Weekday departures type: PERSON policy: - identityUuid: d6871da2-c391-468e-ad9b-f8d5148fe0cd itemUuid: '' label: '' price: 29.99 - identityUuid: 175087ec-03a7-4aa4-a288-29f65bb8966e itemUuid: '' label: '' price: 6 currencyUuid: b5317f07-b5a0-4525-8ff7-3fe55b4d96ec quotaTotal: 10 quotaBooked: 0 quotaAvailable: 10 active: 1 '201906110900': - productUuid: 597a8861-82ce-4770-892a-ab718f76a63c productTitle: 'Day Tour from Taipei: Jiufen Old Street, Golden Waterfall, and Bitou Cape' salesOptionUuid: c15d3c20-c548-42be-aa7b-b6ba53a41962 salesOptionTitle: Day tour publishStatus: 1 sessionUuid: f69e8340-a31a-4fe4-9d41-cdd61205b6d1 sessionStartDate: '2019-06-11' sessionStartTime: 09:00 sessionEndDate: '2019-06-11' sessionEndTime: '17:00' sessionPrice: - pricePolicyUuid: 33a6058e-232c-4fb1-9169-9607827d5614 pricePolicyLabel: Day Tour - Weekday departures type: PERSON policy: - identityUuid: d6871da2-c391-468e-ad9b-f8d5148fe0cd itemUuid: '' label: '' price: 29.99 - identityUuid: 175087ec-03a7-4aa4-a288-29f65bb8966e itemUuid: '' label: '' price: 6 currencyUuid: b5317f07-b5a0-4525-8ff7-3fe55b4d96ec quotaTotal: 10 quotaBooked: 0 quotaAvailable: 10 active: 1 summary: Get Calendar - Availability operationId: get-v1-publish-calendar description: "\nLoad availability calendar with a specific date range by `startDate` and `endDate`. This will return a list of sessions, including their availability, pricing policy and details. Rezio allows specific price or availability changes in a single session, so be sure to use the correct session for making a booking.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/publish/calendar
HTTP MethodGET
ParametersQuery string
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
startDatestringYQuery period, start date. Format is YYYY-MM-DD
endDatestringYQuery period, end date. Format is YYYY-MM-DD
productUuidUUID-Product UUID
\n Check /v1/product/list for more detail\n
salesOptionUuidUUID-Package UUID
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
dataobjectResponse data, check data for details
\n\n##### *data*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
availableDatearrayAll available session date. Format is YYYY-MM-DD
availableTimeInDatearrayAll available session time. Format is HH:mm, i.e., 09:00
\n Use session date as key. Format is YYYY-MM-DD
\n Example: { \"2019-05-24\": [\"09:00\", \"14:00\"] }\n
sessionDataarraySession data
\n Check sessionData for details
\n Use session start time as key. Format is YYYYMMDDHHmm, i.e., 201905240900\n
\n\n##### *sessionData*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\ \ \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
productUuidUUIDProduct UUID
\n Check /v1/product/list for more detail\n
productTitlestringProduct name
salesOptionUuidUUIDPackage UUID
salesOptionTitlestringName of package
publishStatusintPublish status of package
\n 1 Sale turned ON
\n 0 Sale turned OFF\n
sessionUuidUUIDSession UUID
sessionEndDatestringSession end date. Format is YYYY-MM-DD
sessionEndTimestringEnd time of session. Format is HH:mm, i.e., 18:00
sessionPricearrayCheck sessionPrice for details\n
quotaTotalintTotal available seats
quotaBookedintSeats booked
quotaAvailableintSeats available
activeintIs this session activated?
\n 1 Yes, active, available for booking
\n 0 No, inactive\n
\n\n##### *sessionPrice*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
pricePolicyUuidUUIDPricing Policy UUID
\n Check /v1/setting/pricePolicy to get UUID\n
pricePolicyLabelstringPricing policy label name
typestringCharge type
\n PERSON Charge by person
\n ITEM Charge by item\n
policyarrayRule
\n Check policy for details\n
currencyUuidUUIDCurrency UUID
\n Rezio Currency UUID, check/getDataOption?option=currency UUID for details\n
\n\n##### *sessionPrice - policy*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
identityUuidUUIDIdentity UUID
\n i.e., Adult, available for charge type PERSON
\n Check /getDataOption?option=identity for details\n
itemUuidUUIDPricing Item UUID
\n Available when charge type is ITEM\n
labelstringItem label name
\n Available and required when identity.type = ITEM\n
pricenumberPrice
" tags: - Publish Settings parameters: - name: startDate in: query description: query period, start date required: true example: '2019-06-10' schema: type: string - name: endDate in: query description: query period, end date required: true example: '2019-06-11' schema: type: string - name: productUuid in: query description: '' example: 597a8861-82ce-4770-892a-ab718f76a63c schema: type: string - name: salesOptionUuid in: query description: '' example: c15d3c20-c548-42be-aa7b-b6ba53a41962 schema: type: string /v1/order/list: get: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string data: type: object properties: totalCount: type: number page: type: number itemPerPage: type: number list: type: array items: type: object properties: uuid: type: string productUuid: type: string salesOptionUuid: type: string sessionUuid: type: string amount: type: number orderStatus: type: number createdAt: type: string sessionStartDate: type: string sessionStartTime: type: string orderNo: type: string productCode: type: string productName: type: string balance: type: number contactFirstName: type: string contactLastName: type: string sourceOrderNo: type: string orderSource: type: string orderSubSource: type: string example: code: S0000 codeMessage: SUCCESS data: totalCount: 1 page: 1 itemPerPage: 20 list: - uuid: aeaeb7d4-ab8b-4e73-9fab-80a7e966ad58 productUuid: 597a8861-82ce-4770-892a-ab718f76a63c salesOptionUuid: c15d3c20-c548-42be-aa7b-b6ba53a41962 sessionUuid: e3f55be9-5f47-4ad1-8ae6-1ed5968ea42c amount: 43.99 orderStatus: 4 createdAt: '2019-06-05 12:10:34+00' sessionStartDate: '2019-06-07' sessionStartTime: 09:00 orderNo: TT190605ST0003 productCode: JIUFENA1 productName: 'Day Tour from Taipei: Jiufen Old Street, Golden Waterfall, and Bitou Cape' balance: 0 contactFirstName: John contactLastName: Doe sourceOrderNo: '' orderSource: Admin orderSubSource: '' summary: List Orders operationId: get-v1-order-list description: "List all existing orders. Available filters are order status, booking date, depature date, etc.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/order/list
HTTP MethodGET
ParametersQuery string
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
pageint-Pages. Default/minimum value is 1
itemPerPageint-Record counts per page. Default/maximum value is 20
textstring-Filter text, query in order number, product name, product code, package name
statusint-Filter by order status
dateTypeint-Filter by date range
\n 1 Booking date
\n 2 Departure date\n
fromstring-Filter date range, start from. Format is YYYY-MM-DD
tostring-Filter date range, end to. Format is YYYY-MM-DD
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
dataobjectResponse data, check data for details
\n\n##### *data*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
totalCountintRecord counts
pageintCurrent page number
itemPerPageintRecord counts per page. Default/maximum value is 20
listarrayOrders, check list for details
\n\n##### *list*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \ \ \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
uuidUUIDOrder UUID
productUuidUUIDProduct UUID
\n Check /v1/product/list for more detail\n
salesOptionUuidUUIDPackage UUID
sessionUuidUUIDSession UUID
amoutnumberTotal amount
orderStatusintOrder status
\n -2 Expired
\n 0 Cancelled
\n 1 New & Unpaid
\n 2 New & Paid
\n 3 Pending
\n 4 Confirmed
\n 5 Check-in & Redeem
\n 6 No-show
\n 7 Canceling
\n 8 Cancel Requested
\n 9 Departed
\n 10 Channel Redeemed
\n 11 Cancelled by Channel
\n 12 Completed in Channel
\n
createdAtstringOrder created date. Format is YYYY-MM-DD'T'HH:mm:ss'Z'
sessionStartDatestringOrder departure date, which is session start date. Format is YYYY-MM-DD (product timezone)
sessionStartTimestringOrder departure time, which is start time of session. Format is HH:mm, i.e., 09:00 (product timezone)
contactFirstNamestringContact, first name
contactLastNamestringContact, last name
orderNostringOrder number
productNamestringProduct name
productCodestringProduct code
balancenumberBalance, unpaid amount
sourceOrderNostringChannel Order No.
orderSourcestringOrder Source
\n MySite MySite
\n Admin Admin
\n Widget Widget
\n Machine Machine
\n KKday KKday
\n KKdayMkp KKday Marketplace
\n activityJapan Activity Japan
\n Viator Viator
\n Jalan Jalan
\n GYG GetYourGuide
\n Names that are not listed above are Distributor names.
\n
orderSubSourcestringOrder sub Source
\n This field could be null.
\n POS POS
\n KIOSK Kiosk
\n TTD Google TTD
\n Names that are not listed above are either Custom Order Sources or special product pages cooperated with KKday, displayed as \"Website\".\n
" tags: - Orders parameters: - name: page in: query description: '' example: '1' schema: type: string default: '1' - name: itemPerPage in: query description: '' example: '20' schema: type: string default: '20' - name: text in: query description: '' schema: type: string - name: status in: query description: '' schema: type: string enum: - '-2' - '0' - '1' - '2' - '3' - '4' - '5' - '6' - '7' - '8' - '9' - '10' - '11' - '12' - name: dateType in: query description: '' schema: type: string enum: - booking - departure - name: from in: query description: '' schema: type: string - name: to in: query description: '' schema: type: string /v1/order/{orderNo}/detail: get: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string data: type: object properties: uuid: type: string orderNo: type: string productUuid: type: string salesOptionUuid: type: string sessionUuid: type: string currencyUuid: type: string amount: type: number orderStatus: type: number saleFrom: type: string orderTs: type: number sessionsettingUuid: type: string purchaseContent: type: array items: type: object properties: pricePolicyUuid: type: string type: type: string identityUuid: type: string itemUuid: type: string label: type: string quantity: type: number required: - pricePolicyUuid - type - identityUuid - itemUuid - label - quantity extras: type: array items: type: object properties: uuid: type: string quantity: type: number specialRequirement: type: string priceConfig: type: array items: type: object properties: pricePolicyUuid: type: string pricePolicyLabel: type: string type: type: string identityUuid: type: string isGroup: type: number seat: type: number isConstraint: type: number quantityWeight: type: number price: type: number from: type: number to: type: number required: - pricePolicyUuid - pricePolicyLabel - type - identityUuid - isGroup - seat - isConstraint - quantityWeight - price - from - to sessionStartDate: type: string sessionStartTime: type: string sessionWeekday: type: string sessionEndDate: type: string sessionEndTime: type: string resourceAllocation: type: array items: {} resourceUuids: type: array items: type: string contactInfo: type: object properties: 5b9256e0-0442-470f-8e80-4587703c4470: type: string adefb4ec-b408-4f5e-b71d-d1c79599cdbc: type: string bb3b43f7-996d-4e86-97b3-ffff35032e9a: type: string 2a3536a5-a94a-4619-9af7-a93e0110874b: type: array items: oneOf: - type: number - type: number - type: string 57035281-8a2a-4c76-8a44-f9cfa3117654: {} b13428d9-b9ff-473c-a612-66b6637221ed: {} 10662538-eef3-4171-9972-41300fa473d9: type: string 251a6a27-7fbc-4411-83ec-dfd1e9b93b1b: type: string 4e34479f-fe84-4bd3-a443-bbd7df182537: type: string 96e58831-e2df-453b-8a6e-4fd74da1dd64: type: string 496a769e-ad54-48b3-a5eb-0a5c8b83395f: type: string 790ebdf2-7b60-4d02-851d-7c7a680f172b: type: string c570a05e-31dc-4f1c-9669-9facb038ea2e: type: string 3f61ae81-2738-46dd-a83d-b09bc596d763: type: string 9665763e-7476-470a-9a65-a0bd3e062813: type: string bookingInfoDetail: type: object properties: ORDER: type: array items: {} PARTICIPANT: type: array items: type: object properties: 3adfb028-3db6-46d9-920f-9234a1c2b8b5: type: string 1d154db9-f77a-4233-9526-4aeba23efe69: type: string 0774fe06-9d14-4d88-bd36-4eebe638f5b6: type: string 8bac68fc-1711-4377-bd4f-8e1790d528c4: type: string 0dabee8f-50fb-4114-b368-7c15a0604f37: type: string 235b964b-7b1f-4cf3-b322-541079f0b333: type: string required: - 3adfb028-3db6-46d9-920f-9234a1c2b8b5 - 1d154db9-f77a-4233-9526-4aeba23efe69 - 0774fe06-9d14-4d88-bd36-4eebe638f5b6 - 8bac68fc-1711-4377-bd4f-8e1790d528c4 - 0dabee8f-50fb-4114-b368-7c15a0604f37 - 235b964b-7b1f-4cf3-b322-541079f0b333 productName: type: string productCode: type: string salesOptionName: type: string purchaseQuantity: type: number seatQuantity: type: number resourceSessionUuids: type: array items: type: string bookingInfoUuid: type: string amountDetail: type: object properties: purchaseContent: type: array items: type: object properties: identityUuid: type: string unitPrice: type: number subtotal: type: number required: - identityUuid - unitPrice - subtotal extras: type: array items: type: object properties: productExtraUuid: type: string label: type: string unitPrice: type: string subtotal: type: number feeNdTax: type: array items: type: object properties: type: type: string feeNdTaxUuid: type: string label: type: string subtotal: type: string total: type: number bookingInfoConfig: type: array items: type: object properties: uuid: type: string category: type: string label: type: string type: type: string config: type: object properties: values: type: array items: type: object properties: label: type: string value: type: string required: - label - value ask: type: number display: type: object properties: website: type: number internal: type: number sort: type: number required: - uuid - category - label - type - config - sort paid: type: number refund: type: number balance: type: number pickupRequest: type: object properties: pickupLocationUuid: type: string returnPickupLocationUuid: type: string customerRequest: type: string returnCustomerRequest: type: string detail: type: object properties: departure: type: object properties: type: type: number fixedPickupTime: type: string waitingTime: type: number label: type: string addressLine: type: string latitude: type: string longitude: type: string instructions: type: string return: type: object properties: type: type: number label: type: string addressLine: type: string latitude: type: string longitude: type: string instructions: type: string preferLanguage: type: object properties: guideLanguageUuid: type: string deviceLanguageUuid: type: string onsiteLanguageUuid: type: string materialLanguageUuid: type: string payType: type: number depositAmount: type: number depositDetail: type: object properties: {} cancelFeeDetail: type: object properties: {} paymentDetail: type: array items: type: object properties: uuid: type: string currencyUuid: type: string paymentType: type: number note: type: string paidDate: type: string amount: type: number noteDetail: type: array items: type: object properties: uuid: type: string note: type: string createdAt: type: string firstName: type: string lastName: type: string sourceOrderNo: type: string orderSource: type: string orderSubSource: type: string voucherInfo: type: object properties: voucherType: type: number voucherUrl: type: string example: code: S0000 codeMessage: SUCCESS data: uuid: aeaeb7d4-ab8b-4e73-9fab-80a7e966ad58 orderNo: TT190605ST0003 productUuid: 597a8861-82ce-4770-892a-ab718f76a63c salesOptionUuid: c15d3c20-c548-42be-aa7b-b6ba53a41962 sessionUuid: e3f55be9-5f47-4ad1-8ae6-1ed5968ea42c currencyUuid: b5317f07-b5a0-4525-8ff7-3fe55b4d96ec amount: 43.99 orderStatus: 4 saleFrom: Admin orderTs: 1559736634 sessionsettingUuid: e1c135dc-47ec-4d05-9c66-0eb4d73ef115 purchaseContent: - pricePolicyUuid: 66457454-6730-470a-9926-a8e2a19d8cbe type: PERSON identityUuid: d6871da2-c391-468e-ad9b-f8d5148fe0cd itemUuid: '' label: '' quantity: 1 - pricePolicyUuid: 66457454-6730-470a-9926-a8e2a19d8cbe type: PERSON identityUuid: 175087ec-03a7-4aa4-a288-29f65bb8966e itemUuid: '' label: '' quantity: 1 extras: - uuid: 82097bf2-d2a8-458a-b5f9-cc807a060c82 quantity: 0 specialRequirement: Will need a babe seat, please priceConfig: - pricePolicyUuid: 66457454-6730-470a-9926-a8e2a19d8cbe pricePolicyLabel: Day Tour - Weekend departures type: PERSON identityUuid: d6871da2-c391-468e-ad9b-f8d5148fe0cd isGroup: 0 seat: 1 isConstraint: 1 quantityWeight: 1 price: 37.99 from: 3 to: 99 - pricePolicyUuid: 66457454-6730-470a-9926-a8e2a19d8cbe pricePolicyLabel: Day Tour - Weekend departures type: PERSON identityUuid: 175087ec-03a7-4aa4-a288-29f65bb8966e isGroup: 0 seat: 0 isConstraint: 1 quantityWeight: 1 price: 6 from: 0 to: 2 sessionStartDate: '2019-06-07' sessionStartTime: 09:00 sessionWeekday: Fri sessionEndDate: '2019-06-07' sessionEndTime: ':' resourceAllocation: [] resourceUuids: - 6fd0646e-aeed-445c-b19f-5c0d5099ac17 contactInfo: 5b9256e0-0442-470f-8e80-4587703c4470: John adefb4ec-b408-4f5e-b71d-d1c79599cdbc: Doe bb3b43f7-996d-4e86-97b3-ffff35032e9a: johndoe_xxxxxxxxxxx@gmail.com 2a3536a5-a94a-4619-9af7-a93e0110874b: - 886 - 0912345678 57035281-8a2a-4c76-8a44-f9cfa3117654: null b13428d9-b9ff-473c-a612-66b6637221ed: null 10662538-eef3-4171-9972-41300fa473d9: '' 251a6a27-7fbc-4411-83ec-dfd1e9b93b1b: '' 4e34479f-fe84-4bd3-a443-bbd7df182537: '' 96e58831-e2df-453b-8a6e-4fd74da1dd64: '' 496a769e-ad54-48b3-a5eb-0a5c8b83395f: '' 790ebdf2-7b60-4d02-851d-7c7a680f172b: '' c570a05e-31dc-4f1c-9669-9facb038ea2e: '' 3f61ae81-2738-46dd-a83d-b09bc596d763: '' 9665763e-7476-470a-9a65-a0bd3e062813: '' bookingInfoDetail: ORDER: [] PARTICIPANT: - 3adfb028-3db6-46d9-920f-9234a1c2b8b5: John 1d154db9-f77a-4233-9526-4aeba23efe69: Doe 0774fe06-9d14-4d88-bd36-4eebe638f5b6: ORDER.GENDER_MALE 8bac68fc-1711-4377-bd4f-8e1790d528c4: '1981-01-01' 0dabee8f-50fb-4114-b368-7c15a0604f37: Taiwan 235b964b-7b1f-4cf3-b322-541079f0b333: '300012345' - 3adfb028-3db6-46d9-920f-9234a1c2b8b5: John Jr. 1d154db9-f77a-4233-9526-4aeba23efe69: Doe 0774fe06-9d14-4d88-bd36-4eebe638f5b6: ORDER.GENDER_MALE 8bac68fc-1711-4377-bd4f-8e1790d528c4: '2017-12-30' 0dabee8f-50fb-4114-b368-7c15a0604f37: Taiwan 235b964b-7b1f-4cf3-b322-541079f0b333: '300012346' productName: 'Day Tour from Taipei: Jiufen Old Street, Golden Waterfall, and Bitou Cape' productCode: JIUFENA1 salesOptionName: Day tour purchaseQuantity: 2 seatQuantity: 1 resourceSessionUuids: - d11c90f9-9deb-4aa0-bd93-4181348662bb bookingInfoUuid: 5dfa699c-bfe8-44f7-b7cb-3a53dbc423a1 amountDetail: purchaseContent: - identityUuid: d6871da2-c391-468e-ad9b-f8d5148fe0cd unitPrice: 37.99 subtotal: 37.99 - identityUuid: 175087ec-03a7-4aa4-a288-29f65bb8966e unitPrice: 6 subtotal: 6 extras: - productExtraUuid: 82097bf2-d2a8-458a-b5f9-cc807a060c82 label: Tea Time Meal Set unitPrice: '9.9' subtotal: 0 feeNdTax: - type: inclusive feeNdTaxUuid: 2dbe92c2-bf7c-46f8-9566-30e313368124 label: Invoice Tax subtotal: '-' total: 43.99 bookingInfoConfig: - uuid: 5b9256e0-0442-470f-8e80-4587703c4470 category: contact label: First Name type: input config: values: [] ask: 1 display: website: 2 internal: 1 sort: 1 - uuid: adefb4ec-b408-4f5e-b71d-d1c79599cdbc category: contact label: Last Name type: input config: values: [] ask: 1 display: website: 2 internal: 1 sort: 2 - uuid: bb3b43f7-996d-4e86-97b3-ffff35032e9a category: contact label: Email type: email config: values: [] ask: 1 display: website: 2 internal: 1 sort: 3 - uuid: 2a3536a5-a94a-4619-9af7-a93e0110874b category: contact label: Mobile type: phone config: values: [] ask: 1 display: website: 2 internal: 1 sort: 4 - uuid: 57035281-8a2a-4c76-8a44-f9cfa3117654 category: contact label: Phone type: phone config: values: [] ask: 1 display: website: 0 internal: 1 sort: 5 - uuid: b13428d9-b9ff-473c-a612-66b6637221ed category: contact label: Fax type: phone config: values: [] ask: 1 display: website: 0 internal: 1 sort: 6 - uuid: 10662538-eef3-4171-9972-41300fa473d9 category: contact label: Gender type: select config: values: - label: Male value: ORDER.GENDER_MALE - label: Female value: ORDER.GENDER_FEMALE - label: Other value: ORDER.GENDER_OTHER - label: Refuse to answer value: ORDER.GENDER_REFUSE ask: 1 display: website: 0 internal: 1 sort: 7 - uuid: 251a6a27-7fbc-4411-83ec-dfd1e9b93b1b category: contact label: Date of Birth type: date config: values: [] ask: 1 display: website: 0 internal: 1 sort: 8 - uuid: 4e34479f-fe84-4bd3-a443-bbd7df182537 category: contact label: Preferred Language type: language config: values: [] ask: 1 display: website: 0 internal: 1 sort: 9 - uuid: 96e58831-e2df-453b-8a6e-4fd74da1dd64 category: contact label: Company Name type: input config: values: [] ask: 1 display: website: 0 internal: 1 sort: 10 - uuid: 496a769e-ad54-48b3-a5eb-0a5c8b83395f category: contact label: Country/Territory type: country config: values: [] ask: 1 display: website: 0 internal: 1 sort: 11 - uuid: 790ebdf2-7b60-4d02-851d-7c7a680f172b category: contact label: State/County/Region type: state config: values: [] ask: 1 display: website: 0 internal: 1 sort: 12 - uuid: c570a05e-31dc-4f1c-9669-9facb038ea2e category: contact label: City/Town/Suburb type: city config: values: [] ask: 1 display: website: 0 internal: 1 sort: 13 - uuid: 3f61ae81-2738-46dd-a83d-b09bc596d763 category: contact label: Postcode/ZIP type: input config: values: [] ask: 1 display: website: 0 internal: 1 sort: 14 - uuid: 9665763e-7476-470a-9a65-a0bd3e062813 category: contact label: Address type: input config: values: [] ask: 1 display: website: 0 internal: 1 sort: 15 - uuid: 3adfb028-3db6-46d9-920f-9234a1c2b8b5 category: participant label: First Name type: input config: values: [] ask: 2 display: website: 2 internal: 1 sort: 23 - uuid: 1d154db9-f77a-4233-9526-4aeba23efe69 category: participant label: Last Name type: input config: values: [] ask: 2 display: website: 2 internal: 1 sort: 24 - uuid: 0774fe06-9d14-4d88-bd36-4eebe638f5b6 category: participant label: Gender type: select config: values: - label: Male value: ORDER.GENDER_MALE - label: Female value: ORDER.GENDER_FEMALE - label: Other value: ORDER.GENDER_OTHER - label: Refuse to answer value: ORDER.GENDER_REFUSE ask: 2 display: website: 2 internal: 1 sort: 29 - uuid: 8bac68fc-1711-4377-bd4f-8e1790d528c4 category: participant label: Date of Birth type: date config: values: [] ask: 2 display: website: 2 internal: 1 sort: 30 - uuid: 0dabee8f-50fb-4114-b368-7c15a0604f37 category: participant label: Nationality type: input config: values: [] ask: 2 display: website: 2 internal: 1 sort: 33 - uuid: 235b964b-7b1f-4cf3-b322-541079f0b333 category: participant label: Passport number type: input config: values: [] ask: 2 display: website: 2 internal: 1 sort: 34 paid: 43.99 refund: 0 balance: 0 pickupRequest: pickupLocationUuid: 67de4120-2cce-409b-b6ea-ae257363e258 returnPickupLocationUuid: 0095e05f-e83a-477a-97da-6393bfb89ef4 customerRequest: '' returnCustomerRequest: '' detail: departure: type: 3 fixedPickupTime: 08:30 waitingTime: 5 label: 台中高鐵站2號出口 addressLine: 台中市烏日區站區一路 latitude: '24.1477358' longitude: '120.6736482' instructions: '' return: type: 4 label: 台中高鐵站2號出口 addressLine: 台中市烏日區站區一路 latitude: '24.1477358' longitude: '120.6736482' instructions: '' preferLanguage: guideLanguageUuid: 7e8eaa1f-330d-436a-b17d-bdbefe83ab20 deviceLanguageUuid: '' onsiteLanguageUuid: '' materialLanguageUuid: '' payType: 0 depositAmount: -1 depositDetail: {} cancelFeeDetail: {} paymentDetail: - uuid: 6665bf5d-6e89-47b3-82d2-4d5bb2f94d1a currencyUuid: b5317f07-b5a0-4525-8ff7-3fe55b4d96ec paymentType: 1 note: Paid on shop counter paidDate: '2019-06-05' amount: 43.99 noteDetail: - uuid: b0c5b799-9e4c-4933-9dbe-10388f52af07 note: Mary, please confirm with Mr. Doe, because we don't have the babe seat for infant, only available for kid. createdAt: '2019-06-05 12:14:46+00' firstName: Money lastName: Yi sourceOrderNo: '' orderSource: Admin orderSubSource: '' voucherInfo: voucherType: 1 voucherUrl: '' summary: Get Order Detail operationId: get-v1-order-orderNo-detail description: "Load an existing order detail by orderNo\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/order/{orderNo}/detail
HTTP MethodGET
ParametersIn Uri
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters- In Uri\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
orderNostringYOrder number
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
dataobjectResponse data, check data for details
\n\n##### *data*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\ \ \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
uuidUUIDOrder UUID
orderNostringOrder number
productUuidUUIDProduct UUID
salesOptionUuidUUIDPackage UUID
sessionUuidUUIDSession UUID
currencyUuidUUIDCurrency UUID
\n Rezio Currency UUID, check/getDataOption?option=currency UUID for details\n
amountnumberTotal amount
orderStatusintOrder status
\n -2 Expired
\n 0 Cancelled
\n 1 New & Unpaid
\n 2 New & Paid
\n 3 Pending
\n 4 Confirmed
\n 5 Check-in & Redeem
\n 6 No-show
\n 7 Canceling
\n 8 Cancel Requested
\n 9 Departed
\n 10 Channel Redeemed
\n 11 Cancelled by Channel
\n 12 Completed in Channel
\n
saleFromstringChannel which sold the order
orderCreateDatetimestringOrder created time. Format is YYYY-MM-DD'T'HH:mm:ss'Z' Timezone is UTC+0
sessionSettingUuidUUIDSession Setting UUID
purchaseContentarrayPurchase content indicates the booked seats and the related identity information.
\n Check purchaseContent for details\n
extrasarrayExtra data
\n Check extras for details
specialRequirementstringCustomer requested context, note field to customer
priceConfigarrayConfig indicates the pricing policy rules of booked session.
\n Check priceConfig for details
sessionStartDatestringDeparture date, which is session start date. Format is YYYY-MM-DD (product timezone)
sessionStartTimestringDeparture time, which is start time of session. Format is HH:mm, i.e., 09:00 (product timezone)
sessionWeekdaystringWeekday of order departure date, options:
\n Mon Monday
\n Tue Tuesday
\n Wed Wednesday
\n Thu Thursday
\n Fri Friday
\n Sat Saturday
\n Sun Sunday\n
sessionEndDatestringFinish date, which is session end date. Format is YYYY-MM-DD (product timezone)
sessionEndTimestringFinish time, which is the end time of session. Format is HH:mm, i.e., 18:00 (product timezone)
resourceAllocationarrayResource allocation
\n Check resourceAllocation for details
resourceUuidsarrayResource UUID
\n Check /v1/setting/resource for details\n
contactInfoobjectContact information
\n Check contactInfo for details
bookingInfoDetailobjectBooking information detail
\n Check bookingInfoDetail for details
productNamestringProduct name
productCodestringProduct code
salesOptionNamestringPackage name
purchaseQuantityintTotal booked quantity
seatQuantityintTotal occupied seats
resourceSessionUuidsarrayResource Session UUID
bookingInfoUuidUUIDBooking information UUID
\n Check/v1/setting/bookingInfo\n
amountDetailobjectAmount detail
\n Check amountDetail for details
bookingInfoConfigarrayConfig of booking information, all traveler data
\n Check bookingInfoConfig for details
paidnumberPaid amount
refundnumberRefunded amount
balancenumberBalance, unpaid amount
\n balance = amount - (paid - refund)\n
pickupRequestobjectSelected pickup location
\n Pickup location which customer selected, check pickupRequest for details
preferLanguageobjectPreferred language of guide service
\n Customer preferred language of guide service (several options available). Check preferLanguage for details
payTypeintPayment type
\n 1 ATM/Bank Transfer
\n 2 Cash/On-site payment
\n When payType = 0, it indicates this is an internal order and the payment type is not decided yet.\n
depositAmountnumberDeposit amount for this order
\n When depositAmount = -1, it indicates this is an internal order and the amount is not decided yet.\n
depositDetailobjectDeposit policy detail
\n Check depositDetail for details
cancelFeeDetailarrayCancel fee detail
\n Check cancelFeeDetail for details
paymentDetailarrayPayment detail
\n Check paymentDetail for details
noteDetailarrayNote Detail
\n Check noteDetail for details
sourceOrderNostringChannel Order No.
orderSourcestringOrder Source
\n MySite MySite
\n Admin Admin
\n Widget Widget
\n Machine Machine
\n KKday KKday
\n KKdayMkp KKday Marketplace
\n ActivityJapan Activity Japan
\n Viator Viator
\n Jalan Jalan
\n GYG GetYourGuide
\n Names that are not listed above are Distributor names.
\n
orderSubSourcestringOrder sub Source
\n This field could be null.
\n POS POS
\n KIOSK Kiosk
\n TTD Google TTD
\n Names that are not listed above are either Custom Order Sources or special product pages cooperated with KKday, displayed as \"Website\".\n
voucherInfoobjectVoucher information
\n Please refer to the voucherInfo for details
\n\n##### *purchaseContent*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
pricePolicyUuidUUIDPricing Policy UUID
typestringCharge type
\n PERSON Charge by person
\n ITEM Charge by item\n \ \
identityUuidUUIDIdentity UUID
\n i.e., Adult, available for charge type PERSON
\n Check /getDataOption?option=identity for details\n
itemUuidUUIDPricing Item UUID
\n Available when charge type is ITEM\n
labelstringItem label name
\n Available and required when identity.type = ITEM\n
quantityintQuantity
\n\n##### *extras*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
uuidUUIDExtra item UUID
\n Check/v1/setting/extra\n
quantityintQuantity
\n\n##### *priceConfig*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \ \ \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
pricePolicyUuidUUIDPricing Policy UUID
\n Check /v1/setting/pricePolicy for details\n
pricePolicyLabelstringPricing policy label name
typestringCharge type
\n PERSON Charge by person
\n ITEM Charge by item\n
identityUuidstringIdentity UUID
\n i.e., Adult, available for charge type PERSON
\n Check /getDataOption?option=identity for details\n
isGroupintSingle or Group rule?
\n 1 Yes, Group
\n 0 No, Single
\n Available for charge type PERSON\n
seatintSeat occupied (unit)
\n Available for charge type PERSON\n
minintMinimum required for a Group
\n Available when charge type is PERSON AND isGroup = 1\n
maxintMaximum capacity for a Group
\n Available when charge type is PERSON AND isGroup = 1\n
fromintMinimum age for the PERSON identity
\n Available when charge type is PERSON AND isGroup = 0\n
tointMaximum age for the PERSON identity
\n Available when charge type is PERSON AND isGroup = 0\n
isConstraintintBooking constraints between identities
\n Available when charge type is PERSON AND isGroup = 0
\n 1 Yes, with constraints
\n 2 No constraint or not appliable\n
quantityWeightstringTotal weighted quantity
\n Available for charge type PERSON\n
itemUuidUUIDPricing Item UUID
\n Available when charge type is ITEM\n
labelstringItem label name
\n Available and required when identity.type = ITEM\n
pricenumberPrice
\n\n##### *resourceAllocation*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
resourceUuidUUIDResource UUID
\n Check /v1/setting/resource for details\n
groupDetailarrayGroup resource detail
\n Check groupDetail for details
\n\n##### *resourceAllocation - groupDetail*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
uuidUUIDResource UUID. One item belongs to a group type resource
quantityintQuantity, allocation of group resource items can be handled in Admin
\n\n##### *contactInfo*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
uuidUUIDOrder contact information UUID
valuemultipleValue
\n When fields.type = shoe, the response is array, which includes shoe type and sizes, e.g., [\"Man\", 220]
\n When fields.type = phone, the response is array, which includes country code and phone number, e.g., [\"886\", \"0912345678\"]
\n Other fields.type are text or number. Check Get Order Contact Field for details.\n
\n\n##### *bookingInfoDetail*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
orderarrayCheck order for details
participantarrayCheck participant for details
\n\n##### *bookingInfoDetail - order*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
orderUuidOrder field UUIDContact field UUID of order
valuemultipleValue
\n When fields.type = shoe, the response is array, which includes shoe type and sizes, e.g., [\"Man\", 220]
\n When fields.type = phone, the response is array, which includes country code and phone number, e.g., [\"886\", \"0912345678\"]
\n Other fields.type are text or number. Check Get Order Contact Field for details.\n
\n\n##### *bookingInfoDetail - participant*\n\n\n \n \n \n \n \n \n \n \n \n\ \ \n \n \n \n \n \n
NameTypeDescription
participantUuidUUIDParticipants UUID
valuemultipleValue
\n When fields.type = shoe, the response is array, which includes shoe type and sizes, e.g., [\"Man\", 220]
\n When fields.type = phone, the response is array, which includes country code and phone number, e.g., [\"886\", \"0912345678\"]
\n Other fields.type are text or number. Check Get Order Contact Field for details.\n
\n\n##### *amountDetail*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
purchaseContentarrayPurchase content indicates the booked seats and the related identity information.
\n Check purchaseContent for details\n
extrasarrayExtra items
\n Check extras for details\n
feeNdTaxarrayTax or fee items
\n Check feeNdTax for details
totalnumberTotal amount
\n\n##### *purchaseContent*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
identityUuidUUIDIdentity UUID
\n i.e., Adult, available for charge type PERSON
\n Check /getDataOption?option=identity for details\n Available in purchaseContent\n
unitPricenumberUnit price
subtotalnumberSubtotal amount
\n\n##### *amountDetail - extras*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
uuidUUIDExtra item UUID
\n Check/v1/setting/extra\n
labelstringName
unitPricenumberUnit price
subtotalnumberSubtotal amount
\n\n##### *amountDetail - feeNdTax*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
feeNdTaxUuidUUIDTax & Fee UUID
\n Check /v1/setting/feeNdTax to get UUID\n
labelstringName
includedintDoes price include this tax or fee?
\n 1 included
\n 0 excluded (it will be added to the order during the booking process)\n
chargenumberAmount or percentage
\n Available for included = 0\n
chargeModestringCharge mode
\n \ \ FIXED Fix amount
\n PERCENTAGE Percentage of order total amount
\n Available for included = 0\n
unitstringCharge unit
\n HEAD Charge by person
\n ORDER Charge by order
\n Available for included = 0\n
subtotalmultipleSubtotal amount
\n When included = 1, it will be \"-\".
\n When included = 0, it will be a number field.\n
\n\n##### *bookingInfoConfig*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
uuidUUIDBooking field UUID from booking informaiton
categorystringBooking field category
labelstringDisplay name for booking field
typestringField type:
\n input One-line text field
\n multi-line Multi-lines text field
\n text Text area
\n inline inline field
\n select Options. Check option to get list
\n checkbox Checkbox, 1 checked; 0 un-checked
\n email Email field
\n phone Phone field. Format is array, includes country code/ phone number. Check /v1/dataOption?option=countryAll iti for country code value
\n date Date picker. Format is YYYY-MM-DD
\n datetime Datetime picker. Format is YYYY-MM-DD HH:II:SS
\n shoe Shoes options, shoe type: Man/Woman/Kid; option provides shoe sizes
\n country UUID. Check /v1/dataOption?option=countryAll for details
\n state string, text field of address State
\n city string, text field of address City
\n language UUID. Check /v1/dataOption?option=language for details\n
configarrayConfiguation or options for display usage, check config for details
\n\n##### *config*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
valuesarrayValues
\n Available when type = shoe/select
\n Check shoe, check shoe/ select for details\n
askintAsk for everyone's data?
\n 1 Ask once per order
\n 2 Ask for everyone\n
displayobjectDisplay option
\n Check display for details
\n Note: The order created by Rezio API will be considered as website \n
\n\n##### *shoe*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
typestringShoes type
\n \ \ Man
\n Woman
\n Kid\n
sizearrayShoe sizes
\n\n##### *display*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
websiteintIs required on website?
\n 0 Hide field/ Not required
\n 1 Optional
\n 2 Required\n
internalintIs required on internal order (via Rezio Admin)?
\n 0 Hide field/ Not required
\n 1 Optional
\n 2 Required\n
\n\n##### *pickupRequest*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
pickupLocationUuidUUIDOutbound Pickup Route - Pickup location UUID
\n Available field when pickup::type = 1
returnPickupLocationUuidUUIDReturn Pickup Route - Pickup location UUID
\n Available field when pickup::type = 1
customerRequeststringThe pickup request from customer
\n Available when pickup::type = 2
returnCustomerRequeststringReturn customer's custom pickup request
\n Available when pickup::type = 2
detailobjectDetail，Check pickupRequest detail
\n\n##### *pickupRequest detail*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
departureobjectDetails of the departure pickup, please refer to the pickupRequest detail - content
returnobjectDetails of the return pickup, please refer to the pickupRequest detail - content
\n\n##### *pickupRequest detail - content*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
typeintPickup type
\n 1 Relative time pickup route
\n 2 Allow customers to input pickup requests
\n 3 Fixed time pickup route
\n 4 No specified time pickup route\n
pickupLocationUuidUUIDLocation UUID identifier
\n Provided when pickup type is 1, 3, 4
referenceTimestringReference time, format HH:mm, for example: 09:00
\n Provided when pickup type is 1
timeBeforeSessionintPickup before session start time
\n 1 Yes\n 0 No
\n Provided when pickup type is 1\n
labelstringWhen pickup type is 1, 3, 4, it represents the location label.
\n When\ \ pickup type is 2, it represents the available pickup area.
instructionsstringLocation instructions
addressLinestringAddress
Provided when pickup type is 1, 3, 4
pickupTimeintPickup time (minutes)
Provided when pickup type is 1
waitingTimeintWaiting time (minutes)
Provided when pickup type is 1, 3
fixedPickupTimestringFixed pickup time, format HH:mm, for example: 09:00
Provided when pickup type is 3
latitudestringLocation latitude
Provided when pickup type is 1, 3, 4
longitudestringLocation longitude
Provided when pickup type is 1, 3, 4
vehiclestringVehicle used for pickup
Provided when pickup type is 2
availableStartTimestringStart time of availability, format HH:mm
Provided when pickup type is 2
availableEndTimestringEnd time of availability, format HH:mm
Provided when pickup type is 2
customerRequeststringCustomer's customized pickup request
Provided when pickup type is 2
customerPickupTimestringCustomer's customized pickup time, format HH:mm, for example: 09:00
Provided when pickup type is 2
\n\n##### *preferLanguage*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
guideLanguageUuidUUIDSelected language UUID of guide
\n Check /getDataOption?option=languageSpoken for details\n
deviceLanguageUuidUUIDSelected language UUID of audio guide device
\n Check /getDataOption?option=languageSpoken for details\n
onsiteLanguageUuidUUIDSelected language UUID of on-site guide
\n Check /getDataOption?option=languageSpoken for details\n
materialLanguageUuidUUIDSelected language UUID of the printed material
\n Check /getDataOption?option=languageAll for details\n
\n\n##### *depositDetail*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \ \ \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
labelstringName
handlingChargenumberAmount or percentage
\n Example: 50%, handlingCharge = 50 AND policyType = 1\n
policyTypeintDeposit policy type
\n 1 Percentage of order total amount (%)
\n 2 Fixed amount per person
\n 3 Fixed amount per order\n
depositDeadlineDatetimestringDeposit deadline. Format is YYYY-MM-DD'T'HH:mm:ss'Z'
depositOptionarrayAvailable deposit amount
\n\n##### *cancelFeeDetail*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
fromintRule start time
\n Start time is included. Example: 4 day(s) or more with 10% cancellation charge, then \"from\": 4, \"to\":-1 and the 4th day applied.
\n {from} <= Cancellation Date < {to}
\n Note: when from = -1 and to = -1, this rule can apply to anytime\n
tointRule end time
\n End time is excluded. Example: 2 ~ 4 day(s) with 20%/ 4 day(s) or more with 10% cancellation charge, then \"from\": 2, \"to\":4 and the 4th day applied to 10%.
\n {from} <= Cancellation Date < {to}
\n Note: when from = -1 and to = -1, this rule can apply to anytime \n
periodUnitstringRule period unit
\n DAY Day
\n HOUR Hour\n
chargenumberamount or percentage
\n Example: 50%, charge = 50 AND unit = 'PERCENTAGE'\n
unitstringCharge unit
\n PERCENTAGE Percentage of order total amount
\n FIXED Fix amount\n
\n\n##### *paymentDetail*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
uuidUUIDPayment note UUID
currencyUuidUUIDCurrency UUID
\n Rezio Currency UUID, check/getDataOption?option=currency UUID for details\n
paymentTypeintPayment type
\n 1 ATM/Bank Transfer
\n 2 Cash/On-site payment
\n 3 Credit card
\n 4 From channels\n
notestringNotes for this payment record
paidDatestringTransaction date of payment note. Format is YYYY-MM-DD
amountnumberAmount
\n When amount > 0, a paid transaction
\n When amount < 0, an refund transaction\n
\n\n##### *noteDetail*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
uuidUUIDNote UUID
notestringContents for this note record
createdAtstringCreate Date
firstNamestringNote taker's first name
lastNamestringNote taker's last name
\n\n##### *voucherInfo*\n\n\ \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
voucherTypeintVoucher type
\n 1 No Rezio voucher
\n 2 Web version voucher
\n 3 PDF voucher
\n
voucherUrlstringVoucher URL, empty if voucherType is 1
" tags: - Orders parameters: - name: orderNo in: path description: '' required: true example: TT190605ST0003 schema: type: string /v1/order/create: post: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string data: type: object properties: uuid: type: string orderNo: type: string amount: type: number example: code: S0000 codeMessage: SUCCESS data: uuid: aeaeb7d4-ab8b-4e73-9fab-80a7e966ad58 orderNo: TT190605ST0003 amount: 43.99 summary: Create Order operationId: post-v1-order-create description: "Create a new order. Order in Rezio indicates a booking.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/order/create
HTTP MethodPOST
ParametersRaw Body
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
productUuidUUIDYProduct UUID for this order
sessionUuidUUIDYSession UUID for this order
\n Check Publish Settings/ Get Calendar - Availability for more detail
purchaseContentarrayYPurchase content indicates the booked seats and the related identity information.
\n Check purchaseContent for details\n
extrasarray-Extra items
\n Check extras for details
specialRequirementstring-Customer requested context, note field to customer
\n\n##### *purchaseContent*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
pricePolicyUuidUUIDYPricing Policy UUID
\n Check sessionPrice via Publish Settings/ Get Calendar - Availability for more detail\n
typestringYCharge type
\n PERSON Charge by person
\n ITEM Charge by item \n Check sessionPrice via Publish Settings/ Get Calendar - Availability for more detail\n
identityUuidUUID-Identity UUID
\n Check sessionPrice::policy via Publish Settings/ Get Calendar - Availability for more detail\n
labelstring-Item label name
\n Check sessionPrice::policy via Publish Settings/ Get Calendar - Availability for more detail\n
quantityintYBooked quantity
\n\n##### *extras*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n\ \ \n \n \n \n \n \n
NameTypeRequiredDescription
uuidUUIDYExtra item UUID
\n Check/v1/setting/extra\n
quantityintYQuantity of sold extra items
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
dataobjectResponse data, check data for details
\n\n##### *data*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
uuidUUIDOrder UUID
orderNostringOrder number
amountnumberTotal amount
" tags: - Orders requestBody: content: application/json: example: productUuid: 597a8861-82ce-4770-892a-ab718f76a63c sessionUuid: e3f55be9-5f47-4ad1-8ae6-1ed5968ea42c purchaseContent: - pricePolicyUuid: 66457454-6730-470a-9926-a8e2a19d8cbe type: PERSON identityUuid: d6871da2-c391-468e-ad9b-f8d5148fe0cd quantity: 1 - pricePolicyUuid: 66457454-6730-470a-9926-a8e2a19d8cbe type: PERSON identityUuid: 175087ec-03a7-4aa4-a288-29f65bb8966e quantity: 1 extras: - uuid: 82097bf2-d2a8-458a-b5f9-cc807a060c82 quantity: 0 specialRequirement: Will need a babe seat, please schema: type: object properties: productUuid: type: string sessionUuid: type: string purchaseContent: type: array items: type: object properties: pricePolicyUuid: type: string type: type: string identityUuid: type: string quantity: type: number required: - pricePolicyUuid - type - identityUuid - quantity extras: type: array items: type: object properties: uuid: type: string quantity: type: number specialRequirement: type: string /v1/order/{orderNo}/status: put: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string data: type: object properties: newStatus: type: number voucherInfo: type: object properties: voucherType: type: number voucherUrl: type: string example: code: S0000 codeMessage: SUCCESS data: newStatus: 4 voucherInfo: voucherType: 1 voucherUrl: '' summary: Update Order Status operationId: put-v1-order-orderNo-status description: "Update an order status by orderNo\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/order/{orderNo}/status
HTTP MethodPUT
ParametersIn Uri & Raw Body
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters- In Uri\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
orderNostringYOrder number
\n\n##### Parameters- Raw Body\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
orderStatusintYOrder status
\n 0 Cancelled
\n 1 On Hold
\n 2 New Order
\n 3 Pending
\n 4 Confirmed
\n 5 Check In
\n 6 No Show\n
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
dataobjectResponse data, check data for details
\n\n##### *data*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
newStatusintThe updated order status
\n 0 Cancelled
\n 1 On Hold
\n 2 New Order
\n 3 Pending
\n 4 Confirmed
\n 5 Check In
\n 6 No Show\n
voucherInfoobjectVoucher information
\n Please refer to the voucherInfo description
\n\n##### *voucherInfo*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
voucherTypeintVoucher type
\n 1 No Rezio voucher
\n 2 Web version voucher
\n 3 PDF voucher
\n
voucherUrlstringVoucher URL, empty if voucherType is 1
" tags: - Orders parameters: - name: orderNo in: path description: '' required: true example: TT190605ST0003 schema: type: string requestBody: content: application/json: example: orderStatus: 4 schema: type: object properties: orderStatus: type: number /v1/order/{orderNo}/payment: post: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string data: type: object properties: uuid: type: string example: code: S0000 codeMessage: SUCCESS data: uuid: 6665bf5d-6e89-47b3-82d2-4d5bb2f94d1a summary: Create Payment Note operationId: post-v1-order-orderNo-payment description: "Create a new order's payment note by orderNo\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/order/{orderNo}/payment
HTTP MethodPOST
ParametersIn Uri & Raw Body
HeadersContent-Type: application/json\n
X-Lang: en\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters- In Uri\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
orderNostringYOrder number
\n\n##### Parameters- Raw Body\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeLimitRequiredDescription
paidDatestring-YTransaction date of payment note. Format is YYYY-MM-DD
currencystring/ UUID-YCurrency
\n Accept ISO-4217 Code or Rezio Currency UUID
\n Check/getDataOption?option=currency to get code/ UUID\n
amountnumber-YAmount
\n When amount > 0, a paid transaction
\n When amount < 0, an refund transaction\n
paymentTypeint-YPayment type
\n 1 ATM/Bank Transfer
\n 2 Cash/On-site payment
\n 3 Credit card
\n 4 From channels\n
notestringLength limit
varchar(500)		-Notes for this payment record
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
dataobjectResponse data, check data for details
\n\n##### *data*\n\n\n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
uuidUUIDPayment note UUID
" tags: - Orders parameters: - name: orderNo in: path description: '' required: true example: TT190605ST0003 schema: type: string requestBody: content: application/json: example: paidDate: '2019-06-05' currency: USD amount: 43.99 paymentType: 1 note: Paid on shop counter schema: type: object properties: paidDate: type: string currency: type: string amount: type: number paymentType: type: number note: type: string /v1/order/{orderNo}/note: post: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string data: type: object properties: uuid: type: string example: code: S0000 codeMessage: SUCCESS data: uuid: b0c5b799-9e4c-4933-9dbe-10388f52af07 summary: Create Internal Note operationId: post-v1-order-orderNo-note description: "Create internal note for order by orderNo\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/order/{orderNo}/note
HTTP MethodPOST
ParametersIn Uri & Raw Body
HeadersContent-Type: application/json\n
X-Lang: en\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters- In Uri\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
orderNostringYOrder number
\n\n##### Parameters- Raw Body\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
notestringYNotes for this payment record
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
dataobjectResponse data, check data for details
\n\n##### *data*\n\n\n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
uuidUUIDInternal note UUID
" tags: - Orders parameters: - name: orderNo in: path description: '' required: true example: TT190605ST0003 schema: type: string requestBody: content: application/json: example: note: Write down some note about this order, only shown internally, will not send it to customers. schema: type: object properties: note: type: string /v1/product/{productUuid}/contactField: get: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string data: type: object properties: fields: type: array items: type: object properties: uuid: type: string label: type: string type: type: string mandatory: type: number required: - uuid - label - type - mandatory example: code: S0000 codeMessage: SUCCESS data: fields: - uuid: 5b9256e0-0442-470f-8e80-4587703c4470 label: First Name type: input mandatory: 1 - uuid: adefb4ec-b408-4f5e-b71d-d1c79599cdbc label: Last Name type: input mandatory: 1 - uuid: bb3b43f7-996d-4e86-97b3-ffff35032e9a label: Email type: email mandatory: 1 - uuid: 2a3536a5-a94a-4619-9af7-a93e0110874b label: Mobile type: phone mandatory: 1 summary: Get Order Contact Field operationId: get-v1-product-productUuid-contactField description: "Get the contact field by productUuid to fill out the existing order's contact information.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/product/{productUuid}/contactField
HTTP MethodGET
ParametersIn Uri
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
productUuidUUIDYProduct UUID
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
dataobjectResponse data, check data for details
\n\n##### *data*\n\n\n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
fieldsarrayField data for booking informaiton::contact
\n Check fields for details
\n\n##### *fields*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
uuidUUIDContact Field UUID
\n Check Booking Field for more detail
labelstringField label name
typestringField type, available input style:
\n input One-line text field
\n multi-line Multi-lines text field
\n text Text area
\n inline inline field
\n select Options. Check option to get list
\n checkbox Checkbox, 1 checked; 0 un-checked
\n email Email field
\n phone Phone field. Format is array, includes country code/ phone number. Check /v1/dataOption?option=countryAll iti for country code value
\n date Date picker. Format is YYYY-MM-DD
\n datetime Datetime picker. Format is YYYY-MM-DD HH:II:SS
\n shoe Shoes options, shoe type: Man/Woman/Kid; option provides shoe sizes
\n country UUID. Check /v1/dataOption?option=countryAll for details
\n state string, text field of address State
\n city string, text field of address City
\n language UUID. Check /v1/dataOption?option=language for details\n
mandatoryintIs mandatory?
\n 1\ \ Required\n 0 Optional\n
optionarrayOptions value
\n Available for select AND field::type = shoe\n
" tags: - Update Order parameters: - name: productUuid in: path description: '' required: true example: 597a8861-82ce-4770-892a-ab718f76a63c schema: type: string /v1/order/{orderNo}/contact: put: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string example: code: S0000 codeMessage: SUCCESS summary: Update Order Contact Data operationId: put-v1-order-orderNo-contact description: "Update contact information for the order by orderNo. Use Get Order Contact Field for field and format details.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/order/{orderNo}/contact
HTTP MethodPUT
ParametersIn Uri & Raw Body
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters- In Uri\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
orderNostringYOrder number
\n\n##### Parameters- Raw Body\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
contactobjectYContact data of order
\n Check contact for details
\n\n##### *contact*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
uuidUUIDYBooking field UUID from booking informaiton::contact
valuemultipleYValue
\n When fields.type = shoe, the response is array, which includes shoe type and sizes, e.g., [\"Man\", 220]
\n When fields.type = phone, the response is array, which includes country code and phone number, e.g., [\"886\", \"0912345678\"]
\n Other fields.type are text or number. Check Get Order Contact Field for details.\n
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
" tags: - Update Order parameters: - name: orderNo in: path description: '' required: true example: TT190605ST0003 schema: type: string requestBody: content: application/json: example: contact: - uuid: 5b9256e0-0442-470f-8e80-4587703c4470 value: John - uuid: adefb4ec-b408-4f5e-b71d-d1c79599cdbc value: Doe - uuid: bb3b43f7-996d-4e86-97b3-ffff35032e9a value: johndoe_xxxxxxxxxxx@gmail.com - uuid: 2a3536a5-a94a-4619-9af7-a93e0110874b label: Mobile value: - 886 - 0912345678 schema: type: object properties: contact: type: array items: type: object properties: uuid: type: string value: type: array items: oneOf: - type: number - type: number - type: string label: type: string required: - uuid - value /v1/order/{orderNo}/bookingInfo: put: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string example: code: S0000 codeMessage: SUCCESS summary: Update Order Data operationId: put-v1-order-orderNo-bookingInfo description: "Update details of order by orderNo, including traveler's data, selected pickup location, preferred language of guide service.
\nGet field and format details by `productUuid` via Get Product to update the existing order data.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/order/{orderNo}/bookingInfo
HTTP MethodPUT
ParametersIn Uri & Raw Body
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n##### Parameters- In Uri\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
orderNostringYOrder number
\n\n##### Parameters- Raw Body\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
orderobjectYOrder data
\n Check order for details
participantarrayYParticipant data indicates the required booking information
\n Check participant for details
pickupRequestobjectYThe pickup location customer selected
\n Check pickupRequest for details
preferLanguageobjectYPreferred language of guide service
\n Check preferLanguage for details
\n\n##### *order*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
uuidUUIDYBooking field UUID from booking informaiton::contact
valuemultipleYValue
\n When fields.type = shoe, the response is array, which includes shoe type and sizes, e.g., [\"Man\", 220]
\n When fields.type = phone, the response is array, which includes country code and phone number, e.g., [\"886\", \"0912345678\"]
\n Other fields.type are text or number. Check Get Order Contact Field for details.\n
\n\n##### *participant*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
uuidUUIDYBooking field UUID from booking informaiton
valuemultipleYValue
\n When fields.type = shoe, the response is array, which includes shoe type and sizes, e.g., [\"Man\", 220]
\n When fields.type = phone, the response is array, which includes country code and phone number, e.g., [\"886\", \"0912345678\"]
\n Other fields.type are text or number. Check Get Order Contact Field for details.\n
\n\n##### *pickupRequest*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
pickupLocationUuidUUID-Pickup location UUID
\n Required field when pickup::type = 1
customerRequeststring-The pickup request from customer
\n Available when pickup::type = 2
\n\n##### *preferLanguage*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
guideLanguageUuidUUID-Selected language UUID of guide
\n Check /getDataOption?option=languageSpoken for details\n
deviceLanguageUuidUUID-Selected language UUID of audio guide device
\n Check /getDataOption?option=languageSpoken for details\n
onsiteLanguageUuidUUID-Selected language UUID of on-site guide
\n Check /getDataOption?option=languageSpoken for details\n
materialLanguageUuidUUID-Selected language UUID of the printed material
\n Check /getDataOption?option=languageAll for details\n
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
" tags: - Update Order parameters: - name: orderNo in: path description: '' required: true example: TT190605ST0003 schema: type: string requestBody: content: application/json: example: order: [] participant: - - uuid: 3adfb028-3db6-46d9-920f-9234a1c2b8b5 value: John - uuid: 1d154db9-f77a-4233-9526-4aeba23efe69 value: Doe - uuid: 0774fe06-9d14-4d88-bd36-4eebe638f5b6 value: ORDER.GENDER_MALE - uuid: 8bac68fc-1711-4377-bd4f-8e1790d528c4 value: '1981-01-01' - uuid: 0dabee8f-50fb-4114-b368-7c15a0604f37 value: Taiwan - uuid: 235b964b-7b1f-4cf3-b322-541079f0b333 value: '300012345' - - uuid: 3adfb028-3db6-46d9-920f-9234a1c2b8b5 value: John Jr. - uuid: 1d154db9-f77a-4233-9526-4aeba23efe69 value: Doe - uuid: 0774fe06-9d14-4d88-bd36-4eebe638f5b6 value: ORDER.GENDER_MALE - uuid: 8bac68fc-1711-4377-bd4f-8e1790d528c4 value: '2017-12-30' - uuid: 0dabee8f-50fb-4114-b368-7c15a0604f37 value: Taiwan - uuid: 235b964b-7b1f-4cf3-b322-541079f0b333 value: '300012346' pickupRequest: pickupLocationUuid: 67de4120-2cce-409b-b6ea-ae257363e258 customerRequest: '' preferLanguage: guideLanguageUuid: 7e8eaa1f-330d-436a-b17d-bdbefe83ab20 deviceLanguageUuid: '' onsiteLanguageUuid: '' materialLanguageUuid: '' schema: type: object properties: order: type: array items: {} participant: type: array items: type: array items: {} pickupRequest: type: object properties: pickupLocationUuid: type: string customerRequest: type: string preferLanguage: type: object properties: guideLanguageUuid: type: string deviceLanguageUuid: type: string onsiteLanguageUuid: type: string materialLanguageUuid: type: string /v1/redeem/list: get: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: code: type: string codeMessage: type: string data: type: object properties: totalCount: type: number page: type: number itemPerPage: type: number list: type: array items: type: object properties: voucherNo: type: string itemLabel: type: string orderNo: type: string productUuid: type: string productName: type: string productCode: type: string salesOptionUuid: type: string salesOptionName: type: string purchaseContent: type: array items: type: object properties: label: type: string quantity: type: number sessionStartDate: type: string sessionStartTime: type: string redeemDate: type: string redeemTime: type: string redeemAccountFirstName: type: string redeemAccountLastName: type: string example: code: S0000 codeMessage: SUCCESS data: totalCount: 1 page: 1 itemPerPage: 20 list: - voucherNo: RZ221111OV9172-1 itemLabel: Adult orderNo: RZ221111OV9172 productUuid: 8df15fa1-8aed-4243-9a92-3394ba4acf5e productName: 'Day Tour from Taipei: Jiufen Old Street,Golden Waterfall, and Bitou Cape' productCode: 6XUPDQ salesOptionUuid: b5f505a7-29bf-45b3-b002-6a9e5083bdd2 salesOptionName: Day tour purchaseContent: - label: Adult quantity: 3 sessionStartDate: '2022-11-11' sessionStartTime: 09:00 redeemDate: '2022-11-11' redeemTime: 08:30 redeemAccountFirstName: John redeemAccountLastName: Doe summary: List Redemption Record operationId: get-v1-redeem-list description: "List all redemption record.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URI/v1/redeem/list
HTTP MethodGET
ParametersQuery String
HeadersContent-Type: application/json\n
X-Lang: {Lang}\n
X-Auth-StoreUuid: {StoreUuid}\n
X-Auth-Key: {Key}\n
\n\n#### Parameters\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
pageint-Pages. Default/minimum value is 1
itemPerPageint-Record counts per page. Default/maximum value is 20
fromstringYFilter date range, start from. Format is YYYY-MM-DD (Timezone is UTC+0)
The query date range is up to 31 days.
tostringYFilter date range, end to. Format is YYYY-MM-DD (Timezone is UTC+0)
productUuidUUID-Product UUID for this record
sortstring-The sorting options include: redeemDESC (Redemption Time, New to Old), and redeemASC (Redemption Time, Old to New).
The default option is: redeemDESC (Redemption Time, New to Old).
\n\n##### Response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
codestringStatus code
Check Response Codes for details
codeMessagestringStatus message
dataobjectResponse data, check data for details
\n\n##### *data*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
totalCountintRecord counts
pageintCurrent page number
itemPerPageintRecord counts per page. Default/maximum value is 20
listarrayRedemption record, check list for details
\n\n##### *list*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
voucherNostringVoucher Number
itemLabelstringTicket Type
orderNostringOrder Number
productUuidUUIDProduct UUID
\n /v1/product/list
productNamestringProduct name
productCodestringProduct\ \ code
salesOptionUuidUUIDPackage UUID
salesOptionNamestringPackage name
purchaseContentarrayPurchase content indicates the booked seats and the related identity information.
\n Check purchaseContent for details\n
sessionStartDatestringDeparture date, which is session start date. Format is YYYY-MM-DD (product timezone)
sessionStartTimestringDeparture time, which is start time of session. Format is HH:mm, i.e., 09:00 (product timezone)
redeemDatestringRedemption date. Format isYYYY-MM-DD (Timezone is UTC+0)
redeemTimestringRedemption time. Format is HH:mm, i.e., 09:00 (Timezone is UTC+0)
redeemAccountFirstNamestringUser First Name
redeemAccountLastNamestringUser Last Name
\n\n##### *purchaseContent*\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
labelstringItem label name
quantityintQuantity
" tags: - Redemption Record parameters: - name: page in: query description: '' example: '1' schema: type: string default: '1' - name: itemPerPage in: query description: '' example: '20' schema: type: string default: '20' - name: from in: query description: '' required: true schema: type: string - name: to in: query description: '' required: true schema: type: string - name: productUuid in: query description: '' schema: type: string - name: sort in: query description: '' schema: type: string enum: - redeemDESC - redeemASC /webhook: post: responses: '200': description: OK headers: {} content: text/plain: example: 'SUCCESS ' summary: Product Webhook operationId: post-webhook description: "The webhook is triggered when a product or sales option is created, or any content changes occur. Any related inventory changes will also be included.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
URIThe user must provide a Webhook URL to receive notifications.
HTTP MethodPOST
ParametersRaw Body
HeadersContent-Type: application/json
\n\nParameters\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeRequiredDescription
typeStringYNotification type:
\nPRODUCT_NEW: New product
\nPRODUCT_UPDATE: Product updated
\nCALENDAR_NEW: New Packages
\nCALENDAR_UPDATE: Packages updated\n
productUuidStringYProduct UUID
For product details, please refer to Get Product.
saleOptionUuidStringNPackage UUID \n
Only present when type is CALENDAR_NEW or CALENDAR_UPDATE.\n
For package details, please refer to Get Product Packages.\n
\n\nResponse\n\n\n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
SUCCESSStringAfter receiving the Webhook, in addition to the HTTP status code (e.g., 200 for success), you must return the string 'SUCCESS' to indicate successful receipt; otherwise, the system will resend the request after 30 seconds.
" tags: - Webhook（Addon for ENTERPRISE plan） requestBody: content: application/json: example: type: PRODUCT_NEW productUuid: fc1fd163-b940-4550-a3ba-b340a3df7e03 saleOptionUuid: null schema: type: object properties: type: type: string productUuid: type: string saleOptionUuid: {} security: [] components: schemas: {} securitySchemes: StoreUuid: type: apiKey in: header name: X-Auth-StoreUuid description: Store UUID (obtain from rezio admin) ApiKey: type: apiKey in: header name: X-Auth-Key description: 'API Key (apply at rezio admin: My Plan > API Token)' tags: - name: System Parameters - name: Setting - Pricing Policy - name: Setting - Tax & Fees - name: Setting - Cancellation Policy - name: Setting - Deposit Policy - name: Setting - Booking Information - name: Setting - Pick Up - name: Setting - Extras - name: Setting - Resource - name: Product List - name: Create Product - name: Publish Settings - name: Orders - name: Update Order - name: Redemption Record - name: Webhook（Addon for ENTERPRISE plan） security: - StoreUuid: [] ApiKey: []