Order Confirmation
Order Confirmation Variables
Manage dynamic variables for order confirmations
Variables
Details
| Description | The "Variables" endpoint retrieves the order confirmation variables. |
|---|---|
| HTTP Method | GET |
| Endpoint URL | https://platform.innocalls.com/v1/api-gateway/order-confirmation/:id/variables |
| Authorization | To access the API endpoints, you need to authenticate using API keys and API secrets. The API supports Basic Authentication for authorization. You need to include your API ID as the username and your API secret as the password in the HTTP header when making requests. Replace API_ID with your API ID and API_SECRET with your API secret, separated by a colon (:). The value after Basic is the Base64 encoding of your API key and API secret concatenated with a colon. |
| Rate Limit | 3 requests per second |
Request Parameters
| Parameter | Description | Location | Constrains |
|---|---|---|---|
| id | The ID of the order confirmation | Path | Required |
Request Example
curl 'https://platform.innocalls.com/api/v1/api-gateway/order-confirmation/:id/variables' \
--header 'Authorization: Basic <base64-encoded string apiId:apiSecret>'Success Response Example
{
"data": {
"requiredVariables": [
{
"variableName": "test",
"type": "money"
}
]
}
}Description
This JSON response confirms a successful order confirmation's required variables
requiredVariables: The required variables of the order confirmation. It can be empty or an array of objects depending on order confirmation required variables.variableName: Variable name.type: Variable type.
Possible Errors
| Error Code | Description |
|---|---|
| 401 Unauthorized | Invalid Credential |
| 403 Forbidden | Not Enough Permissions to access the resource |
| 429 Too Many Requests | This occurs when requests exceed the rate limit |
| 404 Not Found | This occurs when the requested order confirmation is not found |
