Documentation Powered by ReDoc

Echo Loyalty Member Integration API

Download OpenAPI specification:Download

Glossary:

Item Description
Accept-Language The Accept-Language request HTTP header indicates the natural language and locale that the client prefers. Browsers set required values for this header according to their active user interface language. Users rarely change it, and such changes are not recommended because they may lead to fingerprinting. As Accept-Language header we can pass values available in LANGUAGES dictionary. If you provide values that dictionary does not contain, you will have default language returned.
Base URL In the context of an API, the base URL is the combination of scheme, hostname, and base path on the root level of the API. For example, in the Echo Loyalty Business To Client Gateway REST API, the full URL for the POST /enrollment operation, which enrolls a member is:
https://b2c-tenantId.echoloyalty.com/b2c/v3/enrollment. The base URL is:
https://b2c-tenantId.echoloyalty.com/b2c/v3. This is constructed from these three elements:
-Scheme: HTTPS
-Host: b2c-tenantId.echoloyalty.com
-Base path: /b2c/v3
Bearer access token (access token) An access token that uses the standard and contains all the information the resource server needs to confirm the user’s grant to the application. It has the following three-part structure, with period separators: Header.Payload.Signature. The platform's OAuth Provider domain can issue Bearer access tokens. An advantage of the Bearer access token is that the Resource Server can validate by itself without having to go back to the Authorization Server.
Bearer token Used in OAuth, the bearer token is a security token with the property that any party in possession of the token (the bearer) can use it. The bearer token is sent as-is in the API request, in the Authorization header. The platform's OAuth Provider domain supports Referenced Bearer (a simple bearer token) and bearer access token.
Coordinated Universal Time (UTC) Coordinated Universal Time (UTC), also called Zulu time, is the primary time standard in general use. It essentially equates to Greenwich Mean Time (GMT), but is more scientifically precise. In the Echo Loyalty Business To Client Gateway REST API, time values are represented in the standard UTC date/time format YYYY-MM-DDTHH:MM:SSZ.
Example: 2013-12-31T15:45:00-04:00Z.
Gateway A Echo Loyalty Business To Client Gateway REST API streamlines signing up, signing in, management, operation of APIs, enhancing security and regulatory compliance through authentication and authorization. It provides central definition and management of security and other operational governance policies across multiple instances. The Gateway enables enterprises to standardize API and service delivery with high security, performance, and availability.
Header API headers are like an extra source of information for each API call. Their job is to represent the meta-data associated with an API request and response. API headers tell user about request/response bodies, authorization, caching, cooking. Headers examples: Authorization, WWW-Authenticate, Accept-Charset, Content-Type, Cache-Control.
Path Paramter Path is a type of parameter that lives within the endpoint URL. In a typical REST scheme, the path portion of the URL represents entity class hierarchy. Path parameters are surrounded with curly brackets and offer a unique opportunity for developers to control the representation of a specific resource. In this URL:
(https://b2c-tenantId.echoloyalty.com/b2c/v3/rewards/{rewardCode}?pricePlanDate=2018-09-01), the {rewardCode} part represents the parameter that is required for the call. Unlike query string parameters where the order doesn’t matter, path parameters values must be given in correspondence with the format that is dictated by the URL path. While query parameters allow you to omit a value, path parameter values can’t be omitted since it would mean changing the URL path.
Query Paramter API Query parameters can be defined as the optional key-value pairs that appear after the question mark in the URL. Basically, they are extensions of the URL that are utilized to help determine specific content or action based on the data being delivered. Query parameters are appended to the end of the URL, using a '?'. The question mark sign is used to separate path and query parameters. If you want to add multiple query parameters, an '&' sign is placed in between them to form what is known as a query string. In this URL:
(https://b2c-tenantId.echoloyalty.com/b2c/v3/rewards/{rewardCode}?pricePlanDate=2018-09-01), there is one query parameter: pricePlanDate, with 2018-09-01 being its value.
Token An access object sent to the requestor (client app) after authentication is complete and authorization has been granted. The token enables the client app to request access to the end-user's resources. OAuth, OpenID Connect, and SAML use tokens. There are different types of tokens, as defined in the applicable specification; for example, OAuth access tokens, bearer tokens (also called bearer access tokens), client tokens (not currently supported), and ID tokens (used by OpenID Connect).
URL A URL (Universal Resource Locator, a Web address) identifies a resource by specifying its location in the context of a particular access protocol; for example, HTTP or HTTPS.
Version Each app or API on the platform much have at least one version, and can have multiple versions. When a user creates an app or API on the platform, the first version is created automatically; when using the API, it's important to complete both actions.
X-Correlation-ID X-Correlation-ID - header that correlates HTTP requests between a client and server.
Authentication Authentication is a scheme - authorization credentails encryption scheme (e.g. OAuth 2.0, Bearer Token). Authentication is a identity verification whether user which send request is the same user as he claims.
Authorization As an authortization we understand a verification whether API user has safe access and has permission/priviliges to make use of API resources. Authorization is a header used to provide credentials that authenticate API user enabling access to proteceted resource for him.
Customer Member/participant of loyalty program.
identifierId 'identifierId' is an inner ID poiniting specific identifier in database table. Each identifier is linked to particular member and has its own type.
identifierNo 'identifierNo' is a member identifier ID as 'identifierId' generated within CLC. Unlike 'identifierId', 'identifierNo' is made public and can be found in Customer Care Panel among others.
/me /me is part of endpoint URL available on B2C facade. Using '/me' parameter you determine that endpoint you actually call is about you i.e. currently logged in user, whose identity has been verified. So you don't have to use any customer or identifier identification.

Authentication

customer_password_scheme

Customer password access token flow. Password grant type.
See Authentication documentation for more details.

Security Scheme Type OAuth2
password OAuth Flow
Token URL: https://$host$:$port$/b2c/$version$/login
Refresh URL: https://$host$:$port$/b2c/$version$/refresh-token
Scopes:
  • b2c_api_gateway -

    Grants access to any secured operations

  • b2c_api_tac -

    Grants access to terms and conditions related operations

  • b2c_api_pass_exp -

    Grants access to /me/password-change operation

Authentication & Authorization


Both authentication and authorization are core to the security of APIs.
Authentication - Authentication proves that you are who you say you are. We use OAuth2 security scheme as the method for authentication.
Authorization - The process when an entity proves a right to access. In other words, Authorization proves you have the right to make a request. To authorize as a member, login, password and the valid token obtained during authentication are required. Here you can also manage token validity.

Acquire access token and login

Authorize member, grant access to B2C gateway and issue the access token.
Usage of query parameters is denied, x-www-form-urlencoded approach is preferred.

header Parameters
Content-Type
required
string
Value: "application/x-www-form-urlencoded"

Request content type as MIME type.

Accept
string
Default: application/json
Value: "application/json"

Expected response content type as MIME type.

X-Correlation-ID
string <= 100 characters

Unique request token for correlation purposes.
When not provided to the request, assigned automatically by the system.

Time-Zone
string <= 100 characters

Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH).
Time zone source hierarchy:

  1. Date (time zone is taken from date format, related only to POST/PUT/PATCH requests).
  2. Header (time zone is taken from this header).
  3. DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter).
  4. UTC timezone is assumed.
Time zone is ignored if incorrect value is provided.
X-Tenant-ID
string <= 100 characters

Tenant identifier.
When not provided to the request, the default identifier will be used.

Request Body schema: application/x-www-form-urlencoded
username
required
string

Customer login.
Required for password grant_type, otherwise optional and ignored.

password
required
string <password>

Customer password.
Required for password grant_type, otherwise optional and ignored.

scope
string

Space separated list of scopes, which represent profiles granted within the token.
Only provided scopes can be included in the returned access token. When parameter is not provided, all granted scopes will be returned in the access token.

channel
string
Default: "O"
Enum: "W" "O"

Business channel invoking further operations.
Optional, defaults to O.
Applicable for password and client_credentials grant_type, otherwise ignored.
Subset of TRANSACTION_CHANNELS dictionary:

  • W - Website
  • O - Mobile App

Responses

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "token_type": "bearer",
  • "expires_in": 0,
  • "scope": "string",
  • "jti": "string",
  • "refresh_token": "string"
}

Refresh access token

Prolongate access token expiry time.
Usage of query parameters is denied, x-www-form-urlencoded approach is preferred.

header Parameters
X-Correlation-ID
string <= 100 characters

Unique request token for correlation purposes.
When not provided to the request, assigned automatically by the system.

X-CLM-OTP-TOKEN
string <= 200 characters

Value of token sent on email or sms. Necessary to pass multifactor authentication

Accept
string
Default: application/json
Value: "application/json"

Expected response content type as MIME type.

Time-Zone
string <= 100 characters

Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH).
Time zone source hierarchy:

  1. Date (time zone is taken from date format, related only to POST/PUT/PATCH requests).
  2. Header (time zone is taken from this header).
  3. DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter).
  4. UTC timezone is assumed.
Time zone is ignored if incorrect value is provided.
X-Tenant-ID
string <= 100 characters

Tenant identifier.
When not provided to the request, the default identifier will be used.

Request Body schema: application/x-www-form-urlencoded
refresh_token
required
string

Refresh token to be refreshed

scope
string

Space separated list of scopes, which represent profiles granted within the token.
Only provided scopes can be included in the returned access token. When parameter is not provided, all granted scopes will be returned in the access token.

Responses

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "token_type": "bearer",
  • "expires_in": 0,
  • "scope": "string",
  • "jti": "string",
  • "refresh_token": "string"
}

Invalidate access token and logout

Invalidate access token and logout.
Usage of query parameters is denied, x-www-form-urlencoded approach is preferred.

header Parameters
X-Correlation-ID
string <= 100 characters

Unique request token for correlation purposes.
When not provided to the request, assigned automatically by the system.

Time-Zone
string <= 100 characters

Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH).
Time zone source hierarchy:

  1. Date (time zone is taken from date format, related only to POST/PUT/PATCH requests).
  2. Header (time zone is taken from this header).
  3. DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter).
  4. UTC timezone is assumed.
Time zone is ignored if incorrect value is provided.
X-Tenant-ID
string <= 100 characters

Tenant identifier.
When not provided to the request, the default identifier will be used.

Request Body schema: application/x-www-form-urlencoded
refresh_token
required
string

Refresh token to be invalidated

Responses

Response samples

Content type
application/json
{
  • "error": "UNAUTHORIZED",
  • "message": "Unauthorized",
  • "method": "PUT",
  • "path": "/profile/customers/12345",
  • "correlationId": "1505219765216595",
  • "status": 401,
  • "timestamp": "2017-09-12T12:36:05.217Z"
}

Enrollment


With this method, you can enroll new members in the Loyalty program. You can make use of all pre-defined fields available in the System in your enrollment form. This part of the API will allow you to get the necessary consent types from your loyalty program members.

Enrollment

Enrolls new member with lists of predefined attributes.

header Parameters
Accept
string

Specifies which content types, expressed as MIME types, are accepted by client.
Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header.
Should be used only when operations specification states that it can handle multiple content types.

Accept-Language
string
Example: pl, en-us

Specifies the client proposed language of the response.
If not provided or if system does not have requested language configured, system will return response in system's configured default language.
Only the MultiLang strings will be translated, other will be returned as stored in the system.

X-Correlation-ID
string <= 100 characters

Unique request token for correlation purposes.
When not provided to the request, assigned automatically by the system.

X-CLM-OTP-TOKEN
string <= 200 characters

Value of token sent on email or sms. Necessary to pass multifactor authentication

Time-Zone
string <= 100 characters

Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH).
Time zone source hierarchy:

  1. Date (time zone is taken from date format, related only to POST/PUT/PATCH requests).
  2. Header (time zone is taken from this header).
  3. DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter).
  4. UTC timezone is assumed.
Time zone is ignored if incorrect value is provided.
X-Tenant-ID
string <= 100 characters

Tenant identifier.
When not provided to the request, the default identifier will be used.

X-CLM-Channel
string
Default: O

Enrollment channel code. TRANSACTION_CHANNELS dictionary.
When not provided to the request, the default channel will be used.

Request Body schema: application/json
Array of objects
Array of objects
required
object (types.StaticAttributesEnrollment)
required
object (types.TaCMemberCreateUpdate)

Responses

Request samples

Content type
application/json
{
  • "predefinedAttributes": [
    ],
  • "customAttributes": [
    ],
  • "staticAttributes": {
    },
  • "termsAcceptance": {
    }
}

Response samples

Content type
application/json
{
  • "error": "VALIDATION_ERROR",
  • "message": "Validation error: Constraint violations",
  • "method": "PUT",
  • "path": "/profile/customers/12345",
  • "correlationId": "1505219765216595",
  • "status": 400,
  • "timestamp": "2017-09-12T12:36:05.217Z",
  • "violations": [
    ]
}

Member Profile


This set of methods is strictly related to loyalty program members and their data. Here, you will find all methods allowing you to manage the member data from verification of credentials through profile modification and acceptance of new consents. For example, you will use these methods to show a member his loyalty card number/code and display data on the profile such as name or phone number. Also, it's necessary to change a member's password.

Verify member credentials

Verify member's credentials.
May be used to confirm customer's credentials for some critical operation, while customer is already authenticated.

Authorizations:
customer_password_scheme (b2c_api_gateway)
header Parameters
Content-Type
string

Request content type as MIME type.
By default application/json, unless operation's request specification says otherwise.

Accept
string

Specifies which content types, expressed as MIME types, are accepted by client.
Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header.
Should be used only when operations specification states that it can handle multiple content types.

Accept-Language
string
Example: pl, en-us

Specifies the client proposed language of the response.
If not provided or if system does not have requested language configured, system will return response in system's configured default language.
Only the MultiLang strings will be translated, other will be returned as stored in the system.

Authorization
string
Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l

OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation.
Bearer token where token is authorization key granted to the client.

X-Correlation-ID
string <= 100 characters

Unique request token for correlation purposes.
When not provided to the request, assigned automatically by the system.

Time-Zone
string <= 100 characters

Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH).
Time zone source hierarchy:

  1. Date (time zone is taken from date format, related only to POST/PUT/PATCH requests).
  2. Header (time zone is taken from this header).
  3. DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter).
  4. UTC timezone is assumed.
Time zone is ignored if incorrect value is provided.
X-Tenant-ID
string <= 100 characters

Tenant identifier.
When not provided to the request, the default identifier will be used.

Request Body schema: application/json
password
required
string <password>

Member's password

Responses

Request samples

Content type
application/json
{
  • "password": "pa$$word"
}

Response samples

Content type
application/json
{
  • "error": "VALIDATION_ERROR",
  • "message": "Validation error: Constraint violations",
  • "method": "PUT",
  • "path": "/profile/customers/12345",
  • "correlationId": "1505219765216595",
  • "status": 400,
  • "timestamp": "2017-09-12T12:36:05.217Z",
  • "violations": [
    ]
}

Get member profile

Get member profile

Authorizations:
customer_password_scheme (b2c_api_gateway)
header Parameters
Accept
string

Specifies which content types, expressed as MIME types, are accepted by client.
Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header.
Should be used only when operations specification states that it can handle multiple content types.

Accept-Language
string
Example: pl, en-us

Specifies the client proposed language of the response.
If not provided or if system does not have requested language configured, system will return response in system's configured default language.
Only the MultiLang strings will be translated, other will be returned as stored in the system.

Authorization
string
Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l

OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation.
Bearer token where token is authorization key granted to the client.

X-Correlation-ID
string <= 100 characters

Unique request token for correlation purposes.
When not provided to the request, assigned automatically by the system.

Time-Zone
string <= 100 characters

Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH).
Time zone source hierarchy:

  1. Date (time zone is taken from date format, related only to POST/PUT/PATCH requests).
  2. Header (time zone is taken from this header).
  3. DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter).
  4. UTC timezone is assumed.
Time zone is ignored if incorrect value is provided.
X-Tenant-ID
string <= 100 characters

Tenant identifier.
When not provided to the request, the default identifier will be used.

Responses

Response samples

Content type
application/json
{
  • "predefinedAttributes": [
    ],
  • "customAttributes": [
    ],
  • "staticAttributes": {
    },
  • "termsAcceptance": {
    }
}

Update member profile

Update member profile.
Accept only technical and editable fields configured as Member attributes for Mobile App/Member Portal.
Not provided technical and editable fields are cleared in the data storage.

Authorizations:
customer_password_scheme (b2c_api_gateway)
header Parameters
Accept
string

Specifies which content types, expressed as MIME types, are accepted by client.
Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header.
Should be used only when operations specification states that it can handle multiple content types.

Accept-Language
string
Example: pl, en-us

Specifies the client proposed language of the response.
If not provided or if system does not have requested language configured, system will return response in system's configured default language.
Only the MultiLang strings will be translated, other will be returned as stored in the system.

Authorization
string
Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l

OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation.
Bearer token where token is authorization key granted to the client.

X-Correlation-ID
string <= 100 characters

Unique request token for correlation purposes.
When not provided to the request, assigned automatically by the system.

Time-Zone
string <= 100 characters

Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH).
Time zone source hierarchy:

  1. Date (time zone is taken from date format, related only to POST/PUT/PATCH requests).
  2. Header (time zone is taken from this header).
  3. DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter).
  4. UTC timezone is assumed.
Time zone is ignored if incorrect value is provided.
X-Tenant-ID
string <= 100 characters

Tenant identifier.
When not provided to the request, the default identifier will be used.

Request Body schema: application/json
Array of objects
Array of objects
object (types.StaticAttributes)

Responses

Request samples

Content type
application/json
{
  • "predefinedAttributes": [
    ],
  • "customAttributes": [
    ],
  • "staticAttributes": {
    }
}

Response samples

Content type
application/json
{
  • "error": "VALIDATION_ERROR",
  • "message": "Validation error: Constraint violations",
  • "method": "PUT",
  • "path": "/profile/customers/12345",
  • "correlationId": "1505219765216595",
  • "status": 400,
  • "timestamp": "2017-09-12T12:36:05.217Z",
  • "violations": [
    ]
}

Modify member profile

Modify member profile.
Not provided data are not overwritten in the data storage.
EMAIL attribute can be only updated using PUT /me or PUT /me/email-change methods.
MOBILE_PHONE_NUMBER attribute can be only updated using PUT /me or PUT /me/phone-number-change methods.
MOBILE_PHONE_NUMBER_PREFIX attribute can be only updated using PUT /me or PUT /me/phone-number-change methods.

Authorizations:
customer_password_scheme (b2c_api_gateway)
header Parameters
Accept
string

Specifies which content types, expressed as MIME types, are accepted by client.
Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header.
Should be used only when operations specification states that it can handle multiple content types.

Accept-Language
string
Example: pl, en-us

Specifies the client proposed language of the response.
If not provided or if system does not have requested language configured, system will return response in system's configured default language.
Only the MultiLang strings will be translated, other will be returned as stored in the system.

Authorization
string
Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l

OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation.
Bearer token where token is authorization key granted to the client.

X-Correlation-ID
string <= 100 characters

Unique request token for correlation purposes.
When not provided to the request, assigned automatically by the system.

Time-Zone
string <= 100 characters

Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH).
Time zone source hierarchy:

  1. Date (time zone is taken from date format, related only to POST/PUT/PATCH requests).
  2. Header (time zone is taken from this header).
  3. DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter).
  4. UTC timezone is assumed.
Time zone is ignored if incorrect value is provided.
X-Tenant-ID
string <= 100 characters

Tenant identifier.
When not provided to the request, the default identifier will be used.

Request Body schema: application/json
Array of objects
Array of objects
object (types.StaticAttributes)

Responses

Request samples

Content type
application/json
{
  • "predefinedAttributes": [
    ],
  • "customAttributes": [
    ],
  • "staticAttributes": {
    }
}

Response samples

Content type
application/json
{
  • "error": "VALIDATION_ERROR",
  • "message": "Validation error: Constraint violations",
  • "method": "PUT",
  • "path": "/profile/customers/12345",
  • "correlationId": "1505219765216595",
  • "status": 400,
  • "timestamp": "2017-09-12T12:36:05.217Z",
  • "violations": [
    ]
}

Upload avatar file

Upload member avatar file into the system storage.

Authorizations:
customer_password_scheme (b2c_api_gateway)
header Parameters
Content-Type
string
Default: multipart/form-data
Value: "multipart/form-data"

Content type as MIME type.

Authorization
string
Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l

OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation.
Bearer token where token is authorization key granted to the client.

X-Correlation-ID
string <= 100 characters

Unique request token for correlation purposes.
When not provided to the request, assigned automatically by the system.

Time-Zone
string <= 100 characters

Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH).
Time zone source hierarchy:

  1. Date (time zone is taken from date format, related only to POST/PUT/PATCH requests).
  2. Header (time zone is taken from this header).
  3. DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter).
  4. UTC timezone is assumed.
Time zone is ignored if incorrect value is provided.
X-Tenant-ID
string <= 100 characters

Tenant identifier.
When not provided to the request, the default identifier will be used.

Request Body schema: multipart/form-data
file
required
string <binary>

File contents

Responses

Response samples

Content type
application/json
{
  • "error": "VALIDATION_ERROR",
  • "message": "Validation error: Constraint violations",
  • "method": "PUT",
  • "path": "/profile/customers/12345",
  • "correlationId": "1505219765216595",
  • "status": 400,
  • "timestamp": "2017-09-12T12:36:05.217Z",
  • "violations": [
    ]
}

Change password

Change password

Authorizations:
customer_password_scheme (b2c_api_gatewayb2c_api_pass_exp)
header Parameters
Accept
string

Specifies which content types, expressed as MIME types, are accepted by client.
Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header.
Should be used only when operations specification states that it can handle multiple content types.

Accept-Language
string
Example: pl, en-us

Specifies the client proposed language of the response.
If not provided or if system does not have requested language configured, system will return response in system's configured default language.
Only the MultiLang strings will be translated, other will be returned as stored in the system.

Authorization
string
Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l

OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation.
Bearer token where token is authorization key granted to the client.

X-Correlation-ID
string <= 100 characters

Unique request token for correlation purposes.
When not provided to the request, assigned automatically by the system.

Time-Zone
string <= 100 characters

Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH).
Time zone source hierarchy:

  1. Date (time zone is taken from date format, related only to POST/PUT/PATCH requests).
  2. Header (time zone is taken from this header).
  3. DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter).
  4. UTC timezone is assumed.
Time zone is ignored if incorrect value is provided.
X-Tenant-ID
string <= 100 characters

Tenant identifier.
When not provided to the request, the default identifier will be used.

Request Body schema: application/json
oldPassword
required
string <password>

Customer's old password

newPassword
required
string <password>

Customer's new password

confirmPassword
required
string <password>

New password repeated

Responses

Request samples

Content type
application/json
{
  • "oldPassword": "pa$$word",
  • "newPassword": "pa$$word",
  • "confirmPassword": "pa$$word"
}

Response samples

Content type
application/json
{
  • "error": "VALIDATION_ERROR",
  • "message": "Validation error: Constraint violations",
  • "method": "PUT",
  • "path": "/profile/customers/12345",
  • "correlationId": "1505219765216595",
  • "status": 400,
  • "timestamp": "2017-09-12T12:36:05.217Z",
  • "violations": [
    ]
}

Close customer

Close member account on own request. Operation is irrevertible.

Authorizations:
customer_password_scheme (b2c_api_gateway)
header Parameters
Accept
string

Specifies which content types, expressed as MIME types, are accepted by client.
Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header.
Should be used only when operations specification states that it can handle multiple content types.

Accept-Language
string
Example: pl, en-us

Specifies the client proposed language of the response.
If not provided or if system does not have requested language configured, system will return response in system's configured default language.
Only the MultiLang strings will be translated, other will be returned as stored in the system.

Authorization
string
Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l

OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation.
Bearer token where token is authorization key granted to the client.

X-Correlation-ID
string <= 100 characters

Unique request token for correlation purposes.
When not provided to the request, assigned automatically by the system.

Time-Zone
string <= 100 characters

Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH).
Time zone source hierarchy:

  1. Date (time zone is taken from date format, related only to POST/PUT/PATCH requests).
  2. Header (time zone is taken from this header).
  3. DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter).
  4. UTC timezone is assumed.
Time zone is ignored if incorrect value is provided.
X-Tenant-ID
string <= 100 characters

Tenant identifier.
When not provided to the request, the default identifier will be used.

Responses

Response samples

Content type
application/json
{
  • "error": "VALIDATION_ERROR",
  • "message": "Validation error: Constraint violations",
  • "method": "PUT",
  • "path": "/profile/customers/12345",
  • "correlationId": "1505219765216595",
  • "status": 400,
  • "timestamp": "2017-09-12T12:36:05.217Z",
  • "violations": [
    ]
}

Get T&C Policy details

Get details of recently accepted Terms and Conditions Policy and info about acceptance.

Authorizations:
customer_password_scheme (b2c_api_gatewayb2c_api_tac)
header Parameters
Accept
string

Specifies which content types, expressed as MIME types, are accepted by client.
Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header.
Should be used only when operations specification states that it can handle multiple content types.

Accept-Language
string
Example: pl, en-us

Specifies the client proposed language of the response.
If not provided or if system does not have requested language configured, system will return response in system's configured default language.
Only the MultiLang strings will be translated, other will be returned as stored in the system.

Authorization
string
Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l

OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation.
Bearer token where token is authorization key granted to the client.

X-Correlation-ID
string <= 100 characters

Unique request token for correlation purposes.
When not provided to the request, assigned automatically by the system.

Time-Zone
string <= 100 characters

Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH).
Time zone source hierarchy:

  1. Date (time zone is taken from date format, related only to POST/PUT/PATCH requests).
  2. Header (time zone is taken from this header).
  3. DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter).
  4. UTC timezone is assumed.
Time zone is ignored if incorrect value is provided.
X-Tenant-ID
string <= 100 characters

Tenant identifier.
When not provided to the request, the default identifier will be used.

Responses

Response samples

Content type
application/json
{
  • "gdpr": {
    },
  • "loyalty": {
    }
}

Accept T&C Policy

Accept Terms and Conditions Policy.
Current version of policy is accepted with current date and time.

Authorizations:
customer_password_scheme (b2c_api_gatewayb2c_api_tac)
header Parameters
Accept
string

Specifies which content types, expressed as MIME types, are accepted by client.
Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header.
Should be used only when operations specification states that it can handle multiple content types.

Accept-Language
string
Example: pl, en-us

Specifies the client proposed language of the response.
If not provided or if system does not have requested language configured, system will return response in system's configured default language.
Only the MultiLang strings will be translated, other will be returned as stored in the system.

Authorization
string
Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l

OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation.
Bearer token where token is authorization key granted to the client.

X-Correlation-ID
string <= 100 characters

Unique request token for correlation purposes.
When not provided to the request, assigned automatically by the system.

Time-Zone
string <= 100 characters

Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH).
Time zone source hierarchy:

  1. Date (time zone is taken from date format, related only to POST/PUT/PATCH requests).
  2. Header (time zone is taken from this header).
  3. DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter).
  4. UTC timezone is assumed.
Time zone is ignored if incorrect value is provided.
X-Tenant-ID
string <= 100 characters

Tenant identifier.
When not provided to the request, the default identifier will be used.

Request Body schema: application/json
object
object

Responses

Request samples

Content type
application/json
{
  • "gdpr": {
    },
  • "loyalty": {
    }
}

Response samples

Content type
application/json
{
  • "error": "VALIDATION_ERROR",
  • "message": "Validation error: Constraint violations",
  • "method": "PUT",
  • "path": "/profile/customers/12345",
  • "correlationId": "1505219765216595",
  • "status": 400,
  • "timestamp": "2017-09-12T12:36:05.217Z",
  • "violations": [
    ]
}

Update T&C Policy

Update Terms and Conditions Policy.
Current version of policy is accepted with current date and time.

Authorizations:
customer_password_scheme (b2c_api_gatewayb2c_api_tac)
header Parameters
Accept
string

Specifies which content types, expressed as MIME types, are accepted by client.
Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header.
Should be used only when operations specification states that it can handle multiple content types.

Accept-Language
string
Example: pl, en-us

Specifies the client proposed language of the response.
If not provided or if system does not have requested language configured, system will return response in system's configured default language.
Only the MultiLang strings will be translated, other will be returned as stored in the system.

Authorization
string
Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l

OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation.
Bearer token where token is authorization key granted to the client.

X-Correlation-ID
string <= 100 characters

Unique request token for correlation purposes.
When not provided to the request, assigned automatically by the system.

Time-Zone
string <= 100 characters

Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH).
Time zone source hierarchy:

  1. Date (time zone is taken from date format, related only to POST/PUT/PATCH requests).
  2. Header (time zone is taken from this header).
  3. DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter).
  4. UTC timezone is assumed.
Time zone is ignored if incorrect value is provided.
X-Tenant-ID
string <= 100 characters

Tenant identifier.
When not provided to the request, the default identifier will be used.

Request Body schema: application/json
object
object

Responses

Request samples

Content type
application/json
{
  • "gdpr": {
    },
  • "loyalty": {
    }
}

Response samples

Content type
application/json
{
  • "error": "VALIDATION_ERROR",
  • "message": "Validation error: Constraint violations",
  • "method": "PUT",
  • "path": "/profile/customers/12345",
  • "correlationId": "1505219765216595",
  • "status": 400,
  • "timestamp": "2017-09-12T12:36:05.217Z",
  • "violations": [
    ]
}

Get points expiration forecast

Get list of points expiration forecast with prevention source.
Sortable by [forecastedExpirationDate].
Default sort: forecastedExpirationDate:ASC.

Authorizations:
customer_password_scheme (b2c_api_gateway)
query Parameters
pointType
string

Point type code. POINT_TYPES dictionary.

expirationDateFrom
string <date>

Points expiration date - lower limit. Inclusive.

expirationDateTo
string <date>

Points expiration date - upper limit. Inclusive.

sort
string
Default: "id:ASC"

Defines the sort order of the resulting list of objects.
Available sort orders: ASCENDING, ASC, ascending, asc, 1, DESCENDING, DESC, descending, desc, -1.
If operation description does not state otherwise, default order field is 'id' and the default order is ascending.
If operation description does not state otherwise, all attributes of the response array items may be included as sort criteria.

Constructed as comma separated list of sort fields, with optional order marker after colon. Examples:

  • sort=firstName:ASC,lastName:DESC,address.street - result is ordered by first name ascending, last name descending and street part of the address ascending
  • sort=firstName,lastName:DESC - result is ordered by first name ascending and last name descending
  • sort=firstName,lastName - result is ordered by first name ascending and last name ascending
  • sort=:DESC - result is ordered descending by the default field (id)
firstResult
integer <int32>
Default: 0

First item in array points. Indexed from 0.
Only non-negative values.

maxResults
integer <int32>

Max count of items on the page. Default value is from the PROCESSING_DEFAULT_MAX_RESULTS system parameter.
Only non-negative values.

header Parameters
Accept
string

Specifies which content types, expressed as MIME types, are accepted by client.
Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header.
Should be used only when operations specification states that it can handle multiple content types.

Accept-Language
string
Example: pl, en-us

Specifies the client proposed language of the response.
If not provided or if system does not have requested language configured, system will return response in system's configured default language.
Only the MultiLang strings will be translated, other will be returned as stored in the system.

Authorization
string
Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l

OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation.
Bearer token where token is authorization key granted to the client.

X-Correlation-ID
string <= 100 characters

Unique request token for correlation purposes.
When not provided to the request, assigned automatically by the system.

Time-Zone
string <= 100 characters

Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH).
Time zone source hierarchy:

  1. Date (time zone is taken from date format, related only to POST/PUT/PATCH requests).
  2. Header (time zone is taken from this header).
  3. DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter).
  4. UTC timezone is assumed.
Time zone is ignored if incorrect value is provided.
X-Tenant-ID
string <= 100 characters

Tenant identifier.
When not provided to the request, the default identifier will be used.

Responses

Response samples

Content type
application/json
{
  • "expirationPrevention": {
    },
  • "points": [
    ]
}

Balance and Statements


Members like to browse thru transaction history and check the number of added points. Each of them is stored in the System with a unique identifier so you can display all its details. Furthermore, by using a member balance request, you can check the activity of a single member. This comes together with processing coupons assigned to the member and showing the current points balance in the member's profile.

Get member transactions

Get list of member transactions.
Sortable by [transactionId, identifierNo, date, type, points, status, channel, partner, trnNo, location].

Authorizations:
customer_password_scheme (b2c_api_gateway)
query Parameters
id
integer

Unique transaction identifier

identifierNo
string

Loyalty identifier which identifies the customer on which operation will be processed.
Causes transactions search on the identifier level (transactions performed with the identifier).

type
Array of strings

Transactions types codes. TRANSACTION_TYPES dictionary.

status
Array of strings

Transactions statuses codes. TRANSACTION_STATUSES dictionary.

channel
Array of strings

Transactions channels codes. TRANSACTION_CHANNELS dictionary.

partner
string

Code of the partner that participated in the transactions. PARTNERS dictionary.

location
string

Code of the location in which the transactions where processed. LOCATIONS dictionary.
Location codes are unique in the scope of the partner.

trnNo
string

Identifier of the transaction in the partners' external systems.

dateFrom
string <date>

Transaction date lower boundary. Inclusive.

dateTo
string <date>

Transaction date upper boundary. Inclusive.

attributes
string

Allows search only by static attributes. Search is exact (=). When search by multiple attributes is performed they are joined with AND operator.

Examples:

  • attributes=ATTR_A:1;ATTR_B:2 - searches for all transactions with ATTR_A=1 and ATTR_B=2
  • attributes=ATTR_A:1;ATTR_C;ATTR_B:2 - searches for all transactions with ATTR_A=1 and ATTR_B=2 and ATTR_C is empty

DateTime and Date attributes must be sent with a time zones:
Datetime examples:

  • 2020-08-07T11:00:00Z02:00 for GMT+02:00
  • 2020-08-07T11:00:00Z-02:00 for GMT-02:00
    Date examples:
  • 2020-08-07Z02:00 for GMT+02:00
  • 2020-08-07Z-02:00 for GMT-02:00
with
Array of strings
Items Enum: "attributes" "products" "triggeredRules"

Appends to every response item additional content that is not appended by default to boost lists performance.
Note: Requesting more item data in the responses which are lists may impact performance.
Supports [attributes, products, triggeredRules].

sort
string
Default: "date:DESC"

Defines the sort order of the resulting list of objects.
Available sort orders: ASCENDING, ASC, ascending, asc, 1, DESCENDING, DESC, descending, desc, -1.
If operation description does not state otherwise, default order field is 'id' and the default order is ascending.
If operation description does not state otherwise, all attributes of the response array items may be included as sort criteria.

Constructed as comma separated list of sort fields, with optional order marker after colon. Examples:

  • sort=firstName:ASC,lastName:DESC,address.street - result is ordered by first name ascending, last name descending and street part of the address ascending
  • sort=firstName,lastName:DESC - result is ordered by first name ascending and last name descending
  • sort=firstName,lastName - result is ordered by first name ascending and last name ascending
  • sort=:DESC - result is ordered descending by the default field (id)
firstResult
integer <int32>
Default: 0

First item on the page. Indexed from 0.
Only non-negative values.

maxResults
integer <int32>

Max count of items on the page. Default value is from the PROCESSING_DEFAULT_MAX_RESULTS system parameter.
Only non-negative values.

header Parameters
Accept
string

Specifies which content types, expressed as MIME types, are accepted by client.
Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header.
Should be used only when operations specification states that it can handle multiple content types.

Accept-Language
string
Example: pl, en-us

Specifies the client proposed language of the response.
If not provided or if system does not have requested language configured, system will return response in system's configured default language.
Only the MultiLang strings will be translated, other will be returned as stored in the system.

Authorization
string
Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l

OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation.
Bearer token where token is authorization key granted to the client.

X-Correlation-ID
string <= 100 characters

Unique request token for correlation purposes.
When not provided to the request, assigned automatically by the system.

Time-Zone
string <= 100 characters

Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH).
Time zone source hierarchy:

  1. Date (time zone is taken from date format, related only to POST/PUT/PATCH requests).
  2. Header (time zone is taken from this header).
  3. DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter).
  4. UTC timezone is assumed.
Time zone is ignored if incorrect value is provided.
X-Tenant-ID
string <= 100 characters

Tenant identifier.
When not provided to the request, the default identifier will be used.

Responses

Response samples

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

Get member transaction

Get details of single transaction belonging to the member profile.
Transaction results depend on transaction type and system configuration.

Authorizations:
customer_password_scheme (b2c_api_gateway)
path Parameters
transactionId
required
integer

Transaction internal unique identifier

header Parameters
Accept
string

Specifies which content types, expressed as MIME types, are accepted by client.
Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header.
Should be used only when operations specification states that it can handle multiple content types.

Accept-Language
string
Example: pl, en-us

Specifies the client proposed language of the response.
If not provided or if system does not have requested language configured, system will return response in system's configured default language.
Only the MultiLang strings will be translated, other will be returned as stored in the system.

Authorization
string
Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l

OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation.
Bearer token where token is authorization key granted to the client.

X-Correlation-ID
string <= 100 characters

Unique request token for correlation purposes.
When not provided to the request, assigned automatically by the system.

Time-Zone
string <= 100 characters

Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH).
Time zone source hierarchy:

  1. Date (time zone is taken from date format, related only to POST/PUT/PATCH requests).
  2. Header (time zone is taken from this header).
  3. DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter).
  4. UTC timezone is assumed.
Time zone is ignored if incorrect value is provided.
X-Tenant-ID
string <= 100 characters

Tenant identifier.
When not provided to the request, the default identifier will be used.

Responses

Response samples

Content type
application/json
{
  • "transactionId": 0,
  • "customerLogin": "string",
  • "identifierId": 0,
  • "identifierNo": "string",
  • "date": "2019-08-24T14:15:22Z",
  • "type": "st",
  • "typeName": "string",
  • "status": "s",
  • "statusName": "string",
  • "channel": "s",
  • "channelName": "string",
  • "partner": "string",
  • "partnerName": "string",
  • "location": "string",
  • "locationName": "string",
  • "trnNo": "string",
  • "basicPoints": 0,
  • "basicPointsTypeName": "string",
  • "delayedBasicPoints": 0,
  • "points": [
    ],
  • "delayedPoints": [
    ],
  • "incentiveValue": 0,
  • "discountValue": 0,
  • "totalValue": 0,
  • "currencyCode": "str",
  • "shared": true,
  • "correctionReasonCode": "string",
  • "processDate": "2019-08-24T14:15:22Z",
  • "confirmationDate": "2019-08-24T14:15:22Z",
  • "comment": "string",
  • "triggeredRules": [
    ],
  • "issuedCoupons": [
    ],
  • "burnedCoupons": [
    ],
  • "refundedCoupons": [
    ],
  • "products": [
    ],
  • "attributes": [
    ]
}

Get member coupons

Get list of member regular coupons available at the moment of operation execution.
Sortable by [id, couponTypeCode, couponNumber, issuanceDate, validityStartDate, expiryDate].


Note that there may exist multiple coupons with same couponNumber belonging to different or same customers.

Authorizations:
customer_password_scheme (b2c_api_gateway)
query Parameters
filter
string >= 3 characters

Full text search query.
Matches [couponTypeCode, couponNumber].

couponTypeCode
Array of strings

Coupon type codes list. CLOUD_COUPON_TYPES dictionary.

couponNumber
Array of strings

Coupon numbers list

deliveryChannelCode
Array of strings

Coupon delivery channels codes list. COUPON_DELIVERY_CHANNELS dictionary.
When empty, coupons for all delivery channels are returned.

expiryDateFrom
string <date>

Coupon expiration date - lower limit. Inclusive.

expiryDateTo
string <date>

Coupon expiration date - upper limit. Inclusive.

sort
string
Default: "issuanceDate:DESC, expiryDate:ASC"

Defines the sort order of the resulting list of objects.
Available sort orders: ASCENDING, ASC, ascending, asc, 1, DESCENDING, DESC, descending, desc, -1.
If operation description does not state otherwise, default order field is 'id' and the default order is ascending.
If operation description does not state otherwise, all attributes of the response array items may be included as sort criteria.

Constructed as comma separated list of sort fields, with optional order marker after colon. Examples:

  • sort=firstName:ASC,lastName:DESC,address.street - result is ordered by first name ascending, last name descending and street part of the address ascending
  • sort=firstName,lastName:DESC - result is ordered by first name ascending and last name descending
  • sort=firstName,lastName - result is ordered by first name ascending and last name ascending
  • sort=:DESC - result is ordered descending by the default field (id)
firstResult
integer <int32>
Default: 0

First item on the page. Indexed from 0.
Only non-negative values.

maxResults
integer <int32>

Max count of items on the page. Default value is from the PROCESSING_DEFAULT_MAX_RESULTS system parameter.
Only non-negative values.

header Parameters
Content-Type
string

Request content type as MIME type.
By default application/json, unless operation's request specification says otherwise.

Accept
string

Specifies which content types, expressed as MIME types, are accepted by client.
Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header.
Should be used only when operations specification states that it can handle multiple content types.

Accept-Language
string
Example: pl, en-us

Specifies the client proposed language of the response.
If not provided or if system does not have requested language configured, system will return response in system's configured default language.
Only the MultiLang strings will be translated, other will be returned as stored in the system.

Authorization
string
Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l

OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation.
Bearer token where token is authorization key granted to the client.

X-Correlation-ID
string <= 100 characters

Unique request token for correlation purposes.
When not provided to the request, assigned automatically by the system.

Time-Zone
string <= 100 characters

Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH).
Time zone source hierarchy:

  1. Date (time zone is taken from date format, related only to POST/PUT/PATCH requests).
  2. Header (time zone is taken from this header).
  3. DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter).
  4. UTC timezone is assumed.
Time zone is ignored if incorrect value is provided.
X-Tenant-ID
string <= 100 characters

Tenant identifier.
When not provided to the request, the default identifier will be used.

Responses

Response samples

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

Get member balances

Get member points balances.
Returns breakdown of all points by point type.

Authorizations:
customer_password_scheme (b2c_api_gateway)
header Parameters
Accept
string

Specifies which content types, expressed as MIME types, are accepted by client.
Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header.
Should be used only when operations specification states that it can handle multiple content types.

Accept-Language
string
Example: pl, en-us

Specifies the client proposed language of the response.
If not provided or if system does not have requested language configured, system will return response in system's configured default language.
Only the MultiLang strings will be translated, other will be returned as stored in the system.

Authorization
string
Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l

OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation.
Bearer token where token is authorization key granted to the client.

X-Correlation-ID
string <= 100 characters

Unique request token for correlation purposes.
When not provided to the request, assigned automatically by the system.

Time-Zone
string <= 100 characters

Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH).
Time zone source hierarchy:

  1. Date (time zone is taken from date format, related only to POST/PUT/PATCH requests).
  2. Header (time zone is taken from this header).
  3. DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter).
  4. UTC timezone is assumed.
Time zone is ignored if incorrect value is provided.
X-Tenant-ID
string <= 100 characters

Tenant identifier.
When not provided to the request, the default identifier will be used.

Responses

Response samples

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

Get member main balance

Get member's basic points balance.

Authorizations:
customer_password_scheme (b2c_api_gateway)
header Parameters
Accept
string

Specifies which content types, expressed as MIME types, are accepted by client.
Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header.
Should be used only when operations specification states that it can handle multiple content types.

Accept-Language
string
Example: pl, en-us

Specifies the client proposed language of the response.
If not provided or if system does not have requested language configured, system will return response in system's configured default language.
Only the MultiLang strings will be translated, other will be returned as stored in the system.

Authorization
string
Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l

OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation.
Bearer token where token is authorization key granted to the client.

X-Correlation-ID
string <= 100 characters

Unique request token for correlation purposes.
When not provided to the request, assigned automatically by the system.

Time-Zone
string <= 100 characters

Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH).
Time zone source hierarchy:

  1. Date (time zone is taken from date format, related only to POST/PUT/PATCH requests).
  2. Header (time zone is taken from this header).
  3. DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter).
  4. UTC timezone is assumed.
Time zone is ignored if incorrect value is provided.
X-Tenant-ID
string <= 100 characters

Tenant identifier.
When not provided to the request, the default identifier will be used.

Responses

Response samples

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

Identifiers


Each member of the loyalty program has a unique ID number. With this number, all kinds of transactions can be performed, and what's most important, a member can be unequivocally identified with it. In addition, this method allows checking in-depth details regarding a member's ID, such as visual mode, status or type (internal/external), etc., or generating a list of all IDs assigned to one member.

Get member identifiers

Get list of all identifiers belonging to the member

Authorizations:
customer_password_scheme (b2c_api_gateway)
header Parameters
Accept
string

Specifies which content types, expressed as MIME types, are accepted by client.
Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header.
Should be used only when operations specification states that it can handle multiple content types.

Accept-Language
string
Example: pl, en-us

Specifies the client proposed language of the response.
If not provided or if system does not have requested language configured, system will return response in system's configured default language.
Only the MultiLang strings will be translated, other will be returned as stored in the system.

Authorization
string
Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l

OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation.
Bearer token where token is authorization key granted to the client.

X-Correlation-ID
string <= 100 characters

Unique request token for correlation purposes.
When not provided to the request, assigned automatically by the system.

Time-Zone
string <= 100 characters

Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH).
Time zone source hierarchy:

  1. Date (time zone is taken from date format, related only to POST/PUT/PATCH requests).
  2. Header (time zone is taken from this header).
  3. DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter).
  4. UTC timezone is assumed.
Time zone is ignored if incorrect value is provided.
X-Tenant-ID
string <= 100 characters

Tenant identifier.
When not provided to the request, the default identifier will be used.

Responses

Response samples

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

Get member identifier

Get details of the member's identifier

Authorizations:
customer_password_scheme (b2c_api_gateway)
path Parameters
identifierNo
required
string

Unique loyalty card identifier number

query Parameters
fields
string

When present, limits the fields in the response to the specified list, otherwise whole response is returned.
Items on the list are separated by semicolon. Parent-child relations are indicated by dot.
For example fields=responseFieldX;responseFieldY;responseObjectZ.ZobjectChildField.

header Parameters
Accept
string

Specifies which content types, expressed as MIME types, are accepted by client.
Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header.
Should be used only when operations specification states that it can handle multiple content types.

Accept-Language
string
Example: pl, en-us

Specifies the client proposed language of the response.
If not provided or if system does not have requested language configured, system will return response in system's configured default language.
Only the MultiLang strings will be translated, other will be returned as stored in the system.

Authorization
string
Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l

OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation.
Bearer token where token is authorization key granted to the client.

X-Correlation-ID
string <= 100 characters

Unique request token for correlation purposes.
When not provided to the request, assigned automatically by the system.

Time-Zone
string <= 100 characters

Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH).
Time zone source hierarchy:

  1. Date (time zone is taken from date format, related only to POST/PUT/PATCH requests).
  2. Header (time zone is taken from this header).
  3. DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter).
  4. UTC timezone is assumed.
Time zone is ignored if incorrect value is provided.
X-Tenant-ID
string <= 100 characters

Tenant identifier.
When not provided to the request, the default identifier will be used.

Responses

Response samples

Content type
application/json
{
  • "identifierNo": "string",
  • "identifierTypeCode": "string",
  • "identifierTypeName": "string",
  • "visualMode": "string",
  • "status": "s",
  • "statusName": "string",
  • "main": true,
  • "assignmentDate": "2019-08-24",
  • "blockedReason": "string",
  • "blockedByUserId": 0,
  • "firstTrnDate": "2019-08-24",
  • "lastTrnDate": "2019-08-24",
  • "lastModify": "2019-08-24T14:15:22Z"
}

Rewards & Coupons


This set of methods works in both ways – you can display generic info about all active and configured coupons in your program, and, on the other hand, you can show individual coupons dedicated to member and assigned to his loyalty identifier by any type of campaign. Member can find the names, validity dates, value, and coupon code on his account.
Browsing through rewards with colorful images and checking their price in points and availability is one of the most frequent member activities in the program. In addition, you can display the whole catalog with many details to show the attractiveness of your program.
Last but not least, the member can redeem points (simulated or processed for available rewards).

Redeem points to get a reward

Process or simulate redemption transaction for the member.
Redeems basing on business rules and rewards catalogue.

Authorizations:
customer_password_scheme (b2c_api_gateway)
query Parameters
simulate
boolean
Default: false

True enable simulation mode.
In this mode response of the operation informs about effect of the operation as if it was executed normally, however execution of the method does not cause any effects in the system. No balance, statements or any other persisted state is altered.

header Parameters
Accept
string

Specifies which content types, expressed as MIME types, are accepted by client.
Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header.
Should be used only when operations specification states that it can handle multiple content types.

Accept-Language
string
Example: pl, en-us

Specifies the client proposed language of the response.
If not provided or if system does not have requested language configured, system will return response in system's configured default language.
Only the MultiLang strings will be translated, other will be returned as stored in the system.

Authorization
string
Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l

OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation.
Bearer token where token is authorization key granted to the client.

X-Correlation-ID
string <= 100 characters

Unique request token for correlation purposes.
When not provided to the request, assigned automatically by the system.

Time-Zone
string <= 100 characters

Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH).
Time zone source hierarchy:

  1. Date (time zone is taken from date format, related only to POST/PUT/PATCH requests).
  2. Header (time zone is taken from this header).
  3. DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter).
  4. UTC timezone is assumed.
Time zone is ignored if incorrect value is provided.
X-Tenant-ID
string <= 100 characters

Tenant identifier.
When not provided to the request, the default identifier will be used.

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

Partner transaction number

comment
string <= 400 characters

Transaction comment

required
Array of objects (types.OrderItem)

List of rewards in basket

deliveryMethod
string

Delivery method code. REWARD_DELIVERY_METHODS dictionary.
Required for rewards that are not Online.

object

Delivery location details.
Required for deliveryMethod = L (Location).

object

Delivery address details.
Required for deliveryMethod = H (Home).

Responses

Request samples

Content type
application/json
{
  • "trnNo": "string",
  • "comment": "string",
  • "rewards": [
    ],
  • "deliveryMethod": "string",
  • "deliveryLocation": {
    },
  • "deliveryAddress": {
    }
}

Response samples

Content type
application/json
{
  • "transactionId": 0,
  • "status": "s",
  • "statusName": "string",
  • "orderId": 0,
  • "transactionPoints": {
    },
  • "memberBalance": {
    },
  • "incentiveValue": 0,
  • "productsDiscountValue": 0,
  • "billDiscountValue": 0,
  • "discountValue": 0,
  • "paymentValue": 0,
  • "messages": [
    ],
  • "products": [
    ],
  • "billDiscountPromotions": [
    ],
  • "issuedCoupons": [
    ],
  • "burnedCoupons": [
    ],
  • "refundedCoupons": [
    ]
}

Get reward categories

Get list of reward categories.
Sortable by [code, name, description, parentCategory, categoryOrder].

query Parameters
filter
string >= 3 characters

Full text search query.
Matches [code, name].

code
Array of strings

List of reward category codes. REWARD_CATEGORIES dictionary.

name
string

Reward category name.

description
string

Reward category description.

parentCategory
Array of strings

List of associated upper level categories codes. REWARD_CATEGORIES dictionary.

root
boolean

When true returns only root level categories, when false returns all categories.
Default value is false

sort
string
Default: "id:ASC"

Defines the sort order of the resulting list of objects.
Available sort orders: ASCENDING, ASC, ascending, asc, 1, DESCENDING, DESC, descending, desc, -1.
If operation description does not state otherwise, default order field is 'id' and the default order is ascending.
If operation description does not state otherwise, all attributes of the response array items may be included as sort criteria.

Constructed as comma separated list of sort fields, with optional order marker after colon. Examples:

  • sort=firstName:ASC,lastName:DESC,address.street - result is ordered by first name ascending, last name descending and street part of the address ascending
  • sort=firstName,lastName:DESC - result is ordered by first name ascending and last name descending
  • sort=firstName,lastName - result is ordered by first name ascending and last name ascending
  • sort=:DESC - result is ordered descending by the default field (id)
firstResult
integer <int32>
Default: 0

First item on the page. Indexed from 0.
Only non-negative values.

maxResults
integer <int32>

Max count of items on the page. Default value is from the PROCESSING_DEFAULT_MAX_RESULTS system parameter.
Only non-negative values.

header Parameters
Content-Type
string

Request content type as MIME type.
By default application/json, unless operation's request specification says otherwise.

Accept
string

Specifies which content types, expressed as MIME types, are accepted by client.
Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header.
Should be used only when operations specification states that it can handle multiple content types.

Accept-Language
string
Example: pl, en-us

Specifies the client proposed language of the response.
If not provided or if system does not have requested language configured, system will return response in system's configured default language.
Only the MultiLang strings will be translated, other will be returned as stored in the system.

X-Correlation-ID
string <= 100 characters

Unique request token for correlation purposes.
When not provided to the request, assigned automatically by the system.

Time-Zone
string <= 100 characters

Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH).
Time zone source hierarchy:

  1. Date (time zone is taken from date format, related only to POST/PUT/PATCH requests).
  2. Header (time zone is taken from this header).
  3. DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter).
  4. UTC timezone is assumed.
Time zone is ignored if incorrect value is provided.
X-Tenant-ID
string <= 100 characters

Tenant identifier.
When not provided to the request, the default identifier will be used.

Responses

Response samples

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

Get rewards

Get list of rewards which are currently active and have an unlimited quantity.
Sortable by [code, name, categoryOrder, auditCD, pricePlan.points, type, startDate, endDate]. Sorting by pricePlan.points uses the default system point type by default, the pricePlan.pointType filter can be used to specify the desired one.

query Parameters
filter
string >= 3 characters

Full text search query.
Matches [code, externalName, externalDescription].

code
Array of strings

List of reward codes. REWARDS dictionary.

name
string

Reward name

category
Array of strings

List of category codes of the reward. REWARD_CATEGORIES dictionary.

Note: Searches just directly under the given reward categories.

masterCategory
Array of strings

List of category codes of the reward. REWARD_CATEGORIES dictionary.


Note: Searches recursively under the given reward categories and their subcategories.

type
Array of strings

List of reward type codes. REWARD_TYPES dictionary.

startDate
string <date>

Reward available since date. Inclusive.

endDate
string <date>

Reward available to date. Inclusive.
Rewards with empty endDate are returned regardless of this filter.

period
string
Enum: "D" "W" "M" "Y"

Convenience way for defining reward availability date range.
Ignored when at least one of startDate, endDate criteria is provided.
Available options:

  • D - Today
  • W - This week
  • M - This month
  • Y - This year
partner
Array of strings

Codes of reward partners. PARTNERS dictionary.

pricePlan.code
Array of strings

List of reward price plan codes

pricePlan.channel
Array of strings

List of reward price plan channel codes. REWARD_ORDER_CHANNELS dictionary.
Filters rewards available via specified channel or all channels.

pricePlan.pointsFrom
integer

Minimum points amount set in the price plan. Inclusive. Minimum amount of points that customer is willing to pay for reward.

pricePlan.pointsTo
integer

Maximum points amount set in the price plan. Inclusive. Maximum amount of points that customer is willing to pay for reward.

pricePlan.pointType
Array of strings

Price plan related point type codes. POINT_TYPES dictionary.
Useful for search for rewards achievable with possessed point types.

pricePlan.startDate
string <date>

Reward price plan available since. Inclusive.
Rewards with empty pricePlan.startDate are returned regardless of this filter.

pricePlan.endDate
string <date>

Reward price plan available to. Inclusive.
Rewards with empty pricePlan.endDate are returned regardless of this filter.

pricePlan.period
string
Enum: "D" "W" "M" "Y"

Convenience way for defining reward price plan availability date range.
Is ignored when at least one of pricePlan.startDate, pricePlan.endDate criteria is provided.
Available options:

  • D - Today
  • W - This week
  • M - This month
  • Y - This year
sort
string
Default: "id:ASC"

Defines the sort order of the resulting list of objects.
Available sort orders: ASCENDING, ASC, ascending, asc, 1, DESCENDING, DESC, descending, desc, -1.
If operation description does not state otherwise, default order field is 'id' and the default order is ascending.
If operation description does not state otherwise, all attributes of the response array items may be included as sort criteria.

Constructed as comma separated list of sort fields, with optional order marker after colon. Examples:

  • sort=firstName:ASC,lastName:DESC,address.street - result is ordered by first name ascending, last name descending and street part of the address ascending
  • sort=firstName,lastName:DESC - result is ordered by first name ascending and last name descending
  • sort=firstName,lastName - result is ordered by first name ascending and last name ascending
  • sort=:DESC - result is ordered descending by the default field (id)
firstResult
integer <int32>
Default: 0

First item on the page. Indexed from 0.
Only non-negative values.

maxResults
integer <int32>

Max count of items on the page. Default value is from the PROCESSING_DEFAULT_MAX_RESULTS system parameter.
Only non-negative values.

with
Array of strings
Items Enum: "pricePlans" "resources" "supplier"

Appends to every response item additional content that is not appended by default to boost lists performance.
Note: Requesting more item data in the responses which are lists may impact performance.
Supports [pricePlans, resources, supplier].

header Parameters
Content-Type
string

Request content type as MIME type.
By default application/json, unless operation's request specification says otherwise.

Accept
string

Specifies which content types, expressed as MIME types, are accepted by client.
Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header.
Should be used only when operations specification states that it can handle multiple content types.

Accept-Language
string
Example: pl, en-us

Specifies the client proposed language of the response.
If not provided or if system does not have requested language configured, system will return response in system's configured default language.
Only the MultiLang strings will be translated, other will be returned as stored in the system.

X-Correlation-ID
string <= 100 characters

Unique request token for correlation purposes.
When not provided to the request, assigned automatically by the system.

Time-Zone
string <= 100 characters

Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH).
Time zone source hierarchy:

  1. Date (time zone is taken from date format, related only to POST/PUT/PATCH requests).
  2. Header (time zone is taken from this header).
  3. DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter).
  4. UTC timezone is assumed.
Time zone is ignored if incorrect value is provided.
X-Tenant-ID
string <= 100 characters

Tenant identifier.
When not provided to the request, the default identifier will be used.

Responses

Response samples

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

Get member targeted rewards

Get list of member targeted rewards which are currently active.
Sortable by [code, name, categoryOrder, auditCD, pricePlan.points, type, startDate, endDate]. Sorting by pricePlan.points uses the default system point type by default, the pricePlan.pointType filter can be used to specify the desired one.

Authorizations:
customer_password_scheme (b2c_api_gateway)
query Parameters
filter
string >= 3 characters

Full text search query.
Matches [code, externalName, externalDescription].

code
Array of strings

List of reward codes. REWARDS dictionary.

name
string

Reward name

category
Array of strings

List of category codes of the reward. REWARD_CATEGORIES dictionary.

Note: Searches just directly under the given reward categories.

masterCategory
Array of strings

List of category codes of the reward. REWARD_CATEGORIES dictionary.


Note: Searches recursively under the given reward categories and their subcategories.

type
Array of strings

List of reward type codes. REWARD_TYPES dictionary.

startDate
string <date>

Reward available since date. Inclusive.

endDate
string <date>

Reward available to date. Inclusive.
Rewards with empty endDate are returned regardless of this filter.

period
string
Enum: "D" "W" "M" "Y"

Convenience way for defining reward availability date range.
Ignored when at least one of startDate, endDate criteria is provided.
Available options:

  • D - Today
  • W - This week
  • M - This month
  • Y - This year
partner
Array of strings

Codes of reward partners. PARTNERS dictionary.

pricePlan.code
Array of strings

List of reward price plan codes

pricePlan.channel
Array of strings

List of reward price plan channel codes. REWARD_ORDER_CHANNELS dictionary.
Filters rewards available via specified channel or all channels.

pricePlan.pointsFrom
integer

Minimum points amount set in the price plan. Inclusive. Minimum amount of points that customer is willing to pay for reward.

pricePlan.pointsTo
integer

Maximum points amount set in the price plan. Inclusive. Maximum amount of points that customer is willing to pay for reward.

pricePlan.pointType
Array of strings

Price plan related point type codes. POINT_TYPES dictionary.
Useful for search for rewards achievable with possessed point types.

pricePlan.startDate
string <date>

Reward price plan available since. Inclusive.
Rewards with empty pricePlan.startDate are returned regardless of this filter.

pricePlan.endDate
string <date>

Reward price plan available to. Inclusive.
Rewards with empty pricePlan.endDate are returned regardless of this filter.

pricePlan.period
string
Enum: "D" "W" "M" "Y"

Convenience way for defining reward price plan availability date range.
Is ignored when at least one of pricePlan.startDate, pricePlan.endDate criteria is provided.
Available options:

  • D - Today
  • W - This week
  • M - This month
  • Y - This year
sort
string
Default: "id:ASC"

Defines the sort order of the resulting list of objects.
Available sort orders: ASCENDING, ASC, ascending, asc, 1, DESCENDING, DESC, descending, desc, -1.
If operation description does not state otherwise, default order field is 'id' and the default order is ascending.
If operation description does not state otherwise, all attributes of the response array items may be included as sort criteria.

Constructed as comma separated list of sort fields, with optional order marker after colon. Examples:

  • sort=firstName:ASC,lastName:DESC,address.street - result is ordered by first name ascending, last name descending and street part of the address ascending
  • sort=firstName,lastName:DESC - result is ordered by first name ascending and last name descending
  • sort=firstName,lastName - result is ordered by first name ascending and last name ascending
  • sort=:DESC - result is ordered descending by the default field (id)
firstResult
integer <int32>
Default: 0

First item on the page. Indexed from 0.
Only non-negative values.

maxResults
integer <int32>

Max count of items on the page. Default value is from the PROCESSING_DEFAULT_MAX_RESULTS system parameter.
Only non-negative values.

specialForYou
boolean

Filter out rewards that do not belong to any segment.
Set on true returns rewards that are only available in one of customer segments.
Set on false returns all rewards available to customer.

with
Array of strings
Items Enum: "pricePlans" "resources" "supplier"

Appends to every response item additional content that is not appended by default to boost lists performance.
Note: Requesting more item data in the responses which are lists may impact performance.
Supports [pricePlans, resources, supplier].

header Parameters
Content-Type
string

Request content type as MIME type.
By default application/json, unless operation's request specification says otherwise.

Accept
string

Specifies which content types, expressed as MIME types, are accepted by client.
Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header.
Should be used only when operations specification states that it can handle multiple content types.

Accept-Language
string
Example: pl, en-us

Specifies the client proposed language of the response.
If not provided or if system does not have requested language configured, system will return response in system's configured default language.
Only the MultiLang strings will be translated, other will be returned as stored in the system.

X-Correlation-ID
string <= 100 characters

Unique request token for correlation purposes.
When not provided to the request, assigned automatically by the system.

Time-Zone
string <= 100 characters

Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH).
Time zone source hierarchy:

  1. Date (time zone is taken from date format, related only to POST/PUT/PATCH requests).
  2. Header (time zone is taken from this header).
  3. DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter).
  4. UTC timezone is assumed.
Time zone is ignored if incorrect value is provided.
X-Tenant-ID
string <= 100 characters

Tenant identifier.
When not provided to the request, the default identifier will be used.

Responses

Response samples

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

Get reward

Get reward details

path Parameters
rewardCode
required
string >= 3 characters

Target reward unique code

query Parameters
pricePlanDate
string <date>
Example: pricePlanDate=2018-09-01

Effective date for price plan.
When not provided all price plans for reward will be returned.

header Parameters
Content-Type
string

Request content type as MIME type.
By default application/json, unless operation's request specification says otherwise.

Accept
string

Specifies which content types, expressed as MIME types, are accepted by client.
Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header.
Should be used only when operations specification states that it can handle multiple content types.

Accept-Language
string
Example: pl, en-us

Specifies the client proposed language of the response.
If not provided or if system does not have requested language configured, system will return response in system's configured default language.
Only the MultiLang strings will be translated, other will be returned as stored in the system.

X-Correlation-ID
string <= 100 characters

Unique request token for correlation purposes.
When not provided to the request, assigned automatically by the system.

Time-Zone
string <= 100 characters

Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH).
Time zone source hierarchy:

  1. Date (time zone is taken from date format, related only to POST/PUT/PATCH requests).
  2. Header (time zone is taken from this header).
  3. DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter).
  4. UTC timezone is assumed.
Time zone is ignored if incorrect value is provided.
X-Tenant-ID
string <= 100 characters

Tenant identifier.
When not provided to the request, the default identifier will be used.

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "externalName": "string",
  • "externalDescription": "string",
  • "type": "s",
  • "category": "string",
  • "masterCategory": "string",
  • "couponTypeCode": "string",
  • "categoryOrder": 0,
  • "status": "s",
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "attributes": [
    ],
  • "partner": "string",
  • "netValue": 0,
  • "tax": "string",
  • "deliveryMethod": "s",
  • "quantity": 1,
  • "orderRequiresApproval": false,
  • "maximumRedemptionsAllowed": 1,
  • "nonMaterial": true,
  • "statusName": "string",
  • "partnerName": "string",
  • "typeName": "string",
  • "categoryName": "string",
  • "masterCategoryName": "string",
  • "supplier": "string",
  • "rewardSupplier": {
    },
  • "pricePlans": [
    ],
  • "resources": {
    },
  • "lastModify": "2019-08-24T14:15:22Z",
  • "creationDate": "2019-08-24T14:15:22Z"
}

Get mass campaigns

Get list of wide audience campaigns which are currently active in the current time period.
It returns active coupons with the Mass campaign type, which are visible to non-logged in users (i.e. broadcast = true).
Sortable by [code, name, distributionMode].

query Parameters
filter
string >= 3 characters

Full text search query.
Matches [code, name].

code
Array of strings

List of coupon type codes. CLOUD_COUPON_TYPES dictionary.

excludeCode
Array of strings

List of coupon types codes that should be excluded from the result. CLOUD_COUPON_TYPES dictionary.

deliveryChannelCode
Array of strings

Codes of coupon delivery channels. COUPON_DELIVERY_CHANNELS dictionary.

deliveryStartDateFrom
string <date>

Coupon earliest delivery start date - lower limit. Inclusive.
Earlist delivery.startDate on configured coupon delivery channels.

deliveryStartDateTo
string <date>

Coupon earliest delivery start date - upper limit. Inclusive.
Earlist delivery.startDate on configured coupon delivery channels.

validityEndDateFrom
string <date>

Coupon validity end date - lower limit. Inclusive.
Coupon types with validity.unlimited=true or empty validity end date) are returned regardless of this filter.

validityEndDateTo
string <date>

Coupon validity end date - upper limit. Inclusive.
Coupon types with validity.unlimited=true or empty validity end date) are returned regardless of this filter.

tags
Array of strings

Coupon type tags.

sort
string
Default: "id:ASC"

Defines the sort order of the resulting list of objects.
Available sort orders: ASCENDING, ASC, ascending, asc, 1, DESCENDING, DESC, descending, desc, -1.
If operation description does not state otherwise, default order field is 'id' and the default order is ascending.
If operation description does not state otherwise, all attributes of the response array items may be included as sort criteria.

Constructed as comma separated list of sort fields, with optional order marker after colon. Examples:

  • sort=firstName:ASC,lastName:DESC,address.street - result is ordered by first name ascending, last name descending and street part of the address ascending
  • sort=firstName,lastName:DESC - result is ordered by first name ascending and last name descending
  • sort=firstName,lastName - result is ordered by first name ascending and last name ascending
  • sort=:DESC - result is ordered descending by the default field (id)
firstResult
integer <int32>
Default: 0

First item on the page. Indexed from 0.
Only non-negative values.

maxResults
integer <int32>

Max count of items on the page. Default value is from the PROCESSING_DEFAULT_MAX_RESULTS system parameter.
Only non-negative values.

header Parameters
Content-Type
string

Request content type as MIME type.
By default application/json, unless operation's request specification says otherwise.

Accept
string

Specifies which content types, expressed as MIME types, are accepted by client.
Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header.
Should be used only when operations specification states that it can handle multiple content types.

Accept-Language
string
Example: pl, en-us

Specifies the client proposed language of the response.
If not provided or if system does not have requested language configured, system will return response in system's configured default language.
Only the MultiLang strings will be translated, other will be returned as stored in the system.

Authorization
string
Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l

OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation.
Bearer token where token is authorization key granted to the client.

X-Correlation-ID
string <= 100 characters

Unique request token for correlation purposes.
When not provided to the request, assigned automatically by the system.

Time-Zone
string <= 100 characters

Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH).
Time zone source hierarchy:

  1. Date (time zone is taken from date format, related only to POST/PUT/PATCH requests).
  2. Header (time zone is taken from this header).
  3. DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter).
  4. UTC timezone is assumed.
Time zone is ignored if incorrect value is provided.
X-Tenant-ID
string <= 100 characters

Tenant identifier.
When not provided to the request, the default identifier will be used.

Responses

Response samples

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

Get member targeted campaigns

Get list of member targeted campaigns which are currently active in the current time period.
Sortable by [code, name, id, distributionMode].

Authorizations:
customer_password_scheme (b2c_api_gateway)
query Parameters
filter
string >= 3 characters

Full text search query.
Matches [code, name].

code
Array of strings

List of coupon type codes. CLOUD_COUPON_TYPES dictionary.

excludeCode
Array of strings

List of coupon types codes that should be excluded from the result. CLOUD_COUPON_TYPES dictionary.

deliveryChannelCode
Array of strings

Codes of coupon delivery channels. COUPON_DELIVERY_CHANNELS dictionary.

deliveryStartDateFrom
string <date>

Coupon earliest delivery start date - lower limit. Inclusive.
Earlist delivery.startDate on configured coupon delivery channels.

deliveryStartDateTo
string <date>

Coupon earliest delivery start date - upper limit. Inclusive.
Earlist delivery.startDate on configured coupon delivery channels.

validityEndDateFrom
string <date>

Coupon validity end date - lower limit. Inclusive.
Coupon types with validity.unlimited=true or empty validity end date) are returned regardless of this filter.

validityEndDateTo
string <date>

Coupon validity end date - upper limit. Inclusive.
Coupon types with validity.unlimited=true or empty validity end date) are returned regardless of this filter.

broadcast
boolean

Filter distributionMode = mass campaign coupon types which are broadcasted or not in any webapp channels.
Applies to the mass campaign coupon types which quantity is not based on segments.

tags
Array of strings

Coupon type tags.

sort
string
Default: "id:ASC"

Defines the sort order of the resulting list of objects.
Available sort orders: ASCENDING, ASC, ascending, asc, 1, DESCENDING, DESC, descending, desc, -1.
If operation description does not state otherwise, default order field is 'id' and the default order is ascending.
If operation description does not state otherwise, all attributes of the response array items may be included as sort criteria.

Constructed as comma separated list of sort fields, with optional order marker after colon. Examples:

  • sort=firstName:ASC,lastName:DESC,address.street - result is ordered by first name ascending, last name descending and street part of the address ascending
  • sort=firstName,lastName:DESC - result is ordered by first name ascending and last name descending
  • sort=firstName,lastName - result is ordered by first name ascending and last name ascending
  • sort=:DESC - result is ordered descending by the default field (id)
firstResult
integer <int32>
Default: 0

First item on the page. Indexed from 0.
Only non-negative values.

maxResults
integer <int32>

Max count of items on the page. Default value is from the PROCESSING_DEFAULT_MAX_RESULTS system parameter.
Only non-negative values.

header Parameters
Content-Type
string

Request content type as MIME type.
By default application/json, unless operation's request specification says otherwise.

Accept
string

Specifies which content types, expressed as MIME types, are accepted by client.
Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header.
Should be used only when operations specification states that it can handle multiple content types.

Accept-Language
string
Example: pl, en-us

Specifies the client proposed language of the response.
If not provided or if system does not have requested language configured, system will return response in system's configured default language.
Only the MultiLang strings will be translated, other will be returned as stored in the system.

Authorization
string
Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l

OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation.
Bearer token where token is authorization key granted to the client.

X-Correlation-ID
string <= 100 characters

Unique request token for correlation purposes.
When not provided to the request, assigned automatically by the system.

Time-Zone
string <= 100 characters

Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH).
Time zone source hierarchy:

  1. Date (time zone is taken from date format, related only to POST/PUT/PATCH requests).
  2. Header (time zone is taken from this header).
  3. DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter).
  4. UTC timezone is assumed.
Time zone is ignored if incorrect value is provided.
X-Tenant-ID
string <= 100 characters

Tenant identifier.
When not provided to the request, the default identifier will be used.

Responses

Response samples

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

Get coupon type generic data

Get coupon type generic details

path Parameters
couponTypeCode
required
string

Target coupon type code

header Parameters
Content-Type
string

Request content type as MIME type.
By default application/json, unless operation's request specification says otherwise.

Accept
string

Specifies which content types, expressed as MIME types, are accepted by client.
Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header.
Should be used only when operations specification states that it can handle multiple content types.

Accept-Language
string
Example: pl, en-us

Specifies the client proposed language of the response.
If not provided or if system does not have requested language configured, system will return response in system's configured default language.
Only the MultiLang strings will be translated, other will be returned as stored in the system.

Authorization
string
Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l

OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation.
Bearer token where token is authorization key granted to the client.

X-Correlation-ID
string <= 100 characters

Unique request token for correlation purposes.
When not provided to the request, assigned automatically by the system.

Time-Zone
string <= 100 characters

Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH).
Time zone source hierarchy:

  1. Date (time zone is taken from date format, related only to POST/PUT/PATCH requests).
  2. Header (time zone is taken from this header).
  3. DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter).
  4. UTC timezone is assumed.
Time zone is ignored if incorrect value is provided.
X-Tenant-ID
string <= 100 characters

Tenant identifier.
When not provided to the request, the default identifier will be used.

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "externalName": "string",
  • "externalDescription": "string",
  • "status": "s",
  • "statusName": "string",
  • "distributionMode": "string",
  • "distributionModeName": "string",
  • "description": "string",
  • "usageMode": "string",
  • "usageModeName": "string",
  • "distributionModeData": {
    },
  • "interactive": true,
  • "interactionData": {
    },
  • "largeImageId": "string",
  • "smallImageId": "string",
  • "tagsI18N": {
    },
  • "lastModify": "2019-08-24T14:15:22Z"
}

Rewards orders


History of rewards orders with all necessary details such as items, order number (redemptions) to be displayed on customer profile. There is an option to cancel the particular order if such an option is configured in the System.

Get rewards orders

Get list of reward orders.
Sortable by [id, status, deliveryMethod, date].

Authorizations:
customer_password_scheme (b2c_api_gateway)
query Parameters
status
string

Order status. ORDER_STATUSES dictionary.

deliveryMethod
string

Order delivery method code. REWARD_DELIVERY_METHODS dictionary.

dateFrom
string <date>

Order placement date. Lower boundary. Inclusive.

dateTo
string <date>

Order placement date. Upper boundary. Inclusive.

sort
string
Default: "date:DESC"

Defines the sort order of the resulting list of objects.
Available sort orders: ASCENDING, ASC, ascending, asc, 1, DESCENDING, DESC, descending, desc, -1.
If operation description does not state otherwise, default order field is 'id' and the default order is ascending.
If operation description does not state otherwise, all attributes of the response array items may be included as sort criteria.

Constructed as comma separated list of sort fields, with optional order marker after colon. Examples:

  • sort=firstName:ASC,lastName:DESC,address.street - result is ordered by first name ascending, last name descending and street part of the address ascending
  • sort=firstName,lastName:DESC - result is ordered by first name ascending and last name descending
  • sort=firstName,lastName - result is ordered by first name ascending and last name ascending
  • sort=:DESC - result is ordered descending by the default field (id)
firstResult
integer <int32>
Default: 0

First item on the page. Indexed from 0.
Only non-negative values.

maxResults
integer <int32>

Max count of items on the page. Default value is from the PROCESSING_DEFAULT_MAX_RESULTS system parameter.
Only non-negative values.

header Parameters
Content-Type
string

Request content type as MIME type.
By default application/json, unless operation's request specification says otherwise.

Accept
string

Specifies which content types, expressed as MIME types, are accepted by client.
Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header.
Should be used only when operations specification states that it can handle multiple content types.

Accept-Language
string
Example: pl, en-us

Specifies the client proposed language of the response.
If not provided or if system does not have requested language configured, system will return response in system's configured default language.
Only the MultiLang strings will be translated, other will be returned as stored in the system.

Authorization
string
Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l

OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation.
Bearer token where token is authorization key granted to the client.

X-Correlation-ID
string <= 100 characters

Unique request token for correlation purposes.
When not provided to the request, assigned automatically by the system.

Time-Zone
string <= 100 characters

Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH).
Time zone source hierarchy:

  1. Date (time zone is taken from date format, related only to POST/PUT/PATCH requests).
  2. Header (time zone is taken from this header).
  3. DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter).
  4. UTC timezone is assumed.
Time zone is ignored if incorrect value is provided.
X-Tenant-ID
string <= 100 characters

Tenant identifier.
When not provided to the request, the default identifier will be used.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get rewards order by orderId

Get order detailed info

Authorizations:
customer_password_scheme (b2c_api_gateway)
path Parameters
orderId
required
integer

Unique order identifier

header Parameters
Content-Type
string

Request content type as MIME type.
By default application/json, unless operation's request specification says otherwise.

Accept
string

Specifies which content types, expressed as MIME types, are accepted by client.
Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header.
Should be used only when operations specification states that it can handle multiple content types.

Accept-Language
string
Example: pl, en-us

Specifies the client proposed language of the response.
If not provided or if system does not have requested language configured, system will return response in system's configured default language.
Only the MultiLang strings will be translated, other will be returned as stored in the system.

Authorization
string
Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l

OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation.
Bearer token where token is authorization key granted to the client.

X-Correlation-ID
string <= 100 characters

Unique request token for correlation purposes.
When not provided to the request, assigned automatically by the system.

Time-Zone
string <= 100 characters

Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH).
Time zone source hierarchy:

  1. Date (time zone is taken from date format, related only to POST/PUT/PATCH requests).
  2. Header (time zone is taken from this header).
  3. DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter).
  4. UTC timezone is assumed.
Time zone is ignored if incorrect value is provided.
X-Tenant-ID
string <= 100 characters

Tenant identifier.
When not provided to the request, the default identifier will be used.

Responses

Response samples

Content type
application/json
{
  • "orderId": 0,
  • "transactionId": 0,
  • "accountId": 0,
  • "customerId": 0,
  • "identifierNo": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "date": "2019-08-24",
  • "partnerCode": "string",
  • "partnerName": "string",
  • "deliveryMethod": "string",
  • "deliveryMethodName": "string",
  • "status": "st",
  • "statusName": "string",
  • "ownerEmail": "string",
  • "deliveryAddress": {
    },
  • "deliveryLocation": {
    },
  • "comment": "string",
  • "rewards": [
    ],
  • "totalQuantity": 0,
  • "externalId": "string",
  • "ownerMobile": "string",
  • "ownerMobilePhonePrefix": "string",
  • "totalPointTypes": [
    ]
}

Get rewards order by transactionId

Get order detailed info

Authorizations:
customer_password_scheme (b2c_api_gateway)
path Parameters
transactionId
required
integer

Unique transaction identifier

header Parameters
Content-Type
string

Request content type as MIME type.
By default application/json, unless operation's request specification says otherwise.

Accept
string

Specifies which content types, expressed as MIME types, are accepted by client.
Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header.
Should be used only when operations specification states that it can handle multiple content types.

Accept-Language
string
Example: pl, en-us

Specifies the client proposed language of the response.
If not provided or if system does not have requested language configured, system will return response in system's configured default language.
Only the MultiLang strings will be translated, other will be returned as stored in the system.

Authorization
string
Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l

OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation.
Bearer token where token is authorization key granted to the client.

X-Correlation-ID
string <= 100 characters

Unique request token for correlation purposes.
When not provided to the request, assigned automatically by the system.

Time-Zone
string <= 100 characters

Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH).
Time zone source hierarchy:

  1. Date (time zone is taken from date format, related only to POST/PUT/PATCH requests).
  2. Header (time zone is taken from this header).
  3. DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter).
  4. UTC timezone is assumed.
Time zone is ignored if incorrect value is provided.
X-Tenant-ID
string <= 100 characters

Tenant identifier.
When not provided to the request, the default identifier will be used.

Responses

Response samples

Content type
application/json
{
  • "orderId": 0,
  • "transactionId": 0,
  • "accountId": 0,
  • "customerId": 0,
  • "identifierNo": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "date": "2019-08-24",
  • "partnerCode": "string",
  • "partnerName": "string",
  • "deliveryMethod": "string",
  • "deliveryMethodName": "string",
  • "status": "st",
  • "statusName": "string",
  • "ownerEmail": "string",
  • "deliveryAddress": {
    },
  • "deliveryLocation": {
    },
  • "comment": "string",
  • "rewards": [
    ],
  • "totalQuantity": 0,
  • "externalId": "string",
  • "ownerMobile": "string",
  • "ownerMobilePhonePrefix": "string",
  • "totalPointTypes": [
    ]
}

Cancel rewards order by orderId

Authorizations:
customer_password_scheme (b2c_api_gateway)
path Parameters
orderId
required
integer

Unique order identifier

header Parameters
Content-Type
string

Request content type as MIME type.
By default application/json, unless operation's request specification says otherwise.

Accept
string

Specifies which content types, expressed as MIME types, are accepted by client.
Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header.
Should be used only when operations specification states that it can handle multiple content types.

Accept-Language
string
Example: pl, en-us

Specifies the client proposed language of the response.
If not provided or if system does not have requested language configured, system will return response in system's configured default language.
Only the MultiLang strings will be translated, other will be returned as stored in the system.

Authorization
string
Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l

OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation.
Bearer token where token is authorization key granted to the client.

X-Correlation-ID
string <= 100 characters

Unique request token for correlation purposes.
When not provided to the request, assigned automatically by the system.

Time-Zone
string <= 100 characters

Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH).
Time zone source hierarchy:

  1. Date (time zone is taken from date format, related only to POST/PUT/PATCH requests).
  2. Header (time zone is taken from this header).
  3. DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter).
  4. UTC timezone is assumed.
Time zone is ignored if incorrect value is provided.
X-Tenant-ID
string <= 100 characters

Tenant identifier.
When not provided to the request, the default identifier will be used.

Responses

Response samples

Content type
application/json
{
  • "error": "VALIDATION_ERROR",
  • "message": "Validation error: Constraint violations",
  • "method": "PUT",
  • "path": "/profile/customers/12345",
  • "correlationId": "1505219765216595",
  • "status": 400,
  • "timestamp": "2017-09-12T12:36:05.217Z",
  • "violations": [
    ]
}

Cancel rewards order by transactionId

Authorizations:
customer_password_scheme (b2c_api_gateway)
path Parameters
transactionId
required
integer

Unique transaction identifier

header Parameters
Content-Type
string

Request content type as MIME type.
By default application/json, unless operation's request specification says otherwise.

Accept
string

Specifies which content types, expressed as MIME types, are accepted by client.
Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header.
Should be used only when operations specification states that it can handle multiple content types.

Accept-Language
string
Example: pl, en-us

Specifies the client proposed language of the response.
If not provided or if system does not have requested language configured, system will return response in system's configured default language.
Only the MultiLang strings will be translated, other will be returned as stored in the system.

Authorization
string
Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l

OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation.
Bearer token where token is authorization key granted to the client.

X-Correlation-ID
string <= 100 characters

Unique request token for correlation purposes.
When not provided to the request, assigned automatically by the system.

Time-Zone
string <= 100 characters

Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH).
Time zone source hierarchy:

  1. Date (time zone is taken from date format, related only to POST/PUT/PATCH requests).
  2. Header (time zone is taken from this header).
  3. DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter).
  4. UTC timezone is assumed.
Time zone is ignored if incorrect value is provided.
X-Tenant-ID
string <= 100 characters

Tenant identifier.
When not provided to the request, the default identifier will be used.

Responses

Response samples

Content type
application/json
{
  • "error": "VALIDATION_ERROR",
  • "message": "Validation error: Constraint violations",
  • "method": "PUT",
  • "path": "/profile/customers/12345",
  • "correlationId": "1505219765216595",
  • "status": 400,
  • "timestamp": "2017-09-12T12:36:05.217Z",
  • "violations": [
    ]
}

Unauthorized Member


Member's Authorization is based on login and password. This method allows checking the Terms & conditions policy for not logged users and also all the permits to manage and process password reset by the existing member.

Get T&C Policy

Get Terms and Conditions Policy.

header Parameters
Accept
string

Specifies which content types, expressed as MIME types, are accepted by client.
Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header.
Should be used only when operations specification states that it can handle multiple content types.

Accept-Language
string
Example: pl, en-us

Specifies the client proposed language of the response.
If not provided or if system does not have requested language configured, system will return response in system's configured default language.
Only the MultiLang strings will be translated, other will be returned as stored in the system.

Authorization
string
Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l

OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation.
Bearer token where token is authorization key granted to the client.

X-Correlation-ID
string <= 100 characters

Unique request token for correlation purposes.
When not provided to the request, assigned automatically by the system.

Time-Zone
string <= 100 characters

Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH).
Time zone source hierarchy:

  1. Date (time zone is taken from date format, related only to POST/PUT/PATCH requests).
  2. Header (time zone is taken from this header).
  3. DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter).
  4. UTC timezone is assumed.
Time zone is ignored if incorrect value is provided.
X-Tenant-ID
string <= 100 characters

Tenant identifier.
When not provided to the request, the default identifier will be used.

Responses

Response samples

Content type
application/json
{
  • "gdpr": {
    },
  • "loyalty": {
    }
}

Initiate password reset procedure

Initiate member password reset process.
Notification allowing to reset forgotten password will be sent to the customer.

header Parameters
Accept
string

Specifies which content types, expressed as MIME types, are accepted by client.
Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header.
Should be used only when operations specification states that it can handle multiple content types.

Accept-Language
string
Example: pl, en-us

Specifies the client proposed language of the response.
If not provided or if system does not have requested language configured, system will return response in system's configured default language.
Only the MultiLang strings will be translated, other will be returned as stored in the system.

X-Correlation-ID
string <= 100 characters

Unique request token for correlation purposes.
When not provided to the request, assigned automatically by the system.

Time-Zone
string <= 100 characters

Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH).
Time zone source hierarchy:

  1. Date (time zone is taken from date format, related only to POST/PUT/PATCH requests).
  2. Header (time zone is taken from this header).
  3. DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter).
  4. UTC timezone is assumed.
Time zone is ignored if incorrect value is provided.
X-Tenant-ID
string <= 100 characters

Tenant identifier.
When not provided to the request, the default identifier will be used.

Request Body schema: application/json
login
required
string

Customer login.
Any value that is configured and allows member to login.

oneTimePermission
boolean

Forces password reset communication even if member does not have communication permission.
In case of no permission, communication will not occur unless the permission is explicitly granted. Otherwise oneTimePermission flag is not respected (even if set to false). Information about one time permission is stored in the system.

preferredChannel
string

Preferred communication channel which will be used to communication.
Required if oneTimePermission is true.
COMMUNICATION_CHANNELS dictionary.

Responses

Request samples

Content type
application/json
{
  • "login": "string",
  • "oneTimePermission": true,
  • "preferredChannel": "string"
}

Response samples

Content type
application/json
{
  • "error": "VALIDATION_ERROR",
  • "message": "Validation error: Constraint violations",
  • "method": "PUT",
  • "path": "/profile/customers/12345",
  • "correlationId": "1505219765216595",
  • "status": 400,
  • "timestamp": "2017-09-12T12:36:05.217Z",
  • "violations": [
    ]
}

Complete password reset procedure

Change password using token received after /password-reset call

header Parameters
Accept
string

Specifies which content types, expressed as MIME types, are accepted by client.
Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header.
Should be used only when operations specification states that it can handle multiple content types.

Accept-Language
string
Example: pl, en-us

Specifies the client proposed language of the response.
If not provided or if system does not have requested language configured, system will return response in system's configured default language.
Only the MultiLang strings will be translated, other will be returned as stored in the system.

X-Correlation-ID
string <= 100 characters

Unique request token for correlation purposes.
When not provided to the request, assigned automatically by the system.

Time-Zone
string <= 100 characters

Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH).
Time zone source hierarchy:

  1. Date (time zone is taken from date format, related only to POST/PUT/PATCH requests).
  2. Header (time zone is taken from this header).
  3. DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter).
  4. UTC timezone is assumed.
Time zone is ignored if incorrect value is provided.
X-Tenant-ID
string <= 100 characters

Tenant identifier.
When not provided to the request, the default identifier will be used.

Request Body schema: application/json
token
required
string

Reset password token received by the customer

newPassword
required
string <password>

New password

confirmPassword
required
string <password>

New password repeated

Responses

Request samples

Content type
application/json
{
  • "token": "string",
  • "newPassword": "pa$$word",
  • "confirmPassword": "pa$$word"
}

Response samples

Content type
application/json
{
  • "error": "VALIDATION_ERROR",
  • "message": "Validation error: Constraint violations",
  • "method": "PUT",
  • "path": "/profile/customers/12345",
  • "correlationId": "1505219765216595",
  • "status": 400,
  • "timestamp": "2017-09-12T12:36:05.217Z",
  • "violations": [
    ]
}

Configuration


This set of requests allows the entity to get configured dictionary items and objects specific to the given loyalty program and use them in multiple ways. If you, for example, want to show partner and location with details on your page, this is the way to do it. What's more here in the form of lists and details - point, language, transaction types. Handy section!

Get partners

Get list of partners.
Sortable by [code, name, status].

query Parameters
filter
string non-empty

Full text search query.
Matches [code, name].

code
Array of strings

Partners codes list. PARTNERS dictionary.

excludeCode
Array of strings

List of partner codes that should be excluded from the result

name
string

Partner name

status
string 1 characters

Partner status code. GENERAL_STATUSES dictionary.

promotionCode
Array of strings

Promotion code associated with partners. TRANSACTION_RULES dictionary.

sort
string
Default: "id:ASC"

Defines the sort order of the resulting list of objects.
Available sort orders: ASCENDING, ASC, ascending, asc, 1, DESCENDING, DESC, descending, desc, -1.
If operation description does not state otherwise, default order field is 'id' and the default order is ascending.
If operation description does not state otherwise, all attributes of the response array items may be included as sort criteria.

Constructed as comma separated list of sort fields, with optional order marker after colon. Examples:

  • sort=firstName:ASC,lastName:DESC,address.street - result is ordered by first name ascending, last name descending and street part of the address ascending
  • sort=firstName,lastName:DESC - result is ordered by first name ascending and last name descending
  • sort=firstName,lastName - result is ordered by first name ascending and last name ascending
  • sort=:DESC - result is ordered descending by the default field (id)
firstResult
integer <int32>
Default: 0

First item on the page. Indexed from 0.
Only non-negative values.

maxResults
integer <int32>

Max count of items on the page. Default value is from the PROCESSING_DEFAULT_MAX_RESULTS system parameter.
Only non-negative values.

header Parameters
Content-Type
string

Request content type as MIME type.
By default application/json, unless operation's request specification says otherwise.

Accept
string

Specifies which content types, expressed as MIME types, are accepted by client.
Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header.
Should be used only when operations specification states that it can handle multiple content types.

Accept-Language
string
Example: pl, en-us

Specifies the client proposed language of the response.
If not provided or if system does not have requested language configured, system will return response in system's configured default language.
Only the MultiLang strings will be translated, other will be returned as stored in the system.

X-Correlation-ID
string <= 100 characters

Unique request token for correlation purposes.
When not provided to the request, assigned automatically by the system.

Time-Zone
string <= 100 characters

Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH).
Time zone source hierarchy:

  1. Date (time zone is taken from date format, related only to POST/PUT/PATCH requests).
  2. Header (time zone is taken from this header).
  3. DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter).
  4. UTC timezone is assumed.
Time zone is ignored if incorrect value is provided.
X-Tenant-ID
string <= 100 characters

Tenant identifier.
When not provided to the request, the default identifier will be used.

Responses

Response samples

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

Get partner

Get partner data

path Parameters
partnerCode
required
string

Target partner unique code

header Parameters
Content-Type
string

Request content type as MIME type.
By default application/json, unless operation's request specification says otherwise.

Accept
string

Specifies which content types, expressed as MIME types, are accepted by client.
Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header.
Should be used only when operations specification states that it can handle multiple content types.

Accept-Language
string
Example: pl, en-us

Specifies the client proposed language of the response.
If not provided or if system does not have requested language configured, system will return response in system's configured default language.
Only the MultiLang strings will be translated, other will be returned as stored in the system.

X-Correlation-ID
string <= 100 characters

Unique request token for correlation purposes.
When not provided to the request, assigned automatically by the system.

Time-Zone
string <= 100 characters

Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH).
Time zone source hierarchy:

  1. Date (time zone is taken from date format, related only to POST/PUT/PATCH requests).
  2. Header (time zone is taken from this header).
  3. DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter).
  4. UTC timezone is assumed.
Time zone is ignored if incorrect value is provided.
X-Tenant-ID
string <= 100 characters

Tenant identifier.
When not provided to the request, the default identifier will be used.

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "description": "string",
  • "default": true,
  • "logoFileId": "string",
  • "status": "s",
  • "statusName": "string"
}

Get locations

Get list of configured locations.
Sortable by [name, code, status].
At least one of following request fields' sets is required:

  • [filter]
  • [code]
  • [partner]
  • [name]
  • [address.filter]
  • [address.country]
  • [address.region]
  • [address.email]
  • [address.phone]
query Parameters
filter
string non-empty

Full text search query.
Matches [code, name].

code
Array of strings

List of location codes

excludeCode
Array of strings

List of location codes that should be excluded from the result

partner
Array of strings

List of partner's codes. PARTNERS dictionary.

name
string

Location name

status
Array of strings

Location statuses codes list. LOCATION_STATUSES dictionary.

type
Array of strings

Location types codes list. LOCATION_TYPES dictionary.

address.filter
string

Full text search query for location address.
Matches [address.street, address.city, address.postalCode, address.region, address.country].

address.country
Array of strings

Location country codes list. COUNTRIES dictionary.

address.region
Array of strings

Location region codes list.

address.email
string

Location e-mail list

address.phone
string

Stationary or mobile phone numbers of the location.

rewardPOSDelivery
boolean

Reward POS delivery flag.

clickAndCollect
boolean

Click and collect integration flag.

sort
string
Default: "id:ASC"

Defines the sort order of the resulting list of objects.
Available sort orders: ASCENDING, ASC, ascending, asc, 1, DESCENDING, DESC, descending, desc, -1.
If operation description does not state otherwise, default order field is 'id' and the default order is ascending.
If operation description does not state otherwise, all attributes of the response array items may be included as sort criteria.

Constructed as comma separated list of sort fields, with optional order marker after colon. Examples:

  • sort=firstName:ASC,lastName:DESC,address.street - result is ordered by first name ascending, last name descending and street part of the address ascending
  • sort=firstName,lastName:DESC - result is ordered by first name ascending and last name descending
  • sort=firstName,lastName - result is ordered by first name ascending and last name ascending
  • sort=:DESC - result is ordered descending by the default field (id)
firstResult
integer <int32>
Default: 0

First item on the page. Indexed from 0.
Only non-negative values.

maxResults
integer <int32>

Max count of items on the page. Default value is from the PROCESSING_DEFAULT_MAX_RESULTS system parameter.
Only non-negative values.

with
Array of strings
Items Enum: "address" "geoPos"

Appends to every response item additional content that is not appended by default to boost lists performance.
Note: Requesting more item data in the responses which are lists may impact performance.
Supports [address, geoPos].

header Parameters
Content-Type
string

Request content type as MIME type.
By default application/json, unless operation's request specification says otherwise.

Accept
string

Specifies which content types, expressed as MIME types, are accepted by client.
Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header.
Should be used only when operations specification states that it can handle multiple content types.

Accept-Language
string
Example: pl, en-us

Specifies the client proposed language of the response.
If not provided or if system does not have requested language configured, system will return response in system's configured default language.
Only the MultiLang strings will be translated, other will be returned as stored in the system.

X-Correlation-ID
string <= 100 characters

Unique request token for correlation purposes.
When not provided to the request, assigned automatically by the system.

Time-Zone
string <= 100 characters

Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH).
Time zone source hierarchy:

  1. Date (time zone is taken from date format, related only to POST/PUT/PATCH requests).
  2. Header (time zone is taken from this header).
  3. DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter).
  4. UTC timezone is assumed.
Time zone is ignored if incorrect value is provided.
X-Tenant-ID
string <= 100 characters

Tenant identifier.
When not provided to the request, the default identifier will be used.

Responses

Response samples

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

Get location

Get location details

path Parameters
locationId
required
integer

Location system-wide unique identifier

query Parameters
with
Array of strings
Items Value: "prices"

Appends to every response item additional content that is not appended by default to boost lists performance.
Note: Requesting more item data in the responses which are lists may impact performance.
Supports [prices].

header Parameters
Content-Type
string

Request content type as MIME type.
By default application/json, unless operation's request specification says otherwise.

Accept
string

Specifies which content types, expressed as MIME types, are accepted by client.
Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header.
Should be used only when operations specification states that it can handle multiple content types.

Accept-Language
string
Example: pl, en-us

Specifies the client proposed language of the response.
If not provided or if system does not have requested language configured, system will return response in system's configured default language.
Only the MultiLang strings will be translated, other will be returned as stored in the system.

X-Correlation-ID
string <= 100 characters

Unique request token for correlation purposes.
When not provided to the request, assigned automatically by the system.

Time-Zone
string <= 100 characters

Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH).
Time zone source hierarchy:

  1. Date (time zone is taken from date format, related only to POST/PUT/PATCH requests).
  2. Header (time zone is taken from this header).
  3. DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter).
  4. UTC timezone is assumed.
Time zone is ignored if incorrect value is provided.
X-Tenant-ID
string <= 100 characters

Tenant identifier.
When not provided to the request, the default identifier will be used.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "code": "string",
  • "name": "string",
  • "description": "string",
  • "partner": "string",
  • "status": "s",
  • "type": "stri",
  • "partnerName": "string",
  • "statusName": "string",
  • "typeName": "string",
  • "address": {
    },
  • "geoPos": {
    },
  • "rewardPOSDelivery": true,
  • "clickAndCollect": true,
  • "lastModify": "2019-08-24T14:15:22Z",
  • "productPrices": [
    ]
}

Get system parameter

Get system parameter

path Parameters
parameterCode
required
string

System parameter code

header Parameters
Content-Type
string

Request content type as MIME type.
By default application/json, unless operation's request specification says otherwise.

Accept
string

Specifies which content types, expressed as MIME types, are accepted by client.
Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header.
Should be used only when operations specification states that it can handle multiple content types.

Accept-Language
string
Example: pl, en-us

Specifies the client proposed language of the response.
If not provided or if system does not have requested language configured, system will return response in system's configured default language.
Only the MultiLang strings will be translated, other will be returned as stored in the system.

X-Correlation-ID
string <= 100 characters

Unique request token for correlation purposes.
When not provided to the request, assigned automatically by the system.

Time-Zone
string <= 100 characters

Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH).
Time zone source hierarchy:

  1. Date (time zone is taken from date format, related only to POST/PUT/PATCH requests).
  2. Header (time zone is taken from this header).
  3. DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter).
  4. UTC timezone is assumed.
Time zone is ignored if incorrect value is provided.
X-Tenant-ID
string <= 100 characters

Tenant identifier.
When not provided to the request, the default identifier will be used.

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "category": "st",
  • "categoryName": "string",
  • "type": "s",
  • "typeName": "string",
  • "value": "string",
  • "pattern": "string",
  • "description": "string"
}

Get point types

Get list of configured point types.
Sortable by [code, name, transferable, adjustable].

query Parameters
filter
string >= 3 characters

Full text search query.
Matches [code, name].

code
Array of strings

Point types codes list.

name
string

Point type name

sort
string
Default: "id:ASC"

Defines the sort order of the resulting list of objects.
Available sort orders: ASCENDING, ASC, ascending, asc, 1, DESCENDING, DESC, descending, desc, -1.
If operation description does not state otherwise, default order field is 'id' and the default order is ascending.
If operation description does not state otherwise, all attributes of the response array items may be included as sort criteria.

Constructed as comma separated list of sort fields, with optional order marker after colon. Examples:

  • sort=firstName:ASC,lastName:DESC,address.street - result is ordered by first name ascending, last name descending and street part of the address ascending
  • sort=firstName,lastName:DESC - result is ordered by first name ascending and last name descending
  • sort=firstName,lastName - result is ordered by first name ascending and last name ascending
  • sort=:DESC - result is ordered descending by the default field (id)
firstResult
integer <int32>
Default: 0

First item on the page. Indexed from 0.
Only non-negative values.

maxResults
integer <int32>

Max count of items on the page. Default value is from the PROCESSING_DEFAULT_MAX_RESULTS system parameter.
Only non-negative values.

header Parameters
Content-Type
string

Request content type as MIME type.
By default application/json, unless operation's request specification says otherwise.

Accept
string

Specifies which content types, expressed as MIME types, are accepted by client.
Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header.
Should be used only when operations specification states that it can handle multiple content types.

Accept-Language
string
Example: pl, en-us

Specifies the client proposed language of the response.
If not provided or if system does not have requested language configured, system will return response in system's configured default language.
Only the MultiLang strings will be translated, other will be returned as stored in the system.

Authorization
string
Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l

OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation.
Bearer token where token is authorization key granted to the client.

X-Correlation-ID
string <= 100 characters

Unique request token for correlation purposes.
When not provided to the request, assigned automatically by the system.

Time-Zone
string <= 100 characters

Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH).
Time zone source hierarchy:

  1. Date (time zone is taken from date format, related only to POST/PUT/PATCH requests).
  2. Header (time zone is taken from this header).
  3. DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter).
  4. UTC timezone is assumed.
Time zone is ignored if incorrect value is provided.
X-Tenant-ID
string <= 100 characters

Tenant identifier.
When not provided to the request, the default identifier will be used.

Responses

Response samples

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

Get point type

Get point type

path Parameters
pointTypeCode
required
string

Point type code. POINT_TYPES dictionary.

header Parameters
Content-Type
string

Request content type as MIME type.
By default application/json, unless operation's request specification says otherwise.

Accept
string

Specifies which content types, expressed as MIME types, are accepted by client.
Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header.
Should be used only when operations specification states that it can handle multiple content types.

Accept-Language
string
Example: pl, en-us

Specifies the client proposed language of the response.
If not provided or if system does not have requested language configured, system will return response in system's configured default language.
Only the MultiLang strings will be translated, other will be returned as stored in the system.

Authorization
string
Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l

OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation.
Bearer token where token is authorization key granted to the client.

X-Correlation-ID
string <= 100 characters

Unique request token for correlation purposes.
When not provided to the request, assigned automatically by the system.

Time-Zone
string <= 100 characters

Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH).
Time zone source hierarchy:

  1. Date (time zone is taken from date format, related only to POST/PUT/PATCH requests).
  2. Header (time zone is taken from this header).
  3. DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter).
  4. UTC timezone is assumed.
Time zone is ignored if incorrect value is provided.
X-Tenant-ID
string <= 100 characters

Tenant identifier.
When not provided to the request, the default identifier will be used.

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "description": "string",
  • "transferable": true,
  • "adjustable": true,
  • "expiryPeriod": "P1Y6M",
  • "mainBalance": true
}

Get transaction types

Get list of transaction types configured in the system.

Authorizations:
customer_password_scheme (any)
query Parameters
filter
string

Full text search query.
Matches [code, name].

code
Array of strings

Transaction types filter. TRANSACTION_TYPES dictionary.

status
Array of strings

Transaction types status filter. GENERAL_STATUSES dictionary.

promotable
boolean

Promotable filter

genericEvent
boolean

Generic event filter

b2cDefaultMemberVisibility
boolean

B2C default member visibility filter

sort
string
Default: "id:ASC"

Defines the sort order of the resulting list of objects.
Available sort orders: ASCENDING, ASC, ascending, asc, 1, DESCENDING, DESC, descending, desc, -1.
If operation description does not state otherwise, default order field is 'id' and the default order is ascending.
If operation description does not state otherwise, all attributes of the response array items may be included as sort criteria.

Constructed as comma separated list of sort fields, with optional order marker after colon. Examples:

  • sort=firstName:ASC,lastName:DESC,address.street - result is ordered by first name ascending, last name descending and street part of the address ascending
  • sort=firstName,lastName:DESC - result is ordered by first name ascending and last name descending
  • sort=firstName,lastName - result is ordered by first name ascending and last name ascending
  • sort=:DESC - result is ordered descending by the default field (id)
firstResult
integer <int32>
Default: 0

First item on the page. Indexed from 0.
Only non-negative values.

maxResults
integer <int32>

Max count of items on the page. Default value is from the PROCESSING_DEFAULT_MAX_RESULTS system parameter.
Only non-negative values.

header Parameters
Accept
string

Specifies which content types, expressed as MIME types, are accepted by client.
Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header.
Should be used only when operations specification states that it can handle multiple content types.

Accept-Language
string
Example: pl, en-us

Specifies the client proposed language of the response.
If not provided or if system does not have requested language configured, system will return response in system's configured default language.
Only the MultiLang strings will be translated, other will be returned as stored in the system.

Authorization
string
Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l

OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation.
Bearer token where token is authorization key granted to the client.

X-Correlation-ID
string <= 100 characters

Unique request token for correlation purposes.
When not provided to the request, assigned automatically by the system.

Time-Zone
string <= 100 characters

Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH).
Time zone source hierarchy:

  1. Date (time zone is taken from date format, related only to POST/PUT/PATCH requests).
  2. Header (time zone is taken from this header).
  3. DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter).
  4. UTC timezone is assumed.
Time zone is ignored if incorrect value is provided.
X-Tenant-ID
string <= 100 characters

Tenant identifier.
When not provided to the request, the default identifier will be used.

Responses

Response samples

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

Get password restrictions

Get password restrictions.
This reflects setup of the member password conditions that must be met by member password.

header Parameters
Content-Type
string

Request content type as MIME type.
By default application/json, unless operation's request specification says otherwise.

Accept
string

Specifies which content types, expressed as MIME types, are accepted by client.
Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header.
Should be used only when operations specification states that it can handle multiple content types.

Accept-Language
string
Example: pl, en-us

Specifies the client proposed language of the response.
If not provided or if system does not have requested language configured, system will return response in system's configured default language.
Only the MultiLang strings will be translated, other will be returned as stored in the system.

X-Correlation-ID
string <= 100 characters

Unique request token for correlation purposes.
When not provided to the request, assigned automatically by the system.

Time-Zone
string <= 100 characters

Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH).
Time zone source hierarchy:

  1. Date (time zone is taken from date format, related only to POST/PUT/PATCH requests).
  2. Header (time zone is taken from this header).
  3. DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter).
  4. UTC timezone is assumed.
Time zone is ignored if incorrect value is provided.
X-Tenant-ID
string <= 100 characters

Tenant identifier.
When not provided to the request, the default identifier will be used.

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "restrictions": {
    }
}

Get member profile restrictions

Get member profile restrictions.
This reflects setup of the member profile conditions that must be met by member profile data.

header Parameters
Content-Type
string

Request content type as MIME type.
By default application/json, unless operation's request specification says otherwise.

Accept
string

Specifies which content types, expressed as MIME types, are accepted by client.
Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header.
Should be used only when operations specification states that it can handle multiple content types.

Accept-Language
string
Example: pl, en-us

Specifies the client proposed language of the response.
If not provided or if system does not have requested language configured, system will return response in system's configured default language.
Only the MultiLang strings will be translated, other will be returned as stored in the system.

Authorization
string
Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l

OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation.
Bearer token where token is authorization key granted to the client.

X-Correlation-ID
string <= 100 characters

Unique request token for correlation purposes.
When not provided to the request, assigned automatically by the system.

Time-Zone
string <= 100 characters

Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH).
Time zone source hierarchy:

  1. Date (time zone is taken from date format, related only to POST/PUT/PATCH requests).
  2. Header (time zone is taken from this header).
  3. DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter).
  4. UTC timezone is assumed.
Time zone is ignored if incorrect value is provided.
X-Tenant-ID
string <= 100 characters

Tenant identifier.
When not provided to the request, the default identifier will be used.

Responses

Response samples

Content type
application/json
{
  • "defaultMemberLanguage": "string",
  • "minAge": 0,
  • "blacklists": {
    },
  • "customLogin": {
    },
  • "loginSettings": {
    }
}

Member attributes used in form.

Get list of attributes used in specific form and password restrictions

query Parameters
formType
required
string
Enum: "EN" "MM"

Form type.

  • EN - Enrollment form
  • MM - Member Portal and Mobile App
type
string
Enum: "ALL" "CUSTOM" "PREDEFINED"

Attribute type. Default value is ALL

header Parameters
Accept
string

Specifies which content types, expressed as MIME types, are accepted by client.
Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header.
Should be used only when operations specification states that it can handle multiple content types.

Accept-Language
string
Example: pl, en-us

Specifies the client proposed language of the response.
If not provided or if system does not have requested language configured, system will return response in system's configured default language.
Only the MultiLang strings will be translated, other will be returned as stored in the system.

X-Correlation-ID
string <= 100 characters

Unique request token for correlation purposes.
When not provided to the request, assigned automatically by the system.

Time-Zone
string <= 100 characters

Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH).
Time zone source hierarchy:

  1. Date (time zone is taken from date format, related only to POST/PUT/PATCH requests).
  2. Header (time zone is taken from this header).
  3. DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter).
  4. UTC timezone is assumed.
Time zone is ignored if incorrect value is provided.
X-Tenant-ID
string <= 100 characters

Tenant identifier.
When not provided to the request, the default identifier will be used.

Responses

Response samples

Content type
application/json
{
  • "memberAttributes": [
    ],
  • "passwordRestrictions": [
    ],
  • "consents": {
    }
}

Get allowed member languages

Returns languages from the LANGUAGES dictionary of the MEMBER_LANGUAGES parameter.

query Parameters
filter
string

Full text search query.
Matches [code, value].

firstLetters
string

Full text search query working in 'startsWith' mode.
Matches [code, value].

itemCode
Array of strings

Item code. For fetching particular languages.

header Parameters
Content-Type
string

Request content type as MIME type.
By default application/json, unless operation's request specification says otherwise.

Accept
string

Specifies which content types, expressed as MIME types, are accepted by client.
Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header.
Should be used only when operations specification states that it can handle multiple content types.

Accept-Language
string
Example: pl, en-us

Specifies the client proposed language of the response.
If not provided or if system does not have requested language configured, system will return response in system's configured default language.
Only the MultiLang strings will be translated, other will be returned as stored in the system.

X-Correlation-ID
string <= 100 characters

Unique request token for correlation purposes.
When not provided to the request, assigned automatically by the system.

Time-Zone
string <= 100 characters

Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH).
Time zone source hierarchy:

  1. Date (time zone is taken from date format, related only to POST/PUT/PATCH requests).
  2. Header (time zone is taken from this header).
  3. DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter).
  4. UTC timezone is assumed.
Time zone is ignored if incorrect value is provided.
X-Tenant-ID
string <= 100 characters

Tenant identifier.
When not provided to the request, the default identifier will be used.

Responses

Response samples

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

General Dictionaries


You can either generate a list of all dictionaries configured in the System, a list of any available/active ones or generate only a list of codes assigned to the specific dictionary.

Get available dictionaries

List of available dictionaries

header Parameters
Content-Type
string

Request content type as MIME type.
By default application/json, unless operation's request specification says otherwise.

Accept
string

Specifies which content types, expressed as MIME types, are accepted by client.
Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header.
Should be used only when operations specification states that it can handle multiple content types.

Accept-Language
string
Example: pl, en-us

Specifies the client proposed language of the response.
If not provided or if system does not have requested language configured, system will return response in system's configured default language.
Only the MultiLang strings will be translated, other will be returned as stored in the system.

X-Correlation-ID
string <= 100 characters

Unique request token for correlation purposes.
When not provided to the request, assigned automatically by the system.

Time-Zone
string <= 100 characters

Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH).
Time zone source hierarchy:

  1. Date (time zone is taken from date format, related only to POST/PUT/PATCH requests).
  2. Header (time zone is taken from this header).
  3. DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter).
  4. UTC timezone is assumed.
Time zone is ignored if incorrect value is provided.
X-Tenant-ID
string <= 100 characters

Tenant identifier.
When not provided to the request, the default identifier will be used.

Responses

Response samples

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

Get dictionaries

Get list of dictionaries with dictionary items

query Parameters
dic
required
string

Dictionaries query in special format (examples below).

../dictionaries?dic="LABO"
../dictionaries?dic="LABO"&dic="ORIS"
../dictionaries?dic="dicCode:GENDERS"
../dictionaries?dic="dicCode:GENDERS,itemCode:M"
../dictionaries?dic="dicCode:GENDERS,firstLetters:act"
../dictionaries?dic="dicCode:GENDERS,itemCode:M"&dic="dicCode:SOME_OTHER_DIC,filter:act"

The dicCode is required query parameter if one of [filter, firstLetters, itemCode] is provided.
If provided dic value is in quotes, only the values between quotes will be forwarded, others will be omitted.

header Parameters
Content-Type
string

Request content type as MIME type.
By default application/json, unless operation's request specification says otherwise.

Accept
string

Specifies which content types, expressed as MIME types, are accepted by client.
Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header.
Should be used only when operations specification states that it can handle multiple content types.

Accept-Language
string
Example: pl, en-us

Specifies the client proposed language of the response.
If not provided or if system does not have requested language configured, system will return response in system's configured default language.
Only the MultiLang strings will be translated, other will be returned as stored in the system.

X-Correlation-ID
string <= 100 characters

Unique request token for correlation purposes.
When not provided to the request, assigned automatically by the system.

Time-Zone
string <= 100 characters

Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH).
Time zone source hierarchy:

  1. Date (time zone is taken from date format, related only to POST/PUT/PATCH requests).
  2. Header (time zone is taken from this header).
  3. DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter).
  4. UTC timezone is assumed.
Time zone is ignored if incorrect value is provided.
X-Tenant-ID
string <= 100 characters

Tenant identifier.
When not provided to the request, the default identifier will be used.

Responses

Response samples

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

Get dictionary by code

Returns dictionary items for the particular dictionary domain

path Parameters
dictionaryCode
required
string

Dictionary code, from response of GET /available-dictionaries

query Parameters
filter
string

Full text search query.
Matches [code, value].

firstLetters
string

Full text search query working in 'startsWith' mode.
Matches [code, value].

itemCode
Array of strings

Item code. For fetching particular dictionary items.

header Parameters
Content-Type
string

Request content type as MIME type.
By default application/json, unless operation's request specification says otherwise.

Accept
string

Specifies which content types, expressed as MIME types, are accepted by client.
Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header.
Should be used only when operations specification states that it can handle multiple content types.

Accept-Language
string
Example: pl, en-us

Specifies the client proposed language of the response.
If not provided or if system does not have requested language configured, system will return response in system's configured default language.
Only the MultiLang strings will be translated, other will be returned as stored in the system.

X-Correlation-ID
string <= 100 characters

Unique request token for correlation purposes.
When not provided to the request, assigned automatically by the system.

Time-Zone
string <= 100 characters

Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH).
Time zone source hierarchy:

  1. Date (time zone is taken from date format, related only to POST/PUT/PATCH requests).
  2. Header (time zone is taken from this header).
  3. DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter).
  4. UTC timezone is assumed.
Time zone is ignored if incorrect value is provided.
X-Tenant-ID
string <= 100 characters

Tenant identifier.
When not provided to the request, the default identifier will be used.

Responses

Response samples

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

Files


This method allows you to download from the System any binary file like reward's image, coupon image representation, etc.

Get binary file

Get any binary file stored in the system via system-wide unique identifier.

path Parameters
fileId
required
string <= 99 characters

System-wide unique file identifier in form of GUID.

header Parameters
Accept
string
Default: application/octet-stream

Expected response content type as MIME type.

X-Correlation-ID
string <= 100 characters

Unique request token for correlation purposes.
When not provided to the request, assigned automatically by the system.

Time-Zone
string <= 100 characters

Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH).
Time zone source hierarchy:

  1. Date (time zone is taken from date format, related only to POST/PUT/PATCH requests).
  2. Header (time zone is taken from this header).
  3. DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter).
  4. UTC timezone is assumed.
Time zone is ignored if incorrect value is provided.
X-Tenant-ID
string <= 100 characters

Tenant identifier.
When not provided to the request, the default identifier will be used.

Responses

Response samples

Content type
application/json
{
  • "error": "VALIDATION_ERROR",
  • "message": "Validation error: Constraint violations",
  • "method": "PUT",
  • "path": "/profile/customers/12345",
  • "correlationId": "1505219765216595",
  • "status": 400,
  • "timestamp": "2017-09-12T12:36:05.217Z",
  • "violations": [
    ]
}