Get Order By Id

Retrieves detailed information about a specific order using its unique identifier.

Authentication

This endpoint requires authentication. See Authentication for details.

Parameters

Property	Type	Required	Description
orderId	string	Yes	The unique identifier of the order

Filters

Property	Type	Required	Description
companyCode	string	Yes	Company code for one of your managed companies

Request

Production URL: https://orchestrator.tecspal.com/
Sandbox URL: https://tecspal-orchestrator.sandbox.lexartlabs.uy/
Endpoint: GET /orders/{orderId}

Example Request

{
  "filters": {
    "companyCode": "DM1"
  },
  "request": "orders/acf8c4ee-f403-4f20-8503-7be0dbdd8592",
  "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 order data

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)
maxEta	number | null	Maximum estimated delivery date (YYYY-MM-DD)
minEta	number | null	Minimum 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
email	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
brand	string | null	Brand name (if provided)
amount	number	Quantity of the item
notes	string | null	Notes associated with the item
quotedUnitPrice	string | null	Quoted price per unit (as string)
createdAt	string	ISO timestamp when item was added
catalogModelId	string | null	Optional catalog model reference
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 | null	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)

resellerIds Properties

Property	Type	Description
id	string	Unique identifier of the reseller ID
code	string	Reseller code
countryCode	string	Country code matching the reseller's location

Note: resellerIds is only populated for orders created via the API (when apiClientRequesterName is not null). For orders created through the web interface, this field will be an empty array.

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": null,
      "poNumber": null,
      "resellerIds": [],
      "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"
        }
      ]
    }
  ],
  "message": "Request successful",
  "statusCode": 200
}

Notes

• Orders can be in various states: PENDING, CONFIRMED, DELIVERED, etc.
• The hardwares array contains the items requested in the order
• Each hardware can reference either a commonModel (specific model) or hardwareType (generic type)
• When sendTo is "STORAGE", the order will be delivered to Tecspal's storage facility
• When sendTo is "EMPLOYEE", the order will be delivered to the employee's address

Error Responses

Order Not Found (404)

{
  "error": "Not Found",
  "message": "Order not found",
  "statusCode": 404
}

Unauthorized (401)

{
  "error": "Unauthorized",
  "message": "Unauthorized access",
  "statusCode": 401
}

Bad Request (400)

{
  "error": "Bad Request",
  "message": "Invalid order ID format",
  "statusCode": 400
}