Skip to main content

Confirm Order

Confirms an existing hardware order. The order must be in QUOTED status and belong to the authenticated company.

Authentication​

This endpoint requires authentication. See Authentication for details.

Parameters​

FieldTypeRequiredDescription
idstringYesUUID of the order request to be confirmed
companyCodestringYesCompany code of the authenticated company

Request​

Production URL: https://orchestrator.tecspal.com/
Sandbox URL: https://orchestrator-dev.tecspal.com/
Endpoint: POST /orders/confirm

Example Request​

{
"data": {
"id": "3178e7e9-0fe9-47ad-b69a-e5604a990822",
"companyCode": "DM1"
},
"request": "orders/confirm",
"vendor": "tecspal",
"verb": "POST"
}

Response Schema​

PropertyTypeDescription
statusCodenumberHTTP status code of the response (200 on success)
messagestringDescription of the response status (e.g. Request successful)
enveloparrayArray containing the confirmed order minimal data

Envelope Item Properties​

Cada item dentro de envelop terá apenas os campos essenciais da order confirmada:

PropertyTypeDescription
idstringUnique identifier of the order
statusstringFinal status of the order (ACCEPTED)

Example Response​

{
"statusCode": 200,
"message": "Request successful",
"envelop": [
{
"id": "3178e7e9-0fe9-47ad-b69a-e5604a990822",
"status": "ACCEPTED"
}
]
}

Error Responses​

Bad Request (400)​

{
"error": "Bad Request",
"message": "id is required",
"statusCode": 400
}

Invalid Company or Order (400)​

{
"error": "Bad Request",
"message": "Order request not found",
"statusCode": 400
}

Invalid Status (400)​

{
"error": "Bad Request",
"message": "The Order cannot be confirmed",
"statusCode": 400
}

Unauthorized (401)​

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

Notes​

  • Only orders with status QUOTED can be confirmed via this endpoint.
  • Confirming the order updates its status to ACCEPTED.
  • The companyCode provided must match the company associated with the order.
  • If the order is already in ACCEPTED status, the endpoint will return the same id and status without making changes.