FPLOS Pricing Error Codes
Most LOS Pricing decoding, validation, authentication, and handled processing errors use a common JSON envelope:
{
"status": "ERROR",
"tuid": "49ecd740-34c9-11e9-bef4-137e7754803f",
"errors": [
{
"code": 4012,
"description": "LOS Pricing is not supported for property id 123 because its pricing model is set to 1"
}
]
}Retain the tuid when contacting Agoda support. It identifies the request in Agoda's systems.
Message templates below contain %s where CMAPI inserts request or property data. The returned response contains the resolved value, not %s.
HTTP statuses
| HTTP status | Meaning |
|---|---|
200 OK | The Set request was accepted, or the Search request completed. Search can return an empty rates array. |
400 Bad Request | JSON decoding, request validation, business validation, or handled downstream processing failed. A handled downstream failure can use code 3001. |
401 Unauthorized | Authentication credentials are missing, invalid, or inactive. |
403 Forbidden | The request is not allowed, for example because the source IP is not authorized. |
413 Payload Too Large | The Set request exceeds the 1 MB payload limit. |
429 Too Many Requests | A partner or global request limit was exceeded. |
500 Internal Server Error | CMAPI encountered an unexpected error. Route errors can use JSON code 3001; uncaught actor failures can return XML code 99101. |
504 Gateway Timeout | CMAPI did not receive an actor response before the request timeout and returns XML code 99101. |
Request, authentication, and system errors
| Code | Runtime message template | Description |
|---|---|---|
1201 | API key is not authorised for Property id: %s | The authenticated integration is not authorized for the requested property. |
1301 | Invalid Property id: %s | The property does not exist or cannot be loaded for validation. |
1503 | Authentication failed: %s | Credentials are missing, invalid, expired, or inactive. |
1504 | Rate limit has been exceeed: %s | The applicable request limit was exceeded. Retry with backoff after the limiting window allows requests again. |
1508 | The request payload is too large: %s | The Set request exceeds the configured 1 MB payload limit. Split the update into smaller requests. |
1509 | The request is invalid, Invalid IP address. %s | The source IP is not authorized for the integration. |
1601 | The requested property (%s) has incorrect rate model | The property's rate model is not valid for this operation. |
3000 | %s | Request-model validation failed. The message identifies the invalid field and constraint. LOS must be from 1 through 90, inclusive. |
3001 | There was an internal server error: %s | CMAPI or a downstream dependency failed while processing the request. A handled actor/downstream failure can return this code with HTTP 400; a route exception can return it with HTTP 500. |
3002 | Bad Request: %s | The request could not be handled as valid JSON input. |
3002 | Decoding Failures: %s | JSON decoding failed because a field is missing, has the wrong type, or has an unsupported shape. |
6101 | Property id: %s has failed migration | The property's required rate-model migration failed. |
6102 | Property id: %s has not been migrated yet | The property has not completed the required rate-model migration. |
99101 | There was an internal server error: %s | An uncaught per-request actor failure or actor timeout occurred. This compatibility response is XML rather than the JSON envelope. |
LOS above the API maximum
Set and Search accept LOS values from 1 through 90, inclusive. A supplier or rate plan can impose a lower maximum. For example, Set returns HTTP 400 when los is 91:
{
"status": "ERROR",
"tuid": "49ecd740-34c9-11e9-bef4-137e7754803f",
"errors": [
{
"code": 3000,
"description": "los with value \"91\" got 91, expected between 1 and 90"
}
]
}Set LOS Pricing validation errors
The following business errors apply to POST /api/rate/fplos.
| Code | Runtime message template | Description |
|---|---|---|
4001 | Invalid input for currency: %s | The currency is not a supported ISO currency. |
4002 | Requested currency: %s does not match with Property currency: %s | The request currency differs from the property's configured currency. |
4003 | Room: %s does not exist for Property id: %s | The room does not belong to the property or is unavailable to the integration. |
4004 | Cannot set %s because max occupancy is %s | The submitted occupancy exceeds the applicable room or rate-plan occupancy. |
4005 | Rate plan: %s does not exist for Property id: %s | The rate plan does not belong to the property or is unavailable to the integration. |
4006 | Max los %s in request must not exceeds max los %s of rateplan for Property id: %s | The largest submitted LOS exceeds the rate plan's maximum LOS. |
4007 | Invalid checkIn date %s corresponding to rateplan stay range between %s and %s of property id %s | A submitted check-in date falls outside the rate plan's stay period. |
4008 | Invalid checkIn date %s with max-los %s corresponding to rateplan stay range between %s and %s of property id %s | The stay implied by the check-in date and maximum LOS extends beyond the rate plan's stay period. |
4009 | Min los %s in request must be greater than or equal to min los %s of rateplan for Property id: %s | The smallest submitted LOS is below the rate plan's minimum LOS. |
4010 | Min Rates %s of room id %s are not valid for Property id: %s. Expected min rate should be greater or equal to %s * los | A submitted whole-stay price is below the room's minimum rate multiplied by LOS. |
4011 | Max Rates %s of room id %s are not valid for Property id: %s. Expected max rate should be less than or equal to %s * los | A submitted whole-stay price is above the room's maximum rate multiplied by LOS. |
4012 | LOS Pricing is not supported for property id %s because its pricing model is set to %s | The property is not configured for the FPLOS occupancy/pricing model. |
4013 | Value of losRestriction %s should have same length as max los %s in request for property id %s | The binary LOS restriction length differs from the maximum LOS submitted for the offer. |
4014 | Value of minStayThrough %s should greater or equal to min los %s in rateplan for property id %s | minStayThrough is below the rate plan's minimum LOS. |
4015 | Value of minStayThrough %s should less or equal to max los %s in rateplan for property id %s | minStayThrough exceeds the rate plan's maximum LOS. |
4016 | CheckInDate %s plus minStay %s should be between stay range %s and %s for property id %s | The stay implied by minStay falls outside the rate plan's stay period. |
4017 | CheckInDate %s plus maxStay %s should be between stay range %s and %s for property id %s | The stay implied by maxStay falls outside the rate plan's stay period. |
4018 | Value of minStay %s should greater or equal to min los %s in rateplan for property id %s | minStay is below the rate plan's minimum LOS. |
4019 | Value of minStay %s should less or equal to max los %s in rateplan for property id %s | minStay exceeds the rate plan's maximum LOS. |
4020 | Value of maxStay %s should greater or equal to min los %s in rateplan for property id %s | maxStay is below the rate plan's minimum LOS. |
4021 | Value of maxStay %s should less or equal to max los %s in rateplan for property id %s | maxStay exceeds the rate plan's maximum LOS. |
4022 | CheckInDate %s minus minAdvPurchase %s should be between sell-date range %s and %s for property id %s | The minimum advance-purchase date falls outside the rate plan's sell period. |
4023 | CheckInDate %s minus maxAdvPurchase %s should be between sell-date range %s and %s for property id %s | The maximum advance-purchase date falls outside the rate plan's sell period. |
4024 | minStay %s must be less than or equal to maxStay %s in restriction of the request for Property id: %s | minStay is greater than maxStay. |
4025 | minAdvPurchase %s must be less than or equal to maxAdvPurchase %s in restriction of the request for Property id: %s | minAdvPurchase is greater than maxAdvPurchase. |
4026 | checkInDateRange start/end %s must be in date-range between %s and %s for Property id: %s room id: %s rate plan id: %s | A Set check-in date is earlier than today or is not before the date 730 days from today. |
4027 | start %s must be before or same day as end %s in checkInDateRange for Property id: %s room id: %s rate plan id: %s | A rate check-in range starts after it ends. |
4028 | Max los %s in request must not exceeds max los %s configured for Property id: %s | The largest submitted LOS exceeds the maximum configured for the authenticated integration or property. |
Search LOS Pricing errors
POST /api/rate/fplos/search validates the JSON field constraints and property authorization. It can return the generic errors above, including 1201, 1503, 1504, 1509, 3000, 3001, and 3002.
No matching rates is not an error. Search returns HTTP 200 with the requested identifiers and an empty rates array.
Updated 12 days ago

