supplier_orders

List /supplier_orders

List purchase orders to suppliers (CRM "Stock → Orders"). Matches query against the order number, supplier name and line item / supplier codes. Filters: updated_since for incremental sync, status, supplier, responsible, warehouse, project, date ranges, uuid. subtotal (and line prices on the detail endpoint) only with the order prices permission. Response: items and pagination.

GET

/supplier_orders

curl --request GET \
  --url 'https://default.hannacrm.app/api/v4/supplier_orders?query=%3Cstring%3E&page=123&per_page=123&filter%5Bupdated_since%5D=2023-11-07T05%3A31%3A56Z&filter%5Bcreated_since%5D=2023-11-07T05%3A31%3A56Z&filter%5Bstatus%5D=%3Cstring%3E&filter%5Bsupplier%5D=%3Cstring%3E&filter%5Bresponsible%5D=3c90c3cc-0d44-4b50-8888-8dd25736052a&filter%5Bwarehouse%5D=%3Cstring%3E&filter%5Bproject%5D=%3Cstring%3E&filter%5Border_date%5D=%3Cstring%3E&filter%5Bplanned_receive_date%5D=%3Cstring%3E&filter%5Bcreated_at%5D=%3Cstring%3E&filter%5Bupdated_at%5D=%3Cstring%3E&filter%5Borganization%5D=3c90c3cc-0d44-4b50-8888-8dd25736052a&filter%5Buuid%5D=%3Cstring%3E&filter%5Bcreated_by%5D=3c90c3cc-0d44-4b50-8888-8dd25736052a&filter%5Bupdated_by%5D=3c90c3cc-0d44-4b50-8888-8dd25736052a&sort=%3Cstring%3E&fields=%3Cstring%3E' \
  --header 'Authorization: Bearer <token>'

{
  "items": [
    {
      "client": {
        "name": "<string>",
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "comment": "<string>",
      "confirmed_order_pick_date": "<string>",
      "contact_person": {
        "name": "<string>",
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "created_at": "2023-11-07T05:31:56Z",
      "created_by": {
        "name": "<string>",
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "currency": {
        "name": "<string>",
        "symbol": "<string>"
      },
      "delivery_address": "<string>",
      "delivery_type": "warehouse",
      "item_arrival_date": "<string>",
      "number": "<string>",
      "order_date": "<string>",
      "organization": {
        "name": "<string>",
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "planned_receive_date": "<string>",
      "project": {
        "name": "<string>",
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "responsible": [
        {
          "name": "<string>",
          "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      ],
      "status": {
        "color": "<string>",
        "name": "<string>",
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "status_updated_at": "2023-11-07T05:31:56Z",
      "supplier": {
        "name": "<string>",
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "updated_at": "2023-11-07T05:31:56Z",
      "updated_by": {
        "name": "<string>",
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "uuid": "<string>",
      "warehouse": {
        "code_name": "<string>",
        "name": "<string>",
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    }
  ],
  "pagination": {
    "from": 123,
    "last_page": 123,
    "page": 123,
    "per_page": 123,
    "to": 123,
    "total": 123
  },
  "query": "<string>"
}

Authorizations

Authorizationstringheaderrequired

API key (Bearer token) created in Setup → API & MCP.

Query Parameters

querystringquery

Optional search phrase matched against the order number, supplier name and line item / supplier codes.

Minimum string length: 1

pageintegerquery

Page number (1-based).

Required range: 1 <= x

per_pageintegerquery

Number of results per page.

Required range: 1 <= x <= 50

filter[updated_since]stringquery

Return only orders changed at or after this ISO 8601 timestamp (e.g. 2026-09-01T00:00:00Z). Intended for incremental polling.

filter[created_since]stringquery

Return only orders created at or after this ISO 8601 timestamp.

filter[status]stringquery

Order status UUIDs (picklist orders / order_statuses).

filter[supplier]stringquery

Supplier (client) UUIDs.

filter[responsible]string[]query

Responsible staff UUIDs.

filter[warehouse]stringquery

Warehouse UUIDs or code names.

filter[project]stringquery

Project UUIDs.

filter[order_date]stringquery

Order date range (YYYY-MM-DD - YYYY-MM-DD).

filter[planned_receive_date]stringquery

Planned receive date range (YYYY-MM-DD - YYYY-MM-DD).

filter[created_at]stringquery

Creation date range (YYYY-MM-DD - YYYY-MM-DD).

filter[updated_at]stringquery

Last change date range (YYYY-MM-DD - YYYY-MM-DD). Use updated_since for incremental polling.

filter[organization]string[]query

Organization UUIDs.

filter[uuid]stringquery

Order UUIDs. Use it to fetch several known orders in one call.

filter[created_by]string[]query

Creator staff UUIDs.

filter[updated_by]string[]query

Staff UUIDs who last changed the order.

sortstringquery

Optional sort order, comma-separated; prefix a field with - for descending (e.g. sort=-updated_at); empty values sort last. Sortable fields: comment, confirmed_order_pick_date, created_at, delivery_address, item_arrival_date, number, order_date, planned_receive_date, status_updated_at, updated_at, uuid. Default when omitted: -create_date,-id.

fieldsstring[]query

Optional response field paths (dot notation for nested groups, e.g. billing_address.street; array fields are returned whole). Comma-separated string is also accepted. Identifier field is always included.

Response

Search results

itemsobject[]

Show child attributes

paginationobject

Show child attributes

querystring

Still need help? Ask the team