POST
Add a seller
Company space For: Manager · Permission: sellers.create Conditions
  • Exactly one of agent_id or user_profile_id must be sent; the person must belong to the current company.
  • The person cannot already be a direct seller (not tied to a register) of the company.
Part of Sellers and cashiers.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

response
enum<string>
default:none

Response mode. Default none; none answers 204 No Content.

Available options:
none,
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, sellable_id, status, linear_pos, cash_register_id, created_at, updated_at.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: sellable.

Body

application/json
agent_id
string | null

Identifier of the agent to add as seller. Required when user_profile_id is not sent, and cannot be sent with it. The agent must belong to the company and not already be a direct seller.

Required string length: 27
user_profile_id
string | null

Identifier of the user profile to add as seller. Required when agent_id is not sent. Must belong to the company and not already be a direct seller.

Required string length: 27
linear_pos
boolean

Whether the seller uses the linear POS layout. Defaults to false.

Response

Resource (only with response=resource).

id

Identifier of the seller record (27-character KSUID string).

sellable_id

Identifier of the person who is the seller: an agent account or a user profile of the company.

status

active (can create orders) or inactive.

linear_pos
boolean

Whether the seller uses the linear POS layout.

sellable
object | null

Identity of the person behind the seller (first_name, last_name, username). Only present when requested with include.

cash_register_id

Identifier of the register the seller is tied to. Null for a direct seller, outside any register.

created_at

Date and time the record was created (ISO 8601, UTC).

updated_at

Date and time the record was last changed (ISO 8601, UTC).