Querying the Testing Endpoint

Make sure the connection is successful and return the system time. Query this endpoint when setting up an integration, or to confirm that credentials are still valid.

get

Authorizations

ORDERDESK-API-KEYstringRequired

Your API key, found under Store Settings on the API tab. This should be kept server-side.

ORDERDESK-STORE-IDstringRequired

Your store ID, found under Store Settings on the API tab.

Responses

200

Your credentials are valid.

application/json

statusstring · enumRequired

Either success or error.

Possible values:

messagestringOptional

Describes the result. Always present when an error occurs.

execution_timestringOptional

Time taken to process the request.

Example: 0.1524 seconds

current_date_timestringOptional

System time in UTC.

Example: 2015-04-14 22:00:10

401

Authentication failed. See the Authentication guide, and note that an invalid store ID blocks your store rather than simply failing the request.

application/json

426

This account's plan does not include API access. Like an invalid store ID, this blocks the store rather than simply failing the request.

application/json

429

You are sending too fast. Wait X-Retry-After seconds. See the Rate Limits guide.

application/json

default

The request could not be completed.

application/json

get/test

curl "https://app.orderdesk.me/api/v2/test" \
  -H "ORDERDESK-STORE-ID: your-store-id" \
  -H "ORDERDESK-API-KEY: your-api-key"

{
  "status": "success",
  "message": "Connection Successful",
  "current_date_time": "2015-04-14 22:00:10",
  "execution_time": "0.0121 seconds"
}