# Orders

> Every order Rendezvu attributed to one of your hosts, across your store and every connected network, with the host's commission on each.

- Audience: API
- Page type: reference
- Updated: 2026-10-08
- Canonical URL: https://www.rendezvu.co/docs/api/orders

An order appears here when a Rendezvu link, a host's discount code, or your team's manual match attributes it to a host. `attribution` tells you which: `tracked` for a link or code, `manual` for a match your team made.

To sync orders, page through with `per_page=100` and a `start_date`, then re-read recent days on the next run: refunds and cancellations update an order after it was placed.

## List orders

`GET /api/brand/v1/orders`

Every order Rendezvu attributed to one of your hosts, across Shopify, Squarespace, WooCommerce, AvantLink, Impact, Awin, Rakuten and CJ. The same set as the Orders tab in your console.

Scope: `analytics:read`. Plan feature: Analytics. Paginated.

**Parameters**

| Parameter | Type | Description |
| --- | --- | --- |
| `page` | integer, optional, default `1` | The page to return, starting at 1. At most 10,000. |
| `per_page` | integer, optional, default `25` | Items per page, between 1 and 100. |
| `start_date` | date, optional | Only orders placed on or after this ISO 8601 date (YYYY-MM-DD) or timestamp, UTC. |
| `end_date` | date, optional | Only orders placed on or before this ISO 8601 date or timestamp, UTC. |
| `status` | enum, optional, default `all` | Filter by order state. One of: `all`, `active`, `cancelled`, `refunded`. |

**Returns**

A page of orders, newest first. `data` is an array of objects with these attributes, and the body carries `pagination`.

| Attribute | Type | Description |
| --- | --- | --- |
| `id` | string | The Rendezvu order id. |
| `external_order_id` | string, nullable | The order id in your store or network. |
| `order_number` | string, nullable | The order number your customer saw. |
| `order_date` | timestamp | When the order was placed. |
| `currency` | string, nullable | ISO 4217 currency code. |
| `total_amount` | number, nullable | Order total. |
| `subtotal_amount` | number, nullable | Subtotal before tax and shipping. |
| `refund_amount` | number, nullable | Amount refunded so far. |
| `financial_status` | string, nullable | Payment state as your store reports it, such as paid or partially_refunded. |
| `fulfillment_status` | string, nullable | Fulfillment state as your store reports it. |
| `is_cancelled` | boolean | The order was cancelled. |
| `is_refunded` | boolean | The order was fully refunded. |
| `commission_rate` | number | The host’s commission rate on this order, as a percentage. Your default rate when no override applies. |
| `commission_amount` | number, nullable | The host’s commission on this order. |
| `attribution` | enum | `tracked` when a Rendezvu link or code attributed the order; `manual` when your team matched it by hand. |
| `host` | object, nullable | The host the order is attributed to. |
| `host.id` | string | The host’s Rendezvu user id (UUID). |
| `host.username` | string, nullable | The host’s handle, as in rendezvu.co/username. |
| `host.first_name` | string, nullable | First name. |
| `host.last_name` | string, nullable | Last name. |
| `host.profile_photo` | string, nullable | URL of the host’s profile photo. |
| `product` | object, nullable | The product the shopper clicked through from, when known. |
| `product.id` | string | The Rendezvu product id. |
| `product.title` | string | Product title. |
| `product.cover_photo` | string, nullable | Product photo URL. |
| `gear_list` | object, nullable | The host’s gear list the click came from, when known. |
| `gear_list.id` | string | The gear list id. |
| `gear_list.title` | string | The list title. |
| `line_items` | array of objects | What was bought, reduced to product facts. Buyer-entered notes and properties are never included. |
| `line_items.title` | string, nullable | Product title. |
| `line_items.variant_title` | string, nullable | Size, color or other variant. |
| `line_items.sku` | string, nullable | Your SKU. |
| `line_items.quantity` | integer, nullable | Units. |
| `line_items.price` | number, nullable | Unit price. |

**Example request**

```bash
curl 'https://api.rendezvu.co/api/brand/v1/orders?status=active&start_date=2026-09-01&per_page=1' \
  -H "Authorization: Bearer $RENDEZVU_BRAND_API_KEY"
```

**Example response**

```json
{
  "success": true,
  "data": [
    {
      "id": "9b8a7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
      "external_order_id": "5873214560321",
      "order_number": "#10482",
      "order_date": "2026-09-28T15:04:22.000Z",
      "currency": "USD",
      "total_amount": 214.98,
      "subtotal_amount": 199,
      "refund_amount": 0,
      "financial_status": "paid",
      "fulfillment_status": "fulfilled",
      "is_cancelled": false,
      "is_refunded": false,
      "commission_rate": 12,
      "commission_amount": 23.88,
      "attribution": "tracked",
      "host": {
        "id": "6f1c2a9e-3b4d-4e1f-9a8b-2c7d5e6f7a81",
        "username": "jordanalpine",
        "first_name": "Jordan",
        "last_name": "Reyes",
        "profile_photo": "https://media.rendezvu.co/6f1c2a9e_profile.jpg"
      },
      "product": {
        "id": "5c6d7e8f-9a0b-4c1d-8e2f-3a4b5c6d7e8f",
        "title": "Ridgeline 30L Pack",
        "cover_photo": "https://media.rendezvu.co/5c6d7e8f_ridgeline.jpg"
      },
      "gear_list": {
        "id": "a0b1c2d3-e4f5-4a6b-8c7d-8e9f0a1b2c3d",
        "title": "Western States kit"
      },
      "line_items": [
        {
          "title": "Ridgeline 30L Pack",
          "variant_title": "Slate / M",
          "sku": "RL30-SLT-M",
          "quantity": 1,
          "price": 199
        }
      ]
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 1,
    "total_items": 58,
    "total_pages": 58,
    "has_next": true,
    "has_prev": false
  },
  "_timing": {
    "duration_ms": 42
  }
}
```

## Related

- [Analytics](https://www.rendezvu.co/docs/api/analytics.md): Clicks, views, buy-now clicks and attributed sales for your products, as a summary, a time series and per host. Human traffic only.
- [Discount codes](https://www.rendezvu.co/docs/api/discount-codes.md): The discount codes your hosts share, what each one takes off, whether it is live, and whether it is synced to your store.

---

Source: https://www.rendezvu.co/docs/api/orders (Rendezvu docs, Markdown view). Every page: https://www.rendezvu.co/llms.txt