The POS Search Fields object

Attributes

id string

Unique identifier for the object.

idx integer
pos_settings_id string required
fieldname string
field string required
The POS Search Fields object 
{
  "id": "p-o-s-search-fields_abc123",
  "idx": 1,
  "pos_settings_id": "pos_settings_id_example",
  "fieldname": "fieldname_example",
  "field": "field_example"
}
GET /api/accounts/p-o-s-search-fields?parent_id={id}

List pos search fieldss by parent

Returns all pos search fieldss 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 search fields objects belonging to the parent.

GET /api/accounts/p-o-s-search-fields?parent_id={id} 
curl https://api.overplane.dev/api/accounts/p-o-s-search-fields?parent_id=parent_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "p-o-s-search-fields_abc123",
      "idx": 1,
      "pos_settings_id": "pos_settings_id_example",
      "fieldname": "fieldname_example",
      "field": "field_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/accounts/p-o-s-search-fields

Create a pos search fields

Creates a new pos search fields object.

Body parameters

idx integer
pos_settings_id string required
fieldname string
field string required

Returns

Returns the newly created pos search fields object if the call succeeded.

POST /api/accounts/p-o-s-search-fields 
curl https://api.overplane.dev/api/accounts/p-o-s-search-fields \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"pos_settings_id":"pos_settings_id_example","field":"field_example"}'
Response 
{
  "id": "p-o-s-search-fields_abc123",
  "idx": 1,
  "pos_settings_id": "pos_settings_id_example",
  "fieldname": "fieldname_example",
  "field": "field_example"
}
PATCH /api/accounts/p-o-s-search-fields/{id}

Update a pos search fields

Updates the specified pos search fields 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 search fields to update.

Body parameters

idx integer
pos_settings_id string
fieldname string
field string

Returns

Returns the updated pos search fields object.

PATCH /api/accounts/p-o-s-search-fields/{id} 
curl https://api.overplane.dev/api/accounts/p-o-s-search-fields/p-o-s-search-fields_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"idx":1,"pos_settings_id":"pos_settings_id_example"}'
Response 
{
  "id": "p-o-s-search-fields_abc123",
  "idx": 1,
  "pos_settings_id": "pos_settings_id_example",
  "fieldname": "fieldname_example",
  "field": "field_example"
}
DELETE /api/accounts/p-o-s-search-fields/{id}

Delete a pos search fields

Permanently deletes a pos search fields. This cannot be undone.

Path parameters

id string required

The identifier of the pos search fields to delete.

Returns

Returns a confirmation that the pos search fields has been deleted.

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

Reorder pos search fieldss

Updates the sort order of pos search fieldss within their parent by setting new index values.

Returns

Returns the reordered list.

POST /api/accounts/p-o-s-search-fields/reorder 
curl https://api.overplane.dev/api/accounts/p-o-s-search-fields/reorder \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "p-o-s-search-fields_abc123",
  "idx": 1,
  "pos_settings_id": "pos_settings_id_example",
  "fieldname": "fieldname_example",
  "field": "field_example"
}