Get Order by ID
Retrieve the current status and metadata of a document order previously submitted via POST /document/order.
Method & URL
GET https://api.gbris.com/api/document/order/{order_id}
Example Request
curl -X GET "https://api.gbris.com/api/document/order/d8595ad1e63dc" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
Example Response
{
"id": "d8595ad1e63dc",
"status": "COMPLETED",
"created_at": 1713200000,
"finished_at": 1713201800,
"documents": [
{
"entity_persistent_id": "c338d773ad8595ad1e63dc4651854e50",
"product_code": "DE_GMBH_ANNUAL_REPORT_EN",
"year": 2023,
"status": "DELIVERED",
"download_url": "https://api.gbris.com/files/d8595ad1e63dc/YAzH4SwNkpgA0h.pdf"
},
{
"entity_persistent_id": "c338d773ad8595ad1e63dc4651854e50",
"product_code": "DE_ALL_FULL_OFFICIAL_EXTRACT_HISTORICAL_EN",
"status": "NOT_AVAILABLE"
}
]
}
Response Fields
| Field | Type | Description |
|---|---|---|
id | string | The order ID. |
status | string | IN_PROGRESS, COMPLETED, or CANCELLED. |
created_at | number | Unix timestamp when the order was created. |
finished_at | number | null | Unix timestamp when the order finished processing. |
documents | array | List of documents included in the order. |
documents[] fields
| Field | Type | Description |
|---|---|---|
product_code | string | The document product code (matches original order) |
year | number | null | The year requested (if applicable) |
status | string | DELIVERED or NOT_AVAILABLE |
download_url | string | null | File URL, included only if status is DELIVERED |