Methods

Resource

{
    "rate": {
        "name": "string",
        "productRates": [
            {
                "commissionType": "string",
                "netRates": [
                    {
                        "netPrice": "float",
                        "priceOptionLabel": "string"
                    }
                ],
                "percentageCommission": "float",
                "percentageIncludeExtras": "boolean",
                "productCode": "string"
            }
        ],
        "rateId": "int64"
    },
    "requestStatus": {
        "error": {
            "errorCode": "string",
            "errorMessage": "string"
        },
        "success": "boolean",
        "version": "string",
        "warning": {
            "warningMessage": "string"
        }
    }
}

Properties

Name Type Description Additional
rate object

A Rate is used to group products with its corresponding shared rate

Optional
rate.name string

Rate name

Optional
rate.productRates[] array

Products associated with this Rate (Catalog)

Optional
rate.productRates[].commissionType string

Commission type: PERCENTAGE, NET_RATE

Possible values are:

  • NET_RATE
  • PERCENT
Optional
rate.productRates[].netRates[] array

List of Net rates with its associated price option label e.g. Adult $20, Child $10 etc. This is mandatory if Commission Type is NET_RATE

Optional
rate.productRates[].netRates[].netPrice float

Value of the rate for the given price option label

Optional
rate.productRates[].netRates[].priceOptionLabel string

Label of the price option e.g. Adult, Child etc

Optional
rate.productRates[].percentageCommission float

Percentage value of the commission. This should be mandatory if Commission Type is PERCENTAGE

Optional
rate.productRates[].percentageIncludeExtras boolean

Includes extras, This is mandatory if Commission Type is PERCENTAGE. If true, the product's extras will be included in the agent commission, otherwise the commission will be calculated based on the product price only.

Optional
rate.productRates[].productCode string

Product's product code

Optional
rate.rateId int64

Rate ID

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