Skip to main content

Get All Orders

Retrieves a list of orders for a specific company.

Authentication

This endpoint requires authentication. See Authentication for details.

Filters

PropertyTypeRequiredDescription
companyCodestringYesCompany code for one of your managed companies
countryCodestringNoFilter 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

PropertyTypeDescription
statusCodenumberHTTP status code of the response
messagestringDescription of the response status
enveloparrayArray containing the list of orders

Order Properties

PropertyTypeDescription
idstringUnique identifier of the order
orderNumbernumberOrder number
createdAtstringISO timestamp when order was created
updatedAtstringISO timestamp when order was last updated
statusstringStatus of the order (e.g. DELIVERED)
datestring | nullDelivery date (YYYY-MM-DD)
etastring | nullEstimated delivery date (YYYY-MM-DD)
maxEtanumber | nullMaximum estimated delivery date (YYYY-MM-DD)
minEtanumber | nullMinimum estimated delivery date (YYYY-MM-DD)
localInvoicebooleanIndicates whether local invoice flow is enabled
trackingLinkstring | nullLink for tracking the order
trackingCodestring | nullCode for tracking the order
countryCodestringCountry code (e.g. UY)
sendTostringRecipient type (e.g. EMPLOYEE, STORAGE)
currencystringCurrency used (e.g. USD)
dateCompletedstring | nullDate the order was completed
requesterEmailstring | nullEmail of the person who requested the order (null if created via API)
companyNamestringName of the company
employeeProfileobject | nullEmployee profile info, if applicable
hardwaresarrayList of hardware items requested
createdHardwaresarrayList of hardware items actually created
apiClientRequesterNamestring | nullName of the API client that submitted the request (null if created by user)
poNumberstring | nullPurchase Order number, if provided
clientNamestring | nullClient name associated with this order, if provided
resellerIdsarrayArray of reseller IDs matching the order's country (only for API-created orders)

employeeProfile Properties

PropertyTypeDescription
idstringEmployee ID
firstNamestringFirst name of the employee
lastNamestringLast name of the employee
countryCodestringCountry code of the employee
emailstringEmail address
addressstringStreet address
addressExtraInfostring | nullAdditional address information
postCodestringPostal code

hardwares Properties

PropertyTypeDescription
idstringHardware ID
brandstring | nullBrand name (if provided)
amountnumberQuantity of the item
notesstring | nullNotes associated with the item
quotedUnitPricestring | nullQuoted price per unit (as string)
createdAtstringISO timestamp when item was added
catalogModelIdstring | nullOptional catalog model reference
modelstringModel name of the hardware
ramstringRAM configuration (if applicable)
diskSpacestringDisk size (if applicable)
displaySizestringDisplay size (if applicable)
processorstringProcessor (if applicable)
imagestringURL to the image
externalItemIdstring | nullExternal item identifier (if provided)
serialNumbersstring[]Array of serial numbers (if assigned)
isSelectedboolean | nulltrue if this row is the selected candidate of an alternative group; null if the hardware is not part of a group
isAvailableboolean | nullAvailability flag when the hardware is part of a group; null if not in a group
isRecommendedboolean | nullRecommendation flag when the hardware is part of a group; null if not in a group
alternativeGroupobject | nullPresent when this hardware belongs to an alternative group (then it lists all candidates); null otherwise

alternativeGroup Properties

PropertyTypeDescription
idstringUnique identifier of the alternative group
selectedIdstring | nullID of the currently selected hardware request (typically the same id as the parent hardware in hardwares[])
candidatesarrayFull list of candidates for this group (includes the selected item and alternatives)

candidates Properties

Each candidate exposes the same base fields as hardwares except alternativeGroup (omitted on candidates to avoid recursion), plus:

PropertyTypeDescription
isSelectedbooleantrue for exactly one candidate per group (the chosen option)
isAvailableboolean | nullMarked during quoting
isRecommendedboolean | nullMarked during quoting
isOriginalRequestbooleantrue for the original request in the group (earliest createdAt; ties broken by lexicographic id sorting)

createdHardwares Properties

PropertyTypeDescription
idstringUnique ID of the created hardware
brandstring | nullBrand name (if applicable)
descriptionstringDescription or notes
serialNumberstringSerial number of the hardware
modelstringModel name of the hardware
hardwareTypestringHardware type
ramstringRAM configuration (if applicable)
diskSpacestringDisk size (if applicable)
displaySizestringDisplay size (if applicable)
processorstringProcessor (if applicable)
imagestringURL to the image
coststringPurchase cost of the hardware
dateBoughtstringDate the hardware was bought (ISO format)

resellerIds Properties

PropertyTypeDescription
idstringUnique identifier of the reseller ID
codestringReseller code
countryCodestringCountry code matching the reseller's location

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,
"trackingCode": null,
"countryCode": "UY",
"sendTo": "EMPLOYEE",
"currency": "USD",
"dateCompleted": "2025-04-25",
"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",
"serialNumbers": ["SN-01", "SN-02"],
"createdAt": "2025-04-10T15:01:33.649Z",
"catalogModelId": null,
"brand": null,
"model": "MacBook Pro",
"hardwareType": "MACBOOK",
"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,
"model": "HEADPHONES",
"hardwareType": "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,
"trackingCode": null,
"countryCode": "UY",
"sendTo": "STORAGE",
"currency": "USD",
"dateCompleted": 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,
"model": "MacBook Pro",
"hardwareType": "MACBOOK",
"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,
"model": "Lenovo T14",
"hardwareType": "PC",
"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,
"model": "MOUSE",
"hardwareType": "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 isExternalOrder flag indicates if the order was created through external integrations