Skip to content

Area: Developers

POST

Look up an order for the order status page (access token in the header)

Path
/orders/status-reference
Auth
Access token · browser or app
POST
/orders/status-reference
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.

Media typeapplication/json
object
orderId
required

The order number the shopper typed.

string
>= 1 characters <= 255 characters
email
required

The email the order was placed with.

string format: email
<= 255 characters

Example

{
"orderId": "DEMO-ORDER-1001",
"email": "maria@example.com"
}

The order number and the email go together.

Media typeapplication/json
object
reference
required

The signed order reference, <orderId>.<tag>. Open the order status page with ?rlv_odid=<reference>.

string

Example

{
"reference": "DEMO-ORDER-1001.0123456789abcdef0123456789abcdef"
}

Authentication or validation error.

Media typeapplication/json
object
message
required

Human-readable error. Several validation errors are joined with a space.

string

Examples

{
"message": "Authorization header is malformed. It should look like `Bearer <string>`."
}

The domain is disabled.

Media typeapplication/json
object
message
required

Human-readable error. Several validation errors are joined with a space.

string

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.

Media typeapplication/json
object
code
required
string
Allowed values: notFound

Example

{
"code": "notFound"
}

More than 10 lookups from this IP address for this shop in 15 minutes. Plain-text body.

Unexpected server error.

Media typeapplication/json
object
message
required

Human-readable error. Several validation errors are joined with a space.

string

Example

{
"message": "An internal error occurred."
}