The POS Field object

Attributes

id string

Unique identifier for the object.

idx integer
pos_settings_id string required
fieldname string
fieldtype string
label string
options string
reqd boolean

Default: false

read_only boolean

Default: false

default_value string
The POS Field object 
{
  "id": "p-o-s-field_abc123",
  "idx": 1,
  "pos_settings_id": "pos_settings_id_example",
  "fieldname": "fieldname_example",
  "fieldtype": "fieldtype_example",
  "label": "label_example",
  "options": "options_example",
  "reqd": false,
  "read_only": false,
  "default_value": "default_value_example"
}
GET /api/accounts/p-o-s-field?parent_id={id}

List pos fields by parent

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

GET /api/accounts/p-o-s-field?parent_id={id} 
curl https://api.overplane.dev/api/accounts/p-o-s-field?parent_id=parent_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "p-o-s-field_abc123",
      "idx": 1,
      "pos_settings_id": "pos_settings_id_example",
      "fieldname": "fieldname_example",
      "fieldtype": "fieldtype_example",
      "label": "label_example",
      "options": "options_example",
      "reqd": false,
      "read_only": false,
      "default_value": "default_value_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/accounts/p-o-s-field

Create a pos field

Creates a new pos field object.

Body parameters

idx integer
pos_settings_id string required
fieldname string
fieldtype string
label string
options string
reqd boolean

Default: false

read_only boolean

Default: false

default_value string

Returns

Returns the newly created pos field object if the call succeeded.

POST /api/accounts/p-o-s-field 
curl https://api.overplane.dev/api/accounts/p-o-s-field \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"pos_settings_id":"pos_settings_id_example"}'
Response 
{
  "id": "p-o-s-field_abc123",
  "idx": 1,
  "pos_settings_id": "pos_settings_id_example",
  "fieldname": "fieldname_example",
  "fieldtype": "fieldtype_example",
  "label": "label_example",
  "options": "options_example",
  "reqd": false,
  "read_only": false,
  "default_value": "default_value_example"
}
PATCH /api/accounts/p-o-s-field/{id}

Update a pos field

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

Body parameters

idx integer
pos_settings_id string
fieldname string
fieldtype string
label string
options string
reqd boolean

Default: false

read_only boolean

Default: false

default_value string

Returns

Returns the updated pos field object.

PATCH /api/accounts/p-o-s-field/{id} 
curl https://api.overplane.dev/api/accounts/p-o-s-field/p-o-s-field_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-field_abc123",
  "idx": 1,
  "pos_settings_id": "pos_settings_id_example",
  "fieldname": "fieldname_example",
  "fieldtype": "fieldtype_example",
  "label": "label_example",
  "options": "options_example",
  "reqd": false,
  "read_only": false,
  "default_value": "default_value_example"
}
DELETE /api/accounts/p-o-s-field/{id}

Delete a pos field

Permanently deletes a pos field. This cannot be undone.

Path parameters

id string required

The identifier of the pos field to delete.

Returns

Returns a confirmation that the pos field has been deleted.

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

Reorder pos fields

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

Returns

Returns the reordered list.

POST /api/accounts/p-o-s-field/reorder 
curl https://api.overplane.dev/api/accounts/p-o-s-field/reorder \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "p-o-s-field_abc123",
  "idx": 1,
  "pos_settings_id": "pos_settings_id_example",
  "fieldname": "fieldname_example",
  "fieldtype": "fieldtype_example",
  "label": "label_example",
  "options": "options_example",
  "reqd": false,
  "read_only": false,
  "default_value": "default_value_example"
}