The Website Item Group object

Attributes

id string

Unique identifier for the object.

idx integer
parent_id string
parent_type string
item_group string required
The Website Item Group object 
{
  "id": "website-item-group_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "item_group": "item_group_example"
}
GET /api/setup/website-item-group?parent_id={id}

List website item groups by parent

Returns all website item groups belonging to the specified parent.

Query parameters

parent_id string required

The ID of the parent to list children for.

Returns

A list of website item group objects belonging to the parent.

GET /api/setup/website-item-group?parent_id={id} 
curl https://api.overplane.dev/api/setup/website-item-group?parent_id=parent_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "website-item-group_abc123",
      "idx": 1,
      "parent_id": null,
      "parent_type": "parent_type_example",
      "item_group": "item_group_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/setup/website-item-group

Create a website item group

Creates a new website item group object.

Body parameters

idx integer
parent_id string
parent_type string
item_group string required

Returns

Returns the newly created website item group object if the call succeeded.

POST /api/setup/website-item-group 
curl https://api.overplane.dev/api/setup/website-item-group \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"item_group":"item_group_example"}'
Response 
{
  "id": "website-item-group_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "item_group": "item_group_example"
}
PATCH /api/setup/website-item-group/{id}

Update a website item group

Updates the specified website item group by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the website item group to update.

Body parameters

idx integer
parent_id string
parent_type string
item_group string

Returns

Returns the updated website item group object.

PATCH /api/setup/website-item-group/{id} 
curl https://api.overplane.dev/api/setup/website-item-group/website-item-group_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"idx":1,"parent_id":null}'
Response 
{
  "id": "website-item-group_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "item_group": "item_group_example"
}
DELETE /api/setup/website-item-group/{id}

Delete a website item group

Permanently deletes a website item group. This cannot be undone.

Path parameters

id string required

The identifier of the website item group to delete.

Returns

Returns a confirmation that the website item group has been deleted.

DELETE /api/setup/website-item-group/{id} 
curl https://api.overplane.dev/api/setup/website-item-group/website-item-group_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "website-item-group_abc123",
  "deleted": true
}
POST /api/setup/website-item-group/reorder

Reorder website item groups

Updates the sort order of website item groups within their parent by setting new index values.

Returns

Returns the reordered list.

POST /api/setup/website-item-group/reorder 
curl https://api.overplane.dev/api/setup/website-item-group/reorder \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "website-item-group_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "item_group": "item_group_example"
}