vivenu sellers API
The sellers API from vivenu — 11 operation(s) for sellers.
OpenAPI Specification
openapi: 3.0.3
info:
title: vivenu access-lists sellers API
description: vivenu API Documentation
version: 1.0.0
contact:
name: vivenu GmbH
url: https://vivenu.com
servers:
- url: https://vivenu.com
description: Production API
- url: https://vivenu.dev
description: Staging API
tags:
- name: sellers
paths:
/api/sellers:
get:
security:
- jwt: []
- orgApiKey: []
parameters:
- name: top
required: false
schema:
type: number
format: float
default: 25
metas: {}
in: query
style: form
explode: true
- name: skip
required: false
schema:
type: number
format: float
metas: {}
in: query
style: form
explode: true
- name: name
required: false
schema:
type: string
metas: {}
in: query
style: form
explode: true
- name: orgId
required: false
schema:
type: string
metas: {}
in: query
style: form
explode: true
- name: status
required: false
schema:
type: string
enum:
- ACTIVE
- DISABLED
metas: {}
in: query
style: form
explode: true
- name: createdAt
required: false
schema:
type: object
properties:
$gt:
type: string
format: date-time
description: value is greater than
metas: {}
$gte:
type: string
format: date-time
description: value is greater than or equal
metas: {}
$lt:
type: string
format: date-time
description: value is less than
metas: {}
$lte:
type: string
format: date-time
description: value is less than or equal
metas: {}
$eq:
type: string
format: date-time
description: value is equal
metas: {}
$ne:
type: string
format: date-time
description: value is not equal
metas: {}
metas: {}
in: query
style: deepObject
explode: true
- name: updatedAt
required: false
schema:
type: object
properties:
$gt:
type: string
format: date-time
description: value is greater than
metas: {}
$gte:
type: string
format: date-time
description: value is greater than or equal
metas: {}
$lt:
type: string
format: date-time
description: value is less than
metas: {}
$lte:
type: string
format: date-time
description: value is less than or equal
metas: {}
$eq:
type: string
format: date-time
description: value is equal
metas: {}
$ne:
type: string
format: date-time
description: value is not equal
metas: {}
metas: {}
in: query
style: deepObject
explode: true
responses:
'200':
description: OK
'400':
description: Bad Request
'401':
description: Unauthorized
tags:
- sellers
description: Get all Sellers
operationId: get_all_sellers
post:
security:
- jwt: []
- orgApiKey: []
parameters: []
responses:
'201':
description: Created
'400':
description: Bad Request
'401':
description: Unauthorized
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/POST_Sellers_CreateASeller'
tags:
- sellers
description: Create a Seller
operationId: create_a_seller
/api/sellers/me:
get:
security:
- jwt: []
- apikey: []
parameters: []
responses:
'200':
description: OK
'401':
description: Unauthorized
tags:
- sellers
description: Get Seller by user
operationId: get_seller_by_user
/api/sellers/{id}:
get:
security:
- jwt: []
- orgApiKey: []
parameters:
- name: id
required: true
schema:
oneOf:
- type: string
length: 24
metas: {}
- type: string
pattern: ^[a-z]+_.*$
metas: {}
metas: {}
in: path
responses:
'200':
description: OK
'400':
description: Bad Request
'401':
description: Unauthorized
'404':
description: Not Found
tags:
- sellers
description: Get a Seller
operationId: get_a_seller
put:
security:
- jwt: []
- apikey: []
parameters:
- name: id
required: true
schema:
oneOf:
- type: string
length: 24
metas: {}
- type: string
pattern: ^[a-z]+_.*$
metas: {}
metas: {}
in: path
responses:
'200':
description: OK
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PUT_Sellers_UpdateASeller'
tags:
- sellers
description: Update a Seller
operationId: update_a_seller
/api/sellers/info/{id}:
get:
parameters:
- name: locale
required: false
schema:
type: string
description: Get the info for a specific language
metas: {}
in: query
style: form
explode: true
- name: id
required: true
schema:
type: string
metas: {}
in: path
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GET_Sellers_GetSellerInfo_200_response'
'400':
description: Bad Request
'404':
description: Not Found
tags:
- sellers
description: Get Seller info
operationId: get_seller_info
/api/sellers/{id}/vitals:
get:
security:
- jwt: []
parameters:
- name: from
required: false
schema:
type: string
format: date-time
description: An ISO timestamp to filter relevant objects created on or after this date
metas: {}
in: query
style: form
explode: true
- name: to
required: false
schema:
type: string
format: date-time
description: An ISO timestamp to filter relevant objects created on or before this date
metas: {}
in: query
style: form
explode: true
- name: id
required: true
schema:
oneOf:
- type: string
length: 24
metas: {}
- type: string
pattern: ^[a-z]+_.*$
metas: {}
metas: {}
in: path
responses:
'200':
description: OK
'400':
description: Bad Request
'401':
description: Unauthorized
'404':
description: Not Found
tags:
- sellers
description: Get Seller Vitals
operationId: get_seller_vitals
/api/public/sellers/{id}/payment-methods:
get:
parameters:
- name: channel
required: false
schema:
type: string
enum:
- online
- subscription
description: Channel of the payment
metas: {}
in: query
style: form
explode: true
- name: id
required: true
schema:
oneOf:
- type: string
length: 24
metas: {}
- type: string
pattern: ^[a-z]+_.*$
metas: {}
description: Id of the seller
metas: {}
in: path
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GET_Methods_GetSellersPaymentMethods_200_response'
'400':
description: Bad Request
tags:
- sellers
description: Get Sellers Payment Methods
operationId: get_sellers_payment_methods
/api/sellers/{id}/fiscalization/initialize:
post:
security:
- jwt: []
parameters:
- name: id
required: true
schema:
oneOf:
- type: string
length: 24
metas: {}
- type: string
pattern: ^[a-z]+_.*$
metas: {}
metas: {}
in: path
responses:
'200':
description: OK
'400':
description: Bad Request
'401':
description: Unauthorized
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/POST_Sellers_InitializeFiscalizationOfASeller'
tags:
- sellers
description: Initialize Fiscalization of a Seller
operationId: initialize_fiscalization_of_a_seller
/api/sellers/{id}/product-plans/{planId}/deactivate:
post:
security:
- jwt: []
parameters:
- name: id
schema:
type: string
description: Seller ID
description: Seller ID
in: path
required: true
- name: planId
schema:
type: string
enum:
- vivenu-engage
description: Product Plan ID
description: Product Plan ID
in: path
required: true
responses:
'200':
description: OK
'400':
description: Bad Request
'401':
description: Unauthorized
tags:
- sellers
description: Deactivate a product plan for a seller
operationId: deactivate_a_product_plan_for_a_seller
/api/sellers/{id}/product-plans/{planId}/activate:
post:
security:
- jwt: []
parameters:
- name: id
schema:
type: string
description: Seller ID
description: Seller ID
in: path
required: true
- name: planId
schema:
type: string
enum:
- vivenu-engage
description: Product Plan ID
description: Product Plan ID
in: path
required: true
responses:
'200':
description: OK
'400':
description: Bad Request
'401':
description: Unauthorized
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
discount:
description: Discount percentage (0-1)
type: number
minimum: 0
maximum: 1
additionalProperties: false
tags:
- sellers
description: Activate a product plan for a seller
operationId: activate_a_product_plan_for_a_seller
/api/sellers/{id}/consents:
patch:
security:
- jwt: []
parameters:
- name: id
required: true
schema:
oneOf:
- type: string
length: 24
metas: {}
- type: string
pattern: ^[a-z]+_.*$
metas: {}
metas: {}
in: path
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PATCH_Sellers_UpdateConsentInformation_200_response'
'400':
description: Bad Request
'401':
description: Unauthorized
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PATCH_Sellers_UpdateConsentInformation'
tags:
- sellers
description: Update consent information
operationId: update_consent_information
/api/sellers/{id}/modules:
patch:
security:
- jwt: []
parameters:
- name: id
required: true
schema:
oneOf:
- type: string
length: 24
metas: {}
- type: string
pattern: ^[a-z]+_.*$
metas: {}
metas: {}
in: path
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PATCH_Sellers_UpdateModules_200_response'
'400':
description: Bad Request
'401':
description: Unauthorized
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PATCH_Sellers_UpdateModules'
tags:
- sellers
description: Update modules
operationId: update_modules
components:
schemas:
GET_Sellers_GetSellerInfo_200_response:
type: object
properties:
_id:
type: string
description: The ID of the seller
orgId:
type: string
name:
type: string
description: The name of the seller
description:
type: string
description: The description of the seller
locationName:
type: string
locationStreet:
type: string
locationCity:
type: string
locationPostal:
type: string
locationCountry:
type: string
image:
type: string
description: The logo of the seller
darkImage:
type: string
description: The logo of the seller in dark mode
backgroundImage:
type: string
agb:
type: string
modules:
type: object
properties:
accounts:
type: boolean
customBranding:
type: boolean
entryPermissions:
type: boolean
support:
type: boolean
purchaseIntents:
type: boolean
externalPaymentMethods:
type: boolean
hardtickets:
type: boolean
pos:
type: boolean
products:
type: boolean
seatmaps:
type: boolean
webhooks:
type: boolean
customLegalDocs:
type: boolean
stay22:
type: boolean
multiLanguageData:
type: boolean
domains:
type: boolean
dynamicFees:
type: boolean
eventSeries:
type: boolean
appDeveloper:
type: boolean
description: A Hashmap which modules are enabled.
privacy:
type: string
imprint:
type: string
url:
type: string
website:
type: string
supportUrl:
type: string
description: An url to a custom support page of the seller
accentColor:
type: string
localeSettings:
type: object
properties:
defaultLanguage:
type: string
enum:
- de
- de-CH
- en
- en-GB
- en-AU
- fr
- es
- es-MX
- is
- it
- ru
- pt
- tr
- nb
- nl
- pl
- sv
- sl
- da
- cs
- lv
- he
- ar
- th
- ko
- ja
- zh-TW
default: de
timezone:
type: string
default: Europe/Amsterdam
timeFormatPreference:
type: string
enum:
- browser
- enforceMeridiemFormat
- enforceMilitaryFormat
default: browser
required:
- defaultLanguage
- timezone
- timeFormatPreference
legalSettings:
type: object
properties:
ticketTransfer:
type: object
properties:
strategy:
type: string
enum:
- notAllowed
- allowedResaleOnPlatform
- allowedWithRestrictions
ticketPriceCapped:
type: boolean
noCommercialDistribution:
type: boolean
withPenalty:
type: boolean
cancellation:
type: object
properties:
noMajorChangesToEvent:
type: object
properties:
strategy:
type: string
enum:
- notAllowed
- cancellationAllowed
- exchangeAllowed
cancellationDaysLimit:
type: number
format: float
exchangeDaysLimit:
type: number
format: float
voucherMonthsLimit:
type: number
format: float
withPenalty:
type: boolean
withMajorChangesToEvent:
type: object
properties:
strategy:
type: string
customTextConfig:
type: object
description: A Hashmap of custom text configuration for some actions.
shopSettings:
type: object
currency:
type: string
enum:
- EUR
- USD
- GBP
- AUD
- CHF
- THB
- ILS
- COP
- MXN
- DKK
- NOK
- SEK
- QAR
- CAD
- ISK
- GTQ
- INR
- DOP
- SGD
- PLN
- SAR
- TTD
- ZAR
- KYD
- HKD
- CZK
- KRW
- JPY
- NZD
- AED
- MAD
- TWD
- BRL
- BWP
- NAD
- KES
- SCR
- TRY
- SZL
- LSL
- TZS
- UGX
- ZMW
- ZWG
- GHS
- NGN
- SLE
- LRD
- XOF
- XAF
- GEL
- IDR
- ARS
- CRC
- HUF
- EGP
- MYR
- VND
- PHP
description: The currency for the seller.
default: EUR
dataRequestSettings:
type: object
properties:
capturePhoneNumber:
type: boolean
description: Wheter to capture phone number during checkout
allowDifferentDeliveryAddress:
type: boolean
description: Wheter to allow customers enter different delivery address during checkout
fulfillmentTypes:
type: array
items:
type: object
properties:
_id:
type: string
description: The ID of the fulfillment type.
name:
type: string
minLength: 3
description: The name of the fulfillment type.
description:
type: string
nullable: true
description: The name of the fulfillment type.
type:
type: string
enum:
- NONE
- PICK_UP
- SHIPPING
description: The delivery type of the fulfillment type
fee:
type: object
properties:
type:
type: string
enum:
- onTransaction
- onCheckout
description: "The mode of the fee calculation.\n onTransaction = add fee to each transaction.\n onCheckout = split fee proportionally over transactions."
default: onTransaction
var:
type: number
format: float
minimum: 0
description: The percentage value of fee to be applied.
fix:
type: number
format: float
minimum: 0
description: The fix value of fee to be applied.
required:
- type
description: The price configuration of the fulfillment type.
deliveryDeadline:
type: object
properties:
target:
type: string
nullable: true
description: The target of the relative date
unit:
type: string
enum:
- hours
- days
- weeks
- months
- years
description: The unit in which the offset is specified
offset:
type: integer
description: The offset to the date
required:
- unit
- offset
description: A relatve date specification until fulfillment will be delivered.
availableCountries:
type: array
items:
type: string
description: The array of countries to which delivery is possible. An empty lists makes the method available to all countries. An ISO 3166 country code.
default: []
taxServiceTypeId:
type: string
nullable: true
description: The ID of the tax service type
discountable:
type: boolean
description: Whether the fulfillment type is discountable.
default: true
required:
- _id
- name
- type
description: Fulfillment types
brandingSettings:
type: object
properties:
customBrandingEnabled:
type: boolean
shopLogoUrl:
type: string
customLogo:
type: string
walletLogo:
type: string
walletBackgroundColor:
type: string
googleWalletLogo:
type: string
documentSettings:
type: object
properties:
image:
type: string
taxSetting:
type: object
properties:
taxCalculationMethod:
type: string
enum:
- inclusive
- exclusive
showTaxDetails:
type: boolean
required:
- _id
- name
PATCH_Sellers_UpdateConsentInformation_200_response:
type: object
properties:
_id:
type: string
description: The ID of the seller
orgId:
type: string
name:
type: string
description: The name of the seller
description:
type: string
description: The description of the seller
locationName:
type: string
locationStreet:
type: string
locationCity:
type: string
locationPostal:
type: string
locationCountry:
type: string
imprint:
type: string
outerChargeVar:
type: number
format: float
innerChargeVar:
type: number
format: float
posChargeVar:
type: number
format: float
posOuterChargeVar:
type: number
format: float
outerChargeFix:
type: number
format: float
innerChargeFix:
type: number
format: float
cartOuterChargeFix:
type: number
format: float
cartInnerChargeFix:
type: number
format: float
freeCartOuterChargeFix:
type: number
format: float
freeCartInnerChargeFix:
type: number
format: float
posChargeFix:
type: number
format: float
posOuterChargeFix:
type: number
format: float
paymentChargeVar:
type: number
format: float
paymentChargeMin:
type: number
format: float
internationalPaymentFeeVar:
type: number
format: float
businessPaymentFeeVar:
type: number
format: float
internationalBusinessPaymentFeeVar:
type: number
format: float
paymentMethodFees:
type: object
rebookingOuterChargeFix:
type: number
format: float
active:
type: boolean
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
image:
type: string
description: The logo of the seller
darkImage:
type: string
description: The logo of the seller in dark mode
backgroundImage:
type: string
accentColor:
type: string
website:
type: string
supportUrl:
type: string
description: An url to a custom support page of the seller
payment:
type: object
agb:
type: string
privacy:
type: string
taxSetting:
type: object
properties:
taxRate:
type: number
format: float
default: 0.19
taxId:
type: string
localTaxName:
type: string
createInvoiceAfterTransaction:
type: boolean
default: true
sendTaxInvoiceToCustomer:
type: boolean
serviceTypes:
type: array
items:
type: object
properties:
default:
type: boolean
name:
type: string
taxes:
type: array
items:
type: object
properties:
taxTypeId:
type: string
taxRate:
type: number
format: float
taxPayableAccountId:
type: string
proceedsAccountId:
type: string
exceptions:
type: array
items:
type: object
properties:
name:
type: string
buyerGroup:
type: string
enum:
- All
- B2B
- B2C
regionId:
type: string
invoiceText:
type: string
taxes:
type: array
items:
type: object
properties:
taxTypeId:
type: string
taxRate:
type: number
format: float
taxPayableAccountId:
type: string
proceedsAccountId:
type: string
taxTypes:
type: array
items:
type: object
properties:
name:
type: string
accounts:
type: array
items:
type: object
properties:
name:
type: string
code:
type: string
type:
type: string
regions:
type: array
items:
type: object
properties:
name:
type: string
codes:
type: array
items:
type: string
taxCalculationMethod:
type: string
enum:
- inclusive
- exclusive
showTaxDetails:
type: boolean
url:
type: string
customFieldsConfig:
type: object
shopSettings:
type: object
documentSettings:
type: object
properties:
image:
type: string
invoice:
type: object
properties:
footerColumns:
type: array
items:
type: object
properties:
text:
type: string
active:
type: boolean
mailingSettings:
type: object
consents:
type: object
properties:
apiTerms:
type: object
properties:
consent:
type: boolean
consentAt:
type: string
format: date-time
ip:
type: string
modules:
type: object
properties:
accounts:
type: boolean
customBranding:
type: boolean
entryPermissions:
type: boolean
support:
type: boolean
purchaseIntents:
type: boolean
externalPaymentMethods:
type: boolean
hardtickets:
type: boolean
pos:
type: boolean
products:
type: boolean
seatmaps:
type: boolean
webhooks:
type: boolean
customLegalDocs:
type: boolean
stay22:
type: boolean
multiLanguageData:
type: boolean
domains:
type: boolean
dynamicFees:
type: boolean
eventSeries:
type: boolean
appDeveloper:
type: boolean
description: A Hashm
# --- truncated at 32 KB (101 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/vivenu/refs/heads/main/openapi/vivenu-sellers-api-openapi.yml