redocly logo API docs by Redocly

plenigo partner API v1 (PAPI.240827-MINOR)

Download OpenAPI specification:Download

URL: https://github.com/plenigo/plenigo-doc

This is the OpenAPI description for accessing the plenigo partner platform.

Customers (Doo)

Get customer

Get customer that is identified by the passed customer id.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

Responses

Response samples

Content type
application/json
{
  • "customerId": "100003",
  • "username": "wild_flower",
  • "email": "wildflower@example.com",
  • "invoiceEmail": "wildflower-invoices@example.com",
  • "birthday": "2001-03-21",
  • "language": "de",
  • "mobileNumber": "+14155552671",
  • "status": "ACTIVATED",
  • "acceptedTerms": {
    }
}

Search customer's addresses

Search all addresses that correspond to the given search conditions and belong to the customer identified by the customer id provided.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

query Parameters
size
integer <int32> [ 5 .. 100 ]

amount of elements to return - if no size is provided or the size is not within range it will be automatically set to 5

startTime
string <date-time>

time the entity was changed after or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

endTime
string <date-time>

time the entity was changed before or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

startingAfter
string <= 100 characters

A cursor for use in pagination. startingAfter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include startingAfter=obj_foo in order to fetch the next result set.

endingBefore
string <= 100 characters

A cursor for use in pagination. endingBefore is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include endingBefore=obj_bar in order to fetch the previous page of the list.

sort
string <= 4 characters
Enum: "ASC" "DESC"

The sort of the search, if its desc it will revert to search for a lower startingAfter

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Events (Doo)

Refill empty wallets

Refill empty wallets related to the even list

Authorizations:
plenigoToken
path Parameters
eventListUniqueId
required
string^[0-9\-a-zA-Z]{2,30}$

unique id of the event list

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Participate event

Participate active wallets to a specific event.

Authorizations:
plenigoToken
path Parameters
eventListUniqueId
required
string^[0-9\-a-zA-Z]{2,30}$

unique id of the event list

eventListDateUniqueId
required
string^[0-9\-a-zA-Z]{2,30}$

unique id of the event list date

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Get event participants

Get all participants that participated these events.

Authorizations:
plenigoToken
path Parameters
eventListUniqueId
required
string^[0-9\-a-zA-Z]{2,30}$

unique id of the event list

eventListDateUniqueId
required
string^[0-9\-a-zA-Z]{2,30}$

unique id of the event list date

query Parameters
size
integer <int32> [ 5 .. 100 ]

amount of elements to return - if no size is provided or the size is not within range it will be automatically set to 5

startTime
string <date-time>

time the entity was changed after or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

endTime
string <date-time>

time the entity was changed before or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

startingAfter
string <= 100 characters

A cursor for use in pagination. startingAfter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include startingAfter=obj_foo in order to fetch the next result set.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Products (PO)

Return all paywall products

Get all paywall products.

Authorizations:
plenigoToken
query Parameters
customerCountry
required
string = 2 characters

ISO 3166-1 alpha-2 billing country/region code of the user

customerLanguage
required
string = 2 characters

language of the customer - two letter language code according to ISO 639-1

Responses

Response samples

Content type
application/json
{
  • "paywallOfferInfos": [
    ]
}

Get paywall product

Get a specific paywall product by plenigo offer id.

Authorizations:
plenigoToken
path Parameters
plenigoOfferId
required
string

plenigo offer id

query Parameters
customerCountry
required
string = 2 characters

ISO 3166-1 alpha-2 billing country/region code of the user

customerLanguage
required
string = 2 characters

language of the customer - two letter language code according to ISO 639-1

Responses

Response samples

Content type
application/json
{
  • "plenigoOfferId": "stringstringstringst"
}

Access Rights (PM)

Get all customer access rights

Get all access rights for a customer identified by the passed customer id.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

Responses

Response samples

Content type
application/json
{
  • "customerId": "100003",
  • "customerBlocked": false,
  • "createdDate": "2019-01-01T07:53:23.450961Z",
  • "createdBy": "PLENIGO",
  • "createdByType": "SYSTEM",
  • "changedDate": "2019-01-01T07:53:23.450961Z",
  • "changedBy": "PLENIGO",
  • "changedByType": "SYSTEM",
  • "items": [
    ]
}

Check access

Check if customer has a valid access right for one or multiple access rights identified by the provided access right unique ids.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

query Parameters
accessRightUniqueIds
required
string

comma separated ids of access right unique ids

Responses

Response samples

Content type
application/json
{
  • "customerId": "100003",
  • "customerBlocked": false,
  • "accessGranted": true,
  • "items": [
    ]
}

Login (PM)

Verify login

This functionality verifies the log in data of a customer and executes the log in. The caller must decide if a username or email address is provided for login. If both are provided only the email address will be used.

Authorizations:
plenigoToken
Request Body schema: application/json
username
string <= 100 characters

username of the customer

email
string <= 100 characters

email of the customer

password
required
string <= 100 characters

password of the customer

object (LoggingData)

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "email": "string",
  • "password": "string",
  • "loggingData": {
    }
}

Response samples

Content type
application/json
{
  • "customerId": "100003",
  • "status": "ACTIVATED"
}

Verify transfer token

This functionality verifies the session transfer token and returns the customer id and customer status.

Authorizations:
plenigoToken
query Parameters
transferToken
required
string <= 50 characters

transfer token

Responses

Response samples

Content type
application/json
{
  • "customerId": "100003",
  • "status": "ACTIVATED"
}

Products (PM)

Search access rights

Search all access rights that correspond to the given search conditions.

Authorizations:
plenigoToken
query Parameters
size
integer <int32> [ 5 .. 100 ]

amount of elements to return - if no size is provided or the size is not within range it will be automatically set to 5

startTime
string <date-time>

time the entity was changed after or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

endTime
string <date-time>

time the entity was changed before or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

startingAfter
string <= 100 characters

A cursor for use in pagination. startingAfter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include startingAfter=obj_foo in order to fetch the next result set.

endingBefore
string <= 100 characters

A cursor for use in pagination. endingBefore is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include endingBefore=obj_bar in order to fetch the previous page of the list.

sort
string <= 4 characters
Enum: "ASC" "DESC"

The sort of the search, if its desc it will revert to search for a lower startingAfter

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Access Rights (SL)

Get all customer access rights

Get all access rights for a customer identified by the passed customer id.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

Responses

Response samples

Content type
application/json
{
  • "customerId": "100003",
  • "customerBlocked": false,
  • "createdDate": "2019-01-01T07:53:23.450961Z",
  • "createdBy": "PLENIGO",
  • "createdByType": "SYSTEM",
  • "changedDate": "2019-01-01T07:53:23.450961Z",
  • "changedBy": "PLENIGO",
  • "changedByType": "SYSTEM",
  • "items": [
    ]
}

Check access

Check if customer has a valid access right for one or multiple access rights identified by the provided access right unique ids.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

query Parameters
accessRightUniqueIds
required
string

comma separated ids of access right unique ids

Responses

Response samples

Content type
application/json
{
  • "customerId": "100003",
  • "customerBlocked": false,
  • "accessGranted": true,
  • "items": [
    ]
}

App Stores (SL)

Search Apple purchases

Search all Apple purchases that correspond to the given search conditions.

Authorizations:
plenigoToken
query Parameters
size
integer <int32> [ 5 .. 100 ]

amount of elements to return - if no size is provided or the size is not within range it will be automatically set to 5

startTime
string <date-time>

time the entity was changed after or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

endTime
string <date-time>

time the entity was changed before or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

startingAfter
string <= 100 characters

A cursor for use in pagination. startingAfter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include startingAfter=obj_foo in order to fetch the next result set.

endingBefore
string <= 100 characters

A cursor for use in pagination. endingBefore is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include endingBefore=obj_bar in order to fetch the previous page of the list.

sort
string <= 4 characters
Enum: "ASC" "DESC"

The sort of the search, if its desc it will revert to search for a lower startingAfter

token
string

app store token

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Add Apple purchase

Add an Apple app store purchase to the plenigo system and retrieve a token for further processing.

Authorizations:
plenigoToken
Request Body schema: application/json
appIdentifier
string <= 100 characters

identifier of the application as defined in the plenigo backend to retrieve the according secret

receiptData
Array of strings [ 1 .. 100 ] items [ items <= 10000 characters ]

Responses

Request samples

Content type
application/json
{
  • "appIdentifier": "string",
  • "receiptData": [
    ]
}

Response samples

Content type
application/json
{
  • "customerId": "string",
  • "token": "string",
  • "hasOrders": true,
  • "orders": [
    ]
}

Get Apple purchase

Get details for an Apple app store purchase.

Authorizations:
plenigoToken
path Parameters
appleAppStorePurchaseId
required
integer <int64>

unique id of the purchase

Responses

Response samples

Content type
application/json
{
  • "appleAppStorePurchaseId": 0,
  • "purchaseDate": "2019-08-24T14:15:22Z",
  • "token": "string",
  • "valid": true,
  • "appStoreOrderId": 0,
  • "receipt": {
    },
  • "purchaseData": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "changedDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "createdByType": "API",
  • "changedBy": "string",
  • "changedByType": "API"
}

Associate Apple purchase

Associate an Apple app store purchase with a customer. Only app store purchases that include actual orders can be associated.

Authorizations:
plenigoToken
path Parameters
token
required
string

unique id of the purchase of an app store

Request Body schema: application/json
customerId
string^[0-9]{1,18}$

id of the customer to associate purchase with

Responses

Request samples

Content type
application/json
{
  • "customerId": "string"
}

Response samples

Content type
application/json
{
  • "customerId": "string",
  • "token": "string",
  • "hasOrders": true,
  • "orders": [
    ]
}

Dissociate Apple purchase

Dissociate an Apple app store purchase from a customer.

Authorizations:
plenigoToken
path Parameters
token
required
string

unique id of the purchase of an app store

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Verify Apple purchase

Verify validity of Apple app store purchase.

Authorizations:
plenigoToken
path Parameters
token
required
string

unique id of the purchase of an app store

Responses

Response samples

Content type
application/json
{
  • "customerId": "string",
  • "token": "string",
  • "hasOrders": true,
  • "orders": [
    ]
}

Search Google Playstore purchases

Search all Google Playstore purchases that correspond to the given search conditions.

Authorizations:
plenigoToken
query Parameters
size
integer <int32> [ 5 .. 100 ]

amount of elements to return - if no size is provided or the size is not within range it will be automatically set to 5

startTime
string <date-time>

time the entity was changed after or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

endTime
string <date-time>

time the entity was changed before or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

startingAfter
string <= 100 characters

A cursor for use in pagination. startingAfter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include startingAfter=obj_foo in order to fetch the next result set.

endingBefore
string <= 100 characters

A cursor for use in pagination. endingBefore is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include endingBefore=obj_bar in order to fetch the previous page of the list.

sort
string <= 4 characters
Enum: "ASC" "DESC"

The sort of the search, if its desc it will revert to search for a lower startingAfter

token
string

app store token

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Add Google purchase

Add a Google Playstore purchase to the plenigo system and retrieve a token for further processing.

Authorizations:
plenigoToken
Request Body schema: application/json
packageName
string <= 1000 characters

package name of the application this purchase was done for (for example, 'com.some.thing').

Array of objects (GooglePlayStorePurchaseAdditionElement) [ 1 .. 100 ] items

Responses

Request samples

Content type
application/json
{
  • "packageName": "string",
  • "receiptData": [
    ]
}

Response samples

Content type
application/json
{
  • "customerId": "string",
  • "token": "string",
  • "hasOrders": true,
  • "orders": [
    ]
}

Get Google Playstore purchase

Get details for a Google Playstore purchase.

Authorizations:
plenigoToken
path Parameters
googlePlayStorePurchaseId
required
integer <int64>

unique id of the purchase

Responses

Response samples

Content type
application/json
{
  • "googlePlayStorePurchaseId": 0,
  • "purchaseDate": "2019-08-24T14:15:22Z",
  • "token": "string",
  • "packageName": "string",
  • "productId": "string",
  • "valid": true,
  • "subscription": true,
  • "purchaseToken": "string",
  • "appStoreOrderId": 0,
  • "subscriptionPurchase": {
    },
  • "productPurchase": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "changedDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "createdByType": "API",
  • "changedBy": "string",
  • "changedByType": "API"
}

Associate Google purchase

Associate a Google Playstore purchase with a customer.

Authorizations:
plenigoToken
path Parameters
token
required
string

unique id of the purchase of an app store

Request Body schema: application/json
customerId
string^[0-9]{1,18}$

id of the customer to associate purchase with

Responses

Request samples

Content type
application/json
{
  • "customerId": "string"
}

Response samples

Content type
application/json
{
  • "customerId": "string",
  • "token": "string",
  • "hasOrders": true,
  • "orders": [
    ]
}

Dissociate Google purchase

Dissociate a Google Playstore purchase from a customer.

Authorizations:
plenigoToken
path Parameters
token
required
string

unique id of the purchase of an app store

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Verify Google purchase

Verify validity of Google Playstore purchase.

Authorizations:
plenigoToken
path Parameters
token
required
string

unique id of the purchase of an app store

Responses

Response samples

Content type
application/json
{
  • "customerId": "string",
  • "token": "string",
  • "hasOrders": true,
  • "orders": [
    ]
}

Search app store order

Search all app store orders that correspond to the given search conditions.

Authorizations:
plenigoToken
query Parameters
size
integer <int32> [ 5 .. 100 ]

amount of elements to return - if no size is provided or the size is not within range it will be automatically set to 5

startTime
string <date-time>

time the entity was changed after or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

endTime
string <date-time>

time the entity was changed before or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

startingAfter
string <= 100 characters

A cursor for use in pagination. startingAfter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include startingAfter=obj_foo in order to fetch the next result set.

endingBefore
string <= 100 characters

A cursor for use in pagination. endingBefore is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include endingBefore=obj_bar in order to fetch the previous page of the list.

sort
string <= 4 characters
Enum: "ASC" "DESC"

The sort of the search, if its desc it will revert to search for a lower startingAfter

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get app store order

Get details for an app store order.

Authorizations:
plenigoToken
path Parameters
appStoreOrderId
required
integer <int64>

unique id of the app store order

Responses

Response samples

Content type
application/json
{
  • "appStoreOrderId": 0,
  • "orderDate": "2019-08-24T14:15:22Z",
  • "customerId": "string",
  • "storeType": "APPSTORE",
  • "additionalStoreData": {
    },
  • "items": [
    ],
  • "createdDate": "2019-08-24T14:15:22Z",
  • "changedDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "createdByType": "API",
  • "changedBy": "string",
  • "changedByType": "API"
}

Search app store subscription

Search all app store subscriptions that correspond to the given search conditions.

Authorizations:
plenigoToken
query Parameters
size
integer <int32> [ 5 .. 100 ]

amount of elements to return - if no size is provided or the size is not within range it will be automatically set to 5

startTime
string <date-time>

time the entity was changed after or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

endTime
string <date-time>

time the entity was changed before or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

startingAfter
string <= 100 characters

A cursor for use in pagination. startingAfter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include startingAfter=obj_foo in order to fetch the next result set.

endingBefore
string <= 100 characters

A cursor for use in pagination. endingBefore is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include endingBefore=obj_bar in order to fetch the previous page of the list.

sort
string <= 4 characters
Enum: "ASC" "DESC"

The sort of the search, if its desc it will revert to search for a lower startingAfter

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get app store subscription

Get details for an app store subscription.

Authorizations:
plenigoToken
path Parameters
appStoreSubscriptionId
required
integer <int64>

unique id of the app store subscription

Responses

Response samples

Content type
application/json
{
  • "appStoreSubscriptionId": 0,
  • "chainId": 0,
  • "externalSystemId": "string",
  • "customerId": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "cancellationDate": "2019-08-24T14:15:22Z",
  • "status": "ACTIVE",
  • "accessRightUniqueId": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "changedDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "createdByType": "API",
  • "changedBy": "string",
  • "changedByType": "API"
}

Checkout (SL)

Voucher purchase

Executes a purchase for the product represented by the provided voucher code. Only products that are completely free and have no follow up periods that must be paid can be bought that way.

Authorizations:
plenigoToken
Request Body schema: application/json
customerId
required
string^[0-9]{1,18}$

unique id of the customer the checkout is for

customerSession
string <= 10000 characters

active customer session - if a customer id is provided the customer id overrules the session

invoiceAddressId
integer <int64>

unique id of the invoice address to use

deliveryAddressId
integer <int64>

unique id of the delivery address to use

customerIpAddress
required
string <= 45 characters

ip address of the customer

object (AdditionalOrderData)
voucherCode
required
string <= 20 characters

voucher code to use

overwrittenProductId
string <= 20 characters

add a custom product id during the voucher checkout - this is only allowed for a single offer with one single purchase in it

Responses

Request samples

Content type
application/json
{
  • "customerId": "10003",
  • "customerIpAddress": "198.51.100.42",
  • "voucherCode": "1234-5678-1234"
}

Response samples

Content type
application/json
{
  • "orderId": 0
}

Customers (SL)

Search customers

Search all customers that correspond to the given search conditions.

Authorizations:
plenigoToken
query Parameters
size
integer <int32> [ 5 .. 100 ]

amount of elements to return - if no size is provided or the size is not within range it will be automatically set to 5

startTime
string <date-time>

time the entity was changed after or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

endTime
string <date-time>

time the entity was changed before or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

startingAfter
string <= 100 characters

A cursor for use in pagination. startingAfter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include startingAfter=obj_foo in order to fetch the next result set.

endingBefore
string <= 100 characters

A cursor for use in pagination. endingBefore is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include endingBefore=obj_bar in order to fetch the previous page of the list.

sort
string <= 4 characters
Enum: "ASC" "DESC"

The sort of the search, if its desc it will revert to search for a lower startingAfter

externalSystemId
string

external system id defined by third party systems

email
string <email>

email to search for

username
string

username to search for

customerMark
string
Value: "WBZ"

customer mark

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Create customer

Create a new customer with the data provided.

Authorizations:
plenigoToken
Request Body schema: application/json
customerId
string^[0-9]{1,18}$

unique id of the customer

registrationSource
string <= 100 characters

domain, website, app or other source of the customer registration

password
string <= 100 characters

password the new customer should get

sendWelcomeMail
boolean

flag indicating if welcome mail for customer should be sent

Array of objects (CustomerAddressCreation)

addresses that should be directly associated with the customer

object (AdditionalCustomerData)
pseudoEmail
boolean

flag indicating that email should be a pseudo email

processingBlocked
boolean

Flag to indicate to third party systems that the customer is blocked for further processing and should not be used for advertisement, etc. Can be used in combination with the pseudoEmail flag to handle data protection requests without deletion of a customer.

username
string <= 100 characters

selected username of the customer that is unique for all users

email
required
string <email> <= 100 characters

email address of the customer that is unique for all users

externalSystemId
string <= 100 characters

external system id - can only be set if not set yet

salutation
string
Enum: "DIVERSE" "MR" "MRS" "NONE"

salutation to identify the correct designation of a customer

firstName
string <= 100 characters

first name of the customer - first name and last name or company name are required

lastName
string <= 100 characters

last name of the customer - first name and last name or company name are required

invoiceEmail
string <email> <= 100 characters

email address of the customer where invoices should be sent to

language
required
string = 2 characters

language of the customer - two letter language code according to ISO 639-1

mobileNumber
string <= 100 characters (^\+?[1-9]\d{1,14}$|^$)

mobile number of the customer formatted as E.164

birthday
string or null <date>

birthday of the customer with full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-01

object (CustomerMiscellaneousData)

Responses

Request samples

Content type
application/json
{
  • "customerId": "100003",
  • "username": "wild_flower",
  • "email": "wildflower@example.com",
  • "invoiceEmail": "wildflower-invoices@example.com",
  • "birthday": "2001-03-21",
  • "language": "de",
  • "mobileNumber": "+14155552671",
  • "status": "ACTIVATED",
  • "addresses": [
    ],
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "customerId": "100003",
  • "externalSystemId": "1748-E",
  • "username": "wild_flower",
  • "email": "wildflower@example.com",
  • "salutation": "MR",
  • "firstName": "John",
  • "lastName": "Doe",
  • "invoiceEmail": "wildflower-invoices@example.com",
  • "birthday": "2001-03-21",
  • "language": "de",
  • "mobileNumber": "+14155552671",
  • "status": "ACTIVATED",
  • "changedDate": "2019-03-21T17:32:12Z",
  • "registrationDate": "2019-03-21T17:32:12Z",
  • "registrationSource": "www.example.com",
  • "twoFactorEnabled": false,
  • "addresses": [
    ],
  • "data": {
    }
}

Login (SL)

Verify login

This functionality verifies the log in data of a customer and executes the log in. The caller must decide if a username or email address is provided for login. If both are provided only the email address will be used.

Authorizations:
plenigoToken
Request Body schema: application/json
username
string <= 100 characters

username of the customer

email
string <= 100 characters

email of the customer

password
required
string <= 100 characters

password of the customer

object (LoggingData)

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "email": "string",
  • "password": "string",
  • "loggingData": {
    }
}

Response samples

Content type
application/json
{
  • "customerId": "100003",
  • "status": "ACTIVATED"
}

Verify transfer token

This functionality verifies the session transfer token and returns the customer id and customer status.

Authorizations:
plenigoToken
query Parameters
transferToken
required
string <= 50 characters

transfer token

Responses

Response samples

Content type
application/json
{
  • "customerId": "100003",
  • "status": "ACTIVATED"
}

Products (SL)

Search access rights

Search all access rights that correspond to the given search conditions.

Authorizations:
plenigoToken
query Parameters
size
integer <int32> [ 5 .. 100 ]

amount of elements to return - if no size is provided or the size is not within range it will be automatically set to 5

startTime
string <date-time>

time the entity was changed after or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

endTime
string <date-time>

time the entity was changed before or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

startingAfter
string <= 100 characters

A cursor for use in pagination. startingAfter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include startingAfter=obj_foo in order to fetch the next result set.

endingBefore
string <= 100 characters

A cursor for use in pagination. endingBefore is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include endingBefore=obj_bar in order to fetch the previous page of the list.

sort
string <= 4 characters
Enum: "ASC" "DESC"

The sort of the search, if its desc it will revert to search for a lower startingAfter

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Vouchers (SL)

Validate voucher code

Validates the voucher code provided.

Authorizations:
plenigoToken
path Parameters
voucherCode
required
string

voucher code to validate

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Wallets (SL)

Create credit wallet

Create credit wallet.

Authorizations:
plenigoToken
Request Body schema: application/json
uniqueId
string^[0-9\-a-zA-Z]{2,30}$

unique id of the wallet for identification

creditCount
integer <int64> [ 1 .. 100000000 ]

credit count to create wallet with

customerId
string^[0-9]{1,18}$

unique id of the customer the credit wallet belongs to

Responses

Request samples

Content type
application/json
{
  • "items": {
    }
}

Response samples

Content type
application/json
{
  • "items": {
    }
}

Search credit wallets

Search credit wallets.

Authorizations:
plenigoToken

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get credit uploads

Get credit wallet uploads.

Authorizations:
plenigoToken
query Parameters
size
integer <int32> [ 5 .. 100 ]

amount of elements to return - if no size is provided or the size is not within range it will be automatically set to 5

startTime
string <date-time>

time the entity was changed after or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

endTime
string <date-time>

time the entity was changed before or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

startingAfter
string <= 100 characters

A cursor for use in pagination. startingAfter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include startingAfter=obj_foo in order to fetch the next result set.

endingBefore
string <= 100 characters

A cursor for use in pagination. endingBefore is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include endingBefore=obj_bar in order to fetch the previous page of the list.

sort
string <= 4 characters
Enum: "ASC" "DESC"

The sort of the search, if its desc it will revert to search for a lower startingAfter

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get credit usages

Get credit wallet usages.

Authorizations:
plenigoToken
query Parameters
size
integer <int32> [ 5 .. 100 ]

amount of elements to return - if no size is provided or the size is not within range it will be automatically set to 5

startTime
string <date-time>

time the entity was changed after or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

endTime
string <date-time>

time the entity was changed before or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

startingAfter
string <= 100 characters

A cursor for use in pagination. startingAfter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include startingAfter=obj_foo in order to fetch the next result set.

endingBefore
string <= 100 characters

A cursor for use in pagination. endingBefore is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include endingBefore=obj_bar in order to fetch the previous page of the list.

sort
string <= 4 characters
Enum: "ASC" "DESC"

The sort of the search, if its desc it will revert to search for a lower startingAfter

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Refill empty wallets

Refill empty wallets related to the even list

Authorizations:
plenigoToken
path Parameters
uniqueId
required
string

unique id of the wallet

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Upload

Uploads a credit to a given credit wallet.

Authorizations:
plenigoToken
Request Body schema: application/json
customerId
string^[0-9]{1,18}$

id of the customer the credit usage should be accounted to

uniqueId
string^[0-9\-a-zA-Z]{2,30}$

unique id of the wallet to use

title
string <= 100 characters

title of upload

creditCount
integer <int64> [ 1 .. 100000000 ]

amount of credits to add

Responses

Request samples

Content type
application/json
{
  • "items": {
    }
}

Response samples

Content type
application/json
{
  • "items": {
    }
}

Use credit wallet

Uses a credit from a given credit wallet.

Authorizations:
plenigoToken
Request Body schema: application/json
customerId
required
string^[0-9]{1,18}$

id of the customer the credit usage should be accounted to

uniqueId
required
string^[0-9\-a-zA-Z]{2,30}$

unique id of the wallet to use

creditsUsed
required
integer <int64> [ 1 .. 100000 ]

amount of credits used

reason
required
string <= 100 characters

reason for credit usage

category
string <= 100 characters

category for credit usage

Responses

Request samples

Content type
application/json
{
  • "items": {
    }
}

Response samples

Content type
application/json
{
  • "items": {
    }
}

Get customer credit wallets

Get customer credit wallets.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

query Parameters
size
integer <int32> [ 5 .. 100 ]

amount of elements to return - if no size is provided or the size is not within range it will be automatically set to 5

startTime
string <date-time>

time the entity was changed after or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

endTime
string <date-time>

time the entity was changed before or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

startingAfter
string <= 100 characters

A cursor for use in pagination. startingAfter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include startingAfter=obj_foo in order to fetch the next result set.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get credit uploads by customer

Get credit wallet uploads.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

uniqueId
required
string

unique id of the wallet

query Parameters
size
integer <int32> [ 5 .. 100 ]

amount of elements to return - if no size is provided or the size is not within range it will be automatically set to 5

startTime
string <date-time>

time the entity was changed after or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

endTime
string <date-time>

time the entity was changed before or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

startingAfter
string <= 100 characters

A cursor for use in pagination. startingAfter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include startingAfter=obj_foo in order to fetch the next result set.

endingBefore
string <= 100 characters

A cursor for use in pagination. endingBefore is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include endingBefore=obj_bar in order to fetch the previous page of the list.

sort
string <= 4 characters
Enum: "ASC" "DESC"

The sort of the search, if its desc it will revert to search for a lower startingAfter

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get credit usages by customer

Get credit wallet usages.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

uniqueId
required
string

unique id of the wallet

query Parameters
size
integer <int32> [ 5 .. 100 ]

amount of elements to return - if no size is provided or the size is not within range it will be automatically set to 5

startTime
string <date-time>

time the entity was changed after or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

endTime
string <date-time>

time the entity was changed before or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

startingAfter
string <= 100 characters

A cursor for use in pagination. startingAfter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include startingAfter=obj_foo in order to fetch the next result set.

endingBefore
string <= 100 characters

A cursor for use in pagination. endingBefore is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include endingBefore=obj_bar in order to fetch the previous page of the list.

sort
string <= 4 characters
Enum: "ASC" "DESC"

The sort of the search, if its desc it will revert to search for a lower startingAfter

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Access Rights (UN)

Get all customer access rights

Get all access rights for a customer identified by the passed customer id.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

Responses

Response samples

Content type
application/json
{
  • "customerId": "100003",
  • "customerBlocked": false,
  • "createdDate": "2019-01-01T07:53:23.450961Z",
  • "createdBy": "PLENIGO",
  • "createdByType": "SYSTEM",
  • "changedDate": "2019-01-01T07:53:23.450961Z",
  • "changedBy": "PLENIGO",
  • "changedByType": "SYSTEM",
  • "items": [
    ]
}

Check access

Check if customer has a valid access right for one or multiple access rights identified by the provided access right unique ids.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

query Parameters
accessRightUniqueIds
required
string

comma separated ids of access right unique ids

Responses

Response samples

Content type
application/json
{
  • "customerId": "100003",
  • "customerBlocked": false,
  • "accessGranted": true,
  • "items": [
    ]
}

App Stores (UN)

Search Apple purchases

Search all Apple purchases that correspond to the given search conditions.

Authorizations:
plenigoToken
query Parameters
size
integer <int32> [ 5 .. 100 ]

amount of elements to return - if no size is provided or the size is not within range it will be automatically set to 5

startTime
string <date-time>

time the entity was changed after or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

endTime
string <date-time>

time the entity was changed before or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

startingAfter
string <= 100 characters

A cursor for use in pagination. startingAfter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include startingAfter=obj_foo in order to fetch the next result set.

endingBefore
string <= 100 characters

A cursor for use in pagination. endingBefore is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include endingBefore=obj_bar in order to fetch the previous page of the list.

sort
string <= 4 characters
Enum: "ASC" "DESC"

The sort of the search, if its desc it will revert to search for a lower startingAfter

token
string

app store token

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Add Apple purchase

Add an Apple app store purchase to the plenigo system and retrieve a token for further processing.

Authorizations:
plenigoToken
Request Body schema: application/json
appIdentifier
string <= 100 characters

identifier of the application as defined in the plenigo backend to retrieve the according secret

receiptData
Array of strings [ 1 .. 100 ] items [ items <= 10000 characters ]

Responses

Request samples

Content type
application/json
{
  • "appIdentifier": "string",
  • "receiptData": [
    ]
}

Response samples

Content type
application/json
{
  • "customerId": "string",
  • "token": "string",
  • "hasOrders": true,
  • "orders": [
    ]
}

Get Apple purchase

Get details for an Apple app store purchase.

Authorizations:
plenigoToken
path Parameters
appleAppStorePurchaseId
required
integer <int64>

unique id of the purchase

Responses

Response samples

Content type
application/json
{
  • "appleAppStorePurchaseId": 0,
  • "purchaseDate": "2019-08-24T14:15:22Z",
  • "token": "string",
  • "valid": true,
  • "appStoreOrderId": 0,
  • "receipt": {
    },
  • "purchaseData": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "changedDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "createdByType": "API",
  • "changedBy": "string",
  • "changedByType": "API"
}

Associate Apple purchase

Associate an Apple app store purchase with a customer. Only app store purchases that include actual orders can be associated.

Authorizations:
plenigoToken
path Parameters
token
required
string

unique id of the purchase of an app store

Request Body schema: application/json
customerId
string^[0-9]{1,18}$

id of the customer to associate purchase with

Responses

Request samples

Content type
application/json
{
  • "customerId": "string"
}

Response samples

Content type
application/json
{
  • "customerId": "string",
  • "token": "string",
  • "hasOrders": true,
  • "orders": [
    ]
}

Dissociate Apple purchase

Dissociate an Apple app store purchase from a customer.

Authorizations:
plenigoToken
path Parameters
token
required
string

unique id of the purchase of an app store

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Verify Apple purchase

Verify validity of Apple app store purchase.

Authorizations:
plenigoToken
path Parameters
token
required
string

unique id of the purchase of an app store

Responses

Response samples

Content type
application/json
{
  • "customerId": "string",
  • "token": "string",
  • "hasOrders": true,
  • "orders": [
    ]
}

Search Google Playstore purchases

Search all Google Playstore purchases that correspond to the given search conditions.

Authorizations:
plenigoToken
query Parameters
size
integer <int32> [ 5 .. 100 ]

amount of elements to return - if no size is provided or the size is not within range it will be automatically set to 5

startTime
string <date-time>

time the entity was changed after or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

endTime
string <date-time>

time the entity was changed before or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

startingAfter
string <= 100 characters

A cursor for use in pagination. startingAfter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include startingAfter=obj_foo in order to fetch the next result set.

endingBefore
string <= 100 characters

A cursor for use in pagination. endingBefore is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include endingBefore=obj_bar in order to fetch the previous page of the list.

sort
string <= 4 characters
Enum: "ASC" "DESC"

The sort of the search, if its desc it will revert to search for a lower startingAfter

token
string

app store token

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Add Google purchase

Add a Google Playstore purchase to the plenigo system and retrieve a token for further processing.

Authorizations:
plenigoToken
Request Body schema: application/json
packageName
string <= 1000 characters

package name of the application this purchase was done for (for example, 'com.some.thing').

Array of objects (GooglePlayStorePurchaseAdditionElement) [ 1 .. 100 ] items

Responses

Request samples

Content type
application/json
{
  • "packageName": "string",
  • "receiptData": [
    ]
}

Response samples

Content type
application/json
{
  • "customerId": "string",
  • "token": "string",
  • "hasOrders": true,
  • "orders": [
    ]
}

Get Google Playstore purchase

Get details for a Google Playstore purchase.

Authorizations:
plenigoToken
path Parameters
googlePlayStorePurchaseId
required
integer <int64>

unique id of the purchase

Responses

Response samples

Content type
application/json
{
  • "googlePlayStorePurchaseId": 0,
  • "purchaseDate": "2019-08-24T14:15:22Z",
  • "token": "string",
  • "packageName": "string",
  • "productId": "string",
  • "valid": true,
  • "subscription": true,
  • "purchaseToken": "string",
  • "appStoreOrderId": 0,
  • "subscriptionPurchase": {
    },
  • "productPurchase": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "changedDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "createdByType": "API",
  • "changedBy": "string",
  • "changedByType": "API"
}

Associate Google purchase

Associate a Google Playstore purchase with a customer.

Authorizations:
plenigoToken
path Parameters
token
required
string

unique id of the purchase of an app store

Request Body schema: application/json
customerId
string^[0-9]{1,18}$

id of the customer to associate purchase with

Responses

Request samples

Content type
application/json
{
  • "customerId": "string"
}

Response samples

Content type
application/json
{
  • "customerId": "string",
  • "token": "string",
  • "hasOrders": true,
  • "orders": [
    ]
}

Dissociate Google purchase

Dissociate a Google Playstore purchase from a customer.

Authorizations:
plenigoToken
path Parameters
token
required
string

unique id of the purchase of an app store

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Verify Google purchase

Verify validity of Google Playstore purchase.

Authorizations:
plenigoToken
path Parameters
token
required
string

unique id of the purchase of an app store

Responses

Response samples

Content type
application/json
{
  • "customerId": "string",
  • "token": "string",
  • "hasOrders": true,
  • "orders": [
    ]
}

Search app store order

Search all app store orders that correspond to the given search conditions.

Authorizations:
plenigoToken
query Parameters
size
integer <int32> [ 5 .. 100 ]

amount of elements to return - if no size is provided or the size is not within range it will be automatically set to 5

startTime
string <date-time>

time the entity was changed after or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

endTime
string <date-time>

time the entity was changed before or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

startingAfter
string <= 100 characters

A cursor for use in pagination. startingAfter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include startingAfter=obj_foo in order to fetch the next result set.

endingBefore
string <= 100 characters

A cursor for use in pagination. endingBefore is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include endingBefore=obj_bar in order to fetch the previous page of the list.

sort
string <= 4 characters
Enum: "ASC" "DESC"

The sort of the search, if its desc it will revert to search for a lower startingAfter

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get app store order

Get details for an app store order.

Authorizations:
plenigoToken
path Parameters
appStoreOrderId
required
integer <int64>

unique id of the app store order

Responses

Response samples

Content type
application/json
{
  • "appStoreOrderId": 0,
  • "orderDate": "2019-08-24T14:15:22Z",
  • "customerId": "string",
  • "storeType": "APPSTORE",
  • "additionalStoreData": {
    },
  • "items": [
    ],
  • "createdDate": "2019-08-24T14:15:22Z",
  • "changedDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "createdByType": "API",
  • "changedBy": "string",
  • "changedByType": "API"
}

Search app store subscription

Search all app store subscriptions that correspond to the given search conditions.

Authorizations:
plenigoToken
query Parameters
size
integer <int32> [ 5 .. 100 ]

amount of elements to return - if no size is provided or the size is not within range it will be automatically set to 5

startTime
string <date-time>

time the entity was changed after or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

endTime
string <date-time>

time the entity was changed before or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

startingAfter
string <= 100 characters

A cursor for use in pagination. startingAfter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include startingAfter=obj_foo in order to fetch the next result set.

endingBefore
string <= 100 characters

A cursor for use in pagination. endingBefore is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include endingBefore=obj_bar in order to fetch the previous page of the list.

sort
string <= 4 characters
Enum: "ASC" "DESC"

The sort of the search, if its desc it will revert to search for a lower startingAfter

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get app store subscription

Get details for an app store subscription.

Authorizations:
plenigoToken
path Parameters
appStoreSubscriptionId
required
integer <int64>

unique id of the app store subscription

Responses

Response samples

Content type
application/json
{
  • "appStoreSubscriptionId": 0,
  • "chainId": 0,
  • "externalSystemId": "string",
  • "customerId": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "cancellationDate": "2019-08-24T14:15:22Z",
  • "status": "ACTIVE",
  • "accessRightUniqueId": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "changedDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "createdByType": "API",
  • "changedBy": "string",
  • "changedByType": "API"
}

Checkout (UN)

Voucher purchase

Executes a purchase for the product represented by the provided voucher code. Only products that are completely free and have no follow up periods that must be paid can be bought that way.

Authorizations:
plenigoToken
Request Body schema: application/json
customerId
required
string^[0-9]{1,18}$

unique id of the customer the checkout is for

customerSession
string <= 10000 characters

active customer session - if a customer id is provided the customer id overrules the session

invoiceAddressId
integer <int64>

unique id of the invoice address to use

deliveryAddressId
integer <int64>

unique id of the delivery address to use

customerIpAddress
required
string <= 45 characters

ip address of the customer

object (AdditionalOrderData)
voucherCode
required
string <= 20 characters

voucher code to use

overwrittenProductId
string <= 20 characters

add a custom product id during the voucher checkout - this is only allowed for a single offer with one single purchase in it

Responses

Request samples

Content type
application/json
{
  • "customerId": "10003",
  • "customerIpAddress": "198.51.100.42",
  • "voucherCode": "1234-5678-1234"
}

Response samples

Content type
application/json
{
  • "orderId": 0
}

Customers (UN)

Search customers

Search all customers that correspond to the given search conditions.

Authorizations:
plenigoToken
query Parameters
size
integer <int32> [ 5 .. 100 ]

amount of elements to return - if no size is provided or the size is not within range it will be automatically set to 5

startTime
string <date-time>

time the entity was changed after or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

endTime
string <date-time>

time the entity was changed before or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

startingAfter
string <= 100 characters

A cursor for use in pagination. startingAfter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include startingAfter=obj_foo in order to fetch the next result set.

endingBefore
string <= 100 characters

A cursor for use in pagination. endingBefore is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include endingBefore=obj_bar in order to fetch the previous page of the list.

sort
string <= 4 characters
Enum: "ASC" "DESC"

The sort of the search, if its desc it will revert to search for a lower startingAfter

externalSystemId
string

external system id defined by third party systems

email
string <email>

email to search for

username
string

username to search for

customerMark
string
Value: "WBZ"

customer mark

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Create customer

Create a new customer with the data provided.

Authorizations:
plenigoToken
Request Body schema: application/json
customerId
string^[0-9]{1,18}$

unique id of the customer

registrationSource
string <= 100 characters

domain, website, app or other source of the customer registration

password
string <= 100 characters

password the new customer should get

sendWelcomeMail
boolean

flag indicating if welcome mail for customer should be sent

Array of objects (CustomerAddressCreation)

addresses that should be directly associated with the customer

object (AdditionalCustomerData)
pseudoEmail
boolean

flag indicating that email should be a pseudo email

processingBlocked
boolean

Flag to indicate to third party systems that the customer is blocked for further processing and should not be used for advertisement, etc. Can be used in combination with the pseudoEmail flag to handle data protection requests without deletion of a customer.

username
string <= 100 characters

selected username of the customer that is unique for all users

email
required
string <email> <= 100 characters

email address of the customer that is unique for all users

externalSystemId
string <= 100 characters

external system id - can only be set if not set yet

salutation
string
Enum: "DIVERSE" "MR" "MRS" "NONE"

salutation to identify the correct designation of a customer

firstName
string <= 100 characters

first name of the customer - first name and last name or company name are required

lastName
string <= 100 characters

last name of the customer - first name and last name or company name are required

invoiceEmail
string <email> <= 100 characters

email address of the customer where invoices should be sent to

language
required
string = 2 characters

language of the customer - two letter language code according to ISO 639-1

mobileNumber
string <= 100 characters (^\+?[1-9]\d{1,14}$|^$)

mobile number of the customer formatted as E.164

birthday
string or null <date>

birthday of the customer with full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-01

object (CustomerMiscellaneousData)

Responses

Request samples

Content type
application/json
{
  • "customerId": "100003",
  • "username": "wild_flower",
  • "email": "wildflower@example.com",
  • "invoiceEmail": "wildflower-invoices@example.com",
  • "birthday": "2001-03-21",
  • "language": "de",
  • "mobileNumber": "+14155552671",
  • "status": "ACTIVATED",
  • "addresses": [
    ],
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "customerId": "100003",
  • "externalSystemId": "1748-E",
  • "username": "wild_flower",
  • "email": "wildflower@example.com",
  • "salutation": "MR",
  • "firstName": "John",
  • "lastName": "Doe",
  • "invoiceEmail": "wildflower-invoices@example.com",
  • "birthday": "2001-03-21",
  • "language": "de",
  • "mobileNumber": "+14155552671",
  • "status": "ACTIVATED",
  • "changedDate": "2019-03-21T17:32:12Z",
  • "registrationDate": "2019-03-21T17:32:12Z",
  • "registrationSource": "www.example.com",
  • "twoFactorEnabled": false,
  • "addresses": [
    ],
  • "data": {
    }
}

Login (UN)

Verify login

This functionality verifies the log in data of a customer and executes the log in. The caller must decide if a username or email address is provided for login. If both are provided only the email address will be used.

Authorizations:
plenigoToken
Request Body schema: application/json
username
string <= 100 characters

username of the customer

email
string <= 100 characters

email of the customer

password
required
string <= 100 characters

password of the customer

object (LoggingData)

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "email": "string",
  • "password": "string",
  • "loggingData": {
    }
}

Response samples

Content type
application/json
{
  • "customerId": "100003",
  • "status": "ACTIVATED"
}

Verify transfer token

This functionality verifies the session transfer token and returns the customer id and customer status.

Authorizations:
plenigoToken
query Parameters
transferToken
required
string <= 50 characters

transfer token

Responses

Response samples

Content type
application/json
{
  • "customerId": "100003",
  • "status": "ACTIVATED"
}

Products (UN)

Search access rights

Search all access rights that correspond to the given search conditions.

Authorizations:
plenigoToken
query Parameters
size
integer <int32> [ 5 .. 100 ]

amount of elements to return - if no size is provided or the size is not within range it will be automatically set to 5

startTime
string <date-time>

time the entity was changed after or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

endTime
string <date-time>

time the entity was changed before or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

startingAfter
string <= 100 characters

A cursor for use in pagination. startingAfter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include startingAfter=obj_foo in order to fetch the next result set.

endingBefore
string <= 100 characters

A cursor for use in pagination. endingBefore is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include endingBefore=obj_bar in order to fetch the previous page of the list.

sort
string <= 4 characters
Enum: "ASC" "DESC"

The sort of the search, if its desc it will revert to search for a lower startingAfter

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Vouchers (UN)

Validate voucher code

Validates the voucher code provided.

Authorizations:
plenigoToken
path Parameters
voucherCode
required
string

voucher code to validate

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Wallets (UN)

Create credit wallet

Create credit wallet.

Authorizations:
plenigoToken
Request Body schema: application/json
uniqueId
string^[0-9\-a-zA-Z]{2,30}$

unique id of the wallet for identification

creditCount
integer <int64> [ 1 .. 100000000 ]

credit count to create wallet with

customerId
string^[0-9]{1,18}$

unique id of the customer the credit wallet belongs to

Responses

Request samples

Content type
application/json
{
  • "items": {
    }
}

Response samples

Content type
application/json
{
  • "items": {
    }
}

Search credit wallets

Search credit wallets.

Authorizations:
plenigoToken

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get credit uploads

Get credit wallet uploads.

Authorizations:
plenigoToken
query Parameters
size
integer <int32> [ 5 .. 100 ]

amount of elements to return - if no size is provided or the size is not within range it will be automatically set to 5

startTime
string <date-time>

time the entity was changed after or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

endTime
string <date-time>

time the entity was changed before or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

startingAfter
string <= 100 characters

A cursor for use in pagination. startingAfter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include startingAfter=obj_foo in order to fetch the next result set.

endingBefore
string <= 100 characters

A cursor for use in pagination. endingBefore is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include endingBefore=obj_bar in order to fetch the previous page of the list.

sort
string <= 4 characters
Enum: "ASC" "DESC"

The sort of the search, if its desc it will revert to search for a lower startingAfter

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get credit usages

Get credit wallet usages.

Authorizations:
plenigoToken
query Parameters
size
integer <int32> [ 5 .. 100 ]

amount of elements to return - if no size is provided or the size is not within range it will be automatically set to 5

startTime
string <date-time>

time the entity was changed after or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

endTime
string <date-time>

time the entity was changed before or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

startingAfter
string <= 100 characters

A cursor for use in pagination. startingAfter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include startingAfter=obj_foo in order to fetch the next result set.

endingBefore
string <= 100 characters

A cursor for use in pagination. endingBefore is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include endingBefore=obj_bar in order to fetch the previous page of the list.

sort
string <= 4 characters
Enum: "ASC" "DESC"

The sort of the search, if its desc it will revert to search for a lower startingAfter

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Refill empty wallets

Refill empty wallets related to the even list

Authorizations:
plenigoToken
path Parameters
uniqueId
required
string

unique id of the wallet

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Upload

Uploads a credit to a given credit wallet.

Authorizations:
plenigoToken
Request Body schema: application/json
customerId
string^[0-9]{1,18}$

id of the customer the credit usage should be accounted to

uniqueId
string^[0-9\-a-zA-Z]{2,30}$

unique id of the wallet to use

title
string <= 100 characters

title of upload

creditCount
integer <int64> [ 1 .. 100000000 ]

amount of credits to add

Responses

Request samples

Content type
application/json
{
  • "items": {
    }
}

Response samples

Content type
application/json
{
  • "items": {
    }
}

Use credit wallet

Uses a credit from a given credit wallet.

Authorizations:
plenigoToken
Request Body schema: application/json
customerId
required
string^[0-9]{1,18}$

id of the customer the credit usage should be accounted to

uniqueId
required
string^[0-9\-a-zA-Z]{2,30}$

unique id of the wallet to use

creditsUsed
required
integer <int64> [ 1 .. 100000 ]

amount of credits used

reason
required
string <= 100 characters

reason for credit usage

category
string <= 100 characters

category for credit usage

Responses

Request samples

Content type
application/json
{
  • "items": {
    }
}

Response samples

Content type
application/json
{
  • "items": {
    }
}

Get customer credit wallets

Get customer credit wallets.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

query Parameters
size
integer <int32> [ 5 .. 100 ]

amount of elements to return - if no size is provided or the size is not within range it will be automatically set to 5

startTime
string <date-time>

time the entity was changed after or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

endTime
string <date-time>

time the entity was changed before or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

startingAfter
string <= 100 characters

A cursor for use in pagination. startingAfter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include startingAfter=obj_foo in order to fetch the next result set.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get credit uploads by customer

Get credit wallet uploads.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

uniqueId
required
string

unique id of the wallet

query Parameters
size
integer <int32> [ 5 .. 100 ]

amount of elements to return - if no size is provided or the size is not within range it will be automatically set to 5

startTime
string <date-time>

time the entity was changed after or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

endTime
string <date-time>

time the entity was changed before or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

startingAfter
string <= 100 characters

A cursor for use in pagination. startingAfter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include startingAfter=obj_foo in order to fetch the next result set.

endingBefore
string <= 100 characters

A cursor for use in pagination. endingBefore is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include endingBefore=obj_bar in order to fetch the previous page of the list.

sort
string <= 4 characters
Enum: "ASC" "DESC"

The sort of the search, if its desc it will revert to search for a lower startingAfter

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get credit usages by customer

Get credit wallet usages.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

uniqueId
required
string

unique id of the wallet

query Parameters
size
integer <int32> [ 5 .. 100 ]

amount of elements to return - if no size is provided or the size is not within range it will be automatically set to 5

startTime
string <date-time>

time the entity was changed after or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

endTime
string <date-time>

time the entity was changed before or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

startingAfter
string <= 100 characters

A cursor for use in pagination. startingAfter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include startingAfter=obj_foo in order to fetch the next result set.

endingBefore
string <= 100 characters

A cursor for use in pagination. endingBefore is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include endingBefore=obj_bar in order to fetch the previous page of the list.

sort
string <= 4 characters
Enum: "ASC" "DESC"

The sort of the search, if its desc it will revert to search for a lower startingAfter

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}