Quickstart

Use these requests to confirm your token, then fetch your first page of orders.

Before you start

You need:

the shop’s API base URL, such as https://your-shop.example/api/partner/v1,
a bearer token from the shop owner,
the partner.orders.read scope for the orders request.

Check your token

Call whoami first. It confirms which key you are using, which scopes it carries, and which shop it belongs to.

curl https://your-shop.example/api/partner/v1/whoami \
  -H "Authorization: Bearer YOUR_TOKEN"

{
  "id": 12,
  "name": "Partner integration",
  "scopes": [
    "partner.orders.read",
    "partner.customers.read"
  ],
  "tenant": {
    "ref": "440db2ce-91eb-4c1b-8c84-226c0f6fb4cc"
  },
  "expires_at": "2026-09-25T23:59:59+01:00"
}

If this returns 401, check the token value. If it still fails, ask the shop to rotate the key.

Fetch recent orders

Request the first page of orders:

curl "https://your-shop.example/api/partner/v1/orders?per_page=2" \
  -H "Authorization: Bearer YOUR_TOKEN"

{
  "data": [
    {
      "id": 5001,
      "reference": "WEB-10001",
      "status": "confirmed",
      "payment_status": "paid",
      "fulfilment_method": "delivery",
      "fulfilment_date": "2026-07-02",
      "fulfilment_at": "2026-07-02T13:00:00+01:00",
      "fulfilment_window": "between 13:00-15:00",
      "assigned_florist": { "name": "Sam Rivera" },
      "recipient": {
        "type": "contact",
        "id": 202,
        "name": null,
        "company_name": null,
        "email": null,
        "phone": null
      },
      "customer": {
        "type": "customer",
        "id": 101,
        "name": null,
        "first_name": null,
        "last_name": null,
        "company_name": null,
        "email": null,
        "phone": null,
        "address": null,
        "created_at": "2026-06-27T10:15:00+01:00",
        "updated_at": "2026-06-27T10:20:00+01:00"
      },
      "address": {
        "address_line_one": "10 Example Street",
        "address_line_two": null,
        "address_line_three": null,
        "town": "Manchester",
        "county": null,
        "postcode": "M1 1AE",
        "country": "GB"
      },
      "line_items": [
        {
          "product_id": 42,
          "variant": { "id": 108, "name": "Medium", "sku": "FCB-MED" },
          "name": "Florist choice bouquet",
          "quantity": 1,
          "unit_price": 49,
          "line_total": 49,
          "tax_total": 8.17,
          "note": null,
          "card_message": null
        }
      ],
      "discount_total": 0,
      "total": 54.99,
      "tax_total": 9.17,
      "fulfilment_charge": 5.99,
      "currency": "GBP",
      "notes": null,
      "created_at": "2026-06-27T10:15:00+01:00",
      "updated_at": "2026-06-27T10:20:00+01:00"
    }
  ],
  "links": {
    "next": null,
    "prev": null
  },
  "meta": {
    "per_page": 2,
    "has_more": false
  }
}

This shop has only one order, so has_more is false and links.next is null. When more results exist, follow links.next to fetch the next page. Recipient and customer contact fields are null unless the token has partner.customers.pii. The request still succeeds with HTTP 200. The delivery address and assigned_florist are operational fields, always present so you can route and reconcile without the PII scope.

What’s next?

Authentication

Understand scopes, token rotation, and PII field nulling.

Pagination and filtering

Page through collections and poll with filter[updated_since].

Partner API

Endpoints

Before you start

Check your token

Fetch recent orders

What’s next?

Authentication

Pagination and filtering

​Before you start

​Check your token

​Fetch recent orders

​What’s next?

Authentication

Pagination and filtering

Before you start

Check your token

Fetch recent orders

What’s next?