Retrieve order details

Retrieve an order's items and the customer-facing links for each protection product on it, such as the policy document, certificate, and refund request page.

Look up the order by the reference_id you sent when you submitted it, or by the Teak order ID. Orders are created shortly after a 202 from Submit an order, so this endpoint can return 404 for a few seconds after submitting.

Pass the customer's email to get links that the customer can open directly. Without a matching email, links are returned without the customer's access token.

The response contains no customer personal data and no amounts.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Your reference_id for the order, or the Teak order ID.

Query Params

The customer's email address. When it matches the order, links include the customer's access token. Matching is case-insensitive.

Return only the items and links for this protection product. An ID that doesn't match anything on the order returns empty arrays.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json