List order agreements
Returns a paginated list of order agreements — the legal contracts captured at checkout.
Each entry includes the contract type and the full contract text, which is fetched from the document store at read time. Filter by order_number, order_id, or contract_type. Order results with sort.
Token credential sent in the Authorization header, in the form: Token <your-token>. Requires a staff (admin) account.
The page number to return.
1The number of items to return per page.
10Orders the results by one or more fields. Separate multiple fields with commas. Prefix a field with a hyphen (-) for descending order.
-idFilter by the order number of the owning order. Exact match.
000123456789Filter by the identifier of the owning order. Exact match.
12345The type of legal contract attached to an order agreement.
salesPossible values: A page of order agreements.
A paginated list of order agreements.
Total number of order agreements matching the request.
URL of the next page, or null if this is the last page.
URL of the previous page, or null if this is the first page.
The request contains invalid or missing data.
Authentication credentials were not provided or are invalid.
The authenticated user does not have administrator privileges.
The requested page of the order agreement list does not exist — the page number is beyond the last page or is not a number.
GET /api/v1/remote/1/order_agreements/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
"count": 1,
"next": null,
"previous": null,
"results": [
{
"order_id": "12345",
"url": "https://bucket.s3.amazonaws.com/contracts/sales_12345.html",
"type": "sales",
"contract_content": "<p>Distance Sales Agreement...</p>"
}
]
}Last updated
Was this helpful?

