Calls to the API must be for genuine use and responses from the API must not be stored for the purpose of creating an offline copy of the information stored. Failure to comply with this requirement will infringe the API License.
Disable API Calls
Disable Organisation
POST /disable/organisation/{orgid}
Purpose
To disable an organisation.
Inputs
- orgid - The ID of the organisation you want to diable. This must be a valid organisation ID. Please Note: Disabling an organisation will also disable all of the organisations and stores associated with it.
Example Request
curl -H 'Accept: application/json' \
-u 123:XXXXXXXXXXXXXXXXXXXXXX \
https://gapi.checkmend.com/disable/organisation/6
Output
If successful then there will be no output from this method other than a 204 No Content HTTP status code. In the event of an error a JSON object containing an errors array will be returned. For details on the errors array please read the Errors page.
Example Response
HTTP/1.1 400 Bad request
Content-Type: application/json
{
"errors":
[
{
"id":401,
"message":"The supplied organisation ID is invalid."
}
]
}
Disable Store
POST /disable/store/{storeid}
Purpose
To disable a store.
Inputs
- storeid - The ID of the store you want to disable. This must be a valid store ID. A disabled store's transactions will still be accepted but it will appear on a daily exceptions report.
Example Request
curl -H 'Accept: application/json' \
-u 123:XXXXXXXXXXXXXXXXXXXXXX \
https://gapi.checkmend.com/disable/store/48
Output
If successful then there will be no output from this method other than a 204 No Content HTTP status code. In the event of an error a JSON object containing an errors array will be returned. For details on the errors array please read the Errors page.
Example Response
HTTP/1.1 400 Bad request
Content-Type: application/json
{
"errors":
[
{
"id":400,
"message":"No valid storeid was supplied."
}
]
}