Get All Orders
Retrieves a list of orders for a specific company.
Authentication
This endpoint requires authentication. See Authentication for details.
Filters
| Property | Type | Required | Description |
|---|---|---|---|
| companyCode | string | Yes | Company code for one of your managed companies |
| countryCode | string | No | Filter orders by country in ISO 3166-1 alpha-2 format |
Request
Production URL: https://orchestrator.tecspal.com/
Sandbox URL: https://tecspal-orchestrator.sandbox.lexartlabs.uy/
Endpoint: GET /orders
Example Request
{
"filters": {
"companyCode": "DM1",
"countryCode": "UY"
},
"request": "orders",
"vendor": "tecspal",
"verb": "GET"
}
Response Schema
| Property | Type | Description |
|---|---|---|
| statusCode | number | HTTP status code of the response |
| message | string | Description of the response status |
| envelop | array | Array containing the list of orders |
Order Properties
| Property | Type | Description |
|---|---|---|
| id | string | Unique identifier of the order |
| orderNumber | number | Order number |
| createdAt | string | ISO timestamp when order was created |
| updatedAt | string | ISO timestamp when order was last updated |
| status | string | Status of the order (e.g. DELIVERED) |
| date | string | null | Delivery date (YYYY-MM-DD) |
| eta | string | null | Estimated delivery date (YYYY-MM-DD) |
| trackingLink | string | null | Link for tracking the order |
| countryCode | string | Country code (e.g. UY) |
| sendTo | string | Recipient type (e.g. EMPLOYEE, STORAGE) |
| currency | string | Currency used (e.g. USD) |
| dateCompleted | string | null | Date the order was completed |
| requesterEmail | string | null | Email of the person who requested the order (null if created via API) |
| companyName | string | Name of the company |
| description | string | null | Notes or description entered for the order |
| employeeProfile | object | null | Employee profile info, if applicable |
| hardwares | array | List of hardware items requested |
| createdHardwares | array | List of hardware items actually created |
| apiClientRequesterName | string | null | Name of the API client that submitted the request (null if created by user) |
| poNumber | string | null | Purchase Order number, if provided |
| resellerIds | array | Array of reseller IDs matching the order's country (only for API-created orders) |
employeeProfile Properties
| Property | Type | Description |
|---|---|---|
| id | string | Employee ID |
| firstName | string | First name of the employee |
| lastName | string | Last name of the employee |
| countryCode | string | Country code of the employee |
| string | Email address | |
| address | string | Street address |
| addressExtraInfo | string | null | Additional address information |
| postCode | string | Postal code |
hardwares Properties
| Property | Type | Description |
|---|---|---|
| id | string | Hardware ID |
| createdAt | string | ISO timestamp when item was added |
| catalogModelId | string | null | Optional catalog model reference |
| brand | string | null | Brand name (if provided) |
| amount | number | Quantity of the item |
| quotedUnitPrice | string | null | Quoted price per unit (as string) |
| notes | string | null | Notes associated with the item |
| name | string | Name of the hardware |
| ram | string | RAM configuration (if applicable) |
| diskSpace | string | Disk size (if applicable) |
| displaySize | string | Display size (if applicable) |
| processor | string | Processor (if applicable) |
| image | string | URL to the image |
| externalItemId | string | null | External item identifier (if provided) |
createdHardwares Properties
| Property | Type | Description |
|---|---|---|
| id | string | Unique ID of the created hardware |
| brand | string | Brand name (if applicable) |
| description | string | Description or notes |
| serialNumber | string | Serial number of the hardware |
| name | string | Name of the hardware |
| ram | string | RAM configuration (if applicable) |
| diskSpace | string | Disk size (if applicable) |
| displaySize | string | Display size (if applicable) |
| processor | string | Processor (if applicable) |
| image | string | URL to the image |
| cost | string | Purchase cost of the hardware |
| dateBought | string | Date the hardware was bought (ISO format) |
Example Response
{
"envelop": [
{
"id": "632a303b-e65c-4a48-9ed0-39bb832df5bc",
"orderNumber": 10001006,
"createdAt": "2025-04-10T15:01:33.644Z",
"updatedAt": "2025-04-10T15:02:36.845Z",
"status": "DELIVERED",
"date": "2025-05-03",
"eta": "2025-04-19",
"trackingLink": null,
"countryCode": "UY",
"sendTo": "EMPLOYEE",
"currency": "USD",
"dateCompleted": "2025-04-25",
"description": "",
"requesterEmail": "superadmin@tecspal.com",
"companyName": "Larian Studios",
"apiClientRequesterName": "EXAMPLE API CLIENT",
"poNumber": null,
"employeeProfile": {
"id": "04fb50a9-60fb-414a-ab2b-fa3f8ea8689e",
"firstName": "Juan",
"lastName": "Iruleguy",
"countryCode": "UY",
"email": "jiruleguy@tecspal.com",
"address": "Pedro Domingo Murillo 999, Montevideo, Departamento de Montevideo",
"addressExtraInfo": null,
"postCode": "11500"
},
"hardwares": [
{
"id": "3b194ea5-5d09-49f2-8d30-4b0e77dbc229",
"amount": 1,
"notes": "",
"quotedUnitPrice": "5000",
"createdAt": "2025-04-10T15:01:33.649Z",
"catalogModelId": null,
"brand": null,
"name": "MacBook Pro",
"ram": "16GB",
"diskSpace": "512GB",
"displaySize": "16 inch",
"processor": "M1 Pro",
"image": "https://a-us.storyblok.com/f/1001855/789x500/82ee51ba4d/macbook-pro-16.png",
"externalItemId": "ITEM-2024-001"
},
{
"id": "4ee86352-fe28-42e2-b6e9-d95e63c87a83",
"amount": 1,
"notes": "",
"quotedUnitPrice": "200",
"createdAt": "2025-04-10T15:01:33.649Z",
"catalogModelId": null,
"brand": null,
"name": "HEADPHONES",
"image": "https://a-us.storyblok.com/f/1001855/800x800/eacb7e6f4f/headphones.png",
"externalItemId": "ITEM-2024-002"
}
],
"createdHardwares": [
{
"id": "86890299-6aa2-457f-8918-a27a6d017559",
"description": "",
"serialNumber": "123456",
"cost": "5000",
"dateBought": "2025-04-25T00:00:00.000Z",
"brand": null,
"name": "MacBook Pro",
"ram": "16GB",
"diskSpace": "512GB",
"displaySize": "16 inch",
"processor": "M1 Pro",
"image": "https://a-us.storyblok.com/f/1001855/789x500/82ee51ba4d/macbook-pro-16.png"
},
{
"id": "1bf3bf55-d3d5-49cc-b413-68969d4558f2",
"description": "",
"serialNumber": "123",
"cost": "200",
"dateBought": "2025-04-25T00:00:00.000Z",
"brand": null,
"name": "HEADPHONES",
"image": "https://a-us.storyblok.com/f/1001855/800x800/eacb7e6f4f/headphones.png"
}
]
},
{
"id": "0a679f23-32a1-4ece-a308-9b16a325f54f",
"orderNumber": 10001000,
"createdAt": "2025-04-09T14:35:57.303Z",
"updatedAt": "2025-04-09T14:35:57.303Z",
"status": "PENDING",
"date": null,
"eta": null,
"trackingLink": null,
"countryCode": "UY",
"sendTo": "STORAGE",
"currency": "USD",
"dateCompleted": null,
"description": null,
"requesterEmail": "larian@tecspal.com",
"companyName": "Larian Studios",
"apiClientRequesterName": "EXAMPLE API CLIENT",
"poNumber": "PO-2025-001",
"employeeProfile": null,
"hardwares": [
{
"id": "4cec8a2f-5237-4131-be21-c8e471d3be73",
"amount": 3,
"notes": null,
"quotedUnitPrice": null,
"createdAt": "2025-04-09T14:35:57.337Z",
"catalogModelId": null,
"brand": null,
"name": "MacBook Pro",
"ram": "16GB",
"diskSpace": "512GB",
"displaySize": "16 inch",
"processor": "M1 Pro",
"image": "https://a-us.storyblok.com/f/1001855/789x500/82ee51ba4d/macbook-pro-16.png",
"externalItemId": "ITEM-2024-003"
},
{
"id": "e537d94e-2884-4b06-a46f-6e0745e89db3",
"amount": 3,
"notes": null,
"quotedUnitPrice": null,
"createdAt": "2025-04-09T14:35:57.337Z",
"catalogModelId": null,
"brand": null,
"name": "Lenovo T14",
"ram": "16GB",
"diskSpace": "512GB",
"displaySize": "14 inch",
"processor": "i7",
"image": "https://a-us.storyblok.com/f/1001855/315x238/793696f4d0/lenovo-t14.png",
"externalItemId": "ITEM-2024-004"
},
{
"id": "be636acc-1a97-4700-b0be-74d1c6aaf11c",
"amount": 10,
"notes": null,
"quotedUnitPrice": null,
"createdAt": "2025-04-09T14:35:57.337Z",
"catalogModelId": null,
"brand": null,
"name": "MOUSE",
"image": "https://a-us.storyblok.com/f/1001855/194x310/58f252e365/generic-mouse.png",
"externalItemId": "ITEM-2024-005"
}
],
"createdHardwares": []
}
],
"message": "Request successful",
"statusCode": 200
}
Error Responses
Bad Request (400)
{
"error": "Bad Request",
"message": "Invalid company code",
"statusCode": 400
}
Unauthorized (401)
{
"error": "Unauthorized",
"message": "Unauthorized access",
"statusCode": 401
}
Notes
- Results are returned in descending order by creation date
- The response includes both pending and completed orders
- Hardware items can be either specific models (
commonModel) or generic types (hardwareType) - Orders can be filtered by country using ISO 3166-1 alpha-2 country codes
- The
isExternalOrderflag indicates if the order was created through external integrations