Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

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.

get
/order_agreements/
Authorizations
AuthorizationstringRequired

Token credential sent in the Authorization header, in the form: Token <your-token>. Requires a staff (admin) account.

Query parameters
pageintegerOptional

The page number to return.

Default: 1
limitintegerOptional

The number of items to return per page.

Default: 10
sortstringOptional

Orders the results by one or more fields. Separate multiple fields with commas. Prefix a field with a hyphen (-) for descending order.

Example: -id
order_numberstringOptional

Filter by the order number of the owning order. Exact match.

Example: 000123456789
order_idintegerOptional

Filter by the identifier of the owning order. Exact match.

Example: 12345
contract_typestring · enumOptional

The type of legal contract attached to an order agreement.

Example: salesPossible values:
Responses
200

A page of order agreements.

application/json

A paginated list of order agreements.

countintegerOptional

Total number of order agreements matching the request.

nextstring · nullableOptional

URL of the next page, or null if this is the last page.

previousstring · nullableOptional

URL of the previous page, or null if this is the first page.

get/order_agreements/
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?