Orders API

Orders API

GET /api/integrations/v2/{connection_id}/orders

The workspace’s orders, keyset-paged on (updated_at, id).

Parameters

Name	In	Type	Required	Description
connection_id	path	string (uuid)	yes	Your custom integration’s id; the connection whose secret signs the request.
updated_since	query	string (date-time), nullable	no	Only rows changed at or after this instant (inclusive).
cursor	query	string, nullable	no	The next_cursor of the previous page, as given.
limit	query	integer	no	Page size; at most 250 rows are answered whatever is asked. Default 50.

Headers

Header	Required	Description
X-Yedran-Timestamp	yes	Unix seconds; within five minutes of the server’s clock.
X-Yedran-Signature	yes	Lowercase hex HMAC-SHA256, keyed with the integration’s API secret, over METHOD\npath\ntimestamp\nsha256_hex(body).
Yedran-Version	no	Optional: the contract version, 2026-10 today; absent is 2026-10. Any other value is 400 unsupported_version. Every answer echoes the version served.

Response 200

Schema OrderPageV2.

Field	Type	Required	Description
data	array of OrderV2	yes
next_cursor	string, nullable	yes

Example

curl -X GET "https://app.yedran.com/api/integrations/v2/{connection_id}/orders?limit=1" \
  -H "X-Yedran-Timestamp: $TIMESTAMP" \
  -H "X-Yedran-Signature: $SIGNATURE" \
  -H "Yedran-Version: 2026-10"

Response 200:

{
  "data": [
    {
      "id": "3f2504e0-4f89-11d3-9a0c-0305e82c3301",
      "external_id": "string",
      "state": "draft",
      "currency": "string",
      "total_amount_minor": 1,
      "confirmed_at": "2026-10-02T09:00:00Z",
      "paid_at": "2026-10-02T09:00:00Z",
      "cancelled_at": "2026-10-02T09:00:00Z",
      "refunded_at": "2026-10-02T09:00:00Z",
      "created_at": "2026-10-02T09:00:00Z",
      "updated_at": "2026-10-02T09:00:00Z"
    }
  ],
  "next_cursor": "string"
}

Errors

Code	Meaning
400	Bad Request
401	Unauthorized
422	Unprocessable Entity

GET /api/integrations/v2/{connection_id}/orders/{order_id}

One order by our id.

Parameters

Name	In	Type	Required	Description
connection_id	path	string (uuid)	yes	Your custom integration’s id; the connection whose secret signs the request.
order_id	path	string (uuid)	yes

Headers

Header	Required	Description
X-Yedran-Timestamp	yes	Unix seconds; within five minutes of the server’s clock.
X-Yedran-Signature	yes	Lowercase hex HMAC-SHA256, keyed with the integration’s API secret, over METHOD\npath\ntimestamp\nsha256_hex(body).
Yedran-Version	no	Optional: the contract version, 2026-10 today; absent is 2026-10. Any other value is 400 unsupported_version. Every answer echoes the version served.

Response 200

Schema OrderV2.

Field	Type	Required	Description
id	string (uuid)	yes
external_id	string, nullable	yes
state	OrderState	yes
currency	string	yes
total_amount_minor	integer	yes
confirmed_at	string (date-time), nullable	yes
paid_at	string (date-time), nullable	yes
cancelled_at	string (date-time), nullable	yes
refunded_at	string (date-time), nullable	yes
created_at	string (date-time)	yes
updated_at	string (date-time)	yes

Example

curl -X GET "https://app.yedran.com/api/integrations/v2/{connection_id}/orders/3f2504e0-4f89-11d3-9a0c-0305e82c3301" \
  -H "X-Yedran-Timestamp: $TIMESTAMP" \
  -H "X-Yedran-Signature: $SIGNATURE" \
  -H "Yedran-Version: 2026-10"

Response 200:

{
  "id": "3f2504e0-4f89-11d3-9a0c-0305e82c3301",
  "external_id": "string",
  "state": "draft",
  "currency": "string",
  "total_amount_minor": 1,
  "confirmed_at": "2026-10-02T09:00:00Z",
  "paid_at": "2026-10-02T09:00:00Z",
  "cancelled_at": "2026-10-02T09:00:00Z",
  "refunded_at": "2026-10-02T09:00:00Z",
  "created_at": "2026-10-02T09:00:00Z",
  "updated_at": "2026-10-02T09:00:00Z"
}

Errors

Code	Meaning
400	Bad Request
401	Unauthorized
404	Not Found
422	Unprocessable Entity

Schemas

OrderPageV2

A page of the workspace’s orders, (updated_at, id) ascending.

Field	Type	Required	Description
data	array of OrderV2	yes
next_cursor	string, nullable	yes

OrderV2

One order, bounded like v1’s IntegrationOrderView.

external_id is the order’s external_ref only when THIS integration sent it: another integration’s reference is in another namespace and is never shown. No archived_at: an order is never archived, it ends cancelled or refunded.

Field	Type	Required	Description
id	string (uuid)	yes
external_id	string, nullable	yes
state	OrderState	yes
currency	string	yes
total_amount_minor	integer	yes
confirmed_at	string (date-time), nullable	yes
paid_at	string (date-time), nullable	yes
cancelled_at	string (date-time), nullable	yes
refunded_at	string (date-time), nullable	yes
created_at	string (date-time)	yes
updated_at	string (date-time)	yes

OrderState

The six states migration 0099’s CHECK constraint admits.

One of draft, confirmed, paid, fulfilled, cancelled, refunded.