How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

vivenu pos API

The pos API from vivenu — 21 operation(s) for pos.

vivenu pos API is one of 73 APIs that vivenu publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Point-of-Sale. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 23 operations across 21 paths, and defines 23 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against 2 base URLs: https://vivenu.com, https://vivenu.dev.

23 operations 21 paths 23 schemas 18 GET4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://vivenu.com/api
Authentication
HTTP Bearer, API Key, HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 4

vivenu pos API declares 4 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (jwt). An API key is passed in the header as Authorization (apikey). It accepts HTTP bearer tokens (JWT) (customer-jwt). An API key is passed in the header as Authorization (orgApiKey).

Paths & Operations 23

Across 21 paths, the API surfaces 23 operations — 18 GET, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

pos 23
GET
/api/pos
Get all POS
get_all_pos 3 params → 200400401
POST
/api/pos
Create a POS
create_a_pos body → 201400401
GET
/api/posinfo
Get all POS Infos
get_all_pos_infos 5 params → 200400401
GET
/api/pos/{id}
Get POS
get_pos 1 param → 200400401404
PUT
/api/pos/{id}
Update POS
update_pos 1 param body → 200400401404
GET
/api/posinfo/{id}
Get POS Info
get_pos_info 1 param → 200400401404
GET
/api/pos/payments/gateways
Get the IDs and the types of all active POS payment gateways
get_the_i_ds_and_the_types_of_all_active_pos_payment_gateways → 200400401
GET
/api/pos/{id}/scannable
Get scannable information for a code
get_scannable_information_for_a_code 2 params → 200400401
GET
/api/pos/{id}/xreport
Get X report
get_x_report 1 param → 200400401
GET
/api/pos/{id}/status
Get POS Status
get_pos_status 1 param → 200400401
GET
/api/pos/{id}/sessions
Get POS sessions
get_pos_sessions 1 param → 200400401
GET
/api/pos/{id}/fiscalization-info
Get POS fiscalization info
get_pos_fiscalization_info 1 param → 200400401404
GET
/api/pos/{id}/logs
Get POS journal logs
get_pos_journal_logs 5 params → 200400401404
GET
/api/pos/{id}/events
Get pos events
get_pos_events 15 params → 200400401404
GET
/api/pos/{id}/export/orderdiscounts
Export POS order discounts
export_pos_order_discounts 3 params → 200400401404
GET
/api/pos/{id}/export/orders
Export POS orders
export_pos_orders 3 params → 200400401404
GET
/api/pos/{id}/export/journallogs
Export POS journal logs
export_pos_journal_logs 3 params → 200400401404
GET
/api/pos/{id}/zreport/{reportId}
Get Z report
get_z_report 2 params → 200400401404
GET
/api/pos/{id}/export/cancellations
Export POS cancellations
export_pos_cancellations 3 params → 200400401404
GET
/api/pos/{id}/export/orderitems
Export POS order items
export_pos_order_items 3 params → 200400401404
POST
/api/pos/{id}/disable
Disable POS
disable_pos 1 param → 200400401404
POST
/api/pos/{id}/close
Close a POS session
close_a_pos_session 1 param → 200400401
POST
/api/pos/{id}/open
Open a POS session
open_a_pos_session 1 param body → 200400401

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are POSListingEventResource (41 properties), CouponSingleResource (32 properties), POSCloseSessionResource (15 properties), POSWithStatusResource (13 properties). Each schema is shown below with its type and property counts.

POSInfoResource
object
7 properties 7 required
GET_Pos_GetScannableInformationForACode_200_response
POSResource
object
11 properties 5 required
CouponWithSeriesResource
object
9 properties 2 required
POST_Pos_OpenAPosSession
object
1 property
GET_Pos_GetTheIDsAndTheTypesOfAllActivePosPaymentGateways_200_response
object
1 property
CouponResource
POSListingEventResource
object
41 properties 5 required
GET_Pos_GetAllPos_200_response
array
GET_Pos_GetPosJournalLogs_200_response
object
2 properties
POSCloseSessionResource
object
15 properties 4 required
PUT_Pos_UpdatePos
object
5 properties 4 required
GET_Pos_GetAllPosInfos_200_response
object
2 properties
CouponSingleResource
object
32 properties 1 required
POST_Pos_CreateAPos
object
3 properties 2 required
POSWithStatusResource
object
13 properties 5 required
POSJournalLogResource
object
8 properties 4 required
PublicVoucherInfoResource
object
3 properties 3 required
POSSessionResource
object
12 properties 4 required
FiscalizationDataResource
Fiscalization data
GET_Pos_GetPosSessions_200_response
array
POSOpenSessionResource
object
1 property
GET_Pos_GetPosEvents_200_response
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vivenu-pos-api-openapi.yml Raw ↑

Other APIs vivenu publishes across the network.

vivenu access-lists API
vivenu accessusers API
vivenu api API
vivenu api_keys API
vivenu attributes API
vivenu auth API
vivenu billing API
vivenu bundles API
vivenu cancellations API
vivenu channels API
vivenu chargebacks API
vivenu checkout API
Where this information came from

This is an independent, third-party profile of vivenu pos API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.