Skip to main content
GET
/
v1
/
orders
/
{id}
Get an order
curl --request GET \
  --url https://api.zeroclick.am/v1/orders/{id} \
  --header 'x-zam-api-key: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "listingId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "orderState": "pending",
  "requestBody": {},
  "result": {},
  "errorMessage": "<string>",
  "startedAt": "2023-11-07T05:31:56Z",
  "completedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.zeroclick.am/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-zam-api-key
string
header
required

ZAM API key. Starts with zam_.

Path Parameters

​
id
string<uuid>
required

Order UUID

Response

The order with current state and result (if completed)

​
id
string<uuid>
​
userId
string<uuid>
​
listingId
string<uuid>
​
orderState
enum<string>
Available options:
pending,
running,
completed,
failed
​
requestBody
object

The input sent to the listing's endpoint

​
result
object

The response from the listing's endpoint (when completed)

​
errorMessage
string | null

Error details (when failed)

​
startedAt
string<date-time> | null
​
completedAt
string<date-time> | null
​
createdAt
string<date-time>
​
updatedAt
string<date-time>