Skip to main content

Find Order

API operation: Open the endpoint in Scalar

Use GET /orders/{order} to retrieve one order. The current public operation is Order.find.get.

Access may require authentication, an internal request, or configured guest UUID access with a matching X-uuid-access-X value. Ordinary reads are limited to the caller's customer orders; mode=dashboard applies role-based access for operational users.

Never publish an order access hash. Use params only for relations supported by the operation; see Order relation expansion.

const response = await ordering.orders(orderId).get();

This SDK syntax is historical. Confirm the package and version before using it.

OpenAPI reference​

Operation: GET /orders/{order}

Path parameters

NameTypeRequiredDescription
orderinteger | stringYes—

Query parameters

NameTypeRequiredDescription
paramsstringNoComma-separated list of fields. It is intersected with the model’s $fillable; an empty or invalid list returns all fields.
modestringNo—

Header parameters

NameTypeRequiredDescription
X-uuid-access-XstringNo—

Responses

CodeDescription
200OK (Envelope)
400Bad Request (ErrorResponse)
401Unauthorized
404Not Found
429Too Many Requests (ErrorResponse)
500Internal Server Error (ErrorResponse)
503Service Unavailable (ErrorResponse)
Open this operation in the API reference