Documentation Powered by ReDoc

Echo Loyalty Partner Integration API (3.23.0.RELEASE)

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 Business Gateway REST API, the full URL for the POST /enrollment operation, which enrolls a member is:
https://b2b-tenantId.echoloyalty.com/b2b/profile/v3/enrollment. The base URL is:
https://b2b-tenantId.echoloyalty.com/b2b/profile/v3. This is constructed from these three elements:
-Scheme: HTTPS
-Host: b2b-tenantId.echoloyalty.com
-Base path: /b2b/profile/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 Business 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 Business 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 Parameter 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://b2b-tenantId.echoloyalty.com/b2b/redemption/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 Parameter 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://b2b-tenantId.echoloyalty.com/b2b/redemption/v3/rewards/{rewardCode}?pricePlanDate=2018-09-01), there is one query parameter: pricePlanDate, with 2018-09-01 being its value.
Scheme In the full URL for an API, the scheme is the transfer protocol; most commonly HTTP or HTTPS.
Tag A tag is essentially a keyword or key phrase that's added to a piece of content, or information associated with a resource, to assist in search results. Several different types of resources can have tags assigned to them; for example, apps, APIs, groups, and tickets. Multiple tags are separated by commas.
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).
URI A URI is a string of characters used to identify a name or resource. The term URI encompasses both URLs, URNs, and other ways to indicate a resource. A URL is a type of URI that identifies a resource by specifying its location in the context of a protocol such as HTTP.
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 pointing specific identifier. 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.
{target} '{target}' is a path parameter. It is unique id of resource we want to point at and it is depending on what endpoint is used. For instance it could be unique id of loyalty identifier in the form of customerId={customerId} (in this case we replace whole {target} entity with customerId={customerId} where {customerId} is unique customer internal identifier in endpoint;
https://b2b-tenantId.echoloyalty.com/b2b/profile/v3/customers/{target} =
https://b2b-tenantId.echoloyalty.com/b2b/profile/v3/customers/customerId=123456654321). {target} parameter can be replaced with only value of resource as well (without name of resource and '=' mark). We can do this making use of identifierNo:
https://b2b-tenantId.echoloyalty.com/b2b/profile/v3/customers/7000000000000000122443. However let's remember that first described scenario would have the same effect i.e.
https://b2b-tenantId.echoloyalty.com/b2b/profile/v3/customers/identifierNo=7000000000000000122443.

Authentication

user_client_scheme

Client access token flow for user related clients. Client credentials grant type.
See Authentication documentation for more details.

Security Scheme Type OAuth2
clientCredentials OAuth Flow
Token URL: https://$host$:$port$/oauth/$version$/login
Scopes:
  • any -

    Grants access to any secured operations

Authentication & Authorization


Both authentication and authorization are core to the security of APIs.
Authentication - refers to proving correct identity The process of proving your identity to the System. Authentication proves that you are who you say you are. We use OAuth2 security scheme as the method for authentication.
Authorization - refers to allowing a certain action. 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 in the System you need user, password and the token obtained during authentication.

Acquire access token and login

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

Authorizations:
user_client_scheme (any)
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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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

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

password
required
string <password>

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

channel
string
Default: "V"
Enum: "L" "V"

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

  • L - Point Of Sale
  • V - Web Service

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-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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

Configuration


This set of requests allows the entity to get configured items and objects, specific for the given loyalty program and use in multiple way. If you want to show the list of program’s partners or active locations with details on your page this is the way to do it.

(New) Member attributes used in form.

Get list of attributes used in specific form and password restrictions

Authorizations:
user_client_scheme (any)
query Parameters
formType
required
string
Enum: "PT" "EN"

Form type.

  • PT - Partner
  • EN - Enrollment form
type
string
Enum: "ALL" "CUSTOM" "PREDEFINED"

Attribute type. Default value is ALL

includeConsentsAttributes
boolean

When true, attributes connected to consents are included in the response.
Default value is false.

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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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

Member attributes used in form.

Get list of attributes used in specific form.

Authorizations:
user_client_scheme (any)
query Parameters
formType
required
string
Enum: "PT" "EN"

Form type.

  • PT - Partner
  • EN - Enrollment form
type
string
Enum: "ALL" "CUSTOM" "PREDEFINED"

Attribute type. Default value is ALL

includeConsentsAttributes
boolean

When true, attributes connected to consents are included in the response.
Default value is false.

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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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 partners

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

Authorizations:
user_client_scheme (any)
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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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

Authorizations:
user_client_scheme (any)
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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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]
Authorizations:
user_client_scheme (any)
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

externalCode
string

Exact External Location code

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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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

Authorizations:
user_client_scheme (any)
path Parameters
locationCode
required
string

Location unique code. LOCATIONS 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.

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-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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",
  • "externalCode": "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"
}

Get point types

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

Authorizations:
user_client_scheme (any)
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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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

Authorizations:
user_client_scheme (any)
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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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",
  • "transferable": true,
  • "adjustable": true,
  • "expiryPeriod": "P1Y6M",
  • "mainBalance": true
}

Get suppliers

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

Authorizations:
user_client_scheme (any)
query Parameters
filter
string >= 3 characters

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

code
Array of strings

Supplier codes list

status
Array of strings

Supplier status codes list. GENERAL_STATUSES dictionary.

deliveryOnline
boolean

Supplier online delivery method

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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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

Member Profile


This set of method, is strictly related with loyalty program member and his data. You will find here all methods allowing you to manage the member from his enrollment, thru profile modification and update and closing the loyalty account. If you want to show member his loyalty card number/code and display data on the profile such as name or phone number you will use these methods.

Search member profiles

Search for member profiles.
Note: for every account, customer or identifier matched, whole account structure with all members is returned.

Authorizations:
user_client_scheme (any)
query Parameters
accountId
integer

Unique account identifier

excludeAccountId
integer

Excluded account identifier

pointsBalanceFrom
integer

Points balance. Lower boundary, inclusive.

pointsBalanceTo
integer

Points balance. Upper boundary, inclusive.

registrationDateFrom
string <date>

Date since the registration was made. Inslusive.

registrationDateTo
string <date>

Date till the registration was made. Inslusive.

status
string

Account status code. ACCOUNT_STATUSES dictionary.

statuses
Array of strings

Account status code. ACCOUNT_STATUSES dictionary.

customer.status
string

Customer status code. CUSTOMER_STATUSES dictionary.

customer.login
string

Customer login

customer.customerId
integer

Unique customer identifier

customer.accountId
integer

Unique account identifier

customer.birthDateFrom
string <date>

Date since customer was born. Inslusive.

customer.birthDateTo
string <date>

Date till customer was born. Inslusive.

customer.firstName
string

First name of customer.

customer.lastName
string

First name of customer.

customer.externalCustomerId
string

External customer ID.

customer.address.street
string

Customer street

customer.address.city
string

Customer city

customer.address.email
string

Customer e-mail. Search is exact (=).

customer.address.postalCode
string

Customer postal code

customer.address.phoneNumber
string

Phone number of the customer.

customer.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 customers with ATTR_A=1 and ATTR_B=2
  • attributes=ATTR_A:1;ATTR_C;ATTR_B:2 - searches for customers with ATTR_A=1 and ATTR_B=2 and ATTR_C is empty
  • attributes=ATTR_A:1;ATTR_A:2 - searches for customers with attribute multiple values ATTR_A=1 and ATTR_A=2
identifier.no
Array of strings

Identifier number

identifier.identifierTypeCode
Array of strings

Identifier type code. IDENTIFIER_TYPES dictionary.

identifier.firstTrnDateFrom
string <date>

Date since first transaction was processed. Inslusive.

identifier.firstTrnDateTo
string <date>

Date till first transaction was processed. Inslusive.

identifier.lastTrnDateFrom
string <date>

Date since last transaction was processed. Inslusive.

identifier.lastTrnDateTo
string <date>

Date till last transaction was processed. Inslusive.

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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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 profile

Get member profile

Authorizations:
user_client_scheme (any)
path Parameters
target
required
string

Target unique id of loyalty identifier. Constructed as following:
- customerId={customerId} where {customerId} is unique customer internal identifier
- identifierNo={identifierNo} where {identifierNo} is the identifier number
- {identifierNo} where {identifierNo} is the identifier number
- externalCustomerId={externalCustomerId} where {externalCustomerId} is customer's external identifier. When {externalType} not provided, the default value EXT (External) will be taken.
- externalCustomerId={externalCustomerId}&externalType={externalType} where {externalCustomerId} is customer's external identifier, {externalType} is code of type used to identify which external system is the owner of {externalCustomerId}

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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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.
Not provided data are cleared in the data storage.

Authorizations:
user_client_scheme (any)
path Parameters
target
required
string

Target unique id of loyalty identifier. Constructed as following:
- customerId={customerId} where {customerId} is unique customer internal identifier
- identifierNo={identifierNo} where {identifierNo} is the identifier number
- {identifierNo} where {identifierNo} is the identifier number
- externalCustomerId={externalCustomerId} where {externalCustomerId} is customer's external identifier. When {externalType} not provided, the default value EXT (External) will be taken.
- externalCustomerId={externalCustomerId}&externalType={externalType} where {externalCustomerId} is customer's external identifier, {externalType} is code of type used to identify which external system is the owner of {externalCustomerId}

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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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.

Authorizations:
user_client_scheme (any)
path Parameters
target
required
string

Target unique id of loyalty identifier. Constructed as following:
- customerId={customerId} where {customerId} is unique customer internal identifier
- identifierNo={identifierNo} where {identifierNo} is the identifier number
- {identifierNo} where {identifierNo} is the identifier number
- externalCustomerId={externalCustomerId} where {externalCustomerId} is customer's external identifier. When {externalType} not provided, the default value EXT (External) will be taken.
- externalCustomerId={externalCustomerId}&externalType={externalType} where {externalCustomerId} is customer's external identifier, {externalType} is code of type used to identify which external system is the owner of {externalCustomerId}

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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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

Get member segments

Get list of segments that currently match the member.
Member is, at the moment of the request, included in every segment in the response list.

Authorizations:
user_client_scheme (any)
path Parameters
target
required
string

Target unique id of loyalty identifier. Constructed as following:
- customerId={customerId} where {customerId} is unique customer internal identifier
- identifierNo={identifierNo} where {identifierNo} is the identifier number
- {identifierNo} where {identifierNo} is the identifier number
- externalCustomerId={externalCustomerId} where {externalCustomerId} is customer's external identifier. When {externalType} not provided, the default value EXT (External) will be taken.
- externalCustomerId={externalCustomerId}&externalType={externalType} where {externalCustomerId} is customer's external identifier, {externalType} is code of type used to identify which external system is the owner of {externalCustomerId}

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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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 T&C Policy

Get Terms and Conditions Policy.

Authorizations:
user_client_scheme (any)
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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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

Modify customer custom attributes

Modify customer custom attributes.
Not provided data are not overwritten in the data storage.

Authorizations:
user_client_scheme (any)
path Parameters
target
required
string

Target unique id of loyalty identifier. Constructed as following:
- customerId={customerId} where {customerId} is unique customer internal identifier
- identifierNo={identifierNo} where {identifierNo} is the identifier number
- {identifierNo} where {identifierNo} is the identifier number
- externalCustomerId={externalCustomerId} where {externalCustomerId} is customer's external identifier. When {externalType} not provided, the default value EXT (External) will be taken.
- externalCustomerId={externalCustomerId}&externalType={externalType} where {externalCustomerId} is customer's external identifier, {externalType} is code of type used to identify which external system is the owner of {externalCustomerId}

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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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

Customer attributes to be modified

Array of objects

Responses

Request samples

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

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:
user_client_scheme (any)
path Parameters
target
required
string

Target unique id of loyalty identifier. Constructed as following:
- customerId={customerId} where {customerId} is unique customer internal identifier
- identifierNo={identifierNo} where {identifierNo} is the identifier number
- {identifierNo} where {identifierNo} is the identifier number
- externalCustomerId={externalCustomerId} where {externalCustomerId} is customer's external identifier. When {externalType} not provided, the default value EXT (External) will be taken.
- externalCustomerId={externalCustomerId}&externalType={externalType} where {externalCustomerId} is customer's external identifier, {externalType} is code of type used to identify which external system is the owner of {externalCustomerId}

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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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:
user_client_scheme (any)
path Parameters
target
required
string

Target unique id of loyalty identifier. Constructed as following:
- customerId={customerId} where {customerId} is unique customer internal identifier
- identifierNo={identifierNo} where {identifierNo} is the identifier number
- {identifierNo} where {identifierNo} is the identifier number
- externalCustomerId={externalCustomerId} where {externalCustomerId} is customer's external identifier. When {externalType} not provided, the default value EXT (External) will be taken.
- externalCustomerId={externalCustomerId}&externalType={externalType} where {externalCustomerId} is customer's external identifier, {externalType} is code of type used to identify which external system is the owner of {externalCustomerId}

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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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

Accept T&C Policy

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

Authorizations:
user_client_scheme (any)
path Parameters
target
required
string

Target unique id of loyalty identifier. Constructed as following:
- customerId={customerId} where {customerId} is unique customer internal identifier
- identifierNo={identifierNo} where {identifierNo} is the identifier number
- {identifierNo} where {identifierNo} is the identifier number
- externalCustomerId={externalCustomerId} where {externalCustomerId} is customer's external identifier. When {externalType} not provided, the default value EXT (External) will be taken.
- externalCustomerId={externalCustomerId}&externalType={externalType} where {externalCustomerId} is customer's external identifier, {externalType} is code of type used to identify which external system is the owner of {externalCustomerId}

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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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

Enrollment

Enrolls new member with lists of predefined and custom attributes.

Authorizations:
user_client_scheme (any)
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-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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
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
{
  • "predefinedAttributes": [
    ],
  • "staticAttributes": {
    }
}

Member migration

Migrate new member with regular input data required without consent validation.

Authorizations:
user_client_scheme (any)
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-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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.TaCMemberCreateUpdateForMigration)
object (types.StaticAttributesEnrollment)

Responses

Request samples

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

Response samples

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

Close customer

Close customer or close due to fraud.
Operation is irrevertible.

Authorizations:
user_client_scheme (any)
path Parameters
target
required
string

Target unique id of loyalty identifier. Constructed as following:
- customerId={customerId} where {customerId} is unique customer internal identifier
- identifierNo={identifierNo} where {identifierNo} is the identifier number
- {identifierNo} where {identifierNo} is the identifier number
- externalCustomerId={externalCustomerId} where {externalCustomerId} is customer's external identifier. When {externalType} not provided, the default value EXT (External) will be taken.
- externalCustomerId={externalCustomerId}&externalType={externalType} where {externalCustomerId} is customer's external identifier, {externalType} is code of type used to identify which external system is the owner of {externalCustomerId}

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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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
fraud
boolean

Indicates if customer is closed due to a fraud

reason
required
string <= 1000 characters

Reason for closing the customer

Responses

Request samples

Content type
application/json
{
  • "fraud": true,
  • "reason": "Fraud attempt"
}

Response samples

Content type
application/json
{
  • "error": "REWARDS_MASS_REMOVAL_FAILED",
  • "message": "Cannot remove group of rewards",
  • "method": "POST",
  • "path": "/rewards/remove",
  • "correlationId": "1505219765216595",
  • "status": 500,
  • "timestamp": "2017-09-12T12:36:05.217Z"
}

Block customer

Block customer.
Blocked customer has no transactional abilities. For blocking customer's login ability see Block login operation.

Authorizations:
user_client_scheme (any)
path Parameters
target
required
string

Target unique id of loyalty identifier. Constructed as following:
- customerId={customerId} where {customerId} is unique customer internal identifier
- identifierNo={identifierNo} where {identifierNo} is the identifier number
- {identifierNo} where {identifierNo} is the identifier number
- externalCustomerId={externalCustomerId} where {externalCustomerId} is customer's external identifier. When {externalType} not provided, the default value EXT (External) will be taken.
- externalCustomerId={externalCustomerId}&externalType={externalType} where {externalCustomerId} is customer's external identifier, {externalType} is code of type used to identify which external system is the owner of {externalCustomerId}

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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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
reason
required
string <= 1000 characters

Reason for blocking the customer

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "error": "REWARDS_MASS_REMOVAL_FAILED",
  • "message": "Cannot remove group of rewards",
  • "method": "POST",
  • "path": "/rewards/remove",
  • "correlationId": "1505219765216595",
  • "status": 500,
  • "timestamp": "2017-09-12T12:36:05.217Z"
}

Unblock customer

Unblock customer

Authorizations:
user_client_scheme (any)
path Parameters
target
required
string

Target unique id of loyalty identifier. Constructed as following:
- customerId={customerId} where {customerId} is unique customer internal identifier
- identifierNo={identifierNo} where {identifierNo} is the identifier number
- {identifierNo} where {identifierNo} is the identifier number
- externalCustomerId={externalCustomerId} where {externalCustomerId} is customer's external identifier. When {externalType} not provided, the default value EXT (External) will be taken.
- externalCustomerId={externalCustomerId}&externalType={externalType} where {externalCustomerId} is customer's external identifier, {externalType} is code of type used to identify which external system is the owner of {externalCustomerId}

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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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": "REWARDS_MASS_REMOVAL_FAILED",
  • "message": "Cannot remove group of rewards",
  • "method": "POST",
  • "path": "/rewards/remove",
  • "correlationId": "1505219765216595",
  • "status": 500,
  • "timestamp": "2017-09-12T12:36:05.217Z"
}

Invitation key exists

Checks if an active member with the provided invitation key exists

Authorizations:
query Parameters
key
required
string 5 characters

Invitation key

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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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

Get identifier

Get identifier details

Authorizations:
user_client_scheme (any)
path Parameters
target
required
string

Target unique id of loyalty identifier. Constructed as following:
- identifierNo={identifierNo} where {identifierNo} is the identifier number
- {identifierNo} where {identifierNo} is the identifier number

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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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",
  • "status": "s",
  • "statusName": "string",
  • "main": true,
  • "assignmentDate": "2019-08-24",
  • "visualMode": "BC",
  • "blockedReason": "string",
  • "blockedByUserId": 0,
  • "firstTrnDate": "2019-08-24",
  • "lastTrnDate": "2019-08-24",
  • "lastModify": "2019-08-24T14:15:22Z"
}

Transaction


Feeding the System with the transactional data is one point, but this one is the different one. Members like to browse thru transaction history and checking number of added points. Each on them is stored in the System with an unique identifier so you can display all it details. By using member balance request you can know and display the current points balances (for the each point type) based on the provided member identifier.

Get member balances

Get member points balance.
Returns breakdown of all points.

Authorizations:
user_client_scheme (any)
path Parameters
target
required
string

Target unique id of loyalty identifier. Constructed as following:
- customerId={customerId} where {customerId} is unique customer internal identifier
- identifierNo={identifierNo} where {identifierNo} is the identifier number
- {identifierNo} where {identifierNo} is the identifier number
- externalCustomerId={externalCustomerId} where {externalCustomerId} is customer's external identifier. When {externalType} not provided, the default value EXT (External) will be taken.
- externalCustomerId={externalCustomerId}&externalType={externalType} where {externalCustomerId} is customer's external identifier, {externalType} is code of type used to identify which external system is the owner of {externalCustomerId}

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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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 transactions

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

Authorizations:
user_client_scheme (any)
path Parameters
target
required
string

Target unique id of loyalty identifier. Constructed as following:
- customerId={customerId} where {customerId} is unique customer internal identifier
- identifierNo={identifierNo} where {identifierNo} is the identifier number
- {identifierNo} where {identifierNo} is the identifier number
- externalCustomerId={externalCustomerId} where {externalCustomerId} is customer's external identifier. When {externalType} not provided, the default value EXT (External) will be taken.
- externalCustomerId={externalCustomerId}&externalType={externalType} where {externalCustomerId} is customer's external identifier, {externalType} is code of type used to identify which external system is the owner of {externalCustomerId}

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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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 points expiration forecast

Get list of points expiration forecast.
Sortable by [expirationDate].
Default sort: expirationDate:ASC.

Authorizations:
user_client_scheme (any)
path Parameters
target
required
string

Target unique id of loyalty identifier. Constructed as following:
- customerId={customerId} where {customerId} is unique customer internal identifier
- identifierNo={identifierNo} where {identifierNo} is the identifier number
- {identifierNo} where {identifierNo} is the identifier number
- externalCustomerId={externalCustomerId} where {externalCustomerId} is customer's external identifier. When {externalType} not provided, the default value EXT (External) will be taken.
- externalCustomerId={externalCustomerId}&externalType={externalType} where {externalCustomerId} is customer's external identifier, {externalType} is code of type used to identify which external system is the owner of {externalCustomerId}

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 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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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 transaction

Get transaction details.
Transaction results depend on transaction type and system configuration.

Authorizations:
user_client_scheme (any)
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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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",
  • "cashierId": "string",
  • "accountId": 0,
  • "customerId": 0,
  • "delayedBasicPoints": 0,
  • "points": [
    ],
  • "delayedPoints": [
    ],
  • "incentiveValue": 0,
  • "discountValue": 0,
  • "totalValue": 0,
  • "paymentValue": 0,
  • "currencyCode": "str",
  • "shared": true,
  • "genericEvent": true,
  • "correctionReasonCode": "string",
  • "processDate": "2019-08-24T14:15:22Z",
  • "confirmationDate": "2019-08-24T14:15:22Z",
  • "comment": "string",
  • "files": [
    ],
  • "createdBy": "string",
  • "triggeredRules": [
    ],
  • "issuedCoupons": [
    ],
  • "burnedCoupons": [
    ],
  • "refundedCoupons": [
    ],
  • "products": [
    ],
  • "attributes": [
    ],
  • "paymentMethods": [
    ]
}

Recognition


Some loyalty programs uses tiers to recognize its most valuable members. If your program uses the, here you will find all needed details such as tiers with descriptions, benefits and perks members can get to display on your end. Each member is also interest in his own level so you can display his current tier together with the configured progress tracker.

Get member current recognition

Get member's current recognition tier.

Authorizations:
user_client_scheme (any)
path Parameters
target
required
string

Target unique id of loyalty identifier. Constructed as following:
- customerId={customerId} where {customerId} is unique customer internal identifier
- identifierNo={identifierNo} where {identifierNo} is the identifier number
- {identifierNo} where {identifierNo} is the identifier number
- externalCustomerId={externalCustomerId} where {externalCustomerId} is customer's external identifier. When {externalType} not provided, the default value EXT (External) will be taken.
- externalCustomerId={externalCustomerId}&externalType={externalType} where {externalCustomerId} is customer's external identifier, {externalType} is code of type used to identify which external system is the owner of {externalCustomerId}

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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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",
  • "effectiveDate": "2019-08-24",
  • "expirationDate": "2019-08-24",
  • "nextTierCode": "string"
}

Get schemas

Get recognition schemas

Authorizations:
user_client_scheme (any)
query Parameters
code
string <= 40 characters

Recognition schema unique identifier.

name
string <= 1000 characters

Recognition schema internal name.

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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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 tier details

Get recognition tier details.

Authorizations:
user_client_scheme (any)
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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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",
  • "imageId": "string",
  • "benefits": [
    ]
}

Get benefit details

Get benefit details.

Authorizations:
user_client_scheme (any)
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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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",
  • "type": "string",
  • "typeName": "string",
  • "name": "string",
  • "description": "string",
  • "externalName": "string",
  • "externalDescription": "string",
  • "images": [
    ]
}

Get member progress tracker

Get member's progress tracker for next recognition tier.

Authorizations:
user_client_scheme (any)
path Parameters
target
required
string

Target unique id of loyalty identifier. Constructed as following:
- customerId={customerId} where {customerId} is unique customer internal identifier
- identifierNo={identifierNo} where {identifierNo} is the identifier number
- {identifierNo} where {identifierNo} is the identifier number
- externalCustomerId={externalCustomerId} where {externalCustomerId} is customer's external identifier. When {externalType} not provided, the default value EXT (External) will be taken.
- externalCustomerId={externalCustomerId}&externalType={externalType} where {externalCustomerId} is customer's external identifier, {externalType} is code of type used to identify which external system is the owner of {externalCustomerId}

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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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
{
  • "currentTier": {
    },
  • "nextTier": {
    },
  • "progressTrackerTypeIndicator": "string"
}

Coupons


This set of methods also 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 assign to his loyalty identifier. Member can find the names, validity dates, value and code of the coupon on his account.

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:
user_client_scheme (any)
path Parameters
target
required
string

Target unique id of loyalty identifier. Constructed as following:
- customerId={customerId} where {customerId} is unique customer internal identifier
- identifierNo={identifierNo} where {identifierNo} is the identifier number
- {identifierNo} where {identifierNo} is the identifier number
- externalCustomerId={externalCustomerId} where {externalCustomerId} is customer's external identifier. When {externalType} not provided, the default value EXT (External) will be taken.
- externalCustomerId={externalCustomerId}&externalType={externalType} where {externalCustomerId} is customer's external identifier, {externalType} is code of type used to identify which external system is the owner of {externalCustomerId}

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.

applicableForShopify
boolean

When true returns only coupons applicable to integration with Shopify, when false returns all.
Default value is false

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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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 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,
when identifierNo is not provided are visible only coupons for non-logged in users (i.e. broadcast = true).
Sortable by [code, name, distributionMode].

Authorizations:
user_client_scheme (any)
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.

identifierNo
string

Loyalty identifier on which operation will be processed.
Causes processing on the identifier level.

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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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

Authorizations:
user_client_scheme (any)
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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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

Get coupon numbers status

Get list of coupon numbers status.
Exactly one of the following request fields is required:

  • [couponNumber]
  • [identifierId, couponNumber]
  • [identifierNo, couponNumber]

    Note that there may exist multiple coupons with same couponNumber belonging to different or same customers.
Authorizations:
user_client_scheme (any)
query Parameters
couponNumber
Array of strings

Coupon numbers list

identifierId
integer

Unique id of identifier of the customer who is coupon owner.
Exactly one of [identifierId, identifierNo] can be provied.

identifierNo
string

Identifier number of the customer who is coupon owner.
Exactly one of [identifierId, identifierNo] can be provided.

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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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

Accruals & Returns


By these methods you will feed the System with the transactional data. Transaction date, value or purchased products or used coupon are used in the loyalty program to give points or issue new coupon based on configured promotions. From business perspective returns are also needed, in this case the number of previously issued points is deducted. You can use them also in Simulate mode to check the effect.

Buy products

Process or simulate sale transaction on identifier level.
Accrues points basing on basket items.
Exactly one of the following query parameters is required:

  • [identifierId]
  • [identifierNo]
  • [externalCustomerId]
  • [externalCustomerId, externalType]
Authorizations:
user_client_scheme (any)
query Parameters
identifierId
integer

Unique id of the loyalty identifier on which operation will be processed.
Causes processing on the identifier level.

identifierNo
string

Loyalty identifier on which operation will be processed.
Causes processing on the identifier level.

externalCustomerId
string

Id assigned in external system to the customer on which operation will be processed.
Connected with externalType. Causes processing on the identifier level.

externalType
string

Code of type used to identify which external system is the owner of externalCustomerId. EXTERNAL_IDENTIFIER_TYPES dictionary.
When not provided, the default value EXT (External) will be taken.
Connected with externalCustomerId. Causes processing on the identifier level.

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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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
partner
required
string <= 10 characters

Partner code from PARTNERS dictionary.
The partner will be associated with the transaction

trnNo
string <= 100 characters

Partner transaction number

location
string <= 10 characters

Code of partner's location from LOCATIONS dictionary.
Requires partner.

date
string <date-time>

Transaction date.
Defaults to now when not privided.

totalValue
number <double (2 decimal digits)> >= 0.01

Total value as given by the POS system, may be different from the basket amount.
When provided, overrides the total value amount calculated from contents of the basket.

maxTotalValue
number <double (2 decimal digits)> >= 0

Max total value of sale request. When provided, result of subtraction of discountValue from totalValue is validated.
If subtraction result exceeds maxTotalValue, then request is rejected.

currencyCode
string <= 3 characters

Code of currency with which purchase is paid.
Defaults to loyalty platform system currency.

Array of objects (types.CouponBurnRequest) non-empty

Coupons which have been burned in the transaction.

Array of objects (types.SaleRequestBasketItem)

List of products in basket.
For each product either productVariantCode and/or exactly one of [code, externalCode] is required.

comment
string <= 400 characters

Transaction comment

paymentMethods
string <= 100 characters

List of payment method codes separated by comma. PAYMENT_METHODS dictionary .
Transaction payment method verification against dictionary PAYMENT_METHODS depends on system parameter TRN_PAYMENT_METHOD_VERIFICATION (dafault TRUE).
Default value is UNK - Unknown.

cashierId
string <= 100 characters

Cashier identifier in external system

paymentPoints
integer <int32> [ 1 .. 9999999999 ]

Points used for paying part of the bill value.

Array of objects

List of transaction attributes.

Responses

Request samples

Content type
application/json
{
  • "partner": "PRT",
  • "trnNo": 34234234,
  • "location": "EE",
  • "date": "2019-08-24T14:15:22Z",
  • "totalValue": 0,
  • "maxTotalValue": 0,
  • "currencyCode": "USD",
  • "coupons": [
    ],
  • "products": [
    ],
  • "comment": "Sale transaction with products and coupons",
  • "paymentMethods": "UNK",
  • "cashierId": 351235,
  • "paymentPoints": 100,
  • "attributes": [
    ]
}

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,
  • "payWithPointsDiscountValue": 0,
  • "messages": [
    ],
  • "products": [
    ],
  • "billDiscountPromotions": [
    ],
  • "issuedCoupons": [
    ],
  • "burnedCoupons": [
    ],
  • "refundedCoupons": [
    ]
}

Upload invoice binary file

Upload invoice binary file into the system storage.

Authorizations:
user_client_scheme (any)
path Parameters
target
required
string

Target unique id of loyalty identifier. Constructed as following:
- customerId={customerId} where {customerId} is unique customer internal identifier
- identifierNo={identifierNo} where {identifierNo} is the identifier number
- {identifierNo} where {identifierNo} is the identifier number
- externalCustomerId={externalCustomerId} where {externalCustomerId} is customer's external identifier. When {externalType} not provided, the default value EXT (External) will be taken.
- externalCustomerId={externalCustomerId}&externalType={externalType} where {externalCustomerId} is customer's external identifier, {externalType} is code of type used to identify which external system is the owner of {externalCustomerId}

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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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

File contents

Responses

Response samples

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

Get invoice binary file

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

Authorizations:
user_client_scheme (any)
path Parameters
invoiceId
required
string <= 99 characters

Encoded system-wide unique file identifier.

target
required
string

Target unique id of loyalty identifier. Constructed as following:
- customerId={customerId} where {customerId} is unique customer internal identifier
- identifierNo={identifierNo} where {identifierNo} is the identifier number
- {identifierNo} where {identifierNo} is the identifier number
- externalCustomerId={externalCustomerId} where {externalCustomerId} is customer's external identifier. When {externalType} not provided, the default value EXT (External) will be taken.
- externalCustomerId={externalCustomerId}&externalType={externalType} where {externalCustomerId} is customer's external identifier, {externalType} is code of type used to identify which external system is the owner of {externalCustomerId}

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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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

Process invoices

Accrues points basing on invoice files using optical character recognition.
Exactly one of the following query parameters is required:

  • [identifierId]
  • [identifierNo]
  • [externalCustomerId]
  • [externalCustomerId, externalType]
Authorizations:
user_client_scheme (any)
query Parameters
identifierId
integer

Unique id of the loyalty identifier on which operation will be processed.
Causes processing on the identifier level.

identifierNo
string

Loyalty identifier on which operation will be processed.
Causes processing on the identifier level.

externalCustomerId
string

Id assigned in external system to the customer on which operation will be processed.
Connected with externalType. Causes processing on the identifier level.

externalType
string

Code of type used to identify which external system is the owner of externalCustomerId. EXTERNAL_IDENTIFIER_TYPES dictionary.
When not provided, the default value EXT (External) will be taken.
Connected with externalCustomerId. Causes processing on the identifier level.

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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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
fileIds
required
Array of strings

Encoded system-wide unique identifiers of uploaded invoices.

Responses

Request samples

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

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,
  • "payWithPointsDiscountValue": 0,
  • "messages": [
    ],
  • "products": [
    ],
  • "billDiscountPromotions": [
    ],
  • "issuedCoupons": [
    ],
  • "burnedCoupons": [
    ],
  • "refundedCoupons": [
    ]
}

Return products

Process products return transaction on identifier level.
Cancels accrued points basing on returned products basket.
Exactly one of the following query parameters is required:

  • [identifierId]
  • [identifierNo]
  • [externalCustomerId, externalType]
Authorizations:
user_client_scheme (any)
query Parameters
identifierId
integer

Unique id of the loyalty identifier on which operation will be processed.
Causes processing on the identifier level.

identifierNo
string

Loyalty identifier on which operation will be processed.
Causes processing on the identifier level.

externalCustomerId
string

Id assigned in external system to the customer on which operation will be processed.
Connected with externalType. Causes processing on the identifier level.

externalType
string

Code of type used to identify which external system is the owner of externalCustomerId. EXTERNAL_IDENTIFIER_TYPES dictionary.
When not provided, the default value EXT (External) will be taken.
Connected with externalCustomerId. Causes processing on the identifier level.

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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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
partner
required
string <= 10 characters

Partner code. PARTNERS dictionary.
Use DEFAULT for loyalty.

location
string <= 10 characters

Partner's location code.
Requires partner.

required
Array of objects (types.SaleReturnBasketItem)

List of products to return.
For each product at least one of [code, productVariantCode] is required.

comment
string <= 400 characters

Transaction comment

cashierId
string <= 100 characters

Cashier identifier in external system

Responses

Request samples

Content type
application/json
{
  • "partner": "string",
  • "location": "string",
  • "products": [
    ],
  • "comment": "string",
  • "cashierId": "string"
}

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,
  • "payWithPointsDiscountValue": 0,
  • "messages": [
    ],
  • "products": [
    ],
  • "billDiscountPromotions": [
    ],
  • "issuedCoupons": [
    ],
  • "burnedCoupons": [
    ],
  • "refundedCoupons": [
    ]
}

Return products from transaction

Process products return transaction on identifier level.
Cancels accrued points basing on returned products basket.
Refers to the original transaction. Identifier number is taken from the original transaction.
At least one of request body parameters [products, totalValue] is required.

Authorizations:
user_client_scheme (any)
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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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
partner
required
string <= 10 characters

Original transaction partner code

processMode
string <= 1 characters
Default: "C"
Value: "C"

Processing mode:

  • C - SIMULATE_AND_CORRECT - simulates Sale transaction with original transaction date and basket consisting of returned products, then creates Return transaction with returned products and appropriate returned points amount known from comparing original and simulated Sale transactions; other effects of original transaction (e.g. issued and burned coupons) are not altered.
location
string <= 10 characters

Partner's location code.
Requires partner.

Array of objects (types.SaleReturnWithTransactionBasketItem)

List of products to return.
For each product at least one of [code, productVariantCode] is required.

comment
string <= 400 characters

Transaction comment

totalValue
number <double (2 decimal digits)>

Transaction total value

cashierId
string <= 100 characters

Cashier identifier in external system

Responses

Request samples

Content type
application/json
{
  • "partner": "string",
  • "processMode": "C",
  • "location": "string",
  • "products": [
    ],
  • "comment": "string",
  • "totalValue": 0,
  • "cashierId": "string"
}

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,
  • "payWithPointsDiscountValue": 0,
  • "messages": [
    ],
  • "products": [
    ],
  • "billDiscountPromotions": [
    ],
  • "issuedCoupons": [
    ],
  • "burnedCoupons": [
    ],
  • "refundedCoupons": [
    ]
}

Return products from partner transaction

Process products return transaction on identifier level.
Cancels accrued points basing on returned products basket.
Refers to the original transaction by partner's transaction unique number. Identifier number is taken from the original transaction.
At least one of request body parameters [products, totalValue] is required.

Authorizations:
user_client_scheme (any)
path Parameters
partnerCode
required
string

Transaction's partner code

trnNo
required
string

Transaction partner's unique transaction number

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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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
processMode
string <= 1 characters
Default: "C"
Value: "C"

Processing mode:

  • C - SIMULATE_AND_CORRECT - simulates Sale transaction with original transaction date and basket consisting of returned products, then creates Return transaction with returned products and appropriate returned points amount known from comparing original and simulated Sale transactions; other effects of original transaction (e.g. issued and burned coupons) are not altered.
location
string <= 10 characters

Partner's location code.
Requires partner.

Array of objects (types.SaleReturnWithTransactionBasketItem)

List of products to return.
For each product at least one of [code, productVariantCode] is required.

comment
string <= 400 characters

Transaction comment

totalValue
number <double (2 decimal digits)>

Transaction total value

cashierId
string <= 100 characters

Cashier identifier in external system

Responses

Request samples

Content type
application/json
{
  • "processMode": "C",
  • "location": "string",
  • "products": [
    ],
  • "comment": "string",
  • "totalValue": 0,
  • "cashierId": "string"
}

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,
  • "payWithPointsDiscountValue": 0,
  • "messages": [
    ],
  • "products": [
    ],
  • "billDiscountPromotions": [
    ],
  • "issuedCoupons": [
    ],
  • "burnedCoupons": [
    ],
  • "refundedCoupons": [
    ]
}

Rewards


Browsing thru rewards with colorful images, checking their price in points and availability – that's one of the most frequent member activity in the program. You can display whole catalog with many details to show the attractiveness of your program.

Get reward categories

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

Authorizations:
user_client_scheme (any)
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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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.
Sortable by [code, name, categoryOrder, auditCD, pricePlan.points, type, status, 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:
user_client_scheme (any)
query Parameters
filter
string >= 3 characters

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

externalFilter
string >= 3 characters

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

code
Array of strings

List of reward codes. REWARDS dictionary.

internalName
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.

status
Array of strings

List of reward statuses. REWARD_STATUSES dictionary.

startDateFrom
string <date>

Reward availability start date - lower limit. Inclusive.

startDateTo
string <date>

Reward availability start date - upper limit. Inclusive.

endDateFrom
string <date>

Reward availability end date - lower limit. Inclusive.
Rewards with empty endDate are returned regardless of this filter.

endDateTo
string <date>

Reward availability end date - upper limit. 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 startDateFrom, startDateTo, endDateFrom, endDateTo 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.

segments
Array of strings

List of segments assigned to reward.
Each item is segment code. SEGMENTS dictionary.

unlimitedQuantity
boolean

Filter rewards which availability is limited due to targeting and segmentation or those which are available to any member.

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 price plan points - lower boundary, inclusive. Minimum amount of points that customer is willing to pay for reward.
Makes sense with payment variants allowing spending points for reward.

pricePlan.pointsTo
integer

Maximum price plan points - upper boundary, inclusive. Maximum amount of points that customer is willing to pay for reward.
Makes sense with payment variants allowing spending points 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.startDateFrom
string <date>

Reward price plan availability start date - lower limit. Inclusive.
Rewards with empty pricePlan.startDate are returned regardless of this filter.

pricePlan.startDateTo
string <date>

Reward price plan availability start date - upper limit. Inclusive.
Rewards with empty pricePlan.startDate are returned regardless of this filter.

pricePlan.endDateFrom
string <date>

Reward price plan availability end date - lower limit. Inclusive.
Rewards with empty pricePlan.endDate are returned regardless of this filter.

pricePlan.endDateTo
string <date>

Reward price plan availability end date - upper limit. 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.startDateFrom, pricePlan.startDateTo, pricePlan.endDateFrom, pricePlan.endDateTo criteria is provided.
Available options:

  • D - Today
  • W - This week
  • M - This month
  • Y - This year
availableToCustomerId
integer

Id of customer.
When set returns only rewards available to that customer.

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" "segments" "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, segments, 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.

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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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

Authorizations:
user_client_scheme (any)
path Parameters
rewardCode
required
string

Unique code identifying reward

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.

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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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",
  • "internalName": "string",
  • "externalName": "string",
  • "description": "string",
  • "externalDescription": "string",
  • "type": "s",
  • "category": "string",
  • "masterCategory": "string",
  • "couponTypeCode": "string",
  • "categoryOrder": 0,
  • "externalNameI18N": {
    },
  • "status": "s",
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "externalDescriptionI18N": {
    },
  • "partner": "string",
  • "supplier": "string",
  • "netValue": 0,
  • "tax": "string",
  • "quantity": 1,
  • "maximumRedemptionsAllowed": 1,
  • "nonMaterial": true,
  • "statusName": "string",
  • "partnerName": "string",
  • "typeName": "string",
  • "categoryName": "string",
  • "categoryInternalName": "string",
  • "masterCategoryName": "string",
  • "masterCategoryInternalName": "string",
  • "pricePlans": [
    ],
  • "segments": [
    ],
  • "tiers": [
    ],
  • "resources": {
    },
  • "lastModify": "2019-08-24T14:15:22Z"
}

Get member targeted rewards

Get list of member targeted rewards which are currently active.
Sortable by [code, name, categoryOrder, auditCD, pricePlan.points, type, status, 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:
user_client_scheme (any)
path Parameters
target
required
string

Target unique id of loyalty identifier. Constructed as following:
- customerId={customerId} where {customerId} is unique customer internal identifier
- identifierNo={identifierNo} where {identifierNo} is the identifier number
- {identifierNo} where {identifierNo} is the identifier number
- externalCustomerId={externalCustomerId} where {externalCustomerId} is customer's external identifier. When {externalType} not provided, the default value EXT (External) will be taken.
- externalCustomerId={externalCustomerId}&externalType={externalType} where {externalCustomerId} is customer's external identifier, {externalType} is code of type used to identify which external system is the owner of {externalCustomerId}

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
couponIncentiveTarget
string
Enum: "T" "P"

Returns only rewards of type coupon that have specified discount incentive and incentive target.
Available options:

  • T - Whole ticket
  • P - Products
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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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

Get list of member targeted rewards which are currently active.
Sortable by [code, name, categoryOrder, auditCD, pricePlan.points, type, status, 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:
user_client_scheme (any)
path Parameters
target
required
string

Target unique id of loyalty identifier. Constructed as following:
- customerId={customerId} where {customerId} is unique customer internal identifier
- identifierNo={identifierNo} where {identifierNo} is the identifier number
- {identifierNo} where {identifierNo} is the identifier number
- externalCustomerId={externalCustomerId} where {externalCustomerId} is customer's external identifier. When {externalType} not provided, the default value EXT (External) will be taken.
- externalCustomerId={externalCustomerId}&externalType={externalType} where {externalCustomerId} is customer's external identifier, {externalType} is code of type used to identify which external system is the owner of {externalCustomerId}

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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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

Rewards orders


History of rewards orders (redemptions) to be displayed on customer profile. There is also and option to manage/ cancel the particular order this way.

Get rewards orders

Get list of reward orders.

Authorizations:
user_client_scheme (any)
query Parameters
accountId
integer

Unique identifier of the account which is owner of the requested entity.
Causes processing on the account level.

customerId
integer

Unique identifier of the customer who is owner of the requested entity.
Causes processing on the customer level.

login
string

Unique login of the customer who is owner of the requested entity.
Causes processing on the customer level.

identifierId
integer

Unique id of the loyalty identifier which identified the owner of the requested entity.
Causes processing on the identifier level.

identifierNo
string

Loyalty identifier which identifies the owner of the requested entity.
Causes processing on the identifier level.

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.

partner
string

Partner code. PARTNERS dictionary

location
string

Location code. LOCATIONS dictionary

withRewards
boolean

Flag indicates whether to get orders with rewards. If not set, return orders without rewards

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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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:
user_client_scheme (any)
path Parameters
target
required
string

Target unique id of loyalty identifier. Constructed as following:
- customerId={customerId} where {customerId} is unique customer internal identifier
- identifierNo={identifierNo} where {identifierNo} is the identifier number
- {identifierNo} where {identifierNo} is the identifier number
- externalCustomerId={externalCustomerId} where {externalCustomerId} is customer's external identifier. When {externalType} not provided, the default value EXT (External) will be taken.
- externalCustomerId={externalCustomerId}&externalType={externalType} where {externalCustomerId} is customer's external identifier, {externalType} is code of type used to identify which external system is the owner of {externalCustomerId}

orderId
required
integer

order internal unique 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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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",
  • "ownerMobile": "string",
  • "ownerMobilePhonePrefix": "string",
  • "channel": "s",
  • "channelName": "string",
  • "location": "string",
  • "locationName": "string",
  • "totalPointTypes": [
    ],
  • "deliveryAddress": {
    },
  • "deliveryLocation": {
    },
  • "comment": "string",
  • "rewards": [
    ],
  • "totalQuantity": 0,
  • "externalId": "string"
}

Cancel rewards order by orderId

Authorizations:
user_client_scheme (any)
path Parameters
orderId
required
integer

order internal unique 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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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:
user_client_scheme (any)
path Parameters
transactionId
required
integer

Transaction internal unique 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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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

Reversals & Refunds


By using them you can fully reverses any revertible transaction such as accrual, generic event (reversal). Not all transactions and actions are marked as reversible in the System.

Reverse transaction

Fully reverses any revertible transaction.
Note: Use return operations to partially reverse accrual transactions.

Authorizations:
user_client_scheme (any)
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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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
comment
string <= 400 characters

Transaction comment

cashierId
string <= 100 characters

Cashier identifier in external system

Responses

Request samples

Content type
application/json
{
  • "comment": "string",
  • "cashierId": "string"
}

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,
  • "payWithPointsDiscountValue": 0,
  • "messages": [
    ],
  • "products": [
    ],
  • "billDiscountPromotions": [
    ],
  • "issuedCoupons": [
    ],
  • "burnedCoupons": [
    ],
  • "refundedCoupons": [
    ]
}

Reverse partner transaction

Fully reverses any revertible transaction found by partner's unique transaction number.
Note: Use return operations to partially reverse accrual transactions.

Authorizations:
user_client_scheme (any)
path Parameters
partnerCode
required
string

Transaction's partner code

trnNo
required
string

Transaction partner's unique transaction number

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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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
comment
string <= 400 characters

Transaction comment

cashierId
string <= 100 characters

Cashier identifier in external system

Responses

Request samples

Content type
application/json
{
  • "comment": "string",
  • "cashierId": "string"
}

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,
  • "payWithPointsDiscountValue": 0,
  • "messages": [
    ],
  • "products": [
    ],
  • "billDiscountPromotions": [
    ],
  • "issuedCoupons": [
    ],
  • "burnedCoupons": [
    ],
  • "refundedCoupons": [
    ]
}

Events


The System allows to configure the special type of transaction to be processed according to promotions. They are called Generic Events – using them in your program you are building deeper, not-transactional loyalty. If you want to reward your members for watching your content or reviewing products you should use this one.

Process generic event

Process or simulate generic event transaction on identifier level.
Generic events implement DefaultCommand class. Result of generic event processing depends only on system configuration.
Exactly one of the following query parameters is required:

  • [identifierId]
  • [identifierNo]
  • [externalCustomerId]
  • [externalCustomerId, externalType]
Authorizations:
user_client_scheme (any)
query Parameters
identifierId
integer

Unique id of the loyalty identifier on which operation will be processed.
Causes processing on the identifier level.

identifierNo
string

Loyalty identifier on which operation will be processed.
Causes processing on the identifier level.

externalCustomerId
string

Id assigned in external system to the customer on which operation will be processed.
Connected with externalType. Causes processing on the identifier level.

externalType
string

Code of type used to identify which external system is the owner of externalCustomerId. EXTERNAL_IDENTIFIER_TYPES dictionary.
When not provided, the default value EXT (External) will be taken.
Connected with externalCustomerId. Causes processing on the identifier level.

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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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
date
string <date-time>

Event date.
When not provided defaults to now.

type
required
string

Generic event transaction type.
Works with dedicated, configured transaction types that use implementation of DefaultCommand class.

partner
required
string <= 10 characters

Partner code. PARTNERS dictionary.
Use DEFAULT for loyalty.

location
string <= 10 characters

Partner's location code.
Requires partner.

trnNo
string <= 100 characters

Partner transaction number

comment
string <= 400 characters

Comment

Array of objects

List of generic event transaction attributes.

totalValue
number <double (2 decimal digits)> >= 0

Total value.

currencyCode
string <= 3 characters

Code of currency with which purchase is paid.
Defaults to loyalty platform system currency.

paymentMethods
string <= 100 characters

List of payment method codes separated by comma. PAYMENT_METHODS dictionary.
Transaction payment method verification against dictionary PAYMENT_METHODS depends on system parameter TRN_PAYMENT_METHOD_VERIFICATION (dafault TRUE).
Default value is UNK - Unknown.

cashierId
string <= 100 characters

Cashier identifier in external system

Responses

Request samples

Content type
application/json
{
  • "date": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "partner": "string",
  • "location": "string",
  • "trnNo": "string",
  • "comment": "string",
  • "attributes": [
    ],
  • "totalValue": 0,
  • "currencyCode": "str",
  • "paymentMethods": "string",
  • "cashierId": "string"
}

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,
  • "payWithPointsDiscountValue": 0,
  • "messages": [
    ],
  • "products": [
    ],
  • "billDiscountPromotions": [
    ],
  • "issuedCoupons": [
    ],
  • "burnedCoupons": [
    ],
  • "refundedCoupons": [
    ]
}

Redemptions


Redemptions requests are use to burn points to the reward from catalogue (online, physical) or burn any issued coupon during transaction. You can use them also in Simulate mode to check the effect.

Redeem points to get a reward

Process or simulate redemption transaction on customer or identifier level.
Redeems basing on business rules and rewards catalogue.
Exactly one of the following query parameters is required:

  • [identifierId]
  • [identifierNo]
  • [externalCustomerId]
  • [externalCustomerId, externalType]
Authorizations:
user_client_scheme (any)
query Parameters
identifierId
integer

Unique id of the loyalty identifier on which operation will be processed.
Causes processing on the identifier level.

identifierNo
string

Loyalty identifier on which operation will be processed.
Causes processing on the identifier level.

externalCustomerId
string

Id assigned in external system to the customer on which operation will be processed.
Connected with externalType. Causes processing on the identifier level.

externalType
string

Code of type used to identify which external system is the owner of externalCustomerId. EXTERNAL_IDENTIFIER_TYPES dictionary.
When not provided, the default value EXT (External) will be taken.
Connected with externalCustomerId. Causes processing on the identifier level.

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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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
partner
required
string <= 10 characters

Partner code. PARTNERS dictionary.

trnNo
string <= 100 characters

Partner transaction number

location
string <= 10 characters

Code of partner's location.
Requires partner.

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).

cashierId
string <= 100 characters

Cashier identifier in external system

Responses

Request samples

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

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,
  • "payWithPointsDiscountValue": 0,
  • "messages": [
    ],
  • "products": [
    ],
  • "billDiscountPromotions": [
    ],
  • "issuedCoupons": [
    ],
  • "burnedCoupons": [
    ],
  • "refundedCoupons": [
    ]
}

Redeem coupon

Process or simulate coupon redemption transaction.
Operation burns coupon issued to loyalty member.
Exactly one of the following query parameters is required:

  • [identifierId]
  • [identifierNo]
  • [externalCustomerId]
  • [externalCustomerId, externalType]
Authorizations:
user_client_scheme (any)
query Parameters
identifierId
integer

Unique id of the loyalty identifier on which operation will be processed.
Causes processing on the identifier level.

identifierNo
string

Loyalty identifier on which operation will be processed.
Causes processing on the identifier level.

externalCustomerId
string

Id assigned in external system to the customer on which operation will be processed.
Connected with externalType. Causes processing on the identifier level.

externalType
string

Code of type used to identify which external system is the owner of externalCustomerId. EXTERNAL_IDENTIFIER_TYPES dictionary.
When not provided, the default value EXT (External) will be taken.
Connected with externalCustomerId. Causes processing on the identifier level.

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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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
partner
required
string <= 10 characters

Partner code. PARTNERS dictionary.
Use DEFAULT for loyalty.

trnNo
string <= 100 characters

Partner transaction number

location
string <= 10 characters

Code of partner's location.
Requires partner.

date
string <date-time>

Transaction date.
Defaults to now when not provided.

comment
string <= 400 characters

Transaction comment

required
Array of objects (types.CouponRedemptionBurnRequest) non-empty

Burned coupons

cashierId
string <= 100 characters

Cashier identifier in external system

Responses

Request samples

Content type
application/json
{
  • "partner": "string",
  • "trnNo": "string",
  • "location": "string",
  • "date": "2019-08-24T14:15:22Z",
  • "comment": "string",
  • "coupons": [
    ],
  • "cashierId": "string"
}

Response samples

Content type
application/json
{
  • "transactionId": 0,
  • "status": "s",
  • "statusName": "string",
  • "memberBalance": {
    },
  • "burnedCoupons": [
    ]
}

Balance


The System posts the given member points balance with the points type brakeage on the loyalty identifier level. This transaction is visible on the member’s transaction list.

Balance inquiry

Process balance inquiry transaction on identifier level.
Queries for points balance using the loyalty identifier.
Exactly one of the following query parameters is required:

  • [identifierId]
  • [identifierNo]
Authorizations:
user_client_scheme (any)
query Parameters
identifierId
integer

Unique id of the loyalty identifier on which operation will be processed.
Transaction is processed on the customer level.

identifierNo
string

Loyalty identifier on which operation will be processed.
Transaction is processed on the customer level.

simulate
boolean
Default: true

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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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
partner
required
string <= 10 characters

Partner code. PARTNERS dictionary.

cashierId
string <= 100 characters

Cashier identifier in external system

Responses

Request samples

Content type
application/json
{
  • "partner": "string",
  • "cashierId": "string"
}

Response samples

Content type
application/json
{
  • "transactionId": 0,
  • "status": "s",
  • "statusName": "string",
  • "memberBalance": {
    }
}

General Dictionaries


This set of methods response with the detailed list dictionaries and dictionary items values. So if you want to present Titles or Genders values on your page, or the phone prefixes list that are allowed in the System you will use these.

Get available dictionaries

List of available dictionaries

Authorizations:
user_client_scheme (any)
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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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

Authorizations:
user_client_scheme (any)
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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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

Authorizations:
user_client_scheme (any)
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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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 allowed member languages

Returns languages from the LANGUAGES dictionary of the MEMBER_LANGUAGES parameter.

Authorizations:
user_client_scheme (any)
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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

Responses

Response samples

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

Get system parameter

Get system parameter

Authorizations:
user_client_scheme (any)
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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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

Products


In case you are building the loyalty program based on products or products category and you want to reward your members for purchasing particular items (on the SKU level) the System required products import to be able to recognize them in transaction.

Get product categories

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

Authorizations:
user_client_scheme (any)
query Parameters
filter
string >= 3 characters

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

code
Array of strings

List of product category codes. PRODUCT_HIERARCHY dictionary.

name
string

Product category name.

parentCategory
Array of strings

List of associated upper level categories codes. PRODUCT_HIERARCHY dictionary.

root
boolean

When true returns only root level categories, when false only non root level categories.

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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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

Create new product category

Create new product category.

Authorizations:
user_client_scheme (any)
Request Body schema: application/json
code
string <= 26 characters

Unique product category code. Autogenerated if not provided.

name
required
string [ 3 .. 500 ] characters

Product category name.

parentCategoryCode
string

Parent product category code. PRODUCT_HIERARCHY dictionary.

description
string <= 2000 characters

Product category description.

object

Product category short description.
Max length of [value, i18n.value] is no more than 500 characters.

externalCode
string <= 100 characters

External product category code.

externalParentCategoryCode
string <= 100 characters

External product category extrnal code. It might be the SAP or another number defined in the external system. Depending on the project.

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "parentCategoryCode": "string",
  • "description": "string",
  • "shortDescriptionI18N": {
    },
  • "externalCode": "string",
  • "externalParentCategoryCode": "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": [
    ]
}

Modify product category

Modify product category.

Authorizations:
user_client_scheme (any)
path Parameters
code
required
string

Unique code identifying product category.

Request Body schema: application/json
name
required
string [ 3 .. 500 ] characters

Product category name.

parentCategoryCode
string

Parent product category code. PRODUCT_HIERARCHY dictionary.

description
string <= 2000 characters

Product category description.

object

Product category short description.
Max length of [value, i18n.value] is no more than 500 characters.

externalCode
string <= 100 characters

External product category code.

externalParentCategoryCode
string <= 100 characters

External product category extrnal code. It might be the SAP or another number defined in the external system. Depending on the project.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "parentCategoryCode": "string",
  • "description": "string",
  • "shortDescriptionI18N": {
    },
  • "externalCode": "string",
  • "externalParentCategoryCode": "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": [
    ]
}

Product categories mass removal

Product categories mass removal

Authorizations:
user_client_scheme (any)
Request Body schema: application/json
codes
required
Array of strings unique

Product category codes uniquely identifying the product category.

Responses

Request samples

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

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 products

Get list of products available in product catalogue.
Sortable by [code, name, externalCode, restricted].

Authorizations:
user_client_scheme (any)
query Parameters
code
Array of strings

List of product codes. PRODUCTS dictionary.

name
string

Product name

categoryCode
string

Code of product category assigned to product. PRODUCT_HIERARCHY dictionary.

Note: Search under the given categories is recursive; from the roots to the bottom children of the category.

externalCode
string

External product code

restricted
boolean

Filter awarded or restricted products

with
Array of strings
Items Enum: "options" "variants"

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 [options, variants].

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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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

Create product

Create new product

Authorizations:
user_client_scheme (any)
Request Body schema: application/json
code
string <= 26 characters

Unique product code. Autogenerated if not provided.

categoryCode
string <= 26 characters

Product category code. PRODUCT_HIERARCHY dictionary.
Must not be provided if externalCategoryCode code is provided.

externalCategoryCode
string <= 100 characters

Product category external code.
Must not be provided if categoryCode code is provided.

object

Details of the binary files related with the parent entity, e.g. images representing the entity.
Main resource should be passed to main object, other resources into the others collection.
If object is in the request, it allows to modify or clear the resource list by providing new data or not providing main or other request fields.

required
object

Product name.
Max length of [value, i18n.value] is no more than 500 characters, min length at least 3 characters.

object

Product description.
Max length of [value, i18n.value] is no more than 2000 characters

partnerCode
string <= 10 characters

Code of partner distributing the product. PARTNERS dictionary.

externalCode
string <= 100 characters

External system product code, e.g. product identifier in SAP.

restricted
boolean
Default: false

Marks products not awarded during loyalty transaction processing, e.g. cigarettes or alcohol.

Array of objects (types.ProductVariant)

Product variants.

Array of objects (types.ProductOption)

Product options

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "categoryCode": "string",
  • "externalCategoryCode": "string",
  • "resources": {
    },
  • "nameI18N": {
    },
  • "descriptionI18N": {
    },
  • "partnerCode": "string",
  • "externalCode": "string",
  • "restricted": false,
  • "productVariants": [
    ],
  • "productOptions": [
    ]
}

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 product

Modify product

Authorizations:
user_client_scheme (any)
path Parameters
productCode
required
string

Unique code identifying product.

Request Body schema: application/json
categoryCode
string

Product category code. PRODUCT_HIERARCHY dictionary.
Must not be provided if externalCategoryCode code is provided.

externalCategoryCode
string <= 100 characters

Product category external code.
Must not be provided if categoryCode code is provided.

object

Details of the binary files related with the parent entity, e.g. images representing the entity.
Main resource should be passed to main object, other resources into the others collection.
If object is in the request, it allows to modify or clear the resource list by providing new data or not providing main or other request fields.

required
object

Product name.
Max length of [value, i18n.value] is no more than 500 characters, min length at least 3 characters.

object

Product description.
Max length of [value, i18n.value] is no more than 2000 characters

partnerCode
string <= 10 characters

Code of partner distributing the product. PARTNERS dictionary.

externalCode
string <= 100 characters

External system product code, e.g. product identifier in SAP.

restricted
boolean
Default: false

Marks products not awarded during loyalty transaction processing, e.g. cigarettes or alcohol.

Array of objects (types.ProductVariant)

Product variants.

Array of objects (types.ProductOption)

Product options

lastModify
string <date-time>

Last modification date or null when object was never modified before.
Provides optimistic locking feature.

Responses

Request samples

Content type
application/json
{
  • "categoryCode": "string",
  • "externalCategoryCode": "string",
  • "resources": {
    },
  • "nameI18N": {
    },
  • "descriptionI18N": {
    },
  • "partnerCode": "string",
  • "externalCode": "string",
  • "restricted": false,
  • "productVariants": [
    ],
  • "productOptions": [
    ],
  • "lastModify": "2019-08-24T14:15:22Z"
}

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

Products mass removal

Products mass removal

Authorizations:
user_client_scheme (any)
Request Body schema: application/json
codes
required
Array of strings unique

Product codes uniquely identifying the product

Responses

Request samples

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

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 product

Get product
Exactly one of the following query parameters is required:

  • [code]
  • [externalCode]
Authorizations:
user_client_scheme (any)
query Parameters
code
string

Unique Product Code

externalCode
string

External product 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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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",
  • "categoryCode": "string",
  • "resources": {
    },
  • "nameI18N": {
    },
  • "descriptionI18N": {
    },
  • "partnerCode": "string",
  • "externalCode": "string",
  • "restricted": false,
  • "options": [
    ],
  • "variants": [
    ],
  • "lastModify": "2019-08-24T14:15:22Z"
}

Promotions

Get member promotions

Get member's promotions marked as visible.

Authorizations:
user_client_scheme (any)
path Parameters
target
required
string

Target unique id of loyalty identifier. Constructed as following:
- customerId={customerId} where {customerId} is unique customer internal identifier
- identifierNo={identifierNo} where {identifierNo} is the identifier number
- {identifierNo} where {identifierNo} is the identifier number
- externalCustomerId={externalCustomerId} where {externalCustomerId} is customer's external identifier. When {externalType} not provided, the default value EXT (External) will be taken.
- externalCustomerId={externalCustomerId}&externalType={externalType} where {externalCustomerId} is customer's external identifier, {externalType} is code of type used to identify which external system is the owner of {externalCustomerId}

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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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

Upload binary file

Upload binary file into the system storage.

Authorizations:
user_client_scheme (any)
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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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

Get binary file

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

Authorizations:
user_client_scheme (any)
path Parameters
fileId
required
string <= 99 characters

Encoded system-wide unique file identifier.

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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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

Users

Get user privileges

Get list of user privileges

Authorizations:
user_client_scheme (any)
query Parameters
module
Array of strings

List of privilege module codes. SYSTEM_MODULES 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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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

Member gets member

Get active member gets member promotion intended for enrolling member

Returns information about active member gets member promotion intended for enrolling member

Authorizations:
user_client_scheme (any)
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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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
{
  • "invitedMemberExternalName": "string",
  • "invitedMemberExternalDescription": "string",
  • "imageId": "string",
  • "termsAndConditions": {
    }
}

Get active member gets member promotion intended for logged in member

Returns information about active member gets member promotion indended for logged in member

Authorizations:
user_client_scheme (any)
path Parameters
target
required
string

Target unique id of loyalty identifier. Constructed as following:
- customerId={customerId} where {customerId} is unique customer internal identifier
- identifierNo={identifierNo} where {identifierNo} is the identifier number
- {identifierNo} where {identifierNo} is the identifier number
- externalCustomerId={externalCustomerId} where {externalCustomerId} is customer's external identifier. When {externalType} not provided, the default value EXT (External) will be taken.
- externalCustomerId={externalCustomerId}&externalType={externalType} where {externalCustomerId} is customer's external identifier, {externalType} is code of type used to identify which external system is the owner of {externalCustomerId}

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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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
{
  • "invitingMemberExternalName": "string",
  • "invitingMemberExternalDescription": "string",
  • "imageId": "string",
  • "invitationKey": "string",
  • "termsAndConditions": {
    }
}

Get member gets member invited members list

Get member gets member invited members list

Authorizations:
user_client_scheme (any)
path Parameters
target
required
string

Target unique id of loyalty identifier. Constructed as following:
- customerId={customerId} where {customerId} is unique customer internal identifier
- identifierNo={identifierNo} where {identifierNo} is the identifier number
- {identifierNo} where {identifierNo} is the identifier number
- externalCustomerId={externalCustomerId} where {externalCustomerId} is customer's external identifier. When {externalType} not provided, the default value EXT (External) will be taken.
- externalCustomerId={externalCustomerId}&externalType={externalType} where {externalCustomerId} is customer's external identifier, {externalType} is code of type used to identify which external system is the owner of {externalCustomerId}

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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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 gets member inviting member details

Get member gets member inviting member details

Authorizations:
user_client_scheme (any)
path Parameters
target
required
string

Target unique id of loyalty identifier. Constructed as following:
- customerId={customerId} where {customerId} is unique customer internal identifier
- identifierNo={identifierNo} where {identifierNo} is the identifier number
- {identifierNo} where {identifierNo} is the identifier number
- externalCustomerId={externalCustomerId} where {externalCustomerId} is customer's external identifier. When {externalType} not provided, the default value EXT (External) will be taken.
- externalCustomerId={externalCustomerId}&externalType={externalType} where {externalCustomerId} is customer's external identifier, {externalType} is code of type used to identify which external system is the owner of {externalCustomerId}

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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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,
  • "invitationKey": "string",
  • "identifierNo": "string",
  • "email": "string",
  • "mobilePhoneNumber": "string",
  • "phoneCountryPrefix": "string",
  • "firstName": "string",
  • "lastName": "string"
}

Webhooks

Get public key

Get public key for the webhook signature verification (JWKS endpoint)

Authorizations:
user_client_scheme (any)
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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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
{
  • "kty": "string",
  • "alg": "string",
  • "n": "string",
  • "e": "string"
}

Get webhook subscriptions

Get list of webhook subscriptions.
Sortable by [id].

Authorizations:
user_client_scheme (any)
query Parameters
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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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

Create webhook subscription

Create new webhook subscription

Authorizations:
user_client_scheme (any)
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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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
code
string [ 3 .. 26 ] characters

Webhook subscription code.
Unique subscription identifier.

url
required
string [ 3 .. 2000 ] characters

Url to which webhook event will be sent to.

eventType
required
any

Event type of webhook subscription. WEBHOOK_EVENT_TYPES dictionary.

version
string

Webhook version. Default value is the latest version available for the webhook type.

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "url": "string",
  • "eventType": null,
  • "version": "string"
}

Response samples

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

Get webhook subscription

Get webhook subscription

Authorizations:
user_client_scheme (any)
path Parameters
subscriptionCode
string

Unique webhook subscription 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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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",
  • "url": "string",
  • "eventType": null,
  • "version": "string",
  • "lastModify": "2019-08-24T14:15:22Z"
}

Modify webhook subscription

Modify webhook subscription

Authorizations:
user_client_scheme (any)
path Parameters
subscriptionCode
required
string

Unique code identifying webhook subscription.

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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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
url
required
string [ 3 .. 2000 ] characters

Url to which webhook event will be sent to.

eventType
required
any

Event type of webhook subscription. WEBHOOK_EVENT_TYPES dictionary.

version
required
string

Webhook version.

lastModify
string <date-time>

Last modification date or null when object was never modified before.
Provides optimistic locking feature.

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "eventType": null,
  • "version": "string",
  • "lastModify": "2019-08-24T14:15:22Z"
}

Response samples

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

Webhook subscription removal

Webhook subscription removal

Authorizations:
user_client_scheme (any)
path Parameters
subscriptionCode
required
string

Unique code identifying webhook subscription.

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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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

Tenant settings

Modify tenant settings

Modify tenant settings.
Not provided data are not overwritten in the data storage.

Authorizations:
user_client_scheme (any)
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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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
name
string

Tenant business name.

status
string <= 1 characters

Tenant status code. GENERAL_STATUSES dictionary.

size
string <= 2 characters

Tenant size code. TENANT_SIZES dictionary.

softLimitTrn
integer <int32> >= 0

Soft limit for number of transactions.

hardLimitTrn
integer <int32> >= 0

Hard limit for number of transactions.

linkToStore
string

Link to Shopify store.

linkExpirationDate
string <date>

Expiration date of Shopify Connector installation link.

installationLink
string

Shopify Connector installation link.

customDomain
string

Shopify Connector custom domain.

lastModify
string <date-time>

Last modification date or null when object was never modified before.
Provides optimistic locking feature.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "status": "s",
  • "size": "st",
  • "softLimitTrn": 0,
  • "hardLimitTrn": 0,
  • "linkToStore": "string",
  • "linkExpirationDate": "2019-08-24",
  • "installationLink": "string",
  • "customDomain": "string",
  • "lastModify": "2019-08-24T14:15:22Z"
}

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

Pay with points

Get pay with points

Get pay with points configuration.

Authorizations:
user_client_scheme (any)
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.

X-CLM-DeviceID
string <= 200 characters

Requesting device fingerprint.
Identifies particular device calling the API.

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
{
  • "status": "s",
  • "monetaryValueForOnePoint": 0.01,
  • "pointsStepValue": 1,
  • "productCodes": "string",
  • "productCategoryCodes": "string",
  • "lastModify": "2019-08-24T14:15:22Z"
}