Collection rows
Every row endpoint returns the whole collection, rows in order.
Add a rowโ
POST /v1/collections/{id}/rows
Scope: collections:write. The row goes to the end.
| Field | Type | When | Description |
|---|---|---|---|
kind | string | Always | item, category or heading |
item_type | string | item, category | rental, experience, store, bundle, program, service, gift_card, pass. A category only for rental, experience, store. |
item_id | integer | item | The item (for pass, the pass id from GET /v1/passes). Not used for service and gift_card. |
category_id | integer | category | The category |
heading | string | heading | Up to 120 characters |
title_override | string | item, optional | Title on this collection only |
is_large | boolean | item, optional | Feature it as a large card |
curl -X POST https://app.equipdash.com/api/v1/collections/12/rows \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"kind": "category", "item_type": "rental", "category_id": 7}'
422 when the item or category is not this shop's, when the item is already in the collection, or
when the collection already has 100 rows.
Update a rowโ
PATCH /v1/collections/{id}/rows/{rowId}
| Field | Type | Description |
|---|---|---|
title_override | string or null | Title on this collection only. null uses the item's own name. |
is_large | boolean | Items only |
heading | string | Headings only |
Reorder rowsโ
PUT /v1/collections/{id}/rows/order
{ "row_ids": [84, 81, 82, 83] }
Rows left out keep their place after the ones given. Ids from another collection are ignored.
Remove a rowโ
DELETE /v1/collections/{id}/rows/{rowId}
Removes the row only. The item itself is not touched.