API docs by Redocly

Frisbii Media partner API v1 (1.0.100)

Download OpenAPI specification:Download

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

This is the OpenAPI description for accessing the Frisbii Media 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": [
    ]
}

Addresses (LH)

Search addresses

Search all addresses 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 address

Get address that is identified by the passed address id.

Authorizations:
plenigoToken
path Parameters
addressId
required
integer <int64>

unique id of the address

Responses

Response samples

Content type
application/json
{
  • "addressId": 100001,
  • "changedDate": "2019-03-21T17:32:12Z",
  • "type": "INVOICE",
  • "preferred": true,
  • "customerId": "100003",
  • "businessAddress": true,
  • "salutation": "MR",
  • "title": "Dr",
  • "firstName": "John",
  • "lastName": "Doe",
  • "companyName": "ARAMARK Ltd.",
  • "additionalCompanyInfo": "Subdivision of World Ltd.",
  • "street": "Commercial Road",
  • "streetNumber": "30",
  • "additionalStreetInfo": "Level 5",
  • "postcode": "PO1 1AA",
  • "city": "Hampshire",
  • "country": "GB",
  • "vatNumber": "DE123456789"
}

Customers (LH)

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": [
    ]
}

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": [
    ]
}

Subscriptions (LH)

Search subscriptions

Search all 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

subscriptionItemId
integer <int64>

unique id of the subscription item to search for

externalSystemId
string

external system id defined by third party systems

subscriptionType
string (SubscriptionType)
Enum: "CREDIT_BASED" "CREDIT_TIME_BASED" "CREDIT_TRIGGER_BASED" "CROSS_COMPANY_TIME_BASED" "ISSUE_BASED" "TIME_BASED" "TIME_BASED_FAMILY" "TIME_BASED_MULTIUSER" "TIME_CREDIT_BASED" "VOUCHER_CREDIT_BASED" "VOUCHER_CREDIT_TIME_BASED" "VOUCHER_CREDIT_TRIGGER_BASED" "VOUCHER_ISSUE_BASED" "VOUCHER_TIME_BASED" "VOUCHER_TIME_CREDIT_BASED"

type of the subscription

Responses

Response samples

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

Get subscription

Get subscription that is identified by the passed subscription id.

Authorizations:
plenigoToken
path Parameters
subscriptionId
required
integer <int64>

unique id of the subscription

Responses

Response samples

Content type
application/json
{
  • "subscriptionId": 9310,
  • "changedDate": "2019-03-21T17:32:12Z",
  • "startDate": "2019-02-01T17:32:12Z",
  • "endDate": "2090-02-01T17:32:12Z",
  • "chainId": 9310,
  • "plenigoOfferId": "O_MZA1E7173120881551",
  • "invoiceCustomerId": "100003",
  • "deliveryCustomerId": "100003",
  • "term": 12,
  • "termTimeSpan": "MONTH",
  • "accountingPeriod": 1,
  • "accountingPeriodTimeSpan": "MONTH",
  • "cancellationPeriod": 1,
  • "cancellationPeriodTimeSpan": "DAY",
  • "currency": "EUR",
  • "paymentMethod": "CREDIT_CARD",
  • "paymentMethodId": 100230,
  • "accessBlocked": false,
  • "firstBookingDate": "2019-02-01",
  • "lastBookingDate": "2019-08-01",
  • "nextBookingDate": "2019-09-01",
  • "status": "ACTIVE",
  • "items": [
    ]
}

Addresses (HB)

Search addresses

Search all addresses 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 address

Get address that is identified by the passed address id.

Authorizations:
plenigoToken
path Parameters
addressId
required
integer <int64>

unique id of the address

Responses

Response samples

Content type
application/json
{
  • "addressId": 100001,
  • "changedDate": "2019-03-21T17:32:12Z",
  • "type": "INVOICE",
  • "preferred": true,
  • "customerId": "100003",
  • "businessAddress": true,
  • "salutation": "MR",
  • "title": "Dr",
  • "firstName": "John",
  • "lastName": "Doe",
  • "companyName": "ARAMARK Ltd.",
  • "additionalCompanyInfo": "Subdivision of World Ltd.",
  • "street": "Commercial Road",
  • "streetNumber": "30",
  • "additionalStreetInfo": "Level 5",
  • "postcode": "PO1 1AA",
  • "city": "Hampshire",
  • "country": "GB",
  • "vatNumber": "DE123456789"
}

Customers (HB)

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": [
    ]
}

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": [
    ]
}

Subscriptions (HB)

Search subscriptions

Search all 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

subscriptionItemId
integer <int64>

unique id of the subscription item to search for

externalSystemId
string

external system id defined by third party systems

subscriptionType
string (SubscriptionType)
Enum: "CREDIT_BASED" "CREDIT_TIME_BASED" "CREDIT_TRIGGER_BASED" "CROSS_COMPANY_TIME_BASED" "ISSUE_BASED" "TIME_BASED" "TIME_BASED_FAMILY" "TIME_BASED_MULTIUSER" "TIME_CREDIT_BASED" "VOUCHER_CREDIT_BASED" "VOUCHER_CREDIT_TIME_BASED" "VOUCHER_CREDIT_TRIGGER_BASED" "VOUCHER_ISSUE_BASED" "VOUCHER_TIME_BASED" "VOUCHER_TIME_CREDIT_BASED"

type of the subscription

Responses

Response samples

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

Get subscription

Get subscription that is identified by the passed subscription id.

Authorizations:
plenigoToken
path Parameters
subscriptionId
required
integer <int64>

unique id of the subscription

Responses

Response samples

Content type
application/json
{
  • "subscriptionId": 9310,
  • "changedDate": "2019-03-21T17:32:12Z",
  • "startDate": "2019-02-01T17:32:12Z",
  • "endDate": "2090-02-01T17:32:12Z",
  • "chainId": 9310,
  • "plenigoOfferId": "O_MZA1E7173120881551",
  • "invoiceCustomerId": "100003",
  • "deliveryCustomerId": "100003",
  • "term": 12,
  • "termTimeSpan": "MONTH",
  • "accountingPeriod": 1,
  • "accountingPeriodTimeSpan": "MONTH",
  • "cancellationPeriod": 1,
  • "cancellationPeriodTimeSpan": "DAY",
  • "currency": "EUR",
  • "paymentMethod": "CREDIT_CARD",
  • "paymentMethodId": 100230,
  • "accessBlocked": false,
  • "firstBookingDate": "2019-02-01",
  • "lastBookingDate": "2019-08-01",
  • "nextBookingDate": "2019-09-01",
  • "status": "ACTIVE",
  • "items": [
    ]
}

Addresses (MSP)

Search addresses

Search all addresses 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 address

Get address that is identified by the passed address id.

Authorizations:
plenigoToken
path Parameters
addressId
required
integer <int64>

unique id of the address

Responses

Response samples

Content type
application/json
{
  • "addressId": 100001,
  • "changedDate": "2019-03-21T17:32:12Z",
  • "type": "INVOICE",
  • "preferred": true,
  • "customerId": "100003",
  • "businessAddress": true,
  • "salutation": "MR",
  • "title": "Dr",
  • "firstName": "John",
  • "lastName": "Doe",
  • "companyName": "ARAMARK Ltd.",
  • "additionalCompanyInfo": "Subdivision of World Ltd.",
  • "street": "Commercial Road",
  • "streetNumber": "30",
  • "additionalStreetInfo": "Level 5",
  • "postcode": "PO1 1AA",
  • "city": "Hampshire",
  • "country": "GB",
  • "vatNumber": "DE123456789"
}

Customers (MSP)

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": [
    ]
}

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": [
    ]
}

Subscriptions (MSP)

Search subscriptions

Search all 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

subscriptionItemId
integer <int64>

unique id of the subscription item to search for

externalSystemId
string

external system id defined by third party systems

subscriptionType
string (SubscriptionType)
Enum: "CREDIT_BASED" "CREDIT_TIME_BASED" "CREDIT_TRIGGER_BASED" "CROSS_COMPANY_TIME_BASED" "ISSUE_BASED" "TIME_BASED" "TIME_BASED_FAMILY" "TIME_BASED_MULTIUSER" "TIME_CREDIT_BASED" "VOUCHER_CREDIT_BASED" "VOUCHER_CREDIT_TIME_BASED" "VOUCHER_CREDIT_TRIGGER_BASED" "VOUCHER_ISSUE_BASED" "VOUCHER_TIME_BASED" "VOUCHER_TIME_CREDIT_BASED"

type of the subscription

Responses

Response samples

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

Get subscription

Get subscription that is identified by the passed subscription id.

Authorizations:
plenigoToken
path Parameters
subscriptionId
required
integer <int64>

unique id of the subscription

Responses

Response samples

Content type
application/json
{
  • "subscriptionId": 9310,
  • "changedDate": "2019-03-21T17:32:12Z",
  • "startDate": "2019-02-01T17:32:12Z",
  • "endDate": "2090-02-01T17:32:12Z",
  • "chainId": 9310,
  • "plenigoOfferId": "O_MZA1E7173120881551",
  • "invoiceCustomerId": "100003",
  • "deliveryCustomerId": "100003",
  • "term": 12,
  • "termTimeSpan": "MONTH",
  • "accountingPeriod": 1,
  • "accountingPeriodTimeSpan": "MONTH",
  • "cancellationPeriod": 1,
  • "cancellationPeriodTimeSpan": "DAY",
  • "currency": "EUR",
  • "paymentMethod": "CREDIT_CARD",
  • "paymentMethodId": 100230,
  • "accessBlocked": false,
  • "firstBookingDate": "2019-02-01",
  • "lastBookingDate": "2019-08-01",
  • "nextBookingDate": "2019-09-01",
  • "status": "ACTIVE",
  • "items": [
    ]
}

Access Rights (PO)

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": [
    ]
}

Create customer access right

Create a new access right item with the data provided for a customer identified by the passed customer id.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

Request Body schema: application/json
createdDate
string or null <date-time>

time the object was created with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

changedDate
string or null <date-time>

time the object was changed with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

createdBy
string <= 100 characters

id who created the object

createdByType
string (UserType)
Enum: "API" "CUSTOMER" "MERCHANT" "IMPORTER" "SYSTEM"

type of user who performs the action

changedBy
string <= 100 characters

id who changed the object

changedByType
string (UserType)
Enum: "API" "CUSTOMER" "MERCHANT" "IMPORTER" "SYSTEM"

type of user who performs the action

lifeTimeStart
string or null <date-time>

date the access right will start with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

lifeTimeEnd
string or null <date-time>

date the access right will end with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

accessTimeStart
string or null <date-time>

time the access right will start with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

accessTimeEnd
string or null <date-time>

time the access right will end with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

pausedTimeStart
string or null <date-time>

time the access right pause will start with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

pausedTimeEnd
string or null <date-time>

time the access right pause will end with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

maxCacheDate
string or null <date-time>

max cache date with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

object <= 20 properties

Key must be a string with a maximum length of 20 characters.

blocked
boolean

flag indicating if access is blocked

activePartners
Array of strings

active partners of the company

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

unique id of the access right this access right grants access to

Responses

Request samples

Content type
application/json
{
  • "lifeTimeStart": "2019-01-01T07:53:23.450961Z",
  • "lifeTimeEnd": "2020-01-01T07:53:23.450961Z",
  • "accessTimeStart": "06:00:00",
  • "accessTimeEnd": "18:00:00",
  • "maxCacheDate": "2020-01-01T07:53:23.450961Z",
  • "data": {
    },
  • "blocked": false,
  • "accessRightUniqueId": "newAccessRightUniqueId"
}

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": [
    ]
}

Update customer access right

Updates an access right item with the data provided for a customer identified by the passed customer id.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

accessRightUniqueId
required
string

id of the access right item

Request Body schema: application/json
createdDate
string or null <date-time>

time the object was created with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

changedDate
string or null <date-time>

time the object was changed with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

createdBy
string <= 100 characters

id who created the object

createdByType
string (UserType)
Enum: "API" "CUSTOMER" "MERCHANT" "IMPORTER" "SYSTEM"

type of user who performs the action

changedBy
string <= 100 characters

id who changed the object

changedByType
string (UserType)
Enum: "API" "CUSTOMER" "MERCHANT" "IMPORTER" "SYSTEM"

type of user who performs the action

lifeTimeStart
string or null <date-time>

date the access right will start with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

lifeTimeEnd
string or null <date-time>

date the access right will end with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

accessTimeStart
string or null <date-time>

time the access right will start with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

accessTimeEnd
string or null <date-time>

time the access right will end with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

pausedTimeStart
string or null <date-time>

time the access right pause will start with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

pausedTimeEnd
string or null <date-time>

time the access right pause will end with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

maxCacheDate
string or null <date-time>

max cache date with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

object <= 20 properties

Key must be a string with a maximum length of 20 characters.

blocked
boolean

flag indicating if access is blocked

activePartners
Array of strings

active partners of the company

Responses

Request samples

Content type
application/json
{
  • "lifeTimeStart": "2019-01-01T07:53:23.450961Z",
  • "lifeTimeEnd": "2020-01-01T07:53:23.450961Z",
  • "accessTimeStart": "06:00:00",
  • "accessTimeEnd": "18:00:00",
  • "maxCacheDate": "2020-01-01T07:53:23.450961Z",
  • "data": {
    },
  • "blocked": false
}

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": [
    ]
}

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

selection
string <= 50 characters

name of the paywall tag to filter for

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": [
    ]
}

Create customer access right

Create a new access right item with the data provided for a customer identified by the passed customer id.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

Request Body schema: application/json
createdDate
string or null <date-time>

time the object was created with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

changedDate
string or null <date-time>

time the object was changed with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

createdBy
string <= 100 characters

id who created the object

createdByType
string (UserType)
Enum: "API" "CUSTOMER" "MERCHANT" "IMPORTER" "SYSTEM"

type of user who performs the action

changedBy
string <= 100 characters

id who changed the object

changedByType
string (UserType)
Enum: "API" "CUSTOMER" "MERCHANT" "IMPORTER" "SYSTEM"

type of user who performs the action

lifeTimeStart
string or null <date-time>

date the access right will start with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

lifeTimeEnd
string or null <date-time>

date the access right will end with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

accessTimeStart
string or null <date-time>

time the access right will start with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

accessTimeEnd
string or null <date-time>

time the access right will end with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

pausedTimeStart
string or null <date-time>

time the access right pause will start with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

pausedTimeEnd
string or null <date-time>

time the access right pause will end with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

maxCacheDate
string or null <date-time>

max cache date with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

object <= 20 properties

Key must be a string with a maximum length of 20 characters.

blocked
boolean

flag indicating if access is blocked

activePartners
Array of strings

active partners of the company

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

unique id of the access right this access right grants access to

Responses

Request samples

Content type
application/json
{
  • "lifeTimeStart": "2019-01-01T07:53:23.450961Z",
  • "lifeTimeEnd": "2020-01-01T07:53:23.450961Z",
  • "accessTimeStart": "06:00:00",
  • "accessTimeEnd": "18:00:00",
  • "maxCacheDate": "2020-01-01T07:53:23.450961Z",
  • "data": {
    },
  • "blocked": false,
  • "accessRightUniqueId": "newAccessRightUniqueId"
}

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": [
    ]
}

Update customer access right

Updates an access right item with the data provided for a customer identified by the passed customer id.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

accessRightUniqueId
required
string

id of the access right item

Request Body schema: application/json
createdDate
string or null <date-time>

time the object was created with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

changedDate
string or null <date-time>

time the object was changed with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

createdBy
string <= 100 characters

id who created the object

createdByType
string (UserType)
Enum: "API" "CUSTOMER" "MERCHANT" "IMPORTER" "SYSTEM"

type of user who performs the action

changedBy
string <= 100 characters

id who changed the object

changedByType
string (UserType)
Enum: "API" "CUSTOMER" "MERCHANT" "IMPORTER" "SYSTEM"

type of user who performs the action

lifeTimeStart
string or null <date-time>

date the access right will start with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

lifeTimeEnd
string or null <date-time>

date the access right will end with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

accessTimeStart
string or null <date-time>

time the access right will start with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

accessTimeEnd
string or null <date-time>

time the access right will end with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

pausedTimeStart
string or null <date-time>

time the access right pause will start with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

pausedTimeEnd
string or null <date-time>

time the access right pause will end with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

maxCacheDate
string or null <date-time>

max cache date with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

object <= 20 properties

Key must be a string with a maximum length of 20 characters.

blocked
boolean

flag indicating if access is blocked

activePartners
Array of strings

active partners of the company

Responses

Request samples

Content type
application/json
{
  • "lifeTimeStart": "2019-01-01T07:53:23.450961Z",
  • "lifeTimeEnd": "2020-01-01T07:53:23.450961Z",
  • "accessTimeStart": "06:00:00",
  • "accessTimeEnd": "18:00:00",
  • "maxCacheDate": "2020-01-01T07:53:23.450961Z",
  • "data": {
    },
  • "blocked": false
}

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": [
    ]
}

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": [
    ]
}

Create customer access right

Create a new access right item with the data provided for a customer identified by the passed customer id.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

Request Body schema: application/json
createdDate
string or null <date-time>

time the object was created with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

changedDate
string or null <date-time>

time the object was changed with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

createdBy
string <= 100 characters

id who created the object

createdByType
string (UserType)
Enum: "API" "CUSTOMER" "MERCHANT" "IMPORTER" "SYSTEM"

type of user who performs the action

changedBy
string <= 100 characters

id who changed the object

changedByType
string (UserType)
Enum: "API" "CUSTOMER" "MERCHANT" "IMPORTER" "SYSTEM"

type of user who performs the action

lifeTimeStart
string or null <date-time>

date the access right will start with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

lifeTimeEnd
string or null <date-time>

date the access right will end with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

accessTimeStart
string or null <date-time>

time the access right will start with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

accessTimeEnd
string or null <date-time>

time the access right will end with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

pausedTimeStart
string or null <date-time>

time the access right pause will start with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

pausedTimeEnd
string or null <date-time>

time the access right pause will end with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

maxCacheDate
string or null <date-time>

max cache date with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

object <= 20 properties

Key must be a string with a maximum length of 20 characters.

blocked
boolean

flag indicating if access is blocked

activePartners
Array of strings

active partners of the company

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

unique id of the access right this access right grants access to

Responses

Request samples

Content type
application/json
{
  • "lifeTimeStart": "2019-01-01T07:53:23.450961Z",
  • "lifeTimeEnd": "2020-01-01T07:53:23.450961Z",
  • "accessTimeStart": "06:00:00",
  • "accessTimeEnd": "18:00:00",
  • "maxCacheDate": "2020-01-01T07:53:23.450961Z",
  • "data": {
    },
  • "blocked": false,
  • "accessRightUniqueId": "newAccessRightUniqueId"
}

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": [
    ]
}

Update customer access right

Updates an access right item with the data provided for a customer identified by the passed customer id.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

accessRightUniqueId
required
string

id of the access right item

Request Body schema: application/json
createdDate
string or null <date-time>

time the object was created with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

changedDate
string or null <date-time>

time the object was changed with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

createdBy
string <= 100 characters

id who created the object

createdByType
string (UserType)
Enum: "API" "CUSTOMER" "MERCHANT" "IMPORTER" "SYSTEM"

type of user who performs the action

changedBy
string <= 100 characters

id who changed the object

changedByType
string (UserType)
Enum: "API" "CUSTOMER" "MERCHANT" "IMPORTER" "SYSTEM"

type of user who performs the action

lifeTimeStart
string or null <date-time>

date the access right will start with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

lifeTimeEnd
string or null <date-time>

date the access right will end with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

accessTimeStart
string or null <date-time>

time the access right will start with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

accessTimeEnd
string or null <date-time>

time the access right will end with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

pausedTimeStart
string or null <date-time>

time the access right pause will start with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

pausedTimeEnd
string or null <date-time>

time the access right pause will end with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

maxCacheDate
string or null <date-time>

max cache date with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

object <= 20 properties

Key must be a string with a maximum length of 20 characters.

blocked
boolean

flag indicating if access is blocked

activePartners
Array of strings

active partners of the company

Responses

Request samples

Content type
application/json
{
  • "lifeTimeStart": "2019-01-01T07:53:23.450961Z",
  • "lifeTimeEnd": "2020-01-01T07:53:23.450961Z",
  • "accessTimeStart": "06:00:00",
  • "accessTimeEnd": "18:00:00",
  • "maxCacheDate": "2020-01-01T07:53:23.450961Z",
  • "data": {
    },
  • "blocked": false
}

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": [
    ]
}

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 [ 0 .. 100 ] items [ items <= 300000 characters ]
transactionIds
Array of strings [ 0 .. 100 ] items [ items <= 20000 characters ]

Responses

Request samples

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

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
{
  • "createdDate": "2019-08-24T14:15:22Z",
  • "changedDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "createdByType": "API",
  • "changedBy": "string",
  • "changedByType": "API",
  • "appleAppStorePurchaseId": 0,
  • "purchaseDate": "2019-08-24T14:15:22Z",
  • "token": "string",
  • "valid": true,
  • "appStoreOrderId": 0,
  • "receipt": {
    },
  • "purchaseData": {
    }
}

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
{
  • "createdDate": "2019-08-24T14:15:22Z",
  • "changedDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "createdByType": "API",
  • "changedBy": "string",
  • "changedByType": "API",
  • "googlePlayStorePurchaseId": 0,
  • "purchaseDate": "2019-08-24T14:15:22Z",
  • "token": "string",
  • "packageName": "string",
  • "productId": "string",
  • "valid": true,
  • "subscription": true,
  • "purchaseToken": "string",
  • "appStoreOrderId": 0,
  • "subscriptionPurchase": {
    },
  • "productPurchase": {
    }
}

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
{
  • "endingBeforeId": "string",
  • "startingAfterId": "string",
  • "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
{
  • "createdDate": "2019-08-24T14:15:22Z",
  • "changedDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "createdByType": "API",
  • "changedBy": "string",
  • "changedByType": "API",
  • "appStoreOrderId": 0,
  • "orderDate": "2019-08-24T14:15:22Z",
  • "customerId": "string",
  • "storeType": "APPSTORE",
  • "additionalStoreData": {
    },
  • "items": [
    ]
}

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
{
  • "endingBeforeId": "string",
  • "startingAfterId": "string",
  • "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
{
  • "createdDate": "2019-08-24T14:15:22Z",
  • "changedDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "createdByType": "API",
  • "changedBy": "string",
  • "changedByType": "API",
  • "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",
  • "plenigoInAppProductId": "string"
}

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

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

unique id of the checkout variant to use

object (AdditionalData)
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
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. Required if pseudoMail is not provided

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)
pseudoEmail
boolean

flag indicating that email should be a pseudo email

password
string <= 100 characters

newly created or updated password of the customer

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

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 (CustomerData) <= 50 properties

Key must be a string with a maximum length of 30 characters.

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": {
    }
}

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": [
    ]
}

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
{
  • "plenigoOfferId": "O_TTA1E7173120881551",
  • "status": "ACTIVE"
}

Wallets (SL)

Create credit wallet

Create credit wallet.

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

unique id of the wallet for identification

creditCount
required
integer <int64> [ 1 .. 100000000 ]

credit count to create wallet with

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

unique id of the customer the credit wallet belongs to

Responses

Request samples

Content type
application/json
{
  • "customerId": "42",
  • "uniqueId": "company-wallet",
  • "creditCount": 5
}

Response samples

Content type
application/json
{
  • "customerId": "42",
  • "customerCreditWalletId": 5800001,
  • "uniqueId": "company-wallet",
  • "title": "Wallet of a customer",
  • "availableCreditCount": 5
}

Search credit wallets

Search credit wallets 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 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 [ 2 .. 50 ] characters

unique id of the wallet

Responses

Response samples

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

Upload credit to wallet

Uploads a credit to 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

title
required
string <= 100 characters

title of upload

creditCount
required
integer <int64> [ 1 .. 100000000 ]

amount of credits to add

Responses

Request samples

Content type
application/json
{
  • "customerId": "42",
  • "title": "New monthly credits",
  • "uniqueId": "company-wallet",
  • "creditCount": 2
}

Response samples

Content type
application/json
{
  • "customerId": "42",
  • "customerCreditWalletId": 5800001,
  • "uniqueId": "company-wallet",
  • "title": "Wallet of a customer",
  • "availableCreditCount": 5
}

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
{
  • "customerId": "42",
  • "uniqueId": "company-wallet",
  • "creditsUsed": 2,
  • "reason": "Usage of product one"
}

Response samples

Content type
application/json
{
  • "customerId": "42",
  • "customerCreditWalletId": 5800001,
  • "uniqueId": "company-wallet",
  • "title": "Wallet of a customer",
  • "availableCreditCount": 5
}

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 [ 2 .. 50 ] characters

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 [ 2 .. 50 ] characters

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": [
    ]
}

Create customer access right

Create a new access right item with the data provided for a customer identified by the passed customer id.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

Request Body schema: application/json
createdDate
string or null <date-time>

time the object was created with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

changedDate
string or null <date-time>

time the object was changed with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

createdBy
string <= 100 characters

id who created the object

createdByType
string (UserType)
Enum: "API" "CUSTOMER" "MERCHANT" "IMPORTER" "SYSTEM"

type of user who performs the action

changedBy
string <= 100 characters

id who changed the object

changedByType
string (UserType)
Enum: "API" "CUSTOMER" "MERCHANT" "IMPORTER" "SYSTEM"

type of user who performs the action

lifeTimeStart
string or null <date-time>

date the access right will start with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

lifeTimeEnd
string or null <date-time>

date the access right will end with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

accessTimeStart
string or null <date-time>

time the access right will start with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

accessTimeEnd
string or null <date-time>

time the access right will end with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

pausedTimeStart
string or null <date-time>

time the access right pause will start with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

pausedTimeEnd
string or null <date-time>

time the access right pause will end with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

maxCacheDate
string or null <date-time>

max cache date with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

object <= 20 properties

Key must be a string with a maximum length of 20 characters.

blocked
boolean

flag indicating if access is blocked

activePartners
Array of strings

active partners of the company

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

unique id of the access right this access right grants access to

Responses

Request samples

Content type
application/json
{
  • "lifeTimeStart": "2019-01-01T07:53:23.450961Z",
  • "lifeTimeEnd": "2020-01-01T07:53:23.450961Z",
  • "accessTimeStart": "06:00:00",
  • "accessTimeEnd": "18:00:00",
  • "maxCacheDate": "2020-01-01T07:53:23.450961Z",
  • "data": {
    },
  • "blocked": false,
  • "accessRightUniqueId": "newAccessRightUniqueId"
}

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": [
    ]
}

Update customer access right

Updates an access right item with the data provided for a customer identified by the passed customer id.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

accessRightUniqueId
required
string

id of the access right item

Request Body schema: application/json
createdDate
string or null <date-time>

time the object was created with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

changedDate
string or null <date-time>

time the object was changed with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

createdBy
string <= 100 characters

id who created the object

createdByType
string (UserType)
Enum: "API" "CUSTOMER" "MERCHANT" "IMPORTER" "SYSTEM"

type of user who performs the action

changedBy
string <= 100 characters

id who changed the object

changedByType
string (UserType)
Enum: "API" "CUSTOMER" "MERCHANT" "IMPORTER" "SYSTEM"

type of user who performs the action

lifeTimeStart
string or null <date-time>

date the access right will start with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

lifeTimeEnd
string or null <date-time>

date the access right will end with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

accessTimeStart
string or null <date-time>

time the access right will start with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

accessTimeEnd
string or null <date-time>

time the access right will end with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

pausedTimeStart
string or null <date-time>

time the access right pause will start with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

pausedTimeEnd
string or null <date-time>

time the access right pause will end with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

maxCacheDate
string or null <date-time>

max cache date with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

object <= 20 properties

Key must be a string with a maximum length of 20 characters.

blocked
boolean

flag indicating if access is blocked

activePartners
Array of strings

active partners of the company

Responses

Request samples

Content type
application/json
{
  • "lifeTimeStart": "2019-01-01T07:53:23.450961Z",
  • "lifeTimeEnd": "2020-01-01T07:53:23.450961Z",
  • "accessTimeStart": "06:00:00",
  • "accessTimeEnd": "18:00:00",
  • "maxCacheDate": "2020-01-01T07:53:23.450961Z",
  • "data": {
    },
  • "blocked": false
}

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": [
    ]
}

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 [ 0 .. 100 ] items [ items <= 300000 characters ]
transactionIds
Array of strings [ 0 .. 100 ] items [ items <= 20000 characters ]

Responses

Request samples

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

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
{
  • "createdDate": "2019-08-24T14:15:22Z",
  • "changedDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "createdByType": "API",
  • "changedBy": "string",
  • "changedByType": "API",
  • "appleAppStorePurchaseId": 0,
  • "purchaseDate": "2019-08-24T14:15:22Z",
  • "token": "string",
  • "valid": true,
  • "appStoreOrderId": 0,
  • "receipt": {
    },
  • "purchaseData": {
    }
}

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
{
  • "createdDate": "2019-08-24T14:15:22Z",
  • "changedDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "createdByType": "API",
  • "changedBy": "string",
  • "changedByType": "API",
  • "googlePlayStorePurchaseId": 0,
  • "purchaseDate": "2019-08-24T14:15:22Z",
  • "token": "string",
  • "packageName": "string",
  • "productId": "string",
  • "valid": true,
  • "subscription": true,
  • "purchaseToken": "string",
  • "appStoreOrderId": 0,
  • "subscriptionPurchase": {
    },
  • "productPurchase": {
    }
}

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
{
  • "endingBeforeId": "string",
  • "startingAfterId": "string",
  • "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
{
  • "createdDate": "2019-08-24T14:15:22Z",
  • "changedDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "createdByType": "API",
  • "changedBy": "string",
  • "changedByType": "API",
  • "appStoreOrderId": 0,
  • "orderDate": "2019-08-24T14:15:22Z",
  • "customerId": "string",
  • "storeType": "APPSTORE",
  • "additionalStoreData": {
    },
  • "items": [
    ]
}

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
{
  • "endingBeforeId": "string",
  • "startingAfterId": "string",
  • "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
{
  • "createdDate": "2019-08-24T14:15:22Z",
  • "changedDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "createdByType": "API",
  • "changedBy": "string",
  • "changedByType": "API",
  • "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",
  • "plenigoInAppProductId": "string"
}

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

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

unique id of the checkout variant to use

object (AdditionalData)
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
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. Required if pseudoMail is not provided

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)
pseudoEmail
boolean

flag indicating that email should be a pseudo email

password
string <= 100 characters

newly created or updated password of the customer

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

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 (CustomerData) <= 50 properties

Key must be a string with a maximum length of 30 characters.

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
{
  • "plenigoOfferId": "O_TTA1E7173120881551",
  • "status": "ACTIVE"
}

Wallets (UN)

Create credit wallet

Create credit wallet.

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

unique id of the wallet for identification

creditCount
required
integer <int64> [ 1 .. 100000000 ]

credit count to create wallet with

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

unique id of the customer the credit wallet belongs to

Responses

Request samples

Content type
application/json
{
  • "customerId": "42",
  • "uniqueId": "company-wallet",
  • "creditCount": 5
}

Response samples

Content type
application/json
{
  • "customerId": "42",
  • "customerCreditWalletId": 5800001,
  • "uniqueId": "company-wallet",
  • "title": "Wallet of a customer",
  • "availableCreditCount": 5
}

Search credit wallets

Search credit wallets 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 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 [ 2 .. 50 ] characters

unique id of the wallet

Responses

Response samples

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

Upload credit to wallet

Uploads a credit to 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

title
required
string <= 100 characters

title of upload

creditCount
required
integer <int64> [ 1 .. 100000000 ]

amount of credits to add

Responses

Request samples

Content type
application/json
{
  • "customerId": "42",
  • "title": "New monthly credits",
  • "uniqueId": "company-wallet",
  • "creditCount": 2
}

Response samples

Content type
application/json
{
  • "customerId": "42",
  • "customerCreditWalletId": 5800001,
  • "uniqueId": "company-wallet",
  • "title": "Wallet of a customer",
  • "availableCreditCount": 5
}

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
{
  • "customerId": "42",
  • "uniqueId": "company-wallet",
  • "creditsUsed": 2,
  • "reason": "Usage of product one"
}

Response samples

Content type
application/json
{
  • "customerId": "42",
  • "customerCreditWalletId": 5800001,
  • "uniqueId": "company-wallet",
  • "title": "Wallet of a customer",
  • "availableCreditCount": 5
}

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 [ 2 .. 50 ] characters

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 [ 2 .. 50 ] characters

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 (ST)

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
{
  • "startingAfterId": "100002",
  • "items": [
    ]
}

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": [
    ]
}

Create customer access right

Create a new access right item with the data provided for a customer identified by the passed customer id.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

Request Body schema: application/json
createdDate
string or null <date-time>

time the object was created with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

changedDate
string or null <date-time>

time the object was changed with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

createdBy
string <= 100 characters

id who created the object

createdByType
string (UserType)
Enum: "API" "CUSTOMER" "MERCHANT" "IMPORTER" "SYSTEM"

type of user who performs the action

changedBy
string <= 100 characters

id who changed the object

changedByType
string (UserType)
Enum: "API" "CUSTOMER" "MERCHANT" "IMPORTER" "SYSTEM"

type of user who performs the action

lifeTimeStart
string or null <date-time>

date the access right will start with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

lifeTimeEnd
string or null <date-time>

date the access right will end with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

accessTimeStart
string or null <date-time>

time the access right will start with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

accessTimeEnd
string or null <date-time>

time the access right will end with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

pausedTimeStart
string or null <date-time>

time the access right pause will start with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

pausedTimeEnd
string or null <date-time>

time the access right pause will end with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

maxCacheDate
string or null <date-time>

max cache date with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

object <= 20 properties

Key must be a string with a maximum length of 20 characters.

blocked
boolean

flag indicating if access is blocked

activePartners
Array of strings

active partners of the company

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

unique id of the access right this access right grants access to

Responses

Request samples

Content type
application/json
{
  • "lifeTimeStart": "2019-01-01T07:53:23.450961Z",
  • "lifeTimeEnd": "2020-01-01T07:53:23.450961Z",
  • "accessTimeStart": "06:00:00",
  • "accessTimeEnd": "18:00:00",
  • "maxCacheDate": "2020-01-01T07:53:23.450961Z",
  • "data": {
    },
  • "blocked": false,
  • "accessRightUniqueId": "newAccessRightUniqueId"
}

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 customer has 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": [
    ]
}

Update customer access right

Updates an access right item with the data provided for a customer identified by the passed customer id.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

accessRightUniqueId
required
string

id of the access right item

Request Body schema: application/json
createdDate
string or null <date-time>

time the object was created with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

changedDate
string or null <date-time>

time the object was changed with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

createdBy
string <= 100 characters

id who created the object

createdByType
string (UserType)
Enum: "API" "CUSTOMER" "MERCHANT" "IMPORTER" "SYSTEM"

type of user who performs the action

changedBy
string <= 100 characters

id who changed the object

changedByType
string (UserType)
Enum: "API" "CUSTOMER" "MERCHANT" "IMPORTER" "SYSTEM"

type of user who performs the action

lifeTimeStart
string or null <date-time>

date the access right will start with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

lifeTimeEnd
string or null <date-time>

date the access right will end with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

accessTimeStart
string or null <date-time>

time the access right will start with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

accessTimeEnd
string or null <date-time>

time the access right will end with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

pausedTimeStart
string or null <date-time>

time the access right pause will start with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

pausedTimeEnd
string or null <date-time>

time the access right pause will end with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

maxCacheDate
string or null <date-time>

max cache date with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

object <= 20 properties

Key must be a string with a maximum length of 20 characters.

blocked
boolean

flag indicating if access is blocked

activePartners
Array of strings

active partners of the company

Responses

Request samples

Content type
application/json
{
  • "lifeTimeStart": "2019-01-01T07:53:23.450961Z",
  • "lifeTimeEnd": "2020-01-01T07:53:23.450961Z",
  • "accessTimeStart": "06:00:00",
  • "accessTimeEnd": "18:00:00",
  • "maxCacheDate": "2020-01-01T07:53:23.450961Z",
  • "data": {
    },
  • "blocked": false
}

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": [
    ]
}

Delete customer access right

Delete an access right item for a customer identified by the passed customer id.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

accessRightUniqueId
required
string

id of the access right item

Responses

Response samples

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

Count metered access right

Count metered access for an access right item with the data provided for a customer identified by the passed customer id.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

accessRightUniqueId
required
string

id of the access right item

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": [
    ]
}

Block customer access right item

Block an access right item of type EXTERNAL or SINGLE_PRODUCT for a customer.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

accessRightUniqueId
required
string

id of the access right item

itemId
required
string

item id of an access right item

Responses

Response samples

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

Unblock customer access right item

Unblock an access right item of type EXTERNAL or SINGLE_PRODUCT for a customer.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

accessRightUniqueId
required
string

id of the access right item

itemId
required
string

item id of an access right item

Responses

Response samples

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

Accounting (ST)

Search cost centers

Search all cost centers 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": [
    ]
}

Create cost center

Create a new cost center with the data provided.

Authorizations:
plenigoToken
Request Body schema: application/json
Any of
costCenter
required
string <= 10 characters

Cost center value of the cost center

purchaseNumber
string <= 20 characters

Purchase number to use

description
string <= 400 characters

description of the cost center

shortDescription
string <= 20 characters

short description of the cost center

Responses

Request samples

Content type
application/json
{
  • "costCenter": "12345678",
  • "description": "Default cost center",
  • "shortDescription": "Default CC"
}

Response samples

Content type
application/json
{
  • "costCenterId": 100001,
  • "costCenter": "12345678",
  • "description": "Default cost center",
  • "shortDescription": "Default CC"
}

Get cost center

Get cost center that is identified by the passed cost center id.

Authorizations:
plenigoToken
path Parameters
costCenterId
required
integer <int64>

unique id of the cost center

Responses

Response samples

Content type
application/json
{
  • "costCenterId": 100001,
  • "costCenter": "12345678",
  • "description": "Default cost center",
  • "shortDescription": "Default CC"
}

Update cost center

Update a cost center that is identified by the passed cost center id with the data provided.

Authorizations:
plenigoToken
path Parameters
costCenterId
required
integer <int64>

unique id of the cost center

Request Body schema: application/json
Any of
costCenter
required
string <= 10 characters

Cost center value of the cost center

purchaseNumber
string <= 20 characters

Purchase number to use

description
string <= 400 characters

description of the cost center

shortDescription
string <= 20 characters

short description of the cost center

Responses

Request samples

Content type
application/json
{
  • "costCenter": "12345678",
  • "description": "Default cost center",
  • "shortDescription": "Default CC"
}

Response samples

Content type
application/json
{
  • "costCenterId": 100001,
  • "costCenter": "12345678",
  • "description": "Default cost center",
  • "shortDescription": "Default CC"
}

Search tax codes

Search all tax codes 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": [
    ]
}

Create tax code

Create a new tax code with the data provided.

Authorizations:
plenigoToken
Request Body schema: application/json
countryType
required
string
Enum: "EU" "EU_B2B" "SINGLE_COUNTRY" "WORLD"

type of the country

countries
required
Array of strings

array of country codes formatted as ISO 3166-1 alpha-2

tax
required
number <double> [ 0 .. 100 ]

tax percentage operated on this order item

analogTag
required
string <= 80 characters

tag for the analog tax code

digitalTag
required
string <= 80 characters

tag for the digital tax code

description
string <= 100 characters

description of the tax code

Responses

Request samples

Content type
application/json
{
  • "countryType": "SINGLE_COUNTRY",
  • "countries": [
    ],
  • "tax": 19,
  • "analogTag": "A1901",
  • "digitalTag": "D1901"
}

Response samples

Content type
application/json
{
  • "taxCodeId": 100001,
  • "changedDate": "2019-03-21T17:32:12Z",
  • "countryType": "SINGLE_COUNTRY",
  • "countries": [
    ],
  • "tax": 19,
  • "analogTag": "A1901",
  • "digitalTag": "D1901"
}

Get the tax code

Get tax code that is identified by the passed tax code id.

Authorizations:
plenigoToken
path Parameters
taxCodeId
required
integer <int64>

unique id of the tax code

Responses

Response samples

Content type
application/json
{
  • "taxCodeId": 100001,
  • "changedDate": "2019-03-21T17:32:12Z",
  • "countryType": "SINGLE_COUNTRY",
  • "countries": [
    ],
  • "tax": 19,
  • "analogTag": "A1901",
  • "digitalTag": "D1901"
}

Update tax code

Update a tax code that is identified by the passed tax code id with the data provided.

Authorizations:
plenigoToken
path Parameters
taxCodeId
required
integer <int64>

unique id of the tax code

Request Body schema: application/json
countryType
required
string
Enum: "EU" "EU_B2B" "SINGLE_COUNTRY" "WORLD"

type of the country

countries
required
Array of strings

array of country codes formatted as ISO 3166-1 alpha-2

tax
required
number <double> [ 0 .. 100 ]

tax percentage operated on this order item

analogTag
required
string <= 80 characters

tag for the analog tax code

digitalTag
required
string <= 80 characters

tag for the digital tax code

description
string <= 100 characters

description of the tax code

Responses

Request samples

Content type
application/json
{
  • "countryType": "SINGLE_COUNTRY",
  • "countries": [
    ],
  • "tax": 19,
  • "analogTag": "A1901",
  • "digitalTag": "D1901"
}

Response samples

Content type
application/json
{
  • "taxCodeId": 100001,
  • "changedDate": "2019-03-21T17:32:12Z",
  • "countryType": "SINGLE_COUNTRY",
  • "countries": [
    ],
  • "tax": 19,
  • "analogTag": "A1901",
  • "digitalTag": "D1901"
}

Delete tax code

Delete a tax code that is identified by the passed tax code id.

Authorizations:
plenigoToken
path Parameters
taxCodeId
required
integer <int64>

unique id of the tax code

Responses

Response samples

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

Activities (ST)

Search activities

Search all activities 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

jsonObjectType
string
Enum: "ACCESS_RIGHT_ITEM" "AMAZON_PAY" "BANK_ACCOUNT" "CREDIT_CARD" "CUSTOMER" "DELIVERY_ADDRESS" "INVOICE" "INVOICE_ADDRESS" "ORDER" "PAYPAL" "POST_FINANCE" "SUBSCRIPTION" "TWINT" "VIPPS"

The type the activity belongs to.

jsonObjectIdentifier
string <= 100 characters

The identifier of the object the activity belongs to. Can only be used in combination with jsonObjectType

Responses

Response samples

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

Search activities by customer id

Search all activities that correspond to the given search conditions.

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

jsonObjectType
string
Enum: "ACCESS_RIGHT_ITEM" "AMAZON_PAY" "BANK_ACCOUNT" "CREDIT_CARD" "CUSTOMER" "DELIVERY_ADDRESS" "INVOICE" "INVOICE_ADDRESS" "ORDER" "PAYPAL" "POST_FINANCE" "SUBSCRIPTION" "TWINT" "VIPPS"

The type the activity belongs to.

jsonObjectIdentifier
string <= 100 characters

The identifier of the object the activity belongs to. Can only be used in combination with jsonObjectType

Responses

Response samples

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

Additional Data Selections (ST)

Get additional data selections

Returns additional data selections.

Authorizations:
plenigoToken

Responses

Response samples

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

Update additional data selections.

Update additional data selections.

Authorizations:
plenigoToken
Request Body schema: application/json
createdDate
string or null <date-time>

time the object was created with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

changedDate
string or null <date-time>

time the object was changed with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

createdBy
string <= 100 characters

id who created the object

createdByType
string (UserType)
Enum: "API" "CUSTOMER" "MERCHANT" "IMPORTER" "SYSTEM"

type of user who performs the action

changedBy
string <= 100 characters

id who changed the object

changedByType
string (UserType)
Enum: "API" "CUSTOMER" "MERCHANT" "IMPORTER" "SYSTEM"

type of user who performs the action

Array of objects (AdditionalDataSelection)

Responses

Request samples

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

Response samples

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

Addresses (ST)

Search addresses

Search all addresses 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": [
    ]
}

Create address

Create a new address with the data provided.

Authorizations:
plenigoToken
query Parameters
overrideValidation
boolean

flag if the validation should be ignored

Request Body schema: application/json
businessAddress
boolean

flag indicating if address represents a private or a business address

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

salutation to identify the correct designation of a customer

title
string <= 100 characters

title of the entity

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

companyName
string <= 100 characters

company name - first name and last name or company name are required

additionalCompanyInfo
string <= 100 characters

additional information belonging to the company

street
string <= 100 characters

street name

streetNumber
string <= 100 characters

street number

additionalStreetInfo
string <= 100 characters

additional information describing address

postbox
string <= 100 characters

postbox id

postcode
string <= 100 characters

postcode

city
string <= 100 characters

city

state
string <= 2 characters

state

country
string = 2 characters

country code formatted as ISO 3166-1 alpha-2

vatNumber
string <= 20 characters

VAT number of a member country of the European Union

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

phone number of the customer formatted as E.164

deliveryInformation
string <= 100 characters

delivery information

academicTitle
string <= 100 characters

academic title

jobPosition
string <= 100 characters

job position

email
any

Email address. Only available if the addressType is INVOICE.

validationStatus
string
Enum: "NONE" "VALID" "INVALID" "SUSPECT" "OVERRIDDEN"

validation status of the address

validationHash
string

validation hash of a valid address

preferred
boolean

flag indicating if address is default selection for address type

type
required
string (AddressType)
Enum: "INVOICE" "DELIVERY"

address type

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

unique id of the customer the address belongs to

Responses

Request samples

Content type
application/json
{
  • "type": "INVOICE",
  • "preferred": true,
  • "customerId": "100003",
  • "businessAddress": true,
  • "salutation": "MR",
  • "title": "Dr",
  • "firstName": "John",
  • "lastName": "Doe",
  • "companyName": "ARAMARK Ltd.",
  • "additionalCompanyInfo": "Subdivision of World Ltd.",
  • "street": "Commercial Road",
  • "streetNumber": "30",
  • "additionalStreetInfo": "Level 5",
  • "postcode": "PO1 1AA",
  • "city": "Hampshire",
  • "country": "GB",
  • "vatNumber": "DE123456789"
}

Response samples

Content type
application/json
{
  • "addressId": 100001,
  • "changedDate": "2019-03-21T17:32:12Z",
  • "type": "INVOICE",
  • "preferred": true,
  • "customerId": "100003",
  • "businessAddress": true,
  • "salutation": "MR",
  • "title": "Dr",
  • "firstName": "John",
  • "lastName": "Doe",
  • "companyName": "ARAMARK Ltd.",
  • "additionalCompanyInfo": "Subdivision of World Ltd.",
  • "street": "Commercial Road",
  • "streetNumber": "30",
  • "additionalStreetInfo": "Level 5",
  • "postcode": "PO1 1AA",
  • "city": "Hampshire",
  • "country": "GB",
  • "vatNumber": "DE123456789"
}

Validate address data

Important note: The use of these API endpoints is a chargeable service provided by plenigo GmbH. The billing is done according to the current price list, which you can find in the settings section of your plenigo account. The billing is done with the monthly invoice. Validates the address with the data provided.

Authorizations:
plenigoToken
Request Body schema: application/json
businessAddress
boolean

flag indicating if address represents a private or a business address

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

salutation to identify the correct designation of a customer

title
string <= 100 characters

title of the entity

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

companyName
string <= 100 characters

company name - first name and last name or company name are required

additionalCompanyInfo
string <= 100 characters

additional information belonging to the company

street
string <= 100 characters

street name

streetNumber
string <= 100 characters

street number

additionalStreetInfo
string <= 100 characters

additional information describing address

postbox
string <= 100 characters

postbox id

postcode
string <= 100 characters

postcode

city
string <= 100 characters

city

state
string <= 2 characters

state

country
string = 2 characters

country code formatted as ISO 3166-1 alpha-2

vatNumber
string <= 20 characters

VAT number of a member country of the European Union

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

phone number of the customer formatted as E.164

deliveryInformation
string <= 100 characters

delivery information

academicTitle
string <= 100 characters

academic title

jobPosition
string <= 100 characters

job position

email
any

Email address. Only available if the addressType is INVOICE.

validationStatus
string
Enum: "NONE" "VALID" "INVALID" "SUSPECT" "OVERRIDDEN"

validation status of the address

validationHash
string

validation hash of a valid address

preferred
boolean

flag indicating if address is default selection for address type

type
required
string (AddressType)
Enum: "INVOICE" "DELIVERY"

address type

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

unique id of the customer the address belongs to

Responses

Request samples

Content type
application/json
{
  • "type": "INVOICE",
  • "preferred": true,
  • "customerId": "100003",
  • "businessAddress": true,
  • "salutation": "MR",
  • "title": "Dr",
  • "firstName": "John",
  • "lastName": "Doe",
  • "companyName": "ARAMARK Ltd.",
  • "additionalCompanyInfo": "Subdivision of World Ltd.",
  • "street": "Commercial Road",
  • "streetNumber": "30",
  • "additionalStreetInfo": "Level 5",
  • "postcode": "PO1 1AA",
  • "city": "Hampshire",
  • "country": "GB",
  • "vatNumber": "DE123456789"
}

Response samples

Content type
application/json
{
  • "addressId": 100001,
  • "changedDate": "2019-03-21T17:32:12Z",
  • "type": "INVOICE",
  • "preferred": true,
  • "customerId": "100003",
  • "businessAddress": true,
  • "salutation": "MR",
  • "title": "Dr",
  • "firstName": "John",
  • "lastName": "Doe",
  • "companyName": "ARAMARK Ltd.",
  • "additionalCompanyInfo": "Subdivision of World Ltd.",
  • "street": "Commercial Road",
  • "streetNumber": "30",
  • "additionalStreetInfo": "Level 5",
  • "postcode": "PO1 1AA",
  • "city": "Hampshire",
  • "country": "GB",
  • "vatNumber": "DE123456789"
}

Create wbz address

Create a new wbz address with the data provided.

Authorizations:
plenigoToken
query Parameters
overrideValidation
boolean

flag if the validation should be ignored

Request Body schema: application/json
businessAddress
boolean

flag indicating if address represents a private or a business address

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

salutation to identify the correct designation of a customer

title
string <= 100 characters

title of the entity

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

companyName
string <= 100 characters

company name - first name and last name or company name are required

additionalCompanyInfo
string <= 100 characters

additional information belonging to the company

street
string <= 100 characters

street name

streetNumber
string <= 100 characters

street number

additionalStreetInfo
string <= 100 characters

additional information describing address

postbox
string <= 100 characters

postbox id

postcode
string <= 100 characters

postcode

city
string <= 100 characters

city

state
string <= 2 characters

state

country
string = 2 characters

country code formatted as ISO 3166-1 alpha-2

vatNumber
string <= 20 characters

VAT number of a member country of the European Union

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

phone number of the customer formatted as E.164

deliveryInformation
string <= 100 characters

delivery information

academicTitle
string <= 100 characters

academic title

jobPosition
string <= 100 characters

job position

email
any

Email address. Only available if the addressType is INVOICE.

validationStatus
string
Enum: "NONE" "VALID" "INVALID" "SUSPECT" "OVERRIDDEN"

validation status of the address

validationHash
string

validation hash of a valid address

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

unique id of the customer the address belongs to

Responses

Request samples

Content type
application/json
{
  • "type": "INVOICE",
  • "preferred": true,
  • "customerId": "100003",
  • "businessAddress": true,
  • "salutation": "MR",
  • "title": "Dr",
  • "firstName": "John",
  • "lastName": "Doe",
  • "companyName": "ARAMARK Ltd.",
  • "additionalCompanyInfo": "Subdivision of World Ltd.",
  • "street": "Commercial Road",
  • "streetNumber": "30",
  • "additionalStreetInfo": "Level 5",
  • "postcode": "PO1 1AA",
  • "city": "Hampshire",
  • "country": "GB",
  • "vatNumber": "DE123456789"
}

Response samples

Content type
application/json
{
  • "addressId": 100001,
  • "changedDate": "2019-03-21T17:32:12Z",
  • "type": "INVOICE",
  • "preferred": true,
  • "customerId": "100003",
  • "businessAddress": true,
  • "salutation": "MR",
  • "title": "Dr",
  • "firstName": "John",
  • "lastName": "Doe",
  • "companyName": "ARAMARK Ltd.",
  • "additionalCompanyInfo": "Subdivision of World Ltd.",
  • "street": "Commercial Road",
  • "streetNumber": "30",
  • "additionalStreetInfo": "Level 5",
  • "postcode": "PO1 1AA",
  • "city": "Hampshire",
  • "country": "GB",
  • "vatNumber": "DE123456789"
}

Get address

Get address that is identified by the passed address id.

Authorizations:
plenigoToken
path Parameters
addressId
required
integer <int64>

unique id of the address

Responses

Response samples

Content type
application/json
{
  • "addressId": 100001,
  • "changedDate": "2019-03-21T17:32:12Z",
  • "type": "INVOICE",
  • "preferred": true,
  • "customerId": "100003",
  • "businessAddress": true,
  • "salutation": "MR",
  • "title": "Dr",
  • "firstName": "John",
  • "lastName": "Doe",
  • "companyName": "ARAMARK Ltd.",
  • "additionalCompanyInfo": "Subdivision of World Ltd.",
  • "street": "Commercial Road",
  • "streetNumber": "30",
  • "additionalStreetInfo": "Level 5",
  • "postcode": "PO1 1AA",
  • "city": "Hampshire",
  • "country": "GB",
  • "vatNumber": "DE123456789"
}

Update address

Update an address that is identified by the passed address id with the data provided. If fields were filled before and are now passed empty these fields will be cleared.

Authorizations:
plenigoToken
path Parameters
addressId
required
integer <int64>

unique id of the address

query Parameters
overrideValidation
boolean

flag if the validation should be ignored

Request Body schema: application/json
businessAddress
boolean

flag indicating if address represents a private or a business address

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

salutation to identify the correct designation of a customer

title
string <= 100 characters

title of the entity

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

companyName
string <= 100 characters

company name - first name and last name or company name are required

additionalCompanyInfo
string <= 100 characters

additional information belonging to the company

street
string <= 100 characters

street name

streetNumber
string <= 100 characters

street number

additionalStreetInfo
string <= 100 characters

additional information describing address

postbox
string <= 100 characters

postbox id

postcode
string <= 100 characters

postcode

city
string <= 100 characters

city

state
string <= 2 characters

state

country
string = 2 characters

country code formatted as ISO 3166-1 alpha-2

vatNumber
string <= 20 characters

VAT number of a member country of the European Union

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

phone number of the customer formatted as E.164

deliveryInformation
string <= 100 characters

delivery information

academicTitle
string <= 100 characters

academic title

jobPosition
string <= 100 characters

job position

email
any

Email address. Only available if the addressType is INVOICE.

validationStatus
string
Enum: "NONE" "VALID" "INVALID" "SUSPECT" "OVERRIDDEN"

validation status of the address

validationHash
string

validation hash of a valid address

preferred
boolean

flag indicating if address is default selection for address type

Responses

Request samples

Content type
application/json
{
  • "preferred": true,
  • "businessAddress": true,
  • "salutation": "MR",
  • "title": "Dr",
  • "firstName": "John",
  • "lastName": "Doe",
  • "companyName": "ARAMARK Ltd.",
  • "additionalCompanyInfo": "Subdivision of World Ltd.",
  • "street": "Commercial Road",
  • "streetNumber": "30",
  • "additionalStreetInfo": "Level 5",
  • "postcode": "PO1 1AA",
  • "city": "Hampshire",
  • "country": "GB",
  • "vatNumber": "DE123456789"
}

Response samples

Content type
application/json
{
  • "addressId": 100001,
  • "changedDate": "2019-03-21T17:32:12Z",
  • "type": "INVOICE",
  • "preferred": true,
  • "customerId": "100003",
  • "businessAddress": true,
  • "salutation": "MR",
  • "title": "Dr",
  • "firstName": "John",
  • "lastName": "Doe",
  • "companyName": "ARAMARK Ltd.",
  • "additionalCompanyInfo": "Subdivision of World Ltd.",
  • "street": "Commercial Road",
  • "streetNumber": "30",
  • "additionalStreetInfo": "Level 5",
  • "postcode": "PO1 1AA",
  • "city": "Hampshire",
  • "country": "GB",
  • "vatNumber": "DE123456789"
}

Delete address

Delete an address that is identified by the passed address id. Only addresses that are not associated with a subscription can be deleted. If such an address shall be deleted it must first be disconnected from the subscription.

Authorizations:
plenigoToken
path Parameters
addressId
required
integer <int64>

unique id of the address

Responses

Response samples

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

Get future addresses

Get all future addresses that correspond to the given address id.

Authorizations:
plenigoToken
path Parameters
addressId
required
integer <int64>

unique id of the address

Responses

Response samples

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

Create future address

Create a new future address with the data provided. An address can only have two future addresses

Authorizations:
plenigoToken
path Parameters
addressId
required
integer <int64>

unique id of the address

date
required
string <date>

date of the future address

query Parameters
overrideValidation
boolean

flag if the validation should be ignored

Request Body schema: application/json
businessAddress
boolean

flag indicating if address represents a private or a business address

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

salutation to identify the correct designation of a customer

title
string <= 100 characters

title of the entity

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

companyName
string <= 100 characters

company name - first name and last name or company name are required

additionalCompanyInfo
string <= 100 characters

additional information belonging to the company

street
string <= 100 characters

street name

streetNumber
string <= 100 characters

street number

additionalStreetInfo
string <= 100 characters

additional information describing address

postbox
string <= 100 characters

postbox id

postcode
string <= 100 characters

postcode

city
string <= 100 characters

city

state
string <= 2 characters

state

country
string = 2 characters

country code formatted as ISO 3166-1 alpha-2

vatNumber
string <= 20 characters

VAT number of a member country of the European Union

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

phone number of the customer formatted as E.164

deliveryInformation
string <= 100 characters

delivery information

academicTitle
string <= 100 characters

academic title

jobPosition
string <= 100 characters

job position

email
any

Email address. Only available if the addressType is INVOICE.

validationStatus
string
Enum: "NONE" "VALID" "INVALID" "SUSPECT" "OVERRIDDEN"

validation status of the address

validationHash
string

validation hash of a valid address

Responses

Request samples

Content type
application/json
{
  • "businessAddress": true,
  • "salutation": "MR",
  • "title": "Dr",
  • "firstName": "John",
  • "lastName": "Doe",
  • "companyName": "ARAMARK Ltd.",
  • "additionalCompanyInfo": "Subdivision of World Ltd.",
  • "street": "Commercial Road",
  • "streetNumber": "30",
  • "additionalStreetInfo": "Level 5",
  • "postcode": "PO1 1AA",
  • "city": "Hampshire",
  • "country": "GB",
  • "vatNumber": "DE123456789"
}

Response samples

Content type
application/json
{
  • "activationDate": "2019-03-21",
  • "businessAddress": true,
  • "salutation": "MR",
  • "title": "Dr",
  • "firstName": "John",
  • "lastName": "Doe",
  • "companyName": "ARAMARK Ltd.",
  • "additionalCompanyInfo": "Subdivision of World Ltd.",
  • "street": "Commercial Road",
  • "streetNumber": "30",
  • "additionalStreetInfo": "Level 5",
  • "postcode": "PO1 1AA",
  • "city": "Hampshire",
  • "country": "GB",
  • "vatNumber": "DE123456789"
}

Update future address

Update a future address that is identified by the passed date with the data provided. If fields were filled before and are now passed empty these fields will be cleared.

Authorizations:
plenigoToken
path Parameters
addressId
required
integer <int64>

unique id of the address

date
required
string <date>

date of the future address

query Parameters
overrideValidation
boolean

flag if the validation should be ignored

Request Body schema: application/json
businessAddress
boolean

flag indicating if address represents a private or a business address

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

salutation to identify the correct designation of a customer

title
string <= 100 characters

title of the entity

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

companyName
string <= 100 characters

company name - first name and last name or company name are required

additionalCompanyInfo
string <= 100 characters

additional information belonging to the company

street
string <= 100 characters

street name

streetNumber
string <= 100 characters

street number

additionalStreetInfo
string <= 100 characters

additional information describing address

postbox
string <= 100 characters

postbox id

postcode
string <= 100 characters

postcode

city
string <= 100 characters

city

state
string <= 2 characters

state

country
string = 2 characters

country code formatted as ISO 3166-1 alpha-2

vatNumber
string <= 20 characters

VAT number of a member country of the European Union

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

phone number of the customer formatted as E.164

deliveryInformation
string <= 100 characters

delivery information

academicTitle
string <= 100 characters

academic title

jobPosition
string <= 100 characters

job position

email
any

Email address. Only available if the addressType is INVOICE.

validationStatus
string
Enum: "NONE" "VALID" "INVALID" "SUSPECT" "OVERRIDDEN"

validation status of the address

validationHash
string

validation hash of a valid address

Responses

Request samples

Content type
application/json
{
  • "businessAddress": true,
  • "salutation": "MR",
  • "title": "Dr",
  • "firstName": "John",
  • "lastName": "Doe",
  • "companyName": "ARAMARK Ltd.",
  • "additionalCompanyInfo": "Subdivision of World Ltd.",
  • "street": "Commercial Road",
  • "streetNumber": "30",
  • "additionalStreetInfo": "Level 5",
  • "postcode": "PO1 1AA",
  • "city": "Hampshire",
  • "country": "GB",
  • "vatNumber": "DE123456789"
}

Response samples

Content type
application/json
{
  • "activationDate": "2019-03-21",
  • "businessAddress": true,
  • "salutation": "MR",
  • "title": "Dr",
  • "firstName": "John",
  • "lastName": "Doe",
  • "companyName": "ARAMARK Ltd.",
  • "additionalCompanyInfo": "Subdivision of World Ltd.",
  • "street": "Commercial Road",
  • "streetNumber": "30",
  • "additionalStreetInfo": "Level 5",
  • "postcode": "PO1 1AA",
  • "city": "Hampshire",
  • "country": "GB",
  • "vatNumber": "DE123456789"
}

Delete future address

Delete a future address that is identified by the passed date.

Authorizations:
plenigoToken
path Parameters
addressId
required
integer <int64>

unique id of the address

date
required
string <date>

date of the future address

Responses

Response samples

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

Validate address by id

Important note: The use of these API endpoints is a chargeable service provided by plenigo GmbH. The billing is done according to the current price list, which you can find in the settings section of your plenigo account. The billing is done with the monthly invoice.

Validates the address with the given id.

Authorizations:
plenigoToken
path Parameters
addressId
required
integer <int64>

unique id of the address

Responses

Response samples

Content type
application/json
{
  • "addressId": 100001,
  • "changedDate": "2019-03-21T17:32:12Z",
  • "type": "INVOICE",
  • "preferred": true,
  • "customerId": "100003",
  • "businessAddress": true,
  • "salutation": "MR",
  • "title": "Dr",
  • "firstName": "John",
  • "lastName": "Doe",
  • "companyName": "ARAMARK Ltd.",
  • "additionalCompanyInfo": "Subdivision of World Ltd.",
  • "street": "Commercial Road",
  • "streetNumber": "30",
  • "additionalStreetInfo": "Level 5",
  • "postcode": "PO1 1AA",
  • "city": "Hampshire",
  • "country": "GB",
  • "vatNumber": "DE123456789"
}

Age Rules (ST)

Search age rules

Search all age rules 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.

Responses

Response samples

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

Get age rule

Get age rule that is identified by the passed age rule id.

Authorizations:
plenigoToken
path Parameters
ageRuleId
required
integer <int64>

unique id of the age rule

Responses

Response samples

Content type
application/json
{
  • "internalTitle": "string",
  • "description": "string",
  • "relationalOperator": "ABOVE",
  • "age": 1,
  • "protectedPlenigoOfferId": "string",
  • "followUpPlenigoOfferId": "string",
  • "replacementPlenigoOfferId": "string",
  • "stopOnFail": true,
  • "translations": [
    ],
  • "createdDate": "2019-08-24T14:15:22Z",
  • "changedDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "createdByType": "API",
  • "changedBy": "string",
  • "changedByType": "API",
  • "ageRuleId": 0
}

App Stores (ST)

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 [ 0 .. 100 ] items [ items <= 300000 characters ]
transactionIds
Array of strings [ 0 .. 100 ] items [ items <= 20000 characters ]

Responses

Request samples

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

Response samples

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

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
{
  • "createdDate": "2019-08-24T14:15:22Z",
  • "changedDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "createdByType": "API",
  • "changedBy": "string",
  • "changedByType": "API",
  • "appleAppStorePurchaseId": 0,
  • "purchaseDate": "2019-08-24T14:15:22Z",
  • "token": "string",
  • "valid": true,
  • "appStoreOrderId": 0,
  • "receipt": {
    },
  • "purchaseData": {
    }
}

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
[ ]

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
{
  • "createdDate": "2019-08-24T14:15:22Z",
  • "changedDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "createdByType": "API",
  • "changedBy": "string",
  • "changedByType": "API",
  • "googlePlayStorePurchaseId": 0,
  • "purchaseDate": "2019-08-24T14:15:22Z",
  • "token": "string",
  • "packageName": "string",
  • "productId": "string",
  • "valid": true,
  • "subscription": true,
  • "purchaseToken": "string",
  • "appStoreOrderId": 0,
  • "subscriptionPurchase": {
    },
  • "productPurchase": {
    }
}

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
{
  • "endingBeforeId": "string",
  • "startingAfterId": "string",
  • "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
{
  • "createdDate": "2019-08-24T14:15:22Z",
  • "changedDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "createdByType": "API",
  • "changedBy": "string",
  • "changedByType": "API",
  • "appStoreOrderId": 0,
  • "orderDate": "2019-08-24T14:15:22Z",
  • "customerId": "string",
  • "storeType": "APPSTORE",
  • "additionalStoreData": {
    },
  • "items": [
    ]
}

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
{
  • "endingBeforeId": "string",
  • "startingAfterId": "string",
  • "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
{
  • "createdDate": "2019-08-24T14:15:22Z",
  • "changedDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "createdByType": "API",
  • "changedBy": "string",
  • "changedByType": "API",
  • "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",
  • "plenigoInAppProductId": "string"
}

Archived customer Cancellation Reason Settings (ST)

Search archived cancellation reasons

Search all archived cancellation reasons 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.

Responses

Response samples

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

Backend User Session (ST)

Create a merchant user transfer token

Creates a transfer token for a merchant user.

Authorizations:
plenigoToken
Request Body schema: application/json
apiAccessKey
string <= 5000 characters

api access key of the merchant user to create transfer token for

Responses

Request samples

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

Response samples

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

Blocked ibans (ST)

Get blocked ibans

Get blocked ibans for a company.

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.

iban
string [ 18 .. 32 ] characters

Responses

Response samples

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

Create blocked iban

Create a blocked iban for a company.

Authorizations:
plenigoToken
Request Body schema: application/json
iban
required
string [ 18 .. 32 ] characters
description
string <= 1000 characters

description of the blocked iban

Responses

Request samples

Content type
application/json
{
  • "iban": "stringstringstring",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "blockedIbanId": 100001,
  • "iban": "GB19123412341234123412",
  • "description": "This iban is not allowed."
}

Get blocked iban

Get blocked iban for a company.

Authorizations:
plenigoToken
path Parameters
blockedIbanId
required
integer <int64>

unique id of the blocked iban

Responses

Response samples

Content type
application/json
{
  • "blockedIbanId": 100001,
  • "iban": "GB19123412341234123412",
  • "description": "This iban is not allowed."
}

Delete a blocked iban

Delete a blocked iban for a company.

Authorizations:
plenigoToken
path Parameters
blockedIbanId
required
integer <int64>

unique id of the blocked iban

Responses

Response samples

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

Bonuses (ST)

Search bonuses

Search all bonuses 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.

plenigoBonusId
string

plenigo bonus id of the offer

Responses

Response samples

Content type
application/json
{
  • "endingBeforeId": "string",
  • "startingAfterId": "string",
  • "items": [
    ]
}

Search archived bonuses

Search all archived bonuses 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.

Responses

Response samples

Content type
application/json
{
  • "endingBeforeId": "string",
  • "startingAfterId": "string",
  • "items": [
    ]
}

Get bonus

Get bonus that is identified by the passed bonus id.

Authorizations:
plenigoToken
path Parameters
bonusId
required
integer <int64>

unique id of the bonus

Responses

Response samples

Content type
application/json
{
  • "createdDate": "2019-08-24T14:15:22Z",
  • "changedDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "createdByType": "API",
  • "changedBy": "string",
  • "changedByType": "API",
  • "accessRightId": 223001,
  • "availability": "AVAILABLE",
  • "taxType": "DIGITALPRODUCT",
  • "costCenterId": 123001,
  • "deliveryAddressMandatory": true,
  • "deliveryAmount": 1,
  • "deliveryCondition": "AFTER_PAYMENT",
  • "description": "The cheapest teacup we have in stock.",
  • "internalTitle": "Teacup",
  • "invoiceAddressMandatory": true,
  • "receiver": "PAYER",
  • "archived": true,
  • "bonusId": 123400,
  • "plenigoBonusId": "BO_12345678901234567",
  • "priceIssueId": 323001,
  • "translations": [
    ]
}

Callback Logs (ST)

Search callback logs

Search all callback log entries 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

entityType
string
Enum: "APP_STORE_ORDER" "APP_STORE_SUBSCRIPTION" "CALLBACK_RENEWAL" "CROSS_CLIENT_ORDER" "CUSTOMER" "CUSTOMER_GDPR" "CUSTOMER_OPT_IN" "DOO_EVENT_ACCESS" "FAILED_PAYMENT" "INVOICE" "INVOICE_CANCELLATION" "INVOICE_CORRECTION" "ORDER" "PURCHASED_ADDON" "SUBSCRIPTION" "VOUCHER_CAMPAIGN" "VOUCHER_CHANNEL"

entity type to get entries for

callbackType
string
Enum: "CANCELLATION" "CHANGE" "CONDITIONS_FULFILLED" "CREATION" "DELETION" "ENDED" "FINISHED" "PAYMENT_FAILED" "PAYMENT_REVOKED" "UNDO_CANCELLATION"

callback type to get entries for

errorOnly
boolean

flag indicating if only failed callbacks should be returned

plenigoCallbackId
integer <int64>

id of the callback the returned callback log entries should belong to

Responses

Response samples

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

Get callback log entry

Get callback log entry that is identified by the passed callback log entry id.

Authorizations:
plenigoToken
path Parameters
callbackLogEntryId
required
integer <int64>

unique id of the callback log entry

Responses

Response samples

Content type
application/json
{
  • "callbackLogEntryId": 1230001,
  • "createdDate": "2019-01-01T07:53:23.450961Z",
  • "createdBy": "PLENIGO",
  • "createdByType": "SYSTEM",
  • "changedDate": "2019-01-01T07:53:23.450961Z",
  • "changedBy": "PLENIGO",
  • "changedByType": "SYSTEM",
  • "entityType": "CUSTOMER",
  • "callbackType": "CREATION",
  • "entityVersion": "3.0",
  • "entityId": "1240003",
  • "success": false,
  • "erroMsg": "Could not reach host https://www.example.com."
}

Checkout (ST)

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

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

unique id of the checkout variant to use

object (AdditionalData)
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
}

Goodwill checkout

Summarizes all information of a goodwill purchase before finishing the purchase. This step must be completed before purchase submit.

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

unique id of the customer the invoice belongs to

invoiceAddressId
required
integer <int64>

unique id of the invoice address to use

merchantIpAddress
required
string <= 45 characters

ip address of the merchant

purchaseOrderIndicator
string <= 50 characters

purchase invoice indicator if provided by the customer

variantDeliveryAddressId
integer <int64>

variant delivery address for deliveries

orderDate
null or string <date-time>

date time the order was done if differs from start date with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

object (AdditionalData)

additional data associated with this order

required
Array of objects (GoodwillCheckoutReceiver) [ 1 .. 100 ] items

delivery customers that receive the goodwill products

Responses

Request samples

Content type
application/json
{
  • "invoiceCustomerId": "27001",
  • "invoiceAddressId": 15000,
  • "merchantIpAddress": "198.51.100.42",
  • "purchaseOrderIndicator": "PI-34A345",
  • "additionalData": {},
  • "receivers": [
    ]
}

Response samples

Content type
application/json
{
  • "purchaseOrderId": "string",
  • "purchaseBlocked": true,
  • "contractCompanyId": "string",
  • "companyId": "string",
  • "companyName": "string",
  • "companyCountry": "string",
  • "currency": "string",
  • "invoiceCountry": "string",
  • "ipAddress": "string",
  • "pspType": "string",
  • "additionalPspTypes": [
    ],
  • "paymentMethod": "string",
  • "paymentMethodId": 0,
  • "purchaseOrderIndicator": "string",
  • "analogInvoice": true,
  • "deliveryInPast": true,
  • "orderDate": "2019-08-24T14:15:22Z",
  • "subscriptionStartDate": "2019-08-24T14:15:22Z",
  • "referenceStartDate": "2019-08-24T14:15:22Z",
  • "nextBookingDate": "2019-08-24T14:15:22Z",
  • "customer": {
    },
  • "allowedPaymentMethods": [
    ],
  • "additionalData": {
    },
  • "offers": [
    ]
}

Order free product

Purchases a free product for a given customer. The product must be free of charge and if it is a subscription all the steps must be free of charge.

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

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

unique id of the checkout variant to use

object (AdditionalData)
required
object or object (CheckoutOffer)

Responses

Request samples

Content type
application/json
{
  • "customerId": "10003",
  • "customerIpAddress": "198.51.100.42",
  • "offer": {
    }
}

Response samples

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

Prepare purchase

Prepares everything for a purchase that a customer is supposed to do. The purchase order id returned is only valid a limited time so this method should be called in time before the customer is sent to the checkout.

Authorizations:
plenigoToken
Request Body schema: application/json
customerId
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

showNetPrices
boolean

flag indicating if net prices should be shown during checkout

paymentOnly
boolean

flag indicating that the checkout should only show payment information

forcePaymentMethod
string
Enum: "AMAZON_PAY" "APPLE_PAY" "BANK_ACCOUNT" "BILLING" "CREDIT_CARD" "GOOGLE_PAY" "IDEAL" "PAYPAL" "POSTFINANCE" "SOFORT" "TWINT" "VIPPS" "ZERO"

force checkout to use a specific payment method

basketId
string <= 40 characters

unique id of the plenigo basket

allowMultiplePurchases
boolean

flag indicating if product can be bought multiple times - a user will be able to pay the same product twice

startWithVoucherInput
boolean

flag indicating if checkout process should start with a voucher input field - this field is only a hint for the visual representation and if you don't use the plenigo iFrame checkout the logic must be implemented on your side

hideVoucherInput
boolean

flag indicating if checkout process should hide the voucher input field - this field is only a hint for the visual representation and if you don't use the plenigo iFrame checkout the logic must be implemented on your side

allowedPaymentMethods
Array of strings
Items Enum: "AMAZON_PAY" "APPLE_PAY" "BANK_ACCOUNT" "BILLING" "CREDIT_CARD" "GOOGLE_PAY" "IDEAL" "PAYPAL" "POSTFINANCE" "SOFORT" "TWINT" "VIPPS" "ZERO"

possibility for additional restrictions of payment methods - only payment methods provided here and configured in the backend are allowed during checkout

language
string <= 2 characters

language to use during checkout - two letter language code according to ISO 639-1

debugMode
boolean

flag indicating if debug information should be shown during purchase process

subscriptionStartDate
string or null <date-time>

optional start date of subscriptions with date notation as defined for example, 2017-07-21

object (CheckoutAddressSettings)

additional address settings

giftOption
string
Enum: "FORCE_GIFT_OPTION" "HIDE_GIFT_OPTION" "SHOW_GIFT_OPTION" "PRESELECT_GIFT_OPTION"

flag that controls if the checkout should be run as a gift checkout, should show a gift checkout box or hide it - the default value is HIDE_GIFT_OPTION

object (AdditionalData)

additional data associated with this order

voucherCode
string

voucher code - if voucher code is provided no items must be provided

Array of objects or objects (CheckoutOffer)

offers that should be sold via checkout

Array of objects (ConnectedOfferRequest)

connected offers that should be sold via checkout

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

unique id of the checkout variant to use

Responses

Request samples

Content type
application/json
Example
{
  • "customerIpAddress": "198.51.100.42",
  • "items": [
    ]
}

Response samples

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

Corporate Accounts (ST)

Search corporate accounts

Search all corporate accounts 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.

corporateAccountId
integer <int64>

unique id of the corporate account

Responses

Response samples

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

Validate corporate account

Check if a corporate account user code is valid.

Authorizations:
plenigoToken
Request Body schema: application/json
code
required
string [ 16 .. 19 ] characters

unique code for the corporate account user

Responses

Request samples

Content type
application/json
{
  • "code": "1234-5678-9123-4567"
}

Response samples

Content type
application/json
{
  • "corporateAccountId": 9310,
  • "plenigoOfferId": "O_123456789123456789",
  • "status": "INVITED"
}

Get corporate accounts

Search all corporate accounts of the customer that correspond to the given search conditions.

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.

Responses

Response samples

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

Use corporate account code

Use a corporate account user code.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

Request Body schema: application/json
code
required
string [ 16 .. 19 ] characters

unique code for the corporate account user

Responses

Request samples

Content type
application/json
{
  • "code": "1234-5678-9123-4567"
}

Response samples

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

Get for customer

Get the corporate account of the customer.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

corporateAccountId
required
integer <int64>

unique id of the corporate account

Responses

Response samples

Content type
application/json
{
  • "corporateAccountId": 9310,
  • "customerId": "100003",
  • "title": "A new offer",
  • "plenigoOfferId": "O_123456789123456789",
  • "usersAmount": 5,
  • "users": [
    ],
  • "accessRightItems": [
    ]
}

Create corporate account user

Create a corporate account user for the given corporate account.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

corporateAccountId
required
integer <int64>

unique id of the corporate account

query Parameters
sendMail
boolean

flag indicating if an email should be send

Request Body schema: application/json
email
required
string <email> <= 100 characters

email address of the customer that should belong to this corporate account user

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

salutation to identify the correct designation of a customer

firstName
required
string <= 100 characters

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

lastName
required
string <= 100 characters

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

Responses

Request samples

Content type
application/json
{
  • "email": "wildflower@example.com",
  • "salutation": "MR",
  • "firstName": "John",
  • "lastName": "Doe"
}

Response samples

Content type
application/json
{
  • "corporateAccountId": 9310,
  • "customerId": "100003",
  • "title": "A new offer",
  • "plenigoOfferId": "O_123456789123456789",
  • "usersAmount": 5,
  • "users": [
    ],
  • "accessRightItems": [
    ]
}

Delete corporate account user

Delete a corporate account user for the given corporate account.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

corporateAccountId
required
integer <int64>

unique id of the corporate account

corporateAccountUserId
required
integer <int64>

unique id of the corporate account user

Responses

Response samples

Content type
application/json
{
  • "corporateAccountId": 9310,
  • "customerId": "100003",
  • "title": "A new offer",
  • "plenigoOfferId": "O_123456789123456789",
  • "usersAmount": 5,
  • "users": [
    ],
  • "accessRightItems": [
    ]
}

Resend invitation email

Resend a corporate account user invitation email for the given corporate account.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

corporateAccountId
required
integer <int64>

unique id of the corporate account

corporateAccountUserId
required
integer <int64>

unique id of the corporate account user

Responses

Response samples

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

Credit Wallets (ST)

Search credit wallets

Search all credit wallets 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.

Responses

Response samples

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

Get credit wallet

Get credit wallet that is identified by the passed credit wallet id.

Authorizations:
plenigoToken
path Parameters
creditWalletId
required
integer <int64>

unique id of the credit wallet

Responses

Response samples

Content type
application/json
{
  • "internalTitle": "string",
  • "creditCountInvalidation": true,
  • "creditValidityTime": 36,
  • "creditValidityTimespan": "DAY",
  • "translations": [
    ],
  • "uniqueId": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "changedDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "createdByType": "API",
  • "changedBy": "string",
  • "changedByType": "API",
  • "creditWalletId": 0
}

Cross Sellings (ST)

Search cross sellings

Search all cross sellings 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.

Responses

Response samples

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

Get cross selling

Get cross selling that is identified by the passed cross selling id.

Authorizations:
plenigoToken
path Parameters
crossSellingId
required
integer <int64>

unique id of the cross selling

Responses

Response samples

Content type
application/json
{
  • "crossSellingId": 18001,
  • "internalTitle": "Update to best product",
  • "description": "We offer our customers the best product.",
  • "accessStart": "NOW",
  • "optional": false,
  • "sourceProductTags": [
    ],
  • "targetProductTags": [
    ],
  • "sourceProductTagIds": [
    ],
  • "targetProductTagIds": [
    ],
  • "translations": [
    ]
}

Customer Cancellation Reasons (ST)

Search cancellation reasons

Search all cancellation reasons 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.

Responses

Response samples

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

Get cancellation reasons

Get cancellation reasons that is identified by the passed cancellation reasons id.

Authorizations:
plenigoToken
path Parameters
customerCancellationReasonId
required
string

unique id of a customer cancellation reason

Responses

Response samples

Content type
application/json
{
  • "customerCancellationReasonId": 120302,
  • "createdDate": "2019-01-01T07:53:23.450961Z",
  • "createdBy": "PLENIGO",
  • "createdByType": "SYSTEM",
  • "changedDate": "2019-01-01T07:53:23.450961Z",
  • "changedBy": "PLENIGO",
  • "changedByType": "SYSTEM",
  • "internalTitle": "Too expensive",
  • "active": true,
  • "priority": 1,
  • "uniqueId": "too_expensive",
  • "translations": [
    ]
}

Customer OptIns (ST)

Search advertisement opt ins

Search all advertisement opt ins 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.

Responses

Response samples

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

Get advertisement opt in

Get advertisement opt in that is identified by the passed advertisement opt in id.

Authorizations:
plenigoToken
path Parameters
customerOptInId
required
string

unique id of a customer opt in

Responses

Response samples

Content type
application/json
{
  • "customerOptInId": 120302,
  • "createdDate": "2019-01-01T07:53:23.450961Z",
  • "createdBy": "PLENIGO",
  • "createdByType": "SYSTEM",
  • "changedDate": "2019-01-01T07:53:23.450961Z",
  • "changedBy": "PLENIGO",
  • "changedByType": "SYSTEM",
  • "internalTitle": "Main opt in",
  • "active": true,
  • "uniqueId": "V1.0",
  • "includedTypes": [
    ],
  • "activationTime": "2020-03-21T17:32:12Z",
  • "translations": [
    ]
}

Customer Terms (ST)

Search terms and conditions

Search all terms and conditions 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.

Responses

Response samples

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

Get terms and conditions

Get terms and conditions that is identified by the passed terms and conditions id.

Authorizations:
plenigoToken
path Parameters
customerTermId
required
string

unique id of a customer term

Responses

Response samples

Content type
application/json
{
  • "customerTermId": 120302,
  • "internalTitle": "Main term",
  • "active": true,
  • "uniqueId": "V1.0",
  • "activationTime": "2020-03-21T17:32:12Z",
  • "translations": [
    ]
}

Customers (ST)

Search customers

Search all customers that correspond to the given search conditions. It is important to note that email, username, and externalSystemid exclude each other so only one query parameter is used. The defined priority is email, username, externalSystemId.

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

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
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. Required if pseudoMail is not provided

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)
pseudoEmail
boolean

flag indicating that email should be a pseudo email

password
string <= 100 characters

newly created or updated password of the customer

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

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 (CustomerData) <= 50 properties

Key must be a string with a maximum length of 30 characters.

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": {
    }
}

Search additional customers data

Search all additional data of customers.

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.

Responses

Response samples

Content type
application/json
{
  • "endingBeforeId": "string",
  • "startingAfterId": "string",
  • "items": [
    ]
}

Get internal customer id

Get customer id by external system

Authorizations:
plenigoToken
path Parameters
externalSystemId
required
string

external system id defined by third party systems

Responses

Response samples

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

Search customers failed login attempts

Search all failed login attempts 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
{
  • "createdDate": "2019-08-24T14:15:22Z",
  • "changedDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "createdByType": "API",
  • "changedBy": "string",
  • "changedByType": "API",
  • "customerId": "string",
  • "loginDate": "2019-08-24T14:15:22Z",
  • "browser": "string",
  • "os": "string",
  • "source": "string",
  • "sourceUrl": "string",
  • "country": "string",
  • "failedCustomerLogInId": 0
}

Search customers successful login attempts

Search all successful login attempts 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
{
  • "createdDate": "2019-08-24T14:15:22Z",
  • "changedDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "createdByType": "API",
  • "changedBy": "string",
  • "changedByType": "API",
  • "customerId": "string",
  • "loginDate": "2019-08-24T14:15:22Z",
  • "browser": "string",
  • "os": "string",
  • "source": "string",
  • "sourceUrl": "string",
  • "country": "string",
  • "customerLogInId": 0
}

Search opt-ins

Search opt-ins of a company.

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.

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": [
    ]
}

Search customer by address

Search customer by address with given search conditions

Authorizations:
plenigoToken
query Parameters
useAnd
boolean

flag indicating result should match all set fields

Request Body schema: application/json
Any of
firstName
string <= 100 characters

First name of the customer

lastName
required
string <= 100 characters

Last name of the customer (required if companyName is missing)

companyName
string <= 100 characters

Company name (required if lastName is missing)

street
string <= 100 characters

Street name

postcode
required
string <= 100 characters

Postcode

city
string <= 100 characters

City

country
required
string^[A-Z]{2}$

Country code formatted as ISO 3166-1 alpha-2

Responses

Request samples

Content type
application/json
{
  • "firstName": "John",
  • "lastName": "Doe",
  • "companyName": "Example Ltd.",
  • "street": "Kensington Road",
  • "postcode": "E1 6AN",
  • "city": "London",
  • "country": "GB"
}

Response samples

Content type
application/json
{
  • "endingBeforeId": "string",
  • "startingAfterId": "string",
  • "items": [
    ]
}

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": {
    }
}

Update customer

Update a customer that is identified by the passed customer id with the data provided.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

query Parameters
includeAccessRightsCheck
boolean

flag to include a check if user has active access rights

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

selected username of the customer that is unique for all users

email
string <email> <= 100 characters

email address of the customer that is unique for all users. Required if pseudoMail is not provided

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)
pseudoEmail
boolean

flag indicating that email should be a pseudo email

password
string <= 100 characters

newly created or updated password of the customer

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.

Responses

Request samples

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

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": {
    }
}

Delete customer

Delete a customer. This is only possible if customer has no payments done yet.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

query Parameters
forceDeletion
boolean

flag indicating if force deletion

includeAccessRightsCheck
boolean

flag to include a check if user has active access rights

Responses

Response samples

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

Get access rights

Get access rights associated with a customer.

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": [
    ]
}

Get additional customer data

Returns additional data associated with the customer associated with the provided customer id.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

Responses

Response samples

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

Replace additional customer data

Replace additional data of a customer. All data will be replaced with the new data provided.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

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

unique id of the customer

object (CustomerData) <= 50 properties

Key must be a string with a maximum length of 30 characters.

Responses

Request samples

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

Response samples

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

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": [
    ]
}

Search customer's app store orders

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

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
{
  • "endingBeforeId": "string",
  • "startingAfterId": "string",
  • "items": [
    ]
}

Search customer's app store subscriptions

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

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
{
  • "endingBeforeId": "string",
  • "startingAfterId": "string",
  • "items": [
    ]
}

Dissociates all app store purchases

Dissociates all app store purchases of a customer.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

Responses

Response samples

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

Change email

Changes a customer's email

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

Request Body schema: application/json
email
string <email> <= 100 characters

new email of the customer

Responses

Request samples

Content type
application/json
{
  • "email": "email@example.com"
}

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 foreign orders

Search all foreign orders 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": [
    ]
}

Create GDPR data

ASYNC Every call to this endpoint will return a promise ID and create a GDPR request callback that contains the customer data requested. The callback also returns the promise ID returned by this call to be identified. This endpoint is highly limited because of its expensive nature. You can only call it three times every five seconds. Unlimited requests can be done by an agent via the plenigo merchant backend.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

Responses

Callbacks

Response samples

Content type
application/json
{
  • "success": true,
  • "promiseId": "0ujsszgFvbiEr7CDgE3z8MAUPFt"
}

Callback payload samples

Callback
POST: Sends GDPR export result to customer's configured callback URL
Content type
application/json
{
  • "promiseId": "string",
  • "entityType": "APP_STORE_ORDER",
  • "callbackType": "CANCELLATION",
  • "entityId": 29,
  • "entity": {