Methods

  • post - Create pickup list
  • post - Create product
  • delete - Delete pickup list
  • get - Retrieve pickup list
  • get - Get product
  • get - Search pickup list
  • put - Update pickup list
  • put - Update product

Resource

{
    "product": {
        "additionalInformation": "string",
        "advertisedPrice": "float",
        "agentPaymentType": "string",
        "apiBookingSupported": "boolean",
        "barcodeOutputType": "string",
        "bookingFields": [
            {
                "fieldType": "string",
                "label": "string",
                "listOptions": "string",
                "requiredPerBooking": "boolean",
                "requiredPerParticipant": "boolean",
                "value": "string",
                "visiblePerBooking": "boolean",
                "visiblePerParticipant": "boolean"
            }
        ],
        "bookingMode": "string",
        "cancellationPolicyDays": "int32",
        "charter": "boolean",
        "commissionIncludesExtras": "boolean",
        "confirmMode": "string",
        "confirmModeMinParticipants": "int32",
        "currency": "string",
        "dateCreated": "date-time",
        "dateUpdated": "date-time",
        "description": "string",
        "durationMinutes": "int64",
        "extras": [
            {
                "id": "int64"
            }
        ],
        "generalTerms": "string",
        "images": [
            {
                "id": "int64",
                "itemUrl": "string",
                "largeSizeUrl": "string",
                "mediumSizeUrl": "string",
                "thumbnailUrl": "string"
            }
        ],
        "internalCode": "string",
        "languages": [
            "string"
        ],
        "locationAddress": {
            "addressLine": "string",
            "addressLine2": "string",
            "city": "string",
            "countryCode": "string",
            "latitude": "double",
            "longitude": "double",
            "postCode": "string",
            "state": "string"
        },
        "maxCommissionNetRate": "float",
        "maxCommissionPercent": "float",
        "minimumNoticeMinutes": "int64",
        "name": "string",
        "pickupId": "int64",
        "priceOptions": [
            {
                "id": "int64",
                "label": "string",
                "maxQuantity": "int32",
                "minQuantity": "int32",
                "price": "float",
                "priceGroupType": "string",
                "productCode": "string",
                "seatsUsed": "int32"
            }
        ],
        "productCode": "string",
        "productSeoTags": [
            {
                "attrKey": "string",
                "attrValue": "string",
                "id": "int64",
                "metaType": "string",
                "productCode": "string"
            }
        ],
        "productType": "string",
        "qrCodeType": "string",
        "quantityRequired": "boolean",
        "quantityRequiredMax": "int32",
        "quantityRequiredMin": "int32",
        "shortDescription": "string",
        "supplierAlias": "string",
        "supplierId": "int64",
        "supplierName": "string",
        "tags": [
            "string"
        ],
        "taxes": [
            {
                "compound": "boolean",
                "label": "string",
                "priceInclusive": "boolean",
                "supplierId": "int64",
                "taxAmount": "float",
                "taxPercent": "float",
                "taxType": "string"
            }
        ],
        "terms": "string",
        "timezone": "string",
        "unitLabel": "string",
        "unitLabelPlural": "string",
        "videos": [
            {
                "id": "string",
                "platform": "string",
                "url": "string"
            }
        ],
        "waitListingEnabled": "boolean",
        "xeroAccount": "string"
    },
    "requestStatus": {
        "error": {
            "errorCode": "string",
            "errorMessage": "string"
        },
        "success": "boolean",
        "version": "string",
        "warning": {
            "warningMessage": "string"
        }
    }
}

Properties

Name Type Description Additional
product object

Product object. Holds general details and settings of a specific tour, activity or event.

Optional
product.additionalInformation string

Additional information for the product, that should be sent after a booking is completed (i.e. by email) to the customer. Useful for integration, when manual control of the entire customer booking experience is wanted, and the automatic confirmation e-mail from Rezdy had been suppressed.

Optional
product.advertisedPrice float

General price indication for this product. It represents a display price only, therefore it does not affect a real booking price, which is calculated based on the price options.

Optional
product.agentPaymentType string

If you are an agent, payment rules setup by the supplier for you to book this product

Possible values are:

  • PAYOUTS
  • FULL_AGENT
  • DOWNPAYMENT
  • FULL_SUPPLIER
  • NONE
Optional
product.apiBookingSupported boolean Optional
product.barcodeOutputType string

Specifies how to output the barcodes when this product is booked. Valid types are:

  • PARTICIPANT: Barcodes will be generated by rezdy for each participant when an booking is created for this product
  • ORDER: Barcodes will be generated by rezdy per booking
  • Possible values are:

    • PARTICIPANT
    • ORDER
    Optional
    product.bookingFields[] array

    List of booking fields required for this product

    Optional
    product.bookingFields[].fieldType string

    Booking field type which determines its format. See Booking Fields Format

    Possible values are:

    • String
    • List
    • Boolean
    • Phone
    • Date
    • Hidden
    Optional
    product.bookingFields[].label string

    Field label that can be shown to customers

    Optional
    product.bookingFields[].listOptions string

    If this field only allows limited values to be selected from a list, they'll be included in this string, separated by \r\n

    Optional
    product.bookingFields[].requiredPerBooking boolean

    true if this field must be populated once per booking, regardless of the number of items or participants. It should be in Booking.fields

    Currently, required fields are not validated when a booking is created though public API, however, it's a good practice to support them in your client code However, soon the required fields will be enforced for public API booking..

    Optional
    product.bookingFields[].requiredPerParticipant boolean

    true if this field must be populated for each participant. It should be in Booking.BookingItem.Participant.fields.

    Currently, required fields are not validated when a booking is created through public API, however, it's a good practice to support them in your client code. However, soon the required fields will be enforced for public API booking.

    Optional
    product.bookingFields[].value string

    Value entered by the customer for this field

    Optional
    product.bookingFields[].visiblePerBooking boolean

    true if this field should be asked once per booking, regardless of the number of items or participants. It should be in Booking.fields

    Optional
    product.bookingFields[].visiblePerParticipant boolean

    true if this field should be asked for each participant when doing a booking. It should be in Booking.BookingItem.Participant.fields.

    Optional
    product.bookingMode string

    Booking mode. Determines if this product needs availability or can be booked for any date.

    Possible values are:

    • NO_DATE
    • DATE_ENQUIRY
    • INVENTORY
    Optional
    product.cancellationPolicyDays int32

    Supplier's Cancellation policy. Number of days before the tour a cancellation is allowed with full refund.
    This is only used for automated payments (PAYOUTS) bookings

    Optional
    product.charter boolean

    A charter product means each session can only have a single booking, whatever the number of seats booked.

    Optional
    product.commissionIncludesExtras boolean

    True if agent receive commission from extras, false otherwise.

    Optional
    product.confirmMode string

    Confirmation mode. Determines if bookings are automatically confirmed or it they are pending

    Possible values are:

    • MANUAL
    • AUTOCONFIRM
    • MANUAL_THEN_AUTO
    • AUTO_THEN_MANUAL
    Optional
    product.confirmModeMinParticipants int32

    If confirmMode is MANUAL_THEN_AUTO or AUTO_THEN_MANUAL, determines the minimum number of participants per booking to trigger the change

    Optional
    product.currency string

    Product prices Currency

    Possible values are:

    • AED
    • ANG
    • ARS
    • AUD
    • AWG
    • AZN
    • BGN
    • BHD
    • BOB
    • BRL
    • BYR
    • CAD
    • CHF
    • CLP
    • CNY
    • COP
    • CZK
    • DKK
    • EGP
    • EUR
    • FJD
    • GBP
    • GEL
    • HKD
    • HRK
    • HUF
    • IDR
    • ILS
    • INR
    • ISK
    • JOD
    • JPY
    • KES
    • KRW
    • KWD
    • KZT
    • LTL
    • LVL
    • MAD
    • MKD
    • MUR
    • MXN
    • MYR
    • NGN
    • NOK
    • NZD
    • PGK
    • PHP
    • OMR
    • PEN
    • PLN
    • PYG
    • QAR
    • RON
    • RSD
    • RUB
    • SAR
    • SBD
    • SEK
    • SGD
    • SRD
    • SYP
    • THB
    • TOP
    • TRY
    • TWD
    • UAH
    • USD
    • UYU
    • VEF
    • VUV
    • WST
    • XAF
    • XOF
    • XPF
    • YER
    • ZAR
    • AFA
    • ALL
    • DZD
    • AMD
    • BSD
    • BDT
    • BBD
    • BZD
    • BMD
    • BWP
    • BND
    • BIF
    • KHR
    • CVE
    • KYD
    • KMF
    • BAM
    • CRC
    • CUP
    • CYP
    • DJF
    • DOP
    • XCD
    • ECS
    • SVC
    • ERN
    • EEK
    • ETB
    • FKP
    • CDF
    • GMD
    • GHS
    • GIP
    • GTQ
    • GNF
    • GWP
    • GYD
    • HTG
    • HNL
    • IRR
    • IQD
    • JMD
    • AOA
    • KGS
    • KIP
    • LAK
    • LBP
    • LRD
    • LYD
    • LSL
    • MOP
    • MGF
    • MGA
    • MWK
    • MVR
    • MTL
    • MRO
    • MDL
    • MNT
    • MZM
    • MMK
    • NAD
    • NPR
    • NIO
    • KPW
    • PKR
    • PAB
    • RWF
    • STD
    • SCR
    • SLL
    • SKK
    • SIT
    • SOS
    • LKR
    • SHP
    • SDD
    • SZL
    • TJS
    • TZS
    • TTD
    • TND
    • TMM
    • UGX
    • UZS
    • VND
    • YUM
    • ZMK
    • ZWD
    • AFN
    • MZN
    • UYI
    • ZMW
    • GHC
    • GGP
    • IMP
    • JEP
    • TRL
    • TVD
    Optional
    product.dateCreated date-time

    The product creation date

    Optional
    product.dateUpdated date-time
    • The date of the last product update
    Optional
    product.description string

    Long product description, is between 100 and 15000 characters

    Optional
    product.durationMinutes int64
    • Duration of the product in minutes.
    Optional
    product.extras[] array

    List of extras that can be booked with this product

    Optional
    product.extras[].id int64

    Extra ID

    Optional
    product.generalTerms string

    General terms and conditions for all products from this supplier

    Optional
    product.images[] array

    List of images showcasing this product

    Optional
    product.images[].id int64

    Id of the image. Can be used for DELETE /{productCode}/image/{mediaId} service

    Optional
    product.images[].itemUrl string

    Full size image link

    Optional
    product.images[].largeSizeUrl string

    Large size image link (1280px)

    Optional
    product.images[].mediumSizeUrl string

    Medium size image link (480px)

    Optional
    product.images[].thumbnailUrl string

    Thumbnail image link (240px)

    Optional
    product.internalCode string

    Supplier-defined product code, used internally by the ther supplier

    Optional
    product.languages[] array of string

    List of product languages. The format of the language is ISO 639 two-letter code with BCP 47 language variants, separated by underscore e.g. en_au.

    Optional
    product.locationAddress object

    Address of a company, customer or product location.

    Optional
    product.locationAddress.addressLine string

    Address line

    Optional
    product.locationAddress.addressLine2 string

    Address line 2

    Optional
    product.locationAddress.city string

    City name

    Optional
    product.locationAddress.countryCode string

    Country code

    Optional
    product.locationAddress.latitude double

    Geolocation - latitude

    Optional
    product.locationAddress.longitude double

    Geolocation - longitude

    Optional
    product.locationAddress.postCode string

    Post Code

    Optional
    product.locationAddress.state string

    State name

    Optional
    product.maxCommissionNetRate float

    Maximum commission amount you can receive as an agent, when the supplier setup a net rate (Automated payments Rezdy fee is not included in the amount)

    Optional
    product.maxCommissionPercent float

    Maximum commission % you can receive as an agent, when the supplier setup a percentage (Automated payments Rezdy fee is not included in the amount)

    Optional
    product.minimumNoticeMinutes int64
    • Minimum book ahead interval for he product in minutes.
    Optional
    product.name string

    Product name

    Optional
    product.pickupId int64
    • If pickups are configured for this product, the field will contain the id of the pickup location list created by the supplier.
    Optional
    product.priceOptions[] array

    List of price options belonging to this product.

    Optional
    product.priceOptions[].id int64 Optional
    product.priceOptions[].label string

    Label for this price (I.e. "Adult", "Child")

    Optional
    product.priceOptions[].maxQuantity int32

    Max booking quantity for the product price option. Can be specified, if the price option is fixed or a grouptype. For a successful booking of the product, the number of participants for this price option have to be lesser or equal than this value.

    Optional
    product.priceOptions[].minQuantity int32

    Min booking quantity for the product price option. Can be specified, if the price option is fixed or a group type. For a successful booking of the product, the number of participants for this price option have to be greater or equal than this value.

    Optional
    product.priceOptions[].price float

    Price amount (I.e. "200.00")

    Optional
    product.priceOptions[].priceGroupType string

    If this price is for a group, is the price for the whole group (TOTAL) or per quantity (EACH)

    Possible values are:

    • EACH
    • TOTAL
    Optional
    product.priceOptions[].productCode string

    Product code to which the price options belongs to. Since Rezdy introduced shared availability option for products, the product sessions can contain price overrides for all of the products, which share the sessions. Therefore it is necessary to filer only the price options matching the chosen product code on the client side, when processing /availability service responses.

    Optional
    product.priceOptions[].seatsUsed int32

    How many seats one quantity of this price willuse. Used for availability calculations. For example 1 quantity of "Family of 4" will use 4 seats.

    Optional
    product.productCode string

    Rezdy-generated unique Product code. Used by agents and for API calls

    Optional
    product.productSeoTags[] array

    This will store product meta data such as title and description

    Optional
    product.productSeoTags[].attrKey string

    Value to put in the "key" attribute (depending on type it could be name, property or rel)

    Optional
    product.productSeoTags[].attrValue string

    Value to put in the "value" attribute (depending on type it could be content or href)

    Optional
    product.productSeoTags[].id int64

    ID of Tag

    Optional
    product.productSeoTags[].metaType string

    Type of Tag

    Possible values are:

    • META_NAME
    • META_PROPERTY
    • LINK_REL
    • TITLE
    • NOINDEX
    • REL_CANONICAL
    Optional
    product.productSeoTags[].productCode string

    Product's code this seo tag belongs to

    Optional
    product.productType string

    Type of this product

    Possible values are:

    • ACTIVITY
    • DAYTOUR
    • MULTIDAYTOUR
    • PRIVATE_TOUR
    • TICKET
    • RENTAL
    • CHARTER
    • EVENT
    • GIFT_CARD
    • TRANSFER
    • LESSON
    • MERCHANDISE
    • CUSTOM
    Optional
    product.qrCodeType string

    Specifies the method how QR Codes will be generated for this product. Valid types are:

  • INTERNAL: QR Codes will be generated by rezdy for each participant when an order is created for this product
  • EXTERNAL: QR Codes will be randomly taken from a list of imported QR Codes
  • If nothing is specified, then no QR Codes will be generated when an order is created for this product

    Possible values are:

    • INTERNAL
    • EXTERNAL
    Optional
    product.quantityRequired boolean

    Does this product require a quantity to be booked? True for most products. Can be false if the supplier can only provide one quantity at any single time. (I.e. private charters)

    Optional
    product.quantityRequiredMax int32

    Represent the max booking quantity for the product. It can be setup for a supplier product. For a successful booking of the product, the total number of participants (regardless of pricing options), per booking item in the booking request, have to be lesser or equal than this value.

    Optional
    product.quantityRequiredMin int32

    Represent the min booking quantity for the product. It can be setup for a supplier product. For a successful booking of the product, the total number of participants (regardless of pricing options), per booking item in the booking request, have to be greater or equal than this value.

    Optional
    product.shortDescription string

    Product description is between 15 and 240 characters

    Optional
    product.supplierAlias string

    Alias of the company supplying this product. Company alias is a unique key and should be used to retrieve company details or in filters

    Optional
    product.supplierId int64

    Rezdy internal ID of the company supplying this product

    Optional
    product.supplierName string

    Name of the company supplying this product

    Optional
    product.tags[] array of string

    List of tags related to the product. The format is [TAG_TYPE]:[TAG_VALUE] e.g. TYPE:ACTIVITY, CATEGORY:ABSEILING, INTENSITY:RELAXED, ACCESSIBILITY:VISION_IMPAIRED

    Optional
    product.taxes[] array

    List of taxes/fees associated with the product

    Optional
    product.taxes[].compound boolean

    Whether a stacked tax with the specified percent is applied.
    e.g. A $100 item with an exclusive tax of %10 will result in the price being $110. If compound is true, then an addition %10 of $110 will be added as tax.

    Optional
    product.taxes[].label string

    Name/description of the tax

    Optional
    product.taxes[].priceInclusive boolean

    Whether the tax is included in the price or not. This field will be displayed if the taxType is PERCENT
    E.g. A $100 item with price INCLUSIVE tax of 10% will result in a $10 tax as part of the $100. A $100 item with price EXCLUSIVE tax of 10% will result in a $10 tax on top of the $100.

    Optional
    product.taxes[].supplierId int64

    Rezdy internal ID of the company applying this tax

    Optional
    product.taxes[].taxAmount float

    The tax amount. This field will only contain a value if the taxType is one of the following: FIXED_PER_QUANTITY, FIXED_PER_ORDER, FIXED_PER_DURATION

    Optional
    product.taxes[].taxPercent float

    Percentage value of the fee/tax. This field will only contain a value if the taxType is PERCENT

    Optional
    product.taxes[].taxType string

    This field will contain one of the following values: PERCENT, FIXED_PER_QUANTITY, FIXED_PER_ORDER, FIXED_PER_DURATION.
    PERCENT: The tax will be a percentage of the order total.
    FIXED_PER_QUANTITY: The tax will be a fixed amount e.g. $10 per quantity.
    FIXED_PER_ORDER: The tax will be a fixed amount e.g. $10 per booking item.
    FIXED_PER_DURATION: The tax will be a fixed amount e.g. $10 per duration unit.

    Possible values are:

    • PERCENT
    • FIXED_PER_QUANTITY
    • FIXED_PER_ORDER
    • FIXED_PER_DURATION
    Optional
    product.terms string

    Specific terms and conditions for this product

    Optional
    product.timezone string

    Timezone used by this product and supplier. All Times must be converted to this timezone before being displayed to customers

    Optional
    product.unitLabel string

    What a quantity for this product is. It can be people (I.e. participant, passenger, diver) or objects (Kayak, Helicopter, etc.)

    Optional
    product.unitLabelPlural string

    Plural version of unitLabel

    Optional
    product.videos[] array

    List of videos showcasing this product
    Videos will only be returned when a single product is loaded.

    Optional
    product.videos[].id string

    video id

    Optional
    product.videos[].platform string

    Video platform (youtube, vimeo, etc …)

    Optional
    product.videos[].url string

    Video url

    Optional
    product.waitListingEnabled boolean

    Signifies that customers will still be able to book this product even when there is not enough availability. Orders will have "On Hold" status, and no payment will be processed

    Optional
    product.xeroAccount string

    Supplier Xero account for this product

    Optional
    requestStatus object RequestStatus Required
    requestStatus.error object Error Optional
    requestStatus.error.errorCode string Required
    requestStatus.error.errorMessage string Optional
    requestStatus.success boolean Required
    requestStatus.version string Optional
    requestStatus.warning object Warning Optional
    requestStatus.warning.warningMessage string Optional