The POS Item Group object

Attributes

id string

Unique identifier for the object.

idx integer
pos_profile_id string required
item_group string required
The POS Item Group object 
{
  "id": "p-o-s-item-group_abc123",
  "idx": 1,
  "pos_profile_id": "pos_profile_id_example",
  "item_group": "item_group_example"
}
GET /api/accounts/p-o-s-item-group?parent_id={id}

List pos item groups by parent

Returns all pos 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 pos item group objects belonging to the parent.

GET /api/accounts/p-o-s-item-group?parent_id={id} 
curl https://api.overplane.dev/api/accounts/p-o-s-item-group?parent_id=parent_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "p-o-s-item-group_abc123",
      "idx": 1,
      "pos_profile_id": "pos_profile_id_example",
      "item_group": "item_group_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/accounts/p-o-s-item-group

Create a pos item group

Creates a new pos item group object.

Body parameters

idx integer
pos_profile_id string required
item_group string required

Returns

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

POST /api/accounts/p-o-s-item-group 
curl https://api.overplane.dev/api/accounts/p-o-s-item-group \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"pos_profile_id":"pos_profile_id_example","item_group":"item_group_example"}'
Response 
{
  "id": "p-o-s-item-group_abc123",
  "idx": 1,
  "pos_profile_id": "pos_profile_id_example",
  "item_group": "item_group_example"
}
PATCH /api/accounts/p-o-s-item-group/{id}

Update a pos item group

Updates the specified pos 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 pos item group to update.

Body parameters

idx integer
pos_profile_id string
item_group string

Returns

Returns the updated pos item group object.

PATCH /api/accounts/p-o-s-item-group/{id} 
curl https://api.overplane.dev/api/accounts/p-o-s-item-group/p-o-s-item-group_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"idx":1,"pos_profile_id":"pos_profile_id_example"}'
Response 
{
  "id": "p-o-s-item-group_abc123",
  "idx": 1,
  "pos_profile_id": "pos_profile_id_example",
  "item_group": "item_group_example"
}
DELETE /api/accounts/p-o-s-item-group/{id}

Delete a pos item group

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

Path parameters

id string required

The identifier of the pos item group to delete.

Returns

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

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

Reorder pos item groups

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

Returns

Returns the reordered list.

POST /api/accounts/p-o-s-item-group/reorder 
curl https://api.overplane.dev/api/accounts/p-o-s-item-group/reorder \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "p-o-s-item-group_abc123",
  "idx": 1,
  "pos_profile_id": "pos_profile_id_example",
  "item_group": "item_group_example"
}