Skip to main content
POST
Create register

Authorizations

Authorization
string
header
required

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

Headers

X-OpenFiskal-Merchant
string
required

Merchant identifier returned by the merchants resource.

Body

application/json
location_id
string
required

ID of the location this register belongs to

Example:

"loc_abc123"

name
string
required
Example:

"Register 1"

external_id
string

Your own identifier for this register

Example:

"POS-001"

Response

Register created

id
string
required
merchant_id
string
required
location_id
string
required
name
string
required
status
enum<string>
required
Available options:
active,
inactive
fiscalization_status
enum<string>
required
Available options:
not_fiscalized,
pending,
failed,
fiscalized,
decommissioned
created_at
string<date-time>
required
external_id
string | null
fiscalization
object | null