commerce

GET /v1/carts

List the open baskets in scope.

All commerce endpoints

All developer docs →

Zinn®, our Viking, hammering at his anvil beside an API endpoint sending events to several listeners.

Authentication

Send an API key as a bearer token. The key must carry the billing.payment.manage permission; a key without it is refused with 403, not 404.

Where your organisation id goes

This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.

Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X GET https://api.zinndigital.com/v1/carts \
  -H "Authorization: Bearer zdk_live_…"

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

The organization's OPEN carts that hold at least one line, newest first by paging, so the dashboard's basket screen can open the customer's basket when it is reached without a cart id (a reload, a bookmark, the nav). An empty cart and a converted or abandoned one are not listed. Lines are not re-priced here; read one with getCart. Requires billing.payment.manage, the permission every other cart operation needs.

Parameters

NameTypeRequiredWhat it is
cursor (query)stringNoOpaque cursor from a previous page's page.next_cursor.
limit (query)integerNoMaximum items to return (page size).
org_id (query)UuidNoRestrict to one organization in scope.

Response

NameTypeRequiredWhat it is
dataCartSummary[]Yes—
pagePageMetaYes—

Errors this endpoint can return

401 · 403 · 422 · 429