Get POS Shift Session

Production

https://{{subdomain}}.daftra.com/api2

GET

/pos_shifts{format}

Returns the configuration for the currently open POS shift session — the data a point-of-sale client needs to bootstrap a session: the active language and default payment method, the session's branch and store, the cashier, cash-in/cash-out links, and a set of capability and feature flags derived from your permissions and account settings.

The session is identified by the open shift bound to your authenticated session, or by the Posshift request header carrying the POS shift session id when no session binding exists.

Returns 200 only when the shift is open and you are allowed to access it (you opened it and may open your own sessions, or you may open all sessions). Some members of Shift appear only when the related feature is enabled — the embedded-barcode lengths when embedded barcodes are configured, and the insurance members when the Insurance feature is active.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Header Params

Responses

🟢200OK

application/json

The open POS shift session configuration.

Bodyapplication/json

🟠401Unauthorized

🟠403Forbidden

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https://.daftra.com/api2/pos_shifts.json' \
--header 'Posshift: 2' \
--header 'Accept: application/json' \
--header 'apikey: ' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json'

Response Example

200 - Example 1

{
    "result": "successful",
    "code": 200,
    "data": {
        "Shift": {
            "lang": "en",
            "default_payment": "cash",
            "multiple_addresses_enabled": false,
            "branch_id": 1,
            "shift_id": 12,
            "staff_id": 0,
            "staff_name": "Owner",
            "store_id": 1,
            "cash_in_url": "https://{subdomain}.daftra.com/owner/pos_shift_transactions/view_session/12?action=cash_in",
            "cash_out_url": "https://{subdomain}.daftra.com/owner/pos_shift_transactions/view_session/12?action=cash_out",
            "can_edit_price": true,
            "can_add_discount": true,
            "can_add_invoice_details": true,
            "check_offers": false,
            "disable_shipping": false,
            "stop_selling_expired_items": false,
            "share_products": true,
            "enable_log_rocket": false,
            "show_tracking": false,
            "disable_tracking_products": true,
            "embedded_barcode_length": 13,
            "embedded_product_barcode_length": 5,
            "applyInsurance": true,
            "insuranceAgents": {},
            "insuranceAgentClasses": {}
        }
    }
}

List Shipping Options

API Improvements