Echo Loyalty Member 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 Client Gateway REST API, the full URL for the POST /enrollment operation, which enrolls a member is: https://b2c-tenantId.echoloyalty.com/b2c/v3/enrollment. The base URL is: https://b2c-tenantId.echoloyalty.com/b2c/v3. This is constructed from these three elements: -Scheme: HTTPS -Host: b2c-tenantId.echoloyalty.com -Base path: /b2c/v3
Bearer access token (access token)	An access token that uses the standard and contains all the information the resource server needs to confirm the user’s grant to the application. It has the following three-part structure, with period separators: Header.Payload.Signature. The platform's OAuth Provider domain can issue Bearer access tokens. An advantage of the Bearer access token is that the Resource Server can validate by itself without having to go back to the Authorization Server.
Bearer token	Used in OAuth, the bearer token is a security token with the property that any party in possession of the token (the bearer) can use it. The bearer token is sent as-is in the API request, in the Authorization header. The platform's OAuth Provider domain supports Referenced Bearer (a simple bearer token) and bearer access token.
Coordinated Universal Time (UTC)	Coordinated Universal Time (UTC), also called Zulu time, is the primary time standard in general use. It essentially equates to Greenwich Mean Time (GMT), but is more scientifically precise. In the Echo Loyalty Business To Client Gateway REST API, time values are represented in the standard UTC date/time format YYYY-MM-DDTHH:MM:SSZ. Example: 2013-12-31T15:45:00-04:00Z.
Gateway	A Echo Loyalty Business To Client Gateway REST API streamlines signing up, signing in, management, operation of APIs, enhancing security and regulatory compliance through authentication and authorization. It provides central definition and management of security and other operational governance policies across multiple instances. The Gateway enables enterprises to standardize API and service delivery with high security, performance, and availability.
Header	API headers are like an extra source of information for each API call. Their job is to represent the meta-data associated with an API request and response. API headers tell user about request/response bodies, authorization, caching, cooking. Headers examples: Authorization, WWW-Authenticate, Accept-Charset, Content-Type, Cache-Control.
Path Paramter	Path is a type of parameter that lives within the endpoint URL. In a typical REST scheme, the path portion of the URL represents entity class hierarchy. Path parameters are surrounded with curly brackets and offer a unique opportunity for developers to control the representation of a specific resource. In this URL: (https://b2c-tenantId.echoloyalty.com/b2c/v3/rewards/{rewardCode}?pricePlanDate=2018-09-01), the {rewardCode} part represents the parameter that is required for the call. Unlike query string parameters where the order doesn’t matter, path parameters values must be given in correspondence with the format that is dictated by the URL path. While query parameters allow you to omit a value, path parameter values can’t be omitted since it would mean changing the URL path.
Query Paramter	API Query parameters can be defined as the optional key-value pairs that appear after the question mark in the URL. Basically, they are extensions of the URL that are utilized to help determine specific content or action based on the data being delivered. Query parameters are appended to the end of the URL, using a '?'. The question mark sign is used to separate path and query parameters. If you want to add multiple query parameters, an '&' sign is placed in between them to form what is known as a query string. In this URL: (https://b2c-tenantId.echoloyalty.com/b2c/v3/rewards/{rewardCode}?pricePlanDate=2018-09-01), there is one query parameter: pricePlanDate, with 2018-09-01 being its value.
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 poiniting specific identifier in database table. Each identifier is linked to particular member and has its own type.
identifierNo	'identifierNo' is a member identifier ID as 'identifierId' generated within CLC. Unlike 'identifierId', 'identifierNo' is made public and can be found in Customer Care Panel among others.
/me	/me is part of endpoint URL available on B2C facade. Using '/me' parameter you determine that endpoint you actually call is about you i.e. currently logged in user, whose identity has been verified. So you don't have to use any customer or identifier identification.

Authentication

customer_password_scheme

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

Security Scheme Type	OAuth2
password OAuth Flow	Token URL: https://$host$:$port$/b2c/$version$/login Refresh URL: https://$host$:$port$/b2c/$version$/refresh-token Scopes: `b2c_api_gateway` - Grants access to any secured operations `b2c_api_tac` - Grants access to terms and conditions related operations `b2c_api_pass_exp` - Grants access to /me/password-change operation

Authentication & Authorization

Both authentication and authorization are core to the security of APIs.
Authentication - refers to proving correct identity. 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 as a member, login, password and the valid token obtained during authentication are required. Here you can also manage token validity.

Acquire access token and login

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

header Parameters

Content-Type required	string Value: "application/x-www-form-urlencoded" Request content type as MIME type.
Accept	string Default: application/json Value: "application/json" Expected response content type as MIME type.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
X-CLM-DeviceID	string <= 200 characters Requesting device fingerprint. Identifies particular device calling the API.
X-CLM-OTP-Save-Authorized-Device	boolean Default: false Flag indicating if device of given fingerprint from X-CLM-DeviceID header should be added to trusted devices.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). UTC timezone is assumed. Time zone is ignored if incorrect value is provided.
X-Tenant-ID	string <= 100 characters Tenant identifier. When not provided to the request, the default identifier will be used.

Request Body schema: application/x-www-form-urlencoded

username required	string Customer login. Required for password grant_type, otherwise optional and ignored.
password required	string <password> Customer password. Required for password grant_type, otherwise optional and ignored.
scope	string Space separated list of scopes, which represent profiles granted within the token. Only provided scopes can be included in the returned access token. When parameter is not provided, all granted scopes will be returned in the access token.
channel	string Default: "O" Enum: "W" "O" Business channel invoking further operations. Optional, defaults to O. Applicable for password and client_credentials grant_type, otherwise ignored. Subset of TRANSACTION_CHANNELS dictionary: W - Website O - Mobile App

Responses

Response samples

200
400
401
403
409

Content type

application/json

{"access_token": "string",
"token_type": "bearer",
"expires_in": 0,
"scope": "string",
"jti": "string",
"refresh_token": "string"
}

Acquire access token and login via identity provider

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

header Parameters

Content-Type required	string Value: "application/x-www-form-urlencoded" Request content type as MIME type.
Accept	string Default: application/json Value: "application/json" Expected response content type as MIME type.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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

authorization_code required	string Member's access token, from the external identity provider member authenticates with.
protocol required	string Value: "OIDC_1_0" Protocol used in the authorization process. OIDC_1_0 - OpenID Connect 1.0
provider_code	string Identity provider configuration code. If not specified, default active configuration for certain protocol and profile domain will be used.
code_verifier	string The code verifier for the PKCE request, that the app originally generated before the authorization request.
channel	string Default: "W" Enum: "W" "O" Business channel invoking further operations. Optional, defaults to W. Subset of TRANSACTION_CHANNELS dictionary: W - Website O - Mobile App

Responses

Response samples

200
400
401
403

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.
X-CLM-OTP-Save-Authorized-Device	boolean Default: false Flag indicating if device of given fingerprint from X-CLM-DeviceID header should be added to trusted devices.
X-CLM-OTP-TOKEN	string <= 200 characters Value of token sent on email or sms. Necessary to pass multifactor authentication
Accept	string Default: application/json Value: "application/json" Expected response content type as MIME type.
Time-Zone	string <= 100 characters Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH). Time zone source hierarchy: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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

200
401
403

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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). UTC timezone is assumed. Time zone is ignored if incorrect value is provided.
X-Tenant-ID	string <= 100 characters Tenant identifier. When not provided to the request, the default identifier will be used.
X-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

401

Content type

application/json

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

Enrollment

With this method, you can enroll new members in the Loyalty program. You can make use of all pre-defined fields available in the System in your enrollment form. You are allowed to choose which field would be mandatory or optional. Moreover, you can create your own field - custom attribute and select his acceptance level. They will build the member's profile. Enrollment can be displayed in different languages, and API specifies the proposed language of the response. This part of the API will allow you to get the necessary consent types from your loyalty program members.

Enrollment

Enrolls new member with lists of predefined and custom attributes.

header Parameters

Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
X-CLM-DeviceID	string <= 200 characters Requesting device fingerprint. Identifies particular device calling the API.
X-CLM-OTP-Save-Authorized-Device	boolean Default: false Flag indicating if device of given fingerprint from X-CLM-DeviceID header should be added to trusted devices.
X-CLM-OTP-TOKEN	string <= 200 characters Value of token sent on email or sms. Necessary to pass multifactor authentication
Time-Zone	string <= 100 characters Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH). Time zone source hierarchy: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). UTC timezone is assumed. Time zone is ignored if incorrect value is provided.
X-Tenant-ID	string <= 100 characters Tenant identifier. When not provided to the request, the default identifier will be used.
X-CLM-Channel	string Default: O Enrollment channel code. TRANSACTION_CHANNELS dictionary. When not provided to the request, the default channel will be used.

Request Body schema: application/json

	Array of objects
	Array of objects
required	object (types.StaticAttributesEnrollment)
required	object (types.TaCMemberCreateUpdate)

Responses

Request samples

Payload

Content type

application/json

{"predefinedAttributes": [{"code": "string",
"value": "string"
}
],
"customAttributes": [{"code": "string",
"value": "string"
}
],
"staticAttributes": {"mobileId": "string",
"mobileSystem": "string",
"password": "pa$$word",
"oneTimePermission": true,
"preferredChannel": "string",
"ccmCampaignId": "string"
},
"termsAcceptance": {"gdpr": {"personalDataProcessing": {"memberConsent": true,
"acceptedVersion": 0
},
"personalDataProfiling": {"memberConsent": true,
"acceptedVersion": 0
}
},
"loyalty": {"termsAndConditions": {"memberConsent": true,
"acceptedVersion": 0
},
"communications": {"memberConsent": true,
"communicationChannels": [{"code": "string"
}
]
},
"thirdPartyCommunications": {"memberConsent": true,
"communicationChannels": [{"code": "string"
}
]
},
"marketingCommunications": {"memberConsent": true,
"communicationChannels": [{"code": "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": [{"error": "CONSTRAINT_NOT_EMPTY",
"message": "Empty value not allowed",
"path": "arg1.address.street"
}
]
}

Enrollment via identity provider

Enrolls new member via identity provider, allowing future logins via a identity provider.

query Parameters

protocol required	string Value: "OIDC_1_0" Protocol used in the authorization process. OIDC_1_0 - OpenID Connect 1.0
authorization_code required	string Member's access token, from the external identity provider member authenticates with.
provider_code	string Identity provider configuration code. If not specified, default active configuration for certain protocol and profile domain will be used.
code_verifier	string The code verifier for the PKCE request, that the app originally generated before the authorization request.

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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). UTC timezone is assumed. Time zone is ignored if incorrect value is provided.
X-Tenant-ID	string <= 100 characters Tenant identifier. When not provided to the request, the default identifier will be used.
X-Tenant-ID	string <= 100 characters Tenant identifier. When not provided to the request, the default identifier will be used.

Request Body schema: application/json

required	object
required	object Address details
required	object (types.TaCMemberCreateUpdate)
identifierType	string Code of identifier type which will generate member main identifier. IDENTIFIER_TYPES dictionary. If not given, member identifier is generated from default identifier type or, if there is no default identifier type, error occurs.
identifierNo	string <= 30 characters Identifier number to assign to the new customer. When provided this identifier will be assigned to the new customer. It may exist, e.g. as ghost idenfier, or may be generated and assigned.
mobileId	string <= 250 characters Mobile device fingerprint. Identifies customer's mobile device. Push notifications are sent to this device.
mobileSystem	string Mobile system code. MOBILE_SYSTEMS dictionary.
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"profileData": {"language": "string",
"salutation": "string",
"gender": "s",
"firstName": "string",
"lastName": "string",
"birthDate": "2019-08-24"
},
"address": {"street": "string",
"houseNumber": "string",
"apartmentNumber": "string",
"postalCode": "string",
"city": "string",
"region": "string",
"country": "str",
"email": "string",
"phoneCountryPrefix": "stri",
"mobilePhone": "string",
"additionalInfo": "string"
},
"termsAcceptance": {"gdpr": {"personalDataProcessing": {"memberConsent": true,
"acceptedVersion": 0
},
"personalDataProfiling": {"memberConsent": true,
"acceptedVersion": 0
}
},
"loyalty": {"termsAndConditions": {"memberConsent": true,
"acceptedVersion": 0
},
"communications": {"memberConsent": true,
"communicationChannels": [{"code": "string"
}
]
},
"thirdPartyCommunications": {"memberConsent": true,
"communicationChannels": [{"code": "string"
}
]
},
"marketingCommunications": {"memberConsent": true,
"communicationChannels": [{"code": "string"
}
]
}
}
},
"identifierType": "string",
"identifierNo": "string",
"mobileId": "string",
"mobileSystem": "string",
"customerAttributes": [{"code": "string",
"value": "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": [{"error": "CONSTRAINT_NOT_EMPTY",
"message": "Empty value not allowed",
"path": "arg1.address.street"
}
]
}

Member Profile

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

Verify member credentials

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

Authorizations:

customer_password_scheme (b2c_api_gateway)

header Parameters

Content-Type	string Request content type as MIME type. By default application/json, unless operation's request specification says otherwise.
Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
Authorization	string Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation. Bearer token where token is authorization key granted to the client.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). UTC timezone is assumed. Time zone is ignored if incorrect value is provided.
X-Tenant-ID	string <= 100 characters Tenant identifier. When not provided to the request, the default identifier will be used.

Request Body schema: application/json

password

required

string <password>

Member's password

Responses

Request samples

Payload

Content type

application/json

{"password": "pa$$word"
}

Response samples

Content type

application/json

{"error": "VALIDATION_ERROR",
"message": "Validation error: Constraint violations",
"method": "PUT",
"path": "/profile/customers/12345",
"correlationId": "1505219765216595",
"status": 400,
"timestamp": "2017-09-12T12:36:05.217Z",
"violations": [{"error": "CONSTRAINT_NOT_EMPTY",
"message": "Empty value not allowed",
"path": "arg1.address.street"
}
]
}

Get member profile

Authorizations:

customer_password_scheme (b2c_api_gateway)

header Parameters

Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
Authorization	string Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation. Bearer token where token is authorization key granted to the client.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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": [{"code": "string",
"value": "string",
"valueName": "string"
}
],
"customAttributes": [{"code": "string",
"value": "string"
}
],
"staticAttributes": {"customerId": 0,
"accountId": 0,
"balance": 0,
"mobileId": "string",
"mobileSystem": "string",
"avatarImageId": "string",
"loginBlocked": true,
"lastModify": "2019-08-24T14:15:22Z"
},
"termsAcceptance": {"gdpr": {"personalDataProcessing": {"description": "string",
"acceptanceLevel": "string",
"currentVersion": 0,
"acceptanceDeadline": "2019-08-24T14:15:22Z",
"label": "string",
"acceptedVersion": 0,
"memberConsent": true,
"currentVersionContent": {"contentFormat": "PDF",
"content": "string",
"contentFile": "string"
},
"acceptanceDate": "2019-08-24"
},
"personalDataProfiling": {"description": "string",
"acceptanceLevel": "string",
"currentVersion": 0,
"acceptanceDeadline": "2019-08-24T14:15:22Z",
"label": "string",
"acceptedVersion": 0,
"memberConsent": true,
"currentVersionContent": {"contentFormat": "PDF",
"content": "string",
"contentFile": "string"
},
"acceptanceDate": "2019-08-24"
}
},
"loyalty": {"termsAndConditions": {"description": "string",
"acceptanceLevel": "string",
"currentVersion": 0,
"acceptanceDeadline": "2019-08-24T14:15:22Z",
"label": "string",
"acceptedVersion": 0,
"memberConsent": true,
"currentVersionContent": {"contentFormat": "PDF",
"content": "string",
"contentFile": "string"
},
"acceptanceDate": "2019-08-24"
},
"communications": {"description": "string",
"acceptanceLevel": "string",
"label": "string",
"memberConsent": true,
"communicationChannels": [{"acceptanceDate": "2019-08-24",
"code": "string",
"name": "string"
}
]
},
"thirdPartyCommunications": {"description": "string",
"acceptanceLevel": "string",
"label": "string",
"memberConsent": true,
"communicationChannels": [{"acceptanceDate": "2019-08-24",
"code": "string",
"name": "string"
}
]
},
"marketingCommunications": {"description": "string",
"acceptanceLevel": "string",
"label": "string",
"memberConsent": true,
"communicationChannels": [{"acceptanceDate": "2019-08-24",
"code": "string",
"name": "string"
}
]
}
}
}
}

Update member profile

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

Authorizations:

customer_password_scheme (b2c_api_gateway)

header Parameters

Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
Authorization	string Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation. Bearer token where token is authorization key granted to the client.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
X-CLM-DeviceID	string <= 200 characters Requesting device fingerprint. Identifies particular device calling the API.
X-CLM-OTP-Save-Authorized-Device	boolean Default: false Flag indicating if device of given fingerprint from X-CLM-DeviceID header should be added to trusted devices.
X-CLM-OTP-TOKEN	string <= 200 characters Value of token sent on email or sms. Necessary to pass multifactor authentication
Time-Zone	string <= 100 characters Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH). Time zone source hierarchy: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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

Payload

Content type

application/json

{"predefinedAttributes": [{"code": "string",
"value": "string"
}
],
"customAttributes": [{"code": "string",
"value": "string"
}
],
"staticAttributes": {"mobileId": "string",
"mobileSystem": "string",
"avatarImageId": "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": [{"error": "CONSTRAINT_NOT_EMPTY",
"message": "Empty value not allowed",
"path": "arg1.address.street"
}
]
}

Modify member profile

Modify member profile.
Not provided data are not overwritten in the data storage.

Authorizations:

customer_password_scheme (b2c_api_gateway)

header Parameters

Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
Authorization	string Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation. Bearer token where token is authorization key granted to the client.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
X-CLM-DeviceID	string <= 200 characters Requesting device fingerprint. Identifies particular device calling the API.
X-CLM-OTP-Save-Authorized-Device	boolean Default: false Flag indicating if device of given fingerprint from X-CLM-DeviceID header should be added to trusted devices.
X-CLM-OTP-TOKEN	string <= 200 characters Value of token sent on email or sms. Necessary to pass multifactor authentication
Time-Zone	string <= 100 characters Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH). Time zone source hierarchy: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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

Payload

Content type

application/json

{"predefinedAttributes": [{"code": "string",
"value": "string"
}
],
"customAttributes": [{"code": "string",
"value": "string"
}
],
"staticAttributes": {"mobileId": "string",
"mobileSystem": "string",
"avatarImageId": "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": [{"error": "CONSTRAINT_NOT_EMPTY",
"message": "Empty value not allowed",
"path": "arg1.address.street"
}
]
}

Upload avatar file

Upload member avatar file into the system storage.

Authorizations:

customer_password_scheme (b2c_api_gateway)

header Parameters

Content-Type	string Default: multipart/form-data Value: "multipart/form-data" Content type as MIME type.
Authorization	string Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation. Bearer token where token is authorization key granted to the client.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). UTC timezone is assumed. Time zone is ignored if incorrect value is provided.
X-Tenant-ID	string <= 100 characters Tenant identifier. When not provided to the request, the default identifier will be used.

Request Body schema: multipart/form-data

file

required

string <binary>

File contents

Responses

Response samples

Content type

application/json

{"error": "VALIDATION_ERROR",
"message": "Validation error: Constraint violations",
"method": "PUT",
"path": "/profile/customers/12345",
"correlationId": "1505219765216595",
"status": 400,
"timestamp": "2017-09-12T12:36:05.217Z",
"violations": [{"error": "CONSTRAINT_NOT_EMPTY",
"message": "Empty value not allowed",
"path": "arg1.address.street"
}
]
}

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:

customer_password_scheme (b2c_api_gateway)

header Parameters

Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
Authorization	string Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation. Bearer token where token is authorization key granted to the client.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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": [{"code": "string",
"name": "string",
"type": "string"
}
]
}

Modify customer custom attributes

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

Authorizations:

customer_password_scheme (b2c_api_gateway)

header Parameters

Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
Authorization	string Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation. Bearer token where token is authorization key granted to the client.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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

Payload

Content type

application/json

{"customerAttributes": [{"code": "string",
"value": "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": [{"error": "CONSTRAINT_NOT_EMPTY",
"message": "Empty value not allowed",
"path": "arg1.address.street"
}
]
}

Change password

Authorizations:

customer_password_scheme (b2c_api_gatewayb2c_api_pass_exp)

header Parameters

Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
Authorization	string Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation. Bearer token where token is authorization key granted to the client.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
X-CLM-DeviceID	string <= 200 characters Requesting device fingerprint. Identifies particular device calling the API.
X-CLM-OTP-Save-Authorized-Device	boolean Default: false Flag indicating if device of given fingerprint from X-CLM-DeviceID header should be added to trusted devices.
X-CLM-OTP-TOKEN	string <= 200 characters Value of token sent on email or sms. Necessary to pass multifactor authentication
Time-Zone	string <= 100 characters Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH). Time zone source hierarchy: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). UTC timezone is assumed. Time zone is ignored if incorrect value is provided.
X-Tenant-ID	string <= 100 characters Tenant identifier. When not provided to the request, the default identifier will be used.

Request Body schema: application/json

oldPassword required	string <password> Customer's old password
newPassword required	string <password> Customer's new password
confirmPassword required	string <password> New password repeated

Responses

Request samples

Payload

Content type

application/json

{"oldPassword": "pa$$word",
"newPassword": "pa$$word",
"confirmPassword": "pa$$word"
}

Response samples

Content type

application/json

{"error": "VALIDATION_ERROR",
"message": "Validation error: Constraint violations",
"method": "PUT",
"path": "/profile/customers/12345",
"correlationId": "1505219765216595",
"status": 400,
"timestamp": "2017-09-12T12:36:05.217Z",
"violations": [{"error": "CONSTRAINT_NOT_EMPTY",
"message": "Empty value not allowed",
"path": "arg1.address.street"
}
]
}

Close customer

Close member account on own request. Operation is irrevertible.

Authorizations:

customer_password_scheme (b2c_api_gateway)

header Parameters

Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
Authorization	string Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation. Bearer token where token is authorization key granted to the client.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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

400
500

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": [{"error": "CONSTRAINT_NOT_EMPTY",
"message": "Empty value not allowed",
"path": "arg1.address.street"
}
]
}

Get T&C Policy details

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

Authorizations:

customer_password_scheme (b2c_api_gatewayb2c_api_tac)

header Parameters

Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
Authorization	string Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation. Bearer token where token is authorization key granted to the client.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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": {"personalDataProcessing": {"description": "string",
"acceptanceLevel": "string",
"currentVersion": 0,
"acceptanceDeadline": "2019-08-24T14:15:22Z",
"label": "string",
"acceptedVersion": 0,
"memberConsent": true,
"currentVersionContent": {"contentFormat": "PDF",
"content": "string",
"contentFile": "string"
},
"acceptanceDate": "2019-08-24"
},
"personalDataProfiling": {"description": "string",
"acceptanceLevel": "string",
"currentVersion": 0,
"acceptanceDeadline": "2019-08-24T14:15:22Z",
"label": "string",
"acceptedVersion": 0,
"memberConsent": true,
"currentVersionContent": {"contentFormat": "PDF",
"content": "string",
"contentFile": "string"
},
"acceptanceDate": "2019-08-24"
}
},
"loyalty": {"termsAndConditions": {"description": "string",
"acceptanceLevel": "string",
"currentVersion": 0,
"acceptanceDeadline": "2019-08-24T14:15:22Z",
"label": "string",
"acceptedVersion": 0,
"memberConsent": true,
"currentVersionContent": {"contentFormat": "PDF",
"content": "string",
"contentFile": "string"
},
"acceptanceDate": "2019-08-24"
},
"communications": {"description": "string",
"acceptanceLevel": "string",
"label": "string",
"memberConsent": true,
"communicationChannels": [{"acceptanceDate": "2019-08-24",
"code": "string",
"name": "string"
}
]
},
"thirdPartyCommunications": {"description": "string",
"acceptanceLevel": "string",
"label": "string",
"memberConsent": true,
"communicationChannels": [{"acceptanceDate": "2019-08-24",
"code": "string",
"name": "string"
}
]
},
"marketingCommunications": {"description": "string",
"acceptanceLevel": "string",
"label": "string",
"memberConsent": true,
"communicationChannels": [{"acceptanceDate": "2019-08-24",
"code": "string",
"name": "string"
}
]
}
}
}

Accept T&C Policy

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

Authorizations:

customer_password_scheme (b2c_api_gatewayb2c_api_tac)

header Parameters

Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
Authorization	string Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation. Bearer token where token is authorization key granted to the client.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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

Payload

Content type

application/json

{"gdpr": {"personalDataProcessing": {"memberConsent": true,
"acceptedVersion": 0
},
"personalDataProfiling": {"memberConsent": true,
"acceptedVersion": 0
}
},
"loyalty": {"termsAndConditions": {"memberConsent": true,
"acceptedVersion": 0
},
"communications": {"memberConsent": true,
"communicationChannels": [{"code": "string"
}
]
},
"thirdPartyCommunications": {"memberConsent": true,
"communicationChannels": [{"code": "string"
}
]
},
"marketingCommunications": {"memberConsent": true,
"communicationChannels": [{"code": "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": [{"error": "CONSTRAINT_NOT_EMPTY",
"message": "Empty value not allowed",
"path": "arg1.address.street"
}
]
}

Update T&C Policy

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

Authorizations:

customer_password_scheme (b2c_api_gatewayb2c_api_tac)

header Parameters

Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
Authorization	string Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation. Bearer token where token is authorization key granted to the client.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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

Payload

Content type

application/json

{"gdpr": {"personalDataProcessing": {"memberConsent": true,
"acceptedVersion": 0
},
"personalDataProfiling": {"memberConsent": true,
"acceptedVersion": 0
}
},
"loyalty": {"termsAndConditions": {"memberConsent": true,
"acceptedVersion": 0
},
"communications": {"memberConsent": true,
"communicationChannels": [{"code": "string"
}
]
},
"thirdPartyCommunications": {"memberConsent": true,
"communicationChannels": [{"code": "string"
}
]
},
"marketingCommunications": {"memberConsent": true,
"communicationChannels": [{"code": "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": [{"error": "CONSTRAINT_NOT_EMPTY",
"message": "Empty value not allowed",
"path": "arg1.address.street"
}
]
}

Get points expiration forecast

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

Authorizations:

customer_password_scheme (b2c_api_gateway)

query Parameters

pointType	string Point type code. POINT_TYPES dictionary.
expirationDateFrom	string <date> Points expiration date - lower limit. Inclusive.
expirationDateTo	string <date> Points expiration date - upper limit. Inclusive.
sort	string Default: "id:ASC" Defines the sort order of the resulting list of objects. Available sort orders: ASCENDING, ASC, ascending, asc, 1, DESCENDING, DESC, descending, desc, -1. If operation description does not state otherwise, default order field is 'id' and the default order is ascending. If operation description does not state otherwise, all attributes of the response array items may be included as sort criteria. Constructed as comma separated list of sort fields, with optional order marker after colon. Examples: sort=firstName:ASC,lastName:DESC,address.street - result is ordered by first name ascending, last name descending and street part of the address ascending sort=firstName,lastName:DESC - result is ordered by first name ascending and last name descending sort=firstName,lastName - result is ordered by first name ascending and last name ascending sort=:DESC - result is ordered descending by the default field (id)
firstResult	integer <int32> Default: 0 First item in array points. Indexed from 0. Only non-negative values.
maxResults	integer <int32> Max count of items on the page. Default value is from the PROCESSING_DEFAULT_MAX_RESULTS system parameter. Only non-negative values.

header Parameters

Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
Authorization	string Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation. Bearer token where token is authorization key granted to the client.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). UTC timezone is assumed. Time zone is ignored if incorrect value is provided.
X-Tenant-ID	string <= 100 characters Tenant identifier. When not provided to the request, the default identifier will be used.

Responses

Response samples

Content type

application/json

{"expirationPrevention": {"enabled": true,
"source": "string",
"endDate": "2019-08-24"
},
"points": [{"amount": 0,
"forecastedExpirationDate": "2019-08-24",
"pointType": "string",
"pointTypeName": "string"
}
]
}

Get MFA preferred channel

Get MFA preferred channel.

Authorizations:

customer_password_scheme (b2c_api_gateway)

header Parameters

Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
Authorization	string Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation. Bearer token where token is authorization key granted to the client.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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

{"preferredChannel": "E"
}

Update MFA preferred channel

Update MFA preferred Channel.

Authorizations:

customer_password_scheme (b2c_api_gateway)

header Parameters

Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
Authorization	string Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation. Bearer token where token is authorization key granted to the client.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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

preferredChannel

string

Enum: "E" "M"

Responses

Request samples

Payload

Content type

application/json

{"preferredChannel": "E"
}

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": [{"error": "CONSTRAINT_NOT_EMPTY",
"message": "Empty value not allowed",
"path": "arg1.address.street"
}
]
}

Validate and fetch customer data from CCM

Validate and fetch customer data from Communication Panel.
Error response that customer already exists in CLC will only be returned when B2C_API_RESPONSE_SECURITY_LEVEL parameter is false.

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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). UTC timezone is assumed. Time zone is ignored if incorrect value is provided.
X-Tenant-ID	string <= 100 characters Tenant identifier. When not provided to the request, the default identifier will be used.

Request Body schema: application/json

token

required

string

Token with encrypted information about campaignId and prospectId retrieved from CCM in following format "campaignId|prospectId"

Responses

Request samples

Payload

Content type

application/json

{"token": "string"
}

Response samples

Content type

application/json

{"email": "string",
"mobilePhone": "string",
"phoneCountryPrefix": "string",
"ccmProspectId": "string",
"ccmCampaignId": "string",
"langCode": "string"
}

Balance and Statements

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

Get member transactions

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

Authorizations:

customer_password_scheme (b2c_api_gateway)

query Parameters

id	integer Unique transaction identifier
identifierNo	string Loyalty identifier which identifies the customer on which operation will be processed. Causes transactions search on the identifier level (transactions performed with the identifier).
type	Array of strings Transactions types codes. TRANSACTION_TYPES dictionary.
status	Array of strings Transactions statuses codes. TRANSACTION_STATUSES dictionary.
channel	Array of strings Transactions channels codes. TRANSACTION_CHANNELS dictionary.
partner	string Code of the partner that participated in the transactions. PARTNERS dictionary.
location	string Code of the location in which the transactions where processed. LOCATIONS dictionary. Location codes are unique in the scope of the partner.
trnNo	string Identifier of the transaction in the partners' external systems.
dateFrom	string <date> Transaction date lower boundary. Inclusive.
dateTo	string <date> Transaction date upper boundary. Inclusive.
attributes	string Allows search only by static attributes. Search is exact (=). When search by multiple attributes is performed they are joined with AND operator. Examples: attributes=ATTR_A:1;ATTR_B:2 - searches for all transactions with ATTR_A=1 and ATTR_B=2 attributes=ATTR_A:1;ATTR_C;ATTR_B:2 - searches for all transactions with ATTR_A=1 and ATTR_B=2 and ATTR_C is empty DateTime and Date attributes must be sent with a time zones: Datetime examples: 2020-08-07T11:00:00Z02:00 for GMT+02:00 2020-08-07T11:00:00Z-02:00 for GMT-02:00 Date examples: 2020-08-07Z02:00 for GMT+02:00 2020-08-07Z-02:00 for GMT-02:00
with	Array of strings Items Enum: "attributes" "products" "triggeredRules" Appends to every response item additional content that is not appended by default to boost lists performance. Note: Requesting more item data in the responses which are lists may impact performance. Supports [attributes, products, triggeredRules].
sort	string Default: "date:DESC" Defines the sort order of the resulting list of objects. Available sort orders: ASCENDING, ASC, ascending, asc, 1, DESCENDING, DESC, descending, desc, -1. If operation description does not state otherwise, default order field is 'id' and the default order is ascending. If operation description does not state otherwise, all attributes of the response array items may be included as sort criteria. Constructed as comma separated list of sort fields, with optional order marker after colon. Examples: sort=firstName:ASC,lastName:DESC,address.street - result is ordered by first name ascending, last name descending and street part of the address ascending sort=firstName,lastName:DESC - result is ordered by first name ascending and last name descending sort=firstName,lastName - result is ordered by first name ascending and last name ascending sort=:DESC - result is ordered descending by the default field (id)
firstResult	integer <int32> Default: 0 First item on the page. Indexed from 0. Only non-negative values.
maxResults	integer <int32> Max count of items on the page. Default value is from the PROCESSING_DEFAULT_MAX_RESULTS system parameter. Only non-negative values.

header Parameters

Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
Authorization	string Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation. Bearer token where token is authorization key granted to the client.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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": [{"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",
"products": [{"code": "string",
"name": "string",
"domain": "P",
"quantity": 0,
"value": 0,
"discountedValue": 0,
"discountValue": 0,
"basicPoints": 0,
"points": [{"pointType": "string",
"pointTypeName": "string",
"points": 0
}
]
}
],
"triggeredRules": [{"code": "string",
"name": "string",
"points": [{"pointType": "string",
"pointTypeName": "string",
"points": 0
}
],
"discount": 0
}
],
"points": [{"pointType": "string",
"pointTypeName": "string",
"points": 0
}
],
"attributes": [{"code": "string",
"value": "string"
}
]
}
]
}

Get member transaction

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

Authorizations:

customer_password_scheme (b2c_api_gateway)

path Parameters

transactionId

required

integer

Transaction internal unique identifier

header Parameters

Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
Authorization	string Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation. Bearer token where token is authorization key granted to the client.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). UTC timezone is assumed. Time zone is ignored if incorrect value is provided.
X-Tenant-ID	string <= 100 characters Tenant identifier. When not provided to the request, the default identifier will be used.

Responses

Response samples

Content type

application/json

{"transactionId": 0,
"customerLogin": "string",
"identifierId": 0,
"identifierNo": "string",
"date": "2019-08-24T14:15:22Z",
"type": "st",
"typeName": "string",
"status": "s",
"statusName": "string",
"channel": "s",
"channelName": "string",
"partner": "string",
"partnerName": "string",
"location": "string",
"locationName": "string",
"trnNo": "string",
"basicPoints": 0,
"basicPointsTypeName": "string",
"delayedBasicPoints": 0,
"points": [{"pointType": "string",
"pointTypeName": "string",
"points": 0,
"status": "s",
"statusName": "string",
"expirationDate": "2019-08-24"
}
],
"delayedPoints": [{"pointType": "string",
"pointTypeName": "string",
"points": 0,
"status": "s",
"statusName": "string",
"expirationDate": "2019-08-24"
}
],
"incentiveValue": 0,
"discountValue": 0,
"totalValue": 0,
"paymentValue": 0,
"currencyCode": "str",
"shared": true,
"correctionReasonCode": "string",
"processDate": "2019-08-24T14:15:22Z",
"confirmationDate": "2019-08-24T14:15:22Z",
"comment": "string",
"triggeredRules": [{"code": "string",
"name": "string",
"points": [{"pointType": "string",
"pointTypeName": "string",
"points": 0
}
],
"discount": 0
}
],
"issuedCoupons": [{"couponNumber": "string",
"couponTypeCode": "string",
"couponTypeName": "string",
"externalName": "string",
"externalDescription": "string",
"marketingText": "string",
"useQuantity": 0,
"validityPeriod": {"validityStartDate": "2019-08-24",
"expiryDate": "2019-08-24"
},
"fixedValueDiscount": 0.01,
"percent": 1,
"applicationRule": "U",
"visualModes": ["BC"
]
}
],
"burnedCoupons": [{"couponNumber": "string",
"couponTypeCode": "string",
"couponTypeName": "string",
"externalName": "string",
"externalDescription": "string",
"marketingText": "string",
"useQuantity": 0,
"validityPeriod": {"validityStartDate": "2019-08-24",
"expiryDate": "2019-08-24"
},
"fixedValueDiscount": 0.01,
"percent": 1,
"applicationRule": "U",
"useDetails": {"useResult": "s",
"useResultName": "string",
"status": "s",
"statusName": "string",
"burnQuantity": 0,
"refundQuantity": 0
}
}
],
"refundedCoupons": [{"couponNumber": "string",
"couponTypeCode": "string",
"couponTypeName": "string",
"externalName": "string",
"externalDescription": "string",
"marketingText": "string",
"useQuantity": 0,
"validityPeriod": {"validityStartDate": "2019-08-24",
"expiryDate": "2019-08-24"
},
"fixedValueDiscount": 0.01,
"percent": 1,
"applicationRule": "U",
"visualModes": ["BC"
],
"useDetails": {"status": "s",
"statusName": "string",
"burnQuantity": 0,
"refundQuantity": 0
}
}
],
"products": [{"code": "string",
"name": "string",
"domain": "P",
"quantity": 0,
"value": 0,
"discountedValue": 0,
"discountValue": 0,
"basicPoints": 0,
"points": [{"pointType": "string",
"pointTypeName": "string",
"points": 0
}
]
}
],
"attributes": [{"code": "string",
"value": "string",
"name": "string",
"description": "string"
}
]
}

Get member coupons

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

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

Authorizations:

customer_password_scheme (b2c_api_gateway)

query Parameters

filter	string >= 3 characters Full text search query. Matches [couponTypeCode, couponNumber].
couponTypeCode	Array of strings Coupon type codes list. CLOUD_COUPON_TYPES dictionary.
couponNumber	Array of strings Coupon numbers list
deliveryChannelCode	Array of strings Coupon delivery channels codes list. COUPON_DELIVERY_CHANNELS dictionary. When empty, coupons for all delivery channels are returned.
expiryDateFrom	string <date> Coupon expiration date - lower limit. Inclusive.
expiryDateTo	string <date> Coupon expiration date - upper limit. Inclusive.
sort	string Default: "issuanceDate:DESC, expiryDate:ASC" Defines the sort order of the resulting list of objects. Available sort orders: ASCENDING, ASC, ascending, asc, 1, DESCENDING, DESC, descending, desc, -1. If operation description does not state otherwise, default order field is 'id' and the default order is ascending. If operation description does not state otherwise, all attributes of the response array items may be included as sort criteria. Constructed as comma separated list of sort fields, with optional order marker after colon. Examples: sort=firstName:ASC,lastName:DESC,address.street - result is ordered by first name ascending, last name descending and street part of the address ascending sort=firstName,lastName:DESC - result is ordered by first name ascending and last name descending sort=firstName,lastName - result is ordered by first name ascending and last name ascending sort=:DESC - result is ordered descending by the default field (id)
firstResult	integer <int32> Default: 0 First item on the page. Indexed from 0. Only non-negative values.
maxResults	integer <int32> Max count of items on the page. Default value is from the PROCESSING_DEFAULT_MAX_RESULTS system parameter. Only non-negative values.

header Parameters

Content-Type	string Request content type as MIME type. By default application/json, unless operation's request specification says otherwise.
Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
Authorization	string Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation. Bearer token where token is authorization key granted to the client.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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": [{"id": 0,
"customerId": 0,
"customerLogin": "string",
"couponTypeCode": "string",
"couponTypeName": "string",
"externalName": "string",
"deliveryChannels": {"pos": {"marketingText": "string"
},
"email": {"marketingText": "string"
},
"sms": {"marketingText": "string"
},
"webapp": {"marketingText": "string"
},
"mobileapp": {"marketingText": "string"
}
},
"couponTypeLargeImageId": "string",
"couponTypeSmallImageId": "string",
"tags": ["string"
],
"couponNumber": "string",
"visualModes": ["BC"
],
"issuanceDate": "2019-08-24T14:15:22Z",
"validityStartDate": "2019-08-24",
"expiryDate": "2019-08-24",
"status": "s",
"statusName": "string",
"useQuantity": 0,
"burnQuantity": 0,
"refundQuantity": 0,
"distributionMode": "string",
"distributionModeName": "string",
"issuedByPromotion": 0,
"issuedByPromotionCode": "string",
"issuedByTransaction": 0,
"discount": 0.01,
"discountPercentage": 0,
"interactive": true
}
]
}

Get member balances

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

Authorizations:

customer_password_scheme (b2c_api_gateway)

header Parameters

Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
Authorization	string Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation. Bearer token where token is authorization key granted to the client.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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": {"customerLogin": "string",
"points": [{"pointType": "string",
"pointTypeName": "string",
"points": 0,
"balanceUpdateDate": "2019-08-24T14:15:22Z",
"mainBalance": true,
"pointsWithDelayed": 0,
"delayedPoints": [{"points": 0,
"bookDate": "2019-08-24T14:15:22Z"
}
]
}
]
}
}

Get member main balance

Get member's basic points balance.

Authorizations:

customer_password_scheme (b2c_api_gateway)

header Parameters

Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
Authorization	string Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation. Bearer token where token is authorization key granted to the client.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). UTC timezone is assumed. Time zone is ignored if incorrect value is provided.
X-Tenant-ID	string <= 100 characters Tenant identifier. When not provided to the request, the default identifier will be used.

Responses

Response samples

Content type

application/json

{"points": 0
}

Recognition

Some loyalty programs use tiers to recognize their most valuable members. If your program uses them, you will find all needed details such as tiers schema and levels with descriptions, benefits, and perks members can get. You can also present the progress tracker for the tier a member reaches to build more engagement and show the progress on the member's profile.

Get member current recognition

Get member's current recognition tier.

Authorizations:

customer_password_scheme (b2c_api_gateway)

header Parameters

Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
Authorization	string Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation. Bearer token where token is authorization key granted to the client.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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",
"isCurrentTierTheHighest": true
}

Get member progress tracker

Get member's progress tracker for next recognition tier.

Authorizations:

customer_password_scheme (b2c_api_gateway)

header Parameters

Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
Authorization	string Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation. Bearer token where token is authorization key granted to the client.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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": {"code": "string",
"externalName": "string",
"effectiveDate": "2019-08-24",
"expirationDate": "2019-08-24",
"isCurrentTierTheHighest": true
},
"nextTier": {"code": "string",
"externalName": "string",
"upgradeConditions": {"operator": "string",
"operatorName": "string",
"expressions": [{"operator": "string",
"operatorName": "string",
"expressions": [{"conditionData": {"condition": {"conditionType": "string",
"conditionTypeName": "string",
"upgradeConditionThreshold": 0
},
"counterValue": 0
}
}
]
}
]
}
},
"progressTrackerTypeIndicator": "string"
}

Get schemas

Get recognition schemas

Authorizations:

customer_password_scheme (b2c_api_gateway)

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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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": [{"code": "string",
"name": "string",
"status": "string",
"activationDate": "2019-08-24",
"tiers": [{"code": "string",
"externalName": "string",
"externalDescription": "string",
"imageId": "string",
"priority": 0
}
],
"progressTrackerEnabled": true,
"lastModify": "2019-08-24T14:15:22Z"
}
]
}

Get tier details

Get recognition tier details.

Authorizations:

customer_password_scheme (b2c_api_gateway)

header Parameters

Content-Type	string Request content type as MIME type. By default application/json, unless operation's request specification says otherwise.
Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
Authorization	string Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation. Bearer token where token is authorization key granted to the client.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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": [{"code": "string",
"externalName": "string",
"externalDescription": "string",
"images": ["string"
]
}
]
}

Get benefit details

Get benefit details.

Authorizations:

customer_password_scheme (b2c_api_gateway)

header Parameters

Content-Type	string Request content type as MIME type. By default application/json, unless operation's request specification says otherwise.
Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
Authorization	string Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation. Bearer token where token is authorization key granted to the client.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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": ["string"
]
}

Identifiers

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

Get member identifiers

Get list of all identifiers belonging to the member

Authorizations:

customer_password_scheme (b2c_api_gateway)

header Parameters

Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
Authorization	string Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation. Bearer token where token is authorization key granted to the client.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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": [{"identifierNo": "string",
"identifierTypeCode": "string",
"identifierTypeName": "string",
"visualMode": "string",
"status": "s",
"statusName": "string",
"main": true
}
]
}

Get member identifier

Get details of the member's identifier

Authorizations:

customer_password_scheme (b2c_api_gateway)

path Parameters

identifierNo

required

string

Unique loyalty card identifier number

query Parameters

fields

string

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

header Parameters

Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
Authorization	string Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation. Bearer token where token is authorization key granted to the client.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). UTC timezone is assumed. Time zone is ignored if incorrect value is provided.
X-Tenant-ID	string <= 100 characters Tenant identifier. When not provided to the request, the default identifier will be used.

Responses

Response samples

Content type

application/json

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

Rewards & Coupons

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

Redeem points to get a reward

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

Authorizations:

customer_password_scheme (b2c_api_gateway)

query Parameters

simulate

boolean

Default: false

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

header Parameters

Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
Authorization	string Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation. Bearer token where token is authorization key granted to the client.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
X-CLM-DeviceID	string <= 200 characters Requesting device fingerprint. Identifies particular device calling the API.
X-CLM-OTP-Save-Authorized-Device	boolean Default: false Flag indicating if device of given fingerprint from X-CLM-DeviceID header should be added to trusted devices.
X-CLM-OTP-TOKEN	string <= 200 characters Value of token sent on email or sms. Necessary to pass multifactor authentication
Time-Zone	string <= 100 characters Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH). Time zone source hierarchy: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). UTC timezone is assumed. Time zone is ignored if incorrect value is provided.
X-Tenant-ID	string <= 100 characters Tenant identifier. When not provided to the request, the default identifier will be used.

Request Body schema: application/json

trnNo	string <= 100 characters Partner transaction number
comment	string <= 400 characters Transaction comment
required	Array of objects (types.OrderItem) List of rewards in basket
deliveryMethod	string Delivery method code. REWARD_DELIVERY_METHODS dictionary. Required for rewards that are not Online.
	object Delivery location details. Required for deliveryMethod = L (Location).
	object Delivery address details. Required for deliveryMethod = H (Home).

Responses

Request samples

Payload

Content type

application/json

{"trnNo": "string",
"comment": "string",
"rewards": [{"pricePlanCode": "string",
"quantity": 1
}
],
"deliveryMethod": "string",
"deliveryLocation": {"partnerCode": "string",
"locationCode": "string"
},
"deliveryAddress": {"name": "string",
"street": "string",
"houseNumber": "string",
"apartmentNumber": "string",
"postalCode": "string",
"city": "string",
"region": "string",
"country": "str",
"email": "string",
"mobile": "string",
"phoneCountryPrefix": "string",
"additionalInfo": "string"
}
}

Response samples

Content type

application/json

{"transactionId": 0,
"status": "s",
"statusName": "string",
"orderId": 0,
"transactionPoints": {"basicPoints": 0,
"points": [{"pointType": "string",
"pointTypeName": "string",
"points": 0,
"pointsPromotions": [{"code": "string",
"externalName": "string",
"points": 0
}
]
}
]
},
"memberBalance": {"basicPoints": 0,
"points": [{"pointType": "string",
"pointTypeName": "string",
"points": 0
}
]
},
"incentiveValue": 0,
"productsDiscountValue": 0,
"billDiscountValue": 0,
"discountValue": 0,
"paymentValue": 0,
"payWithPointsDiscountValue": 0,
"messages": ["string"
],
"products": [{"code": "string",
"externalCode": "string",
"quantity": 0,
"discountValue": 0,
"paymentValue": 0,
"discountPromotions": [{"code": "string",
"externalName": "string",
"discountValue": 0
}
]
}
],
"billDiscountPromotions": [{"code": "string",
"externalName": "string",
"discountValue": 0
}
],
"issuedCoupons": [{"couponNumber": "string",
"couponTypeCode": "string",
"couponTypeName": "string",
"externalName": "string",
"externalDescription": "string",
"marketingText": "string",
"useQuantity": 0,
"validityPeriod": {"validityStartDate": "2019-08-24",
"expiryDate": "2019-08-24"
},
"fixedValueDiscount": 0.01,
"percent": 1,
"applicationRule": "U",
"visualModes": ["BC"
]
}
],
"burnedCoupons": [{"couponNumber": "string",
"couponTypeCode": "string",
"couponTypeName": "string",
"externalName": "string",
"externalDescription": "string",
"marketingText": "string",
"useQuantity": 0,
"validityPeriod": {"validityStartDate": "2019-08-24",
"expiryDate": "2019-08-24"
},
"fixedValueDiscount": 0.01,
"percent": 1,
"applicationRule": "U",
"useDetails": {"useResult": "s",
"useResultName": "string",
"status": "s",
"statusName": "string",
"burnQuantity": 0,
"refundQuantity": 0
}
}
],
"refundedCoupons": [{"couponNumber": "string",
"couponTypeCode": "string",
"couponTypeName": "string",
"externalName": "string",
"externalDescription": "string",
"marketingText": "string",
"useQuantity": 0,
"validityPeriod": {"validityStartDate": "2019-08-24",
"expiryDate": "2019-08-24"
},
"fixedValueDiscount": 0.01,
"percent": 1,
"applicationRule": "U",
"visualModes": ["BC"
],
"useDetails": {"status": "s",
"statusName": "string",
"burnQuantity": 0,
"refundQuantity": 0
}
}
]
}

Get reward categories

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

query Parameters

filter	string >= 3 characters Full text search query. Matches [code, name].
code	Array of strings List of reward category codes. REWARD_CATEGORIES dictionary.
name	string Reward category name.
description	string Reward category description.
parentCategory	Array of strings List of associated upper level categories codes. REWARD_CATEGORIES dictionary.
root	boolean When true returns only root level categories, when false returns all categories. Default value is false
sort	string Default: "id:ASC" Defines the sort order of the resulting list of objects. Available sort orders: ASCENDING, ASC, ascending, asc, 1, DESCENDING, DESC, descending, desc, -1. If operation description does not state otherwise, default order field is 'id' and the default order is ascending. If operation description does not state otherwise, all attributes of the response array items may be included as sort criteria. Constructed as comma separated list of sort fields, with optional order marker after colon. Examples: sort=firstName:ASC,lastName:DESC,address.street - result is ordered by first name ascending, last name descending and street part of the address ascending sort=firstName,lastName:DESC - result is ordered by first name ascending and last name descending sort=firstName,lastName - result is ordered by first name ascending and last name ascending sort=:DESC - result is ordered descending by the default field (id)
firstResult	integer <int32> Default: 0 First item on the page. Indexed from 0. Only non-negative values.
maxResults	integer <int32> Max count of items on the page. Default value is from the PROCESSING_DEFAULT_MAX_RESULTS system parameter. Only non-negative values.

header Parameters

Content-Type	string Request content type as MIME type. By default application/json, unless operation's request specification says otherwise.
Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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": [{"code": "string",
"name": "string",
"externalName": "string",
"parentCategory": "string",
"description": "string",
"externalDescription": "string",
"shortDescription": "string",
"imageId": "string",
"parentCategoryName": "string",
"categoryOrder": 0
}
]
}

Get rewards

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

query Parameters

filter	string >= 3 characters Full text search query. Matches [code, externalName, externalDescription].
code	Array of strings List of reward codes. REWARDS dictionary.
name	string Reward name
category	Array of strings List of category codes of the reward. REWARD_CATEGORIES dictionary. Note: Searches just directly under the given reward categories.
masterCategory	Array of strings List of category codes of the reward. REWARD_CATEGORIES dictionary. Note: Searches recursively under the given reward categories and their subcategories.
type	Array of strings List of reward type codes. REWARD_TYPES dictionary.
startDate	string <date> Reward available since date. Inclusive.
endDate	string <date> Reward available to date. Inclusive. Rewards with empty endDate are returned regardless of this filter.
period	string Enum: "D" "W" "M" "Y" Convenience way for defining reward availability date range. Ignored when at least one of startDate, endDate criteria is provided. Available options: D - Today W - This week M - This month Y - This year
partner	Array of strings Codes of reward partners. PARTNERS dictionary.
pricePlan.code	Array of strings List of reward price plan codes
pricePlan.channel	Array of strings List of reward price plan channel codes. REWARD_ORDER_CHANNELS dictionary. Filters rewards available via specified channel or all channels.
pricePlan.pointsFrom	integer Minimum points amount set in the price plan. Inclusive. Minimum amount of points that customer is willing to pay for reward.
pricePlan.pointsTo	integer Maximum points amount set in the price plan. Inclusive. Maximum amount of points that customer is willing to pay for reward.
pricePlan.pointType	Array of strings Price plan related point type codes. POINT_TYPES dictionary. Useful for search for rewards achievable with possessed point types.
pricePlan.startDate	string <date> Reward price plan available since. Inclusive. Rewards with empty pricePlan.startDate are returned regardless of this filter.
pricePlan.endDate	string <date> Reward price plan available to. Inclusive. Rewards with empty pricePlan.endDate are returned regardless of this filter.
pricePlan.period	string Enum: "D" "W" "M" "Y" Convenience way for defining reward price plan availability date range. Is ignored when at least one of pricePlan.startDate, pricePlan.endDate criteria is provided. Available options: D - Today W - This week M - This month Y - This year
sort	string Default: "id:ASC" Defines the sort order of the resulting list of objects. Available sort orders: ASCENDING, ASC, ascending, asc, 1, DESCENDING, DESC, descending, desc, -1. If operation description does not state otherwise, default order field is 'id' and the default order is ascending. If operation description does not state otherwise, all attributes of the response array items may be included as sort criteria. Constructed as comma separated list of sort fields, with optional order marker after colon. Examples: sort=firstName:ASC,lastName:DESC,address.street - result is ordered by first name ascending, last name descending and street part of the address ascending sort=firstName,lastName:DESC - result is ordered by first name ascending and last name descending sort=firstName,lastName - result is ordered by first name ascending and last name ascending sort=:DESC - result is ordered descending by the default field (id)
firstResult	integer <int32> Default: 0 First item on the page. Indexed from 0. Only non-negative values.
maxResults	integer <int32> Max count of items on the page. Default value is from the PROCESSING_DEFAULT_MAX_RESULTS system parameter. Only non-negative values.
with	Array of strings Items Enum: "pricePlans" "resources" "supplier" Appends to every response item additional content that is not appended by default to boost lists performance. Note: Requesting more item data in the responses which are lists may impact performance. Supports [pricePlans, resources, supplier].

header Parameters

Content-Type	string Request content type as MIME type. By default application/json, unless operation's request specification says otherwise.
Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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": [{"code": "string",
"externalName": "string",
"status": "s",
"type": "s",
"category": "string",
"categoryOrder": 0,
"masterCategory": "string",
"partner": "string",
"partnerName": "string",
"startDate": "2019-08-24",
"endDate": "2019-08-24",
"statusName": "string",
"typeName": "string",
"categoryName": "string",
"masterCategoryName": "string",
"supplier": "string",
"rewardSupplier": {"code": "string",
"name": "string",
"status": "s",
"statusName": "string",
"address": {"street": "string",
"houseNumber": "string",
"apartmentNumber": "string",
"postalCode": "string",
"city": "string",
"region": "string",
"country": "str",
"email": "string",
"mobile": "string",
"phone": "string",
"additionalInfo": "string"
},
"contacts": [{"name": "string",
"address": "string",
"email": "string",
"phone": "string",
"mobile": "string",
"additionalInfo": "string"
}
],
"deliveryPOS": true,
"deliveryHome": true,
"deliveryOnline": true
},
"nonMaterial": true,
"attributes": [{"code": "string",
"value": "string"
}
],
"pricePlans": [{"id": 0,
"code": "string",
"channel": "string",
"points": 0,
"pointType": "string",
"pointTypeName": "string",
"startDate": "2019-08-24",
"endDate": "2019-08-24"
}
],
"resources": {"main": {"id": 0,
"name": "string",
"fileId": "string",
"type": "string",
"channel": "s",
"typeName": "string",
"channelName": "string"
},
"other": [{"id": 0,
"name": "string",
"fileId": "string",
"type": "string",
"channel": "s",
"typeName": "string",
"channelName": "string"
}
]
},
"creationDate": "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, startDate, endDate]. Sorting by pricePlan.points uses the default system point type by default, the pricePlan.pointType filter can be used to specify the desired one.

Authorizations:

customer_password_scheme (b2c_api_gateway)

query Parameters

filter	string >= 3 characters Full text search query. Matches [code, externalName, externalDescription].
code	Array of strings List of reward codes. REWARDS dictionary.
name	string Reward name
category	Array of strings List of category codes of the reward. REWARD_CATEGORIES dictionary. Note: Searches just directly under the given reward categories.
masterCategory	Array of strings List of category codes of the reward. REWARD_CATEGORIES dictionary. Note: Searches recursively under the given reward categories and their subcategories.
type	Array of strings List of reward type codes. REWARD_TYPES dictionary.
startDate	string <date> Reward available since date. Inclusive.
endDate	string <date> Reward available to date. Inclusive. Rewards with empty endDate are returned regardless of this filter.
period	string Enum: "D" "W" "M" "Y" Convenience way for defining reward availability date range. Ignored when at least one of startDate, endDate criteria is provided. Available options: D - Today W - This week M - This month Y - This year
partner	Array of strings Codes of reward partners. PARTNERS dictionary.
pricePlan.code	Array of strings List of reward price plan codes
pricePlan.channel	Array of strings List of reward price plan channel codes. REWARD_ORDER_CHANNELS dictionary. Filters rewards available via specified channel or all channels.
pricePlan.pointsFrom	integer Minimum points amount set in the price plan. Inclusive. Minimum amount of points that customer is willing to pay for reward.
pricePlan.pointsTo	integer Maximum points amount set in the price plan. Inclusive. Maximum amount of points that customer is willing to pay for reward.
pricePlan.pointType	Array of strings Price plan related point type codes. POINT_TYPES dictionary. Useful for search for rewards achievable with possessed point types.
pricePlan.startDate	string <date> Reward price plan available since. Inclusive. Rewards with empty pricePlan.startDate are returned regardless of this filter.
pricePlan.endDate	string <date> Reward price plan available to. Inclusive. Rewards with empty pricePlan.endDate are returned regardless of this filter.
pricePlan.period	string Enum: "D" "W" "M" "Y" Convenience way for defining reward price plan availability date range. Is ignored when at least one of pricePlan.startDate, pricePlan.endDate criteria is provided. Available options: D - Today W - This week M - This month Y - This year
sort	string Default: "id:ASC" Defines the sort order of the resulting list of objects. Available sort orders: ASCENDING, ASC, ascending, asc, 1, DESCENDING, DESC, descending, desc, -1. If operation description does not state otherwise, default order field is 'id' and the default order is ascending. If operation description does not state otherwise, all attributes of the response array items may be included as sort criteria. Constructed as comma separated list of sort fields, with optional order marker after colon. Examples: sort=firstName:ASC,lastName:DESC,address.street - result is ordered by first name ascending, last name descending and street part of the address ascending sort=firstName,lastName:DESC - result is ordered by first name ascending and last name descending sort=firstName,lastName - result is ordered by first name ascending and last name ascending sort=:DESC - result is ordered descending by the default field (id)
firstResult	integer <int32> Default: 0 First item on the page. Indexed from 0. Only non-negative values.
maxResults	integer <int32> Max count of items on the page. Default value is from the PROCESSING_DEFAULT_MAX_RESULTS system parameter. Only non-negative values.
specialForYou	boolean Filter out rewards that do not belong to any segment. Set on true returns rewards that are only available in one of customer segments. Set on false returns all rewards available to customer.
with	Array of strings Items Enum: "pricePlans" "resources" "supplier" Appends to every response item additional content that is not appended by default to boost lists performance. Note: Requesting more item data in the responses which are lists may impact performance. Supports [pricePlans, resources, supplier].

header Parameters

Content-Type	string Request content type as MIME type. By default application/json, unless operation's request specification says otherwise.
Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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": [{"code": "string",
"externalName": "string",
"status": "s",
"type": "s",
"category": "string",
"categoryOrder": 0,
"masterCategory": "string",
"partner": "string",
"partnerName": "string",
"startDate": "2019-08-24",
"endDate": "2019-08-24",
"statusName": "string",
"typeName": "string",
"categoryName": "string",
"masterCategoryName": "string",
"supplier": "string",
"rewardSupplier": {"code": "string",
"name": "string",
"status": "s",
"statusName": "string",
"address": {"street": "string",
"houseNumber": "string",
"apartmentNumber": "string",
"postalCode": "string",
"city": "string",
"region": "string",
"country": "str",
"email": "string",
"mobile": "string",
"phone": "string",
"additionalInfo": "string"
},
"contacts": [{"name": "string",
"address": "string",
"email": "string",
"phone": "string",
"mobile": "string",
"additionalInfo": "string"
}
],
"deliveryPOS": true,
"deliveryHome": true,
"deliveryOnline": true
},
"nonMaterial": true,
"attributes": [{"code": "string",
"value": "string"
}
],
"pricePlans": [{"id": 0,
"code": "string",
"channel": "string",
"points": 0,
"pointType": "string",
"pointTypeName": "string",
"startDate": "2019-08-24",
"endDate": "2019-08-24"
}
],
"resources": {"main": {"id": 0,
"name": "string",
"fileId": "string",
"type": "string",
"channel": "s",
"typeName": "string",
"channelName": "string"
},
"other": [{"id": 0,
"name": "string",
"fileId": "string",
"type": "string",
"channel": "s",
"typeName": "string",
"channelName": "string"
}
]
},
"specialForYou": true,
"creationDate": "2019-08-24T14:15:22Z"
}
]
}

Get reward

Get reward details

path Parameters

rewardCode

required

string >= 3 characters

Target reward unique code

query Parameters

pricePlanDate

string <date>

Example: pricePlanDate=2018-09-01

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

header Parameters

Content-Type	string Request content type as MIME type. By default application/json, unless operation's request specification says otherwise.
Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). UTC timezone is assumed. Time zone is ignored if incorrect value is provided.
X-Tenant-ID	string <= 100 characters Tenant identifier. When not provided to the request, the default identifier will be used.

Responses

Response samples

Content type

application/json

{"code": "string",
"externalName": "string",
"externalDescription": "string",
"type": "s",
"category": "string",
"masterCategory": "string",
"couponTypeCode": "string",
"categoryOrder": 0,
"status": "s",
"startDate": "2019-08-24",
"endDate": "2019-08-24",
"attributes": [{"code": "string",
"value": "string"
}
],
"partner": "string",
"netValue": 0,
"tax": "string",
"deliveryMethod": "s",
"quantity": 1,
"orderRequiresApproval": false,
"maximumRedemptionsAllowed": 1,
"nonMaterial": true,
"statusName": "string",
"partnerName": "string",
"typeName": "string",
"categoryName": "string",
"masterCategoryName": "string",
"supplier": "string",
"rewardSupplier": {"code": "string",
"name": "string",
"status": "s",
"statusName": "string",
"address": {"street": "string",
"houseNumber": "string",
"apartmentNumber": "string",
"postalCode": "string",
"city": "string",
"region": "string",
"country": "str",
"email": "string",
"mobile": "string",
"phone": "string",
"additionalInfo": "string"
},
"contacts": [{"name": "string",
"address": "string",
"email": "string",
"phone": "string",
"mobile": "string",
"additionalInfo": "string"
}
],
"deliveryPOS": true,
"deliveryHome": true,
"deliveryOnline": true
},
"pricePlans": [{"id": 0,
"code": "string",
"channel": "string",
"points": 0,
"pointType": "string",
"pointTypeName": "string",
"startDate": "2019-08-24",
"endDate": "2019-08-24"
}
],
"resources": {"main": {"id": 0,
"name": "string",
"fileId": "string",
"type": "string",
"channel": "s",
"typeName": "string",
"channelName": "string"
},
"other": [{"id": 0,
"name": "string",
"fileId": "string",
"type": "string",
"channel": "s",
"typeName": "string",
"channelName": "string"
}
]
},
"lastModify": "2019-08-24T14:15:22Z",
"creationDate": "2019-08-24T14:15:22Z"
}

Get mass campaigns

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

query Parameters

filter	string >= 3 characters Full text search query. Matches [code, name].
code	Array of strings List of coupon type codes. CLOUD_COUPON_TYPES dictionary.
excludeCode	Array of strings List of coupon types codes that should be excluded from the result. CLOUD_COUPON_TYPES dictionary.
deliveryChannelCode	Array of strings Codes of coupon delivery channels. COUPON_DELIVERY_CHANNELS dictionary.
deliveryStartDateFrom	string <date> Coupon earliest delivery start date - lower limit. Inclusive. Earlist delivery.startDate on configured coupon delivery channels.
deliveryStartDateTo	string <date> Coupon earliest delivery start date - upper limit. Inclusive. Earlist delivery.startDate on configured coupon delivery channels.
validityEndDateFrom	string <date> Coupon validity end date - lower limit. Inclusive. Coupon types with validity.unlimited=true or empty validity end date) are returned regardless of this filter.
validityEndDateTo	string <date> Coupon validity end date - upper limit. Inclusive. Coupon types with validity.unlimited=true or empty validity end date) are returned regardless of this filter.
tags	Array of strings Coupon type tags.
sort	string Default: "id:ASC" Defines the sort order of the resulting list of objects. Available sort orders: ASCENDING, ASC, ascending, asc, 1, DESCENDING, DESC, descending, desc, -1. If operation description does not state otherwise, default order field is 'id' and the default order is ascending. If operation description does not state otherwise, all attributes of the response array items may be included as sort criteria. Constructed as comma separated list of sort fields, with optional order marker after colon. Examples: sort=firstName:ASC,lastName:DESC,address.street - result is ordered by first name ascending, last name descending and street part of the address ascending sort=firstName,lastName:DESC - result is ordered by first name ascending and last name descending sort=firstName,lastName - result is ordered by first name ascending and last name ascending sort=:DESC - result is ordered descending by the default field (id)
firstResult	integer <int32> Default: 0 First item on the page. Indexed from 0. Only non-negative values.
maxResults	integer <int32> Max count of items on the page. Default value is from the PROCESSING_DEFAULT_MAX_RESULTS system parameter. Only non-negative values.

header Parameters

Content-Type	string Request content type as MIME type. By default application/json, unless operation's request specification says otherwise.
Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
Authorization	string Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation. Bearer token where token is authorization key granted to the client.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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": [{"code": "string",
"name": "string",
"externalName": "string",
"externalDescription": "string",
"interactive": false,
"status": "s",
"statusName": "string",
"distributionMode": "string",
"distributionModeName": "string",
"delivery": {"channels": [{"code": "string",
"name": "string"
}
],
"segments": [{"code": "string",
"name": "string",
"type": "s",
"assignMode": "I",
"size": 0
}
],
"broadcast": true
},
"specialForYou": true,
"validityPeriod": {"from": "2019-08-24",
"to": "2019-08-24"
},
"largeImageId": "string",
"smallImageId": "string",
"tags": ["string"
],
"discount": 0.01,
"discountPercentage": 0,
"couponNumber": "string",
"visualModes": ["BC"
]
}
]
}

Get member targeted campaigns

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

Authorizations:

customer_password_scheme (b2c_api_gateway)

query Parameters

filter	string >= 3 characters Full text search query. Matches [code, name].
code	Array of strings List of coupon type codes. CLOUD_COUPON_TYPES dictionary.
excludeCode	Array of strings List of coupon types codes that should be excluded from the result. CLOUD_COUPON_TYPES dictionary.
deliveryChannelCode	Array of strings Codes of coupon delivery channels. COUPON_DELIVERY_CHANNELS dictionary.
deliveryStartDateFrom	string <date> Coupon earliest delivery start date - lower limit. Inclusive. Earlist delivery.startDate on configured coupon delivery channels.
deliveryStartDateTo	string <date> Coupon earliest delivery start date - upper limit. Inclusive. Earlist delivery.startDate on configured coupon delivery channels.
validityEndDateFrom	string <date> Coupon validity end date - lower limit. Inclusive. Coupon types with validity.unlimited=true or empty validity end date) are returned regardless of this filter.
validityEndDateTo	string <date> Coupon validity end date - upper limit. Inclusive. Coupon types with validity.unlimited=true or empty validity end date) are returned regardless of this filter.
broadcast	boolean Filter distributionMode = mass campaign coupon types which are broadcasted or not in any webapp channels. Applies to the mass campaign coupon types which quantity is not based on segments.
tags	Array of strings Coupon type tags.
sort	string Default: "id:ASC" Defines the sort order of the resulting list of objects. Available sort orders: ASCENDING, ASC, ascending, asc, 1, DESCENDING, DESC, descending, desc, -1. If operation description does not state otherwise, default order field is 'id' and the default order is ascending. If operation description does not state otherwise, all attributes of the response array items may be included as sort criteria. Constructed as comma separated list of sort fields, with optional order marker after colon. Examples: sort=firstName:ASC,lastName:DESC,address.street - result is ordered by first name ascending, last name descending and street part of the address ascending sort=firstName,lastName:DESC - result is ordered by first name ascending and last name descending sort=firstName,lastName - result is ordered by first name ascending and last name ascending sort=:DESC - result is ordered descending by the default field (id)
firstResult	integer <int32> Default: 0 First item on the page. Indexed from 0. Only non-negative values.
maxResults	integer <int32> Max count of items on the page. Default value is from the PROCESSING_DEFAULT_MAX_RESULTS system parameter. Only non-negative values.

header Parameters

Content-Type	string Request content type as MIME type. By default application/json, unless operation's request specification says otherwise.
Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
Authorization	string Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation. Bearer token where token is authorization key granted to the client.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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": [{"code": "string",
"name": "string",
"externalName": "string",
"externalDescription": "string",
"interactive": false,
"interactionData": {"interactionType": "string",
"interactiveText": "string",
"coverColor": "string",
"coverText": "string"
},
"status": "s",
"statusName": "string",
"distributionMode": "string",
"distributionModeName": "string",
"delivery": {"channels": [{"code": "string",
"name": "string"
}
],
"broadcast": true
},
"specialForYou": true,
"validityPeriod": {"from": "2019-08-24",
"to": "2019-08-24"
},
"largeImageId": "string",
"smallImageId": "string",
"tags": ["string"
],
"discount": 0.01,
"discountPercentage": 0,
"couponNumber": "string",
"visualModes": ["BC"
]
}
]
}

Get coupon type generic data

Get coupon type generic details

path Parameters

couponTypeCode

required

string

Target coupon type code

header Parameters

Content-Type	string Request content type as MIME type. By default application/json, unless operation's request specification says otherwise.
Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
Authorization	string Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation. Bearer token where token is authorization key granted to the client.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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": {"couponNumber": "string",
"validityPeriod": {"from": "2019-08-24",
"to": "2019-08-24"
},
"useQuantity": 0,
"visualModes": ["BC"
]
},
"interactive": true,
"interactionData": {"interactionType": "string",
"interactiveText": "string",
"coverColor": "string",
"coverText": "string"
},
"largeImageId": "string",
"smallImageId": "string",
"tagsI18N": {"value": ["string"
],
"i18n": [{"langCode": "string",
"value": ["string"
]
}
]
},
"lastModify": "2019-08-24T14:15:22Z"
}

Activate scratch coupon

Activate scratch coupon.
Coupon has to be assigned to customer and be in status pre-issued.

Authorizations:

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.

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": [{"error": "CONSTRAINT_NOT_EMPTY",
"message": "Empty value not allowed",
"path": "arg1.address.street"
}
]
}

Rewards orders

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

Get rewards orders

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

Authorizations:

customer_password_scheme (b2c_api_gateway)

query Parameters

status	string Order status. ORDER_STATUSES dictionary.
deliveryMethod	string Order delivery method code. REWARD_DELIVERY_METHODS dictionary.
dateFrom	string <date> Order placement date. Lower boundary. Inclusive.
dateTo	string <date> Order placement date. Upper boundary. Inclusive.
sort	string Default: "date:DESC" Defines the sort order of the resulting list of objects. Available sort orders: ASCENDING, ASC, ascending, asc, 1, DESCENDING, DESC, descending, desc, -1. If operation description does not state otherwise, default order field is 'id' and the default order is ascending. If operation description does not state otherwise, all attributes of the response array items may be included as sort criteria. Constructed as comma separated list of sort fields, with optional order marker after colon. Examples: sort=firstName:ASC,lastName:DESC,address.street - result is ordered by first name ascending, last name descending and street part of the address ascending sort=firstName,lastName:DESC - result is ordered by first name ascending and last name descending sort=firstName,lastName - result is ordered by first name ascending and last name ascending sort=:DESC - result is ordered descending by the default field (id)
firstResult	integer <int32> Default: 0 First item on the page. Indexed from 0. Only non-negative values.
maxResults	integer <int32> Max count of items on the page. Default value is from the PROCESSING_DEFAULT_MAX_RESULTS system parameter. Only non-negative values.

header Parameters

Content-Type	string Request content type as MIME type. By default application/json, unless operation's request specification says otherwise.
Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
Authorization	string Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation. Bearer token where token is authorization key granted to the client.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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": "stri"
}
]

Get rewards order by orderId

Get order detailed info

Authorizations:

customer_password_scheme (b2c_api_gateway)

path Parameters

orderId

required

integer

Unique order identifier

header Parameters

Content-Type	string Request content type as MIME type. By default application/json, unless operation's request specification says otherwise.
Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
Authorization	string Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation. Bearer token where token is authorization key granted to the client.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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",
"deliveryAddress": {"name": "string",
"phone": "string",
"phoneCountryPrefix": "string",
"street": "string",
"houseNumber": "string",
"apartmentNumber": "string",
"postalCode": "string",
"city": "string",
"region": "string",
"country": "str",
"email": "string",
"mobile": "string",
"additionalInfo": "string"
},
"deliveryLocation": {"partner": "string",
"partnerName": "string",
"location": "string",
"locationName": "string"
},
"comment": "string",
"rewards": [{"reward": "string",
"rewardName": "string",
"pricePlanCode": "string",
"quantity": 1,
"totalPointTypes": [{"pointTypeCode": "string",
"pointTypeName": "string",
"amount": 0
}
],
"supplier": "string",
"supplierName": "string",
"online": true,
"type": null
}
],
"totalQuantity": 0,
"externalId": "string",
"totalPointTypes": [{"pointTypeCode": "string",
"pointTypeName": "string",
"amount": 0
}
]
}

Get rewards order by transactionId

Get order detailed info

Authorizations:

customer_password_scheme (b2c_api_gateway)

path Parameters

transactionId

required

integer

Unique transaction identifier

header Parameters

Content-Type	string Request content type as MIME type. By default application/json, unless operation's request specification says otherwise.
Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
Authorization	string Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation. Bearer token where token is authorization key granted to the client.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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",
"deliveryAddress": {"name": "string",
"phone": "string",
"phoneCountryPrefix": "string",
"street": "string",
"houseNumber": "string",
"apartmentNumber": "string",
"postalCode": "string",
"city": "string",
"region": "string",
"country": "str",
"email": "string",
"mobile": "string",
"additionalInfo": "string"
},
"deliveryLocation": {"partner": "string",
"partnerName": "string",
"location": "string",
"locationName": "string"
},
"comment": "string",
"rewards": [{"reward": "string",
"rewardName": "string",
"pricePlanCode": "string",
"quantity": 1,
"totalPointTypes": [{"pointTypeCode": "string",
"pointTypeName": "string",
"amount": 0
}
],
"supplier": "string",
"supplierName": "string",
"online": true,
"type": null
}
],
"totalQuantity": 0,
"externalId": "string",
"totalPointTypes": [{"pointTypeCode": "string",
"pointTypeName": "string",
"amount": 0
}
]
}

Cancel rewards order by orderId

Authorizations:

customer_password_scheme (b2c_api_gateway)

path Parameters

orderId

required

integer

Unique order identifier

header Parameters

Content-Type	string Request content type as MIME type. By default application/json, unless operation's request specification says otherwise.
Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
Authorization	string Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation. Bearer token where token is authorization key granted to the client.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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": [{"error": "CONSTRAINT_NOT_EMPTY",
"message": "Empty value not allowed",
"path": "arg1.address.street"
}
]
}

Cancel rewards order by transactionId

Authorizations:

customer_password_scheme (b2c_api_gateway)

path Parameters

transactionId

required

integer

Unique transaction identifier

header Parameters

Content-Type	string Request content type as MIME type. By default application/json, unless operation's request specification says otherwise.
Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
Authorization	string Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation. Bearer token where token is authorization key granted to the client.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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": [{"error": "CONSTRAINT_NOT_EMPTY",
"message": "Empty value not allowed",
"path": "arg1.address.street"
}
]
}

Suppliers

With this method, you can generate a list of all suppliers configured in the System. Suppliers are related to the rewards.

Get suppliers

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

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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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": [{"code": "string",
"name": "string",
"status": "s",
"statusName": "string",
"address": {"street": "string",
"houseNumber": "string",
"apartmentNumber": "string",
"postalCode": "string",
"city": "string",
"region": "string",
"country": "str",
"email": "string",
"mobile": "string",
"phone": "string",
"additionalInfo": "string"
},
"contacts": [{"name": "string",
"address": "string",
"email": "string",
"phone": "string",
"mobile": "string",
"additionalInfo": "string"
}
],
"deliveryPOS": true,
"deliveryHome": true,
"deliveryOnline": true
}
]
}

Unauthorized Member

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

Get T&C Policy

Get Terms and Conditions Policy.

header Parameters

Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
Authorization	string Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation. Bearer token where token is authorization key granted to the client.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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": {"personalDataProcessing": {"description": "string",
"acceptanceLevel": "string",
"currentVersion": 0,
"acceptanceDeadline": "2019-08-24T14:15:22Z",
"label": "string",
"currentVersionContent": {"contentFormat": "PDF",
"content": "string",
"contentFile": "string"
}
},
"personalDataProfiling": {"description": "string",
"acceptanceLevel": "string",
"currentVersion": 0,
"acceptanceDeadline": "2019-08-24T14:15:22Z",
"label": "string",
"currentVersionContent": {"contentFormat": "PDF",
"content": "string",
"contentFile": "string"
}
}
},
"loyalty": {"termsAndConditions": {"description": "string",
"acceptanceLevel": "string",
"currentVersion": 0,
"acceptanceDeadline": "2019-08-24T14:15:22Z",
"label": "string",
"currentVersionContent": {"contentFormat": "PDF",
"content": "string",
"contentFile": "string"
}
},
"communications": {"description": "string",
"acceptanceLevel": "string",
"communicationChannels": [{"code": "string",
"name": "string"
}
]
},
"thirdPartyCommunications": {"description": "string",
"acceptanceLevel": "string",
"communicationChannels": [{"code": "string",
"name": "string"
}
]
},
"marketingCommunications": {"description": "string",
"acceptanceLevel": "string",
"communicationChannels": [{"code": "string",
"name": "string"
}
]
}
}
}

Initiate password reset procedure

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

header Parameters

Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
X-CLM-DeviceID	string <= 200 characters Requesting device fingerprint. Identifies particular device calling the API.
X-CLM-OTP-Save-Authorized-Device	boolean Default: false Flag indicating if device of given fingerprint from X-CLM-DeviceID header should be added to trusted devices.
X-CLM-OTP-TOKEN	string <= 200 characters Value of token sent on email or sms. Necessary to pass multifactor authentication
Time-Zone	string <= 100 characters Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH). Time zone source hierarchy: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). UTC timezone is assumed. Time zone is ignored if incorrect value is provided.
X-Tenant-ID	string <= 100 characters Tenant identifier. When not provided to the request, the default identifier will be used.

Request Body schema: application/json

login required	string Customer login. Any value that is configured and allows member to login.
oneTimePermission	boolean Forces password reset communication even if member does not have communication permission. In case of no permission, communication will not occur unless the permission is explicitly granted. Otherwise oneTimePermission flag is not respected (even if set to false). Information about one time permission is stored in the system.
preferredChannel	string Preferred communication channel which will be used to communication. Required if oneTimePermission is true. COMMUNICATION_CHANNELS dictionary.

Responses

Request samples

Payload

Content type

application/json

{"login": "string",
"oneTimePermission": true,
"preferredChannel": "string"
}

Response samples

Content type

application/json

{"error": "VALIDATION_ERROR",
"message": "Validation error: Constraint violations",
"method": "PUT",
"path": "/profile/customers/12345",
"correlationId": "1505219765216595",
"status": 400,
"timestamp": "2017-09-12T12:36:05.217Z",
"violations": [{"error": "CONSTRAINT_NOT_EMPTY",
"message": "Empty value not allowed",
"path": "arg1.address.street"
}
]
}

Complete password reset procedure

Change password using token received after /password-reset call

header Parameters

Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
X-CLM-DeviceID	string <= 200 characters Requesting device fingerprint. Identifies particular device calling the API.
X-CLM-OTP-Save-Authorized-Device	boolean Default: false Flag indicating if device of given fingerprint from X-CLM-DeviceID header should be added to trusted devices.
X-CLM-OTP-TOKEN	string <= 200 characters Value of token sent on email or sms. Necessary to pass multifactor authentication
Time-Zone	string <= 100 characters Time zone to which all datetime fields will be adjusted (GET) or interpreted (POST/PUT/PATCH). Time zone source hierarchy: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). UTC timezone is assumed. Time zone is ignored if incorrect value is provided.
X-Tenant-ID	string <= 100 characters Tenant identifier. When not provided to the request, the default identifier will be used.

Request Body schema: application/json

token required	string Reset password token received by the customer
newPassword required	string <password> New password
confirmPassword required	string <password> New password repeated

Responses

Request samples

Payload

Content type

application/json

{"token": "string",
"newPassword": "pa$$word",
"confirmPassword": "pa$$word"
}

Response samples

Content type

application/json

{"error": "VALIDATION_ERROR",
"message": "Validation error: Constraint violations",
"method": "PUT",
"path": "/profile/customers/12345",
"correlationId": "1505219765216595",
"status": 400,
"timestamp": "2017-09-12T12:36:05.217Z",
"violations": [{"error": "CONSTRAINT_NOT_EMPTY",
"message": "Empty value not allowed",
"path": "arg1.address.street"
}
]
}

Confirm link external account

Confirm link external account with customer in CLC

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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). UTC timezone is assumed. Time zone is ignored if incorrect value is provided.
X-Tenant-ID	string <= 100 characters Tenant identifier. When not provided to the request, the default identifier will be used.

Request Body schema: application/json

token

required

string

Token with encrypted information required to confirm linking of external account

Responses

Request samples

Payload

Content type

application/json

{"token": "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": [{"error": "CONSTRAINT_NOT_EMPTY",
"message": "Empty value not allowed",
"path": "arg1.address.street"
}
]
}

Initiate close account procedure

Initiate member close account process.
Notification allowing to close account will be sent to the customer.

header Parameters

Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
X-CLM-DeviceID	string <= 200 characters Requesting device fingerprint. Identifies particular device calling the API.
X-CLM-OTP-Save-Authorized-Device	boolean Default: false Flag indicating if device of given fingerprint from X-CLM-DeviceID header should be added to trusted devices.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). UTC timezone is assumed. Time zone is ignored if incorrect value is provided.
X-Tenant-ID	string <= 100 characters Tenant identifier. When not provided to the request, the default identifier will be used.

Request Body schema: application/json

login

required

string

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

Responses

Request samples

Payload

Content type

application/json

{"login": "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": [{"error": "CONSTRAINT_NOT_EMPTY",
"message": "Empty value not allowed",
"path": "arg1.address.street"
}
]
}

Complete close account procedure

Close account using token received after /close-account call

header Parameters

Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). UTC timezone is assumed. Time zone is ignored if incorrect value is provided.
X-Tenant-ID	string <= 100 characters Tenant identifier. When not provided to the request, the default identifier will be used.

Request Body schema: application/json

token

required

string

Close account token received by the customer

Responses

Request samples

Payload

Content type

application/json

{"token": "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": [{"error": "CONSTRAINT_NOT_EMPTY",
"message": "Empty value not allowed",
"path": "arg1.address.street"
}
]
}

Configuration

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

Get partners

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

query Parameters

filter	string non-empty Full text search query. Matches [code, name].
code	Array of strings Partners codes list. PARTNERS dictionary.
excludeCode	Array of strings List of partner codes that should be excluded from the result
name	string Partner name
status	string 1 characters Partner status code. GENERAL_STATUSES dictionary.
promotionCode	Array of strings Promotion code associated with partners. TRANSACTION_RULES dictionary.
sort	string Default: "id:ASC" Defines the sort order of the resulting list of objects. Available sort orders: ASCENDING, ASC, ascending, asc, 1, DESCENDING, DESC, descending, desc, -1. If operation description does not state otherwise, default order field is 'id' and the default order is ascending. If operation description does not state otherwise, all attributes of the response array items may be included as sort criteria. Constructed as comma separated list of sort fields, with optional order marker after colon. Examples: sort=firstName:ASC,lastName:DESC,address.street - result is ordered by first name ascending, last name descending and street part of the address ascending sort=firstName,lastName:DESC - result is ordered by first name ascending and last name descending sort=firstName,lastName - result is ordered by first name ascending and last name ascending sort=:DESC - result is ordered descending by the default field (id)
firstResult	integer <int32> Default: 0 First item on the page. Indexed from 0. Only non-negative values.
maxResults	integer <int32> Max count of items on the page. Default value is from the PROCESSING_DEFAULT_MAX_RESULTS system parameter. Only non-negative values.

header Parameters

Content-Type	string Request content type as MIME type. By default application/json, unless operation's request specification says otherwise.
Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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": [{"code": "string",
"name": "string",
"description": "string",
"default": true,
"logoFileId": "string",
"status": "s",
"statusName": "string"
}
]
}

Get partner

Get partner data

path Parameters

partnerCode

required

string

Target partner unique code

header Parameters

Content-Type	string Request content type as MIME type. By default application/json, unless operation's request specification says otherwise.
Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). UTC timezone is assumed. Time zone is ignored if incorrect value is provided.
X-Tenant-ID	string <= 100 characters Tenant identifier. When not provided to the request, the default identifier will be used.

Responses

Response samples

Content type

application/json

{"code": "string",
"name": "string",
"description": "string",
"default": true,
"logoFileId": "string",
"status": "s",
"statusName": "string"
}

Get locations

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

[filter]
[code]
[partner]
[name]
[address.filter]
[address.country]
[address.region]
[address.email]
[address.phone]

query Parameters

filter	string non-empty Full text search query. Matches [code, name].
code	Array of strings List of location codes
excludeCode	Array of strings List of location codes that should be excluded from the result
partner	Array of strings List of partner's codes. PARTNERS dictionary.
name	string Location name
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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": [{"id": 0,
"code": "string",
"externalCode": "string",
"name": "string",
"description": "string",
"partner": "string",
"status": "s",
"type": "stri",
"partnerName": "string",
"statusName": "string",
"typeName": "string",
"address": {"street": "string",
"houseNumber": "string",
"apartmentNumber": "string",
"postalCode": "string",
"city": "string",
"region": "string",
"country": "str",
"email": "string",
"mobile": "string",
"phone": "string",
"additionalInfo": "string"
},
"geoPos": {"latitude": 0,
"longitude": 0
},
"rewardPOSDelivery": true,
"clickAndCollect": true
}
]
}

Get location

Get location details

path Parameters

locationId

required

integer

Location system-wide unique identifier

query Parameters

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

header Parameters

Content-Type	string Request content type as MIME type. By default application/json, unless operation's request specification says otherwise.
Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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",
"externalCode": "string",
"name": "string",
"description": "string",
"partner": "string",
"status": "s",
"type": "stri",
"partnerName": "string",
"statusName": "string",
"typeName": "string",
"address": {"street": "string",
"houseNumber": "string",
"apartmentNumber": "string",
"postalCode": "string",
"city": "string",
"region": "string",
"country": "str",
"email": "string",
"mobile": "string",
"phone": "string",
"additionalInfo": "string"
},
"geoPos": {"latitude": 0,
"longitude": 0
},
"rewardPOSDelivery": true,
"clickAndCollect": true,
"lastModify": "2019-08-24T14:15:22Z",
"productPrices": [{"product": "string",
"productName": "string",
"productVariant": "string",
"productVariantName": "string",
"price": 0,
"priceUnit": "string",
"priceUnitName": "string",
"currencyCode": "string",
"lastUpdateDate": null
}
]
}

Get system parameter

path Parameters

parameterCode

required

string

System parameter code

header Parameters

Content-Type	string Request content type as MIME type. By default application/json, unless operation's request specification says otherwise.
Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). UTC timezone is assumed. Time zone is ignored if incorrect value is provided.
X-Tenant-ID	string <= 100 characters Tenant identifier. When not provided to the request, the default identifier will be used.

Responses

Response samples

Content type

application/json

{"code": "string",
"name": "string",
"category": "st",
"categoryName": "string",
"type": "s",
"typeName": "string",
"value": "string",
"pattern": "string",
"description": "string"
}

Get point types

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

query Parameters

filter	string >= 3 characters Full text search query. Matches [code, name].
code	Array of strings Point types codes list.
name	string Point type name
sort	string Default: "id:ASC" Defines the sort order of the resulting list of objects. Available sort orders: ASCENDING, ASC, ascending, asc, 1, DESCENDING, DESC, descending, desc, -1. If operation description does not state otherwise, default order field is 'id' and the default order is ascending. If operation description does not state otherwise, all attributes of the response array items may be included as sort criteria. Constructed as comma separated list of sort fields, with optional order marker after colon. Examples: sort=firstName:ASC,lastName:DESC,address.street - result is ordered by first name ascending, last name descending and street part of the address ascending sort=firstName,lastName:DESC - result is ordered by first name ascending and last name descending sort=firstName,lastName - result is ordered by first name ascending and last name ascending sort=:DESC - result is ordered descending by the default field (id)
firstResult	integer <int32> Default: 0 First item on the page. Indexed from 0. Only non-negative values.
maxResults	integer <int32> Max count of items on the page. Default value is from the PROCESSING_DEFAULT_MAX_RESULTS system parameter. Only non-negative values.

header Parameters

Content-Type	string Request content type as MIME type. By default application/json, unless operation's request specification says otherwise.
Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
Authorization	string Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation. Bearer token where token is authorization key granted to the client.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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": [{"code": "string",
"name": "string",
"description": "string",
"transferable": true,
"adjustable": true,
"mainBalance": true
}
]
}

Get point type

path Parameters

pointTypeCode

required

string

Point type code. POINT_TYPES dictionary.

header Parameters

Content-Type	string Request content type as MIME type. By default application/json, unless operation's request specification says otherwise.
Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
Authorization	string Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation. Bearer token where token is authorization key granted to the client.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). UTC timezone is assumed. Time zone is ignored if incorrect value is provided.
X-Tenant-ID	string <= 100 characters Tenant identifier. When not provided to the request, the default identifier will be used.

Responses

Response samples

Content type

application/json

{"code": "string",
"name": "string",
"description": "string",
"transferable": true,
"adjustable": true,
"expiryPeriod": "P1Y6M",
"mainBalance": true
}

Get transaction types

Get list of transaction types configured in the system.

Authorizations:

customer_password_scheme (any)

query Parameters

filter	string Full text search query. Matches [code, name].
code	Array of strings Transaction types filter. TRANSACTION_TYPES dictionary.
status	Array of strings Transaction types status filter. GENERAL_STATUSES dictionary.
promotable	boolean Promotable filter
genericEvent	boolean Generic event filter
b2cDefaultMemberVisibility	boolean B2C default member visibility filter
sort	string Default: "id:ASC" Defines the sort order of the resulting list of objects. Available sort orders: ASCENDING, ASC, ascending, asc, 1, DESCENDING, DESC, descending, desc, -1. If operation description does not state otherwise, default order field is 'id' and the default order is ascending. If operation description does not state otherwise, all attributes of the response array items may be included as sort criteria. Constructed as comma separated list of sort fields, with optional order marker after colon. Examples: sort=firstName:ASC,lastName:DESC,address.street - result is ordered by first name ascending, last name descending and street part of the address ascending sort=firstName,lastName:DESC - result is ordered by first name ascending and last name descending sort=firstName,lastName - result is ordered by first name ascending and last name ascending sort=:DESC - result is ordered descending by the default field (id)
firstResult	integer <int32> Default: 0 First item on the page. Indexed from 0. Only non-negative values.
maxResults	integer <int32> Max count of items on the page. Default value is from the PROCESSING_DEFAULT_MAX_RESULTS system parameter. Only non-negative values.

header Parameters

Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
Authorization	string Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation. Bearer token where token is authorization key granted to the client.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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": [{"code": "st",
"name": "string",
"description": "string",
"status": "s",
"statusName": "string",
"promotable": true,
"genericEvent": true,
"smallImageId": "string",
"largeImageId": "string",
"b2cMemberVisibility": true,
"b2cDefaultMemberVisibility": true
}
]
}

Get password restrictions

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

header Parameters

Content-Type	string Request content type as MIME type. By default application/json, unless operation's request specification says otherwise.
Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). UTC timezone is assumed. Time zone is ignored if incorrect value is provided.
X-Tenant-ID	string <= 100 characters Tenant identifier. When not provided to the request, the default identifier will be used.

Responses

Response samples

Content type

application/json

{"name": "string",
"restrictions": {"minLength": 0,
"minBigLetters": 0,
"minSmallLetters": 0,
"minDigits": 0,
"minSpecialChars": 0
}
}

Get member profile restrictions

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

header Parameters

Content-Type	string Request content type as MIME type. By default application/json, unless operation's request specification says otherwise.
Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
Authorization	string Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation. Bearer token where token is authorization key granted to the client.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). UTC timezone is assumed. Time zone is ignored if incorrect value is provided.
X-Tenant-ID	string <= 100 characters Tenant identifier. When not provided to the request, the default identifier will be used.

Responses

Response samples

Content type

application/json

{"defaultMemberLanguage": "string",
"minAge": 0,
"blacklists": {"emailDomain": ["string"
],
"phoneCountryPrefix": ["string"
]
},
"customLogin": {"aliasPattern": "string",
"aliasMinLength": 3,
"aliasMaxLength": 3
},
"loginSettings": {"loginWithEmail": true,
"loginWithPhone": true,
"loginWithAlias": true,
"loginWithIdNo": true
}
}

Member attributes used in form.

Get list of attributes used in specific form.

query Parameters

formType required	string Enum: "EN" "MM" Form type. EN - Enrollment form MM - Member Portal and Mobile App
type	string Enum: "ALL" "CUSTOM" "PREDEFINED" Attribute type. Default value is ALL
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.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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": [{"name": "string",
"code": "string",
"predefined": true,
"valueType": "S",
"valueTypeName": "string",
"acceptanceLevel": "string",
"acceptanceLevelName": "string",
"label": "string",
"tags": ["string"
],
"editable": true,
"order": 1,
"description": "string",
"formField": "string",
"constraints": {"attributeValidators": [{"regexp": "string",
"message": "string",
"key": "string"
}
],
"valuesList": ["string"
],
"valuesBlackList": ["string"
],
"defaultValue": "string",
"visible": true,
"dictDomain": "string",
"minValue": "string"
}
}
]
}

(New) Member attributes used in form.

Get list of attributes used in specific form and password restrictions

query Parameters

formType required	string Enum: "EN" "MM" Form type. EN - Enrollment form MM - Member Portal and Mobile App
type	string Enum: "ALL" "CUSTOM" "PREDEFINED" Attribute type. Default value is ALL
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.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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": [{"name": "string",
"code": "string",
"predefined": true,
"valueType": "S",
"valueTypeName": "string",
"acceptanceLevel": "string",
"acceptanceLevelName": "string",
"label": "string",
"tags": ["string"
],
"editable": true,
"order": 1,
"description": "string",
"formField": "string",
"constraints": {"attributeValidators": [{"regexp": "string",
"message": "string",
"key": "string"
}
],
"valuesList": ["string"
],
"valuesBlackList": ["string"
],
"defaultValue": "string",
"visible": true,
"dictDomain": "string",
"minValue": "string"
}
}
],
"passwordRestrictions": [{"regexp": "string",
"message": "string",
"key": "string"
}
],
"consents": {"gdpr": {"personalDataProcessing": {"description": "string",
"acceptanceLevel": "string",
"currentVersion": 0,
"acceptanceDeadline": "2019-08-24T14:15:22Z",
"label": "string",
"currentVersionContent": {"contentFormat": "PDF",
"content": "string",
"contentFile": "string"
}
},
"personalDataProfiling": {"description": "string",
"acceptanceLevel": "string",
"currentVersion": 0,
"acceptanceDeadline": "2019-08-24T14:15:22Z",
"label": "string",
"currentVersionContent": {"contentFormat": "PDF",
"content": "string",
"contentFile": "string"
}
}
},
"loyalty": {"termsAndConditions": {"description": "string",
"acceptanceLevel": "string",
"currentVersion": 0,
"acceptanceDeadline": "2019-08-24T14:15:22Z",
"label": "string",
"currentVersionContent": {"contentFormat": "PDF",
"content": "string",
"contentFile": "string"
}
},
"communications": {"description": "string",
"acceptanceLevel": "string",
"communicationChannels": [{"code": "string",
"name": "string"
}
]
},
"thirdPartyCommunications": {"description": "string",
"acceptanceLevel": "string",
"communicationChannels": [{"code": "string",
"name": "string"
}
]
},
"marketingCommunications": {"description": "string",
"acceptanceLevel": "string",
"communicationChannels": [{"code": "string",
"name": "string"
}
]
}
}
}
}

Get transaction domain attributes definitions

Get list of attribute's definitions used in transaction domain.
Sortable by [code, name].

Authorizations:

customer_password_scheme (b2c_api_gateway)

query Parameters

trnType	Array of strings Transaction types codes list. TRANSACTION_TYPES dictionary.
code	Array of strings Attribute definition codes list.
name	string Attribute definition 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.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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": [{"code": "string",
"name": "string",
"description": "string",
"constraints": {"valueType": "string",
"valuesList": ["string"
],
"valuesBlackList": ["string"
],
"defaultValue": "string",
"editable": true,
"acceptanceLevel": "string"
}
}
]
}

Get allowed member languages

Returns languages from the LANGUAGES dictionary of the MEMBER_LANGUAGES parameter.

query Parameters

filter	string Full text search query. Matches [code, value].
firstLetters	string Full text search query working in 'startsWith' mode. Matches [code, value].
itemCode	Array of strings Item code. For fetching particular languages.

header Parameters

Content-Type	string Request content type as MIME type. By default application/json, unless operation's request specification says otherwise.
Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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": [{"code": "string",
"value": "string",
"order": 0,
"description": "string",
"imageId": "string"
}
]
}

Branding

Within this API, you can get details of web portal and mobile app brandings, such as your colors and fonts.

Get member portal branding

Get branding details for member portal application

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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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": "s",
"typeName": "string",
"value": "string"
}
]

Get mobile app branding

Get branding details for mobile application

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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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": "s",
"typeName": "string",
"value": "string"
}
]

Content

The method allows you to receive information about mobile app content parameters and elements. Some of the components may be parametrized in the System by the business user, e.g., contact info, Enrollment form headers, and descriptions. Content may be provided in different languages (multi lang).

Get mobile application content parameter

Get content element for mobile application

path Parameters

parameterName

required

string

Mobile content parameter 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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). UTC timezone is assumed. Time zone is ignored if incorrect value is provided.
X-Tenant-ID	string <= 100 characters Tenant identifier. When not provided to the request, the default identifier will be used.

Responses

Response samples

Content type

application/json

{"name": "string",
"description": "string",
"value": "string"
}

Get list of content elements for mobile application

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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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": [{"name": "string",
"description": "string",
"value": "string"
}
]
}

Get web application content parameter

Get content element for web application

path Parameters

parameterName

required

string

Web content parameter 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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). UTC timezone is assumed. Time zone is ignored if incorrect value is provided.
X-Tenant-ID	string <= 100 characters Tenant identifier. When not provided to the request, the default identifier will be used.

Responses

Response samples

Content type

application/json

{"name": "string",
"description": "string",
"value": "string"
}

Get list of content elements for web application

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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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": [{"name": "string",
"description": "string",
"value": "string"
}
]
}

Messages

Keeping in touch with members is a key to creating a successful loyalty program. By selecting one of the available methods from this area, you can check how many messages have been sent to a specific member, the content, channel, and status of sent communication.

Get messages sent to member

Get list of messages sent to the member.
Sortable by [id, subject, sentDate, sentTo, status, channel, eventType].

Authorizations:

customer_password_scheme (b2c_api_gateway)

query Parameters

sentDateFrom	string <date> Message sent date - lower limit. Inclusive.
sentDateTo	string <date> Message sent date - upper limit. Inclusive.
sentTo	string Receiver
status	Array of strings Message statuses codes list. MESSAGE_STATUSES dictionary.
channel	Array of strings Message channels codes list. COMMUNICATION_CHANNELS dictionary.
eventType	Array of strings Event types codes list. CUSTOMER_NOTIFICATION_TYPES 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.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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": [{"id": 0,
"subject": "string",
"sentDate": "2019-08-24T14:15:22Z",
"sentTo": "string",
"channel": "s",
"channelName": "string",
"status": "s",
"statusName": "string",
"eventType": "ACCOUNT_TERMINATION",
"eventTypeName": "ACCOUNT_TERMINATION"
}
]
}

Get message sent to member

Get details of message sent to the member

Authorizations:

customer_password_scheme (b2c_api_gateway)

path Parameters

messageId

required

integer

Target message unique id

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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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,
"subject": "string",
"sentDate": "2019-08-24T14:15:22Z",
"sentTo": "string",
"channel": "s",
"channelName": "string",
"status": "s",
"statusName": "string",
"eventType": "ACCOUNT_TERMINATION",
"eventTypeName": "ACCOUNT_TERMINATION",
"format": "P",
"body": "string",
"bounceError": "string",
"bounceType": "S",
"bounceTypeName": "Soft",
"error": "string",
"action": "string",
"objectId": 0
}

Get member sent message attachments

Get list of sent message's attachments.

Authorizations:

customer_password_scheme (b2c_api_gateway)

path Parameters

messageId

required

integer

Target message unique id

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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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": [{"fileId": 0,
"name": "string",
"contentType": "string"
}
]
}

Get member sent message attachment

Get message attachment.

Authorizations:

customer_password_scheme (b2c_api_gateway)

path Parameters

messageId required	integer Target message unique id
attachmentId required	integer Attachment unique identifier

header Parameters

Accept	string Default: application/octet-stream Expected response 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.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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": [{"error": "CONSTRAINT_NOT_EMPTY",
"message": "Empty value not allowed",
"path": "arg1.address.street"
}
]
}

Get count of member sent messages

Get count of messages sent to the member

Authorizations:

customer_password_scheme (b2c_api_gateway)

query Parameters

status

Array of strings

Message statuses codes list. MESSAGE_STATUSES 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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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

{"messagesCount": 0
}

Open message asynchronously

Trigger open message operation.

Authorizations:

customer_password_scheme (b2c_api_gateway)

path Parameters

messageId

required

integer <int64>

Message unique ID.

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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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": [{"error": "CONSTRAINT_NOT_EMPTY",
"message": "Empty value not allowed",
"path": "arg1.address.street"
}
]
}

General Dictionaries

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

Get available dictionaries

List of available dictionaries

header Parameters

Content-Type	string Request content type as MIME type. By default application/json, unless operation's request specification says otherwise.
Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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": ["string"
]
}

Get dictionaries

Get list of dictionaries with dictionary items

query Parameters

dic

required

string

Dictionaries query in special format (examples below).

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

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

header Parameters

Content-Type	string Request content type as MIME type. By default application/json, unless operation's request specification says otherwise.
Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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": [{"code": "string",
"items": [{"code": "string",
"value": "string",
"order": 0,
"description": "string",
"imageId": "string"
}
]
}
]
}

Get dictionary by code

Returns dictionary items for the particular dictionary domain

path Parameters

dictionaryCode

required

string

Dictionary code, from response of GET /available-dictionaries

query Parameters

filter	string Full text search query. Matches [code, value].
firstLetters	string Full text search query working in 'startsWith' mode. Matches [code, value].
itemCode	Array of strings Item code. For fetching particular dictionary items.

header Parameters

Content-Type	string Request content type as MIME type. By default application/json, unless operation's request specification says otherwise.
Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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": [{"code": "string",
"value": "string",
"order": 0,
"description": "string",
"imageId": "string"
}
]
}

Files

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

Get binary file

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

path Parameters

fileId

required

string <= 99 characters

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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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": [{"error": "CONSTRAINT_NOT_EMPTY",
"message": "Empty value not allowed",
"path": "arg1.address.street"
}
]
}

Promotions

A method for receiving information about a member's progress is presented in a progress tracker form. Progress tracker for cumulative promotions may be configured by the business user.

Get member promotions

Get member's promotions marked as visible in mobile app/web portal.

Authorizations:

customer_password_scheme (b2c_api_gateway)

header Parameters

Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
Authorization	string Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation. Bearer token where token is authorization key granted to the client.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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": [{"code": "string",
"externalName": "string",
"externalDescription": "string",
"images": ["string"
],
"memberTriggerLimit": 0,
"conditionDetails": {"cumulativePeriodStartDate": "2019-08-24",
"cumulativePeriodEndDate": "2019-08-24",
"conditions": {"operator": "string",
"operatorName": "string",
"expressions": [{"conditionData": {"condition": {"conditionType": "string",
"conditionTypeName": "string",
"threshold": 0
},
"counterValue": 0
}
}
]
}
},
"issuanceModeDetails": {"issuanceMode": {"issuanceMode": "string",
"issuanceModeName": "string",
"issuanceModeValue": 0
},
"counterValue": 0
},
"progressTrackerDetails": {"startDate": "2019-08-24",
"endDate": "2019-08-24",
"progressTracker": {"operator": "string",
"operatorName": "string",
"conditions": [{"condition": {"conditionType": "string",
"conditionTypeName": "string",
"threshold": 0
},
"counterValue": 0
}
]
}
},
"triggeredForMember": 0,
"progressTrackerTypeIndicator": "string",
"stampsImageId": "string",
"order": 0
}
]
}

Member gets member configuration

There is no better way to promote a loyalty program than by allowing members to invite their friends and become your brand ambassadors. Thanks to these methods, you can receive detailed information about promotion for both an existing member and future members who will receive an invitation, such as description, validity dates, or additional terms and conditions.

GET active member gets member promotion for enrolling member

Returns information about active member gets member promotion for enrolling member

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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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": {"contentFormat": "PDF",
"content": "string",
"version": "string",
"contentFileId": "string"
}
}

GET active member gets member promotion for logged member

Returns information about active member gets member promotion for logged member

Authorizations:

customer_password_scheme (b2c_api_gateway)

header Parameters

Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
Authorization	string Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation. Bearer token where token is authorization key granted to the client.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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": {"contentFormat": "PDF",
"content": "string",
"version": "string",
"contentFileId": "string"
}
}

Member gets member

You can treat this method as a follow-up of a previous one; this method's main aim is to get a list of the invited members' list, so an existing member can check his progress and status of already sent invitations.

GET member gets member invited members list

Get member gets member invited members list

Authorizations:

customer_password_scheme (b2c_api_gateway)

header Parameters

Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
Authorization	string Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation. Bearer token where token is authorization key granted to the client.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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": [{"identifierNo": "string",
"email": "string",
"firstName": "string",
"phoneCountryPrefix": "string",
"mobilePhoneNumber": "string",
"enrollmentDate": "2019-08-24",
"invitingMemberExternalDescription": "string",
"promotionConditionsFulfilled": true
}
]
}

Identity providers

If you are going to use a single sign-on (SSO) to give members access to the loyalty program, we need to use your data as a trusted provider in this method.

Get identity provider configuration data

Get identity provider configuration data required for authorization request.

query Parameters

protocol required	string Value: "OIDC_1_0" Protocol used in the authorization process. OIDC_1_0 - OpenID Connect 1.0
profile required	string Value: "M" Profile used in the authorization process. M - Member
provider_code	string Identity provider configuration code. If not specified, default active configuration for certain protocol and profile domain will be used.

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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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

{"openIDConnect": {"authorizationRequestEndpointURL": "string",
"clientId": "string"
}
}

Merchant Service

This section is dedicated and valid only with LMC click and collect/pre ordering module. If you need to find information about anything that connects with stores, you should check the possibilities of this method. You can check information about location and products and their variants with it. You can also place, return and update orders of products in the click and collect model.

Returns list of locations

Authorizations:

customer_password_scheme (b2c_api_gateway)

query Parameters

page	integer Page number
size	integer Max number of elements per page

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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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,
"name": "string",
"code": "string",
"status": "string",
"address": {"houseNo": "string",
"postalCode": "string",
"phone": "string",
"street": "string",
"city": "string",
"email": "string",
"latitude": 0,
"longitude": 0
}
}
]

Returns single location result

Authorizations:

customer_password_scheme (b2c_api_gateway)

path Parameters

id

required

integer

Location ID

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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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,
"name": "string",
"code": "string",
"status": "string",
"address": {"houseNo": "string",
"postalCode": "string",
"phone": "string",
"street": "string",
"city": "string",
"email": "string",
"latitude": 0,
"longitude": 0
}
}

Returns pickup times for location

Authorizations:

customer_password_scheme (b2c_api_gateway)

path Parameters

id

required

integer

Location ID

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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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,
"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"capacity": 0
}
]

Returns single product category result

Authorizations:

customer_password_scheme (b2c_api_gateway)

path Parameters

id

required

integer

Product category ID

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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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,
"name": "string",
"code": "string",
"description": "string",
"externalCode": "string",
"shortDescription": "string",
"parentCategoryExternalCode": "string",
"imageUrl": "string"
}

Returns list of product categories

Authorizations:

customer_password_scheme (b2c_api_gateway)

query Parameters

locationId	integer Location id
page	integer Page number
size	integer Max number of elements per page

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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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,
"name": "string",
"code": "string",
"description": "string",
"externalCode": "string",
"shortDescription": "string",
"parentCategoryExternalCode": "string",
"imageUrl": "string"
}
]

Returns single product result

Authorizations:

customer_password_scheme (b2c_api_gateway)

path Parameters

id

required

integer

Product id

query Parameters

locationId

integer

Location id

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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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",
"categoryId": 0,
"description": "string",
"price": 0,
"secondPrice": 0,
"externalCode": "string",
"partnerCode": "string",
"restricted": true,
"quantity": 0,
"imageUrl": "string",
"available": true,
"temporaryBlocked": true,
"availableIngredients": [{"id": 0,
"name": "string",
"price": 0,
"includedFree": true,
"extra": true,
"available": true
}
],
"variants": [{"id": 0,
"name": "string",
"price": 0,
"secondPrice": 0,
"available": true
}
]
}

Returns single product ingredient result

Authorizations:

customer_password_scheme (b2c_api_gateway)

path Parameters

id

required

string

Product ingredient id

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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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,
"name": "string",
"price": 0,
"includedFree": true,
"extra": true,
"available": true
}

Returns single product variant result

Return single product variant result

Authorizations:

customer_password_scheme (b2c_api_gateway)

path Parameters

id

required

string

Product id

query Parameters

locationId

integer

Location id

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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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,
"name": "string",
"price": 0,
"secondPrice": 0,
"available": true
}

Returns list of products

Return list of products

Authorizations:

customer_password_scheme (b2c_api_gateway)

query Parameters

categoryId	integer Category ID
locationId	integer Location id
productIds	Array of integers Product IDs
page	integer Page number
size	integer Max number of elements per page

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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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",
"categoryId": 0,
"description": "string",
"price": 0,
"secondPrice": 0,
"externalCode": "string",
"partnerCode": "string",
"restricted": true,
"quantity": 0,
"imageUrl": "string",
"available": true,
"temporaryBlocked": true,
"availableIngredients": [{"id": 0,
"name": "string",
"price": 0,
"includedFree": true,
"extra": true,
"available": true
}
],
"variants": [{"id": 0,
"name": "string",
"price": 0,
"secondPrice": 0,
"available": true
}
]
}
]

Returns list of variants

Return list of variants

Authorizations:

customer_password_scheme (b2c_api_gateway)

query Parameters

page	integer Page number
size	integer Max number of elements per page

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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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,
"name": "string",
"price": 0,
"secondPrice": 0,
"available": true
}
]

Returns list of customers orders

Returns list of targeted orders

Authorizations:

customer_password_scheme (b2c_api_gateway)

path Parameters

customerId

required

integer

Customer id

query Parameters

id	integer Order id
customerId	integer Customer id - will always be set as in path variable
createDateFrom	string <date-time> Example: createDateFrom=2023-11-10T00:15:00.000+0000 Date from
createDateTo	string <date-time> Example: createDateTo=2023-11-10T00:15:00.000+0000 Date to
status	string (OrderStatus) Enum: "WF" "PF" "PC" "TB" "IP" "RB" "RT" "NP" "RE" "RI" "CO" "CB" "OC" Order status
locationId	integer Location id
cashierId	integer Cashier id
page	integer Page number
size	integer Max number of elements per page

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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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,
"customerId": 0,
"locationId": 0,
"createDate": "2019-08-24T14:15:22Z",
"orderStatus": "WF",
"orderStatusName": "WAITING_FOR_PAYMENT",
"pickupCode": "string",
"pickupPeriodStartDate": "2019-08-24T14:15:22Z",
"cashierId": 0,
"identifierNo": "string",
"discountValue": 0,
"totalValue": 0,
"rejectedReason": "CLOSING_EARLY",
"paymentStatus": "IN",
"paymentStatusName": "INCOMPLETE",
"paymentId": "string",
"cashierProvidedRejectionReason": "Bad customer",
"customerComment": "Bad cashier",
"orderItems": [{"id": 3202,
"orderId": 2672,
"productId": 7421,
"productVariantId": 1052,
"quantity": 2,
"price": 998,
"ingredients": [{"id": 1052,
"orderItemId": 2552,
"ingredientId": 7052,
"quantity": 2,
"price": 499,
"extra": true
}
]
}
],
"statusChangesList": [{"orderStatus": "WF",
"orderStatusName": "WAITING_FOR_PAYMENT",
"changeDate": "2019-08-24T14:15:22Z"
}
]
}
]

Creates initial order in system

Authorizations:

customer_password_scheme (b2c_api_gateway)

query Parameters

customerId

required

integer

CustomerId

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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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

locationId required	integer Location Id
customerComment	string Customer comment
pickupPeriodStartDate required	string <date-time> Pickup period
identifierNo	string <= 16 characters Card number
required	Array of objects (OrderItemAddDto)

Responses

Request samples

Payload

Content type

application/json

{"locationId": 9999,
"customerComment": "Bad cashier",
"pickupPeriodStartDate": "2019-08-24T14:15:22Z",
"identifierNo": "string",
"orderItems": [{"productId": 7421,
"productVariantId": 1052,
"quantity": 2,
"price": 998,
"ingredients": [{"ingredientId": 5201,
"price": 199,
"extra": true,
"quantity": 1
}
]
}
]
}

Response samples

Content type

application/json

{"id": 0,
"customerId": 0,
"locationId": 0,
"createDate": "2019-08-24T14:15:22Z",
"orderStatus": "WF",
"orderStatusName": "WAITING_FOR_PAYMENT",
"pickupCode": "string",
"pickupPeriodStartDate": "2019-08-24T14:15:22Z",
"cashierId": 0,
"identifierNo": "string",
"discountValue": 0,
"totalValue": 0,
"rejectedReason": "CLOSING_EARLY",
"paymentStatus": "IN",
"paymentStatusName": "INCOMPLETE",
"paymentId": "string",
"cashierProvidedRejectionReason": "Bad customer",
"customerComment": "Bad cashier",
"orderItems": [{"id": 3202,
"orderId": 2672,
"productId": 7421,
"productVariantId": 1052,
"quantity": 2,
"price": 998,
"ingredients": [{"id": 1052,
"orderItemId": 2552,
"ingredientId": 7052,
"quantity": 2,
"price": 499,
"extra": true
}
]
}
],
"statusChangesList": [{"orderStatus": "WF",
"orderStatusName": "WAITING_FOR_PAYMENT",
"changeDate": "2019-08-24T14:15:22Z"
}
]
}

Returns details of a sigle customers order

Returns details of a single customer order

Authorizations:

customer_password_scheme (b2c_api_gateway)

path Parameters

customerId required	integer Customer id
orderId required	integer Order id

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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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,
"customerId": 0,
"locationId": 0,
"createDate": "2019-08-24T14:15:22Z",
"orderStatus": "WF",
"orderStatusName": "WAITING_FOR_PAYMENT",
"pickupCode": "string",
"pickupPeriodStartDate": "2019-08-24T14:15:22Z",
"cashierId": 0,
"identifierNo": "string",
"discountValue": 0,
"totalValue": 0,
"rejectedReason": "CLOSING_EARLY",
"paymentStatus": "IN",
"paymentStatusName": "INCOMPLETE",
"paymentId": "string",
"cashierProvidedRejectionReason": "Bad customer",
"customerComment": "Bad cashier",
"orderItems": [{"id": 3202,
"orderId": 2672,
"productId": 7421,
"productVariantId": 1052,
"quantity": 2,
"price": 998,
"ingredients": [{"id": 1052,
"orderItemId": 2552,
"ingredientId": 7052,
"quantity": 2,
"price": 499,
"extra": true
}
]
}
],
"statusChangesList": [{"orderStatus": "WF",
"orderStatusName": "WAITING_FOR_PAYMENT",
"changeDate": "2019-08-24T14:15:22Z"
}
]
}

Updates order status

Authorizations:

customer_password_scheme (b2c_api_gateway)

path Parameters

customerId required	integer Customer id
orderId required	integer Order id

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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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

status required	string (OrderStatus) Enum: "WF" "PF" "PC" "TB" "IP" "RB" "RT" "NP" "RE" "RI" "CO" "CB" "OC" Order status code
paymentId	string Payment id
paymentStatus	string (PaymentStatus) Enum: "IN" "SU" "CN" "IA" "NO" "AU" "TO" "RF" "CF" "DE" "RE" "CH" "F" "CA" "CP" "DI" "DS" Payment status code
cashierId	integer Cashier id
rejectedReason	string (RejectionReason) Enum: "CLOSING_EARLY" "NO_ITEMS_IN_STOCK" "TECHNICAL_PROBLEM" "OTHER" Rejected reasons list
cashierProvidedRejectionReason	string Rejected reason provided by cashier

Responses

Request samples

Payload

Content type

application/json

{"status": "WF",
"paymentId": "string",
"paymentStatus": "IN",
"cashierId": 0,
"rejectedReason": "CLOSING_EARLY",
"cashierProvidedRejectionReason": "Bad customer"
}

Response samples

Content type

application/json

{"id": 0,
"customerId": 0,
"locationId": 0,
"createDate": "2019-08-24T14:15:22Z",
"orderStatus": "WF",
"orderStatusName": "WAITING_FOR_PAYMENT",
"pickupCode": "string",
"pickupPeriodStartDate": "2019-08-24T14:15:22Z",
"cashierId": 0,
"identifierNo": "string",
"discountValue": 0,
"totalValue": 0,
"rejectedReason": "CLOSING_EARLY",
"paymentStatus": "IN",
"paymentStatusName": "INCOMPLETE",
"paymentId": "string",
"cashierProvidedRejectionReason": "Bad customer",
"customerComment": "Bad cashier",
"orderItems": [{"id": 3202,
"orderId": 2672,
"productId": 7421,
"productVariantId": 1052,
"quantity": 2,
"price": 998,
"ingredients": [{"id": 1052,
"orderItemId": 2552,
"ingredientId": 7052,
"quantity": 2,
"price": 499,
"extra": true
}
]
}
],
"statusChangesList": [{"orderStatus": "WF",
"orderStatusName": "WAITING_FOR_PAYMENT",
"changeDate": "2019-08-24T14:15:22Z"
}
]
}

Mobile Payment Service

Merchant lists

Authorizations:

customer_password_scheme (b2c_api_gateway)

Responses

Response samples

200
400
401
500

Content type

application/json

[{"id": "string",
"name": "string",
"locations": [{"code": "string"
}
],
"merchantType": "STRIPE",
"publicKey": "string",
"environment": "string",
"isSubmerchant": true,
"masterMerchantId": "string",
"oneTimeUse": true,
"supportedTypes": ["CARD"
]
}
]

Get list of payments

Authorizations:

customer_password_scheme (b2c_api_gateway)

query Parameters

customerId	number >= 0 Customer id
id	string <= 255 characters Payment id
externalId	string <= 255 characters Payment ID from external system
externalName	string <= 255 characters Payment name from external system
paymentMethodId	string <= 255 characters Payment method id
amountMin	number [ 0 .. 99999999 ] Minimum amount of money. Has to be provided as an integer value (e.g. $5.00 as 500)
amountMax	number [ 0 .. 99999999 ] Maximum amount of money. Has to be provided as an integer value (e.g. $5.00 as 500)
currency	string <= 255 characters Currency of payment
createDateFrom	string <date-time> Example: createDateFrom=2019-07-22T07:02:34.510+00:00 Payment create date from (ISO 8601 datetime format)
createDateTo	string <date-time> Example: createDateTo=2019-07-22T07:02:34.510+00:00 Payment create date to (ISO 8601 datetime format)
updateDateFrom	string <date-time> Example: updateDateFrom=2019-07-22T07:02:34.510+00:00 Payment update date from (ISO 8601 datetime format)
updateDateTo	string <date-time> Example: updateDateTo=2019-07-22T07:02:34.510+00:00 Payment update date to (ISO 8601 datetime format)
confirmationDateFrom	string <date-time> Example: confirmationDateFrom=2019-07-22T07:02:34.510+00:00 Payment confirmation date from (ISO 8601 datetime format)
confirmationDateTo	string <date-time> Example: confirmationDateTo=2019-07-22T07:02:34.510+00:00 Payment confirmation date to (ISO 8601 datetime format)
cancelDateFrom	string <date-time> Example: cancelDateFrom=2019-07-22T07:02:34.510+00:00 Payment cancel date from (ISO 8601 datetime format)
cancelDateTo	string <date-time> Example: cancelDateTo=2019-07-22T07:02:34.510+00:00 Payment cancel date to (ISO 8601 datetime format)
declineDateFrom	string <date-time> Example: declineDateFrom=2019-07-22T07:02:34.510+00:00 Payment decline date from (ISO 8601 datetime format)
declineDateTo	string <date-time> Example: declineDateTo=2019-07-22T07:02:34.510+00:00 Payment decline date to (ISO 8601 datetime format)
status	string (ppm.PaymentStatus) Enum: "INCOMPLETE" "SUCCESS" "CANCELED" "CHARGING" "CAPTURING" "REFUNDING" "CANCELING" "IN_AUTHORIZATION" "NOT_AUTHORIZED" "AUTHORIZED" "TO_REFUND" "REFUNDED" "CAPTURE_FAILED" "DECLINED" "CHARGE_FAILED" "DISPUTING" "DISPUTED" Payment status
type	string (ppm.PaymentType) Enum: "CHARGE" "CAPTURE" "EXTERNAL" Payment type
location	string <= 255 characters Location of payment
merchantId	string <= 255 characters Merchant id
page	number Page number
size	number Max number of elements on one page
sort	string Sorting parameters. Payments can be sorted by createDate, updateDate, confirmationDate, cancelDate, declineDate, amount or status e.g. sort=amount,asc

Responses

Response samples

200
400
401
500

Content type

application/json

[{"id": "string",
"customerId": 1235901,
"externalName": "ex-name",
"externalId": "ex-id",
"paymentMethodId": "string",
"amount": 1000,
"amountToCapture": 1000,
"currency": "string",
"createDate": "2019-07-22T07:02:34.510+00:00",
"updateDate": "2019-07-22T07:02:34.510+00:00",
"confirmationDate": "2019-07-22T07:02:34.510+00:00",
"cancelDate": "2019-07-22T07:02:34.510+00:00",
"declineDate": "2019-07-22T07:02:34.510+00:00",
"type": "CHARGE",
"status": "INCOMPLETE",
"merchantId": "string",
"location": "string"
}
]

Create payment

Authorizations:

customer_password_scheme (b2c_api_gateway)

Request Body schema: application/json

customerId	number >= 0 Customer Id
externalId required	string [ 1 .. 255 ] characters External identifier
externalName required	string [ 1 .. 255 ] characters External name

Responses

Request samples

Payload

Content type

application/json

{"customerId": 2341,
"externalId": "ex-id",
"externalName": "ex-name"
}

Response samples

400
401
409
415
500

Content type

application/json

{"code": "string",
"message": "One or many argument are not valid",
"details": [{"field": "id",
"message": "must not be blank"
}
]
}

Get payment

Authorizations:

customer_password_scheme (b2c_api_gateway)

path Parameters

id

required

string

Payment id

Responses

Response samples

200
400
401
404
500

Content type

application/json

{"id": "string",
"customerId": 1235901,
"externalName": "ex-name",
"externalId": "ex-id",
"paymentMethodId": "string",
"amount": 1000,
"amountToCapture": 1000,
"currency": "string",
"createDate": "2019-07-22T07:02:34.510+00:00",
"updateDate": "2019-07-22T07:02:34.510+00:00",
"confirmationDate": "2019-07-22T07:02:34.510+00:00",
"cancelDate": "2019-07-22T07:02:34.510+00:00",
"declineDate": "2019-07-22T07:02:34.510+00:00",
"type": "CHARGE",
"status": "INCOMPLETE",
"declineReason": "EXPIRED_CARD",
"nextAction": {"type": "string",
"clientSecret": "string",
"url": "string",
"data": { }
},
"merchantId": "string",
"location": "string",
"refunds": [{"refundAmount": 0,
"status": "PROCESSING",
"createDate": "2019-07-22T07:02:34.510+00:00",
"succeedDate": "2019-07-22T07:02:34.510+00:00"
}
]
}

Update Payment

Authorizations:

customer_password_scheme (b2c_api_gateway)

path Parameters

id

required

string

Payment id

Request Body schema: application/json

amount	integer [ 1 .. 99999999 ] Amount of money. Has to be provided as an integer value (e.g. $5.00 as 500). Minimum and maximum payment values depend on payment provider (e.g. for Stripe minimum amount is $0.50 and maximum is $999,999.99 or approximate equivalents in different currencies)
currency	string 3 characters Currencies are identified by their ISO 4217 currency codes.

Responses

Request samples

Payload

Content type

application/json

{"amount": 1000,
"currency": "USD"
}

Response samples

400
401
404
415
500

Content type

application/json

{"code": "string",
"message": "string"
}

Charge payment

Authorizations:

customer_password_scheme (b2c_api_gateway)

path Parameters

id

required

string

Payment id

Request Body schema: application/json

paymentMethodId	string <= 255 characters Payment method id to be used for payment
amount required	number [ 1 .. 99999999 ] Amount of money. Has to be provided as an integer value (e.g. $5.00 as 500). Minimum and maximum payment values depend on payment provider (e.g. for Stripe minimum amount is $0.50 and maximum is $999,999.99 or approximate equivalents in different currencies)
currency required	string 3 characters Currencies are identified by their ISO 4217 currency codes.
location	string <= 255 characters Location of merchant
merchantId	string <= 255 characters Merchant id

Responses

Request samples

Payload

Content type

application/json

{"paymentMethodId": "string",
"amount": 1000,
"currency": "USD",
"location": "DEFAULT",
"merchantId": "DEFAULT"
}

Response samples

Content type

application/json

{"externalId": "string",
"externalName": "string",
"status": "INCOMPLETE"
}

Cancel payment (only if paymentStatus is equal to INCOMPLETE, AUTHORIZED or DECLINED)

Authorizations:

customer_password_scheme (b2c_api_gateway)

path Parameters

id

required

string

Payment id

Responses

Response samples

202
400
401
404
500

Content type

application/json

{"externalId": "string",
"externalName": "string",
"status": "INCOMPLETE"
}

Single payment method

Authorizations:

customer_password_scheme (b2c_api_gateway)

path Parameters

id

required

string

Payment method ID

Responses

Response samples

200
400
401
404
500

Content type

application/json

{"id": "string",
"createDate": "2019-07-22T07:02:34.510+00:00",
"updateDate": "2019-07-22T07:02:34.510+00:00",
"customerId": 0,
"merchantId": "string",
"type": "string",
"identifier": "string",
"last4": "string",
"expiresYear": 0,
"expiresMonth": 0,
"status": "ACTIVE",
"isDefault": true
}

Update payment method

Authorizations:

customer_password_scheme (b2c_api_gateway)

path Parameters

id

required

string

Payment method ID

Request Body schema: application/json

status	string Enum: "ACTIVE" "INACTIVE" Payment method status
isDefault	boolean Is payment method default for customer and merchant

Responses

Request samples

Payload

Content type

application/json

{"status": "ACTIVE",
"isDefault": true
}

Response samples

400
401
404
415
500

Content type

application/json

{"code": "string",
"message": "string"
}

Delete payment method

Authorizations:

customer_password_scheme (b2c_api_gateway)

path Parameters

id

required

string

Payment method ID

Responses

Response samples

400
401
404
500

Content type

application/json

{"code": "string",
"message": "One or many argument are not valid",
"details": [{"field": "id",
"message": "must not be blank"
}
]
}

Rankings

The methods allow getting a response regarding available member rankings with details such as name, validity, and number of active participants. In addition, it is also possible to get info about individual member scoring within the given ranking.

Get member rankings

Get all member rankings which are currently visible.

query Parameters

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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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": [{"code": "string",
"externalName": "string",
"externalDescription": "string",
"startDate": "2019-08-24",
"endDate": "2019-08-24",
"numberOfParticipants": 0,
"memberRankingScore": 0,
"memberRankingPosition": 0,
"imageId": "string"
}
]
}

Get member's ranking details

Get member's ranking details.

path Parameters

rankingCode

required

string [ 3 .. 15 ] characters

Target ranking 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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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",
"startDate": "2019-08-24",
"endDate": "2019-08-24",
"numberOfParticipants": 0,
"memberRankingScore": 0,
"memberRankingPosition": 0,
"imageId": "string",
"rankingOfParticipants": [{"memberRankingPosition": 0,
"memberIdentity": {"firstName": "string",
"lastName": "string",
"currentMember": true
},
"memberRankingScore": 0
}
]
}

Accruals & Returns

Upload invoice binary file

Upload invoice binary file into the system storage.

Authorizations:

customer_password_scheme (b2c_api_gateway)

header Parameters

Content-Type	string Default: multipart/form-data Value: "multipart/form-data" Content type as MIME type.
Authorization	string Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation. Bearer token where token is authorization key granted to the client.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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:

customer_password_scheme (b2c_api_gateway)

path Parameters

invoiceId

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.

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": [{"error": "CONSTRAINT_NOT_EMPTY",
"message": "Empty value not allowed",
"path": "arg1.address.street"
}
]
}

Process invoices

Process sale transaction on identifier level.
Accrues points basing on invoice files using optical character recognition.

Authorizations:

customer_password_scheme (b2c_api_gateway)

header Parameters

Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
Authorization	string Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation. Bearer token where token is authorization key granted to the client.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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

Payload

Content type

application/json

{"fileIds": ["string"
]
}

Response samples

Content type

application/json

{"transactionId": 0,
"status": "s",
"statusName": "string",
"orderId": 0,
"transactionPoints": {"basicPoints": 0,
"points": [{"pointType": "string",
"pointTypeName": "string",
"points": 0,
"pointsPromotions": [{"code": "string",
"externalName": "string",
"points": 0
}
]
}
]
},
"memberBalance": {"basicPoints": 0,
"points": [{"pointType": "string",
"pointTypeName": "string",
"points": 0
}
]
},
"incentiveValue": 0,
"productsDiscountValue": 0,
"billDiscountValue": 0,
"discountValue": 0,
"paymentValue": 0,
"payWithPointsDiscountValue": 0,
"messages": ["string"
],
"products": [{"code": "string",
"externalCode": "string",
"quantity": 0,
"discountValue": 0,
"paymentValue": 0,
"discountPromotions": [{"code": "string",
"externalName": "string",
"discountValue": 0
}
]
}
],
"billDiscountPromotions": [{"code": "string",
"externalName": "string",
"discountValue": 0
}
],
"issuedCoupons": [{"couponNumber": "string",
"couponTypeCode": "string",
"couponTypeName": "string",
"externalName": "string",
"externalDescription": "string",
"marketingText": "string",
"useQuantity": 0,
"validityPeriod": {"validityStartDate": "2019-08-24",
"expiryDate": "2019-08-24"
},
"fixedValueDiscount": 0.01,
"percent": 1,
"applicationRule": "U",
"visualModes": ["BC"
]
}
],
"burnedCoupons": [{"couponNumber": "string",
"couponTypeCode": "string",
"couponTypeName": "string",
"externalName": "string",
"externalDescription": "string",
"marketingText": "string",
"useQuantity": 0,
"validityPeriod": {"validityStartDate": "2019-08-24",
"expiryDate": "2019-08-24"
},
"fixedValueDiscount": 0.01,
"percent": 1,
"applicationRule": "U",
"useDetails": {"useResult": "s",
"useResultName": "string",
"status": "s",
"statusName": "string",
"burnQuantity": 0,
"refundQuantity": 0
}
}
],
"refundedCoupons": [{"couponNumber": "string",
"couponTypeCode": "string",
"couponTypeName": "string",
"externalName": "string",
"externalDescription": "string",
"marketingText": "string",
"useQuantity": 0,
"validityPeriod": {"validityStartDate": "2019-08-24",
"expiryDate": "2019-08-24"
},
"fixedValueDiscount": 0.01,
"percent": 1,
"applicationRule": "U",
"visualModes": ["BC"
],
"useDetails": {"status": "s",
"statusName": "string",
"burnQuantity": 0,
"refundQuantity": 0
}
}
]
}

OCR

Get OCR configurations

Get OCR configuration

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": [{"code": "string",
"status": "string",
"fileMaxSize": 0
}
]
}

Badge types

Get member badges

Get active member badges, grouped by category.
Categories are sorted by categoryExternalName.
By default badge types are sorted in the following order: achieved badges (from most recent ones), not achieved badges (from highest progress), badges with startDate in future. Next, they are sorted by externalName.

Authorizations:

customer_password_scheme (b2c_api_gateway)

query Parameters

progress

string

Current progress of badge for customer. BADGE_PROGRESSION_TYPES dictionary.

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: Date (time zone is taken from date format, related only to POST/PUT/PATCH requests). Header (time zone is taken from this header). DEFAULT_TIME_ZONE parameter (time zone is taken from the parameter). 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": [{"category": "string",
"categoryExternalName": "string",
"badgeTypes": {"code": "string",
"externalName": "string",
"startDate": "2019-08-24",
"resources": {"main": {"name": "string",
"fileId": "string"
},
"other": [{"name": "string",
"fileId": "string",
"channel": "W"
}
]
},
"achievedOn": "2019-08-24T14:15:22Z",
"progressPercent": 0
}
}
]
}

Get member badge

Get member badge details.

Authorizations:

customer_password_scheme (b2c_api_gateway)

path Parameters

badgeTypeCode

required

string >= 3 characters

Unique code identifying badge type. BADGE_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.
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

{"category": "string",
"categoryExternalName": "string",
"externalDescription": "string",
"conditions": [{"type": "s",
"counterValue": 0,
"threshold": 0,
"pointTypes": [{"code": "string",
"name": "string",
"counterValue": 0,
"threshold": 0
}
]
}
],
"endDate": "2019-08-24",
"code": "string",
"externalName": "string",
"startDate": "2019-08-24",
"resources": {"main": {"name": "string",
"fileId": "string"
},
"other": [{"name": "string",
"fileId": "string",
"channel": "W"
}
]
},
"achievedOn": "2019-08-24T14:15:22Z",
"progressPercent": 0
}

Get badge condition products

Get badge condition products details.

Authorizations:

customer_password_scheme (b2c_api_gateway)

path Parameters

badgeTypeCode

required

string >= 3 characters

Unique code identifying badge type. BADGE_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.
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

{"productCategories": [{"code": "string",
"name": "string",
"categoryPath": "string",
"products": [{"code": "string",
"name": "string",
"categoryPath": "string"
}
]
}
],
"products": [{"code": "string",
"name": "string",
"categoryPath": "string"
}
]
}

Pay at Pump Service

Initializes mobile pump transaction

Generates mobile transaction id

Authorizations:

customer_password_scheme (b2c_api_gateway)

Request Body schema: application/json

amount	integer <int64> (payAtPumpTypes.Amount) [ 0 .. 99999999 ] Total Transaction Amount (cents)
quantity	integer <int64> (payAtPumpTypes.Quantity) [ 0 .. 99999999 ] Total Transaction Quantity (multiplied by 100)
location required	string (payAtPumpTypes.LocationCode) <= 10 characters Location (station) code
currency required	string (payAtPumpTypes.Currency) Currency
pumpNumber required	integer <int32> (payAtPumpTypes.PumpNumber) Pump number
productCode	string (payAtPumpTypes.ProductCode) <= 30 product code
identifier required	string (payAtPumpTypes.Identifier) <= 30 Idientifer number
paymentMethodId	string (payAtPumpTypes.PaymentMethodId) Payment method id(UUID)
	Array of Array of objects (payAtPumpTypes.BurnCoupons) coupons
	object (payAtPumpTypes.DeviceInfo) device info, required if property transaction.deviceInfo.required enabled

Responses

Request samples

Payload

Content type

application/json

{"amount": 0,
"quantity": 0,
"location": "string",
"currency": "string",
"pumpNumber": 0,
"productCode": "string",
"identifier": "string",
"paymentMethodId": "string",
"coupons": [[{"code": "string",
"quantity": 0,
"type": "string"
}
]
],
"deviceInfo": {"acceptHeader": "string",
"locale": "string",
"timezoneOffsetUtcMinutes": 0,
"userAgent": "string",
"colorDepth": 0,
"javaEnabled": true,
"javaScriptEnabled": true,
"screenHeight": 0,
"screenWidth": 0
}
}

Response samples

Content type

application/json

{"mobileTransactionId": 0
}

Process mobile indoor transaction

Start indoor transaction process

Authorizations:

customer_password_scheme (b2c_api_gateway)

Request Body schema: application/json

paymentMethodId

string (payAtPumpTypes.PaymentMethodId)

Payment method id(UUID)

Responses

Request samples

Payload

Content type

application/json

{"paymentMethodId": "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": [{"error": "CONSTRAINT_NOT_EMPTY",
"message": "Empty value not allowed",
"path": "arg1.address.street"
}
]
}

Get mobile transactions

Authorizations:

customer_password_scheme (b2c_api_gateway)

query Parameters

status	string (payAtPumpTypes.Status) Search criteria
statuses	Array of strings (payAtPumpTypes.Status) Search criteria
processDateFrom	string <date> (payAtPumpTypes.Date) Search criteria
processDateTo	string <date> (payAtPumpTypes.Date) Search criteria
type	string (payAtPumpTypes.Type) Search criteria
identifierNo	string (payAtPumpTypes.IdentifierNo) Search criteria

Responses

Response samples

Content type

application/json

[{"mobileTransactionId": 0,
"loyaltyTransactionId": 0,
"mobileTransactionStatus": "string",
"processDate": "2019-08-24",
"amount": 0,
"quantity": 0,
"finaAmount": 0,
"location": "string",
"paymentStatus": "string",
"paymentRejectReason": "string",
"pumpStatus": "string",
"pumpRejectReason": "string"
}
]

Gets mobile transaction

Authorizations:

customer_password_scheme (b2c_api_gateway)

path Parameters

mobileTransactionId

required

number (payAtPumpTypes.MobileTransactionId)

Mobile Transaction id

Responses

Response samples

Content type

application/json

{"mobileTransactionId": 0,
"mobileTransactionStatus": "string",
"processDate": "2019-08-24",
"amount": 0,
"quantity": 0,
"finalAmount": 0,
"pumpNumber": 0,
"currency": "string",
"productCode": "string",
"location": "string",
"loyaltyTransactionId": 0,
"paymentId": "472e651e-5a1e-424d-8098-23858bf03ad7",
"paymentStatus": "string",
"paymentRejectReason": "string",
"pumpStatus": "string",
"pumpRejectReason": "string",
"paymentMethodId": "string",
"coupons": [[{"code": "string",
"quantity": 0,
"type": "string"
}
]
],
"products": [{"code": "string",
"plu": "string",
"description": "string",
"unitPrice": 0,
"quantity": 0,
"unitOfMeasure": "string",
"discountAllowed": true,
"totalAmount": 0,
"vatPercentage": 0,
"vatAmount": 0
}
],
"type": "PREPAYMENT"
}

Gets mobile transaction status

Authorizations:

customer_password_scheme (b2c_api_gateway)

path Parameters

mobileTrnId

required

integer

mobile transaction id

Responses

Response samples

Content type

application/json

{"mobileTransactionId": 0,
"mobileTransactionStatus": "string"
}

getTransactionReceipt

Authorizations:

customer_password_scheme (b2c_api_gateway)

path Parameters

mobileTrnId

required

integer <int64>

Responses

Response samples

Content type

application/json

{"amount": 0,
"currency": "string",
"quantity": 0,
"created": "2019-08-24T14:15:22Z",
"transactionId": 0,
"paymentType": "string",
"productCode": "string",
"productDescription": "string",
"vatAmount": 0,
"vatPercentage": 0,
"unitPrice": 0,
"unitOfMeasure": "string"
}

getConfigDefaultPreAuthAmountParam

Authorizations:

customer_password_scheme (b2c_api_gateway)

Responses

Response samples

Content type

application/json

{"enabled": true,
"value": 0
}

getConfigSingleModeParam

Authorizations:

customer_password_scheme (b2c_api_gateway)

Responses

Response samples

Content type

application/json

{"enabled": true
}

Surveys

Get available survey [DEPRECATED]

--operationStatus=DEPRECATED--
Please use Get available surveys list method instead.
Get available survey details. Returns first available survey.

Authorizations:

customer_password_scheme (b2c_api_gateway)

header Parameters

Content-Type	string Request content type as MIME type. By default application/json, unless operation's request specification says otherwise.
Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
Authorization	string Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation. Bearer token where token is authorization key granted to the client.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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

{"code": "string",
"status": "string",
"statusName": "string",
"endDate": "2019-08-24",
"externalName": {"0": "s",
"1": "t",
"2": "r",
"3": "i",
"4": "n",
"5": "g",
"value": "string",
"i18n": [{"langCode": "string",
"value": "string"
}
]
},
"externalDescription": "string",
"imageFileId": "string",
"questions": [{"questionId": 0,
"question": {"value": "string",
"i18n": [{"langCode": "string",
"value": "string"
}
]
},
"answers": [{"answerId": 0,
"answerI18N": "string"
}
]
}
],
"includedSegments": ["string"
],
"excludedSegments": ["string"
],
"pointsIncentives": [{"pointTypeCode": "string",
"name": "string",
"amount": 0,
"pointsExpirationPeriodExtension": true,
"pointsExpirationPeriodExtensionLength": 0,
"pointsExpirationPeriodExtensionUnit": "DAY"
}
],
"couponIncentives": [{"couponTypeCode": "string",
"name": "string",
"incentiveFixedValue": 0,
"incentivePercentValue": 0,
"repeatability": 0
}
]
}

Get available surveys list

Get list with available surveys.

Authorizations:

customer_password_scheme (b2c_api_gateway)

header Parameters

Content-Type	string Request content type as MIME type. By default application/json, unless operation's request specification says otherwise.
Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
Authorization	string Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation. Bearer token where token is authorization key granted to the client.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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": [{"code": "string",
"status": "string",
"statusName": "string",
"endDate": "2019-08-24",
"externalName": {"0": "s",
"1": "t",
"2": "r",
"3": "i",
"4": "n",
"5": "g",
"value": "string",
"i18n": [{"langCode": "string",
"value": "string"
}
]
},
"externalDescription": "string",
"imageFileId": "string",
"questions": [{"questionId": 0,
"question": {"value": "string",
"i18n": [{"langCode": "string",
"value": "string"
}
]
},
"answers": [{"answerId": 0,
"answerI18N": "string"
}
]
}
],
"includedSegments": ["string"
],
"excludedSegments": ["string"
],
"pointsIncentives": [{"pointTypeCode": "string",
"name": "string",
"amount": 0,
"pointsExpirationPeriodExtension": true,
"pointsExpirationPeriodExtensionLength": 0,
"pointsExpirationPeriodExtensionUnit": "DAY"
}
],
"couponIncentives": [{"couponTypeCode": "string",
"name": "string",
"incentiveFixedValue": 0,
"incentivePercentValue": 0,
"repeatability": 0
}
]
}
]
}

Submit survey

Submit survey.

Authorizations:

customer_password_scheme (b2c_api_gateway)

header Parameters

Content-Type	string Request content type as MIME type. By default application/json, unless operation's request specification says otherwise.
Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
Authorization	string Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation. Bearer token where token is authorization key granted to the client.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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

Array of objects (types.SurveySubmissionResult)

Survey submission result array.

Responses

Request samples

Payload

Content type

application/json

{"results": [{"questionId": 0,
"answerId": 0
}
]
}

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": [{"error": "CONSTRAINT_NOT_EMPTY",
"message": "Empty value not allowed",
"path": "arg1.address.street"
}
]
}

OTP tokens

Sends token to generator owner, the token will be available for use

Authorizations:

customer_password_scheme (b2c_api_gateway)

path Parameters

operationName

required

string

Indicates what operation token should be send for

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

notificationType	string code identifying notification type, combined with generator channel it identifies message template
	Array of objects (types.KeyValuePair) additional dynamic data used to fill the message template

Responses

Request samples

Payload

Content type

application/json

{"notificationType": "string",
"dataSource": [{"key": "string",
"value": "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": [{"error": "CONSTRAINT_NOT_EMPTY",
"message": "Empty value not allowed",
"path": "arg1.address.street"
}
]
}

OTP authorized devices

Get authorized devices fingerprints

Authorizations:

customer_password_scheme (b2c_api_gateway)

header Parameters

Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
Authorization	string Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation. Bearer token where token is authorization key granted to the client.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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": ["string"
]
}

Delete authorized device

Delete authorized device
If no fingerprint specified all owner devices will be deleted

Authorizations:

customer_password_scheme (b2c_api_gateway)

header Parameters

Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
Authorization	string Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation. Bearer token where token is authorization key granted to the client.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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

fingerprint

string <= 200 characters

device fingerprint (e.g. random UUID)

Responses

Request samples

Payload

Content type

application/json

{"fingerprint": "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": [{"error": "CONSTRAINT_NOT_EMPTY",
"message": "Empty value not allowed",
"path": "arg1.address.street"
}
]
}

OTP configuration

Retrieves information of all supported channels by OTP

Authorizations:

customer_password_scheme (b2c_api_gateway)

header Parameters

Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
Authorization	string Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation. Bearer token where token is authorization key granted to the client.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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": [{"channel": "string",
"defaultFlag": true
}
]
}

Retrieves information of owner supported channels by OTP

Authorizations:

customer_password_scheme (b2c_api_gateway)

header Parameters

Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
Authorization	string Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation. Bearer token where token is authorization key granted to the client.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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": [{"channel": "string",
"defaultFlag": true
}
]
}

Retrieves information about the OTP configuration

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.

Responses

Response samples

Content type

application/json

{"isOtpEnabledForEnrollment": true,
"tokenLength": 4
}

Payment Methods

List payment methods

Authorizations:

customer_password_scheme (b2c_api_gateway)

query Parameters

id	string Payment method id
customerId	number Customer id
merchantId	string Merchant id
createDateFrom	string <date-time> Example: createDateFrom=2019-07-22T07:02:34.510+00:00 Date from (ISO 8601 datetime format)
createDateTo	string <date-time> Example: createDateTo=2019-07-22T07:02:34.510+00:00 Date to (ISO 8601 datetime format)
status	string Enum: "ACTIVE" "INACTIVE" Example: status=ACTIVE Payment status

Responses

Response samples

200
400
401
500

Content type

application/json

[{"id": "string",
"createDate": "2019-07-22T07:02:34.510+00:00",
"customerId": 0,
"merchantId": "string",
"type": "string",
"identifier": "string",
"last4": "string",
"expiresYear": 0,
"expiresMonth": 0,
"status": "ACTIVE",
"isDefault": true
}
]

Add paymentMethod to customer

Authorizations:

customer_password_scheme (b2c_api_gateway)

Request Body schema: application/json

customerId required	number >= 0 Customer id
type required	string <= 255 characters card or payment_method (For braintree is only card).
providerMethodId required	string <= 255 characters Id payment method for payment provider
merchantId required	string <= 255 characters Merchant id
setAsDefault	boolean Implies if the payment method should be set as default. In case of adding the first payment method for the customer that value is overridden and set as true

Responses

Request samples

Payload

Content type

application/json

{"customerId": 5032,
"type": "card",
"providerMethodId": "tok_ee",
"merchantId": "DEFAULT",
"setAsDefault": true
}

Response samples

400
401
415
500

Content type

application/json

{"code": "string",
"message": "string"
}

Hosted Tokenization Pages

Create hosted tokenization page

Authorizations:

customer_password_scheme (b2c_api_gateway)

header Parameters

Accept-Language

required

string <string>

Request Body schema: application/json

merchantId

required

string <= 255 characters

Merchant id

Responses

Request samples

Payload

Content type

application/json

{"merchantId": "DEFAULT"
}

Response samples

201
400
401
415
500

Content type

application/json

{"hostUrl": "string",
"hostedTokenizationUrl": "string",
"hostedTokenizationId": "string",
"invalidTokens": ["string"
],
"expiredCardTokens": ["string"
]
}

Profile data promotions

Get profile data promotion list available for customer

Get list of profile data promotions available for customer.

Authorizations:

customer_password_scheme (b2c_api_gateway)

header Parameters

Content-Type	string Request content type as MIME type. By default application/json, unless operation's request specification says otherwise.
Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
Authorization	string Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation. Bearer token where token is authorization key granted to the client.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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": [{"code": "string",
"externalNameI18N": {"value": "string",
"i18n": [{"langCode": "string",
"value": "string"
}
]
},
"conditions": [{"attributeCode": "string",
"name": "string",
"type": "string"
}
]
}
]
}

Tenant settings

Get logo

Get logo.

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": [{"error": "CONSTRAINT_NOT_EMPTY",
"message": "Empty value not allowed",
"path": "arg1.address.street"
}
]
}

Get marketing banner

Authorizations:

customer_password_scheme (b2c_api_gateway)

header Parameters

Content-Type	string Request content type as MIME type. By default application/json, unless operation's request specification says otherwise.
Accept	string Specifies which content types, expressed as MIME types, are accepted by client. Server, using content negotiation, selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. Should be used only when operations specification states that it can handle multiple content types.
Accept-Language	string Example: pl, en-us Specifies the client proposed language of the response. If not provided or if system does not have requested language configured, system will return response in system's configured default language. Only the MultiLang strings will be translated, other will be returned as stored in the system.
Authorization	string Example: Bearer QWxhZGRpbjpPcGVuU2VzYW1l OAuth authorization header. Formatted according to OAUTH principles with Bearer Authentication Scheme. See Authorization documentation. Bearer token where token is authorization key granted to the client.
X-Correlation-ID	string <= 100 characters Unique request token for correlation purposes. When not provided to the request, assigned automatically by the system.
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

{"title": "string",
"subtitle": "string",
"description": "string",
"buttonLabel": "string",
"buttonAction": "string",
"image": "string"
}