Look up an order for the order status page
- Path
/orders/status-reference/{accessToken}- Auth
- Access token · in the URL path
const url = 'https://releva.ai/api/v0/orders/status-reference/YOUR_ACCESS_TOKEN';const options = { method: 'POST', headers: {'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/YOUR_ACCESS_TOKEN \ --header 'Content-Type: application/json' \ --data '{ "orderId": "DEMO-ORDER-1001", "email": "maria@example.com" }'The lookup behind Releva.lookupOrder on an order status page built in Releva’s editor: a shopper who has no
link to their order types its number and the email it was placed with, and gets back the signed reference the
page opens the order with (?rlv_odid=<reference>). Order emails carry the same reference in their order
status link.
It only reads. A wrong email, an unknown order and an order with no email on it all answer the same 404, so
the answer never says which. The email is compared without case and surrounding spaces; orderId is trimmed.
Every request counts against a limit of 10 per 15 minutes per shop and IP address, successful or not.
Send the access token in the path, or as authorization: Bearer <accessToken> on
POST /orders/status-reference.
Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The shop’s access token.
Example
YOUR_ACCESS_TOKENRequest 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": "The 'orderId' field is required."}{ "message": "The 'orderId' field must not be empty."}{ "message": "The 'email' field must be a valid e-mail."}{ "message": "The access token you provided is invalid."}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."}