Look up an order for the order status page (access token in the header)
- Path
/orders/status-reference- Auth
- Access token · browser or app
const url = 'https://releva.ai/api/v0/orders/status-reference';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"orderId":"DEMO-ORDER-1001","email":"maria@example.com"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://releva.ai/api/v0/orders/status-reference \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "orderId": "DEMO-ORDER-1001", "email": "maria@example.com" }'The same call as POST /orders/status-reference/{accessToken}, with the access token sent as
authorization: Bearer <accessToken> instead of in the path. When both are sent, the header wins.
Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”object
The order number the shopper typed.
The email the order was placed with.
Example
{ "orderId": "DEMO-ORDER-1001", "email": "maria@example.com"}Responses
Section titled “Responses”The order number and the email go together.
object
The signed order reference, <orderId>.<tag>. Open the order status page with ?rlv_odid=<reference>.
Example
{ "reference": "DEMO-ORDER-1001.0123456789abcdef0123456789abcdef"}Authentication or validation error.
object
Human-readable error. Several validation errors are joined with a space.
Examples
{ "message": "Authorization header is malformed. It should look like `Bearer <string>`."}{ "message": "Authorization header is missing, and accessToken url parameters is also missing. At least one of them is required."}{ "message": "The 'orderId' field is required."}The domain is disabled.
object
Human-readable error. Several validation errors are joined with a space.
Example
{ "message": "Domain is disabled. Please reach out to support@releva.ai to enable it."}No order with this number was placed with this email. The same answer for every reason.
object
Example
{ "code": "notFound"}More than 10 lookups from this IP address for this shop in 15 minutes. Plain-text body.
Unexpected server error.
object
Human-readable error. Several validation errors are joined with a space.
Example
{ "message": "An internal error occurred."}