The POS Profile User object

Attributes

id string

Unique identifier for the object.

idx integer
pos_profile_id string required
default boolean

Default: false

user string
The POS Profile User object 
{
  "id": "p-o-s-profile-user_abc123",
  "idx": 1,
  "pos_profile_id": "pos_profile_id_example",
  "default": false,
  "user": "user_example"
}
GET /api/accounts/p-o-s-profile-user?parent_id={id}

List pos profile users by parent

Returns all pos profile users 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 profile user objects belonging to the parent.

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

Create a pos profile user

Creates a new pos profile user object.

Body parameters

idx integer
pos_profile_id string required
default boolean

Default: false

user string

Returns

Returns the newly created pos profile user object if the call succeeded.

POST /api/accounts/p-o-s-profile-user 
curl https://api.overplane.dev/api/accounts/p-o-s-profile-user \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"pos_profile_id":"pos_profile_id_example"}'
Response 
{
  "id": "p-o-s-profile-user_abc123",
  "idx": 1,
  "pos_profile_id": "pos_profile_id_example",
  "default": false,
  "user": "user_example"
}
PATCH /api/accounts/p-o-s-profile-user/{id}

Update a pos profile user

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

Body parameters

idx integer
pos_profile_id string
default boolean

Default: false

user string

Returns

Returns the updated pos profile user object.

PATCH /api/accounts/p-o-s-profile-user/{id} 
curl https://api.overplane.dev/api/accounts/p-o-s-profile-user/p-o-s-profile-user_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-profile-user_abc123",
  "idx": 1,
  "pos_profile_id": "pos_profile_id_example",
  "default": false,
  "user": "user_example"
}
DELETE /api/accounts/p-o-s-profile-user/{id}

Delete a pos profile user

Permanently deletes a pos profile user. This cannot be undone.

Path parameters

id string required

The identifier of the pos profile user to delete.

Returns

Returns a confirmation that the pos profile user has been deleted.

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

Reorder pos profile users

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

Returns

Returns the reordered list.

POST /api/accounts/p-o-s-profile-user/reorder 
curl https://api.overplane.dev/api/accounts/p-o-s-profile-user/reorder \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "p-o-s-profile-user_abc123",
  "idx": 1,
  "pos_profile_id": "pos_profile_id_example",
  "default": false,
  "user": "user_example"
}