BackOffice Admin
Welcome to CRM.COM Application Programming Interface (API) documentation
The CRM.COM API is designed around REST, allowing you to access and extend the software’s current functionality in a simple, programmatic way using intuitive URL endpoints, conventional HTTP requests, response codes, authentication and verbs.
Back-Office API is designed with a main focus on users and external systems that desire to access and extend the functionality found in CRM.COM.
For the Mobile/Web based Applications API please refer to the Self-Service API documentation that provides more details how to allow contacts to manage their subscription and/or reward accounts.
CRM.COM is built on a domain based micro-service architecture. Our primary resources such as Contact, Account, Wallet, Products and Subscriptions are all created with a unique identifier that uses a performant time based GUID. These are generated when a new resource such as a contact is created. However in some cases external integration may wish to use a unique identfier that is stored in an external system, such as a Bank CIF or Credit Card fingerprint.
Some systems allow from their create APIs to supply a unique identifier as part of the request body. CRM.COM has decided to provide an alternative approach and make an alternative unique identifier available on resources (e.g. on Contacts we provide the contact.code). If such attribute is specified during the create operation it wil be available on subsequent operations as a resource’s identifier, alongside with the GUID that is returned in the response body.
CRM.COM API is organized around REST. Our API has specific resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses and uses standard HTTP response codes, authentication & verbs.
You can use the entire API in test mode, which does not affect your live data. The API Key used to authenticate any of your requests will determine whether the request is on live mode or test mode.
The API may differ based on each CRM.COM release. For every new release with noticable changes that might alter backwards compatibility, a new version will be created.
CRM.COM Back-Office API uses either API Keys to authenticate requests or an authentication JWT token obtained from a user successful logging in.
All API requests must be made over HTTPS. Any request made over plain HTTP or without authentication will fail. In addition, API Keys carry many privileges, so be sure to keep them secure! Do not share your secret API Keys in publicly accessible areas, such as GitHub or client-side code.
API KEY AUTHORIZATION HEADER EXAMPLE
curl -X $HTTP_METHOD -H "api_key: 2189341e-981e-9ad5-9912-11101670314a"
AUTH TOKEN AUTHORIZATION HEADER EXAMPLE
curl -X $HTTP_METHOD -H "authorization: Bearer JWT_TOKEN"
API requests should be made using the HTTPS protocol so that traffic is encrypted. The interface responds to different methods depending on the action required.
| Method | Usage |
|---|---|
| POST | To create a new object, your request should specify the POST method. The POST request includes all of the attributes necessary to create a new object to the targeted endpoint. |
| PUT | To update the information on an existing object, the PUT method should be used. This will update the specified object if it is found using the provided values, regardless of their current values. If it is not found, the operation will return a response indicating that the object was not found. This idempotency means that you do not have to check for a resource’s availability prior to issuing an update command, the final state will be the same regardless of its existence. Requests using the PUT method do not need to check the current attributes of the object. |
| DELETE | To remove an existing object from your environment, the DELETE method should be used. Similar to PUT method, the DELETE method is idempotent. |
| GET | For retrieving information about customers, purchases or orders, the GET method should be used. Any requested information will be returned as a JSON object. The attributes defined by the JSON object can be used to form additional requests. Any request using the GET method is read-only and will not affect any of the retrieved objects. |
Along with the HTTP methods that the API responds to, CRM.COM uses conventional HTTP response codes and human-readable messages in JSON format to indicate the success or failure of an API request.
In the event of a problem, the status will contain the error code, while the body of the response will usually contain additional information about the problem that was encountered.
| HTTP Status | Description |
|---|---|
| 2XX | Return codes in the 200 range indicate that the request was fulfilled successfully and that no error was encountered. |
| 4XX | Return codes in the 400 range, typically, indicate that there was an issue with the request that was sent. Most common reasons could be an invalid authentication method, unauthorised requests or the object that you are requesting does not exist. |
| 5XX | Return codes in the 500 range indicate that there is a server-side problem and CRM.COM cannot fulfill your request at the moment. |
Most of our 4XX range errors that could be handled programmatically contain all the necessary details for a better integration handling. Such details are
- HTTP Status Code & Error are used for programmatic consumption
- Message is human-readable and can be used as a default error message
- Parameters are used for programmatic consumption and can be used for enhancing the interface error message with additional information
4XX ERROR RESPONSE EXAMPLE
An example of a customer not found error is as follows
HTTP/1.1 404 Not Found
{
"status": 404,
"message": "Record not found.",
"error": "CRM.EXCEPTIONS.NOTFOUNDEXCEPTION",
"parameters": [
"contact",
"789dacae-cf71-414f-9483-ca88acaa46432"
]
}
The request has succeeded
The request has succeeded
The input request was invalid or incorrect, often due to missing a required parameter
The client request has not been completed because it lacks valid authentication credentials for the requested resource
The API key or Token does not have permissions to perform the request
The requested resource does not exist
The server is unwilling to process a request because it may be replayed
The server encountered an unexpected condition which prevented it from fulfilling the request
The server received an invalid response from the upstream server it accessed in attempting to fulfill the request
The server is currently unable to handle the request due to a temporary overloading or maintenance
The server did not receive a timely response from the upstream server
The ledger of customer financial transactions such as invoices and payments. An account has a set currency and credit terms and outputs balances such as running balance, overdue amount and pending balance per accounting period. Many processes within CRM.COM are carried out against an account, such as placing an order or creating a subscription.
{id}{id}{id}/accounts{id}/accounts{id}/actions{id}Get a single Account with its financial information
Path variables
The unique identifier of the Account
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
OK
Body
The unique identifier of the account
The account’s name
The account’s number
Defines whether the account is the primary one of the contact
Contact is able to perform transactions
Contact blocked from ordering/purchases but still allowed to make Payments
Contact can no longer perform any kind of transactions using this account(financial, ordering, rewards etc)
The account’s running balance
The unpaid amount that is passed its due date
The account’s credit limit.
The account’s payment terms
Payment terms unique identifier
Payment terms nane
Details about the event classification
The classification identifier
The classification name
The id of the billing address
Address line 1
Address line 2
GET https://sandbox.crm.com/backoffice/v2/accounts/4dc0809f-ed91-4b68-b912-5bd6064d901e HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "AC00123456 John Smith",
"number": "AC00123456",
"is_primary": "true",
"state": "ACTIVE",
"currency_code": "EUR",
"balance": 99.99,
"overdue_amount": 9.99,
"credit_limit": 99.99,
"payment_terms": {
"id": "CAD1E31269B76D7A65ACCE45B2E68DFD",
"name": "Net 7"
},
"classification": {
"id": "c8d83493-3f50-40df-adb0-762ec5f41863",
"name": "Delivery Purchase"
},
"billing_address": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"address_line_1": "2265 Oak Street",
"address_line_2": "",
"state_province_county": "New York",
"town_city": "Old Forge",
"postal_code": "13420",
"country_code": "CYP"
}
}{id}Update the account of a contact or organisation. A single account can be updated per Web API call. Select to update at least one of the account’s basic attributes
Path variables
The account (identifier) that will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
If set to true, then this account will be set as the primary one, unmarking the previous account from being the primary.
The account’s classification identifier
The unique identifier of a contact address which will be set as the billing address of the account.
Sets the credit limit of the account. The credit limit is set in the account’s currency
Sets the Account’s Payment Terms.
Responses
The request has succeeded
Body
The account identifier
PUT https://sandbox.crm.com/backoffice/v2/accounts/a2c0809f-ed91-4b68-b912-5bd6064d602a HTTP/1.1
Content-Type: application/json
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
{
"is_primary": true,
"classification_id": "d230809f-ed91-4b68-b912-5bd6064d602a",
"billing_address_id": "a345fb9f-ed91-4b68-b912-5bd6064d602a",
"credit_limit": 20.99,
"payment_terms_id": "d230809f-ed91-4b68-b912-5bd6064d602a"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "d230809f-ed91-4b68-b912-5bd6064d602a"
}{id}/accountsGet a list of Contact Accounts. Normally a contact will have a single account but multiple accounts can be used to service different currencies. All accounts of the contact are retrieved by default, regardless of their state
Path variables
The contact identifier whose accounts will be retrieved
Request parameters
Defines on which attribute the results should be sorted
The page number that should be retrieved
The size (total records) of each page
Defines how the results will be ordered
If set to true, then only the primary account of the contact will get retrieved. If not specified, then all accounts are retrieved including terminated ones
Filter accounts based on whether they are Active, Suspended and or Terminated. If not specified then all contact accounts are retrieved, even terminated ones.
[
"ACTIVE"
]Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
OK
Body
The account identifier
Indicates if this is the primary account of the contact
The account name
The Account number. This is a unique number across all Accounts
Contact is able to perform transactions
Contact blocked from ordering/purchases but still allowed to make Payments
Contact can no longer perform any kind of transactions using this account(financial, ordering, rewards etc)
Details about the event classification
The classification identifier
The classification name
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/contacts/a2c0809f-ed91-4b68-b912-5bd6064d602a/accounts HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"is_primary": true,
"name": "AC123456 John Smith",
"number": "AC123456",
"state": "ACTIVE",
"currency_code": "EUR",
"classification": {
"id": "c8d83493-3f50-40df-adb0-762ec5f41863",
"name": "Delivery Purchase"
}
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}/accountsCreate a new Account for a contact. A contact can have multiple accounts, each one having a different currency. A contact can own a single primary account.
Path variables
The unique identifier of the contact for which the new account is created
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Mark the new account as the contact’s primary account. If contact has another account marked as the primary, then this setting will enforce the new account to be the primary, unmarking the other one from being the primary.
The account’s name. If not specified, then a name will be assigned by CRM.COM based on account name rules
The account’s classification. If not specified, then the default Classification is set
The unique identifier of a contact address which will be set as the billing address of the account.
Responses
Created
Body
The account identifier
POST https://sandbox.crm.com/backoffice/v2/contacts/3ec0809f-ed91-4458-b912-5bd6064dabf1/accounts HTTP/1.1
Content-Type: application/json
{
"is_primary": true,
"currency_code": "EUR",
"name": "John Smith Main account",
"classification_id": "a2c0809f-ed91-4b68-b912-5bd6064d602a",
"billing_address_id": "e230809f-ed91-4b68-b912-5bd6064d602a"
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "b4c0809f-ed91-4b68-b912-5bd60545902a"
}{id}/actionsUse this Web API to update the account’s state. The new state to which the account will be updated to also denotes the action performed on it, for example terminating or reactivating the account.
Path variables
The account identifier on which the action is performed
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Contact is able to perform transactions
Contact blocked from ordering/purchases but still allowed to make Payments
Contact can no longer perform any kind of transactions using this account(financial, ordering, rewards etc)
The account to which any account balance will get transfered, in case of Termination. Applicable and required when terminating the account. If not specified on terminating the account, the terminated account’s balance is lost
Responses
Successful Request
Body
The unique identifier of the account
POST https://sandbox.crm.com/backoffice/v2/accounts/1eaa809f-ed91-4b68-b912-5bd6064d3400/actions HTTP/1.1
Content-Type: application/json
{
"state": "ACTIVE",
"account_id": "2ee0809f-ed91-4b68-b912-5bd6064d602a"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "b560809f-ed91-4b68-b912-5bd6064d602a"
}{id}{id}{id}Create a new activity
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The activity name
The activity description
The activity type (identifier)
The contact address (identifier) associated to the activity
Use the entity address as the Activity address. In cases where an Activity is being created for an entity which has an address (e.g. Contact, Order, Service Request) then use that address as the default Activity address. Either the address_id or the use_entity_address can be specified, not both
The scheduled from date/time
The scheduled to date/time
The related entities for the activity. Contact should always be specified and optionally one of the the rest entities (orders, service requests, leadds) can be specified as well
[
{
"type": "ORDER",
"id": "50490788-0f2c-0a73-8ae0-1b129f8fdb50"
},
{
"type": "CONTACT",
"id": "50490788-0f2c-0a73-8ae0-1b129f8fdb50"
}
]The type of related entity.
The related entity identifier
The user identifier
The team identifier
The custom field’s unique key
The custom field’s value
Responses
The request has succeded
Body
The activity identifier
POST https://sandbox.crm.com/backoffice/v2/activities HTTP/1.1
Content-Type: application/json
{
"name": "Call customer",
"description": "We need to call the contact (after 4pm) in order to schedule a demo",
"type_id": "cdd8e232-ddce-87c0-44fd-27f44035a252",
"address_id": "4d1b276d-6ae9-eca3-8c61-aedd35ebb9a4",
"use_entity_address": "false",
"scheduled_on": {
"from_date": 1592809457,
"to_date": 11653396172
},
"linked_to": [
{
"type": "ORDER",
"id": "50490788-0f2c-0a73-8ae0-1b129f8fdb50"
}
],
"assign_to": {
"user_id": "1edef819-0a1d-4d41-9d2a-d4bbc2ddbedf",
"team_id": "a43f08ca-998b-afbc-6ed4-c9dc2d136935"
},
"custom_fields": [
{
"key": "back_office",
"value": "0001-12345"
}
]
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "81b8d150-1196-6e6a-1df9-aaf23adc757d"
}{id}Update an existing activity
Path variables
The activity (identifier) that will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The activity name
The activity description
The activity state
The contact address (identifier) associated to the activity
The scheduled from date/time
The scheduled to date/time
The related entities for the activity, contact cannot be updated
[
{
"type": "ORDER",
"id": "50490788-0f2c-0a73-8ae0-1b129f8fdb50"
}
]The type of related entity.
The related entity identifier
The user identifier
The team identifier
The custom field’s unique key
The custom field’s value
Responses
The request has succeded
Body
The activity identifier
PUT https://sandbox.crm.com/backoffice/v2/activities/43bf8b4a-6b7c-f86d-6faf-454b7e99a8e2 HTTP/1.1
Content-Type: application/json
{
"name": "Approve Offers",
"description": "Require 4 approvals for an offer",
"state": "CANCELLED",
"address_id": "6cbe314d-9f32-d3c7-4be6-f453e7b8e77e",
"scheduled_on": {
"from_date": 1592809457,
"to_date": 11653396172
},
"linked_to": [
{
"type": "ORDER",
"id": "50490788-0f2c-0a73-8ae0-1b129f8fdb50"
}
],
"assign_to": {
"user_id": "1edef819-0a1d-4d41-9d2a-d4bbc2ddbedf",
"team_id": "a43f08ca-998b-afbc-6ed4-c9dc2d136935"
},
"custom_fields": [
{
"key": "back_office",
"value": "0001-12345"
}
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "43bf8b4a-6b7c-f86d-6faf-454b7e99a8e2"
}{id}Delete an existing activity
Path variables
The activity (identifier) that will be deleted
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
DELETE https://sandbox.crm.com/backoffice/v2/activities/52cbb887-a61a-9b1e-63df-1303f7b5718a HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 204 No Content Retrieve a list of activities based on search criteria (e.g. all open activities)
Request parameters
Filter based on search values, such as name (behave as like)
Filter based on activity type(s)
Filter based on related contact
Filter based on related service request
Filter based on related lead
Filter based on related order
Filter based on activity state
Filter based on activity tags
Defines whether tags should be retrieved or not
Filter based on the created date, which may fall within a given date range. The value can be a string with a date in epoch format. Each option must also include an operator. Use up to two options based on the required search (e.g. created_on[gte]=1618395497&created_on[lt]=1618395497).
Returns results where the created date is greater than this value
Returns results where the created date is greater than or equal to this value
Returns results where the created date is less than this value
Returns results where the created date is less then or equal to this value
Filter based on the completed date, which may fall within a given date range. The value can be a string with a date in epoch format. Each option must also include an operator. Use up to two options based on the required search (e.g. completed_on[gte]=1618395497&completed_on[lt]=1667890564).
Returns results where the date is greater than this value
Returns results where the date is greater than or equal to this value
Returns results where the date is less than this value
Returns results where the date is less then or equal to this value
Filters based on specific assign to user
Filters based on specific assign to team
Filters based on custom fields (key/value set should be semicolon separated)
Defines whether custom fields should be retrieved or not (via List/Get APIs)
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeded
Body
The activity identifier
The activity name
The activity description
The activity state
The date that the activity was created
The date/time that the activity is scheduled
The scheduled from date
The scheduled to date
The activity type
The activity type identifier
The activity type name
The activity type color (hex code), used for visual purposes
Details about the related contact
The contact identifier
The contact full name
The contact unique code
The lead identifier
The lead title
The order identifier
The order number
Details about the user that the record is assigned to
The user identifier
The user name
The username of the user
Details about team
The team identifier
The team name
The custom field (unique) key
The custom field’s (provided) value
Tag unique id
Tag name
The colour of the tag - for list view only
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/activities/ HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "1cf0d458-b799-1d99-52e4-d7f5081b3c01",
"name": "Call customer",
"description": "We need to call the customer to arrange a demo",
"state": "CANCELLED",
"key_dates": {
"created_on": 1592809457,
"scheduled_on": {
"from_date": 1592809457,
"to_date": 1592809457
}
},
"type": {
"id": "HGJDHGSJDHG",
"name": "site visit",
"color": "876FD5"
},
"contact": {
"id": "1c060611-0667-313e-b3bf-4cb70ee81cdf",
"name": "John Doe",
"code": "C123"
},
"lead": {
"id": "2760043d-c671-a428-9b35-2f27b0623fa1",
"title": "ASOS"
},
"service_request": {
"id": "JHGHGF7576HGFTGD564654",
"number": "SRV78001"
},
"order": {
"id": "2760043d-c671-a428-9b35-2f27b0623fa1",
"number": "O101367"
},
"assign_to": {
"user": {
"id": "47ac694d-6281-b873-bf46-3fd8da334a3a",
"name": "John Doe",
"username": "j_doe@crm.com"
},
"team": {
"id": "bf1370a1-73ad-0bbf-6fef-f2ce1938d4fe",
"name": "Support"
}
},
"custom_fields": [
{
"key": "back_office",
"value": "Back Office"
}
],
"tags": {
"id": "609a369e-3f10-492a-8332-679ecbe56b65",
"name": "Maintenance",
"colour": "FR547F"
}
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Retrieve detailed information for an activity
Path variables
The activity (identifier) that will be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeded
Body
The activity identifier
The activity name
The activity description
The date that the activity was created
The date/time that the activity is scheduled
The scheduled from date
The scheduled to date
The activity type
The activity type identifier
The activity type name
The activity type color (hex code), used for visual purposes
Details about the related contact
The contact identifier
The contact full name
The contact unique code
The lead identifier
The lead title
The order identifier
The order number
The address line 1
The address line 2
The address state/province/county
The address town/city
The address postal code
The address country (based on ISO 3 char code)
The latitude of the address
The longitude of the address
The Google textual identifier that uniquely identifies an address
The activity states history
The activity state
The date on which the state was reached
Details about the user that the record is assigned to
The user identifier
The user name
The username of the user
Details about team
The team identifier
The team name
The custom field (unique) key
The custom field’s (provided) value
GET https://sandbox.crm.com/backoffice/v2/activities/6215f115-321a-c3d4-8809-59ca5f502433 HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "6215f115-321a-c3d4-8809-59ca5f502433",
"name": "Call customer",
"description": "Arrange a call with the customer after 4pm to schedule a demo for next week",
"key_dates": {
"created_on": 1592809457,
"scheduled_on": {
"from_date": 1592809457,
"to_date": 1592809457
}
},
"type": {
"id": "HGJDHGSJDHG",
"name": "site visit",
"color": "876FD5"
},
"contact": {
"id": "1c060611-0667-313e-b3bf-4cb70ee81cdf",
"name": "John Doe",
"code": "C123"
},
"service_request": {
"id": "JHGHGF7576HGFTGD564654",
"number": "SRV78001"
},
"lead": {
"id": "2760043d-c671-a428-9b35-2f27b0623fa1",
"title": "ASOS"
},
"order": {
"id": "2760043d-c671-a428-9b35-2f27b0623fa1",
"number": "O101367"
},
"address": {
"address_line_1": "Elia Papakyriakou",
"address_line_2": "7 Tower Stars",
"state_province_county": "Egkomi",
"town_city": "Nicosia",
"postal_code": "2015",
"country": "CYP",
"lat": 35.157115,
"lon": 33.313719,
"google_place_id": "ChIJrTLr-GyuEmsRBfy61i59si0"
},
"states": [
{
"state": "COMPLETED",
"date": 1653400142
}
],
"assign_to": {
"user": {
"id": "47ac694d-6281-b873-bf46-3fd8da334a3a",
"name": "John Doe",
"username": "j_doe@crm.com"
},
"team": {
"id": "bf1370a1-73ad-0bbf-6fef-f2ce1938d4fe",
"name": "Support"
}
},
"custom_fields": [
{
"key": "back_office",
"value": "Back Office"
}
]
}{id}/tags{id}/tags{id}/tagsUpdate the tags associated with the activity
Path variables
The activity (identifier) on which tags will be upaded
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The tags that will be associated with the activity
Responses
The request has succeded
Body
The activity identifier
PUT https://sandbox.crm.com/backoffice/v2/activities/d4187991-4d1a-4aa2-fa3e-ce5fe7fdb7d9/tags HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"tags": [
"96c3cb52-c68f-6ba6-e886-ed28f2b594cb"
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "d4187991-4d1a-4aa2-fa3e-ce5fe7fdb7d9"
}{id}/tagsRetrieve a list of tags that are associated with the activity
Path variables
The activity (identifier) of which tags will be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeded
Body
The tag identifier
The tag name
The tag color (hex code) that will be used for visual purposes
GET https://sandbox.crm.com/backoffice/v2/activities/d82881e9-a909-9d44-4f28-4b30fc1ac276/tags HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "1abe9097-d46a-d2ed-3415-fd3e1439d8d4",
"name": "VIP",
"colour": "#0000FF"
}
]
}{id}/analytics{id}/analytics{id}{id}/{id}{id}/events{id}/filters{id}/breakdowns{id}/results{id}/preview{id}/exportsCreate a new insight
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The insight name
The insight description
Responses
Body
The insight identifier
POST https://sandbox.crm.com/backoffice/v1/insights HTTP/1.1
Content-Type: application/json
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
{
"name": "Marketing customers",
"description": "A list of customers that own an account"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "c0d4712e-6688-4604-b3d6-d084e4d2dc05"
}{id}Updates the basic information of an insight
Path variables
The insight identifier that will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The insight name
The insight’s description
Responses
Body
The insight identifier
PUT https://sandbox.crm.com/backoffice/v1/insights/c0d4712e-6688-4604-b3d6-d084e4d2dc05 HTTP/1.1
Content-Type: application/json
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
{
"name": "Rewards Award",
"description": "List of contacts owning a non-terminated account",
"refresh_frequency": 1
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "c0d4712e-6688-4604-b3d6-d084e4d2dc05"
}{id}/Delete an existing insight
Path variables
The insight identifier that will be deleted
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
DELETE https://sandbox.crm.com/backoffice/v1/insights/c0d4712e-6688-4604-b3d6-d084e4d2dc05/ HTTP/1.1
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
HTTP/1.1 200 OK Returns a list of insights
Request parameters
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Search using Insights name
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
The insights unique identifier
The insight’s name
The insights’s description
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v1/insights HTTP/1.1
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "4AD9C84FA60F9FE407140E20F707726A",
"name": "Marketing customers",
"descripion": "List customers owning an account"
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Get all data for a single insight
Path variables
The insight identifier that will be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
The insight identifier
The insight name
The event identifier
["Costa Coffee Nicosia"]The filter identifier
The breakdown identifier
simple naming A, B, C used for ordering
GET https://sandbox.crm.com/backoffice/v1/insights/c0d4712e-6688-4604-b3d6-d084e4d2dc05 HTTP/1.1
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "c0d4712e-6688-4604-b3d6-d084e4d2dc05",
"name": "Rewards Award",
"events": [
{
"id": "c0d4712e-6688-4604-b3d6-d084e4d2dc05",
"name": "Purchases",
"event_name": "SPEND",
"totals": {
"is_frequency": true,
"property_name": "amount"
},
"criteria": [
{
"name": "A",
"property": {
"property": "venue.name",
"operator": "IS",
"value_list": [
"Costa Coffee Nicosia"
]
}
}
]
}
],
"filters": [
{
"id": "c0d4712e-6688-4604-b3d6-d084e4d2dc05",
"name": "",
"type": "CONTACT",
"property_name": "",
"operator": "NOT_EQUAL",
"min_value": "",
"max_value": "",
"value_list": [
""
]
}
],
"breakdowns": [
{
"id": "c0d4712e-6688-4604-b3d6-d084e4d2dc05",
"name": "",
"type": "CONTACT",
"property_name": "city"
}
]
}{id}/eventsAdds a set of events on an insight
Path variables
Request body
if the measurement is Freqency or Total of property
Name of the property to sum for a total or count frequency
List of selection operators
List of values if the operator is contains or single item if matching
Responses
POST https://sandbox.crm.com/backoffice/v1/insights/{id}/events HTTP/1.1
Content-Type: application/json
{
"events": [
{
"name": "Purchases",
"event_name": "SPEND",
"totals": {
"is_frequency": false,
"property_name": "amount"
},
"criteria": [
{
"name": "A",
"property": {
"property": "venue.name",
"operator": "IS",
"value_list": [
"Costa Coffee Nicosia"
]
}
}
]
}
]
}{id}/filtersAdds a set of filters on an insight
Path variables
Request body
Use Operator
Venue1,Venue2Responses
POST https://sandbox.crm.com/backoffice/v1/insights/{id}/filters HTTP/1.1
Content-Type: application/json
{
"filters": [
{
"name": "",
"type": "EVENT",
"property_name": "",
"operator": "IS_NOT",
"min_value": "",
"max_value": "",
"value_list": [
""
]
}
]
}
HTTP/1.1 201 Created {id}/breakdownsAdds a set of breakdowns on an insight
Path variables
The insight identifier which breakdown will be set
Request body
name of the property to create the breakdown
Responses
POST https://sandbox.crm.com/backoffice/v1/insights/{id}/breakdowns HTTP/1.1
Content-Type: application/json
{
"breakdowns": [
{
"name": "",
"type": "CONTACT",
"property_name": ""
}
]
}
HTTP/1.1 201 Created {id}/resultsRetrieve results of a specific insight
Path variables
The insight identifier which results will be retrieved
Request parameters
The start date of the insight sequence
The end date of the insight sequence
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
A temporary identifier to link child levels
The identifier of the previous level
The breakdown level 0 = EVENTS
The name of the property within the group
The value of the property
The name of the event
The number of points can be used for frequency
The decimal amounts for the level
Applicable only if the property is a list and represents the list name
GET https://sandbox.crm.com/backoffice/v1/insights/04f28639-5ceb-a25e-1e44-b1109e533f42/results HTTP/1.1
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"breakdown": {
"id": "bb686ff0-e7a4-a8a6-05a6-cfe8e39f675f",
"parent_id": "bb686ff0-e7a4-a8a6-05a6-cfe8e39f675f",
"level": 1,
"property_name": "venue.name",
"property_value": "Costa Coffee Larnaca",
"event_name": "",
"count": 1,
"amount": 12.8,
"list_name": "products"
}
}
]
}{id}/previewPreview the results of a specific insight
Path variables
The insight identifier which results will be previewed
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The start date of the insight sequence
The end date of the insight sequence
if the measurement is Freqency or Total of property
Name of the property to sum for a total or count frequency
List of selection operators
List of values if the operator is contains or single item if matching
Use Operator
Venue1,Venue2name of the property to create the breakdown
Responses
Body
A temporary identifier to link child levels
The identifier of the previous level
The breakdown level 0 = EVENTS
The name of the property within the group
The value of the property
The name of the event
The number of points can be used for frequency
The decimal amounts for the level
Applicable only if the property is a list and represents the list name
POST https://sandbox.crm.com/backoffice/v1/insights/62cb9ada-3a7b-cafb-b7a7-7c103011fa48/preview HTTP/1.1
Content-Type: application/json
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
{
"start_date": 1612953199,
"end_date": 1612953199,
"events": [
{
"name": "Purchases",
"event_name": "PURCHASE",
"totals": {
"is_frequency": true,
"property_name": ""
},
"criteria": [
{
"name": "A",
"property": {
"property": "venue.name",
"operator": "IS_NOT",
"value_list": [
""
]
}
}
]
}
],
"filters": [
{
"name": "",
"type": "CONTACT",
"property_name": "",
"operator": "DOES_NOT_CONTAIN",
"min_value": "",
"max_value": "",
"value_list": [
""
]
}
],
"breakdowns": [
{
"name": "",
"type": "CONTACT",
"property_name": ""
}
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"breakdown": {
"id": "bb686ff0-e7a4-a8a6-05a6-cfe8e39f675f",
"parent_id": "bb686ff0-e7a4-a8a6-05a6-cfe8e39f675f",
"level": 1,
"property_name": "venue.name",
"property_value": "Costa Coffee Larnaca",
"event_name": "",
"count": 1,
"amount": 12.8,
"list_name": "products"
}
}
]
}Get a list of distinct values for a contact or event property
Request parameters
Contact or Event collectioons
city
Responses
Body
Value of the property
GET https://sandbox.crm.com/backoffice/v1/distincts HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
[
{
"property_value": "London"
}
]{id}/exportsExport the results of a specific insight
Path variables
The insights (identifier) that will be exported
Request headers
Authorization Token
Request body
Defines what data should be exported from the related insight results
Export results in a tabular format, excluding underlying data
Export all underlying granular data that were used for this Insight
Defines the file format in which the exported data should be exported
CSV file
Responses
POST https://sandbox.crm.com/backoffice/v1/insights/efc5c8af-56ba-3d6f-d180-18be6dd04cc8/exports HTTP/1.1
Content-Type: application/json
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
{
"type": "UGD",
"format": "csv"
}
HTTP/1.1 200 OK CRM.COM provides a pre-defined list of Reports.
{name}/preview{name}{id}{id}{id}{name}/previewRuns the report in preview mode. The Web API returns a subset of the report’s results for preview purposes (max 10 records included in the response).
Path variables
The report (unique name) that will be previewed
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Set of filters based on which the report runs
The filter’s name
The filter’s value as this was specified by the user
Set of columns that will be included in the report’s preview. Up to 10 columns are included by default
Number, NameThe field’s key name
Responses
Body
List of fields and their values. Each object in this list represents a row in the report’s preview. Up to 10 records are returned
The field’s key
The key’s value
POST https://sandbox.crm.com/backoffice/v2/reports/contacts_summary/preview HTTP/1.1
Content-Type: application/json
{
"filters_set": [
{
"key": "period_from",
"value": "This month"
}
],
"columns_set": [
{
"key": "product_code"
}
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"fields": [
{
"key": "name",
"value": "Jane Smith"
}
]
}
]
}{name}Runs the requested report and sends an email to the User that ran it. User receives a link through which the report can be downloaded. The download link will be available for 2 days. The Report can also be scheduled via this Web API, i.e. schedule to run and send its results on a frequent basis.
Path variables
The report (unique name) that will be scheduled
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The report’s format
Set of filters based on which the report runs
[
{
"label": "Registration date",
"key": "period_from",
"value": "THIS_MONTH",
"type": "NUMBER"
}
]The filter’s label
The filter’s name
The filter’s value as this was specified by the user
The data type of the filter
Set of columns that will be included in the report
Number, NameThe ordering of the columns from left to right
The column’s label as this will be displayed on the report
The field’s name
The data type of the filter
Set of fields to be used to group the report’s results
The grouping’s ordering
The group by field’s label as this will be displayed on the report
The field’s name
The data type of the filter
Defines the report’s name (if not provided will be set based on the report’s unique name, e.g. Contacts Summary). Specify a meaningfull name if reprot is to be scheduled. This report name appears in the email’s subject.
Defines the scheduler settings that will send a report on a recurring basis (if not specified, report will be generated and send only once)
Defines the period when report generation will take place
The repeat frequency provided as a cron expression pattern
Defines the recipients that will receive the report results (if not specified, will be sent to the user that requested such report). Applicable only on scheduling the report.
The type of recipients that will retrieve the report
Applicable only to Business organisations
The recipients that will retrieve the report
Responses
Runs a report and sends its results via email to the user who runs it
POST https://sandbox.crm.com/backoffice/v2/reports/contacts_summary HTTP/1.1
Content-Type: application/json
{
"format": "PDF",
"filters_set": [
{
"label": "Registration date",
"key": "period_from",
"value": "THIS_MONTH",
"type": "TEXT"
}
],
"columns_set": [
{
"order": 1,
"label": "Code",
"key": "product_code",
"type": "TEXT"
}
],
"group_by_set": [
{
"order": 1,
"label": "Type",
"key": "product_type",
"type": "DATE"
}
]
}Schedule a report to be sent on a recurring basis and send to users of a specific team
POST https://sandbox.crm.com/backoffice/v2/reports/contacts_summary HTTP/1.1
Content-Type: application/json
{
"format": "CSV",
"filters_set": [
{
"label": "Registration date",
"key": "period_from",
"value": "THIS_MONTH",
"type": "INTEGER"
}
],
"columns_set": [
{
"order": 1,
"label": "Code",
"key": "product_code",
"type": "NUMBER"
}
],
"group_by_set": [
{
"order": 1,
"label": "Type",
"key": "product_type",
"type": "TEXT"
}
],
"name": "VIP Contacts",
"scheduler_options": {
"period": "WEEKLY",
"frequency": "0 0 12 * * ?"
},
"recipients": [
{
"type": "TEAM",
"id": "b52f4dbb-0ccf-db7a-93b6-2cc35af9fc39"
}
]
}{id}Update a Report’s scheduling options.
Path variables
The scheduled report’s identifier
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The report’s format
Defines the scheduler settings that will send a report on a recurring basis (if not specified, report will be generated and send only once)
Defines the period when report generation will take place
The repeat frequency provided as a cron expression pattern
Defines the recipients that will receive the report results. A scheduled reprot requires at least one recipient.
The type of recipients that will retrieve the report
Applicable only to Business organisations
The recipients that will retrieve the report
Responses
Body
The report identifier
PUT https://sandbox.crm.com/backoffice/v2/reports/81228876-09c6-cc46-638d-be2a7a6867bf HTTP/1.1
Content-Type: application/json
{
"format": "PDF",
"scheduler_options": {
"period": "WEEKLY",
"frequency": "0 0 12 * * ?"
},
"recipients": [
{
"type": "TEAM",
"id": "b52f4dbb-0ccf-db7a-93b6-2cc35af9fc39"
}
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "81228876-09c6-cc46-638d-be2a7a6867bf"
}{id}Deletes a scheduled report. The selected report will no longer be sent to any recipients.
Path variables
The schedulued report’s identifier
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
DELETE https://sandbox.crm.com/backoffice/v2/reports/1193d47e-f079-3f03-299b-50b7419459af HTTP/1.1
HTTP/1.1 204 No Content Retrieves a list of all scheduled reports
Request parameters
Filter based on report name
Filter based on report type
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
The type of the event
The scheduled report name
Defines the scheduler settings that will send a report on a recurring basis (if not specified, report will be generated and send only once)
Defines the period when report generation will take place
The repeat frequency provided as a cron expression pattern
The next scheduled period to run the report
Defines the recipients that will receive the report results
The type of recipients that will retrieve the report
Applicable only to Business organisations
The recipient name
The recipient username (applicable for recipients of type == USER)
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/reports HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"type": "organisations_rewards_analysis",
"name": "VIP Contacts",
"scheduler_options": {
"period": "WEEKLY",
"frequency": "0 0 12 * * ?",
"next_scheduled": 1639123750
},
"recipients": [
{
"type": "TEAM",
"name": "John Doe",
"username": "johndoe@crm.com"
}
]
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Get details for a specific scheduled report
Path variables
The scheduled report’s identifier that will be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
The (scheduled) report (identifier) that will be retrieved
The scheduled report name
The type of the event
The report’s format
Details about the filters based on which the report runs
The filter’s label
The filter’s name
The filter’s value as this was specified by the user
The data type of the filter
Details about the columns that will be included in the report
The ordering of the columns from left to right
The column’s label as this will be displayed on the report
The field’s name
The data type of the filter
Details about the fields to be used to group the report’s results
The grouping’s ordering
The group by field’s label as this will be displayed on the report
The field’s name
The data type of the filter
Defines the scheduler settings that will send a report on a recurring basis (if not specified, report will be generated and send only once)
Defines the period when report generation will take place
The repeat frequency provided as a cron expression pattern
The next scheduled period to run the report
Details about the recipients that will receive the report results
The type of recipients that will retrieve the report
Applicable only to Business organisations
The recipients that will retrieve the report
GET https://sandbox.crm.com/backoffice/v2/reports/df97fe77-84f0-d761-39d6-6d9e1ddf4962 HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "df97fe77-84f0-d761-39d6-6d9e1ddf4962",
"name": "VIP Contacts",
"type": "devices_summary",
"format": "PDF",
"filters_set": [
{
"label": "Registration date",
"key": "period_from",
"value": "THIS_MONTH",
"type": "INTEGER"
}
],
"columns_set": [
{
"order": 1,
"label": "Code",
"key": "product_code",
"type": "NUMBER"
}
],
"group_by_set": [
{
"order": 1,
"label": "Type",
"key": "product_type",
"type": "DATE"
}
],
"scheduler_options": {
"period": "WEEKLY",
"frequency": "0 0 12 * * ?",
"next_scheduled": 1639123750
},
"recipients": [
{
"recipient_type": "USER",
"recipient_id": "b52f4dbb-0ccf-db7a-93b6-2cc35af9fc39"
}
]
}{id}/analyticsGet analytics for an organisation
Path variables
The organisation identifier that is optionally a parent. If the organisation is a Parent an optional paramter can request children in the same response.
Request parameters
Which metrics are required. A list of metrics can be included in the request, comma separated. At least one must be specified.
Total Awarded Amount and Total Number of Awards and Previous Period Values
Total Spent Amount and Total Number of Spends and Previous Period Values
Frequency denotes which metric will be applied for example get the daily or monthly metrics
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
The number of contacts auth’d against a WiFi platform
The number of devices auth’d against a WiFi platform
Details about data allowance (data should be aggregated from child organisations as well)
The consumed data allownace
The remaining data allownace
The total data allownace (consumed + remaining)
Details about the top 10 organisations that allowance was consumed
The organisation identifier
The organisation name
The total allowance consumed on the organisation
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v1/organisations/babc8d45-50be-4259-b1bf-c85dee46642f/analytics HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "",
"organisation_id": "64824e45-ad64-40c5-9ef4-81cb4d88d9b5",
"organisation_name": "Subscription-Billing",
"merchants": 1,
"venues": 1,
"trials": 1,
"new_sign_ups": 1,
"referred_by": 1,
"reward_participants": 1,
"reward_participants_per_tier": 1,
"open_loop_reward_participants": 1,
"close_loop_reward_participants": 1,
"active_offers": 1,
"most_awarded_offer": "",
"total_awards": 1,
"total_spends": 1,
"given_awards": 1,
"awards_spend": 1,
"average_spend_per_visit": 1,
"top_10_best_offers": [
{
"offer_id": "034de72f-2006-4a80-ba49-13c4de5cc31b",
"offer_name": "Register to Sports channel and win 21 BDT",
"total_award_amount": 26.25
}
],
"total_purchase_amount": 1,
"total_visits": 1,
"most_visited_venues": "",
"total_applications_usage": 1,
"wallets_open_balance": 1,
"wallets_commerse_balance": 1,
"active_subscribers": 1,
"inactive_subscribers": 1,
"new_services": 1,
"cancelled_services": 1,
"regretted_services": 1,
"upgraded_services": 1,
"downgraded_services": true,
"services_in_trial": 1,
"deactivated_services": 1,
"activated_services": 1,
"paid_services_in_trial": 1,
"cancelled_services_in_trial": 1,
"new_subscribers": 1,
"reactivated_subscriptions": 1,
"removed_services_after_expiration": 1,
"cancelled_services_in_contract": 1,
"cancelled_services_not_in_contract": 1,
"renewed_services": 1,
"expired_services": 1,
"subscriber_churn_rate": 1,
"active_subscriptions_per_billing_period": 1,
"active_services_per_month": 1
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}/analyticsGet analytics for a contact
Path variables
The contact (identifier) of which analytics will be retrieved
Request parameters
Filters based on which metrics will be retrieved (a list of metrics can be included in the request, comma separated - and at least one metric should be specified)
Frequency denotes which metric will be applied for example get the daily or monthly metrics
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
Details about the contact
The contact identifier
The contact (full) name
Details about contact’s usage
The usage that is already consumed
The remaining usage that can be consumed
The percentage relation between consumed and allowed usage
GET https://sandbox.crm.com/backoffice/v1/contacts/babc8d45-50be-4259-b1bf-c85dee46642f/analytics?metrics=USAGE&frequency=OVERALL HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"contact": {
"id": "fa3360fa-a246-7d1e-1c41-eda3c093dcc9",
"name": "John R. Doe"
},
"usage": {
"consumed_usage": 20,
"remaining_usage": 80,
"usage_percentage": 20
}
}Create an upload signature for files
Notes
Integrating file upload for Service Requests should be based on the following APIs
- Upload File Signature
- Connect File to a “Module” Entity, such as Service Request Files
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
File contents provided via multipart/form-data
Responses
The request has succeeded
Body
The file identifier that will be used for connecting the file with a module
POST https://sandbox.crm.com/backoffice/v2/files HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"file": "file object"
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "7279fecf-b0a6-0aab-6bcd-37881fe8c10e"
}{id}Delete an existing file
Path variables
The file (identifier) to be deleted
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
DELETE https://sandbox.crm.com/backoffice/v2/files/5f21680e-2ce4-7b4b-7221-42cc2a41bc05 HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK {id}Retrieve a specific file
Path variables
The file (identifier) to be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The file identifier
The URL that can be used to access the actual content of the file
The mime type of the uploaded file
GET https://sandbox.crm.com/backoffice/v2/files/5f21680e-2ce4-7b4b-7221-42cc2a41bc05 HTTP/1.1
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "3ae9d64a-8a3b-f1e1-eed6-05b307f926fb",
"content_url": "crm.com/file",
"mime": "txt"
}{id}Create a new group for upcoming uploaded media
Notes
Uploading media for an entity requires the execution of the following APIs
- Create new Media Group
- Create “Module” Media Group, such as Product Media Groups
- Upload Media
- Perform Cloudinary Upload (where CRM will send all signature details)
- Cloudinary service calls back CRM media group (using an internal callback)
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The media group name
The media group description
The media group external identifier
Responses
The request has succeeded
Body
The media group identifier
POST https://sandbox.crm.com/backoffice/v1/media_groups HTTP/1.1
Content-Type: application/json
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
{
"name": "Marketing",
"description": "Marketing Media Group for Creatives",
"external_id": "747e5a96-24a2-7aca-7b28-da5e996ad54c"
}
HTTP/1.1 200 OK Create an upload media
Notes
Uploading media for an entity requires the execution of the following APIs
- Create new Media Group
- Create “Module” Media Group, such as Product Media Groups
- Upload Media
- Perform Cloudinary Upload (where CRM will send all signature details)
- Cloudinary service calls back CRM media group (using an internal callback)
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The media group (identifier) to associate the media item with once uploaded (external id is based on the response of Create new Media Group)
Information about the creative type
Partner logos configurable by SO, applicable for Business, Merchant, Venue
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
The related Cloudinary folder (within CRM the folder is set as the media related organisation-id)
The key to track upload (random UUID)
Responses
The request has succeeded
Body
The API key that is used for uploading media
The name of the cloudinary instance
The uploaded signature context
The uploaded signature value
The date/time on which such upload was made
Details about the upload options
The folder in which media will be uploaded (and located)
The media group external identifier
Information about the creative type
Partner logos configurable by SO, applicable for Business, Merchant, Venue
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Defines how media will be used
The option type (defaults to upload)
Details that will be used in the signature
The folder in which media will be uploaded (and located)
Defines what action will be performed on the media (always is set to “upload”)
The key to track the current upload
POST https://sandbox.crm.com/backoffice/v2/media HTTP/1.1
Content-Type: application/json
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
{
"media_group_external_id": "e66896ba-db0a-41e2-8093-9aca2ae02f29",
"media_usage_type": "LOGO",
"folder": "offers/hero",
"tracking_key": "26c32dfe-f8ea-9cf3-a5af-5096be4a164b"
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"api_key": "698271538719998",
"cloud_name": "crm-com",
"context": "uploadStrategy=MEDIA_UPLOAD|organisationId=8062c26a-c05f-47ca-81e4-566b3c279320|trackingKey=e3ffca89-902f-4bd6-b503-c7dcf59dd725|mediaGroupExternalId=1d7b73d2-a324-4cee-a97a-492050b101ef|usageType=ATTACHMENT",
"signature": "8f38472a40d8466f11852bd9d3a19c23bfe12f91",
"timestamp": 1616056261,
"upload_options": [
{
"folder": "35d7d0a4-9846-73a7-8707-26d2507edc51",
"media_group_external_id": "35d7d0a4-9846-73a7-8707-26d2507edc51",
"media_usage_type": "MARKETING",
"options": {
"type": "upload"
},
"needed_signature_options": {
"folder": "6ff2469c-e473-e370-c86e-16633434607a",
"type": "upload"
},
"tracking_key": "6ff2469c-e473-e370-c86e-16633434607a"
}
]
}Create an upload signature
Notes
Uploading media into CRM is made based on the following flow & API calls
- Create new Media Group
- Create “Module” Media Group, such as Product Media Groups
- Upload Media
- Perform Cloudinary Upload (where CRM will send all signature details)
- Cloudinary service calls back CRM media group (using an internal callback)
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The media group (identifier) to associate the media item with once uploaded (external id is based on the response of Create new Media Group)
Information about the creative type
Partner logos configurable by SO, applicable for Business, Merchant, Venue
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
The related Cloudinary folder (within CRM the folder is set as the media related organisation-id)
The key to track upload (random UUID)
Responses
The request has succeeded
Body
The API key that is used for uploading media
The name of the cloudinary instance
The uploaded signature context
The uploaded signature value
The date/time on which such upload was made
Details about the upload options
The folder in which media will be uploaded (and located)
The media group external identifier
Information about the creative type
Partner logos configurable by SO, applicable for Business, Merchant, Venue
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
The option type
The key to track the current upload
POST https://sandbox.crm.com/backoffice/v2/signature HTTP/1.1
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
Content-Type: application/json
{
"media_group_external_id": "e66896ba-db0a-41e2-8093-9aca2ae02f29",
"media_usage_type": "APPLE_LOCKSCREEN_ICON",
"folder": "offers/hero",
"tracking_key": "26c32dfe-f8ea-9cf3-a5af-5096be4a164b"
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"api_key": "698271538719998",
"cloud_name": "crm-com",
"context": "uploadStrategy=MEDIA_UPLOAD|organisationId=8062c26a-c05f-47ca-81e4-566b3c279320|trackingKey=e3ffca89-902f-4bd6-b503-c7dcf59dd725|mediaGroupExternalId=1d7b73d2-a324-4cee-a97a-492050b101ef|usageType=ATTACHMENT",
"signature": "8f38472a40d8466f11852bd9d3a19c23bfe12f91",
"timestamp": 1616056261,
"upload_options": [
{
"folder": "35d7d0a4-9846-73a7-8707-26d2507edc51",
"media_group_external_id": "35d7d0a4-9846-73a7-8707-26d2507edc51",
"media_usage_type": "APPLE_LOCKSCREEN_ICON",
"options": {
"type": "upload"
},
"needed_signature_options": {
"folder": "6ff2469c-e473-e370-c86e-16633434607a",
"type": "upload"
},
"tracking_key": "6ff2469c-e473-e370-c86e-16633434607a"
}
]
}{id}Delete an existing media
Path variables
The media (identifier) that will be deleted
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
DELETE https://sandbox.crm.com/backoffice/v2/media/5f21680e-2ce4-7b4b-7221-42cc2a41bc05 HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 204 No Content Approval is a type of workflow which comprises a series of steps that an event must pass in order to be approved. A request for approval prevents a specific record from further amendment or process unless it is approved by a number of authorised user(s) or contact. Approval requests are created when an automation is triggered and can be processed (approved/rejected) by an authorised user or by a contact.
{id}/actions{token}Retrieve a list of approval requests based on search criteria (e.g. all pending approval requests)
Request parameters
Filter based on search value (case insensitive) across entity and entity reference
Filter based on approval request state
Filter based on automations that triggered such request (applicable only when org_requests is set to NETWORK_REQUESTS)
Filter based on a single user that is authorised to approve/reject such request
Filter based on a single contact that is authorised to approve/reject such request
Filter based on the condition type that are authorised to approve/reject such requests
Filter based on the entity (contact/user) that requested such approval
Filter based on the entity type that such requests are applied to
Filter based on entity record that such request is applied to
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The approval request identifier
The approval request state
Details about the entity that an approval request was applied to
The entity identifier
The approval entity type
The entity reference name/code/number
Details about the automation
The automation identifer
The automation name
Details about approval requests responses
The authorised user/contact response message on this request
The response state
Details about the person (user/contact) who approved/rejected such request
The authorised person identifier
The authorised person full name
The authorised type of person
The date/time when such request was approvded/rejected
Details about the authorised by type who can approve/reject such requests
The authorised condition identifier
The authorised condition name (e.g. contact full name, user role name)
The authorised condition type
The date that the approval was requested
Defines how many should approve/reject the approval
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v1/approval_requests HTTP/1.1
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "CEEE83D6E0804A30966F684B0269AD91",
"state": "APPROVED",
"description": "The award of the offer has been changed to 100% from what it was 50%",
"response": "Approved",
"authorised_by": {
"id": "23490b97-dd93-3eb4-c3bc-e6828e12e2c1",
"name": "John Doe",
"type": "USER"
},
"authorised_on": 1611930210,
"automations": {
"id": "cf010c72-a2cb-48f8-a9fa-1ed99c8d6ec0",
"name": "Request approval on newly activated offers"
},
"entity": {
"id": "cf010c72-a2cb-48f8-a9fa-1ed99c8d6ec0",
"type": "REWARD_OFFER",
"reference": "5% discount"
},
"authorised_conditions": [
{
"id": "18eb40c8-ba71-fa51-9de7-5b7017962ccf",
"name": "John Doe",
"type": "USER"
}
]
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}/actionsPerform actions on existing approval requests (e.g. approve a request)
Path variables
The approval request (identifier) that will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The approval request state that will be changed to
The reason why the approval request was approved or rejected
Responses
The request has succeeded
Body
The approval request identifier
PUT https://sandbox.crm.com/backoffice/v2/approval_requests/23cf989a-47b5-6019-d0c9-b4a50a13f847/actions HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"state": "REJECTED",
"response": "Award cannot be 100%"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "23cf989a-47b5-6019-d0c9-b4a50a13f847"
}{token}Accept or reject a pending approval request (using an action link send via a communication)
Path variables
The token that will verify that the client is trusted and will approve/reject the related request
Responses
The request has succeeded
Body
An HTML based landing page is returned and rendered
Retrieve a list of pending approval requests based on search criteria that the signed-in user is authorised to approve/reject (e.g. all pending reward offer approval requests)
Request parameters
Filter based on search value (case insensitive) across entity and entity reference
Filter based on entity type that such requests are applied to
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
Responses
The request has succeeded
Body
The approval request identifier
The date that the approval was requested
Details about the entity that an approval request was applied to
The entity identifier
The approval entity type
The entity reference name/code/number
Details about the automation
The automation identifer
The automation name
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v1/approval_requests/my_pending_approvals HTTP/1.1
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "CEEE83D6E0804A30966F684B0269AD91",
"entity": {
"id": "cf010c72-a2cb-48f8-a9fa-1ed99c8d6ec0",
"type": "SERVICE_REQUEST",
"reference": "CO1234"
},
"automations": {
"id": "cf010c72-a2cb-48f8-a9fa-1ed99c8d6ec0",
"name": "Request approval on newly activated offers"
},
"created_date": 1642508197
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}Retrieve a list of approvals based on search criteria that were requested by the signed-in user (e.g. all pending approvals)
Request parameters
The value of the search (case insensitive) across entity and entity reference
Filter based on approval request state
Filter based on the entity type that such requests are applied to
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
Responses
The request has succeeded
Body
The approval request identifier
The approval request state
The date that the approval was requested
Defines how many should approve/reject the approval
Details about the entity that an approval request was applied to
The entity identifier
The approval entity type
The entity reference name/code/number
Details about the automation
The automation identifer
The automation name
Details about approval requests responses
[
{
"message": "This is a response message",
"state": "APPROVED",
"authorised_by": {
"id": "23490b97-dd93-3eb4-c3bc-e6828e12e2c1",
"name": "John Doe",
"type": "USER"
},
"authorised_on": 1611930210
}
]The authorised user/contact response message on this request
The response state
Details about the person (user/contact) who approved/rejected such request
The authorised person identifier
The authorised person full name
The authorised type of person
The date/time when such request was approvded/rejected
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v1/approval_requests/my_requests HTTP/1.1
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "CEEE83D6E0804A30966F684B0269AD91",
"state": "APPROVED",
"entity": {
"id": "cf010c72-a2cb-48f8-a9fa-1ed99c8d6ec0",
"type": "ORDER",
"reference": "CO1234"
},
"automations": {
"id": "cf010c72-a2cb-48f8-a9fa-1ed99c8d6ec0",
"name": "Request approval on newly activated offers"
},
"responses": [
{
"message": "This is a response message",
"state": "APPROVED",
"authorised_by": {
"id": "23490b97-dd93-3eb4-c3bc-e6828e12e2c1",
"name": "John Doe",
"type": "USER"
},
"authorised_on": 1611930210
}
],
"created_date": 1642508197,
"pending_requests": 2
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}An automation is a predefined sequence of steps that allow a business to automate repeatable tasks that are required to carry its operations. An automation starts with an event trigger (an action within CRM.COM, such as contact registration, award contact) and is completed with a series of actions via internal and/or external adaptors (e.g. send contacts an outbound email communication) executed in the sequential order defined.
Each adaptor is designed to carry out a specific business action (e.g. Mailchimp to send an email to a contact; or the CRM.COM assignment adaptor to fulfil an order by a venue).
{id}{id}{id}Create a new automation
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The automation name
The automation description
The automation state
Defines the entity that its events will trigger this automation
Defines the event that will trigger this automation (filtered based on the selected entity)
Approvals
Approvals
Contacts
Contacts
Contacts
Contacts
Contacts
Contacts & Users
Orders
Orders
Orders
Orders
Passes
Passes
Rewards
Rewards
Rewards
Reward Offers
Reward Schemes
Service Requests
Organisations
Organisations
Users
Users
Products
Financial Transactions
Financial Transactions
Financial Transactions
Financial Transactions
Financial Transactions
Customer Events
Customer Events
Customer Events
Subscriptions
Subscriptions
Subscriptions
Subscriptions
Subscriptions
Subscriptions
Subscriptions
Subscriptions
Subscriptions
Subscriptions
Subscriptions
Subscriptions
Subscriptions
Subscriptions
Subscriptions
Subscriptions
Subscriptions
Usage
Usage
Orders
Orders
Service Requests
Service Requests
Service Requests
Service Requests
Service Requests
Service Requests
Service Requests
Activities
Activities
Activities
Products
Products
Financial Transactions
Financial Transactions
Orders
Financial Transactions
The automation actions (adaptors and filters) that will be performed
The automation action
The automation action order
Details about adaptor (and its action/parameters)
The automation adaptor
Activity Provision
Approval Requests
Automatic Content Updates
Communications
Customer Event Provision
Order Provision
Order Provision
Service Request Provision
Webhooks
MICROS Simphony Order Provision
NCR Aloha Order Provision
Twinsoft Order Provision
The automation adaptor action (each action is applicable for specific adaptors)
Request User Appoval
Request Contact Appoval
Update Content
Communicate Contact
Communicate User
Assign to a specific user
Fulfilled By specific organisation
Assign to specific team adaptor)
Fulfilled by nearest location
Fulfilled based on postal code
Post Webhook
Put Webhook
Assign to user of a specific team
Assign to user of a specific user role
Fulfilled by a user of a specific user role
Fulfilled by a specific user
Provision (create) order to Simphony POS
Provision (create) order to Aloha POS
Provision (void) order to Aloha POS
Create a purchase event
Cancel a purchase event
Webhooks
Schedule an activity
Provision (create) order to Twinsoft POS
Provision (print receipt) order to an external POS based on IP and port
Create an achievement event
Details about the adaptor’s actions parameters
The parameter identifier
The parameter type
The parameter group (used when more than one parameters should be specified for an adaptor’s action)
The parameter key
The parameter from value
The parameter to value
Details about the filters to be applied (required when type is based on Filter)
Details about applicable filter attributes
The filter identiifer
The attribute that its value will be compared based on the related operator
The type of the key
The filter operator to compare the attribute actual value with the filtered one
Applicable for type of number/integer/date
Applicable for type of string
Applicable for type of number/integer/date
Applicable for type of number/integer/date
Applicable for type of number/integer/date
Applicable for type of number/integer/date
The attribute value to apply the filter condition (either value or value_list should be specified)
The supported list of values (either value or value_list should be specified)
The custom field that its value will be compared based on the related operator
Responses
The request has succeeded
Body
The automation identifier
POST https://sandbox.crm.com/backoffice/v2/automations HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"name": "Communicate contact on service request",
"description": "actions on new service request",
"state": "INACTIVE",
"entity": "ORGANISATIONS",
"event": "NEW_ORDER",
"actions": [
{
"order": 1,
"adaptor": {
"adaptor": "APPROVAL_REQUESTS",
"action": "FF_BY_USER_OF_SPEC_USER_ROLE",
"parameters": [
{
"id": "4b8e0ae7-0f8a-4313-a1fd-ecc1c0510f55",
"type": "INTEGER",
"group": "1",
"key": "FULFILL_ORDER_DISTANCE",
"from_value": "123",
"to_value": "1234"
}
]
}
}
]
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "c69b54fc-644b-1dc9-65b2-f0b3672cf46e"
}{id}Update an existing automation
Path variables
The automation (identifier) that will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The automation name
The automation description
The automation state
The automation actions (adaptors and filters) that will be performed
The automation action
The automation action order
Details about adaptor (and its action/parameters)
The automation adaptor
Activity Provision
Approval Requests
Automatic Content Updates
Communications
Customer Event Provision
Order Provision
Order Provision
Service Request Provision
Webhooks
MICROS Simphony Order Provision
NCR Aloha Order Provision
Twinsoft Order Provision
The automation adaptor action (each action is applicable for specific adaptors)
Request User Appoval
Request Contact Appoval
Update Content
Communicate Contact
Communicate User
Assign to a specific user
Fulfilled By specific organisation
Assign to specific team adaptor)
Fulfilled by nearest location
Fulfilled based on postal code
Post Webhook
Put Webhook
Assign to user of a specific team
Assign to user of a specific user role
Fulfilled by a user of a specific user role
Fulfilled by a specific user
Provision (create) order to Simphony POS
Provision (create) order to Aloha POS
Provision (void) order to Aloha POS
Create a purchase event
Cancel a purchase event
Webhooks
Schedule an activity
Provision (create) order to Twinsoft POS
Provision (print receipt) order to an external POS based on IP and port
Create an achievement event
Details about the adaptor’s actions parameters
The parameter identifier
The parameter type
The parameter group (used when more than one parameters should be specified for an adaptor’s action)
The parameter key
The parameter from value
The parameter to value
Details about the filters to be applied (required when type is based on Filter)
Details about applicable filter attributes
The filter identiifer
The attribute that its value will be compared based on the related operator
The type of the key
The filter operator to compare the attribute actual value with the filtered one
Applicable for type of number/integer/date
Applicable for type of string
Applicable for type of number/integer/date
Applicable for type of number/integer/date
Applicable for type of number/integer/date
Applicable for type of number/integer/date
The attribute value to apply the filter condition (either value or value_list should be specified)
The supported list of values (either value or value_list should be specified)
The custom field that its value will be compared based on the related operator
Responses
The request has succeeded
Body
The automation identifier
PUT https://sandbox.crm.com/backoffice/v2/automations/c69b54fc-644b-1dc9-65b2-f0b3672cf46e HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"name": "Approve Offers",
"description": "Require 4 approvals for an offer",
"state": "INACTIVE",
"actions": [
{
"order": 1,
"adaptor": {
"adaptor": "CUSTOMER_EVENTS",
"action": "FULFILLED_BY_SPECIFIC_USER",
"parameters": [
{
"id": "4b8e0ae7-0f8a-4313-a1fd-ecc1c0510f55",
"type": "NUMBER",
"group": "1",
"key": "FULFILL_ORDER_POSTAL_CODE",
"from_value": "123",
"to_value": "1234"
}
]
}
}
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "c69b54fc-644b-1dc9-65b2-f0b3672cf46e"
}{id}Delete an existing automation
Path variables
The automation (identifier) that will be deleted
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
DELETE https://sandbox.crm.com/backoffice/v2/automations/3c72e7d1-e763-1db7-a776-6dd0295f728c HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 204 No Content Retrieve a list of automations based on search criteria (e.g. all active automations)
Request parameters
Filter based on search value (case insensitive) across name
Filter based on automation name
Filter based on automation state
Filter based on the entity that its event will trigger the automation
Filter based on the event that will trigger the automation
Approvals
Approvals
Contacts
Contacts
Contacts
Contacts
Contacts
Contacts & Users
Orders
Orders
Orders
Orders
Passes
Passes
Rewards
Rewards
Rewards
Reward Offers
Reward Schemes
Service Requests
Organisations
Organisations
Users
Users
Products
Financial Transactions
Financial Transactions
Financial Transactions
Financial Transactions
Financial Transactions
Customer Events
Customer Events
Customer Events
Subscriptions
Subscriptions
Subscriptions
Subscriptions
Subscriptions
Subscriptions
Subscriptions
Subscriptions
Subscriptions
Subscriptions
Subscriptions
Subscriptions
Subscriptions
Subscriptions
Subscriptions
Subscriptions
Subscriptions
Usage
Usage
Orders
Orders
Service Requests
Service Requests
Service Requests
Service Requests
Service Requests
Service Requests
Service Requests
Activities
Activities
Activities
Products
Products
Financial Transactions
Financial Transactions
Orders
Financial Transactions
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The automation identifier
The automation name
The automation description
The automation state
Defines the entity that its events will trigger this automation
Defines the event that will trigger this automation (filtered based on the selected entity)
Approvals
Approvals
Contacts
Contacts
Contacts
Contacts
Contacts
Contacts & Users
Orders
Orders
Orders
Orders
Passes
Passes
Rewards
Rewards
Rewards
Reward Offers
Reward Schemes
Service Requests
Organisations
Organisations
Users
Users
Products
Financial Transactions
Financial Transactions
Financial Transactions
Financial Transactions
Financial Transactions
Customer Events
Customer Events
Customer Events
Subscriptions
Subscriptions
Subscriptions
Subscriptions
Subscriptions
Subscriptions
Subscriptions
Subscriptions
Subscriptions
Subscriptions
Subscriptions
Subscriptions
Subscriptions
Subscriptions
Subscriptions
Subscriptions
Subscriptions
Usage
Usage
Orders
Orders
Service Requests
Service Requests
Service Requests
Service Requests
Service Requests
Service Requests
Service Requests
Activities
Activities
Activities
Products
Products
Financial Transactions
Financial Transactions
Orders
Financial Transactions
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/automations HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "efc5389d-ae3f-9b94-73f9-5f916e8b350e",
"name": "communicate contact",
"description": "Lorem Ipsum",
"state": "INACTIVE",
"entity": "REWARD_OFFERS",
"event": "INVITE_EXISTING_USER"
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Retrieve detailed information for an automation
Path variables
The automation (identifier) that will be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The automation identifier
The automation name
The automation description
The automation state
Defines the entity that its events will trigger this automation
Defines the event that will trigger this automation (filtered based on the selected entity)
Approvals
Approvals
Contacts
Contacts
Contacts
Contacts
Contacts
Contacts & Users
Orders
Orders
Orders
Orders
Passes
Passes
Rewards
Rewards
Rewards
Reward Offers
Reward Schemes
Service Requests
Organisations
Organisations
Users
Users
Products
Financial Transactions
Financial Transactions
Financial Transactions
Financial Transactions
Financial Transactions
Customer Events
Customer Events
Customer Events
Subscriptions
Subscriptions
Subscriptions
Subscriptions
Subscriptions
Subscriptions
Subscriptions
Subscriptions
Subscriptions
Subscriptions
Subscriptions
Subscriptions
Subscriptions
Subscriptions
Subscriptions
Subscriptions
Subscriptions
Usage
Usage
Orders
Orders
Service Requests
Service Requests
Service Requests
Service Requests
Service Requests
Service Requests
Service Requests
Activities
Activities
Activities
Products
Products
Financial Transactions
Financial Transactions
Orders
Financial Transactions
The automation actions (adaptors and filters) that will be performed
Defines the sequence’s action
Details about adaptor (and its action/parameters)
The automation adaptor
Activity Provision
Approval Requests
Automatic Content Updates
Communications
Customer Event Provision
Order Provision
Order Provision
Service Request Provision
Webhooks
MICROS Simphony Order Provision
NCR Aloha Order Provision
Twinsoft Order Provision
The automation adaptor action (each action is applicable for specific adaptors)
Request User Appoval
Request Contact Appoval
Update Content
Communicate Contact
Communicate User
Assign to a specific user
Fulfilled By specific organisation
Assign to specific team adaptor)
Fulfilled by nearest location
Fulfilled based on postal code
Post Webhook
Put Webhook
Assign to user of a specific team
Assign to user of a specific user role
Fulfilled by a user of a specific user role
Fulfilled by a specific user
Provision (create) order to Simphony POS
Provision (create) order to Aloha POS
Provision (void) order to Aloha POS
Create a purchase event
Cancel a purchase event
Webhooks
Schedule an activity
Provision (create) order to Twinsoft POS
Provision (print receipt) order to an external POS based on IP and port
Create an achievement event
Details about the adaptor’s actions parameters
The parameter identifier
The parameter key
The parameter from value
The parameter to value
The parameter type
The parameter group (used when more than one parameters should be specified for an adaptor’s action)
Details about the filters to be applied (required when type is based on Filter)
The action filter identifier
Details about applicable filter attributes
The filter identiifer
The attribute that its value will be compared based on the related operator
The type of the key
The filter operator to compare the attribute actual value with the filtered one
Applicable for type of number/integer/date
Applicable for type of string
Applicable for type of number/integer/date
Applicable for type of number/integer/date
Applicable for type of number/integer/date
Applicable for type of number/integer/date
The attribute value to apply the filter condition (either value or value_list should be specified)
The supported list of values (either value or value_list should be specified)
The custom field that its value will be compared based on the related operator
GET https://sandbox.crm.com/backoffice/v2/automations/37160c87-3c37-9a00-0716-4933fe6b76f4 HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "37160c87-3c37-9a00-0716-4933fe6b76f4",
"name": "communicate contact",
"description": "On customer award an outbound email communication will be triggered",
"state": "INACTIVE",
"entity": "PASSES",
"event": "APPROVE_ALL_REQUESTS",
"actions": [
{
"order": 1,
"adaptor": {
"adaptor": "CUSTOMER_EVENTS",
"action": "ASSIGN_USER_OF_SPECIFIC_TEAM",
"parameters": [
{
"id": "4b8e0ae7-0f8a-4313-a1fd-ecc1c0510f55",
"key": "FULFILL_ORDER_POSTAL_CODE",
"from_value": "123",
"to_value": "1234",
"type": "DATE",
"group": "1"
}
]
}
}
]
}Bulk Data Operations is a usefull utility tool that enables the ability to import and export a sizeable volumes of data, such as contacts and products, into and out of CRM.COM.
{id}/actionsPreview the content of a file that will be imported
Notes
Importing Data should be made based on the following API order
- Upload File Signature
- Optionally, preview the content of the uploaded file via Import Preview
- Submit a request to import the content of the uploaded file, including a couple behavorial options via Import Data
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The file (identiifer) that will be previewed
Defines the number of rows that will be previewed (header row is excluded)
Defines whether the header row values will be excluded from import or not
Defines the mapping between the imported file attribures and system attributes
The imported file attribute that will be mapped to the system’s one
The system attribute that will be mapped to the imported file’s one
Defines whether the system attribute key is a custom one or not
Responses
The request has succeeded
Body
Details about the file preview per row
The header attribute of the specific row
The previewed values of the specific row
[
"CRM", "CRMI"
]GET https://sandbox.crm.com/backoffice/v2/imports/preview HTTP/1.1
Content-Type: application/json
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
{
"file_id": "f56f9cd8-9cb2-bbe6-d4d9-ae14bb1f0399",
"preview_rows": 5,
"exclude_header": "false",
"data_mapping": [
{
"import_key": "contact first name",
"attribute_key": "first_name",
"is_custom": "false"
}
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"header": "Organisation Name",
"values": [
"CRM"
]
}
]
}Submit a request for importing data along with processing options
Notes
Importing Data should be made based on the following API order
- Upload File Signature
- Optionally, preview the content of the uploaded file via Import Preview
- Submit a request to import the content of the uploaded file, including a couple behavorial options via Import Data
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The file (identifier) that will be used for importing data
The type of the entity that data will be imported
Defines whether the header row values will be excluded from import or not
Defines whether existing records will be updated or not
Defines whether missing attributes will be created automatically
Defines the mapping between the imported file attribures and system attributes
The imported file attribute that will be mapped to the system’s one
The system attribute that will be mapped to the imported file’s one
Defines whether the system attribute key is a custom one or not
Responses
The request has succeeded
Body
The import definition identifier
POST https://sandbox.crm.com/backoffice/v2/imports HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"file_id": "1e347d4d-ab96-6957-fdb6-35e72b3d9185",
"type": "DEVICES",
"exclude_header": true,
"update_data": "false",
"auto_generate_config": true,
"data_mapping": [
{
"import_key": "contact first name",
"attribute_key": "first_name",
"is_custom": "false"
}
]
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "1e347d4d-ab96-6957-fdb6-35e72b3d9185"
}Retrieve a list of import data definitions based on search criteria (e.g. all completed imports)
Request parameters
Filter imports based on state
Import is queued to be processed
Import is currently processing
Import is completed
Import is failed
Filter imports based on imported record type
Filter based on the imported date, which may fall within a given date range. The value can be a string with a date in epoch format. Each option must also include an operator. Use up to two options based on the required search (e.g. imported_on[gte]=1618395497&imported_on[lt]=1618395497).
Returns results where the imported date is greater than this value
Returns results where the imported date is greater than or equal to this value
Returns results where the imported date is less than this value
Returns results where the imported date is less then or equal to this value
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The import definition identifier
The export definition status
Import is queued to be processed
Import is currently processing
Import is completed
Import is failed
The type of the entity that data will be imported
The date that such import was made
Details how the import file content will be processed
Defines whether the header row values will be excluded from import or not
Defines whether existing records will be updated or not
Defines whether missing attributes will be created automatically
Details about the uploaded file that was used for import
The file identifier
The file name
Details about the file that contain all failed imported data
The file identifier
The file name
Details about the processed data
The records that were created successfully
The records that were updated successfully
The records that were not changed
The records that were failed to be processed
The total number of records that were imported
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/imports HTTP/1.1
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "507c17d2-3976-d1e5-ccf5-cf3c1334acc7",
"status": "FAILED",
"type": "DEVICES",
"imported_on": 1623677135,
"options": {
"exclude_header": true,
"update_data": true,
"auto_generate_config": "false"
},
"file": {
"id": "507c17d2-3976-d1e5-ccf5-cf3c1334acc7",
"name": "contacts.csv"
},
"error_file": {
"id": "507c17d2-3976-d1e5-ccf5-cf3c1334acc7",
"name": "contacts_errors.csv"
},
"processed_results": {
"new": 19,
"updated": 4,
"unchanged": 4,
"errors": 1,
"total": 28
}
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}/actionsPerform actions on existing import definition (e.g. re-submit a failed import)
Path variables
The import definition (identifier) on which an action will be performed
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The type of action that will be performed
Re-submit an import with FAILED state
Responses
The request has succeeded
Body
The import definition identifier
PUT https://sandbox.crm.com/backoffice/v2/imports/0e2e1e37-b118-7bbc-db46-6cd954e01a89/actions HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"action": "REPLAY"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "0e2e1e37-b118-7bbc-db46-6cd954e01a89"
}Business Network is a group of participating entities, collaborating to accomplish a business operation and provide a service to the end customer. The Business Network is configured as a hierarchical structure with varying levels of ownership, privileges and permissions depending on the level of hierarchy.
{id}{id}{id}/network{id}{id}/activity_feed{id}/switch{id}/masquerade{id}/actions{id}/statement{id}/statement_details{id}/export_statementCreates a business semantic parent as the primary business.
Request headers
The public api key required for API calls to identify the organisation
Request body
The organisation name
The organisation type
The parent organisation (identifier) that the newly registered organisation belongs to (applicable only when type is merchant)
Information about the owner (admin user) of the organisation
The user’s first name
The user’s last name
The user’s email address
The phone country code (based on ISO 3 char code)
The phone number
The user’s identity
The provider of the identity
The identity challenge
The identity value (e.g. password) - applicable only for EMAIL based identities
The organisation’s base currency (applicable only for business)
The organisation timezone (applicable only for business)
The custom field’s unique key
The custom field’s value
Responses
The request has succeeded
Body
The organisation identifier
POST https://sandbox.crm.com/backoffice/v2/organisations/register HTTP/1.1
api_key: 8c54d563-b991-4b76-8a83-557c08166f95
Content-Type: application/json
{
"name": "Delicious Food Group",
"type": "MERCHANT",
"organisation_id": "4bd55b60-2c2a-d588-7a94-0890ced7e0ba",
"owner": {
"first_name": "John",
"last_name": "Doe",
"email_address": "john@crm.com",
"identity": {
"type": "PHONE",
"challenge": "jd@crm.com",
"value": "Crm.comPassword1234"
}
},
"currency_code": "EUR",
"timezone": "EUROPE/ATHENS",
"custom_fields": [
{
"key": "back_office",
"value": "0001-12345"
}
]
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "ae5cf529-83e5-8b6b-06f0-54dee9d38b20"
}Create a new organisation, expanding the current business network
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The organisation name
The type of the organisation
The organisation description
The organisation’s country of agreement code (applicable only for service owner/business)
The group that such organisation will belong to (only Merchant/Service Provider and Venue/Service Point can be grouped)
The organisation’s contact (email/phone) details
Information about the owner (admin user) of the organisation
The name of the contact information
The type of the organisation’s contact detail
The contact information value
The country code of the related contact detail of type phone
The organisation address(es)
Information about the organisation’s location
The name of the location
The address of the location
Additional address information about the location
The state/province/county of the location
The town/city of the location
The postal code of the location
The country code of the location
The care of information of the location
The latitude of the location
The longitude of the location
The Google textual identifier that uniquely identifies a location
The parent organisation (identifier) that this organisation belongs to
The name that the organisation will have on the cloud (applicable for Service Owner organisations; special characters not allowed)
Defines whether organisation will support contact registry or not (applicable for Service Owner and Business)
The organisations (service owners) that the organisation (transaction processor) serves (applicable only for Transaction Processors)
Defines whether the new organisation will have the same industry, industry sectors and business activities as its parent organisation (applicable only for Venues)
The organisation industry
The organisation industry sectors
The organisation business activities
Details about provisioning an organisation over to WiFi
The integration identifier that organisation will be provisioned for WiFi
The site identifier that will be used to identify the organisation over to WiFi platform
The custom field’s unique key
The custom field’s value
Information about the owner (admin user) of the organisation
The user’s first name
The user’s last name
The user’s email address
The phone country code (based on ISO 3 char code)
The phone number
The user’s identity
The provider of the identity
The identity challenge
The identity value (e.g. password) - applicable only for EMAIL based identities
Responses
The request has succeeded
Body
The organisation identifier
POST https://sandbox.crm.com/backoffice/v2/organisations HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"name": "Delicious Food Group",
"type": "SERVICE_OWNER",
"description": "Lorem Ipsum",
"country_agreement": "CYP",
"groups": [
"7d699221-b38a-6484-f739-b7670c1973c6"
],
"contact_info": [
{
"name": "Main Office",
"type": "EMAIL",
"value": "johndoe@deliciousfood.com",
"country_code": "CYP"
}
],
"addresses": [
{
"name": "Head Office",
"address_line_1": "Elia Papakyriakou 21",
"address_line_2": "7 Tower Stars",
"state_province_county": "Egkomi",
"town_city": "Nicosia",
"postal_code": "2415",
"country_code": "CY",
"care_of": "c/o Company",
"lat": 35.157115,
"lon": 33.313719,
"google_place_id": "ChIJrTLr-GyuEmsRBfy61i59si0"
}
],
"organisation_id": "e7251be4-89f2-8cea-7a4a-65b679cf6131",
"cloud_name": "crmdotcom",
"contact_registry": "true",
"service_organisations": [
"7c56cc02-48cf-9832-e412-a4ae022cd547"
],
"inherit_from_parent": "false",
"industry_id": "b7fae8bd-018a-796f-e509-34c39e478a3f",
"industry_sectors": [
"d22cf1fb-5b47-1da9-7be7-c6a70a4f0ed3"
],
"business_activities": [
"331d2da8-4a41-2b58-f58d-936296c13aaf"
],
"wifi_platform": {
"integration_id": "88165da9-58a9-74cd-3da5-593b901fc0ec",
"site_id": "88quh2m6"
},
"custom_fields": [
{
"key": "back_office",
"value": "0001-12345"
}
]
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "bd92a0b2-1a8d-026b-e01e-41212b105f0f"
}{id}Update a single organisation
Path variables
The organisation (identifier) that will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The organisation name
The organisation description
The organisation’s contact (email/phone) details
Information about the owner (admin user) of the organisation
The organisation’s contact information identifier
The organisation’s contact information name
The type of the organisation’s contact detail
The organisation’s contact information value
The organisation’s contact information country code (applicable for phones)
The organisation industry
The organisation industry sectors
The organisation business activities
The organisation groups (applicable only for Merchant/Service Provider and Venue/Service Point)
Defines whether the new organisation will have the same industry, industry sectors, business activities and reward tags as its parent organisation (applicable only for Venue/Service Point)
The organisation profile infromation (applicable only for Business)
The organisation’s registration number
The organisation’s TAX reference number
The organisation’s VAT reference number
The company’s registrationc country code
The name (special characters not allowed) that the organisation will have on the cloud (applicable for Service Owner)
The organisations (service owners) that the organisation (transaction processor) serves (applicable only for Transaction Processors)
1daf80b1-134b-36eb-7146-76dec04e6c5d
Defines whether organisation supports contact registry or not (applicable for Service Owner and Business)
Information about the organisation’s location
The location identifier that will be updated
The name of the location
The address of the location
Additional address information about the location
The state/province/county of the location
The town/city of the location
The postal code of the location
The country code of the location
The care of information of the location
The latitude of the location
The longitude of the location
The Google textual identifier that uniquely identifies a location
The custom field’s unique key
The custom field’s value
Defines the partners (their logos will appear on the backend) assigned on this organisation by the service owner. (applicable only for Business)
The partner identifier
The organisation subscription details
The (business) organisation (identifier) that the organisation will be charged from
The default service (identifier) that the organisation subscribed to
Responses
The request has succeeded
Body
The organisation identifier
PUT https://sandbox.crm.com/backoffice/v1/organisations/CAD1E31269B76D7A65ACCE45B2E68DFD HTTP/1.1
Content-Type: application/json
{
"name": "Delicious Food Group",
"description": "Lorem Ipsum",
"contact_info": [
{
"id": "CK1234567890123456789012345678",
"type": "PHONE",
"value": "info@crm.com",
"name": "Head Office"
}
],
"industry_id": "CAD1E31269B76D7A65ACCE45B2E68DFD",
"industry_sectors": [
"CAD1E31269B76D7A65ACCE45B2E68DFD"
],
"business_activities": [
"CAD1E31269B76D7A65ACCE45B2E68DFD"
],
"groups": [
"CAD1E31269B76D7A65ACCE45B2E68DFD"
],
"inherit_from_parent": "false",
"organisation_profile": {
"registration_number": "1234",
"tax_reference_number": "TAX1234",
"vat_reference_number": "VAT1234",
"registration_country": "CYP"
},
"cloud_name": "crmdotcom",
"organisation_tags": [
"Accounting"
],
"service_organisations": [
"1daf80b1-134b-36eb-7146-76dec04e6c5d"
],
"contact_registry": "true",
"locations": {
"id": "a6cc4f88-cab1-4ab2-98d3-4655789277e2",
"name": "Head Office",
"address_line_1": "Elia Papakyriakou 21",
"address_line_2": "7 Tower Stars",
"state_province_county": "Egkomi",
"town_city": "Nicosia",
"postal_code": "2415",
"country_code": "CY",
"care_of": "",
"lat": 35.157115,
"lon": 33.313719,
"google_place_id": "ChIJrTLr-GyuEmsRBfy61i59si0"
},
"custom_fields": [
{
"key": "back_office",
"value": "0001-12345"
}
],
"partners": [
{
"id": "43f394c0-ece1-43a5-ab7d-b54ce9065fe7"
}
]
}{id}Delete an organisation
Path variables
The organisation (identifier) that will be deleted
Notes
Only Business organisations can be deleted and as a result of such action the entire network (e.g. merchants and venues) of such business is deleted as well
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
DELETE https://sandbox.crm.com/backoffice/v2/organisations/bf2fd7b1-5454-a38e-23ad-88498dc4fb25 HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 204 No Content {id}/networkRetrieve a list of organisations based on search criteria (e.g. all merchants under business)
Path variables
Parent organisation (identifier) whose child organisations will be retrieved
Request parameters
Filter based on the organisation’s name (behaves as like)
Filter based on the organisation’s relationship
Defines the free text search parameter based on the provided type (e.g. name)
Defines the entitiy type that the search will be applied
Filter based on the organisation group(s)
Filter based on the organisation industry(ies)
Filter based on the organisation industry sector(s)
Filter based on the organisation business activity(ies)
Filter based on (organisation) tags
Filter based on the organisation (address) area(s)
Filter based on the organisation (address) country(ies)
Filter based on the organisation (address) town(s)/city(ies)
Defines whether child organisations total number should be returned
Defines whether organisations creatives should be returned
Defines whether the organisation group should be returned as part of the response
Defines whether the operation details of such organisations should be retrieved or not
Defines whether custom fields should be retrieved or not (via List/Get APIs)
Filters based on custom fields (key/value set should be semicolon separated)
Filter based on organisation state
Filter based on TAP code
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The organisation identifier
The organisatio name
The organisation description
Information about the child organisations
The type of the organisation
The total number of child organisations
The organisation groups
The organisation group identifier
The organisation group name
The organisation addresses
Information about the organisation’s location
The location identifier
The name of the location
The address of the location
Additional address information about the location
The state/province/county of the location
The town/city of the location
The postal code of the location
The country code of the location
The care of information of the location
The latitude of the location
The longitude of the location
The Google textual identifier that uniquely identifies a location
The creative identifier
Information about the creative type
Partner logos configurable by SO, applicable for Business, Merchant, Venue
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
The creative width
The creative height
The creative format
The creative content URL
The creative public identifier
Information about the creative transformations
The transformed creative width
The transformed creative height
The transformed creative URL
Information about the organisation’s industry
The industry identifier
The industry name
The organisation industry sectors
Information about the industry sectors
The industry sector identifier
The industry sector name
The organisation business activities
Information about the business activity
The business activity identifier
The business activity name
The organisation operation details
Details about the organisation’s working hours
The day of the week that the organisation is open
The time that the organisation opens
The time that the organisation closes
The opening hours for each organisation’s operation type
Details about the organisation’s availability to offer its services
The organisation’s operation type
Defines whether the organisation is temporary closed for offering its services
Defines whether organisation supports contact registry
The custom field’s unique key
The custom field’s value
The status of the organisation
The date that such organisation was created
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/organisations/d332dd8a-254e-47c9-ba1f-3f369877a9b3/network HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "8265f357-9399-2536-8bb1-4a8343d7d554",
"name": "CRM.COM Cyprus",
"description": "Lorem Ipsum",
"child_organisations": [
{
"type": "BUSINESS",
"count": 21
}
],
"groups": [
{
"id": "CAD1E31269B76D7A65ACCE45B2E68DFD",
"name": "Seasonal"
}
],
"addresses": [
{
"id": "LOC123456234567345674567895678IK",
"name": "Head Office",
"address_line_1": "Elia Papakyriakou 21",
"address_line_2": "7 Tower Stars",
"state_province_county": "Egkomi",
"town_city": "Nicosia",
"postal_code": "2415",
"country_code": "CY",
"care_of": "c/o Company",
"lat": 35.157115,
"lon": 33.313719,
"google_place_id": "ChIJrTLr-GyuEmsRBfy61i59si0"
}
],
"creatives": [
{
"id": "3caf8388-b9c6-6679-1e9b-94a6fda92a41",
"usage_type": "LANDING_PAGE_IMAGE",
"width": 2159,
"height": 3075,
"format": "jpg",
"url": "https://assets.crm.com/image/logo.jpg",
"public_id": "crm-com/image",
"media": [
{
"width": 200,
"height": 300,
"url": "https://asset.crm.com/image/offer/c_scale,w_200/logo.jpg"
}
]
}
],
"industry": {
"id": "59106518-092e-8a08-7769-29f40dced0d1",
"name": "Restaurant"
},
"industry_sectors": [
{
"id": "9a857635-5ef3-aa4c-bd2c-90434070cb5a",
"name": "Bar"
}
],
"business_activities": [
{
"id": "CAD1E31269B76D7A65ACCE45B2E68DFD",
"name": "Bar & Grill"
}
],
"operation_details": {
"opening_hours": [
{
"day_of_week": "MONDAY",
"opens": "09:00",
"closes": "20:00",
"operation": "DELIVERY"
}
],
"short_term_operations": [
{
"operation": "DELIVERY",
"is_closed": "false"
}
]
},
"contact_registry": "true",
"custom_fields": [
{
"key": "back_office",
"value": "0001-12345"
}
],
"state": "INACTIVE",
"created_date": 1663841080
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Retrieve detailed information for an organisation
Path variables
The organisation (identifier) that will be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The organisation identifier
The organisation name
The organisation description
The type of the organisation
The organisation groups
The organisation group identifier
The organisation group name
The organisation contact (email/phone) details
Information about the owner (admin user) of the organisation
The contact detail identifier
The name of the contact information
The type of the contact information
The value of the specific contact information
The country code related to the contact detail of type phone
The organisation addresses
Information about the organisation’s location
The location identifier
The name of the location
The address of the location
Additional address information about the location
The state/province/county of the location
The town/city of the location
The postal code of the location
The country code of the location
The care of information of the location
The latitude of the location
The longitude of the location
The Google textual identifier that uniquely identifies a location
Information about the organisation’s industry
The industry identifier
The industry name
The organisation industry sectors
Information about the industry sectors
The industry sector identifier
The industry sector name
The organisation business activities
Information about the business activity
The business activity identifier
The business activity name
Defines whether the organisation has the same industry, industry sectors and business activities as its parent organisation
The parent organisation identifier that this organisation belongs to
The name that the organisation will have on the cloud (applicable for Service Owner organisations; special characters not allowed)
The organisations (service owners) that the organisation (transaction processor) serves
Details about the organisation from where such event was posted
The organisation identifier
The organisation name
The creative identifier
Information about the creative type
Partner logos configurable by SO, applicable for Business, Merchant, Venue
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
The creative width
The creative height
The creative format
The creative content URL
The creative public identifier
Information about the creative transformations
The transformed creative width
The transformed creative height
The transformed creative URL
Defines whether the organisation supports contact registry
The custom field’s unique key
The custom field’s value
The status of the organisation
Defines the partners that are assigned to this organisation and their logos will be shown on the back-end SPA. Applicable only for organisations of type Business, where Service Owners will be responsible for assigning such information
The partner identifier
The partner name
The date that such entity was created
The organisation subscription details
The billing (businesS) organisation
The organisation identifier
The organisation name
The default service assigned to the organisation
The product identifier
The product name
The product SKU
The organisation profile infromation (applicable only for Business)
The organisation’s registration number
The organisation’s TAX reference number
The organisation’s VAT reference number
The company’s registrationc country code
The organisation’s MRR metrics
The organisation’s total MRR
GET https://sandbox.crm.com/backoffice/v2/organisations/9866964d-6892-6700-5f39-09492c9e714e HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "9866964d-6892-6700-5f39-09492c9e714e",
"name": "Delicious Bite",
"description": "Lorem Ipsum",
"type": "BUSINESS",
"groups": [
{
"id": "CAD1E31269B76D7A65ACCE45B2E68DFD",
"name": "Seasonal"
}
],
"contact_info": [
{
"id": "CON123456234567345674567895678IK",
"name": "Main Office",
"type": "PHONE",
"value": "johndoe@deliciousfood.com",
"country_code": "CYP"
}
],
"addresses": [
{
"id": "LOC123456234567345674567895678IK",
"name": "Head Office",
"address_line_1": "Elia Papakyriakou 21",
"address_line_2": "7 Tower Stars",
"state_province_county": "Egkomi",
"town_city": "Nicosia",
"postal_code": "2415",
"country_code": "CY",
"care_of": "c/o Company",
"lat": 35.157115,
"lon": 33.313719,
"google_place_id": "ChIJrTLr-GyuEmsRBfy61i59si0"
}
],
"industry": {
"id": "59106518-092e-8a08-7769-29f40dced0d1",
"name": "Restaurant"
},
"industry_sectors": [
{
"id": "9a857635-5ef3-aa4c-bd2c-90434070cb5a",
"name": "Bar"
}
],
"business_activities": [
{
"id": "CAD1E31269B76D7A65ACCE45B2E68DFD",
"name": "Bar & Grill"
}
],
"inherit_from_parent": "false",
"organisation_id": "7e8e39de-2f80-d2fe-b1f9-25b0cf4b2fbf",
"cloud_name": "crmdotcom",
"service_organisations": [
{
"id": "4248fab3-67d5-2eb1-eaf6-079ce18cd2ed",
"name": "Bravo Coffee"
}
],
"creatives": [
{
"id": "3caf8388-b9c6-6679-1e9b-94a6fda92a41",
"usage_type": "HERO",
"width": 2159,
"height": 3075,
"format": "jpg",
"url": "https://assets.crm.com/image/logo.jpg",
"public_id": "crm-com/image",
"media": [
{
"width": 200,
"height": 300,
"url": "https://asset.crm.com/image/offer/c_scale,w_200/logo.jpg"
}
]
}
],
"contact_registry": "true",
"custom_fields": [
{
"key": "back_office",
"value": "0001-12345"
}
],
"state": "INACTIVE",
"partners": [
{
"id": "f4942b1d-efe2-258e-ebc2-6be805ce8b7c",
"name": "Best Partner"
}
],
"created_date": 1,
"subscription": {
"organisation": {
"id": "8f2b27a5-b7c4-5b73-564c-4c5b4530ba96",
"name": "CRM"
},
"service": {
"id": "26684853-42d4-44d2-601a-48a6e6990ef8",
"name": "Enterprise",
"sku": "ES00323"
}
},
"organisation_profile": {
"registration_number": "1234",
"tax_reference_number": "TAX1234",
"vat_reference_number": "VAT1234",
"registration_country": "CYP"
}
}{id}/activity_feedGet the activity feed of a single organisation
Path variables
The organisation (identifier) whose activity will be retrieved
Request parameters
Filter based on activity type
Filter based on the performed date, which may fall within a given date range. The value can be a string with a date in epoch format. Each option must also include an operator. Use up to two options based on the required search (e.g. performed_on[gte]=1618395497&performed_on[lt]=1618395497).
Returns results where the performed date is greater than this value
Returns results where the performed date is greater than or equal to this value
Returns results where the performed date is less than this value
Returns results where the performed date is less then or equal to this value
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The activity (feed) identifier
The entity’s type name
The entity’s number
The entity’s reference number
The entity’s code
The entity’s state
The entity’s created date
The entity’s due date in case of Invoices
The activity (feed) direction
The activity (feed) notes
The entity’s total amount
The currency (code) of such amount
The associated topup
The top up identifier
The top up number
The top up entity type
The associated order
The order queue
The order queue identifier
The order queue name
The order stage
The order stage identifier
The order stage name
The entity’s subject
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/organisations/33c11c8a-60a9-159a-c25c-ada7a9e2edbd/activity_feed HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "cb6ad302-e27c-5a1a-3092-396b2fd40682",
"type": "INVOICE",
"number": "I10003",
"reference_number": "Ref12345678",
"code": "123456789ABE2364",
"state": "POSTED",
"created_date": 1576486645,
"due_date": 1576486645,
"direction": "OUTGOING",
"notes": "This Invoice is created for November 2019",
"total_amount": 200,
"currency_code": "EUR",
"top_up": {
"id": "018482c9-3af3-2076-5285-c51092ff30b9",
"number": "AC00123 John Johnson",
"type": "ACCOUNT"
},
"order": {
"queue": {
"id": "359652c2-8152-ea3e-0c52-a13adfff1566",
"name": "Up-Front Orders"
},
"stage": {
"id": "ad4c71f9-9964-f445-3104-e5f0a3526c4a",
"name": "In Progress"
}
},
"subject": "Invoice Sent"
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}/switchSwitch the user to another organisation
Path variables
The organisation (identifier) that will be switched to
Notes
As part of “changing organisations that a user belongs to” flow, the user will have a different role as assigned when such user was invited to the organisation that switched to
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
Authentication information provided for an admin user
The token that can be used in subsequent API calls
The token that can be used to generate a new access token (when previous is expired)
The token expiration date
The authenticated user details
{
"first_name": "John",
"last_name": "Doe",
"email": "johndoe@crm.com"
}The first name
The last name
The email address
The organisation mode
Organisation was not live enabled
Organisation is in test mode (therefore User is signed in test mode)
Organisation supports live mode (therefore User is signed in live mode)
The organisations that the user is a member at
The organisation identifier
The type of the organisation
The organisation name
The organisation status
The organisation progress status
Defines whether a user (other than the owner) is invited
Defines whether a contact is created (applicable only for business)
Defines whether a reward scheme is created (applicable only for business)
Defines whether a reward offer is created
Defines whether a merchant is created (applicable only for business)
Defines whether a venue is created
Defines whether password has been expired or not
Defines the date on which the user’s lockout will be expired
Defines whether two factor authentication is required or not (true only for authentication API, false to all others)
The two-factor method that is used and all user’s (configured) two-factor methods
The method that is used for the two-factor authentication
Defines the type of the user 2FA method
The two-factor method obfuscated value (applicable only for email and phone based two-factor methods)
The user’s (configured) two-factor methods
The user’s (configured) two-factor methods
Defines the type of the user 2FA method
The two-factor method obfuscated value (applicable only for email and phone based two-factor methods)
Defines the number of days that are left until password is expired
POST https://sandbox.crm.com/backoffice/v2/organisations/9f70eae6-8465-8add-8702-6871a36a85de/switch HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"access_token": "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJhY2U5ZDRkMi0wYjhkLTExZWEtOTUxOC00MjAxMGE5YTAwMDMiLCJ0eXBlIjoiYWNjZXNzIiwicHJpbWFyeU9yZ2FuaXNhdGlvbiI6IjhkY2MzNjgwLTBiOGEtMTFlYS05NTE4LTQyMDEwYTlhMDAwMyIsImN1cnJlbnRPcmdhbmlzYXRpb24iOiI4ZGNjMzY4MC0wYjhhLTExZWEtOTUxOC00MjAxMGE5YTAwMDMiLCJzY29wZSI6WyJjdXN0b21lci13cml0ZSIsIm9yZGVyLXJlYWQiXSwicHJlZmVycmVkX3VzZXJuYW1lIjoiamQiLCJlbWFpbCI6ImpkQGNybS5jb20iLCJleHAiOjE1Nzk4ODA2Mjl9.-uJyEW-Y_QgHb1q-WHBBMew3J_TnUfvqy-NDFmIzFhbS3gkerE5QAqp4cgNMr5BiGcyt174UVhYGXp2Fg7BKcw",
"refresh_token": "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJhY2U5ZDRkMi0wYjhkLTExZWEtOTUxOC00MjAxMGE5YTAwMDMiLCJ0eXBlIjoicmVmcmVzaCIsInByaW1hcnlPcmdhbmlzYXRpb24iOiI4ZGNjMzY4MC0wYjhhLTExZWEtOTUxOC00MjAxMGE5YTAwMDMiLCJjdXJyZW50T3JnYW5pc2F0aW9uIjoiOGRjYzM2ODAtMGI4YS0xMWVhLTk1MTgtNDIwMTBhOWEwMDAzIiwic2NvcGUiOlsiY3VzdG9tZXItd3JpdGUiLCJvcmRlci1yZWFkIl0sInByZWZlcnJlZF91c2VybmFtZSI6ImpkIiwiZW1haWwiOiJqZEBjcm0uY29tIiwiZXhwIjoxNTc5ODgwNjI5fQ.cW_g6ozy2OaP5Tx3l2QuzNeRBSXnNrP1AN6QoOqf6s95eVoUrld6bHRUdBt3H74CZyrxhp7Rs_uXtv17GhVz5w",
"expiration_date": 1579880629,
"user": {
"first_name": "John",
"last_name": "Doe",
"email": "johndoe@crm.com"
},
"mode": "TRIAL",
"organisations": [
{
"id": "b907f6f0-5f3c-9b67-bcf1-9ee13d747294",
"type": "TRANSACTION_PROCESSOR",
"name": "CRM.COM"
}
],
"progress": {
"invite_user": "true",
"create_contact": "false",
"create_scheme": "true",
"create_offer": "false",
"create_merchant": "false",
"create_venue": "false"
},
"password_expired": true,
"lockout_date": 1615897181,
"two_factor_required": true,
"two_factor_methods": {
"send_method": {
"method": "TOTP",
"value": "jo****@crm.com"
},
"options": [
{
"method": "EMAIL",
"value": "jo****@crm.com"
}
]
}
}{id}/masqueradeSwitch the user to another organisation
Path variables
The organisation (identifier) that will be masqueraded to
Notes
As part of “masquerade” flow, the masqueraded user will have the same role as the one from the initial organisation that such user signed in.
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
Authentication information provided for an admin user
The authenticated user details
The first name
The last name
The two-factor method that is used and all user’s (configured) two-factor methods
The method that is used for the two-factor authentication
Defines the type of the user 2FA method
The two-factor method obfuscated value (applicable only for email and phone based two-factor methods)
The user’s (configured) two-factor methods
The user’s (configured) two-factor methods
Defines the type of the user 2FA method
The two-factor method obfuscated value (applicable only for email and phone based two-factor methods)
POST https://sandbox.crm.com/backoffice/v2/organisations/CAD1E31269B76D7A65ACCE45B2E68DFD/masquerade HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"user": {
"first_name": "John",
"last_name": "Doe"
},
"two_factor_methods": {
"send_method": {
"method": "EMAIL",
"value": "jo****@crm.com"
},
"options": [
{
"method": "PHONE",
"value": "jo****@crm.com"
}
]
}
}{id}/actionsPerform an action on an existing organisation
Path variables
The organisation (identifier) that an action will be applied on it
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The action that will be applied on the organisation
Switch between test/live mode (if not already live, first time switch will set such organisation as live)
Copy a business and its business network (applicable only for Business)
Set the organisation state to active
Set the organisation state to inactive
Set the organisation state to suspend
The organisation name that will be set on the copied (new) organisation (applicable only on COPY action)
Responses
The request has succeeded
Body
The organisation identifier
POST https://sandbox.crm.com/backoffice/v2/organisations/2513ff06-b55c-724f-048f-fb6bb16f5fb2/actions HTTP/1.1
Content-Type: application/json
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
{
"action": "COPY",
"name": "CRM"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "4872e81e-4866-2eb2-bbd3-8a5a8c276290"
}{id}/statementRetrieves all financial events of a Merchant or Service Provider based on an account and the selected period for the signed-in organisation. Used in conjunction with Get Account Statement Details to produce the Merchant or Service Provider complete statement.
Path variables
The organisation identifier to retrieve account balances for
Request parameters
Merchant or Service Provider’s account id to retrieve balance information for. If not specified, then use the primary account
Specify the account currency for which the statement will be produced. Default is the primary account’s currency
Starting statement period month
Ending statement period month
Starting statement period year
Ending statement period year
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
OK
Body
Account unique identifier
Account number
Statement period
Statement period months
Starting month
Ending month
Statement period year
Starting year
Ending year
Opening balance for account
Closing balance for account
Total credited amount for the selected period
Total debited amount for the selected period
The Account’s Ageing Analysis. The ageing balance is based on the selected Account but it
The total aged balance of the account
Aged balanc eof th eaccount, separated in 5 buckets, each one having a 30 days duration.
Aged balance over 121 days
Balance aged by up to 30 days
Aged balanc eby 31 to 60 days
Aged balanc eby 61 to 90 days
Aged balanc eby 91 to 120 days
GET https://sandbox.crm.com/backoffice/v2/organisations/76D7A65ACCE45B2E68DFDCAD1E31269B/statement HTTP/1.1 {id}/statement_detailsRetrieves all the statement detail lines for a single Merchant or Service Provider, for the given period, used in conjunction with Get Accounts Statement API to create a Merchant or Service Provider statement
Path variables
The organisation identifier for which to retrieve account journals for
Request parameters
Merchant or Service Provider’s account id to retrieve balance information for
Specify the 3-char account currency for which the statement will be produced
Starting statement period month
Ending statement period month
Starting statement period year
Ending statement period year
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
OK
Body
Statement detail lines
Account unique idetifier
Transaction date
Type of financial transaction
Transaction amount
Financial activity information
The reference number of the transaction if available (e.g. reference number of a payment or a transfer)
The activity entity unique id number (e.g. id of an invoice)
Transaction details
Running balance of account right after the financial event was performed.
GET https://sandbox.crm.com/backoffice/v2/organisations/76D7A65ACCE45B2E68DFDCAD1E31269B/statement_details HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "d2ea1d75-0805-4d8c-b212-f31064ee3bff",
"date": "2343342445",
"type": "CREDIT",
"amount": 3.59,
"currency_code": "EUR",
"activity": {
"type": "PASS_REDEMPTON",
"number": "90508992",
"id": "61c943c8-dfeb-4c09-a25c-b054f48bf244"
},
"details": "Sally's Flower Shop",
"running_balance": 14.99
}
]
}{id}/export_statementUse this API to export the Merchant or Service Provider statement in PDF or CSV format to the user’s email, or send to the contact’s email address
Path variables
The organisation’s id to export statement for
Request headers
Authorization Token
The public api key required for API calls to identify the organisation
Request body
The identifier of the account for which the export will be performed
Statement period starting month
Statement period starting year
Statement period ending month
Statement period ending year
How the statement will be sent
Sent to user’s email
Sent to user’s email
Sent to the Contact’s email address
Responses
POST https://sandbox.crm.com/backoffice/v2/contacts/da60dd8f-b124-439d-a7fe-e1bdbd484c71/export_statement HTTP/1.1
api_key: 8c54d563-b991-4b76-8a83-557c08166f95
Content-Type: application/json
{
"account_id": "da60dd8f-b124-439d-a7fe-e1bdbd484c71",
"currency_code": "EUR",
"from_month": 3,
"from_year": 2022,
"to_month": 3,
"to_year": 2022,
"format": "PDF"
}{id}/billing{id}/billingRetrieves a relationship between an organisation as the billing business and a contact
Path variables
The organisation (identifier) that billing relationship will be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The organisation that performs the billing
The organisation identifier
The organisation name
The billing organisation’s public API key
The billing contact (contact information and authentication details) that will be billed due to its billing relation to the billing organisation
The jwt token associated to the contact of the billing organisation that can be used for subsequent API requests
The refresh token that can be used to issue a new access token, after the previous one is expired
The access token expiration date
The billing contact details
The contact identifier
The contact (full) name
GET https://sandbox.crm.com/backoffice/v2/organisations/db560dec-4097-655e-25b3-d0fe95698bd0/billing HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"organisation": {
"id": "db560dec-4097-655e-25b3-d0fe95698bd0",
"name": "CRM billing",
"api_key": "5bd2fd1d-3f49-3f51-fddc-76bb419880c7"
},
"contact": {
"access_token": "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJhMjc4ZDNlNS05YjhlLTQzNmUtOTIzMC03MGYzZTJkZjFjYTUiLCJleHAiOjE1Njg1NTQxMjJ9.LemqPPThkqfakkKS6CdkNvV1Lnc88CWirEpHOPnWjJPQz02zgkKSwfbvrEsl3OmR2LUhDILsOXf4x-GPFmNJCg",
"refresh_token": "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJhMjc4ZDNlNS05YjhlLTQzNmUtOTIzMC03MGYzZTJkZjFjYTUiLCJleHAiOjE1Njg1NTQxMjJ9.LemqPPThkqfakkKS6CdkNvV1Lnc88CWirEpHOPnWjJPQz02zgkKSwfbvrEsl3OmR2LUhDILsOXf4x-GPFmNJCg",
"expiration_date": 11664276644,
"contact": {
"id": "4f87056c-9fba-2902-779f-f47e4c833a4f",
"name": "CRM.COM Media Group Ltd"
}
}
}Set of operations that allow setting up and managing an Organisation’s Account. Businesses, Merchants/Service Providers can have an Account as Contacts do. Merchants/Service Providers can place Orders and the Business is delivering the rdered items to them.
{id}/accounts{id}/accounts{id}/accounts/{account_id}/actions{id}/accountsCreate an account for a specific organisation. An account can only be created for a Business or a Merchant/Service Provider. Once created, the account will be set in Active state. Only one account per supported currency can be created per organisation.
Path variables
The organisation (identifier) that an account will be created
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The account name (if not specified, defaults to account name rules)
The account classification (identifier)
The billing address (identifier)
Defines whether the account is the primary one (if it’s the first one, defaults to primary)
Responses
The request has succeeded
Body
The organisation account identifier
POST https://sandbox.crm.com/backoffice/v2/organisations/c6e6bcc8-ef76-45a9-a7c1-b45efaa6fdb4/accounts HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"name": "Good Burgers Main Account",
"currency_code": "EUR",
"classification_id": "bacffd55-e3d8-ded4-30dc-99375312302e",
"billing_address_id": "bf91070e-1f23-a8ec-31b5-be1e62638180"
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "c6e6bcc8-ef76-45a9-a7c1-b45efaa6fdb4"
}{id}/accountsGet a list of accounts for a specific organisation. Normally an organisation will have a single account, but multiple accounts can be used to service different currencies. All accounts of the organisation are retrieved by default, regardless of their state
Path variables
The organisation (identifier) which accounts wil be retrieved
Request parameters
Retrieve only the primary account of the organisation
Filter account based on state(s)
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The account identifier
Defines whether the account is the primary one
The account name
The account number
The account state
The account classification
The classification identifier
The classification name
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/organisations/c6e6bcc8-ef76-45a9-a7c1-b45efaa6fdb4/accounts HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"is_primary": true,
"name": "Default",
"number": "AC123456",
"state": "ACTIVE",
"currency_code": "EUR",
"classification": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "VIP"
}
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}/accounts/{account_id}/actionsPerform actions on an existing organisation account (e.g. suspend account)
Path variables
The organisation (identifier) on which the account will be updated
The account (identifier) on which the action is performed
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Contact is able to perform transactions
Contact blocked from ordering/purchases but still allowed to make Payments
Contact can no longer perform any kind of transactions using this account(financial, ordering, rewards etc)
Responses
Successful Request
Body
The organisation account identifier
PUT https://sandbox.crm.com/backoffice/v2/organisations/1eaa809f-ed91-4b68-b912-5bd6064d3400/accounts/18e0e170-a19c-4448-a9c6-b5737ad238e8/actions HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"state": "ACTIVE"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "18e0e170-a19c-4448-a9c6-b5737ad238e8"
}{id}/media_groups{id}/media_groupsLink an organisation with one or many media groups
Path variables
The organisation (identifier) that media groups will be set
Notes
Uploading media for an organisation requires the execution of the following APIs
- Create new Media Group
- Create Organisation Media Groups
- Upload Media
- Perform Cloudinary Upload (where CRM will send all signature details)
- Cloudinary service calls back CRM media group (using an internal callback)
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The media group identifier
Responses
The request has succeeded
POST https://sandbox.crm.com/backoffice/v2/organisations/sdfsfsdf-32-fwef-wef-wefwef23/media_groups HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
[
{
"media_group_id": "3f1f9e63-7f40-4e5e-bc42-11a162f7f1fb"
}
]
HTTP/1.1 204 No Content {id}/operation_details{id}/operation_details{id}/operation_detailsUpdate an organisation’s operational details (e.g. opening hours)
Path variables
The organisation (identifier) of which operation details will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Details about the organisation’s working hours
The day of the week that the organisation is open
The time that the organisation opens
The time that the organisation closes
The opening hours for each organisation’s operation type
Details about the organisation’s availability to offer its services
The organisation’s operation
Defines whether the organisation is temporary closed for offering its services
Responses
The request has succeeded
Body
The organisation identifier
PUT https://sandbox.crm.com/backoffice/v2/organisations/711f82b5-0728-bee7-5f8b-a2d1fcb1cd7c/operation_details HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"opening_hours": [
{
"day_of_week": "SUNDAY",
"open": "09:00",
"close": "20:00",
"operation": "PICK_UP"
}
],
"short_term_operations": [
{
"operation": "PICK_UP",
"is_closed": "false"
}
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "711f82b5-0728-bee7-5f8b-a2d1fcb1cd7c"
}{id}/operation_detailsRetrieve an organisation’s operational details (e.g. opening hours)
Path variables
The organisation (identifier) whose operation details will be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
Details about the organisation’s working hours
The day of the week that the organisation is open
The time that the organisation opens
The time that the organisation closes
The opening hours for each organisation’s operation type
Details about the organisation’s availability to offer its services
The organisation’s operation type
Defines whether the organisation is temporary closed for offering its services
GET https://sandbox.crm.com/backoffice/v2/organisations/CAD1E31269B76D7A65ACCE45B2E68DFD/operation_details HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"opening_hours": [
{
"day_of_week": "MONDAY",
"open": "09:00",
"close": "20:00",
"operation": "DELIVERY"
}
],
"short_term_operations": [
{
"operation": "DELIVERY",
"is_closed": "false"
}
]
}{id}/addresses{id}/addresses/{address_id}{id}/addresses/{address_id}{id}/addresses{id}/addressesAdd a new location for an existing Organisation
Path variables
The organisation (identifier) whose locations will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The name of the address
The address line 1 of the address
The address line 2 of the address
The state/province/county of the address
The town/city of the address
The postal code of the address
The country of the address
The care of information of the address
The latitude of the address
The longitude of the address
The Google textual identifier that uniquely identifies a address
Responses
The request has succeeded
Body
The organisation’s address identifier
POST https://sandbox.crm.com/backoffice/v2/organisations/53420b7f-b114-690b-0513-bc15a8904d34/addresses HTTP/1.1
Content-Type: application/json
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
{
"name": "Head Office",
"address_line_1": "Elia Papakyriakou 21",
"address_line_2": "7 Tower Stars",
"state_province_county": "Egkomi",
"town_city": "Nicosia",
"postal_code": "2415",
"country_code": "CY",
"care_of": "",
"lat": 33.313719,
"lon": 33.313719,
"google_place_id": "ChIJrTLr-GyuEmsRBfy61i59si0"
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "ff8f8be9-db79-cd8f-1bae-4a81c007f856"
}{id}/addresses/{address_id}Update an existing address for an organisation
Path variables
The organisation (identifier) of which address will be updated
The organisation’s address (identifier) that will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The name of the address
The address line 1 of the address
The address line 2 of the address
The state/province/county of the address
The town/city of the address
The postal code of the address
The country of the address
The care of information of the address
The latitude of the address
The longitude of the address
The Google textual identifier that uniquely identifies a address
Responses
The request has succeeded
Body
The organisation’s address identifier
PUT https://sandbox.crm.com/backoffice/v2/organisations/53a399c8-58ed-77bd-ca8f-265072b028d7/addresses/a044a3f9-7e3c-4229-6ec5-0fbac9b27fda HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"name": "Head Office",
"address_line_1": "Elia Papakyriakou 21",
"address_line_2": "7 Tower Stars",
"state_province_county": "Egkomi",
"town_city": "Nicosia",
"postal_code": "2415",
"country_code": "CY",
"care_of": "",
"lat": 35.157115,
"lon": 33.313719,
"google_place_id": "ChIJrTLr-GyuEmsRBfy61i59si0"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "a044a3f9-7e3c-4229-6ec5-0fbac9b27fda"
}{id}/addresses/{address_id}Delete an address from an organisation
Path variables
The organisation (identifier) whose address will be removed
The organisation’s address (identifier) that will be deleted
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
DELETE https://sandbox.crm.com/backoffice/v2/organisations/9ef933f3-976f-32f7-6746-12faf9e41964/addresses/a6f6506f-a3b7-da53-f34d-33fc749e5a9f HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 204 No Content {id}/addressesRetrieves all addresses associated with a single organisation
Path variables
The organisation (identifier) which addresses will be retrieved
Request parameters
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
Information about the organisation’s location
The location identifier
The name of the location
The address of the location
Additional address information about the location
The state/province/county of the location
The town/city of the location
The postal code of the location
The country code of the location
The care of information of the location
The latitude of the location
The longitude of the location
The Google textual identifier that uniquely identifies a location
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/organisations/83e1563f-cb0c-08cc-535e-10f8e8619e63/addresses HTTP/1.1
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "LOC123456234567345674567895678IK",
"name": "Head Office",
"address_line_1": "Elia Papakyriakou 21",
"address_line_2": "7 Tower Stars",
"state_province_county": "Egkomi",
"town_city": "Nicosia",
"postal_code": "2415",
"country_code": "CY",
"care_of": "c/o Company",
"lat": 35.157115,
"lon": 33.313719,
"google_place_id": "ChIJrTLr-GyuEmsRBfy61i59si0"
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}/payment_methods{id}/payment_methods/{payment_method_id}{id}/payment_methods/{payment_method_id}{id}/payment_methods{id}/payment_methodsAdd a new payment method for an organisation
Path variables
The organisation (identifier) that a payment method will be created
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The name of the payment method
The payment method’s type
Marks the payment method as the organisation’s primary one
Marks the payment method as the backup
Notes related to te payment method
The account’s main information. Required and applicable if the payment method type is ACCOUNT
The account name
Information regarding the account’s payment gateway
The payment gateway related to the payment method
The identifier used on payment gateway
The bank details.Required and applicable if the payment method is set to BANK
The bank account number.
The IBAN code.
The name of the customer’s bank
Institution number of the customer’s bank.
The identifier of the bank branch
The bank account swift number
The sort code
The mandate (sequence) type
The type of the event
The payment gateway’s integration identifier
The country the bank account is located in.
The card’s main information. Required and applicable if the payment method type is CARD
The card’s name
The card’s brand
The card’s first 6 digits
The card’s lat 4 digits
The card’s expiration month
The card’s expiration year
The card’s coutry of issue (3 code based)
Details about the cardholder owner
The name of the card holder
The address related to the card
Additional address information related to the card
The city related to the card
The zip code related to the card
The state related to the card
The country related to the card
Details about the gateway that a card related token was issued
Defines the gateway that issued such token
The gateway integration (identifier)
The card related token
Responses
The request has succeeded
Body
The payment method identifier
POST https://sandbox.crm.com/backoffice/v1/organisations/4db61210-49b0-0267-6de6-82ca63a35903/payment_methods HTTP/1.1
Content-Type: application/json
{
"name": "Primary payment method",
"type": "SETTLEMENT_ACCOUNT",
"is_primary": "true",
"is_backup": "false",
"notes": "some notes",
"settlement_account": {
"name": "Primary Account",
"payment_gateway": {
"gateway": "JCC_MERCHANT",
"gateway_identifier": "0000257"
}
},
"account_debit": {
"account_name": "",
"account_number": "001002001",
"iban": "0143240434320434",
"bank": "Barclays",
"bank_code": "0032933-1123",
"branch": "Ascot",
"swift": "12345678",
"sort_code": "20-02-53",
"mandate": {
"reference": "",
"sign_date": 1
},
"account_type": "SAVINGS",
"integration_id": ""
},
"card": {
"name": "Default Card",
"brand": "VISA",
"first6": "424242",
"last4": "4242",
"expiration_month": 1,
"expiration_year": 2020,
"country_of_issue": "CYP",
"card_holder_details": {
"card_holder_name": "John Doe",
"address_line_1": "Elia Papakyriakou",
"address_line_2": "7 Tower Star",
"address_city": "Nicosia",
"address_zip": "2415",
"address_state": "Nicosia",
"address_country": "CYP"
},
"gateway_token": [
{
"gateway": "SETTLE",
"integration_id": "bce504a4-f712-5262-183c-f58218a7a0ed",
"token": "Xt5EWLLDS7FJjR1c"
}
]
}
}{id}/payment_methods/{payment_method_id}Update an existing payment method for an organisation
Path variables
The organisation (identifier) whose paymeny method will be updated
The payment method (identifier) that will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Marks the payment method as the organisation’s primary one
Marks the payment method as the backup
The payment method notes
The account’s main information. Required and applicable if the payment method type is ACCOUNT
The account name
Information regarding the account’s payment gateway
The payment gateway related to the payment method
The identifier used on payment gateway
The bank details.Required and applicable if the payment method is set to BANK
The bank account number.
The IBAN code.
The name of the customer’s bank
Institution number of the customer’s bank.
The identifier of the bank branch
The bank account swift number
The sort code
The mandate (sequence) type
The type of the event
The payment gateway’s integration identifier
The country the bank account is located in.
Responses
The request has succeeded
Body
The payment method identifier
PUT https://sandbox.crm.com/backoffice/v1/organisations/2b2460d3-9753-148e-2f5b-f30c0562f5a5/payment_methods/5a56dec4-144c-0d73-f749-9030879280ca HTTP/1.1
Content-Type: application/json
{
"name": "",
"is_primary": "true",
"is_backup": "false",
"notes": "some notes",
"settlement_account": {
"name": "Primary Account",
"payment_gateway": {
"gateway": "JCC_MERCHANT",
"gateway_identifier": "0000257"
}
},
"account_debit": {
"account_name": "",
"account_number": "001002001",
"iban": "0143240434320434",
"bank": "Barclays",
"bank_code": "0032933-1123",
"branch": "Ascot",
"swift": "12345678",
"sort_code": "20-02-53",
"mandate": {
"reference": "",
"sign_date": 1
},
"account_type": "SAVINGS",
"integration_id": ""
}
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "5a56dec4-144c-0d73-f749-9030879280ca"
}{id}/payment_methods/{payment_method_id}Remove a payment method from an organisation
Path variables
The organisation (identifier) whose payment method will be removed
The payment method (identifier) that will be removed
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
DELETE https://staging.crm.com/backoffice/v1/organisations/CAD1E31269B76D7A65ACCE45B2E68DFD/payment_methods/CAD1E31269B76D7A65ACCE45B2E68DFD HTTP/1.1
HTTP/1.1 200 OK {id}/payment_methodsRetrieve a list of payment methods for an organisation
Path variables
The organisation (identifier) whose payment methods will be retrieved
Request parameters
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Filter based on payment method type
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The payment method identifier
The payment method identifier
The payment method type
Indicates which payment mehod is the organisation’s primary one
Indicates which payment mehod is the organistaion’s backup one
Notes related to the payment method
The account details (applicable if the payment method is set to ACCOUNT)
The account name
Information regarding the account’s payment gateway
The payment gateway related to the payment method
The identifier used on payment gateway
The bank details.Required and applicable if the payment method is set to BANK
The bank account number.
The IBAN code.
The name of the customer’s bank
Institution number of the customer’s bank.
The identifier of the bank branch
The bank account swift number
The sort code
The country the bank account is located in.
The type of the event
The mandate (sequence) type
The card’s main information. Required and applicable if the payment method type is CARD
The card’s name
The card’s brand
The type of the event
The first 6 digits of the card. Either the card number or the first 6 and last 4 digits must be specified
The last 4 digits f the card. Either the card number or the first 6 and last 4 digits must be specified
The card expiration month
The card expiration year
The card issue country (3 char country code)
Information about the card holder
The name of the card holder
The address related to the card
Additional address information related to the card
The city related to the card
The zip code related to the card
The state related to the card
The country related to the card
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v1/organisations/ff27b927-d346-4369-aba3-4478de764816/payment_methods HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "ff27b927-d346-4369-aba3-4478de764816",
"name": "",
"payment_method_type": "CARD",
"is_primary": "true",
"is_backup": "false",
"notes": "Payment Method Notes",
"settlement_account": [
{
"name": "Primary Account",
"payment_gateway": {
"gateway": "JCC_MERCHANT",
"gateway_identifier": "1245"
}
}
],
"account_debit": {
"account_name": "",
"account_number": "001002001",
"iban": "0143240434320434",
"bank": "Barclays",
"bank_code": "0032933-1123",
"branch": "Ascot",
"swift": "12345678",
"sort_code": "20-02-53",
"account_type": "SAVINGS",
"mandate": {
"reference": "",
"sign_date": 1
},
"gateway_token": [
{
"token": "",
"gateway": "JCC",
"integration": {
"id": "",
"name": ""
}
}
]
},
"card": {
"name": "Default Card",
"brand": "VISA",
"funding_type": "CREDIT",
"first6": "",
"last4": "",
"expiration_month": 1,
"expiration_year": 2020,
"country_of_issue": "CYP",
"cvc": "",
"card_holder_details": {
"card_holder_name": "John Doe",
"address_line_1": "Elia Papakyriakou",
"address_line_2": "7 Tower Star",
"address_city": "Nicosia",
"address_zip": "2415",
"address_state": "Nicosia",
"address_country": "CYP"
},
"gateway_token": [
{
"token": "",
"gateway": "JCC_MERCHANT",
"integration": {
"id": "",
"name": ""
}
}
]
}
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}Disable Enable Products for an Organisation
{id}/products{id}/productsRetrieve all products which are temporarily not available for sale for the specified organisation
Path variables
The organisation (identifier) whose product availability will be retrieved
Request parameters
Filter products based on product SKU, name or description
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeded
Body
The product of which availability is set
The product identifier
The product SKU
The product name
Defines whether the product is available or not
The supported supply method for the product
The type of the event
Delivered to the customer’s address
Picked up by the customer from a venue
Online sales of services
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/organisations/52ed5363-e747-4f41-b91f-e6c5b5e32376/products HTTP/1.1
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"product": {
"id": "c4301882-573a-f04c-7884-5228e7844981",
"sku": "FE1234",
"name": "Freddo Espresso"
},
"availability": "ENABLED",
"supply_method": [
"DELIVERY"
]
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}/reward_terms{id}/reward_terms{id}/reward_termsUpdate the reward commercial terms for a specific organisation
Path variables
The organisation (identifier) that will be updated
Notes
Reward Commercial Terms can be assigned only on Business and Merchant/Service Provider organisations.
Only business users can amend Reward Commercial Terms related to their Business and Merchants/Service Providers.
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Defines whether the organisation can contribute to the customers awards/spends
Defines the reward schemes that the organisation can contribute to contacts rewards
Details about settlement settings
Defines how the organisation will be settled
Details about (award) contribution settings
Defines the contribution that the organisation will cover on each award
Details abouht explicit contributions that will overwrite the default one
On which type the contribution will be applied
The entity (identifier) on which the contribution will be applied
The explicit defined contribution
Details about contact self-service purchase settings
The maximum number of purchase events that a contact can submit in a day
The maximum purchase event amount that a contact can submit
Responses
The request has succeeded
Body
The organisation identifier
PUT https://sandbox.crm.com/backoffice/v2/organisations/7cc1b26a-459f-4b47-a09f-6b121ae947da/reward_terms HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"state": "NOT_BLOCKED",
"reward_schemes": [
"7fdd1338-7064-4fe6-8f4f-0a02324d45c5"
],
"settlement": {
"method": "ON_AWARD",
"contributions": {
"default": 72.91,
"explicit": [
{
"type": "REWARD_OFFER",
"id": "ba0b20d4-f8aa-ab5d-552f-66f813b02f75",
"contribution": 1.22
}
]
}
},
"purchase_restrictions": {
"max_purchases": 12,
"max_amount": 199.99
}
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "7cc1b26a-459f-4b47-a09f-6b121ae947da"
}{id}/reward_termsRetrieve the reward commercial terms of an organisation
Path variables
The organisation (identifier) whose reward terms will be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
Details about terms state changes
Defines whether the organisation can contribute to the customers awards/spends
The date that the state has changed
The user’s identifier
The user’s full name
The user’s credential username
Defines the reward schemes that the organisation can contribute to contacts rewards
The reward scheme that the offer belongs to
The reward scheme identifier
The reward scheme name
Details about settlement settings
Defines how the organisation will be settled
Details about (award) contribution settings
Defines the contribution that the organisation will cover on each award
Details abouht explicit contributions that will overwrite the default one
On which type the contribution will be applied
The entity (identifier) on which the contribution will be applied
The entity name that the contribution will be applied
The explicit defined contribution
Details about contact self-service purchase settings
The maximum number of purchase events that a contact can submit in a day
The maximum purchase event amount that a contact can submit
GET https://sandbox.crm.com/backoffice/v2/organisations/7cc1b26a-459f-4b47-a09f-6b121ae947da/reward_terms HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"state_details": {
"state": "BLOCKED",
"date": 1593607273,
"user": {
"id": "a12b282f-e6ce-e618-0a72-becb3ad78033",
"name": "John Smith"
}
},
"reward_schemes": [
{
"id": "622175bf-03b0-4e9e-9df9-adf85080a889",
"name": "Coffee Scheme"
}
],
"settlement": {
"method": "ON_AWARD",
"contributions": {
"default": 82.91,
"explicit": [
{
"type": "REWARD_OFFER",
"id": "58ffb072-1088-b729-5280-1849fd3969d0",
"name": "1% cashback",
"contribution": 12.11
}
]
}
},
"purchase_restrictions": {
"max_purchases": 1,
"max_amount": 9.01
}
}{id}/tags{id}/tags{id}/tagsUpdate the tags associated with the organisation
Path variables
The organisation (identifier) on which tags will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The tags that will be associated with the activity
Responses
The request has succeded
Body
The organisation identifier
PUT https://sandbox.crm.com/backoffice/v2/organisations/d4187991-4d1a-4aa2-fa3e-ce5fe7fdb7d9/tags HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"tags": [
"96c3cb52-c68f-6ba6-e886-ed28f2b594cb"
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "d4187991-4d1a-4aa2-fa3e-ce5fe7fdb7d9"
}{id}/tagsRetrieve a list of tags that are associated with the organisation
Path variables
The organisation (identifier) of which tags will be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeded
Body
The tag identifier
The tag name
The tag color (hex code) that will be used for visual purposes
GET https://sandbox.crm.com/backoffice/v2/organisations/d82881e9-a909-9d44-4f28-4b30fc1ac276/tags HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "1abe9097-d46a-d2ed-3415-fd3e1439d8d4",
"name": "VIP",
"colour": "#0000FF"
}
]
}{id}/taps{org_id}/taps/{tap_id}{org_id}/taps/{tap_id}{org_id}/taps{org_id}/taps/{tap_id}{id}/tapsCreate a transaction acquiring point for an existing organisation
Path variables
The organisation (identifier) for which a tap will be created
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Information about the organisation’s external references
The transaction acquiring point name
The transaction acquiring point code
Defines whether the transaction acquiring point is active or not
The transaction acquiring point description
IP address of External Device
Port of the External IP
The transaction acquiring point type
Optional specification of external reference
Responses
The request has succeeded
Body
The transaction acquiring point identifier
POST https://sandbox.crm.com/backoffice/v2/organisations/c564e3ef-91f5-3aff-bfc9-263eb5954893/taps HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"name": "POS",
"code": "02451",
"is_active": "true",
"description": "pos system",
"external_ip": "82.102.93.164",
"external_port": "9100",
"tap_type": "EXTERNAL_REF",
"external_type": "ALOHA"
}
HTTP/1.1 201 Created {org_id}/taps/{tap_id}Update a transaction acquiring point for an existing organisation
Path variables
The organisation (identifier) of which tap that will be updated
The transaction acquiring point (identifier) that will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The transaction acquiring point code
Determines whether the transaction acquiring point is active or not
The transaction acquiring point description
IP address of External Device
Port of the External IP
The transaction acquiring point type
Optional specification of external reference
Responses
The request has succeeded
Body
The transaction acquiring point identifier
PUT https://sandbox.crm.com/backoffice/v2/organisations/eff2bcf5-702d-ed03-ca12-f1ba8ac692a2/taps/c564e3ef-91f5-3aff-bfc9-263eb5954893 HTTP/1.1
Content-Type: application/json
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
{
"code": "123456789",
"is_active": "true",
"description": "pos system",
"external_ip": "82.102.93.164",
"external_port": "9100",
"tap_type": "EXTERNAL_REF",
"external_type": "TWINSOFT"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "c564e3ef-91f5-3aff-bfc9-263eb5954893"
}{org_id}/taps/{tap_id}Delete a transaction acquiring point for an existing organisation
Path variables
The organisation (identifier) whose tap will be deleted
The transaction acquiring point (identifier) that will be deleted
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
DELETE https://sandbox.crm.com/backoffice/v2/organisations/eff2bcf5-702d-ed03-ca12-f1ba8ac692a2/taps/c564e3ef-91f5-3aff-bfc9-263eb5954893 HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 204 No Content {org_id}/tapsRetrieve a list of transaction acquiring points for an organisation based on search criteria (e.g. all active transaction acquiring points)
Path variables
The organisation (identifier) whose taps will be retrieved
Request parameters
The value of the search (case insensitive) across name and code
Filter based on tap name
Filter based on tap code
Filter based on type
Filter based on external type
Filter based on whether taps are active or not
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
Information about the organisation’s external references
The tap identifier
The tap name
The tap code
Defines whether the tap is active or not
The tap description
The transaction acquiring point type
Optional specification of external reference
The tap external IP address
The tap external port
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/organisations/eff2bcf5-702d-ed03-ca12-f1ba8ac692a2/taps HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "09b10d6d-1cca-9319-c4c0-09223f45a9a8",
"name": "ePOS",
"code": "EP12",
"is_active": "true",
"description": "electronic POS",
"type": "POS",
"external_type": "TWINSOFT",
"external_ip": "82.102.93.164",
"external_port": "9100"
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{org_id}/taps/{tap_id}Retrieve detailed information for a transaction acquiring point (tap)
Path variables
The organisation (identifier) whose transaction acquiring point will be retrieved
The transaction acquiring point (identifier) that will be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
Information about the organisation’s external references
The tap identifier
The tap name
The tap code
Defines whether the tap is active or not
The tap description
The transaction acquiring point type
Optional specification of external reference
The tap external IP address
The tap external port
GET https://sandbox.crm.com/backoffice/v2/organisations/eff2bcf5-702d-ed03-ca12-f1ba8ac692a2/tapsc564e3ef-91f5-3aff-bfc9-263eb5954893 HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "c564e3ef-91f5-3aff-bfc9-263eb5954893",
"name": "ePOS",
"code": "EP12",
"is_active": "true",
"description": "electronic printer",
"type": "PRINTER_RECEIPT",
"external_ip": "82.102.93.164",
"external_port": "9100"
}{id}/wifi/sites{id}/wifi/sites{id}/wifi/import{id}/wifi/sites/{s_id}/networks{id}/wifi/sites/{s_id}/networks{id}/wifi/sites/{s_id}/guest_control{id}/wifi/sites/{s_id}/guest_control{id}/wifi/sites/{s_id}/devices{id}/wifi/sitesCreate a new WiFi site for the organisation. An organisation can have multiple WiFi site and each one represents the available (& supported) WiFi networks
Path variables
The organisation (identifier) where a site will be created
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The WiFi platform integration
The organisation site identifier as provided from WiFi platform
Responses
The request has succeeded
Body
The organisation network site identifier
POST https://sandbox.crm.com/backoffice/v1/organisations/35b9bc9c-466b-de7a-f23b-ed7a227e309f/wifi/sites HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"integration_id": "c6932bcf-b7e8-4fcc-b168-85ea400fb8ed",
"site_id": "88quh2m6"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "0633ab11-9090-001c-5998-936ae44ff5e0"
}{id}/wifi/sitesRetrieve all WiFi sites for an organisation
Path variables
The organisation (identifier) whose sites will be retrieved
Request parameters
Filter based on integration
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The site identifier
Details about the integration
The integration identifier
The integration name
The WiFi platform site id
Details about the guest control settings
Defines the redirection URL (landing page) that contacts will access when joining a guest wifi network
Details about the wifi networks related to the site
The network identifier
the network name
Defines whether the network is enabled or not
Defines whether the guest access is enabled or not
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v1/organisations/35b9bc9c-466b-de7a-f23b-ed7a227e309f/wifi/sites HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "21f8a49e-b0c3-0334-b708-b2ef9cac8adb",
"integration": {
"id": "81ed6bcd-39ec-214c-5124-9e5ac6cb5dc4",
"name": "UniFi"
},
"site_id": "88quh2m6"
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}/wifi/importRetrieve WiFi data for a specific organisation from a WiFi platform
Path variables
The organisation (identifier) that WiFi data will be imported
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The external reference of the organisation over to the WiFi platform
Defines which data should be imported
Responses
The request has succeeded
POST https://sandbox.crm.com/backoffice/v1/organisations/5e4f4825-b378-d856-c393-1cf3fde458dd/wifi/import HTTP/1.1
Content-Type: application/json
{
"site_id": "wer232rw",
"type": "DEVICES"
}
HTTP/1.1 204 No Content{id}/wifi/sites/{s_id}/networksUpdate a WiFi network for an organisation
Path variables
The organisation (identifier) whose networks will be updated
The site (identifier) of which networks will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The network (identifier) that will be updated
The network name that will be updated
Defines whether the network is enabled or not
Defines whether the network has enabled the guest access or not
Responses
The request has succeeded
Body
The organisation identifier
PUT https://sandbox.crm.com/backoffice/v1/organisations/add25d0e-54fc-c005-ca5e-60f167c35578/wifi/sites/02b80141-8b0a-9803-0762-b76e50d34e9e/networks HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
[
{
"network_id": "fecbacb3-0a03-219a-b86c-6a3b31032410",
"is_enabled": "true",
"is_guest_enabled": "false"
}
]
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "add25d0e-54fc-c005-ca5e-60f167c35578"
}{id}/wifi/sites/{s_id}/networksRetrieve a list of an organisation’s wifi networks based on search criteria (e.g. all enabled wifi networks)
Path variables
The organisation (identifier) of which networks will be retrieved
The site (identifier) of which networks will be retrieved
Request parameters
Filters based on whether the network is enabled or not
Filters based on whether the network has enabled the guest access or not
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The network identifier
The network name
Defines whether the network is enabled or not
Defines whether the network has enabled the guest access or not
GET https://sandbox.crm.com/backoffice/v1/organisations/35b9bc9c-466b-de7a-f23b-ed7a227e309f/wifi/sites/02b80141-8b0a-9803-0762-b76e50d34e9e/networks HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "619387ec31d36b2cf6f9d8af",
"name": "CRM-Nicosia",
"is_enabled": "true",
"is_guest_enabled": "false"
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}/wifi/sites/{s_id}/guest_controlUpdate an organisation’s guest control settings
Path variables
The organisation (identifier) whose guest control will be updated
The site (identifier) of which guest control will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Defines the redirection URL (landing page) that contacts will access when joining a guest wifi network
Responses
The request has succeeded
Body
The organisation network site identifier
PUT https://sandbox.crm.com/backoffice/v2/organisations/35b9bc9c-466b-de7a-f23b-ed7a227e309f/wifi/sites/85b8181b-a1f2-8642-2400-3f9476bfc031/guest_control HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"redirect_url": "https://crm.com/;anding-page"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "0633ab11-9090-001c-5998-936ae44ff5e0"
}{id}/wifi/sites/{s_id}/guest_controlRetrieve guest control settings for an organisation
Path variables
The organisation (identifier) of which guest control will be retrieved
The site (identifier) of which guest control will be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
Defines the redirection URL (landing page) that contacts will access when joining a guest wifi network
GET https://sandbox.crm.com/backoffice/v2/organisations/35b9bc9c-466b-de7a-f23b-ed7a227e309f/wifi/sites/5464d7c1-8bb4-357c-33de-3e0059c6b984/guest_control HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"redirect_url": "https://crm.com/landing-page"
}{id}/wifi/sites/{s_id}/devicesRetrieve a list of devices (access points) for an organisation’s wifi network
Path variables
The organisation (identifier) of which devices will be retrieved
The site (identifier) of which devices will be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The organisation identifier
The device name
The device mac address
GET https://sandbox.crm.com/backoffice/v2/organisations/35b9bc9c-466b-de7a-f23b-ed7a227e309f/wifi/sites/7ae2d47f-39ca-377f-66c1-4f707795b7e3/devices HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"name": "CRM-Nicosia",
"mac-address": "00:00:5e:00:53:af"
}
]
}A pool of common commercial terms that awarded cashback can be redeemed for (e.g. any coffee SKU on weekdays between 3pm to 6pm)
{id}{id}Create a commerce pool
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The commerce pool name
The commerce pool description
The organisation conditions on which commerce balance can be redeemed at
The product conditions on which commerce balance can be redeemed
Defines which type will be used as a condition
The unique identifier of the selected type
The time conditions on which commerce balance can be redeemed
[
{
"month": 1,
"day": "WEDNESDAY",
"start_time": "10:00",
"end_time": "11:00"
}
]The month as a condition (1-12)
The day as a condition (1-7)
The time that condition will be valid from
The time that condition will be valid up to
Validity (from) condition
The award validity type
Amount will be available to be spend from a specific date
Amount will be available to be spend from a specific period
Amount will be available to be spend from the next purchase
The valid from date (applicable for specific date validity type)
The validity from period (applicable for period validity type)
The award validity period unit (applicable for period validity type)
Expiration (valid to) condition
The award expiration type
The date that the amount expires (applicable for specific expiration type)
The expiration period (applicable for period expiration type)
The award validity period unit (applicable for period validity type)
Responses
The request has succeeded
Body
The commerce pool identifier
POST https://sandbox.crm.com/backoffice/v2/commerce_pools HTTP/1.1
Content-Type: application/json
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
{
"name": "Spend on CRM for a specific SKU",
"organisations": [
"c98b829b-30d9-393c-48cb-a96f1ff860d3"
],
"products": [
{
"type": "PRODUCT",
"id": "b1a980fd-5a7a-0dcd-1443-930b38bcaab7"
}
],
"timings": [
{
"day": "MONDAY"
}
],
"validity": {
"validity_type": "NEXT_PURCHASE"
},
"expiration": {
"expiration_type": "YEAR_END"
}
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "c0d4712e-6688-4604-b3d6-d084e4d2dc05"
}{id}Update an existing commerce pool
Path variables
The commerce pool (identifier) that will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The commerce pool name
The commerce pool description
The organisation conditions on which commerce balance can be redeemed at
The product conditions on which commerce balance can be redeemed
Defines which type will be used as a condition
The unique identifier of the selected type
The time conditions on which commerce balance can be redeemed
The month as a condition (1-12)
The day as a condition (1-7)
The time that condition will be valid from
The time that condition will be valid up to
Validity (from) condition
The award validity type
Amount will be available to be spend from a specific date
Amount will be available to be spend from a specific period
Amount will be available to be spend from the next purchase
The valid from date (applicable for specific date validity type)
The validity from period (applicable for period validity type)
The award validity period unit (applicable for period validity type)
Expiration (valid to) condition
The award expiration type
The date that the amount expires (applicable for specific expiration type)
The expiration period (applicable for period expiration type)
The award validity period unit (applicable for period validity type)
Responses
The request has succeeded
Body
The commerce pool identifier
PUT https://sandbox.crm.com/backoffice/v2/commerce_pools/c0d4712e-6688-4604-b3d6-d084e4d2dc05 HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"name": "Spend on CRM for a specific SKU",
"organisations": [
"c98b829b-30d9-393c-48cb-a96f1ff860d3"
],
"products": [
{
"type": "PRODUCT",
"id": "b1a980fd-5a7a-0dcd-1443-930b38bcaab7"
}
],
"timings": [
{
"day": "MONDAY"
}
],
"validity": {
"validity_type": "NEXT_PURCHASE"
},
"expiration": {
"expiration_type": "YEAR_END"
}
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "c0d4712e-6688-4604-b3d6-d084e4d2dc05"
}Retrieves the available commerce pools
Request parameters
The value of the search (case insensitive) across name
Filter based on name
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
Details about spend condition
The commerce pool identifier
The commerce pool name
The commerce pool description
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/commerce_pools HTTP/1.1
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "dc01f65b-a482-48f1-9fda-c163df72f28f",
"name": "Spend Anywhere"
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Retrieve detailed information for a specific commerce pool
Path variables
The commerce pool (identifer) to be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The commerce pool identifier
The commerce pool name
The commerce pool description
The organisation conditions on which commerce balance can be redeemed at
The organisation identifier
The organisation name
The organisation type
The organisation location (address)
Information about the organisation’s location
The name of the location
The address of the location
Additional address information about the location
The state/province/county of the location
The town/city of the location
The postal code of the location
The country code of the location
The latitude of the location
The longitude of the location
The Google textual identifier that uniquely identifies a location
Which product piece of information will be used as a condition; the product itself, it type or brand or family?
The unique identifier of the selected item type.
The name of the entity e.g the product name or product type name
The descirption of the entity.
The time conditions on which commerce balance can be redeemed
The month as a condition (1-12)
The day as a condition (1-7)
The time that condition will be valid from
The time that condition will be valid up to
Valid (from) condition
The award validity type
Amount will be available to be spend from a specific date
Amount will be available to be spend from a specific period
Amount will be available to be spend from the next purchase
The date that the amount will be valid (applicable for specific validity type)
The specific validity period (applicable for period validity type)
The award validity period unit (applicable for period validity type)
Valid (from) condition
The award validity type
Amount will be available to be spend from a specific date
Amount will be available to be spend from a specific period
Amount will be available to be spend from the next purchase
The date that the amount will be valid (applicable for specific validity type)
The specific validity period (applicable for period validity type)
The award validity period unit (applicable for period validity type)
GET https://sandbox.crm.com/backoffice/v2/commerce_pools/c0d4712e-6688-4604-b3d6-d084e4d2dc05 HTTP/1.1
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "c0d4712e-6688-4604-b3d6-d084e4d2dc05",
"name": "Happy Hour",
"organisations": [
{
"id": "308ad557-90de-b56c-fe96-0819cdf8e4d8",
"name": "X-CAFE",
"type": "MERCHANT",
"locations": [
{
"name": "Head Office",
"address_line_1": "Elia Papakyriakou 21",
"address_line_2": "7 Tower Stars",
"state_province_county": "Egkomi",
"town_city": "Nicosia",
"postal_code": "2415",
"country_code": "CY",
"lat": 35.157115,
"lon": 33.313719,
"google_place_id": "ChIJrTLr-GyuEmsRBfy61i59si0"
}
]
}
],
"products": [
{
"item_type": "PRODUCT",
"item_id": "6A24D2B5E44F44B28451FE021FCAD51E",
"name": "Support Service",
"description": "24/7 Support to all users"
}
],
"timings": [
{
"month": 1,
"day": "THURSDAY",
"start_time": "",
"end_time": ""
}
],
"validity": {
"validity_type": "SPECIFIC_DATE",
"specific_date": 1590474228,
"period": 1,
"period_unit": "MONTH"
},
"expiration": {
"expiration_type": "SPECIFIC_DATE",
"specific_date": 1590474228,
"period": 2,
"period_unit": "YEAR"
}
}{id}Creates a single communication for a speciifc Contact
Request headers
Authorization Token
The public api key required for API calls to identify the organisation
Request body
The name of the communication
The GUID of the Contact that the communication will be sent to
The channel that the communication is sent through
The integration that will send the communication
The language of the communication
The recipient’s address or phone according to the channel
Title of push notification (applicable for INAPP channels)
Subtitle (iOS only) of push notification (applicable for INAPP channels)
The actual subject of the communication sent (applicable for EMAIL channels)
The actual content of the communication sent
If set to True then the email and sms opt-out preferences of contact will be ignored
Image for push notification
Push notification URL (deep linking)
The message type that a provisioning provider will send (applicable and required only if the selected integrator is a provisioning provider)
Email Communication (send by provisioning provider)
On Screen Display Communication (send by provisioning provider)
Responses
The request has succeeded
Body
The communication identifier
POST https://stagingapi.crm.com/backoffice/v1/communications HTTP/1.1
api_key: 8c54d563-b991-4b76-8a83-557c08166f95
Content-Type: application/json
{
"name": "Happy Birthday",
"contact_id": "CAD1E31269B76D7A65ACCE45B2E68DFD",
"channel": "EMAIL",
"integration_id": "CAD1E31269B76D7A65ACCE45B2E68DFD",
"language": "ENG",
"recipient": "customer@crm.com",
"subject": "New Rewards Offer",
"content": "",
"ignore_preferences": "true"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "CAD1E31269B76D7A65ACCE45B2E68DFD"
}{id}Retrieve a specific communication
Path variables
The communication (identifier) to be retrieved
Responses
The request has succeeded
Body
The name of the communication
The state of the communication
The channel that the communication is sent through
Has the recipient viewed the communication?
The datetime that the recipient viewed the communication
Has the recipient archived the communication?
The date links in the communication where first clicked by the recipient
The date and time that the communication was created
The language of the communication
The default sender
The email or number of the recipient
Title of push notification (applicable for INAPP channels)
Subtitle (iOS only) of push notification (applicable for INAPP channels)
The actual subject of the communication sent (if applicable)
The actual content of the communication sent
Image for push notification
Push notification URL (deep linking)
The contact that the communication was delivered to
The unique identifier of the contact
The unique code of the contact
The full name of the contact
The message type that a provisioning provider will send (applicable and required only if the selected integrator is a provisioning provider)
Email Communication (send by provisioning provider)
On Screen Display Communication (send by provisioning provider)
The process name or the User name
User identifier if communoication was triggered manually be a user.
GET https://sandbox.crm.com/backoffice/v2/communications/9c656a25-6711-f954-e1d8-4867f0771d75 HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"name": "Happy Birthday",
"state": "PENDING",
"channel": "INAPP",
"is_viewed": true,
"viewed_on": 1583846861,
"is_archived": true,
"clicked_on": 1583846865,
"created_on": 1583846861,
"language": "ENG",
"sender": "dev@crm.com",
"recipient": "jon@crm.com",
"title": "New Festive Beverages",
"subtitle": "20% discount for December",
"subject": "",
"content": "",
"in_app_image_url": "",
"in_app_click_link_url": "",
"contact": {
"id": "CAD1E31269B76D7A65ACCE45B2E68DFD",
"code": "C123",
"name": "John Johnson"
},
"message_type": "MAIL",
"initiated_by": {
"process": "AUTOMATION",
"name": "Registration email",
"id": "AAD1E31269B76D7A65ACCE45B2E68DFD"
}
}Retrieves all available communications
Request parameters
The contact ID for which the communications will be retrieved
The life cycle state of the communications to be retrieved
The channel of the communications to be retrieved
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
The process or action that initiated the communication
Initiated manualy by a user
The user who initiated the communication
The transaction name to which the communication was triggered
Has the recipient viewed the communication?
The email or number of the recipient
Request headers
Authorization Token
The public api key required for API calls to identify the organisation
Responses
The request has succeeded
Body
The communication ID
The name of the communication plan in case this communication was created based on a plan
The state of the communication
The channel that the communication is sent through
Has the recipient viewed the communication?
The datetime that the recipient viewed the communication
Has the recipient archived the communication?
The date links in the communication where first clicked by the recipient
The date and time that the communication was created
The communication’s language
The default sender
The email or number of the recipient
The actual subject of the communication sent (if applicable)
The actual content of the communication sent
Title of push notification (applicable for INAPP channels)
Subtitle (iOS only) of push notification (applicable for INAPP channels)
Image for push notification
Push notification URL (deep linking)
The contact that the communication was delivered to
The unique identifier of the contact
The full name of the contact
The unique code of the contact
The message type that a provisioning provider will send (applicable and required only if the selected integrator is a provisioning provider)
Email Communication (send by provisioning provider)
On Screen Display Communication (send by provisioning provider)
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/communications HTTP/1.1
api_key: 8c54d563-b991-4b76-8a83-557c08166f95
HTTP/1.1 400 Bad Request {id}{id}{id}Creates a communication template
Request headers
Authorization Token
The public api key required for API calls to identify the organisation
Request body
The name of the communication template
Communication template related entity
Channel of communication - subject to integrations
The language that the content is provided in (3-digits)
Title - applicable if template is for push notifications
Subtitle - applicable if template is for push notifications
The subject of the communication of the rich content
The content in rich format
The content in plain format
Image for push notification
Type of image
Push notification URL (deep linking)
Defines whether the communication template is the default one
Responses
The request has succeeded
Body
The communication template identifier
POST https://sandbox.crm.com/backoffice/v1/communication_templates HTTP/1.1
api_key: 8c54d563-b991-4b76-8a83-557c08166f95
Content-Type: application/json
{
"name": "New Rewards Offer Template",
"entity": "INVOICE",
"channel": "SMTP",
"contents": [
{
"language": "ENG",
"title": "New Festive Beverages",
"subtitle": "20% discount for December",
"subject": "",
"rich_content": "",
"plain_content": "",
"in_app_image_url": "",
"in_app_image_type": "UPLOAD",
"in_app_click_link_url": ""
}
]
}{id}Update a communication template
Path variables
The communication template identifier to be updated
Request headers
Authorization Token
The public api key required for API calls to identify the organisation
Request body
Communication template unique id
The name of the communication template
Communication template content id
The language that the content is provided in (3-digits)
Title - applicable if template is for push notifications
Subtitle - applicable if template is for push notifications
The subject of the communication of the rich content
The content in rich format
The content in plain format
Image for push notification
Type of image
Push notification URL (deep linking)
Defines whether the communication template is the default one
Responses
The request has succeeded
Body
The communication template identifier
PUT https://sandbox.crm.com/backoffice/v1/communication_templates/{id} HTTP/1.1
api_key: 8c54d563-b991-4b76-8a83-557c08166f95
Content-Type: application/json
{
"id": "e82c88c8-0c5a-4fc9-97fc-06bed0506578",
"name": "General invoice",
"contents": [
{
"id": "db56a528-fe5a-49d0-8424-87f76caee81a",
"language": "ENG",
"title": "New Festive Beverages",
"subtitle": "20% discount for December",
"subject": "",
"rich_content": "",
"plain_content": "",
"in_app_image_url": "",
"in_app_image_type": "UPLOAD",
"in_app_click_link_url": ""
}
]
}Retrieves all available communication templates
Request parameters
The communication template related entity
Channel of communication - subject to integrations
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Retrieves the communication templates based on their names
Request headers
Authorization Token
The public api key required for API calls to identify the organisation
Responses
The request has succeeded
Body
Unique id of communication template
The name of the communication template
Communication template related entity
Channel of communication
Defines whether the communication template is the default one
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v1/communication_templates HTTP/1.1
api_key: 8c54d563-b991-4b76-8a83-557c08166f95
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "New Rewards Offer Template",
"entity": "INVOICE",
"channel": "SMS"
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Retrieve a single communication template
Path variables
The communication template id
Request headers
Authorization Token
The public api key required for API calls to identify the organisation
Responses
The request has succeeded
Body
Communication template unique id
The name of the communication template
Communication template related entity
Channel of communication
Communication template content id
The language that the content is provided in (3-digits)
Title - provided if template is for push notifications
Subtitle (iOS only) - provided if template is for push notifications
The subject of the communication of the rich content
The content in rich format
The content in plain format
Image for push notification
Type of image
Push notification URL (deep linking)
Defines whether the communication template is the default one
GET https://sandbox.crm.com/backoffice/v1/communication_templates/4AD9C84FA60F9FE407140E20F707726A HTTP/1.1
api_key: 8c54d563-b991-4b76-8a83-557c08166f95
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "e82c88c8-0c5a-4fc9-97fc-06bed0506578",
"name": "New Rewards Offer Template",
"entity": "INVOICE",
"channel": "EMAIL",
"contents": [
{
"id": "db56a528-fe5a-49d0-8424-87f76caee81a",
"language": "ENG",
"title": "New Festive Beverages",
"subtitle": "20% discount for December",
"subject": "",
"rich_content": "",
"plain_content": "",
"in_app_image_url": "",
"in_app_image_type": "UPLOAD",
"in_app_click_link_url": ""
}
]
}{id}Delete a communication template
Path variables
The communication template id to be deleted
Request headers
Authorization Token
The public api key required for API calls to identify the organisation
Responses
Use this API to send a transaction as an email or view it as a web page (to print), the output is based on a configured communication template which must be specified.
Request headers
Authorization Token
The public api key required for API calls to identify the organisation
Request body
Details of entity to be output
Output entity type
Output entity id (e.g. invoice id)
Communication template id to be used for output
Output type
Transaction is sent to the Contact’s email address
Transaction is viewed as a web page (can be printed using web browser)
Responses
The request has succeeded
Body
An HTML based landing page is returned and rendered
The communication template identifier
POST https://sandbox.crm.com/backoffice/v1/printout HTTP/1.1
api_key: 8c54d563-b991-4b76-8a83-557c08166f95
Content-Type: application/json
{
"entity": {
"name": "INVOICE",
"id": "007c08166f95-8c54d563-b991-4b76-8a83"
},
"template_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"action": "EMAIL"
}{id}{id}{id}Creates a single communication plan
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The communication plan’s name
The datetime that the communication plan ends running
The datetime that the communication plan will start running
A list of segments that the communications will be sent to
the segment ID
A list of communication contents set up based on the channels and languages enabled
the IDs of different contents used in this communication plan. Different languages and type of text
The language that the content is provided in (3-digitis)
Title for INAPP push notifications
Subtitle for INAPP push notifications (iOS only)
The subject of the communication of the rich content (not for INAPP)
The content in rich format
The content in plain format
Image for push notification
Type of image
Push notification URL (deep linking)
A list of integrations that will send the emails. One integration/connector per channel should be provided
The message type that a provisioning provider will send (applicable and required only if the selected integrator is a provisioning provider)
Email Communication (send by provisioning provider)
On Screen Display Communication (send by provisioning provider)
The repeat frequency provided as a cron expression pattern
The life cycle state of the Communication Plan
Responses
The request has succeeded
Body
The communication plan identifier
POST https://sandbox.crm.com/backoffice/v2/communication_plans HTTP/1.1
Content-Type: application/json
{
"name": "New Reward Offers",
"end_date": 12345678,
"start_date": 12345678,
"segments": [
"CAD1E31269B76D7A65ACCE45B2E68DFD"
],
"contents": [
{
"language": "ENG",
"title": "New Festive Beverages",
"subtitle": "20% discount for December",
"subject": "",
"rich_content": "",
"plain_content": "",
"in_app_image_url": "",
"in_app_image_type": "UPLOAD",
"in_app_click_link_url": ""
}
],
"integrations": [
"CAD1E31269B76D7A65ACCE45B2E68DFD"
],
"message_type": "MAIL",
"frequency": "0 0 12 * * ?",
"state": "POSTED"
}
HTTP/1.1 200 OK {id}Updates an existing communication plan
Path variables
The ID of the communication plan to be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The communication plan’s name
The datetime that the communication plan will start running
The datetime that the communication plan ends running
A list of segments that the communications will be sent to
the segment ID
A list of communication contents set up based on the channels and languages enabled
the IDs of different contents used in this communication plan. Different languages and type of text
The language that the content is provided in (3-digitis)
Title for INAPP push notifications
Subtitle for INAPP push notifications (iOS only)
The subject of the communication of the rich content (not for INAPP)
The content in rich format
The content in plain format
Image for push notification
Image type
Push notification URL (deep linking)
A list of integrations that will send the emails. One integration/connector per channel should be provided
The message type that a provisioning provider will send (applicable and required only if the selected integrator is a provisioning provider)
Email Communication (send by provisioning provider)
On Screen Display Communication (send by provisioning provider)
The repeat frequency provided as a cron expression pattern
The life cycle state of the Communication Plan
Responses
The request has succeeded
Body
The communication plan identifier
PUT https://sandbox.crm.com/backoffice/v2/communication_plans/CAD1E31269B76D7A65ACCE45B2E68DFD HTTP/1.1
Content-Type: application/json
{
"name": "New Reward Offer",
"start_date": 112345678,
"end_date": 12345678,
"segments": [
"CAD1E31269B76D7A65ACCE45B2E68DFD"
],
"contents": [
{
"language": "ENG",
"title": "New Festive Beverages",
"subtitle": "20% discount for December",
"subject": "",
"rich_content": "",
"plain_content": "",
"in_app_image_url": "",
"in_app_image_type": "UPLOAD",
"in_app_click_link_url": ""
}
],
"integrations": [
"CAD1E31269B76D7A65ACCE45B2E68DFD"
],
"message_type": "MAIL",
"frequency": "0 0 12 * * ?",
"state": "POSTED"
}{id}Deletes a single communication plan
Path variables
The ID of the communication plan to be deleted
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
DELETE https://devapi.crm.com/backoffice/v1/communication_plans/4AD9C84FA60F9FE407140E20F707726A HTTP/1.1
api_key: 8c54d563-b991-4b76-8a83-557c08166f95
HTTP/1.1 200 OK Retrieves all available communication plans
Request parameters
The value of the search across the plan name
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The communication plan identifier
The communication plan name
The datetime that the communication plan will start running
The datetime that the communication plan ends running
The life cycle state of the Communication Plan
The integration identifier
The name of the integration
The channel that the communication is sent through
Details about the organisation from where such event was posted
The organisation identifier
The organisation name
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/communication_plans HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "4AD9C84FA60F9FE407140E20F707726A",
"name": "New Reward Offers",
"start_date": 12345678,
"end_date": 12345678,
"state": "POSTED",
"integrations": {
"id": "CAD1E31269B76D7A65ACCE45B2E68DFD",
"name": "Connection for Emails",
"channel": "INAPP"
},
"owner": {
"id": "4248fab3-67d5-2eb1-eaf6-079ce18cd2ed",
"name": "Bravo Coffee"
}
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Retrieves a specific communication plan
Path variables
The unique ID of the communication plan to be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The name of the communication plan
The datetime that the communication plan ends running
The datetime that the communication plan will start running
A list of segments that the communications will be sent to
the segment ID
The ID of the segment
The name of the segment
A list of communication contents set up based on the channels and languages enabled
the IDs of different contents used in this communication plan. Different languages and type of text
The language that the content is provided in (3-digits)
Title for INAPP push notifications
Subtitle for INAPP push notifications (iOS only)
The subject of the communication of the rich content (not for INAPP)
The content in rich format
The content in plain format
Image for push notification
Type of image
Push notification URL (deep linking)
A list of integrations that will send the communications. One integration/connector per channel should be provided
The unique identifier
The name of the integration
The channel that the communication is sent through
The repeat frequency provided as a cron expression pattern
The message type that a provisioning provider will send (applicable and required only if the selected integrator is a provisioning provider)
Email Communication (send by provisioning provider)
On Screen Display Communication (send by provisioning provider)
The life cycle state of the Communication Plan
GET https://sandbox.crm.com/backoffice/v1/communication_plans/4AD9C84FA60F9FE407140E20F707726A HTTP/1.1 Contacts represent the customers of an organisation, and can either be a person (B2C), or a business (B2B). They are the centre point of CRM.COM, and the starting point of any business flow.
{id}{id}{id}Create a new contact of type ‘person’ or ‘company’
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
A unique contact code, if one is not provided then it will be generated by the system. In the latter case a random, unique 16-digit code will be assigned.
Optionally provide a contact loyalty identifier, also acts as a CIM (typically from an external system)
Type of contact support types include Person and Company.
Contact’s first name
Contact’s middle name
Contact’s surname
The company name, if the contact type is ‘company’
The phone number
The contact’s email address
Information about an address of the contact
The address type. Many of the same type.
A short address name so that it can be easily recognised in a list
Defines whether the address is the primary one (used for billing or communication purposes)
The address line 1 (main address information
The address line 2 (additional information)
The address state/province/county
The address town/city
The address postal code
The latitude of the address
The longitude of the address
The Google textual identifier that uniquely identifies an address
Has the contact opted out from receiving marketing communications via sms?
Has the contact opted out from receiving marketing communications via email?
Optionally provide the contact’s referral code (used when referring a friend). If a code is not provided, then it will be automatically generated by the system
The id of the contact’s category classification
Is the contact excluded from paying taxes?
Create a wallet for the contact?
Method of identifying the contact’s wallet (existing contact)
Value for the identification type, i.e. the email address or phone number
If set to true, then a single account is created for the contact using the system’s default settings, alternatively, use ‘account’ to specificy account settings
Create a single contact account with specific settings. Since this is the first account of the contact, then it will also be marked as the primary one.
The account name. If not specified, then it will be set based on business rules.
The account credit limit. If not specified, then default Credit Terms are applied
The account classification identifier
The id for the account’s payment terms. If not specified, then default Credit Terms are applied
The gender of the contact
The contact’s unique statutory number
Contact’s passport information
Passport number
Passport’s expiry date
Contact’s ID information
ID number
ID’s expiry date
Contact’s celebrated name day
Day of the month
Month of the year
Contact’s date of birth
Day
Month
Year
Company’s registration number
The company’s tax reference number
The company VAT registration numnber
Id for company’s industry
Ids for company’s industry sectors
Industry sector identifier
Notes about the contact
The custom field’s unique key
The custom field’s value
The sales model based on which prices will be applied for this contact. If not specified, then the contact’s type (Person or Company) is used to apply Retail or Wholesale sales models respectivelly.
Responses
The request has succeeded
Body
The identifier for the new contact created
Create a contact for a person
POST https://sandbox.crm.com/backoffice/v2/contacts HTTP/1.1
Content-Type: application/json
{
"code": "8047448052702285",
"loyalty_identifier": "25145083077",
"type": "COMPANY",
"person_name": {
"first_name": "Fernandes",
"middle_name": "Louis",
"last_name": "Kozior"
},
"company_name": "Smith & Sons Ltd.",
"phone": {
"country_code": "CYP",
"number": "99123456",
"type": "FAX"
},
"email_address": "bill@gmail.com",
"address": {
"type": "HOME",
"name": "Engomi office",
"is_primary": "true",
"address_line_1": "21 Elia Papakyriakou",
"address_line_2": "7 Stars Tower",
"state_province_county": "Egkomi",
"town_city": "Nicosia",
"postal_code": "2415",
"country_code": "CYP",
"lat": 35.157115,
"lon": 33.313719,
"google_place_id": "ChIJrTLr-GyuEmsRBfy61i59si0"
},
"language_code": "EN",
"marketing_preferences": {
"sms_opt_out": "true",
"email_opt_out": "false"
},
"referral_code": "fa8f71",
"country_of_agreement": "CYP",
"category_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"is_tax_exempt": true,
"create_wallet": true,
"wallet_identity": {
"type": "EMAIL",
"value": "bill@gmail.com"
},
"create_default_account": "true",
"account": {
"name": "AC001856",
"credit_limit": 100,
"currency_code": "EUR",
"classification_id": "356215f1-8775-c949-cc18-b6da670d319a",
"payment_terms_id": "356215f1-8775-c949-cc18-b6da670d319a"
},
"demographics": {
"gender": "MALE",
"statutory_number": "231224-8424406",
"country_of_residence": "CYP",
"passport": {
"number": "AK123456",
"issuing_country_code": "CYP",
"expiration_date": 1677673128
},
"id_details": {
"number": "809251833",
"issuing_country_code": "CYP",
"expiration_date": 1709295528
},
"name_day": {
"day": 6,
"month": 8
},
"date_of_birth": {
"day": 1,
"month": 3,
"year": 1948
}
},
"company_profile": {
"registration_number": "EPM869233102",
"registration_country": "CYP",
"tax_reference_number": "TPS90398813",
"vat_registration_number": "1206523T",
"industry_id": "69350edc-e0dc-4e2d-a8a1-8f26a2eacc09",
"industry_sectors": [
{
"id": "69350edc-e0dc-4e2d-a8a1-8f26a2eacc09"
}
]
},
"notes": "This customer has been referred by our associate Kerry Jackson.",
"custom_fields": [
{
"key": "back_office",
"value": "0001-12345"
}
],
"sales_model_id": "caf332bc-4e90-47b5-a05d-142b264897b9"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "356215f1-8775-c949-cc18-b6da670d319a"
}{id}Update the information about a contact, it is possible to supply a partial body so that only those items supplied will be updated.
Path variables
The contact identifier that will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Contact’s first name
Contact’s middle name
Contact’s surname
Change the company name, if the contact type is ‘company’
The phone number
Set or change the contact’s email address
Information about an address of the contact
The address type. Many of the same type.
A short address name so that it can be easily recognised in a list
Defines whether the address is the primary one (used for billing or communication purposes)
The address line 1 (main address information
The address line 2 (additional information)
The address state/province/county
The address town/city
The address postal code
The latitude of the address
The longitude of the address
The Google textual identifier that uniquely identifies an address
The contact’s category
Defines whether the contact is tax exempt or not
The gender of the contact
The contact’s unique statutory number
Contact’s passport information
Passport number
Passport’s expiry date
Contact’s ID information
ID number
ID’s expiry date
Contact’s celebrated name day
Day of the month
Month of the year
Contact’s date of birth
Day
Month
Year
Company’s registration number
The company’s tax reference number
The company VAT registration numnber
Id for company’s industry
Ids for company’s industry sectors
Industry sector identifier
Has the contact opted out from receiving marketing communications via sms?
Has the contact opted out from receiving marketing communications via email?
Add or update notes about the contact
The custom field’s unique key
The custom field’s value
The sales model based on which prices will be applied for this contact. If not specified, then the contact’s type (Person or Company) is used to apply Retail or Wholesale sales models respectivelly.
Responses
OK
Body
The updated contact identifier
PUT https://sandbox.crm.com/backoffice/v2/contacts/CAD1E31269B76D7A65ACCE45B2E68DFD HTTP/1.1
Content-Type: application/json
{
"person_name": {
"first_name": "Fernandes",
"middle_name": "Louis",
"last_name": "Kozior"
},
"company_name": "Good Burger",
"phone": {
"country_code": "CYP",
"number": "99123456",
"type": "LANDLINE"
},
"email_address": "bill@gmail.com",
"addresses": {
"type": "HOME",
"name": "Engomi office",
"is_primary": "true",
"address_line_1": "21 Elia Papakyriakou",
"address_line_2": "7 Stars Tower",
"state_province_county": "Egkomi",
"town_city": "Nicosia",
"postal_code": "2415",
"country_code": "CYP",
"lat": 35.157115,
"lon": 33.313719,
"google_place_id": "ChIJrTLr-GyuEmsRBfy61i59si0"
},
"preferred_language_code": "EN",
"category_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"is_tax_exempt": "false",
"demographics": {
"gender": "MALE",
"statutory_number": "231224-8424406",
"country_of_residence": "CYP",
"passport": {
"number": "AK123456",
"issuing_country_code": "CYP",
"expiration_date": 1677673128
},
"id_details": {
"number": "809251833",
"issuing_country_code": "CYP",
"expiration_date": 1709295528
},
"name_day": {
"day": 6,
"month": 8
},
"date_of_birth": {
"day": 1,
"month": 3,
"year": 1948
}
},
"company_profile": {
"registration_number": "EPM869233102",
"registration_country": "CYP",
"tax_reference_number": "TPS90398813",
"vat_registration_number": "1206523T",
"industry_id": "69350edc-e0dc-4e2d-a8a1-8f26a2eacc09",
"industry_sectors": [
{
"id": "69350edc-e0dc-4e2d-a8a1-8f26a2eacc09"
}
]
},
"marketing_preferences": {
"sms_opt_out": "true",
"email_opt_out": "false"
},
"notes": "Notes",
"custom_fields": [
{
"key": "back_office",
"value": "0001-12345"
}
],
"sales_model": {
"id": "caf332bc-4e90-47b5-a05d-142b264897b9",
"name": "Retail",
"description": "Sales model available for all contact Person"
}
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "443b03a2-8ec9-b4ba-7315-f0c638748dc3"
}{id}Get the details of a specific contact
Path variables
The unique identifier of the contact whose details will be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The contact identifier
The contact’s unique code
Type of contact support types include Person and Company.
The full name of the contact based on name display setting
Contact’s first name
Contact’s middle name
Contact’s surname
The company name if the contact type is ‘company’
The phone identifier
The phone number
The contact’s email
Contact’s addresses
[
{
"id": "0df9936c-7d5f-a878-4c05-9b942aa14295",
"type": "BUSINESS",
"name": "Main Office",
"is_primary": true,
"address_line_1": "21 Elia Papakyriakou",
"address_line_2": "7 Stars Tower",
"state_province_county": "Egkomi",
"town_city": "Nicosia",
"postal_code": "2415",
"country_code": "CYP",
"lat": 35.157115,
"lon": 33.313719,
"google_place_id": "ChIJrTLr-GyuEmsRBfy61i59si0"
}
]The address identifier
The address type. Many of the same type.
A short address name so that it’s easily recognised in a list
Defines whether the address is the primary one
The address line 1
The address line 2
The address state/province/county
The address town/city
The address postal code
The latitude of the address
The longitude of the address
The Google textual identifier that uniquely identifies an address
The unique id of the loyalty identifier (CIM)
The loyalty identifier
Has the contact opted out from receiving marketing communications via sms?
Has the contact opted out from receiving marketing communications via email?
Details about the event classification
The category identifier
The category name
The contact’s referral code for refer-a-friend actions via app/portal
Is the contact exempt from paying taxes?
The gender of the contact
The contact’s unique statutory number
Contact’s passport information
Passport number
Passport’s expiry date
Contact’s id information
Id number
Country code where id was issued
Id’s expiry date
Contact’s celebrated name day
Day of the month
Month of the year
Contact’s date of birth
Day
Month
Year
Profile year
Company’s annual turnover
Establishment date
Number of people employeed by the company
Company’s registration number
The company’s tax reference number
The company VAT registration numnber
Id for company’s industry
Ids for company’s industry sectors
The custom field (unique) key
The custom field’s (provided) value
Internal notes about the contact
The interaction status of the contact, retrieved by REDIS
A credit/debit transaction exists in the last 60 days
A credit/debit transaction exists in the last 60-120 days
A credit/debit transaction exists in the last 120+ days
No credit/debit transactions exist
The contact’s total spent amount in the last 12 months, retrieved from REDIS
The contact’s authorisation credentials
The name of the authorisation credential
Authorised credential value
Have credentials been verified?
Contact wallet information
Wallet id
Wallet code
Defines wether a contact is anonymised, when and by whom
Shows whether the contact is anonymised or not
Date on which the contact was anonymised
The user’s identifier
The user’s full name
The user’s credential username
The sales model unique identifier used apply pricing policies for this contact
The sales model unique identifier
The sales model name
The contact’s MRR metrics
The contact’s total MRR
GET https://sandbox.crm.com/backoffice/v2/contacts/9837ee37-a1ab-4a27-9b4b-663c9025a205 HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "9837ee37-a1ab-4a27-9b4b-663c9025a205",
"code": "8047448052702285",
"type": "COMPANY",
"person_name": {
"full_name": "Fernandes Louis Kozior",
"first_name": "Fernandes",
"middle_name": "Louis",
"last_name": "Kozior"
},
"company_name": "Smith & Sons Ltd.",
"phone": {
"id": "5203665d-281d-ad97-6643-ae1038d2f6b7",
"country_code": "CYP",
"number": "99123456",
"type": "LANDLINE"
},
"email_address": "fernandes@gmail.com",
"addresses": [
{
"id": "0df9936c-7d5f-a878-4c05-9b942aa14295",
"type": "ALTERNATIVE",
"name": "Mum's house",
"is_primary": true,
"address_line_1": "21 Elia Papakyriakou",
"address_line_2": "7 Stars Tower",
"state_province_county": "Egkomi",
"town_city": "Nicosia",
"postal_code": "2415",
"country_code": "CYP",
"lat": 35.157115,
"lon": 33.313719,
"google_place_id": "ChIJrTLr-GyuEmsRBfy61i59si0"
}
],
"language_code": "EN",
"loyalty_identifiers": [
{
"id": "3311eb31-1f2c-5d8f-ae0d-d22595bbfb7a",
"identifier": "100000001908"
}
],
"marketing_preferences": {
"sms_opt_out": "true",
"email_opt_out": "false"
},
"category": {
"id": "c8d83493-3f50-40df-adb0-762ec5f41863",
"name": "Delivery Purchase"
},
"referral_code": "fa8f71",
"country_of_agreement": "CYP",
"is_tax_exempt": "false",
"demographics": {
"gender": "FEMALE",
"statutory_number": "231224-8424406",
"country_of_residence": "CYP",
"passport": {
"number": "AK123456",
"issuing_country_code": "CYP",
"expiration_date": 1677673128
},
"id_details": {
"number": "809251833",
"issuing_country_code": "CYP",
"expiration_date": 1709295528
},
"name_day": {
"day": 6,
"month": 8
},
"date_of_birth": {
"day": 1,
"month": 3,
"year": 1948
}
},
"company_profile": {
"profile_year": 1980,
"annual_turnover": 4005000,
"established_on": 62340925,
"number_of_employees": 200,
"registration_number": "EPM869233102",
"registration_country": "CYP",
"tax_reference_number": "TPS90398813",
"vat_registration_number": "1206523T",
"industry_id": "69350edc-e0dc-4e2d-a8a1-8f26a2eacc09",
"industry_sectors": [
"c43d9c79-2e47-44a1-9fd5-44da76c303e6"
]
},
"custom_fields": [
{
"key": "back_office",
"value": "Back Office"
}
],
"notes": "This customer is an associate of Kerry Jackson.",
"interaction_status": "DORMANT",
"total_spend": 245.06,
"currency_code": "EUR",
"credentials": [
{
"name": "EMAIL",
"value": "john.doe@gmail.com",
"is_verified": "true"
}
],
"wallet": {
"id": "3f91e3b1-7a0c-4ca3-9455-aa1bb8d51181",
"code": "251432"
},
"anonymisation": {
"is_anonymised": "false",
"date": 1663064797,
"user": {
"id": "a12b282f-e6ce-e618-0a72-becb3ad78033",
"name": "John Smith",
"username": "johnsmith@crm.com"
}
},
"sales_model": {
"id": "caf332bc-4e90-47b5-a05d-142b264897b9",
"name": "Retail"
}
}Retrieves the list of contacts (can be filtered based on contact attributes)
Notes
Recommended to be used when creating new Orders, Service Requests or Activities by external integrations (e.g. POS Integrators) to identify a contact
Request parameters
The value to be used for searching across Full Name, Company Name, Contact Code, Phone Number, Email Address, Loyalty Identifier, Serial number of a purchased/rental device (case insensitive) or Account number
The contact code to search for
The name of the contact to serach for, applicable only when searching for physical persons (‘person’ type contacts)
The name of the company to serach for,aapplicable only when searching for companies (‘company’ type contacts)
The email address of the contact to search for
The phone number of the contact to search for
The contact’s loyalty identifier to serach for
Search using one of the contact’s identification mediums
Search using the contact’s country of agreement (useful in cases of multi-country setup)
Filter based on the contact’s date of registration
Returns results where the registration date is greater than this value
Returns results where the registration date is greater than or equal to this value
Returns results where the registration date is less than this value
Returns results where the registration date is less then or equal to this value
Filter based on Contact type
Filter based on the unique identifier of the organisation that owns the contact
Filter based on custom fields (the key/value set should be semicolon separated)
Filter using a list of tag ids
Defines whether tags should be retrieved or not
Include contact wallet information in the response?
If set to ‘true’ then any Gift passes redeemed by the contact will also be returned in the response
Retrieve metrics information in the response?
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Retrieve anonymised contacts
The complete phone number of the contact which includes the country’s dial code
Search for a contact using their account information
Search for a contact using one of the available sales models
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Successful Request
Body
The unique contact identifier
The unique contact code
Type of contact support types include Person and Company.
The contact’s full name (used for both ‘person’ and ‘company’ type contacts)
The contact’s email address
The phone identifier
The phone number
The id of the organisation who owns the contact
The unique id of the loyalty identifier (CIM)
The loyalty identifier
The contact’s redeemed Gift passes (also used as a CIM). Available only if ‘include_gift_passes’ parameter was set to ‘true’
The pass code
The contact’s statutory number (if available)
Date of contact registration
The custom field (unique) key
The custom field’s (provided) value
Metrics information about the contact, available only if ‘include_metrics’ is set to ‘true’
Number of subscriptions
Number of reward schemes
Does the contact have a wallet?
Contact wallet information, subject to ‘include_wallet’ parameter
Wallet id
Wallet code
Wallet balance information, a balance per currency is returned
Wallet type
Wallet total balance
Wallet open balance (can be spent without restrictions)
Wallet commerce balance (may be subject to spend conditions)
The sales model of the contact
The sales model unique identifier
The sales model name which has to be unique across all sales models
Tag unique id
Tag name
The colour of the tag - for list view only
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/contacts HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "14B48204E5B44589AE99CC351BC46A2A",
"code": "3517500846607727",
"type": "COMPANY",
"name": "John Doe",
"email_address": "john.doe@crm.com",
"phone": {
"id": "5203665d-281d-ad97-6643-ae1038d2f6b7",
"country_code": "CYP",
"number": "99123456",
"type": "FAX"
},
"owned_by": "bcca12e3-84c1-475e-a57b-35b5d85a8483",
"loyalty_identifiers": [
{
"id": "3311eb31-1f2c-5d8f-ae0d-d22595bbfb7a",
"identifier": "100000001908"
}
],
"gift_passes": [
{
"code": "SIOT9W5GGKQQ4"
}
],
"statutory_number": "0008569412",
"registered_on": 1652342710,
"custom_fields": [
{
"key": "back_office",
"value": "Back Office"
}
],
"metrics": {
"subscriptions": 1,
"reward_schemes": 1,
"has_wallet": true
},
"wallet": {
"id": "9837ee37-a1ab-4a27-9b4b-663c9025a205",
"code": "6304407382072801",
"balances": [
{
"type": "BUSINESS",
"currency_code": "EUR",
"total": 130,
"open": 95.15,
"commerce": 34.85
}
]
},
"sales_model": {
"id": "caf332bc-4e90-47b5-a05d-142b264897b9",
"name": "Retail"
},
"tags": [
{
"id": "609a369e-3f10-492a-8332-679ecbe56b65",
"name": "Maintenance",
"colour": "FR547F"
}
]
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Permanently delete an existing contact, and completely remove all it’s details.
Path variables
Id of the contact to be deleted
Notes
- Anything related to the contact is permanently deleted from the database, this action is not reversible
- Contacts at the Service Owner (contact registry) level cannot be deleted
- Contacts that were created for Businesses that use the Service Owner registry can be deleted at the Business level, BUT NOT at the contact registry level
- Contacts who have rented devices on them (for subscription services), cannot be deleted until the devices have been returned
- No financial validation checks whatsoever are applied prior to deleting a contact (e.g. any unpaid invoices are ignored) - Deleted contacts and their affected entities are excluded from analytics representations
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
DELETE https://sandbox.crm.com/backoffice/v2/contacts/473539a2-1cb9-4674-9260-d68d3d639b5c HTTP/1.1
HTTP/1.1 204 No Content {id}/activity_feed{id}/activity_feedRetrieve the Contact’s activity feed
Path variables
The contact identifier that the activity will be retrieved for
Request parameters
Filter based on activity type
Filter based on the performed date, which may fall within a given date range. The value can be a string with a date in epoch format. Each option must also include an operator. Use up to two options based on the required search (e.g. performed_on[gte]=1618395497&performed_on[lt]=1618395497).
Returns results where the performed date is greater than this value
Returns results where the performed date is greater than or equal to this value
Returns results where the performed date is less than this value
Returns results where the performed date is less then or equal to this value
The page number that should be retrieved
The size (total records) of each page
Defines on which attribute the results should be sorted
Defines how the results will be ordered
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Successful Request
Body
In some cases only parts of the response may be populated, depending on the type of activity
The unique activity identifier
The entity’s number (e.g. an invoice number)
The entity’s reference number (e.g. an invoice reference number)
A code relevant to the entity
The entity’s state
The date and time the activity was created
The activity type
The entity’s type name
The activity name
Notes accompanying the activity
The entity’s total amount
The entity’s due date in case of Invoices
The entity’s expiration date in case of Awards
The name of the reward offer that provided the award
The name of the merchant that the activity was performed at
Top-up activity information
The unique ID of the topped-up entity
The number or code of the topped-up entity
The type of the topped-up entity
Relevant for transfer activities
Details of the entity where the transfer originated from (can be an account or wallet)
The unique id of the transfer origin entity
The number or code of the transfer origin entity
The type of the transfer origin entity
Details of the entity on the receiving end of the transfer
The unique id of the destiantion transfer entity (can be an account or wallet)
The number or code of the destination entity
The type of the destination entity
Details of the contact receiving the transferred funds
Id of the contact receiving transfer of funds
The full name of the contact receiving the transfer
The unique contact code of the contact receiving the transfer
The referred by contact details
The referred by contact identifier
The referred by contact name
The ad hoc return purchase details
The ad hoc return reference number
The date that the ad hoc return is requested
The actual amount that the contact was debiterd due to ad hoc return
The amount that was returned
Payment method(s) information
{
"type": "CASH",
"identity": {
"id": "",
"identifier": "Visa *****1234 03/25"
}
}The type of the event
The type of the event
The unique identifier of the contact’s payment method
A short description of the payment method. Depending on the payment method’s type different information is returned:
- Card: the brand, followed by the last 4 digits of the card plus expiration month/year
- Account debit: Name: Bank code followed by the first 5 and the last 9 digits of the account number/IBAN
- Wallet: Name: Email and/or phone used on registration
How an entity is allocated (e.g. a credit note)
The financial transaction type unique identifier
The financial transaction type name
Purchase discount amount
scheduled date
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/contacts/13cc9948-3560-e10a-e1e4-a73610054933/activity_feed HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "0f7c6a42-68f9-bb46-f0d1-cf24a79f72e6",
"number": "I10003",
"reference_number": "Ref12345678",
"code": "123456789ABE2364",
"state": "POSTED",
"created_date": 1576486645,
"activity_type": "ACTIVITY",
"direction": "OUTGOING",
"notes": "This Invoice is created for November 2019",
"type": "INVOICE",
"total_amount": 200,
"currency_code": "EUR",
"name": "",
"due_date": 1576486645,
"expiration_date": 1576486645,
"reward_offer": "Happy Birthday Offer",
"merchant_name": "Bakery Nicosia",
"topup_entity": {
"id": "CAD1E31269B76D7A65ACCE45B2E68DFD",
"number": "AC00123 John Johnson",
"type": "WALLET"
},
"transfer_origin_entity": {
"id": "CAD1E31269B76D7A65ACCE45B2E68DFD",
"number": "AC00123 John Johnson",
"type": "ACCOUNT"
},
"transfer_dest_entity": {
"id": "CAD1E31269B76D7A65ACCE45B2E68DFD",
"number": "W00123 John Johnson",
"type": "ACCOUNT",
"contact": {
"id": "",
"name": "John Smith",
"code": "89904678"
}
},
"referred_by_contact": {
"id": "4bab629d-0d6b-f93b-4664-82cea61c1422",
"name": "John Doe"
},
"ad_hoc_return": {
"reference_number": "qwewe234-dfsf234324-dwrwerw",
"date": 1601636257,
"amount": 299.99,
"currency_code": "EUR",
"return_amount": 999.99
},
"payment": [
{
"type": "ACCOUNT_DEBIT",
"identity": {
"id": "",
"identifier": "Visa *****1234 03/25"
}
}
],
"allocations": [
{
"id": "",
"name": "Purchase"
}
],
"purchase_discount": 2.4,
"financials": "",
"owner": {
"id": "&686786876HGHJDG",
"name": "John Doe"
},
"priority": "LOW",
"date": "",
"from_time": "",
"to_time": ""
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}Addresses related to a contact
{id}/addresses{id}/addresses/{address_id}{id}/addresses/{address_id}{id}/addresses/{id}/addressesAdd a new address to an existing contact. A contact can have multiple addresses but only one of them is the primary one.
Path variables
The contact identifier for which the address will be added
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Information about an address of the contact
The address type. Many of the same type.
A short address name so that it can be easily recognised in a list
Defines whether the address is the primary one (used for billing or communication purposes)
The address line 1 (main address information
The address line 2 (additional information)
The address state/province/county
The address town/city
The address postal code
The latitude of the address
The longitude of the address
The Google textual identifier that uniquely identifies an address
Responses
Successful Request
Body
The address identifier
POST https://sandbox.crm.com/backoffice/v2/contacts/61c943c8-dfeb-4c09-a25c-b054f48bf244/addresses HTTP/1.1
Content-Type: application/json
{
"type": "BUSINESS",
"name": "Engomi office",
"is_primary": "true",
"address_line_1": "21 Elia Papakyriakou",
"address_line_2": "7 Stars Tower",
"state_province_county": "Egkomi",
"town_city": "Nicosia",
"postal_code": "2415",
"country_code": "CYP",
"lat": 35.157115,
"lon": 33.313719,
"google_place_id": "ChIJrTLr-GyuEmsRBfy61i59si0"
}{id}/addresses/{address_id}Update an existing address of a contact
Path variables
The contact identifier for which the address will be updated
The address identifier that will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Information about an address of the contact
The address type. Many of the same type.
A short address name so that it can be easily recognised in a list
Defines whether the address is the primary one (used for billing or communication purposes)
The address line 1 (main address information
The address line 2 (additional information)
The address state/province/county
The address town/city
The address postal code
The latitude of the address
The longitude of the address
The Google textual identifier that uniquely identifies an address
Responses
Successful Request
Body
The address identifier
PUT https://sandbox.crm.com/backoffice/v2/contacts/61c943c8-dfeb-4c09-a25c-b054f48bf244/addresses/9f0508e7-ea4f-43f3-b260-ce55ab87fa8d HTTP/1.1
Content-Type: application/json
{
"address_type": "HOME",
"address_name": "Mum's house",
"is_primary": "true",
"address_line_1": "21 Elia Papakyriakou",
"address_line_2": "7 Stars Tower",
"state_province_county": "Egkomi",
"town_city": "Nicosia",
"postal_code": "2415",
"country_code": "CYP",
"lat": 35.157115,
"lon": 33.313719,
"google_place_id": "ChIJrTLr-GyuEmsRBfy61i59si0",
"care_of": "n/a"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "9f0508e7-ea4f-43f3-b260-ce55ab87fa8d"
}{id}/addresses/{address_id}Removes a contact address. A single address can be removed at a time
Path variables
The contact identifier for which an addresss will be removed
The address identifier that will be removed
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
DELETE https://sandbox.crm.com/backoffice/v2/contacts/61c943c8-dfeb-4c09-a25c-b054f48bf244/addresses/9f0508e7-ea4f-43f3-b260-ce55ab87fa8d HTTP/1.1
HTTP/1.1 204 No Content {id}/addresses/Retrieves all addresses associated with a single contact.
Path variables
Contact identifier
Request parameters
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
Value to search by name
Responses
Body
The address identifier
The address type. Many of the same type.
A short address name so that it’s easily recognised in a list
Defines whether the address is the primary one
The address line 1
The address line 2
The address state/province/county
The address town/city
The address postal code
The latitude of the address
The longitude of the address
The Google textual identifier that uniquely identifies an address
GET https://sandbox.crm.com/backoffice/v2/contacts/{id}/addresses/ HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "0df9936c-7d5f-a878-4c05-9b942aa14295",
"type": "ALTERNATIVE",
"name": "Mum's house",
"is_primary": true,
"address_line_1": "21 Elia Papakyriakou",
"address_line_2": "7 Stars Tower",
"state_province_county": "Egkomi",
"town_city": "Nicosia",
"postal_code": "2415",
"country_code": "CYP",
"lat": 35.157115,
"lon": 33.313719,
"google_place_id": "ChIJrTLr-GyuEmsRBfy61i59si0",
"care_of": "n/a"
}
]
}{id}/anonymisation{id}/anonymisationContact Anonymisation is the process of encrypting or removing personally identifiable data from data sets so that the person can no longer be identified directly or indirectly. In order to successfully anonymise a Contact there atwo major pre-requisites:
- All accounts of the contact are terminated and this also implies that all account-based entities (e.g. financial transactions, subscirptions) are in a final state.
- The Contact’s Wallet does not have a balance. If contact requests for the data to be anonymised and there’s still money in the Wallet, then this money will be lost.
Path variables
The contact identifier that will be anonymised
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The contact unique identifier to whom the user will transfer the wallet money
Responses
Successful Request
Body
The entity identifier
POST https://sandbox.crm.com/backoffice/v2/contacts/4dc0809f-ed91-4b68-b912-5bd6064d901e/anonymisation HTTP/1.1
Content-Type: application/json
{
"contact_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}{id}/attachments{id}/attachments/{file_id}{id}/attachments{id}/attachmentsConnect an uploaded file to an existing contact using a file (identifier) or URL
Path variables
The contact (identifier) that an attachment will be added
Notes
Integrating attachments upload for Contacts should be based on the following APIs
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The uploaded file signature (identifier) to be attached (file or link should be provided)
The URL endpoint to be attached (file or link should be provided)
The file description
Responses
The request has succeeded
Body
The attachment identifier
POST https://sandbox.crm.com/backoffice/v2/contacts/66451204-4404-894c-4dc6-486c540ece40/files HTTP/1.1
Content-Type: application/json
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
{
"file_id": "30526723-24a3-e4e3-1a75-b26b1b41f05c",
"description": "Screenshot sent by contact"
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "66451204-4404-894c-4dc6-486c540ece40"
}{id}/attachments/{file_id}Delete a specific contact attachment
Path variables
The contact (identifier) whose attachment will be deleted
The attachment (identifier) that will be delted
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
DELETE https://sandbox.crm.com/backoffice/v2/contacts/66451204-4404-894c-4dc6-486c540ece40/files/04c0bebd-8bb0-0b3e-e1a6-716a0fd200b1 HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 204 No Content {id}/attachmentsRetrieve all attachment files for a specific contact
Path variables
The contact (identifier) that attachments will be retrieved
Request parameters
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The attachement identifier
The attachement description
The attached file
The attached file identifier
The attached file URL endpoint
The attached file name
The mime type of the uploaded file
The attached URL endpoint
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/contacts/66451204-4404-894c-4dc6-486c540ece40/files HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "3ae9d64a-8a3b-f1e1-eed6-05b307f926fb",
"description": "Screenshot sent by customer",
"file": {
"id": "0317868f-28f8-9f56-d248-5a78718b38cc",
"url": "https://crmcom.sharepoint.com/:x:/s/servicerequests/EZx2qopbvfN3uj1o3dOqbPm52Ct6bg?rtime=w0ic-hfG2Ug",
"name": "img.png",
"mime": "docx"
},
"url": "https://crmcom.sharepoint.com/:x:/s/servicerequests/EZx2qopbvfN3uj1o3dOqbPm52Ct6bg?rtime=w0ic-hfG2Ug"
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}/otp{id}/validate_otp{id}/otpRequest a one-time-password for a specific contact. The request sends an outbound validation number that can be used to verify the contact.
Path variables
The contact (identifier) that a one-time-password will be created for
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Defines how one time password will be sent
Send otp to contact’s email address
Send otp to contact’s phone number
Responses
The request has succeeded
Body
The obfuscated value of the email or sms used to send the otp
The one time password authentication identifier
POST https://sandbox.crm.com/backoffice/v2/contacts/33749faa-4ef0-426d-f9f0-83b91bf5ab3f/otp HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"method": "SMS"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"obfuscated_value": "+35799***834",
"auth_otp": "731e4023-4c04-4278-8eb5-240651317e46"
}{id}/validate_otpVerifies an one time password that was sent to contact
Path variables
The contact (identifier) for which the one-time-password will be validated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The one time password authentication identifier as generated on one time password request
The one time password that was sent to the contact and should be used for verification purposes
Responses
The request has succeeded
POST https://sandbox.crm.com/backoffice/v2/contacts/{id}/validate_otp HTTP/1.1
Content-Type: application/json
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
{
"auth_otp": "47c7-318202dbe45d",
"code": "654321"
}
HTTP/1.1 204 No Content {id}/organisations{id}/organisationsContact joins an existing organisation
Path variables
The contact (registry) (identifier) that will sign up/out to/from an organisation
Notes
Contacts should belong to the service owner registry and via API integration a user can sign up/off such contacts to/from a business that utilise such service owner contact registry
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The action that should be applied on the organisation
The organisation identifier that the action will be applied
Defines whether the contact has accepted the client service (applicable only if action = SIGNUP)
The contact setting for receiving emails (applicable only if action = SIGN_UP)
The contact setting for receiving sms (applicable only if action = SIGNUP)
The contact setting for consent (applicable only if action = SIGN_UP)
Responses
POST https://sandbox.crm.com/backoffice/v1/contacts/0b2c2111-0294-59f1-8a39-92039444a2f6/organisations HTTP/1.1
Content-Type: application/json
{
"action": "SIGNUP",
"organisation_id": "db50a590-7de3-3b2d-33a6-91a25e83d3e6",
"service_acceptance": "true",
"email_opt_out": "false",
"sms_opt_out": "false",
"consent_state": "ACCEPTED",
"referral_code": "1234"
}
HTTP/1.1 200 OK POST https://sandbox.crm.com/backoffice/v1/contacts/0b2c2111-0294-59f1-8a39-92039444a2f6/organisations HTTP/1.1
Content-Type: application/json
{
"action": "SIGNOFF",
"organisation_id": "db50a590-7de3-3b2d-33a6-91a25e83d3e6"
}
HTTP/1.1 200 OK {id}/loyalty_identifiers{id}/loyalty_identifiers/{loyalty_id}{id}/loyalty_identifiers{id}/loyalty_identifiersAdd a new loyalty identifier to an existing contact. A contact can have multiple loyalty identifiers. A contact’s loyalty identifiers must be unique (per contact).
Path variables
The contact (identifier) whose loyalty identifier will be created
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The loyalty identifier
Responses
The request has succeeded
Body
The loyalty identifier (CIM)
POST https://sandbox.crm.com/backoffice/v2/contacts/731a8b58-46de-654d-3e45-0c3f90970da2/loyalty_identifiers HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"identifier": "123234345624356213"
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "891d84dd-4b3b-84b3-ba87-aa63fed3b88a"
}{id}/loyalty_identifiers/{loyalty_id}Removes a contact loyalty identifier. A single loyalty identifier can be removed at a time
Path variables
The contact (identifier) whose loyalty identifier will be removed
The loylaty (identifier) (CIM based) that will be removed
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
DELETE https://sandbox.crm.com/backoffice/v2/contacts/1be1fa96-1d76-6227-c603-e751d15ff424/loyalty_identifiers/7449929f-f297-8400-2f22-65b1f624130f HTTP/1.1
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
HTTP/1.1 204 No Content {id}/loyalty_identifiersRetrieve the loyalty identifiers for a specific contact
Path variables
The contact (identifier) whose loyalty identiers will be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The loyalty identifier (CIM) identifier
The loyalty identifier
GET https://sandbox.crm.com/backoffice/v2/contacts/7449929f-f297-8400-2f22-65b1f624130f/loyalty_identifiers HTTP/1.1
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "1adaae9e-6dbb-f389-e5d0-8288f0c87a62",
"identifier": "2143454566754"
}
]
}Allow for management of payment methods for contacts.
{id}/payment_methods{id}/payment_methods/{payment_method_id}{id}/payment_methods/{payment_method_id}{id}/payment_methods{id}/payment_methodsAdd a new payment method for a contact. The payment method’s details will be passed to a Payment Gateway Integrator
Path variables
The contact’s unique identifier
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
A short name for the payment method
Only Account Debits can be added as payment methods via the back-end
If the payment method being added is the first one for the contact, then it will automatically become the primary payment method. If another primary method exists, then the new payment method becomes the primary.
If another backup payment method exists, then the new payment method becomes the backup
Payment method notes
The bank details.Required and applicable if the payment method is set to BANK
The bank account number.
The IBAN code.
The name of the customer’s bank
Institution number of the customer’s bank.
The identifier of the bank branch
The bank account swift number
The sort code
The mandate (sequence) type
The type of the event
The payment gateway’s integration identifier
The country the bank account is located in.
The card’s main information. Required and applicable if the payment method type is CARD
The card’s name
The card’s brand
The card’s first 6 digits
The card’s lat 4 digits
The card’s expiration month
The card’s expiration year
The card’s coutry of issue (3 code based)
Details about the cardholder owner
The name of the card holder
The address related to the card
Additional address information related to the card
The city related to the card
The zip code related to the card
The state related to the card
The country related to the card
Details about the gateway that a card related token was issued
Defines the gateway that issued such token
The gateway integration (identifier)
The card related token
Responses
Body
Id of newly created payment method
POST https://sandbox.crm.com/backoffice/v1/contacts/{id}/payment_methods HTTP/1.1
Content-Type: application/json
{
"name": "",
"type": "CARD",
"is_primary": true,
"is_backup": true,
"notes": "",
"account_debit": {
"account_name": "",
"account_number": "001002001",
"iban": "0143240434320434",
"bank": "Barclays",
"bank_code": "0032933-1123",
"branch": "Ascot",
"swift": "12345678",
"sort_code": "20-02-53",
"mandate": {
"reference": "",
"sign_date": 1
},
"account_type": "SAVINGS",
"integration_id": "",
"account_holder_details": {
"account_holder_name": "",
"address_line_1": "",
"address_line_2": "",
"address_state": "",
"address_city": "",
"address_zip": "",
"address_coutry": "",
"use_billing_address": true
},
"country": "CY",
"currency": "EUR"
},
"card": {
"name": "Default Card",
"brand": "VISA",
"first6": "424242",
"last4": "4242",
"expiration_month": 1,
"expiration_year": 2020,
"country_of_issue": "CYP",
"card_holder_details": {
"card_holder_name": "John Doe",
"address_line_1": "Elia Papakyriakou",
"address_line_2": "7 Tower Star",
"address_city": "Nicosia",
"address_zip": "2415",
"address_state": "Nicosia",
"address_country": "CYP"
},
"gateway_token": [
{
"gateway": "SETTLE",
"integration_id": "bce504a4-f712-5262-183c-f58218a7a0ed",
"token": "Xt5EWLLDS7FJjR1c"
}
]
}
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": ""
}{id}/payment_methods/{payment_method_id}Update a payment method for a contact
Path variables
The payment method id to be updated
Notes
JCC Merchant Gateway
- Perform Fingerprint to retrieve the card masked & hashed numbers and the country of issue
- Set the retrieved masked number, hashed number and country of issue on the related “card” collection
Settle Gateway
- Set the phone country code, phone number and msisdn (phone country + number) on the related “phone” collection
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Payment method short name
Marks the payment method as the contact’s primary payment method
Marks the payment method as the backup payment method
The bank details.Required and applicable if the payment method is set to BANK
The bank account number.
The IBAN code.
The name of the customer’s bank
Institution number of the customer’s bank.
The identifier of the bank branch
The bank account swift number
The sort code
The country the bank account is located in.
The mandate (sequence) type
The type of the event
Notes related to the payment method
Responses
Body
The unique identifier of the updated payment method
PUT https://sandbox.crm.com/backoffice/v2/contacts/880e68ca-d42b-4ead-a6c6-34a39b9149e0/payment_methods/9f0508e7-ea4f-43f3-b260-ce55ab87fa8d HTTP/1.1
Content-Type: application/json
{
"name": "",
"is_primary": true,
"is_backup": true,
"account_debit": {
"account_name": "",
"account_number": "001002001",
"iban": "0143240434320434",
"bank": "Barclays",
"bank_code": "0032933-1123",
"branch": "Ascot",
"swift": "12345678",
"sort_code": "20-02-53",
"country": "CY",
"mandate": {
"reference": "",
"sign_date": 1
},
"currency": "EUR",
"account_type": "SAVINGS",
"account_holder_details": {
"account_holder_name": "",
"address_line_1": "",
"address_line_2": "",
"address_state": "",
"address_city": "",
"address_zip": "",
"address_coutry": "",
"use_billing_address": true
}
},
"wallet": "",
"notes": ""
}{id}/payment_methods/{payment_method_id}Deletes a payment method for a contact
Path variables
The id of the contact
The id of the payment method.
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
DELETE https://sandbox.crm.com/backoffice/v1/contacts/JGKDJHAK76786JUGJHDG/payment_methods/SHDGJKSHDJKHS86876HGFHDGSFHSF HTTP/1.1 {id}/payment_methodsRetrieves all payment methods for a single contact
Path variables
The contact identifier whose payment methods will be retrieved
Request parameters
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Filters the contact’s payment methods based on type
Credit/Debit/Prepaid cards
Wallet related to either a card, bank account or has a monetary value
Collect money directly from an account
Filter using primary payment methods
Filter using backup payment methods
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The payment method identifier
USED?
Indicates the contact’s primary payment method
Indicates the contact’s backup payment method
The type of the event
Credit/Debit/Prepaid cards
Wallet related to either a card, bank account or has a monetary value
Collect money directly from an account
The card’s main information. Required and applicable if the payment method type is CARD
The card’s name
The card’s brand
The type of the event
The first 6 digits of the card. Either the card number or the first 6 and last 4 digits must be specified
The last 4 digits f the card. Either the card number or the first 6 and last 4 digits must be specified
The card expiration month
The card expiration year
The card issue country (3 char country code)
Information about the card holder
The name of the card holder
The address related to the card
Additional address information related to the card
The city related to the card
The zip code related to the card
The state related to the card
The country related to the card
The bank details.Required and applicable if the payment method is set to BANK
The bank account number.
The IBAN code.
The name of the customer’s bank
Institution number of the customer’s bank.
The identifier of the bank branch
The bank account swift number
The sort code
The country the bank account is located in.
The type of the event
The mandate (sequence) type
The card’s main information. Required and applicable if the payment method type is CARD
The email used when registering to the walled-based payment method
The phone used when registering to the walled-based payment method
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/contacts/880e68ca-d42b-4ead-a6c6-34a39b9149e0/payment_methods HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "2e58e67a-b551-4780-bd7a-7b065447a799",
"name": "",
"is_primary": true,
"is_backup": "false",
"payment_method_type": "CARD",
"card": {
"name": "Default Card",
"brand": "VISA",
"funding_type": "CREDIT",
"first6": "",
"last4": "",
"expiration_month": 1,
"expiration_year": 2020,
"country_of_issue": "CYP",
"cvc": "",
"card_holder_details": {
"card_holder_name": "John Doe",
"address_line_1": "Elia Papakyriakou",
"address_line_2": "7 Tower Star",
"address_city": "Nicosia",
"address_zip": "2415",
"address_state": "Nicosia",
"address_country": "CYP"
},
"gateway_token": [
{
"token": "",
"gateway": "JCC",
"integration": {
"id": "",
"name": ""
}
}
]
},
"account_debit": {
"account_name": "",
"account_number": "001002001",
"iban": "0143240434320434",
"bank": "Barclays",
"bank_code": "0032933-1123",
"branch": "Ascot",
"swift": "12345678",
"sort_code": "20-02-53",
"country": "CY",
"currency": "EUR",
"account_type": "SAVINGS",
"mandate": {
"reference": "",
"sign_date": 1,
"termination_date": 1
},
"account_holder_details": {
"account_holder_name": "",
"address_line_1": "",
"address_line_2": "",
"address_city": "",
"address_state": "",
"address_zip": "",
"address_country": ""
},
"gateway_token": [
{
"token": "",
"gateway": "SETTLE",
"integration": {
"id": "",
"name": ""
}
}
]
},
"wallet": {
"email": "jsmith@email.com",
"phone": {
"name": "",
"country_code": "",
"number": "",
"msisdn": ""
},
"gateway_token": [
{
"token": "",
"gateway": "SETTLE",
"integration": {
"id": "",
"name": ""
}
}
]
}
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}/people{id}/people/{people_id}{id}/people/{people_id}{id}/people{id}/peopleAdd a new person to a contact’s community
Path variables
The contact (identifier) whose community will be updated by adding a new person
Request headers
Authorization Token
The public api key required for API calls to identify the organisation
Request body
The existing contact (identifier) that will be added as a member to the (parent) contact community (contact id or contact should be specified)
The new contact that will be created and will be added as a member to the (parent) contact community (contact id or contact should be specified)
The contact first name
The contact last name
The contact email address
The contact phone
The phone country code
The phone number
The community relation (identifier) that will be assigned to the new contact member
Defines whether the new contact member will have full permissions
Defines the (explicit) allowed permissions that the new contact member will have
Responses
The request has succeeded
Body
The community relation identifier
POST https://sandbox.crm.com/backoffice/v2/contacts/41531d41-2a77-fc41-5643-d84dfbefc1ff/people HTTP/1.1
api_key: 8c54d563-b991-4b76-8a83-557c08166f95
Content-Type: application/json
{
"contact": {
"first_name": "John",
"last_name": "Doe",
"email_address": "johndoe@crm.com",
"phone": {
"country_code": "CYP",
"number": "22265566"
}
},
"relation_id": "d0eec134-784e-7289-2aa5-32d5323d6e7a",
"is_admin": "true",
"permissions": [
"VIEW_CONTACTS"
]
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "9dcc93dd-4698-afaf-1296-f22824bb5da8"
}{id}/people/{people_id}Update an existing person in a contact’s community
Path variables
The contact (identifier) whose community will be updated
The community person (identifier) that will be updated
Request headers
Authorization Token
The public api key required for API calls to identify the organisation
Request body
The community relation (identifier) that will be assigned to the existing contact member
Defines whether the existing contact member will have full permissions
Defines the (explicit) allowed permissions that the existing contact member will have
Responses
The request has succeeded
Body
The community relation identifier
PUT https://sandbox.crm.com/backoffice/v2/contacts/719ee10e-a6c3-68b3-d5bf-30473eacd927/people/f3ef1fc1-afc8-d3b4-3a6d-3a299acb454c HTTP/1.1
api_key: 8c54d563-b991-4b76-8a83-557c08166f95
Content-Type: application/json
{
"relation_id": "bfd3cc67-2a4b-2900-6fcc-2ad3341f5495",
"is_admin": "false",
"permissions": [
"VIEW_CONTACTS"
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "f3ef1fc1-afc8-d3b4-3a6d-3a299acb454c"
}{id}/people/{people_id}Delete an existing person from a contact’s community
Path variables
The contact (identifier) whose community will be updated, by removing an existing member
The community person (identifier) that will be deleted
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
DELETE https://sandbox.crm.com/backoffice/v2/contacts/5c6de428-9acb-9648-c0ec-5cbcb5dec714/people/0650dff4-53e8-601b-170f-bf522df18f81 HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 204 No Content {id}/peopleLists all people that a contact’s community has
Path variables
The contact (identifier) whose community people will be retrieved
Request parameters
Filter based on whether the contact is a parent or a member in a community
Retrieve all contact communities that such contact is a member to
Retrieve all contacts that are members to such contact’s community
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The contact relationship identifier
The contact (parent or member in the respective community)
The contact identifier
The contact first name
The contact last name
The contact email address
The contact phone number
The phone country code
The phone number
The community relation that the contact has
The community relation identifier
The community relation name
Defines whether the contact member will have full permissions
Defines the (explicit) allowed permissions that the new contact member will have
Defines whether the contact is a parent or a member in a community
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/contacts/323a12a6-90e4-fa30-caa4-63e9552ffb10/people HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "323a12a6-90e4-fa30-caa4-63e9552ffb10",
"contact": {
"id": "19e631ac-4123-1099-d207-2a70fb126186",
"first_name": "John",
"last_name": "Doe",
"email": "johndoe@crm.com",
"phone": {
"country_code": "CYP",
"number": "22265566"
}
},
"relation": {
"id": "9aabba32-82e3-441f-969a-103d81e2f91f",
"name": "Employees"
},
"is_admin": "false",
"permissions": [
"VIEW_CONTACTS"
],
"type": "MEMBER"
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}/rewards{id}/rewards{id}/reward_schemes{id}/rewardsRetrieve a contact’s reward details
Path variables
The contact (identifier) whose reward details will be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
Details about sign up
The date when the contact was signed up for the first time
Details about the organisation from where such event was posted
The organisation identifier
The organisation name
Details about whether the contact can spend or not
Defines whether the contact can spend or not
The date that the contact’s spend blockage was updated
The user’s identifier
The user’s full name
The user’s credential username
Details about the reward tier.
The reward tier identifier
The reward tier name
The designated hexadecimal code of the tier’s color
The account’s value units that accumulated during the last rolling period
The overall accumulated value units
Details about the progression percentage for each reward tier
The progression percentage until the reward tier
Details about the reward tier
The reward tier identifier
The reward tier name
The tier (threshold) value units (inclusive)
The remaining value units to reach this tier
Information about the already signed up reward schemes
The reward scheme identifier
The reward scheme name
The date when the contact was signed up on the specific reward scheme
The email address that was used during sign up (applicable if the reward scheme is a close loop scheme based on email domains)
Defines how customers can sign up to the reward scheme
Contacts will sign up upon registration automatically
Contacts can sign up manually
Contacts can be signed up on a selective and controlled manner (request to sign up), usually based on domain specific emails
GET https://sandbox.crm.com/backoffice/v1/accounts/d12b5b30-98f1-12fb-53db-23c05cfe264a/rewards HTTP/1.1
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "d12b5b30-98f1-12fb-53db-23c05cfe264a",
"sign_up_on": 1583846865,
"sign_up_organisation": {
"id": "7d65bf09-9385-a2a4-c069-1df91e5e9c26",
"name": "CRMdotCOM"
},
"spending_blocked_status": "false",
"spending_blocked_date": 1583846865,
"spending_blocked_user": {
"id": "57a23a0f-dee5-9a18-2edc-2dca904e3712",
"email_address": "johndoe@crm.com",
"first_name": "John",
"last_name": "Doe"
},
"reward_tier": {
"id": "0c85a6e0-6b97-63d8-5c9c-adf0efdf00fc",
"name": "Gold",
"color": "#d4af37",
"period_value_units": 222,
"lifetime_value_units": 333,
"tier_progression": [
{
"percentage": 45.98,
"tier": {
"id": "41ed2390-4058-81a2-d41b-18acaea22c84",
"name": "Gold"
},
"value_units": 2500,
"remaining_value_units": 123
}
]
},
"joined_reward_schemes": [
{
"id": "6f0cb034-7e0c-cdc8-3f62-d734d54aab56",
"name": "CRMdotCOM Scheme",
"signed_up_on": 1583846865,
"email_address": "johndoe@crm.com",
"sign_up_option": "CLOSE_LOOP_SIGN_UP"
}
]
}{id}/rewardsUpdate the reward details of a contact
Path variables
The contact (identifier) whose reward details will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The date that the contact first signed up
The date that the contact first signed up
The organisation that signed up the contact (first time)
The organisation identifier
Defines whether the spending is blocked for the specific contact
Responses
The request has succeeded
Body
The contact identifier
PUT https://sandbox.crm.com/backoffice/v2/contacts/d12b5b30-98f1-12fb-53db-23c05cfe264a/rewards HTTP/1.1
Content-Type: application/json
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
{
"signed_up": {
"date": 1647852385,
"organisation": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}
},
"spend_blocked": "true"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "d12b5b30-98f1-12fb-53db-23c05cfe264a"
}{id}/reward_schemesSign up/out a contact from/to a reward scheme
Path variables
The contact (identifier) that will be signed up/out to/from a reward scheme
Notes
- A user can sign up a contact only to auto-sign up and self-sign up reward schemes.
- A user can sign out a contact from any type of reward schemes.
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The action that should be applied for the reward scheme
The reward scheme that the contact has signed up
The date that the contact has signed up (if not specified, defaults to current date)
Responses
The request was successful
Body
The reward scheme identifier
The request has succeeded
Sign up to a reward scheme
POST https://sandbox.crm.com/backoffice/v1/contacts/84842636-0779-ba89-8757-7c3c74af6bf6/reward_schemes HTTP/1.1
Content-Type: application/json
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
{
"reward_scheme_id": "a66ebb30-4e81-e301-e37d-1c5502af65b0"
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "a66ebb30-4e81-e301-e37d-1c5502af65b0"
}Sign out from a reward scheme
POST https://sandbox.crm.com/backoffice/v2/contacts/84842636-0779-ba89-8757-7c3c74af6bf6/reward_schemes HTTP/1.1
Content-Type: application/json
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
{
"actions": "SIGN_OUT",
"reward_scheme_id": "a66ebb30-4e81-e301-e37d-1c5502af65b0"
}
HTTP/1.1 204 No Content A Contact’s statement is a financial analysis of all financial events performed by or for the contact within a period of time. It includes an opening balance of an account along with all financial events logged for that period and
{id}/statement{id}/statement_details{id}/export_statement{id}/statementRetrieves all financial events of a Contact based on an account and the selected period for the signed-in organisation. Used in conjunction with Get Account Statement Details to produce the complete Contact statement.
Path variables
The contact identifier to retrieve account balances for
Request parameters
Contact’s account id to retrieve balance information for
Specify the account currency for which the statement will be produced. Default is the primary account’s currency
Starting statement period month
Ending statement period month
Starting statement period year
Ending statement period year
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
OK
Body
Account unique identifier
Account number
Statement period
Statement period months
Starting month
Ending month
Statement period year
Starting year
Ending year
Opening balance for account
Closing balance for account
Total credited amount for the selected period
Total debited amount for the selected period
The Account’s Ageing Analysis. The ageing balance is based on the selected Account but it
The total aged balance of the account
Aged balanc eof th eaccount, separated in 5 buckets, each one having a 30 days duration.
Aged balance over 121 days
Balance aged by up to 30 days
Aged balanc eby 31 to 60 days
Aged balanc eby 61 to 90 days
Aged balanc eby 91 to 120 days
GET https://sandbox.crm.com/backoffice/v2/contacts/76D7A65ACCE45B2E68DFDCAD1E31269B/statement HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "c8079ee1-8081-4be1-ab09-5091f55b2d4e",
"number": "A3900853",
"currency_code": "EUR",
"period": {
"month": {
"from": 3,
"to": 3
},
"year": {
"from": 2022,
"to": 2022
}
},
"opening_balance": 100.56,
"closing_balance": 157.8,
"total_credits": 84.05,
"total_debits": 26.81,
"ageing_analysis": {
"balance": 99.99,
"buckets": {
"121": 96.03,
"1_30": 0.99,
"31_60": 0.99,
"61_90": 0.99,
"91_120": 0.99
}
}
}{id}/statement_detailsRetrieves all the statement detail lines for a single Contact, for the given period, used in conjunction with Get Accounts Statement API to create a Contact statement
Path variables
The contact identifier for which to retrieve account journals for
Request parameters
Contact’s account id to retrieve balance information for
Specify the 3-char account currency for which the statement will be produced
Starting statement period month
Ending statement period month
Starting statement period year
Ending statement period year
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
OK
Body
Statement detail lines
Account unique idetifier
Transaction date
Type of financial transaction
Transaction amount
Financial activity information
The reference number of the transaction if available (e.g. reference number of a payment or a transfer)
The activity entity unique id number (e.g. id of an invoice)
Transaction details
Running balance of account right after the financial event was performed.
GET https://sandbox.crm.com/backoffice/v2/contacts/76D7A65ACCE45B2E68DFDCAD1E31269B/statement_details HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "d2ea1d75-0805-4d8c-b212-f31064ee3bff",
"date": "2343342445",
"type": "CREDIT",
"amount": 3.59,
"currency_code": "EUR",
"activity": {
"type": "INVOICE",
"number": "90508992",
"id": "61c943c8-dfeb-4c09-a25c-b054f48bf244"
},
"details": "Sally's Flower Shop",
"running_balance": 14.99
}
]
}{id}/export_statementUse this API to export the contact statement in PDF or CSV format to the user’s email, or send to the contact’s email address
Path variables
The contact id to export statement for
Request headers
Authorization Token
The public api key required for API calls to identify the organisation
Request body
The identifier of the account for which the export will be performed
Statement period starting month
Statement period starting year
Statement period ending month
Statement period ending year
How the statement will be sent
Sent to user’s email
Sent to user’s email
Sent to the Contact’s email address
Responses
POST https://sandbox.crm.com/backoffice/v2/contacts/da60dd8f-b124-439d-a7fe-e1bdbd484c71/export_statement HTTP/1.1
api_key: 8c54d563-b991-4b76-8a83-557c08166f95
Content-Type: application/json
{
"account_id": "da60dd8f-b124-439d-a7fe-e1bdbd484c71",
"currency_code": "EUR",
"from_month": 3,
"from_year": 2022,
"to_month": 3,
"to_year": 2022,
"format": "PDF"
}The following APIs are used to manage tags for contacts. Tags are used to label contacts with one or more keywords so that it can be easily located/filtered when necessary.
{id}/tags{id}/tags{id}/tagsUpdate the tags associated with the contact
Path variables
The contact (identifier) on which tags will be upaded
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The tags that will be associated with the activity
Responses
The request has succeded
Body
The contact identifier
PUT https://sandbox.crm.com/backoffice/v2/contacts/d4187991-4d1a-4aa2-fa3e-ce5fe7fdb7d9/tags HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"tags": [
"96c3cb52-c68f-6ba6-e886-ed28f2b594cb"
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "d4187991-4d1a-4aa2-fa3e-ce5fe7fdb7d9"
}{id}/tagsRetrieve a list of tags that are associated with the contact
Path variables
The contact (identifier) of which tags will be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeded
Body
The tag identifier
The tag name
The tag color (hex code) that will be used for visual purposes
GET https://sandbox.crm.com/backoffice/v2/contacts/d82881e9-a909-9d44-4f28-4b30fc1ac276/tags HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "1abe9097-d46a-d2ed-3415-fd3e1439d8d4",
"name": "VIP",
"colour": "#0000FF"
}
]
}{id}/identities{id}/identitiesRetrieve a list of contact identities based on search criteria (e.g. all contact identities)
Path variables
The contact (identifier) whose identities will be retrieved
Request parameters
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The contact identity identifier
The contact identity type
The contact identity username
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/contacts/5fa7ff61-a960-cfa3-2f93-68a67058489a/identities HTTP/1.1
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "09e4d464-3bae-1eab-1c7c-9166979300fd",
"type": "EMAIL_PASSWORD",
"username": "johndoe@crm.com"
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}Customer Events capture contact financial and marketing interactions for analytical and award purposes. The classification of an event, such as achievement and purchase, determines how CRM.COM will process and award the event.
- Achievement Events represent a contact’s accomplishment of pushing past a goal post (e.g. Facebook like, complete a questionnaire, monetary achievement)
- Purchase Events record the purchase of goods or services by a contact from an external POS or within CRM.COM for the purpose of awarding it or paying for it by spending the wallet balance
- Referral Events represent the events where one contact refers another contact to sign up to the business
{id}/actions{id}{id}/rewardsCreate a new achievement customer event in posted life cycle state
Notes
Customer identification can be achieved by providing one of the following attributes
Request headers
The secret api key required for API calls to ensure that the client is trusted
Authorization Token
Request body
The achievement customer event identifier
The achievement reference number
Defines the contact for whom the achievement is created for
The contact identifier
The contact code
The value of a single contact identification medium (representing a contact)
The purchase classification
The customer event classification identifier
The customer event classification name
The amount related with the achievement
The date that the achievement was performed
Details about the organisation that achievement was submitted from
The organisation identifier
The transaction acquiring point that the event was submitted from (id or code must be specified). TAP and Organisation (id) attributes are semi-optional
The transaction acquiring point identifier
The transaction acquiring point code
Responses
The request has succeeded
Body
The achievement identifier
POST https://sandbox.crm.com/backoffice/v2/achievements HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"id": "b995d649-e9de-637e-5590-1d8f0f24ecdf",
"reference_number": "RF000001",
"contact": {
"id": "847e833b-294f-b3f8-b7b9-543dc0a1bbbb"
},
"classification": {
"id": "c8d83493-3f50-40df-adb0-762ec5f41863"
},
"amount": 131.2,
"date": 1572423477,
"organisation": {
"tap": {
"code": "TAP001"
}
}
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "b995d649-e9de-637e-5590-1d8f0f24ecdf"
}{id}/actionsPerform actions on an existing achievement customer event (e.g. cancel achievement)
Path variables
The achievement (identifier) that will be updated
Request headers
The secret api key required for API calls to ensure that the client is trusted
Authorization Token
Request body
Defines the action that will be applied on the event
Responses
The request has succeeded
Body
The achievement identifier
PUT https://sandbox.crm.com/backoffice/v2/achievements/4c01d5e4-02c9-ae89-4a3c-eaeb3174fcf0/actions HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"action": "CANCEL"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "4c01d5e4-02c9-ae89-4a3c-eaeb3174fcf0"
}Retrieve a list of achievement events based on search criteria (e.g. all posted achievements)
Request parameters
Filter based on contact (identifier)
Filter based on contact code
Filter based on reference number
Filter based on state
Filter based on whether the event amount falls within a given amount range (e.g. amount.[gte]=0.99&amount.[lt]=1.99)
Filter based on whether the performed date falls within a given date range (e.g. performed_date.[gte]=1618395497&performed_date.[lt]=1618395497)
Returns results where the performed date is greater than this value
Returns results where the performed date is greater than or equal to this value
Returns results where the performed date is less than this value
Returns results where the performed date is less then or equal to this value
Filter based on event classification
Filter based on performed on organisation
Filter based on the performed on transaction acquiring point (identifier) that captured the achievement event
Filter based on the performed on transaction acquiring point (code) that captured the achievement event
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The achievement identifier
The achievement reference number
The export definition status
The amount related to the achievement
The date on which the achievement was performed
Details about the related contact
The contact identifier
The contact full name
The contact unique code
Details about the event classification
The classification identifier
The classification name
Details about the organisation from where such event was posted
The organisation identifier
The organisation name
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/achievements HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "1f69c0a7-e3cd-1c6d-9c00-9d6b8f93a007",
"reference_number": "REF1234",
"state": "POSTED",
"amount": 1.99,
"date": 1576486645,
"contact": {
"id": "1c060611-0667-313e-b3bf-4cb70ee81cdf",
"name": "John Doe",
"code": "C123"
},
"classification": {
"id": "c8d83493-3f50-40df-adb0-762ec5f41863",
"name": "Delivery Purchase"
},
"organisation": {
"id": "4248fab3-67d5-2eb1-eaf6-079ce18cd2ed",
"name": "Bravo Coffee"
}
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Retrieve detailed information for an achievement event
Path variables
The achievement (identifier) that will be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The achievement identifier
The achievement reference number
A unique code assigned to the achievement
The export definition status
The date on which the achievement was performed
The amount related with the achievement
Details about the event classification
The classification identifier
The classification name
Details about the related contact
The contact identifier
The contact full name
The contact unique code
Details about the organisation from where such event was posted
The organisation identifier
The organisation name
Information about the organisation’s external references
The tap identifier
The tap name
The tap code
Details about reward amounts
The total awarded amount
Details about fees that were applied on achievement
The total fee amount (sum of all fee amounts)
The fee that was applied on awards (credit wallet)
Details about top-up transaction
The top-up identifier
The top-up code
GET https://devapi.crm.com/backoffice/v2/purchases/0e6dd60a-3163-167d-f456-f924d3e9e1b6 HTTP/1.1
authorization: 4AD9C84FA60F9FE407140E20F707726A
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "0e6dd60a-3163-167d-f456-f924d3e9e1b6",
"reference_number": "REF001",
"life_cycle_state": "CANCELLED",
"reduction_method": "BACK_END",
"payment_medium_identifer": "424242",
"performed_on": 1576486645,
"total_net_amount": 1.59,
"total_tax_amount": 0.41,
"discount_amount": 0.5,
"total_amount": 1.5,
"requested_spend_amount": 1,
"contact": {
"id": "CAD1E31269B76D7A65ACCE45B2E68DFD",
"name": "John Doe",
"code": "CO1234"
},
"account": {
"id": "CEEE83D6E0804A30966F684B0269AD91",
"name": "ACR1234 John Doe",
"number": "ACR1234"
},
"organisation": {
"id": "CEEE83D6E0804A30966F684B0269AD91",
"name": "Bravo Coffee"
},
"tap": {
"id": "CEEE83D6E0804A30966F684B0269AD91",
"name": "ePOS",
"code": "TAP00012"
},
"rewards": {
"total_award_amount": 121.99,
"total_spend_amount": 12.22,
"total_automatic_spend_amount": 2.22,
"total_instant_discount_amount": 4.49,
"total_spend_request_amount": 4.51
},
"products": [
{
"product_sku": {
"id": "CEEE83D6E0804A30966F684B0269AD91",
"sku": "SKU00012",
"name": "Cappuccino",
"description": "Cappuccino Coffee"
}
"quantity": 1,
"net_amount": 1.08,
"tax_amount": 0.51,
"total_amount": 1.59
},
{
"product_family": {
"id": "CEEE83D6E0804A30966F684B0269AD91",
"name": "Chocolates"
},
"quantity": 1,
"net_amount": 1.08,
"tax_amount": 0.51,
"total_amount": 1.59
}
]
}{id}/rewardsGet reward details (awards/spends) for a specific achievement customer event
Path variables
The achievement (identifier) for which rewards details will be retrieved
Request parameters
Filter based on reward type
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The reward type
The reward offer that the promotion pass will consume.
The reward offer identifier
The reward offer name
Defines which redeem methods are allowed
The awarded amount
GET https://sandbox.crm.com/backoffice/v2/achievements/e3e9bad2-9169-e273-12b5-877a8acd3529/rewards HTTP/1.1
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"type": "AWARD",
"reward_offer": {
"id": "c888dd7a-7476-538c-730a-9f924bd82d04",
"name": "Review Offer"
},
"redeem_method": "DEFERRED",
"amount": 9.99
}
]
}{id}/actions{id}{id}/rewards{id}Create a new purchase customer event in posted life cycle state
Notes
Customer identification can be achieved by providing one of the following attributes
- contact id - a unique contact identifier (usually GUID based)
- cim - a unique identification medium representing the customer (e.g. phone number, hashed card number)
- contact token - an OTP token as requested by a contact via CRM.COM applications
- contact code - a unique contact code (usually 8 or 16 characters long)
Product SKUs and Product Families will be created automatically if they are submitted in a purchase and do not exist in CRM.COM.
To integrate purchase estimates in a “submit purchase” flow the following APIs should be called
POST /estimates/purchasesPOST /purchasesby providing the estimates identifier as return from previous API call
Attribute “disable spends” from Purchase Estimates can be explicitly ovewritten by Submit Purchase.
Request headers
The secret api key required for API calls to ensure that the client is trusted
Authorization Token
Request body
The purchase customer event identifier
The purchase reference number
The transaction reference number that will be used for matching purchases (TP Match Mode)
The purchase estimation (identifier) that can be used instead of specifying (again) all purchase attributes
The date that the customer event was performed
The purchase classification
The customer event classification identifier
The customer event classification name
The purchased products. Applicable and required when net/tax/total amounts are not provided
The purchased product sku (product sku and product family are semi-optional)
The purchased product name
The purchased product family (product sku and product family are semi-optional)
The purchased product net amount
The purchased product vat amount
The purchased product total amount (net and vat amount)
The purchased quantity
Details about total transaction amounts (products and transaction amounts are semi-optional)
The net amount
The tax amount
The total amount (net + tax)
The discount amount
Details about the organisation that purchase was submitted from (id or taps are semi-optional)
The organisation identifier
The transaction acquiring point that the event was submitted from (id or code must be specified). TAP and Organisation (id) attributes are semi-optional
The transaction acquiring point identifier
The transaction acquiring point code
The transaction acquiring point that the event was submitted from (id or code must be specified). TAP and Organisation (id) attributes are semi-optional
The transaction acquiring point identifier
The transaction acquiring point code
Defines the contact for whom the purchase is created for (customer identification can be made either using contact id, contact code, cim, contact_token or contact masked card)
The contact identifier
The contact code
The contact cim
The contact OTP token
Information related with the spend request that should be created as part of the purchase
The amount requested to be spent (spend, instant_spend and amount are semi-optional)
Defines whether spend will be calculated across any available balance (e.g. instant offers and available wallet balance) (spend, instant_spend and amount are semi-optional)
Defines whether spend will be calculated only based on instant offers (e.g. free product, amount) (spend, instant_spend and amount are semi-optional)
Defines whether the purchase will be posted successfully only if requested spend amount is fully covered by the available wallet balance
Details about the pass
Defines the pass type
The pass code. For Promotion passes - a Promotion pass will be generated and redeemed as part of the process, the contact_id should also be provided
The pass assocaited pin (if applicable) should be set here for validation
- If validation is successful, the Purchase Event will be created and wallet funds will be consumed
- If validation is unsuccessful, the Purchase Event won’t be created and wallet funds won’t be consumed
The pass one time password (if applicable) - not implemented yet for passes
The unique identifier of the payment medium used in the purchase e.g. the first 8 digits of a credit card
Responses
The request has succeeded
Body
The purchase identifier
Details about reward amounts
The total (actual) spent amount
The spent amount from wallet’s open balance
The spent amount from wallet’s commerce balance
POST https://sandbox.crm.com/backoffice/v2/purchases HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"id": "4c01d5e4-02c9-ae89-4a3c-eaeb3174fcf0",
"reference_number": "RF000001",
"date": 1572423477,
"classification": {
"name": "Delivery"
},
"products": [
{
"product_sku": "FREDESPR001",
"product_name": "Freddo Espresso",
"net_amount": 14.15,
"tax_amount": 1.04,
"total_amount": 15.19,
"quantity": 2
}
],
"transaction_amounts": {
"discount": 1,
},
"organisation": {
"merchant_tap": {
"code": "TAP001"
},
"venue_tap": {
"code": "TAP001"
}
},
"contact": {
"otp": "447212"
}
"pass": {
"code": "SI8276333"
},
"payment_medium_identifier": "4242"
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "4c01d5e4-02c9-ae89-4a3c-eaeb3174fcf0",
"reference_number": "RF123",
"rewards": {
"spend": 1.72
}
}POST https://sandbox.crm.com/backoffice/v2/purchases HTTP/1.1
Content-Type: application/json
{
"transaction_amounts": {
"net": 12.11,
"tax": 0.11,
"discount": 1,
"total": 11
},
"organisation": {
"merchant_tap": {
"code": "TAP001"
},
"venue_tap": {
"code": "TAP001"
}
},
"contact": {
"cim": "93002149"
},
"payment_medium_identifier": "4242"
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "4c01d5e4-02c9-ae89-4a3c-eaeb3174fcf0"
}{id}/actionsPerform actions on an existing purchase customer event (e.g. cancel purchase)
Path variables
The purchase (identifier) that will be canceled
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Defines the action that will be applied on the event
Responses
The request has succeeded
Body
The purchase identifier
PUT https://sandbox.crm.com/backoffice/v2/purchases/91a52c35-fcdd-a328-7708-2b02ac3ff02e/actions HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"action": "CANCEL"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "91a52c35-fcdd-a328-7708-2b02ac3ff02e"
}Retrieve a list of purchase events based on search criteria (e.g. all posted purchases)
Request parameters
Filter based on contact (identifier)
Filter based on contact (code)
Filter based on reference number
Filter based on state
The classification related to the purchase customer event
The organisation that the purchase customer event was performed
The transaction acquiring point that captured the customer event
Filter based on the total amount, which may fall within a given amount range. The value can be a string with an amount in numeric format. Each option must also include an operator. Use up to two options based on the required search (e.g. total_amount[gte]=12.99&total_amount[lt]=99.99).
Returns results where the total amount is greater than this value
Returns results where the total amount is greater than or equal to this value
Returns results where the total amount is less than this value
Returns results where the total amount is less then or equal to this value
Filter based on the performed date, which may fall within a given date range. The value can be a string with a date in epoch format. Each option must also include an operator. Use up to two options based on the required search (e.g. performed_on[gte]=1618395497&performed_on[lt]=1618395497).
Returns results where the performed date is greater than this value
Returns results where the performed date is greater than or equal to this value
Returns results where the performed date is less than this value
Returns results where the performed date is less then or equal to this value
Filter purchases that an ad hoc return was applied on them
Filter purchase based on the applied ad hoc return reference number
Filter based on transaction reference number
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The purchase identifier
The purchase’s reference number
The export definition status
The date on which the purchase was performed
Details about the purchase transaction amounts
The total net amount (all products’ net amount or total transaction net amount)
The total tax amount (all products’ tax amount or total transaction tax amount)
The purchase’s total amount (net + tax)
The purchase’s discount amount
Details about the related contact
The contact identifier
The contact full name
The contact unique code
Details about the event classification
The classification identifier
The classification name
Details about the organisation from where such event was posted
The organisation identifier
The organisation name
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/purchases HTTP/1.1
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "6409b6ba-4cba-b9d9-e5b1-0b568388eb6a",
"reference_number": "REF1234",
"state": "CANCELLED",
"date": 1576486645,
"amounts": {
"net": 1.51,
"tax": 0.49,
"discount": 1,
"total": 1
},
"contact": {
"id": "1c060611-0667-313e-b3bf-4cb70ee81cdf",
"name": "John Doe",
"code": "C123"
},
"classification": {
"id": "c8d83493-3f50-40df-adb0-762ec5f41863",
"name": "Delivery Purchase"
},
"organisation": {
"id": "4248fab3-67d5-2eb1-eaf6-079ce18cd2ed",
"name": "Bravo Coffee"
}
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Retrieve detailed information for a purchase event
Path variables
The purchase (identifier) that will be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The purchase identifier
A unique code assigned to the purchase
The purchase reference number
The transaction reference number (TP Match Mode)
The export definition status
The date on which the purchase was performed
Details about the event classification
The classification identifier
The classification name
Details about purchased products
Details about product SKU
The product identifier
The product sku
The product name
The product description
Details about product family
The product family identifier
The product family
The quantity of the line item
The net amount of the line item
The tax amount of the line item
The total amount (net + tax) of the line item
Details about the purchase transaction amounts
The total net amount (all products’ net amount or total transaction net amount)
The total tax amount (all products’ tax amount or total transaction tax amount)
The purchase’s total amount (net + tax)
The purchase’s discount amount
Details about the related contact
The contact identifier
The contact full name
The contact unique code
The unique identifier of the payment medium used in the purchase e.g. the first 8 digits of a credit card
Details about spend request for a specific amount (as requested by contact)
The requested spend amount
Details about pass redemption
The pass identifier
The pass code
Details about the organisation from where such event was posted
The organisation identifier
The organisation name
Information about the organisation’s external references
The tap identifier
The tap name
The tap code
Details about reward amounts
The total awarded amount
The total redeemed amount
The total (actual) spent amount
Details about ad hoc return of goods
The ad hoc return reference number
The date that ad hoc retun of goods was applied
The amount that was returned
The amount that the customer was debited due to ad hoc return of goods
Details about financial transaction
The financial transaction identifier
The financial transaction number
The financial transaction reference number
Details about financial transaction
The financial transaction identifier
The financial transaction number
The financial transaction reference number
Details about applied fees
The total fee amount (sum of all fee amounts)
The fee that was applied on awards (credit wallet)
The fee that was applied on spends (debit wallet)
GET https://sandbox.crm.com/backoffice/v2/purchases/a0003f83-32c8-da03-200d-d6af0386cb3a HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "a0003f83-32c8-da03-200d-d6af0386cb3a",
"code": "1234WER",
"reference_number": "REF001",
"state": "POSTED",
"date": 1576486645,
"classification": {
"id": "c8d83493-3f50-40df-adb0-762ec5f41863",
"name": "Delivery Purchase"
},
"products": [
{
"product_sku": {
"id": "6aaeaf7c-8e41-f9e8-214a-e62209859a60",
"sku": "SKU00012",
"name": "Cappuccino",
"description": "Cappuccino Coffee"
},
"product_family": {
"id": "61310d09-1521-f288-4475-5b26add58a23",
"name": "Chocolates"
},
"quantity": 1,
"net_amount": 1.08,
"tax_amount": 0.51,
"total_amount": 1.59
}
],
"contact": {
"id": "1c060611-0667-313e-b3bf-4cb70ee81cdf",
"name": "John Doe",
"code": "C123"
},
"organisation": {
"id": "4248fab3-67d5-2eb1-eaf6-079ce18cd2ed",
"name": "Bravo Coffee"
},
"tap": {
"id": "cd953fe3-e2f6-2ae2-8a40-1bd8154c0f29",
"name": "ePOS",
"code": "EP12"
},
"rewards": {
"award": 5.99,
"redeem": 2.01,
"spend": 1.72
}
}{id}/rewardsGet reward details for a specific purchase customer event
Path variables
The purchase (identifier) for which rewards details will be retrieved
Request parameters
Filter based on reward type
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The reward type
The reward offer that the promotion pass will consume.
The reward offer identifier
The reward offer name
Defines which redeem methods are allowed
The awarded/redeemed/spent amount
The awarded product (free product)
The awarded product type
The awarded product identifier
The awarded product name
GET https://sandbox.crm.com/backoffice/v2/purchases/2cd2ba51-63c6-4327-f570-80949e693a08/rewards HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"type": "AWARD",
"reward_offer": {
"id": "c888dd7a-7476-538c-730a-9f924bd82d04",
"name": "Birthday Offer"
},
"redeem_method": "INSTANT",
"amount": 9.23
}
]
}Performs an ad hoc return of goods for a speciifc customer
Notes
No purchase customer events will be cancelled
When an ad hoc return of goods transaction takes place, the customer wallet will be debited for an amount proportional based on the return amount, the identified purchase transaction amount and the award (on total transaction value) provided on that purchase.
debit amount = (return amount/purchase total amount)*award amount
Any spend amount on such purchase should be ignored, as the spend is an event that is triggered real-time and returning any spend amounts can be a complex process due to different spend conditions that apply on awards that the Customer has earned from previous purchases.
Request headers
The secret api key required for API calls to ensure that the client is trusted
Request body
The ad hoc return reference number
The amount of purchased goods that are returned
The date that the ad hoc return is requested
Defines the contact for whom the purchase is created for (customer identification can be made either using contact id, contact code, cim, contact_token or contact masked card)
The contact identifier
The contact code
The contact cim
Details about the organisation that purchase was submitted from (id or taps are semi-optional)
The organisation identifier
The transaction acquiring point that the event was submitted from (id or code must be specified). TAP and Organisation (id) attributes are semi-optional
The transaction acquiring point identifier
The transaction acquiring point code
The transaction acquiring point that the event was submitted from (id or code must be specified). TAP and Organisation (id) attributes are semi-optional
The transaction acquiring point identifier
The transaction acquiring point code
Responses
The request has succeeded
Body
The purchase identifier that ad hoc return is performed against
POST https://sandbox.crm.com/backoffice/v2/purchases/ad_hoc_return HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"reference_number": "RF123",
"amount": 14.56,
"date": 1601636231,
"contact": {
"cim": "93002149"
},
"organisation": {
"merchant_tap": {
"code": "TAP001"
},
"venue_tap": {
"code": "TAP001-V01"
}
}
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "37ed4a1a-0e8f-4691-a8a0-636aea6e47c5"
}Create a new batch to submit a number of purchase events
Notes
Customer identification can be achieved by providing one of the following attributes
- contact id - a unique contact identifier (usually GUID based)
- cim - a unique identification medium representing the customer (e.g. phone number, hashed card number)
- contact token - an OTP token as requested by a contact via CRM.COM applications
- contact code - a unique contact code (usually 8 or 16 characters long)
Request headers
Authorization Token
The public api key required for API calls to identify the organisation
Request body
The batch identifier
The batch name
The purchase events that will be submitted as part of the batch process
The purchase customer event identifier
The purchase reference number
The transaction reference number that will be used for matching purchases (TP Match Mode)
The purchase estimation (identifier) that can be used instead of specifying (again) all purchase attributes
The date that the customer event was performed
The purchase classification
The customer event classification identifier
The customer event classification name
The purchased products. Applicable and required when net/tax/total amounts are not provided
The purchased product sku (product sku and product family are semi-optional)
The purchased product name
The purchased product family (product sku and product family are semi-optional)
The purchased product net amount
The purchased product vat amount
The purchased product total amount (net and vat amount)
The purchased quantity
Details about total transaction amounts (products and transaction amounts are semi-optional)
The net amount
The tax amount
The total amount (net + tax)
The discount amount
Details about the organisation that purchase was submitted from (id or taps are semi-optional)
The organisation identifier
The transaction acquiring point that the event was submitted from (id or code must be specified). TAP and Organisation (id) attributes are semi-optional
The transaction acquiring point identifier
The transaction acquiring point code
The transaction acquiring point that the event was submitted from (id or code must be specified). TAP and Organisation (id) attributes are semi-optional
The transaction acquiring point identifier
The transaction acquiring point code
Defines the contact for whom the purchase is created for (customer identification can be made either using contact id, contact code, cim, contact_token or contact masked card)
The contact identifier
The contact code
The contact cim
The contact OTP token
Details about the pass
Defines the pass type
The pass code. For Promotion passes - a Promotion pass will be generated and redeemed as part of the process, the contact_id should also be provided
The pass assocaited pin (if applicable) should be set here for validation
- If validation is successful, the Purchase Event will be created and wallet funds will be consumed
- If validation is unsuccessful, the Purchase Event won’t be created and wallet funds won’t be consumed
The pass one time password (if applicable) - not implemented yet for passes
The unique identifier of the payment medium used in the purchase e.g. the first 8 digits of a credit card
Responses
The request has succeeded
Body
The batch identifier
POST https://sandbox.crm.com/backoffice/v2/purchases/batches HTTP/1.1
api_key: 8c54d563-b991-4b76-8a83-557c08166f95
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
Content-Type: application/json
{
"id": "65bd03bf-b33e-469d-a8cc-505654d3df49",
"name": "EOD Events",
"events": [
{
"id": "4c01d5e4-02c9-ae89-4a3c-eaeb3174fcf0",
"reference_number": "RF000001",
"performed_on": 1572423477,
"payment_medium_identifier": "42424242",
"contact": {
"cim": "93002149"
},
"products": [
{
"product_sku": "FREDESPR001",
"product_name": "Freddo Espresso",
"net_amount": 14.15,
"tax_amount": 1.04,
"total_amount": 15.19,
"quantity": 2
}
],
"merchant_tap": {
"code": "TAP001"
},
"venue_tap": {
"code": "TAP001-V01"
},
"classification": {
"name": "Delivery Purchase"
}
}
]
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "65bd03bf-b33e-469d-a8cc-505654d3df49"
}Get a list of purchase batches and process status
Request parameters
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The public api key required for API calls to identify the organisation
Responses
The request has succeeded
Body
The batch identifier
The batch name
Details about processing time frame
The date on which the batch was performed
Details about batch events
The number of events submitted
The number of events that were successfully processed
The number of events that failed to be processed
The number of events that were processed
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/purchases/batches HTTP/1.1
api_key: 8c54d563-b991-4b76-8a83-557c08166f95
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "65bd03bf-b33e-469d-a8cc-505654d3df49",
"name": "EOD File",
"dates": {
"start": 1606814571
},
"events": {
"submitted": 2,
"success": 1,
"failure": 1,
"processed": 2
}
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Retrieve details for a specific batch of purchase events
Path variables
The batch (identifier) that will be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The batch identifier
The batch name
Details about processing time frame
The date on which the batch was performed
A list of all processed purchase events
The purchase event identifier
The purchase event reference number
The time that the purchase event was processed
The status of the processed purchase event
GET https://sandbox.crm.com/backoffice/v2/purchases/batches/65bd03bf-b33e-469d-a8cc-505654d3df49 HTTP/1.1
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "65bd03bf-b33e-469d-a8cc-505654d3df49",
"name": "EOD Batch",
"dates": {
"start": 1606814160
},
"events": [
{
"id": "65bd03bf-b33e-469d-a8cc-505654d3dfQQ",
"reference_number": "RF000001",
"processed_at": 1606814160,
"process_status": "PENDING"
}
]
}{id}/actions{id}{id}/actionsPerform actions on an existing referral customer event (e.g. cancel referral)
Path variables
The referral (identifier) that will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Defines the action that will be applied on the event
Responses
The request has succeeded
Body
The referral event identifier
PUT https://sandbox.crm.com/backoffice/v2/referrals/e3e9bad2-9169-e273-12b5-877a8acd3529/actions HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"action": "CANCEL"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "e3e9bad2-9169-e273-12b5-877a8acd3529"
}Retrieve a list of referral events based on search criteria (e.g. all posted referrals)
Request parameters
The referred contact identifier
The referred by contact identifier
The referral’s reference number
Filter based on the performed date, which may fall within a given date range. The value can be a string with a date in epoch format. Each option must also include an operator. Use up to two options based on the required search (e.g. performed_on[gte]=1618395497&performed_on[lt]=1618395497).
Returns results where the performed date is greater than this value
Returns results where the performed date is greater than or equal to this value
Returns results where the performed date is less than this value
Returns results where the performed date is less then or equal to this value
Filter based on state
The organisation that the referral customer event was performed
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The referral identifier
The referral reference number
Details about the referred contact
Details about the related contact
The contact identifier
The contact full name
The contact unique code
Details about the referred by contact
Details about the related contact
The contact identifier
The contact full name
The contact unique code
The export definition status
Details about the organisation from where such event was posted
The organisation identifier
The organisation name
The date on which the referral was performed
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/referrals HTTP/1.1
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "e3e9bad2-9169-e273-12b5-877a8acd3529",
"reference_number": "REF1234",
"referred": {
"contact": {
"id": "CAD1E31269B76D7A65ACCE45B2E68DFD",
"name": "John Johnson",
"code": "C123"
}
},
"referred_by": {
"contact": {
"id": "CAD1E31269B76D7A65ACCE45B2E68DFD",
"name": "John Johnson",
"code": "C123"
}
},
"state": "POSTED",
"organisation": {
"id": "4248fab3-67d5-2eb1-eaf6-079ce18cd2ed",
"name": "Bravo Coffee"
},
"date": 1576486645
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Retrieve detailed information for a referral event
Path variables
The referral event (identifier) that will be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The referral identifier
The referral reference number
The export definition status
The date on which the referral was made
Details about referred contact
Details about the related contact
The contact identifier
The contact full name
The contact unique code
Details about referred by contact
Details about the related contact
The contact identifier
The contact full name
The contact unique code
Details about the organisation from where such event was posted
The organisation identifier
The organisation name
Details about reward amounts
The total awarded amount
GET https://stagingapi.crm.com/backoffice/v1/referrals/CEEE83D6E0804A30966F684B0269AD91 HTTP/1.1
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "CEEE83D6E0804A30966F684B0269AD91",
"reference_number": "REF001",
"life_cycle_state": "CANCELLED",
"performed_on": 1576486645,
"referred_contact": {
"id": "CAD1E31269B76D7A65ACCE45B2E68DFD",
"name": "John Doe",
"code": "CO1234"
},
"referred_account": {
"id": "CEEE83D6E0804A30966F684B0269AD91",
"name": "ACR1234 John Doe",
"number": "ACR1234"
},
"organisation": {
"id": "CEEE83D6E0804A30966F684B0269AD91",
"name": "Bravo Coffee"
},
"rewards": {
"total_award_amount": 121.99
},
"referred_by_contact": {
"id": "b47cc2a3-6e00-b826-6bb5-48849e222e2a",
"name": "Jane Doe",
"code": "45679"
},
"referred_by_account": {
"id": "0a1c62c3-75cc-7b65-d7c8-9ce59f7ad6cc",
"name": "AR567 Jane Doe",
"number": "AR567"
}
}{id}{id}{id}{id}/actions{id}/history{id}/ownershipCreate a new device
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The device’s serial number
The device electronic id
The device’s product (identifier) - product must be of traceable physical good classification
The warehouse (identifier) at which the device will be located, required only when devices are imported to a warehouse
The contact (identifier) that owns such device, required only when a contact registers his/her own device
The spatial location of the device (when located in the warehouse)
The device characteristics. The allowed set of characteristics are defined by the device’s product specification.
The characteristic’s key which is uque across the set of configured characteristics
The actual value of the characteristic.
The custom field’s unique key
The custom field’s value
The device status
Responses
The request has succeeded
Body
The device identifier
POST https://sandbox.crm.com/backoffice/v2/devices HTTP/1.1
Content-Type: application/json
{
"serial_number": "STB123456",
"electronic_id": "I243WER",
"product_id": "f4b9dc04-b06f-1f57-bb9a-a845851b91e8",
"warehouse_id": "d538824d-7efe-3f9d-5d11-701efca5fe40",
"contact_id": "81dd0800-be43-d43a-a727-77d6c7606036",
"spatial_location": "1C",
"characteristics": [
[
{
"key": "static-ip",
"value": "10.10.01.10"
}
]
],
"custom_fields": [
{
"key": "back_office",
"value": "0001-12345"
}
]
}{id}Update a single device
Path variables
The device (identifier) to be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The device’s new state (a user can update a device state to Used and Blocked only, other states are set only by business operations/processes)
The spatial location of the device
The device characteristics (specified per product, product type or device)
The characteristic’s key which is uque across the set of configured characteristics
The actual value of the characteristic.
The custom field’s unique key
The custom field’s value
The device status
Detailed information of when the device was at first initialised on a subscription. Informaiton is set only once when the device is added to the first subscription either as a sold item or a rented one. This information is never reset, even if the device is returned to the warehouse or given to another contact.
The initialisation date
The user who performe dthe action that adds the service to the first subscription
Responses
The request has succeeded
Body
The device identifer
PUT https://sandbox.crm.com/backoffice/v2/devices/0b8e03c1-01e4-9c44-533a-d55b9ab0821e HTTP/1.1
Content-Type: application/json
{
"state": "BLOCKED",
"spatial_location": "1D",
"characteristics": [
[
{
"key": "static-ip",
"value": "10.10.01.10"
}
]
],
"custom_fields": [
{
"key": "back_office",
"value": "0001-12345"
}
],
"status_id": "9ce41a61-4c47-c06a-1c74-191f496903ae",
"iniaitalisation_details": {
"date": 1666862814,
"user_id": "9ce41a61-4c47-c06a-1c74-191f496903ae"
}
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "0b8e03c1-01e4-9c44-533a-d55b9ab0821e"
}{id}Delete a single device
Path variables
The device (identifier) to be deleted
Request headers
Authorization Token
The public api key required for API calls to identify the organisation
Responses
The request has succeeded
DELETE https://sandbox.crm.com/backoffice/v2/devices/f42971d4-cfcb-963b-6213-7e2b8c82b30c HTTP/1.1
api_key: 8c54d563-b991-4b76-8a83-557c08166f95
HTTP/1.1 204 No Content Retrieve a list of devices based on search criteria (e.g. all rented devices)
Request parameters
Search for devices using their serial number, mac address or electronic ID
Filter based on device’s state(s)
Filter based on serial number
Filter based on electronic id
Filter based on mac address
Filter based on subscription
Filter based on the contact that owns/bought/brought/rented such devices
Filter based on the organisation that owns such devices
Filter based on the integrator (e.g. provisioning provider) that provisions the device
If set to true, then list all warehouse devices that can be provded to contacts as rentals i.e such devices have a rental price in the product catalogue. It is important to note that only devices located in the business’s warehouse are returned
Defines whether Application and Platform details should be returned or not
Defines whether WiFi platform details should be returned or not
Defines whether subscription and enabled services should be returned or not
Defines whether custom fields should be retrieved or not (via List/Get APIs)
Filters based on custom fields (key/value set should be semicolon separated)
Defines whether characteristics should be returned or not
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Filter based on device status
Search for devices based on their spatial location in the warehouse
Filter based on product
Filter only the devices that currently are in the warehouse
Filter based on product family
Filter based on product type
Defines whether only reserved devices will be retrieved or not
The date on which the device was initialised for the first time. Filter supports gt, gte,lt, lte operators
The user who performed the device’s first initialisation
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The device identifier
The device’ state
The device’s serial number
Details about the application
The application identiier
The application name
The date from which the device is located at the contact’s premises. Returned only when listing devices linked to a subscription (i.e subscirpiton provided as input)
The product identifier
The product SKU code
The product name
Details about the device’s ownership
The ownership type
The device owner identifier
The name of the device owner
The enabled services for the device. List of services includes all services of the specified subscripption.
Details about the enabled services for the device
The enabled service identifier
The enabled service life cycle state
Details about a product
The product identifier
The product SKU code
The product name
The product characteristics
[
[
{
"key": "static-ip",
"value": "10.10.01.10",
"label": "Static IP"
}
]
]The Characteristic’s key which is uque across the set of configured characteristics
The actual value of the characteristic.
The characteristic’s label used for UI purposes
The subscription identifier
The subscription code
Details about the integration
The integration identifier
The integration name
Details about the device WiFi platform status
The current WiFi status of the device
The last time that the device was WiFi authorized
The custom field (unique) key
The custom field’s (provided) value
The device electronic id
The device’s operation platform (Application Devices)
The device’s MAC address
The device’s registration token
The device status
The device status identifier
The device status name
The device characteristics (specified per product, product type or device)
The Characteristic’s key which is uque across the set of configured characteristics
The actual value of the characteristic.
The characteristic’s label used for UI purposes
Defines whether the device is reserved or not
The business entity from which the device is reserved
The business entity from which the device is reserved for
The business entity identifier that such device is reserved by
The business entity number that such device is reserved by
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/devices HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "f9ce56ed-f1ce-a8f1-f9e8-e1db5fb2cb33",
"state": "NEW",
"serial_number": "STB123456",
"application": {
"id": "af9c61d3-7685-e31f-3387-27c42858e868",
"name": "Best Coffee App"
},
"provided_on": 1642770980,
"product": {
"id": "e283a863-18e1-7cae-48c4-7433bf28cf97",
"sku": "ABC-12345",
"name": "ABC"
},
"warehouse": {
"id": "4248fab3-67d5-2eb1-eaf6-079ce18cd2ed",
"name": "Nicosia headquarters"
},
"ownership": {
"type": "RETAILER",
"id": "5f67324c-1076-618b-8d29-012efde9485e",
"name": "CRM"
},
"enabled_services": [
{
"id": "",
"life_cycle_state": "",
"product": {
"id": "a0f79973-d4b3-db89-4276-cb4abcccd842",
"sku": "STB",
"name": "Set-top-box",
"measurement_unit": "MB"
}
}
],
"subscription": {
"id": "5535e087-3e27-d2c8-249f-54fe0c1307a4",
"code": "SUB001"
},
"provisioning": {
"id": "81ed6bcd-39ec-214c-5124-9e5ac6cb5dc4",
"name": "UniFi"
},
"wifi": {
"status": "OFFLINE",
"last_auth_date": "1642767506"
},
"custom_fields": [
{
"id": "f68fad29-4a1b-3a1e-5cfa-6540a5b1609a",
"key": "back_office",
"label": "Back Office",
"description": "The account's back office code",
"tooltip": "",
"visible": true,
"field": "RADIO_BUTTONS",
"entity": "DEVICES"
}
],
"electronic_id": "I243WER"
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Retrieve detailed information for a device
Path variables
The device (identifier) to be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The device identifier
The device’ state
The device’s MAC address
The device’s operation platform (Application Devices)
The device’s registration token for push notifications
The date that such device was registered by the contact
Details about the application
The application identiier
The application name
Details about the device WiFi platform status
The current WiFi status of the device
The last time that the device was WiFi authorized
The device serial number
The device’s spatial location when located in a warehouse
The product identifier
The product SKU code
The product name
Details about the device’s ownership
The ownership type
The device owner identifier
The name of the device owner
The order from which the device is sold to the contact
The order identifier
The order number
The services that the device is enabled to
Details about the enabled services for the device
The enabled service identifier
The enabled service life cycle state
Details about a product
The product identifier
The product SKU code
The product name
The product characteristics
[
[
{
"key": "static-ip",
"value": "10.10.01.10",
"label": "Static IP"
}
]
]The Characteristic’s key which is uque across the set of configured characteristics
The actual value of the characteristic.
The characteristic’s label used for UI purposes
The subscription identifier
The subscription code
Details about the integration
The integration identifier
The integration name
The custom field (unique) key
The custom field’s (provided) value
The device electronic id
The device characteristics (specified per product, product type or device)
The Characteristic’s key which is uque across the set of configured characteristics
The actual value of the characteristic.
The characteristic’s label used for UI purposes
The device status
The device status identifier
The device status name
Detailed information of when the device was at first initialised on a subscription. Informaiton is set only once when the device is added to the first subscription either as a sold item or a rented one. This information is never reset, even if the device is returned to the warehouse or given to another contact.
The initialisation date.
The user’s identifier
The user’s full name
The user’s credential username
Defines whether the device is reserved or not
The business entity from which the device is reserved
The business entity from which the device is reserved for
The business entity identifier that such device is reserved by
The business entity number that such device is reserved by
GET https://sandbox.crm.com/backoffice/v2/devices/c39c6c23-319f-ef74-37cd-9b7878992fc1 HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "c39c6c23-319f-ef74-37cd-9b7878992fc1",
"state": "USED",
"mac_address": "00:00:5e:00:53:af",
"platform": "OTHER",
"registration_token": "4e11bef819b8ae9af08d",
"registration_date": 1642758418,
"application": {
"id": "af9c61d3-7685-e31f-3387-27c42858e868",
"name": "Best Coffee App"
},
"wifi": {
"status": "OFFLINE",
"last_auth_date": "1642767506"
},
"serial_number": "2049-3630",
"spatial_location": "1C",
"product": {
"id": "e283a863-18e1-7cae-48c4-7433bf28cf97",
"sku": "ABC-12345",
"name": "ABC"
},
"owner": {
"type": "RETAILER",
"id": "5f67324c-1076-618b-8d29-012efde9485e",
"name": "CRM"
},
"order": {
"id": "fa1f472e-fa4e-4cae-eae1-7e0002391237",
"number": "O0002334"
},
"enabled_services": [
{
"id": "",
"life_cycle_state": "",
"product": {
"id": "a0f79973-d4b3-db89-4276-cb4abcccd842",
"sku": "STB",
"name": "Set-top-box",
"characteristics": [
[
{
"key": "static-ip",
"value": "10.10.01.10",
"label": "Static IP"
}
]
]
}
}
],
"subscription": {
"id": "5535e087-3e27-d2c8-249f-54fe0c1307a4",
"code": "SUB001"
},
"provisioning": {
"id": "81ed6bcd-39ec-214c-5124-9e5ac6cb5dc4",
"name": "UniFi"
},
"custom_fields": [
{
"key": "back_office",
"value": "Back Office"
}
],
"electronic_id": "I243WER",
"characteristics": [
[
{
"key": "static-ip",
"value": "10.10.01.10",
"label": "Static IP"
}
]
],
"status": {
"id": "9ce41a61-4c47-c06a-1c74-191f496903ae",
"name": "new status"
},
"initialisation_details": {
"date": 1666862572,
"user": {
"id": "a12b282f-e6ce-e618-0a72-becb3ad78033",
"name": "John Smith",
"username": "johnsmith@crm.com"
}
}
}{id}/actionsPerform actions on an existing device (e.g. unblock device)
Path variables
The device (identifier) that an action will be performed
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Defines the action that will be applied on the device
Responses
The request has succeeded
Body
The device identifier
PUT https://sandbox.crm.com/backoffice/v2/devices/91a52c35-fcdd-a328-7708-2b02ac3ff02e/actions HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"action": "UNBLOCK"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "91a52c35-fcdd-a328-7708-2b02ac3ff02e"
}{id}/historyRetrieve detailed information for a device’s history
Path variables
The device (identifier) of which history will be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The historical action identifier
The action that was performed
The date on which such action was performed
Details about the user/contact that performed such action
Defines who made such action
The performer identifier
The performer full name
The performer username (user related)
Details about the owner of a device (history)
Defines the historical entity type
Defines the historical entity identifier
Defines the historical entity value
Details about the owner of a device (history)
Defines the historical entity type
Defines the historical entity identifier
Defines the historical entity value
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v1/devices/3ef38763-2d6b-fb41-5c22-79989fa90bae/history HTTP/1.1
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"action": "SALE",
"performed_on": 1618861892,
"performed_by": {
"type": "CONTACT",
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "Jane Smith",
"username": "janesmith@crm.com"
},
"origin": {
"type": "SUBSCRIPTION",
"id": "07d737e8-d20c-08c5-7a2a-6c7f247b13a5",
"value": "JS01"
},
"destination": {
"type": "WAREHOUSE",
"id": "07d737e8-d20c-08c5-7a2a-6c7f247b13a5",
"value": "JS01"
}
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}/ownershipTransfer the ownership of a device
Path variables
The device (identifier) to be transferred
Notes
Ownership transfer can be between an organisation to a contact, or between two contacts
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The entity that will transfer the ownership of the device
Defines the entity (identifier) that such device’s ownership will be transferred from
Defines the entity (identifier) that such device’s ownership will be transferred to, usually the destination is a Contact
Responses
The request has succeeded
Body
The device identifier
POST https://stagingapi.crm.com/backoffice/v1/devices/6A24D2B5E44F44B28451FE021FCAD51E/ownership_transfer HTTP/1.1
Content-Type: application/json
{
"origin_entity": "CONTACT",
"origin_id": "6A24D2B5E44F44B28451FE021FCAD51E",
"destination_id": "6A24D2B5E44F44B28451FE021FCAD51E"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "6A24D2B5E44F44B28451FE021FCAD51E"
}Returns an estimation on whether a contact is allowed to consume usage allowance and if yes, the remaining one.
Request parameters
Set to True if the remaining ausage allowance should also be included in the response. When set to False, the Web API just informs whether usage consumption is authorised or not.
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The contact consuming usage
The usage product identifier
The identifier of the service through which usage is consumed. If not specified, then the response will include all termed and one-time services that allow the specified contact to consume usage. In the latter case, one-time services which are expired or fully consumed are not returned. For termed services, only non-cancelled ones are returned
the unique identifier of the service
The organisation at which usage is consumed
The consumed usage’s charged amount.
The charged amount’s currency.
The consumed usage’s amount/volume
Responses
Body
Returned are True if usage can be consumed, i.e. termed/one-time service has remaining allowance. If no usage allowance limits are set, then usage is always authorised.
The currency code reated to usage cash amount limits
The one-time/termed service through which usage is consumed
POST https://sandbox.crm.com/backoffice/v1/estimates/allowance HTTP/1.1
Content-Type: application/json
{
"contact_id": "",
"product_id": "",
"service": {
"id": "",
"classification": "ONE_TIME_SERVICE"
},
"organisation_id": "",
"cash_amount": 1,
"currency_code": "",
"usage_amount": 1
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"estimation_id": "",
"services": [
{
"authorise_consumption": true,
"currency_code": "EUR",
"service": {
"id": "",
"classification": "ONE_TIME_SERVICE",
"product": {
"id": "",
"sku": "",
"name": ""
}
},
"accumulated_allowance": {
"cash_amounts": {
"per_transaction": 9.99,
"per_day": 19.99,
"per_billing_cycle": 59.99
}
},
"products_allowance": [
{
"item_type": "PRODUCT",
"item_id": "",
"name": "",
"remaining_cash": {
"per_transaction": 9.99,
"per_day": 19.99,
"per_billing_cycle": 59.99
},
"remaining_usage": {
"per_transaction": 9.99,
"per_day": 19.99,
"per_billing_cycle": 59.99
},
"measurement_unit": {
"id": "",
"name": "",
"display_name": ""
}
}
]
}
]
}Returns an estimation of a subscriber’s upcoming billing
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The subscirptipon to be billed. If not specified, then all of the subscirpitons of the specified contact/account are billed, otherwise, if a subscription is specified, then the selected subscirpiton’s bill preview is presented
Responses
Body
Sum of all products’ prices as these are defined in the product catalog
Total amount of the invoice that will be generated. Includes taxed and disoucnt amounts
The amount that will be due at the time of the estimation
Amount that the customer needs to pay at the time of the estimation
The price of the product as this is configured in the product catalog (including tax or not depending on the tax model)
The date from which the service is invoiced/credited
The date until which the service is invoiced/credited
Details about the product
The product identifier
The product SKU
The product name
Details about the applied discount
Details about the applied taxes
Defines the main product that the line item is component to it (applicable only when the line item is invoiced as a component of another product)
The product identifier
The product sku
The product name
POST https://sandbox.crm.com/backoffice/v2/estimates/billing HTTP/1.1
Content-Type: application/json
{
"contact_id": "",
"organisation_id": "",
"account_id": "",
"as_of_date": 1234567,
"upcoming_billing_cycles": 3,
"subscription_id": ""
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"billing_estimate": [
{
"billing_date": 12345678,
"billed_period": {
"from_date": 12345678,
"to_date": 12345678
},
"account": {
"id": "",
"number": "",
"name": ""
},
"totals": {
"total_amount": 9.99,
"tax_amount": 1.99,
"net_amount": 1.99,
"discount_amount": 1.99
},
"invoicing": [
{
"issued_date": 123456789,
"due_date": 123456789,
"currency_code": "EUR",
"is_credit": true,
"wallet_funds_amount": 5.99,
"total_net_amount": 1,
"total_discount_amount": 1,
"total_discount_incl_tax": 1,
"total_tax_amount": 0.99,
"total_price": 1,
"total_amount": 9.99,
"amount_due": "",
"amount_to_collect": 1,
"taxes_breakdown": [
{
"tax_amount": 0.99,
"tax_rate": {
"id": "",
"name": "",
"tax_code": "VAT",
"percentage": 1
}
}
],
"line_items": [
{
"quantity": 1,
"unit_price": 9.99,
"net_amount": 9.99,
"discount_amount": 1,
"sub_total": 9.99,
"pricing": 11.99,
"period": {
"from": 1651172405,
"to": 1653764405
},
"product": {
"id": "ba603bdc-f18f-1d4e-dd07-ad6b57c6e565",
"sku": "DEC1234",
"name": "Decoder",
"classification": "TRACEABLE_PHYSICAL_GOOD"
},
"discount": {
"discount_amount": 0.96,
"discount_percentage": 1.5,
"discount_incl_tax": 0.98
},
"applied_taxes": [
{
"tax_amount": 0.99,
"tax_exempt_reason": "CONTACT",
"tax_rate": {
"id": "",
"name": "",
"tax_code": "VAT",
"percentage": 1
}
}
],
"bundle_product": {
"id": "31f2e99d-a5cb-21c1-2866-1a1491989893",
"sku": "ICL-001",
"name": "Iced Latte",
"classification": "TRACEABLE_PHYSICAL_GOOD"
}
}
]
}
]
}
]
}Estimates how a product will be charged in invoices, quotations, billing without generating any invoices etc. Pricing estimation includes the price, all applicable promotions as well as the taxes to be applied.
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The contact’s unique identifier.
The account’s unique identifier
The unique idetifier of the organisation from which the customer purchases prducts
The unique identifier of a product
The unit price of the product. If specified, then the pricing strategy is not applied.
Required if a discount value is specified.
Required if a price is specified as input
Applicable for termed and one-time services
Responses
The request has succeeded
Body
Sum of all products’ prices as these are defined in the product catalog
Total amount of the invoice that will be generated. Includes taxed and disoucnt amounts
The amount that will be due at the time of the estimation
Amount that the customer needs to pay at the time of the estimation
The price of the product as this is configured in the product catalog (including tax or not depending on the tax model)
The date from which the service is invoiced/credited
The date until which the service is invoiced/credited
Details about the product
The product identifier
The product SKU
The product name
Details about the applied discount
Details about the applied taxes
Defines the main product that the line item is component to it (applicable only when the line item is invoiced as a component of another product)
The product identifier
The product sku
The product name
POST https://sandbox.crm.com/backoffice/v1/estimates/invoicing HTTP/1.1
Content-Type: application/json
{
"contact_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"account_id": "24c0809f-ed91-4b68-b912-5bd6064d901e",
"supply_method": "DELIVERY",
"fulfilled_by": "",
"line_items": [
{
"product_id": "",
"bundle_product_id": "",
"quantity": 1,
"price": 9.99,
"discount_option": "AMOUNT",
"discount_value": 1.11,
"tax_model": "TAX_EXCLUSIVE",
"price_term_id": ""
}
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"issued_date": 123456789,
"due_date": 123456789,
"currency_code": "EUR",
"is_credit": true,
"wallet_funds": 5.99,
"total_net_amount": 1,
"total_discount_amount": 1,
"total_discount_incl_tax": 1,
"total_tax_amount": 0.99,
"total_amount": 9.99,
"taxes_breakdown": [
{
"tax_amount": 0.99,
"tax_rate": {
"id": "",
"name": "",
"tax_code": "VAT",
"percentage": 1
}
}
],
"line_items": [
{
"id": "7CD9C84FA60F9FE407140E20F707726A",
"sku": "",
"name": "",
"tax_model": "TAX_INCLUSIVE",
"pricing_model": "TIERED",
"currency": "EUR",
"quantity": 1,
"unit_price": 9.99,
"price_incl_tax": 11.99,
"net_amount": 9.99,
"discount": {
"discount_amount": 0.96,
"discount_percentage": 1.5,
"discount_incl_tax": 0.98
},
"tax_amount": 0.99,
"sub_total": 9.99,
"classification": "",
"applied_taxes": [
{
"tax_amount": 0.99,
"tax_exempt_reason": "CONTACT",
"tax_rate": {
"id": "",
"name": "",
"tax_code": "VAT",
"percentage": 1
}
}
]
}
]
}Preview order fulfillment information
Notes
The following APIs should be called in order to make an order
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Preview order based on the supply method
Preview order only for open venues
Preview order based on the postal code
Preview order based on the geo-location (lat/long)
Preview order based on the customer address
Preview order based on a specific organisation as requested by the customer
Preview order based on the date and time at which the customer requests the ordered items to be delivered/picked-uo (Applicable only for ordering ahead/scheduling an order)
The order ahead time
The order ahead time unit
The order ahead date
The id of the queue selected
Responses
The request has succeeded
Body
Details about the organisation (business/merchant/venues) that will fulfill the order
The organisation identifier
The organisation name
The organisation phone number
The organisation address
The address line 1
The address line 2
The address state/province/county
The address town/city
The address postal code
The latitude of the location
The longitude of the location
The Google textual identifier that uniquely identifies a location
Details about the parent organisation (business/merchant) of the fulfilled by. Not applicable if the fulfilled by organisation is of type business or merchant
The organisation identifier
The organisation name
The creative identifier
Information about the creative type
Partner logos configurable by SO, applicable for Business, Merchant, Venue
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
The creative width
The creative height
The creative format
The creative content URL
The creative public identifier
Information about the creative transformations
The transformed creative width
The transformed creative height
The transformed creative URL
Details about the organisation’s working hours
The day of the week that the organisation is open
The time that the organisation opens
The time that the organisation closes
The opening hours for each organisation’s operation type
Details about the organisation’s availability to offer its services
The organisation’s operation type
Defines whether the organisation is temporary closed for offering its services
The payment methods allowed when ordering from the organisation that fulfills the order
[
"CASH","CARD"
]The type of the event
The creative identifier
Information about the creative type
Partner logos configurable by SO, applicable for Business, Merchant, Venue
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
The creative width
The creative height
The creative format
The creative content URL
The creative public identifier
Information about the creative transformations
The transformed creative width
The transformed creative height
The transformed creative URL
POST https://sandbox.crm.com/backoffice/v1/estimates/order_fulfillment HTTP/1.1
Content-Type: application/json
{
"supply_method": "DIRECT_SALE",
"is_open": true,
"postal_code": "2415",
"lat_lot": "35.157204,33.314151",
"address_id": "28441e3e-767a-b6cc-9a59-6d7705de6428",
"requested_organisation_id": "4456e728-019c-86e4-3e4f-bb7920e2ef75",
"requested_delivery_at": {
"time": 30,
"time_unit": "MINUTES",
"date": 12312323123
},
"queue_id": "532652ff-10b2-1f88-914a-df316249ccf0"
}
HTTP/1.1 200 OK
Content-Type: application/json
[
{
"fulfilled_by": {
"id": "3FD1E31269B76D7A65ACCE45B2E68DFD",
"name": "Best Burger Egkomi",
"phone": "+6934222321",
"address": {
"address_line_1": "Ilia Papakyriakou 21",
"address_line_2": "7 Stars Tower",
"state_province_county": "Egkomi",
"town_city": "Nicosia",
"postal_code": "2415",
"lat": "35.157115",
"lon": "33.313719",
"google_place_id": "ChIJrTLr-GyuEmsRBfy61i59si0"
},
"parent_organisation": {
"id": "b1607c37-e750-2324-ac49-6591a86f54b8",
"name": "Best Burger",
"creatives": [
{
"id": "CA123456789AQWSXZAQWS1236547896541",
"usage_type": "LOGO",
"width": 2159,
"height": 3075,
"format": "jpg",
"url": "https://assets.crm.com/image/logo.jpg",
"public_id": "crm-com/image",
"media": [
{
"width": 200,
"height": 300,
"url": "https://asset.crm.com/image/offer/c_scale,w_200/logo.jpg"
}
]
}
]
},
"opening_hours": [
{
"day_of_week": "MONDAY",
"opens": "09:00",
"closes": "20:00",
"operation": "ANY"
}
],
"short_term_operations": [
{
"operation": "PICK_UP",
"is_closed": "false"
}
],
"payment_method_types": [
"CRM_WALLET"
],
"creatives": [
{
"id": "CA123456789AQWSXZAQWS1236547896541",
"usage_type": "WALLET_IMAGE",
"width": 2159,
"height": 3075,
"format": "jpg",
"url": "https://assets.crm.com/image/logo.jpg",
"public_id": "crm-com/image",
"media": [
{
"width": 200,
"height": 300,
"url": "https://asset.crm.com/image/offer/c_scale,w_200/logo.jpg"
}
]
}
]
}
}
]Preview order information before making an order including fulfillment and invoice estimations
Notes
The following APIs should be called in order to make an order
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The contact’s or organisation’s Account identifier. This must be an Active account.
The type of the event
Delivered to the customer’s address
Picked up by the customer from a venue
Online sales of services
The organisation that will fulfill the Order. For Direct Sales, the Business itslef fulfills the Order.
Time at which the contact requests the Order to be fulfilled. Applicable for Delivery and Pick up Orders
Order to be fulfilled after a period of time
Unit of time. Applicable when “time” is specified
Date on which the Order is requested to be fulfilled.
Appicable and required when the supply method is Delivery. either a contact address or a one-off address can be specified.
Order to be fulfilled at one of the contact’s registered Addresses
The address line 1
The address line 2
The address state/province/county
The address town/city
The address postal code
The address country (based on ISO 3 char code)
The latitude of the address
The longitude of the address
The Google textual identifier that uniquely identifies an address
The Order’s queue.
Defines whether the contact wants to use available funds from the CRM Wallet to fully or partially pay off the Order’s cost.
The type of the event
List of ordered items. At least one must be specified
Product identifier
Quantity of ordered items
Unit price provided to the buyer. If not specified, then the Business’s pricing rules will be applied.
Order item notes
Applicable and required for termed and one-time services. Also applicable for tracceable physical goods which are ordered as Rentals.
List of components that is applicable when ordering products of bundle composition or products that include modifiers.
Product identifier. This product must be only of the allowed ones of the bundle/composite product.
Quantity of the component. If not specified, then it defaults to 1
The component product’s price. IF not specified, then the business’s pricing rules will be applied.
Applicable only when ordering a service bundle. This is the component service’s selected price.
These milestones will default to the milestones based on the queue type selected - unless they are edited by the user.
The stage on which the Milesotne’s Invoice will be issued. The allowed stages are defined in the order’s Queue, i.e. only Queue stages with a milestone are allowed to be specified as the Order’s milestone stages.
This will be either be the value entered by the user or the value based on the queue stages configuration. Each milestone can either have a percentage or a specific amount, not both
The milestone’s actual ammount to be paid on reaching a stage. Each milestone can either have a percentage or a specific amount, not both. The sum of all milestone amounts cannot exceed the order’s total cost.
Ad-hoc discount applied including tax
Redeemed Promotion pass for a subscription service
Pass code
Pass associated OTP (roadmapped)
Responses
The request has succeeded
Body
The order’s estimation_id. Use this id as input to POST /orders Web API to successfully place the new Order.
The Order’s estimation.
Indicates whether minimum order amount is met and order can proceed with submission. the order’s amount is validated against the Applied Fulfillemnt policy’s rules.
Defines the minimum order amount as specified in the fulfillment policy of the organisation fulfilling the order.
Details about the organisation from where such event was posted
The organisation identifier
The organisation name
Estimated delivery information, i.e. when the order will be fulfilled.
Time to fulfill
Unit of time
Fulfilled by this time
The applied Queue that the order will follow
Order queue identifier
Queue name
Sum of all products’ prices as these are defined in the product catalog
Total amount of the invoice that will be generated. Includes taxed and disoucnt amounts
The amount that will be due at the time of the estimation
Amount that the customer needs to pay at the time of the estimation
The price of the product as this is configured in the product catalog (including tax or not depending on the tax model)
The date from which the service is invoiced/credited
The date until which the service is invoiced/credited
Details about the product
The product identifier
The product SKU
The product name
Details about the applied discount
Details about the applied taxes
Defines the main product that the line item is component to it (applicable only when the line item is invoiced as a component of another product)
The product identifier
The product sku
The product name
Applicable only when purchasing termed services and/or renting devices
Sum of all products’ prices as these are defined in the product catalog
Total amount of the invoice that will be generated. Includes taxed and disoucnt amounts
The amount that will be due at the time of the estimation
Amount that the customer needs to pay at the time of the estimation
The price of the product as this is configured in the product catalog (including tax or not depending on the tax model)
The date from which the service is invoiced/credited
The date until which the service is invoiced/credited
Details about the product
The product identifier
The product SKU
The product name
Details about the applied discount
Details about the applied taxes
Defines the main product that the line item is component to it (applicable only when the line item is invoiced as a component of another product)
The product identifier
The product sku
The product name
The Order’s milestone plans plus each milestone’s amount.
The milestone’s stage i.e. when the Invoice will be issued.
Order stage identifier
Stage name
Each milestone’s ordering along the Order’s life cycle.
The milestone’s percentage
The milestone’s calculated amount based on the percentage set and the order’s total cost.
POST https://sandbox.crm.com/backoffice/v2/estimates/orders HTTP/1.1
Content-Type: application/json
{
"account_id": "1bd3e4d3-5981-209b-787d-352dcd5389a3",
"supply_method": "DELIVERY",
"fulfilled_by": "271671a0-4bb3-9c2e-a9c7-6490dbfe5939",
"requested_delivery_at": {
"time": 30,
"time_unit": "MINUTES",
"date": 12312323123
},
"address_info": {
"id": "Appicable and required when the supply method is Delivery",
"address": {
"address_line_1": "Elia Papakyriakou",
"address_line_2": "7 Tower Stars",
"state_province_county": "Egkomi",
"town_city": "Nicosia",
"postal_code": "2015",
"country": "CYP",
"lat": 35.157115,
"lon": 33.313719,
"google_place_id": "ChIJrTLr-GyuEmsRBfy61i59si0"
}
},
"queue_id": "271671a0-4bb3-9c2e-a9c7-6490dbfe5939",
"use_wallet_funds": "false",
"payment_method_type": "CRM_WALLET",
"items": [
{
"id": "7f45ad8a-b164-2a67-eb93-8651c0f1b101",
"quantity": 1,
"price": 2.99,
"tax_model": "TAX_INCLUSIVE",
"notes": "",
"price_terms_id": "905a4a5d-80d4-1e18-4595-d03c2b9546e1",
"components": [
{
"id": "6e111025-002b-48d7-a675-6d9e48070b8f",
"quantity": 1,
"price": 0.5,
"price_terms_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"tax_model": "TAX_INCLUSIVE"
}
]
}
],
"milestones": [
{
"stage_id": "271671a0-4bb3-9c2e-a9c7-6490dbfe5939",
"percentage": 20,
"amount": 9.99
}
],
"discount": {
"amount": 1,
"type": "AMOUNT"
},
"pass": {
"code": "TB68937255",
"otp": "344566"
}
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "905a4a5d-80d4-1e18-4595-d03c2b9546e1",
"order_estimate": {
"ordering_allowed": "true",
"minimum_amount": 1,
"fulfilled_by": {
"id": "4248fab3-67d5-2eb1-eaf6-079ce18cd2ed",
"name": "Bravo Coffee"
},
"estimated_delivery": {
"time_to_deliver": 30,
"uot": "minutes",
"delivered_at": 12345565
},
"queue": {
"id": "905a4a5d-80d4-1e18-4595-d03c2b9546e1",
"name": "Delivery Orders"
}
},
"invoice_estimate": {
"issued_date": 123456789,
"due_date": 123456789,
"currency_code": "EUR",
"is_credit": true,
"wallet_funds_amount": 5.99,
"total_net_amount": 1,
"total_discount_amount": 1,
"total_discount_incl_tax": 1,
"total_tax_amount": 0.99,
"total_price": 1,
"total_amount": 9.99,
"amount_due": "",
"amount_to_collect": 1,
"taxes_breakdown": [
{
"tax_amount": 0.99,
"tax_rate": {
"id": "",
"name": "",
"tax_code": "VAT",
"percentage": 1
}
}
],
"line_items": [
{
"quantity": 1,
"unit_price": 9.99,
"net_amount": 9.99,
"discount_amount": 1,
"sub_total": 9.99,
"pricing": 11.99,
"period": {
"from": 1651172405,
"to": 1653764405
},
"product": {
"id": "ba603bdc-f18f-1d4e-dd07-ad6b57c6e565",
"sku": "DEC1234",
"name": "Decoder",
"classification": "TRACEABLE_PHYSICAL_GOOD"
},
"discount": {
"discount_amount": 0.96,
"discount_percentage": 1.5,
"discount_incl_tax": 0.98
},
"applied_taxes": [
{
"tax_amount": 0.99,
"tax_exempt_reason": "CONTACT",
"tax_rate": {
"id": "",
"name": "",
"tax_code": "VAT",
"percentage": 1
}
}
],
"bundle_product": {
"id": "31f2e99d-a5cb-21c1-2866-1a1491989893",
"sku": "ICL-001",
"name": "Iced Latte",
"classification": "TRACEABLE_PHYSICAL_GOOD"
}
}
]
},
"service_delivery_estimate": [
{
"action_allowed": true,
"allowed_execution_on": 12345678,
"next_billing_date": 1235678,
"next_payment_date": 12345678,
"subscription": {
"life_cycle_state": "ACTIVE",
"terms": {
"billing_period": {
"duration": 1,
"uot": "MONTHS"
},
"billing_day": {
"day_of_month": 5,
"day_of_week": "MONDAY"
}
}
},
"services_to_add": [
{
"life_cycle_state": "EFFECTIVE",
"quantity": 5,
"product": {
"id": "",
"sku": "",
"name": "",
"classification": "TERMED_SERVICE"
},
"trial_period": {
"starts_on": 12345678,
"ends_on": 12345678
},
"components": [
{
"id": "b82648cb-e5f4-53b2-26b3-edca38e3e34f",
"sku": "",
"name": ""
}
],
"dependencies": [
{
"item_type": "",
"item_id": "",
"item_name": ""
}
]
}
],
"billing_estimate": {
"billing_date": 12345678,
"billed_period": {
"from_date": 12345678,
"to_date": 12345678
},
"totals": {
"total_amount": 9.99,
"tax_amount": 1.99,
"net_amount": 1.99,
"discount_amount": 1.99
},
"invoice_estimate": {
"issued_date": 123456789,
"due_date": 123456789,
"currency_code": "EUR",
"is_credit": true,
"wallet_funds_amount": 5.99,
"total_net_amount": 1,
"total_discount_amount": 1,
"total_discount_incl_tax": 1,
"total_tax_amount": 0.99,
"total_price": 1,
"total_amount": 9.99,
"amount_due": "",
"amount_to_collect": 1,
"taxes_breakdown": [
{
"tax_amount": 0.99,
"tax_rate": {
"id": "",
"name": "",
"tax_code": "VAT",
"percentage": 1
}
}
],
"line_items": [
{
"quantity": 1,
"unit_price": 9.99,
"net_amount": 9.99,
"discount_amount": 1,
"sub_total": 9.99,
"pricing": 11.99,
"period": {
"from": 1651172405,
"to": 1653764405
},
"product": {
"id": "ba603bdc-f18f-1d4e-dd07-ad6b57c6e565",
"sku": "DEC1234",
"name": "Decoder",
"classification": "TRACEABLE_PHYSICAL_GOOD"
},
"discount": {
"discount_amount": 0.96,
"discount_percentage": 1.5,
"discount_incl_tax": 0.98
},
"applied_taxes": [
{
"tax_amount": 0.99,
"tax_exempt_reason": "CONTACT",
"tax_rate": {
"id": "",
"name": "",
"tax_code": "VAT",
"percentage": 1
}
}
],
"bundle_product": {
"id": "31f2e99d-a5cb-21c1-2866-1a1491989893",
"sku": "ICL-001",
"name": "Iced Latte",
"classification": "TRACEABLE_PHYSICAL_GOOD"
}
}
]
}
}
}
],
"milestone_plan": [
{
"stage": {
"id": "b82648cb-e5f4-53b2-26b3-edca38e3e34f",
"name": "Accepted",
"order": 1
},
"percentage": "5.5",
"amount": 1
}
]
}Preview purchase information (including awards and spends) before submitting a purchase customer event
Notes
Integrating purchase estimates in a “submit purchase” flow the following APIs should be called
POST /estimates/purchasesPOST /purchasesby providing the estimates identifier as return from previous API call
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The date that the customer event was performed
The purchase classification
The customer event classification identifier
The customer event classification name
The purchased products. Applicable and required when net/tax/total amounts are not provided
The purchased product sku (product sku and product family are semi-optional)
The purchased product name
The purchased product family (product sku and product family are semi-optional)
The purchased product net amount
The purchased product vat amount
The purchased product total amount (net and vat amount)
The purchased quantity
Details about total transaction amounts (products and transaction amounts are semi-optional)
The net amount
The tax amount
The total amount (net + tax)
The discount amount
Details about the organisation that purchase was submitted from (id or taps are semi-optional)
The organisation identifier
The transaction acquiring point that the event was submitted from (id or code must be specified). TAP and Organisation (id) attributes are semi-optional
The transaction acquiring point identifier
The transaction acquiring point code
The transaction acquiring point that the event was submitted from (id or code must be specified). TAP and Organisation (id) attributes are semi-optional
The transaction acquiring point identifier
The transaction acquiring point code
Defines the contact for whom the purchase is created for (customer identification can be made either using contact id, contact code, cim, contact_token or contact masked card)
The contact identifier
The contact code
The contact cim
The contact OTP token
Information related with the spend request that should be created as part of the purchase
The amount requested to be spent (spend, instant_spend and amount are semi-optional)
Defines whether spend will be calculated across any available balance (e.g. instant offers and available wallet balance) (spend, instant_spend and amount are semi-optional)
Defines whether spend will be calculated only based on instant offers (e.g. free product, amount) (spend, instant_spend and amount are semi-optional)
Defines whether the purchase will be posted successfully only if requested spend amount is fully covered by the available wallet balance
Details about the pass
Defines the pass type
The pass code. For Promotion passes - a Promotion pass will be generated and redeemed as part of the process, the contact_id should also be provided
The pass assocaited pin (if applicable) should be set here for validation
- If validation is successful, the Purchase Event will be created and wallet funds will be consumed
- If validation is unsuccessful, the Purchase Event won’t be created and wallet funds won’t be consumed
The pass one time password (if applicable) - not implemented yet for passes
Responses
The request has succeeded
Body
The purchase estimates identifier (can be used on post purchase instead of re-submitting the whole purchase event)
Details about reward amounts
The total (actual) spent amount
The spent amount from wallet’s open balance
The spent amount from wallet’s commerce balance
POST https://sandbox.crm.com/backoffice/v2/estimates/purchases HTTP/1.1
Content-Type: application/json
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
{
"date": 1622863554,
"classification": {
"name": "Delivery Purchase"
},
"products": [
{
"product_sku": "FREDESPR001",
"product_name": "Freddo Espresso",
"product_family": "Chocolates",
"net_amount": 14.15,
"tax_amount": 1.04,
"total_amount": 15.19,
"quantity": 2
}
],
"transaction_amounts": {
"discount": 1
},
"organisation": {
"venue_tap": {
"code": "TAP001"
}
},
"contact": {
"otp": "447212"
}
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "cec7736c-75ba-93a0-56f5-6171ae8d4f02",
"rewards": {
"spend": 1.72
}
}Returns an estimation of a change perfromed on a subscription service, without making the change. The estimation is based on existing services owned by the customer plus any requested changes.
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Applicable when amending a flexible service bundle. At least one components should be specifid as either to be added or removed
The unique identifier of the service
The service components to be removed
Responses
Body
Sum of all products’ prices as these are defined in the product catalog
Total amount of the invoice that will be generated. Includes taxed and disoucnt amounts
The amount that will be due at the time of the estimation
Amount that the customer needs to pay at the time of the estimation
The price of the product as this is configured in the product catalog (including tax or not depending on the tax model)
The date from which the service is invoiced/credited
The date until which the service is invoiced/credited
Details about the product
The product identifier
The product SKU
The product name
Details about the applied discount
Details about the applied taxes
Defines the main product that the line item is component to it (applicable only when the line item is invoiced as a component of another product)
The product identifier
The product sku
The product name
POST https://sandbox.crm.com/backoffice/v2/estimates/service_delivery HTTP/1.1
Content-Type: application/json
{
"action": "CHANGE_TERMS",
"contact_id": "",
"organisation_id": "",
"account_id": "",
"subscription_id": "",
"scheduled_date": 12345678,
"number_of_days": 3,
"subscription_term_changes": {
"billing_day": {
"day_of_month": 1,
"day_of_week": "MONDAY"
},
"payment_method_id": "",
"funding_source": "ACCOUNT"
},
"services_to_add": [
{
"product_id": "",
"price_terms_id": "",
"quantity": 1,
"components": [
{
"product_id": "",
"price_terms_id": ""
}
]
}
],
"services_to_remove": [
{
"id": ""
}
],
"services_to_change": [
{
"from_service_id": "",
"to_service_product_id": "",
"to_price_terms_id": "",
"components": [
{
"product_id": "",
"price_terms_id": ""
}
]
}
],
"service_term_changes": [
{
"service_id": "",
"auto_renewal_preference": "OPT_IN, OPT_OUT",
"contract_preference": "RENEW, EXTEND",
"extend_by": {
"period": 3,
"uot": "DAYS"
},
"quantity": 1
}
],
"component_changes": {
"id": "",
"to_be_added": [
{
"product_id": "",
"price_terms_id": ""
}
],
"to_be_removed": [
{
"id": ""
}
]
}
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"service_delivery_estimate": [
{
"action_allowed": true,
"allowed_execution_on": 12345678,
"next_billing_date": 1235678,
"next_payment_date": 12345678,
"subscription": {
"life_cycle_state": "ACTIVE",
"terms": {
"billing_period": {
"duration": 1,
"uot": "MONTHS"
},
"billing_day": {
"day_of_month": 5,
"day_of_week": "MONDAY"
}
}
},
"services_to_add": [
{
"life_cycle_state": "EFFECTIVE",
"product": {
"id": "",
"sku": "",
"name": ""
},
"trial_period": {
"starts_on": 12345678,
"ends_on": 12345678
},
"dependencies": [
{
"item_type": "",
"item_id": "",
"item_name": ""
}
]
}
],
"services_to_remove": [
{
"id": "",
"life_cycle_state": "CANCELLED",
"product": {
"id": "",
"sku": "",
"name": ""
}
}
],
"services_to_change": [
{
"id": "",
"life_cycle_state": "SWAPPED",
"product": {
"id": "",
"sku": "",
"name": ""
},
"change_to_product": {
"id": "",
"sku": "",
"name": ""
},
"dependencies": [
{
"item_type": "",
"item_id": "",
"item_name": ""
}
]
}
],
"components_change": {
"service": {
"id": "",
"sku": "",
"name": ""
},
"components_added": [
{
"id": "",
"sku": "",
"name": ""
}
],
"components_removed": [
{
"id": "",
"sku": "",
"name": ""
}
]
},
"billing_estimate": {
"billing_date": 12345678,
"billed_period": {
"from_date": 12345678,
"to_date": 12345678
},
"totals": {
"total_amount": 9.99,
"tax_amount": 1.99,
"net_amount": 1.99,
"discount_amount": 1.99
},
"invoicing": [
{
"issued_date": 123456789,
"due_date": 123456789,
"currency_code": "EUR",
"is_credit": true,
"wallet_funds_amount": 5.99,
"total_net_amount": 1,
"total_discount_amount": 1,
"total_discount_incl_tax": 1,
"total_tax_amount": 0.99,
"total_price": 1,
"total_amount": 9.99,
"amount_due": "",
"amount_to_collect": 1,
"taxes_breakdown": [
{
"tax_amount": 0.99,
"tax_rate": {
"id": "",
"name": "",
"tax_code": "VAT",
"percentage": 1
}
}
],
"line_items": [
{
"quantity": 1,
"unit_price": 9.99,
"net_amount": 9.99,
"discount_amount": 1,
"sub_total": 9.99,
"pricing": 11.99,
"period": {
"from": 1651172405,
"to": 1653764405
},
"product": {
"id": "ba603bdc-f18f-1d4e-dd07-ad6b57c6e565",
"sku": "DEC1234",
"name": "Decoder",
"classification": "TRACEABLE_PHYSICAL_GOOD"
},
"discount": {
"discount_amount": 0.96,
"discount_percentage": 1.5,
"discount_incl_tax": 0.98
},
"applied_taxes": [
{
"tax_amount": 0.99,
"tax_exempt_reason": "CONTACT",
"tax_rate": {
"id": "",
"name": "",
"tax_code": "VAT",
"percentage": 1
}
}
],
"bundle_product": {
"id": "31f2e99d-a5cb-21c1-2866-1a1491989893",
"sku": "ICL-001",
"name": "Iced Latte",
"classification": "TRACEABLE_PHYSICAL_GOOD"
}
}
]
}
]
}
}
]
}Use the Web API to get recommendations from CRM.COM:
- Who is ordering product s(physical goods and services)
Request parameters
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
GET https://sandbox.crm.com/backoffice/v2/products/recommendation HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"recommendation_type":"NEW-UPGRADE-DOWNGRADE-UPSELL",
"id": "",
"sku": "",
"name": "",
"pricing": [
{
"id":"",
"price":9.99,
"out_contract_price":11.99,
"curreny_code":"EUR",
"price_terms":{
"billing_period":{
"duation":1,
"uot":"MONTH"
},
"contract_period":{
"duation":12,
"uot":"MONTH"
},
"trial_period":{
"duation":7,
"uot":"DAYS"
}
}
}
]
}
],
"paging": "123"
}Journal entries are records that keep track of the business’s financial transactions for its contacts. Through a journal entry a contact account or the contacts’ wallet is either debited or credited. Journal entries are generated automatically on various financial events such as Invoicing an account or on crediting the wallet. Journal entries can also be issued manually.
{id}/journals{id}{id}/journalsCreate a new journal entry that either debits or credits an account or a wallet. Journal entries generated by CRM.COM via various financial or wallet events are always related to an entity for example an Invoice or an Award. Using this Web API however, a manual journal entry is generated having no relation to any financial/wallet event previously submitted within CRM.COM
Path variables
The unique identifier of the contact
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Journal entry’s code. If not specified, then a unique and random 16-digit code will be generated
A Journal either debits or credits the account/wallet
The entity on which the action is performed. The journal is created against an account or the wallet.
The journal’s amount
Commerce pool restricting how the amount can be spent. Applicable if action=credit & process=wallet, if specified the wallet commerce balance will be credited.
Journal’s issuing date
Additional notes about the journal
Responses
Body
Journal’s unique identifier
POST https://sandbox.crm.com/backoffice/v2/contacts/{id}/journals HTTP/1.1
Content-Type: application/json
{
"code": "5554330232221234",
"action": "DEBIT",
"entity": "ACCOUNT",
"amount": 9.99,
"currency_code": "EUR",
"commerce_pool_id": "82177c61-5800-4053-9be1-ba4e6c64cfeb",
"posted_date": 1618298816,
"notes": "Amount credited to the customer in settlement of complaint no.1012"
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "82177c61-5800-4053-9be1-ba4e6c64cfeb"
}{id}Retrieve details of an existing journal entry.
Path variables
Journal identifier
Responses
Body
The Journal’s code. This is a unique and random 16-digit code, generated by CRM.COM
The Journal entry’s accounting entity
Journal either debits or credits an account or the wallet.
Journal’s amount
Journal’s issuing date
Details about the related contact
The contact identifier
The contact full name
The contact unique code
Details about the organisation from where such event was posted
The organisation identifier
The organisation name
Details about the related contact’s account
The account identifier
The account name
The account number
Wallet unique ID
Wallet unique code
Restrictions on how the journal’s amount can be spent. Applicable only when issuing a Credit jounal for the Wallet.
Commerce pool identifier
Commerce pool name
Journal entries created because of a financial event performed on an entity.
The type of the event
Financial transaction, triggered by an Order, or an invoice created to charge a Contact (e.g. via the backend)
Financial transaction, credit note issued for a Contact’s account
Financial transaction, a contact payment for an invoice or an external debit
Financial transaction, debiting a Contact’s account
Financial transaction posted against an account
Financial transaction, crediting a Contact’s account
Financial transaction, transfer of funds to another accountwallet of the same contact, or another Contact’s account/wallet
Redeeming a pass (credits the Contact’s open/commerce wallet balance)
An amount returned for a non specified purchase
A spend originating from a Purchase Event
Award from one or more offers
Reverse a purchase transaction
Backend process can debit a wallet, credit a customer account, credit an organisation account after a refund
Wallet fees applied based on configuration
Wallet funds used to pay for an Order when an order is placed (not from a purchase event)
Reverse an achievement customer event (for award only, not for spend)
Manual journal entry created to credit/debit and account/wallet
The entity’s identifier. Use this identifier in other GET Web APIs to retrieve detailed information for the entity/financial event it self.
The entity’s unique number or code.
Additional nots on why the journal was issued.
GET https://sandbox.crm.com/backoffice/v2/journals/{id} HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"code": "7461746837632706",
"entity": "ACCOUNT",
"type": "DEBIT",
"amount": 9.99,
"currency_code": "EUR",
"posted_date": 1583846865,
"contact": {
"id": "1c060611-0667-313e-b3bf-4cb70ee81cdf",
"name": "John Doe",
"code": "C123"
},
"organisation": {
"id": "4248fab3-67d5-2eb1-eaf6-079ce18cd2ed",
"name": "Bravo Coffee"
},
"account": {
"id": "8a025412-ec13-550a-4d82-6aef6562ac49",
"name": "AC123456 John Doe",
"number": "AC123456"
},
"wallet": {
"id": "b94a4516-f452-4bad-9d99-81016ab225fb",
"code": "4444000545432222"
},
"commerce_pool": {
"id": "d6dc2b8e-831a-41d4-a8e7-d5c57b668937",
"name": "Spend within 3 months"
},
"financial_event": {
"type": "TOPUP",
"id": "d6dc2b8e-831a-41d4-a8e7-d5c57b668937",
"number": "I1000001"
},
"notes": "Amount credited to the customer in settlement of complaint no.1012"
}Retrieves a list of Journal entries using various filters.
Request parameters
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
The journal entry’ accounting entity, for which one it was generated for
Journal’s accounting type
The financial event that aused the journal’s creation
[
"INVOICE"
]Returns results where the given <amount> is greater than this value
Returns results where the given <amount> is greater than or equal to this value
Returns results where the given <amount> is less than this value
Returns results where the given <amount> is less then or equal to this value
Returns results where the given <date> is greater than this value
Returns results where the the given <date> is greater than or equal to this value
Returns results where the given <date> is less than this value
Returns results where the given <date> is less then or equal to this value
The number/code of the entity related to the financial event e.g. an Invoice’s number or a Top-up’s code. Invoices and Credit Notes are assigned a number based on a scheme on their posting. Any other financial event has a code only
The account identifier
The wallet identifier
The contact’s identifier
The Organisation’s identifier
The transaction’s reference number. Applicable only for Invoices and Credit Notes i.e. the transactions that have a reference number and not a number while they are in Draft sate.
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
Journal entry’s unique identifier
Journal entry’s code. This is a unique and random 16-digit code, generated by CRM.COM on issuing the journal entry
Journal entry is issued for either an Account or a Wallet
Journal entry’s accounting type
Date on which the journal entry was created
The contact owning the account/wallet for which the journal entry was issued. A journal entry is issued for either a Contact or an Organisation.
Contact identifier
Contact full name
Contact code
The Organisation owning the account/wallet for which the journal entry was issued. A journal entry is issued for either a Contact or an Orgnaisation.
Organisation identifier
Organisation name
Journal entry issued for an account. An account might be owned by a Contact or an Organisation
Account unique identifier
Account number
Journal entry issued for a Wallet
Wallet identifier
Wallet code
Journal entries created because of a financial event performed on an entity.
The type of the event
Financial transaction, triggered by an Order, or an invoice created to charge a Contact (e.g. via the backend)
Financial transaction, credit note issued for a Contact’s account
Financial transaction, a contact payment for an invoice or an external debit
Financial transaction, debiting a Contact’s account
Financial transaction posted against an account
Financial transaction, crediting a Contact’s account
Financial transaction, transfer of funds to another accountwallet of the same contact, or another Contact’s account/wallet
Redeeming a pass (credits the Contact’s open/commerce wallet balance)
An amount returned for a non specified purchase
A spend originating from a Purchase Event
Award from one or more offers
Reverse a purchase transaction
Backend process can debit a wallet, credit a customer account, credit an organisation account after a refund
Wallet fees applied based on configuration
Wallet funds used to pay for an Order when an order is placed (not from a purchase event)
Reverse an achievement customer event (for award only, not for spend)
Manual journal entry created to credit/debit and account/wallet
The entity’s identifier. Use this identifier in other GET Web APIs to retrieve detailed information for the entity/financial event it self.
The entity’s unique number or code.
The entity’s reference number. Applicable for Invoices and Credit Notees
Applicable for wallet journal entries only and in cases where the wallet is credited because of an Award event. In such cases, the journal entry is indireclty related to a customer event as well.
Award is a result of a purchase event
Award is a result of a reward achievement offer
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/journals HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "2f4ea11b-12a6-4321-92d1-f4ede511e203",
"code": "99323451230005432",
"entity": "ACCOUNT",
"type": "DEBIT",
"amount": 9.99,
"currency_code": "EUR",
"posted_date": 1654584876,
"contact": {
"id": "CAD1E31269B76D7A65ACCE45B2E68DFD",
"name": "John Johnson",
"code": "C123"
},
"organisation": {
"id": "4248fab3-67d5-2eb1-eaf6-079ce18cd2ed",
"name": "Bravo Coffee"
},
"account": {
"id": "2f4ea11b-12a6-4321-92d1-f4ede511e203",
"number": "964AC123456"
},
"wallet": {
"id": "2f4ea11b-12a6-4321-92d1-f4ede511e203",
"code": "5434599999112300"
},
"financial_event": {
"type": "REFUND",
"id": "2f4ea11b-12a6-4321-92d1-f4ede511e203",
"number": "I000001",
"reference_number": "INV-43243435-123445",
"initial_type": "PURCHASE"
}
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}An Invoice is a financial document that shows a list of services or physical goods bought by an account owner, as well as and the prices to be paid for them. Invoices debit the account and can be generated either by system processes or manually by users. An Invoice needs to be paid off by its due date. An Invoice might be cancelled through a Credit Note, if it was not issued correctly
{id}{id}/actions{id}Create a new Invoice financial transaction for an account owner. A single Invoice can be created per Web API call. The Invoices debits the account of the contact/organisation for at least one product
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The account on which the financial transaction will be posted against to. The account might be owned by a Contact or an Organisation.
The unique identifier of the financial transaction type id. If not specified, then the default Invoice type will be set based on Financial settings
The reference number of the financial transaction to be created. if not specified, then a unique and random 16-digit code will be generated to represent the Invoices reference number.
The due date of the financial transaction. The default value is provided based on settings but the user can provide a different one. The due date mus tbe greater than or equa to the Invoice’s posted date.
The issued date of the financial transaction. Defaults to current date.
The posted date of the financial transaction. Defaults to current date. If not specified, then it will be set on Posting the Invoice
The life cycle state of the financial transaction
Any notes related to the financial transaction
The CRM.COM entity for which the Invoice was issued for
The unique identifier of the entity
The product’s unique identifier to be included in the financial transaction
The quantity of the product. Defaults to 1. Quantity can be set as a Number only for service products
The price per unit of the product
Provide an ad hoc discount to the Invoice that can be set an a specific amount or a percentage
The discount amount of the line
The discount percentage of the line
The sub total of the financial transaction line. If the line’s sub-total is specified, then the line’s amounts are calculated from right to left, i.e. the process will re-calculate the unit price , net, tax and discount amounts
The IDs of the devices to be sold in case of a stockable/traceable product
Responses
Successful Request
Body
The unique identifier of the financial transaction
POST https://sandbox.crm.com/backoffice/v2/invoices HTTP/1.1
Content-Type: application/json
{
"account_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"type_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"reference_number": "6554900212234544",
"due_date": 1583846865,
"issued_date": 1583846865,
"posted_date": 1583846865,
"state": "POSTED",
"notes": "",
"issued_for": {
"entity": "ORDERS",
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
},
"lines": [
{
"product_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"quantity": 1.5,
"unit_price": 9.99,
"discount": {
"amount": 20,
"percentage": 20
},
"sub_total": 99.99,
"devices": [
"4dc0809f-ed91-4b68-b912-5bd6064d901e"
]
}
]
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}{id}Update an Invoice financial transaction. An Invoice can be updated but its state defines which information can be updated
- While in Draft state, any Invoice information can be updated
- Once Posted, then only its notes, delivery and billing addresses can be updated
Path variables
The id of the Invoice to be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The unique identifier of the financial transaction type id
The due date of the financial transaction. The default value is provided based on Financial settings but the user can provide a different one. The due date cannot be set before the invoice’s posted date
The issued date of the financial transaction.
The Invoice’s billing address which defaults to the account’s billing address. The new address must still be one of the account owner’s addresses.
The Invoice’s delivery address. Applicable only when Invoice was issued for a Delivery Order. The new address must still be one of the account owner’s addresses.
Any notes related to the financial transaction
Invoice Lines. At least one line must be included in an Invoice
The unique identifier of an existing line to be updated
The unique identifier of the product to be provided on new lines
The quantity of the product
The price per unit of the product
The line’s discount that can be specified as an amount or a percentage
The discount amount of the line
The discount percentage of the line
The sub total of the financial transaction line. If specified, then the line’s amounts will be re-calcualted so as to result ton this sub-total
The IDs of the devices to be sold in case of a stockable/traceable product
Responses
Successful Request
Body
The unique identifier of the Invoice
PUT https://sandbox.crm.com/backoffice/v2/invoices/{id} HTTP/1.1
Content-Type: application/json
{
"type_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"due_date": 1583846865,
"issued_date": 1583846865,
"billing_address_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"delivery_address_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"notes": "Manual Invoice",
"lines": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"product_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"quantity": 2.5,
"unit_price": 9.99,
"discount": {
"amount": 1.99,
"percentage": 2.5
},
"sub_total": 19.98,
"devices": [
""
]
}
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}{id}/actionsPerform actions to an existing Invoice like Posting a draft Invoice or Crediting it. The action is performed on a single Invoice.
Path variables
The unique identifier of the invoice on which the action is performed
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The action to be performed on the Invoice
Issues a credit note based on the specified invoice. Applicable only for Posted Invoices.
Posts a Draft Invoice
Rejects a Draft Invoice
The invoice notes available to provide any addtional information on the performed action
Applicable only when Crediting the Invoice. The amount must be less than or equal to the Invoice’s total amount. If not specified when performing the action, then the Invoice is fully Credited.
Responses
Successful Request
Body
The unique identifier of the invoice
POST https://sandbox.crm.com/backoffice/v2/invoices/4dc0809f-ed91-4b68-b912-5bd6064d901e/actions HTTP/1.1
Content-Type: application/json
{
"action": "CREDIT",
"notes": "Reject to incorrect pricing options",
"amount": 9.99
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}Returns a list of invoices. Use the Web APIs filters to retrieve the required Invoices.
Request parameters
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
The value of the search across number or reference number
The unique ID of the contact whose Invoices belong to one of the cotnact’s accounts
Uiue identifier of the Organisations for which Invoices were posted.
The unique ID of the account against which Invoices were posted
If set to true, then only the unsettled Invoices will be retreived
Unique identifier of the Service Request for which the invoice was issued
Filter based on order
Filter based on the life cycle state
The Invoice’s type identifier
Search using the Invoice’s due date
Returns results where the given <date> is greater than this value
Returns results where the the given <date> is greater than or equal to this value
Returns results where the given <date> is less than this value
Returns results where the given <date> is less then or equal to this value
Search using th eInvoice’s posted date
Returns results where the given <date> is greater than this value
Returns results where the the given <date> is greater than or equal to this value
Returns results where the given <date> is less than this value
Returns results where the given <date> is less then or equal to this value
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
OK
Body
The unique identifier of the Invoice
The financial transaction number
The financial transaction’s reference number
Details about the related type
The type identifier
The type name
Details about the related contact’s account
The account identifier
The account name
The account number
Details about the related contact
The contact identifier
The contact full name
The contact unique code
Details about the organisation from where such event was posted
The organisation identifier
The organisation name
The life cycle state of the financial transaction
The date that the financial transaction was issued
The date that the financial transaction was posted
The due date of the financial transaction
The total amount of the financial transaction
The unpaid amount that passed the Invoice’s due date
Invoice financial transaction
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/invoices HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"number": "INV00010",
"reference_number": "1234563211112309",
"type": {
"id": "c01ecd1b-ff1e-35c2-7236-59ae20339c78",
"name": "Internal Transaction"
},
"account": {
"id": "8a025412-ec13-550a-4d82-6aef6562ac49",
"name": "ACR1234 John Doe",
"number": "AC123456"
},
"contact": {
"id": "1c060611-0667-313e-b3bf-4cb70ee81cdf",
"name": "John Doe",
"code": "C123"
},
"organisation": {
"id": "4248fab3-67d5-2eb1-eaf6-079ce18cd2ed",
"name": "Bravo Coffee"
},
"state": "PENDING",
"issued_date": 1583846865,
"posted_date": 1583846865,
"due_date": 1583846865,
"currency_code": "EUR",
"total": 1,
"overdue_amount": 9.99,
"unsettled_amount": 1
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Retrieve detailed information for an Invoice
Path variables
The id of the Invoice to be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
OK
Body
The unique identifier of the Invoice
The Invoice number
The Invoice’s reference number
Details about the related type
The type identifier
The type name
The life cycle state of the financial transaction
Details about the related contact’s account
The account identifier
The account name
The account number
Details about the related contact
The contact identifier
The contact full name
The contact unique code
Details about the organisation from where such event was posted
The organisation identifier
The organisation name
Any notes of the financial transaction
The date that the Invoice was issued
The date that the Invoice was posted
The due date of the Invoice
The total net amount of the financial transaction
The total discount amount of the financial tranasction
Total tax amount
The total amount of the financial transaction
The unpaid amount that passed the financial transaction’s due date
The unpaid amount of the financial transaction
The account owner’s payment terms based on which the Invoice’s Due date was calculated
The entity that initiated the Invoice. An Invoice is issued for an Order or Service Request or because of recurring billing, i.e. issued for a Subscription
The entitiy for which the Invoice was issued
The unique identifier of the initiating entity
The entity’s number/code
Account owner’s name
Account owner’s phone number
Account owner’s email address
The address line 1
The address line 2
The address state/province/county
The address town/city
The address postal code
The address country (based on ISO 3 char code)
The latitude of the address
The longitude of the address
The Google textual identifier that uniquely identifies an address
Account owner’s name
Account owner’s phone number
Account owner’s email address
The address line 1
The address line 2
The address state/province/county
The address town/city
The address postal code
The address country (based on ISO 3 char code)
The latitude of the address
The longitude of the address
The Google textual identifier that uniquely identifies an address
List of Invoice Lines. At least one line exists per Invoice
The unique ID of the financial transaction line
The invoiced product
The product’s unique identifier
The product’s SKU
The product’s name
Shows whether the invoiced product is stockable or not. For stockable products, warehouse transactions are issued on posting the invoice
The quantity of the product
The price per unit of the product
The net amount
The applied discount. IF a percentage was applied, then retrieving the line’s discount will return both the discount amount and the percentage
The discount amount of the line. This is the discount excluding the taxed amount for the disocunt
The discount percentage of the line
The applied discount including applied taxes.
Total taxed amount for the product
The sub total of the financial transaction line
Applicableonly when the invoiced item was provided as part of a bundle product
Product identifier
Product SKU
Product name
The date from which the service is invoiced/credited
The date until which the service is invoiced/credited
The applied tax rate
Unique identifier of the tax rate
Tax rate name
Tax rate’s percentage that was valid on the date on which he tax was applied
Total applied tax amount
Applicable only when a Tax Exempt rate was applied. Shows whether the tax exempt rate was applied because the Contact or the Product was marked as tax exempt.
The discounted amount
Type of discount applied
The applied Promotion. Applicable when discount type is Promotion
Promotion identifier
Promotion name
The starting tier of the price tier
The ending tier of the price tier
Number of items invoiced/credited based on this tier range
The unit price per invoiced item
The devices that were sold through this invoice
The ID of the device
The serial number of the device
Total applied tax amount
The applied tax rate
Unique identifier of the tax rate
Tax rate name
Tax rate’s percentage that was valid on the date on which he tax was applied
The discounted amount
Type of discount applied
The applied Promotion. Applicable when discount type is Promotion
Promotion identifier
Promotion name
List of credit financial transactions that were allocated to the Invoice
The classification of the transaction whch can either be a Payment or a Credit Note.
The unique identifier of the Payment/Credit Note
The number of the financal transaction. For Credit Notes a numbe rif returned whereas for Payments, the Paument’s code is returned
The transaction’s reference number
GET https://sandbox.crm.com/backoffice/v2/invoices/4dc0809f-ed91-4b68-b912-5bd6064d901e HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"number": "INV00014",
"reference_number": "1234569098887670",
"type": {
"id": "c01ecd1b-ff1e-35c2-7236-59ae20339c78",
"name": "Internal Transaction"
},
"state": "POSTED",
"account": {
"id": "8a025412-ec13-550a-4d82-6aef6562ac49",
"name": "AC123456 John Doe",
"number": "AC123456"
},
"contact": {
"id": "1c060611-0667-313e-b3bf-4cb70ee81cdf",
"name": "John Doe",
"code": "C123"
},
"organisation": {
"id": "4248fab3-67d5-2eb1-eaf6-079ce18cd2ed",
"name": "Bravo Coffee"
},
"notes": "",
"issued_date": 1583846865,
"posted_date": 1583846865,
"due_date": 1583846865,
"net": 150,
"discount": 50,
"tax": 2.99,
"total": 100,
"overdue_amount": 1,
"unsettled_amount": 100,
"currency_code": "EUR",
"net_term_days": 7,
"issued_for": {
"entity": "ORDERS",
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"number": "O10000101"
},
"billing_address": {
"name": "John Smith",
"phone": "0035799999999",
"email": "jsmith@emailaddress.com",
"address": {
"address_line_1": "Elia Papakyriakou",
"address_line_2": "7 Tower Stars",
"state_province_county": "Egkomi",
"town_city": "Nicosia",
"postal_code": "2015",
"country": "CYP",
"lat": 35.157115,
"lon": 33.313719,
"google_place_id": "ChIJrTLr-GyuEmsRBfy61i59si0"
}
},
"delivery_address": {
"name": "John Smith",
"phone": "0035799999999",
"email": "jsmith@emailaddress.com",
"address": {
"address_line_1": "Elia Papakyriakou",
"address_line_2": "7 Tower Stars",
"state_province_county": "Egkomi",
"town_city": "Nicosia",
"postal_code": "2015",
"country": "CYP",
"lat": 35.157115,
"lon": 33.313719,
"google_place_id": "ChIJrTLr-GyuEmsRBfy61i59si0"
}
},
"lines": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"product": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"sku": "abc-12345",
"name": "Decoder",
"is_stockable": true,
"classification": "TRACEABLE_PHYSICAL_GOOD"
},
"quantity": 1,
"unit_price": 10.99,
"net": 1.99,
"discount": {
"amount": 2.99,
"percentage": 1.5,
"amount_incl_tax": 3.99
},
"tax": 1.5,
"sub_total": 200,
"bundle_product": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"sku": "FILMS",
"name": "Films"
},
"period": {
"from": 1651172405,
"to": 1653764405
},
"applied_taxes": [
{
"tax_rate": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "Standard VAT",
"tax_code": "VAT",
"percentage": 20
},
"tax_amount": 9.99,
"tax_exempt_reason": "PRODUCT"
}
],
"applied_discounts": [
{
"amount": 0.99,
"type": "PROMOTION",
"promotion": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "Xmas Offers"
}
}
],
"applied_tiers": [
{
"lower_tier": 1,
"upper_tier": 5,
"units_invoiced": 1,
"unit_price": 1.99
}
],
"devices": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"serial_number": "STB123456"
}
]
}
],
"taxes_breakdown": [
{
"tax_amount": 9.99,
"tax_rate": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "Standard VAT",
"tax_code": "VAT",
"percentage": 20
}
}
],
"discounts": [
{
"amount": 0.99,
"type": "PROMOTION",
"promotion": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "Xmas Offers"
}
}
],
"credits": [
{
"classification": "PAYMENT",
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"number": "CI0000010",
"reference_number": "3234556545550091"
}
]
}A Credit Note is a financial document issued by a business against an account to correct mistakes or adjust the amount that an account owenr was invoiced (in cases for example where the customer changes the purchased services an/or physical goods). A credit note is usually issued for the same or lower amount than an Invoice, and sets it off against the outstanding balance from the same or other financial transactions.
{id}{id}/actions{id}Create a new Credit Note to credit an account. A Credit Note must include at least one line. A single Credit Note can be created per Web API call.
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The account against which the financial transaction will be posted
The unique identifier of the Credit Note type. If not specified, the default Credit Note type will be set.
The reference number of the financial transaction to be created. if not specified, a random and unique 16-digit code will be assigned.
The issued date of the financial transaction. Defaults to current date.
The posted date of the financial transaction. Defaults to current date
Any notes related to the financial transaction
The life cycle state of the financial transaction
Set of Credit Note line items. At least one must be specified
The product’s unique identifier to be included in the financial transaction
The quantity of the product
The price per unit of the product
The discount amount of the line
The discount percentage of the line
The sub total of the financial transaction line
The IDs of the devices to be returned back to the business in case of a stockable/traceable product
The Invoice financial transactions to be credited by this Credit Note
Unique identifier of the Invoice to be credited
A Credit Note might be issued during the invoicing process of another entity
The entity for which the Credit Note was issued
The unique identifier of the entity
Responses
Successful Request
Body
The unique identifier of the financial transaction
POST https://sandbox.crm.com/backoffice/v2/credit_notes HTTP/1.1
Content-Type: application/json
{
"account_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"type_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"reference_number": "1234565455000032",
"issued_date": 1583846865,
"posted_date": 1583846865,
"notes": "Credit note due to wrong Invoice charges",
"state": "DRAFT",
"lines": [
{
"product_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"quantity": 1,
"unit_price": 10,
"discount": {
"amount": 20,
"percentage": 20
},
"sub_total": 200,
"devices": [
""
]
}
],
"invoices_credited": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}
],
"issued_for": {
"entity": "ORDERS",
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}{id}Update a Draft Credit Note financial transaction
Path variables
The id of the Credit Note to be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The unique identifier of the financial transaction id
The issued date of the financial transaction. Defaults to current date.
Any notes related to the financial transaction
List of Credit Note line items.
The unique identifier of an existing line to be updated
The unique identifier of the product to be provided on new lines
The price per unit of the product
The quantity of the product
The discount amount of the line
The discount percentage of the line
The sub total of the financial transaction line
The IDs of the devices to be returned back to the business in case of a stockable/traceable product
The Invoice financial transactions to be credited by this Credit Note
Unique identifier fo the Invoices to be credited
Responses
Successful Request
Body
The unique identifier of the financial transaction
PUT https://sandbox.crm.com/backoffice/v2/credit_notes/{id} HTTP/1.1
Content-Type: application/json
{
"type_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"issued_date": 1583846865,
"notes": "Credit Note to credit wrong invoice charges",
"lines": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"product_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"unit_price": 10,
"quantity": 2,
"discount": {
"amount": 20,
"percentage": 5
},
"sub_total": 200,
"devices": [
"CAD1E31269B76D7A65ACCE45B2E68DFD"
]
}
],
"invoices_credited": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}{id}/actionsPerform actions on an existing Credit Note
Path variables
The unique identification of the credit note that the actions will be performed against to
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The action to be performed on the Credit Note
The credit note notes available to provide any information on the performed action
Responses
Successful Request
Body
The unique identifier of the credit note
POST https://sandbox.crm.com/backoffice/v2/credit_notes/CAD1E31269B76D7A65ACCE45B2E68DFD/actions HTTP/1.1
Content-Type: application/json
{
"action": "POST",
"notes": "Posting Credit Note on customer request"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}List Credit Notes. Use filters to retrieve required list of Credit Notes across all accounts.
Request parameters
The unique ID of the account whose Credit Notes belong to
The unique ID of the contact whose Credit Notes belong to
The organisation aganst which the Credit Note was posted
The state of the Credit Notes to be retrieved
The Order for which the Credit Note was issued
The value of the search across number and reference number
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
List of Credit notes financial transaction types
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
OK
Body
The unique identifier of the Credit Note
The financial transaction number
The financial transaction’s reference number
Details about the related type
The type identifier
The type name
Details about the related contact’s account
The account identifier
The account name
The account number
Details about the related contact
The contact identifier
The contact full name
The contact unique code
Details about the organisation from where such event was posted
The organisation identifier
The organisation name
The total amount of the financial transaction
The life cycle state of the financial transaction
The date that the financial transaction was issued
The date that the financial transaction was posted
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/credit_notes HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"number": "CR0001",
"reference_number": "1234566545556780",
"type": {
"id": "c01ecd1b-ff1e-35c2-7236-59ae20339c78",
"name": "Internal Transaction"
},
"account": {
"id": "8a025412-ec13-550a-4d82-6aef6562ac49",
"name": "ACR1234 John Doe",
"number": "AC123456"
},
"contact": {
"id": "1c060611-0667-313e-b3bf-4cb70ee81cdf",
"name": "John Doe",
"code": "C123"
},
"organisation": {
"id": "4248fab3-67d5-2eb1-eaf6-079ce18cd2ed",
"name": "Bravo Coffee"
},
"total": 100.5,
"currency_code": "EUR",
"state": "DRAFT",
"issued_date": 1583846865,
"posted_date": 1583846865
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Get a Credit Note
Path variables
The id of the Credit Note to be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
OK
Body
The unique identifier of the Crdit Note
The financial transaction number
The financial transaction’s reference number
Details about the related contact’s account
The account identifier
The account name
The account number
Details about the related type
The type identifier
The type name
Details about the related contact
The contact identifier
The contact full name
The contact unique code
Details about the organisation from where such event was posted
The organisation identifier
The organisation name
The life cycle state of the financial transaction
The date that the financial transaction was issued
The date that the financial transaction was posted
The total net amount of the financial transaction
The total discount amount of the financial tranasction
The total applied tax amount
The total amount of the financial transaction
Any notes of the financial transaction
Lis tof Credit Note line items. At least one is returned
The unique ID of the financial transaction line
The credited product
The product’s identifier
The product’s SKU
The product’s name
Defines whethe rthe credite product is stockable or not
The quantity of the product
The price per unit of the product
Total net amount credited
Total taxed amount for this product
Total discount amount credited
The discount amount of the line
The discount percentage of the line
The discount amount including the taxed amount
The sub total of the financial transaction line
The bunle through which the product was credited
Product identifier
Product SKU
Product name
The date from which the service is invoiced/credited
The date until which the service is invoiced/credited
The applied tax rate
Unique identifier of the tax rate
Tax rate name
Tax rate’s percentage that was valid on the date on which he tax was applied
Total applied tax amount
Applicable only when a Tax Exempt rate was applied. Shows whether the tax exempt rate was applied because the Contact or the Product was marked as tax exempt.
The starting tier of the price tier
The ending tier of the price tier
Number of items invoiced/credited based on this tier range
The unit price per invoiced item
List of devices returned through the Credit Note
Device identifier
Device serial number
The applied tax rate
Unique identifier of the tax rate
Tax rate name
Tax rate’s percentage that was valid on the date on which he tax was applied
Total applied tax amount
Applicable only when a Tax Exempt rate was applied. Shows whether the tax exempt rate was applied because the Contact or the Product was marked as tax exempt.
The financial transactions that are credited by the Credit Note
The unique identifier of the Invoice that was credited
Invoice number
Invoice reference number
Posted date
Due date
Total invoiced amount. The Invoice’s amount is in the same currency as the Credit Note
The entity that initiated the Credit Note. A Credit Note is issued for an Order or because of recurring billing, i.e. issued for a Subscription
The entity for which the Credit Note was issued
The entity’s unique identifier
The entity’s number
GET https://sandbox.crm.com/backoffice/v2/credit_notes/{id} HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "c01ecd1b-ff1e-35c2-7236-59ae20339c78",
"number": "CR0001",
"reference_number": "1234568777667098",
"account": {
"id": "8a025412-ec13-550a-4d82-6aef6562ac49",
"name": "AC123456 John Doe",
"number": "AC123456"
},
"type": {
"id": "c01ecd1b-ff1e-35c2-7236-59ae20339c78",
"name": "Internal Transaction"
},
"contact": {
"id": "1c060611-0667-313e-b3bf-4cb70ee81cdf",
"name": "John Doe",
"code": "C123"
},
"organisation": {
"id": "4248fab3-67d5-2eb1-eaf6-079ce18cd2ed",
"name": "Bravo Coffee"
},
"state": "REJECTED",
"issued_date": 1583846865,
"posted_date": 1583846865,
"currency_code": "EUR",
"net": 150.5,
"discount": 50.5,
"tax": 1.5,
"total": 100.5,
"notes": "manual invoice",
"lines": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"product": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"sku": "ABD12345",
"name": "3Play",
"is_stockable": true,
"classification": "TRACEABLE_PHYSICAL_GOOD"
},
"quantity": 1,
"unit_price": 10,
"net": 20.5,
"tax": 0.1,
"discount": {
"amount": 20.5,
"percentage": 20.5,
"amount_incl_tax": 15.5
},
"sub_total": 200.5,
"bundle_product": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"sku": "ALARM001",
"name": "Alarm"
},
"period": {
"from": 1651172405,
"to": 1653764405
},
"applied_taxes": [
{
"tax_rate": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "Standard VAT",
"tax_code": "VAT",
"percentage": 20
},
"tax_amount": 9.99,
"tax_exempt_reason": "PRODUCT"
}
],
"applied_tiers": [
{
"lower_tier": 1,
"upper_tier": 5,
"units_invoiced": 1,
"unit_price": 1.99
}
],
"devices": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"serial_number": "ADES-2243333"
}
]
}
],
"taxes_breakdown": [
{
"tax_rate": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "Standard VAT",
"tax_code": "VAT",
"percentage": 20
},
"tax_amount": 9.99,
"tax_exempt_reason": "PRODUCT"
}
],
"invoices_credited": [
{
"id": "c01ecd1b-ff1e-35c2-7236-59ae20339c78",
"number": "I1000101",
"reference_number": "4345550002321234",
"posted_date": 1655817643,
"due_date": 1655817643,
"total_amount": 19.99
}
],
"issued_for": {
"entity": "ORDERS",
"id": "c01ecd1b-ff1e-35c2-7236-59ae20339c78",
"number": "O0000123"
}
}A Payment is a financial document issued by a customer to a business to settle an outstanding balance. A payment is usually issued for the same or lower amount of a specific invoice, and sets it off against the outstanding balance of that invoice or any other unsettled transactions.
{id}{id}{id}/actionsCrediting the account to either settle an invoice or payment against the account. If no invoices are specified then the allocation is FIFO. A single payment can be created per Web API call, against a Contact or an Organisation
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Code that uniquely identifies the payment. If not specified, then a random and unique 16-digits code will be automatically assigned.
The contact on which the financial transaction will be posted against to (contact and organisation are semi-optional)
The organisation on which the financial transaction will be posted against to (contact and organisation are semi-optional)
The unique identifier of the financial transaction type. Only financial transaction types for Payments can be selected. If not specified, then the default Payment financial transaction type will be used.
The issued date of the financial transaction. Defaults to current date.
The posted date of the financial transaction. Defaults to current date
The amount of the payment
Any notes related to the financial transaction
The life cycle state of the financial transaction
The type of the event
The unique identifier of the contac’ts payment method. Applicable and required when the select payment method type is either a Card, an Account Debit or a Wallet.
A number that provides a form of identification for the payment. Usually a number that represents the payment in an external system. Can also be used to register the cheque’s number in the corresponding payment method type.
An array of unique IDs of Invoices to be paid. Either Invoices or External references must be specified (only one of the two)
The unique identifier of the Invoice to be paid
An array of reference numbers of external debits to be paid. Either Invoices or External references must be specified (only one of the two)
The external reference
The custom field’s unique key
The custom field’s value
Responses
Successful Request
Body
The unique identifier of the Payment
POST https://sandbox.crm.com/backoffice/v2/payments HTTP/1.1
Content-Type: application/json
{
"code": "9554443434296054",
"contact_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"organisation_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"type_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"issued_date": 1583846865,
"posted_date": 1583846865,
"amount": 9.99,
"currency_code": "EUR",
"notes": "",
"state": "POSTED",
"payment_method": {
"type": "WALLET",
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
},
"backoffice_code": "",
"invoices_paid": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}
],
"external_payable": [
{
"reference": "I0001231"
}
],
"custom_fields": [
{
"key": "back_office",
"value": "0001-12345"
}
]
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}{id}Update an existing draft payment financial transaction
Path variables
The id of the Payment to be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The unique identifier of the financial transaction type id
The issued date of the financial transaction. Defaults to current date.
The posted date of the financial transaction. Defaults to current date
The amount of the payment
Any notes related to the financial transaction
The type of the event
The unique identifier of the contac’ts payment method. Applicable and required when the select payment method type is either a Card, an Account Debit or a Wallet.
An array of unique IDs of Invoices to be paid. Invoices or External References must be specified (one of the two only)
Unique identifier of the Invoice to be paid
An array of reference numbers of external debits to be paid. Invoices or External References must be specified (one of the two only)
The external debit transactions reference number
The custom field’s unique key
The custom field’s value
Responses
Successful Request
Body
The unique identifier of the payment
PUT https://sandbox.crm.com/backoffice/v2/payments/{id} HTTP/1.1
Content-Type: application/json
{
"type_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"issued_date": 1583846865,
"posted_date": 1583846865,
"amount": 9.99,
"notes": "Paid in Cash",
"payment_method": {
"type": "CHEQUE",
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
},
"invoices_paid": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}
],
"external__payable": [
{
"reference": "INV000123"
}
],
"custom_fields": [
{
"key": "back_office",
"value": "0001-12345"
}
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}List all Payments
Request parameters
The unique ID of the account whose Payments belong to
The unique ID of the contact whose Payments belong to
The unique ID of the organisation whose Payments belong to
The state of the Payments to be retrieved
Filters based on custom fields (key/value set should be semicolon separated)
Search for payments based on their codes
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Search using Payment transaction type(s)
Search using the Payment’s posted date
Returns results where the given <date> is greater than this value
Returns results where the the given <date> is greater than or equal to this value
Returns results where the given <date> is less than this value
Returns results where the given <date> is less then or equal to this value
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
OK
Body
The unique identifier of the payment
The payment’s code
Details about the related type
The type identifier
The type name
Details about the related contact
The contact identifier
The contact full name
The contact unique code
Details about the organisation from where such event was posted
The organisation identifier
The organisation name
The life cycle state of the financial transaction
The date that the financial transaction was issued
The date that the financial transaction was posted
The amount of the financial transaction
{
"type": "CASH",
"identity": {
"id": "",
"identifier": "Visa *****1234 03/25"
}
}The type of the event
The type of the event
The unique identifier of the contact’s payment method
A short description of the payment method. Depending on the payment method’s type different information is returned:
- Card: the brand, followed by the last 4 digits of the card plus expiration month/year
- Account debit: Name: Bank code followed by the first 5 and the last 9 digits of the account number/IBAN
- Wallet: Name: Email and/or phone used on registration
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/payments HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"code": "6564443456760009",
"type": {
"id": "c01ecd1b-ff1e-35c2-7236-59ae20339c78",
"name": "Internal Transaction"
},
"contact": {
"id": "1c060611-0667-313e-b3bf-4cb70ee81cdf",
"name": "John Doe",
"code": "C123"
},
"organisation": {
"id": "4248fab3-67d5-2eb1-eaf6-079ce18cd2ed",
"name": "Bravo Coffee"
},
"state": "DRAFT",
"issued_date": 1583846865,
"posted_date": 1583846865,
"amount": 150.5,
"currency_code": "EUR",
"payment_method": {
"type": "CHEQUE",
"identity": {
"id": "",
"identifier": "Visa *****1234 03/25"
}
}
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Get detailed information of a Payment
Path variables
The unique identifier of the to be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
OK
Body
The unique idnetifier of the payment
The payment’s unique code
Details about the related type
The type identifier
The type name
Details about the related contact’s account
The account identifier
The account name
The account number
Details about the related contact
The contact identifier
The contact full name
The contact unique code
Details about the organisation from where such event was posted
The organisation identifier
The organisation name
The life cycle state of the financial transaction
The date that the financial transaction was issued
The date that the financial transaction was posted
The amount of the financial transaction
{
"type": "CASH",
"identity": {
"id": "",
"identifier": "Visa *****1234 03/25"
}
}The type of the event
The type of the event
The unique identifier of the contact’s payment method
A short description of the payment method. Depending on the payment method’s type different information is returned:
- Card: the brand, followed by the last 4 digits of the card plus expiration month/year
- Account debit: Name: Bank code followed by the first 5 and the last 9 digits of the account number/IBAN
- Wallet: Name: Email and/or phone used on registration
Any notes of the financial transaction
The information of the financial transactions to be paid by the Payment
The unique ID of the Financial Transaction
The number of the Financial Transaction
The reference number of the Financial Transaction
The posted date of the Financial Transaction
The due date of the Financial Transaction
The total amount of the financial transaction
An array of reference numbers of external debits to be paid.
The external debit’s reference number
The custom field’s unique key
The custom field’s value
GET https://sandbox.crm.com/backoffice/v2/payments/{id} HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"code": "4533340009897776",
"type": {
"id": "c01ecd1b-ff1e-35c2-7236-59ae20339c78",
"name": "Internal Transaction"
},
"account": {
"id": "8a025412-ec13-550a-4d82-6aef6562ac49",
"name": "ACR1234 John Doe",
"number": "AC123456"
},
"contact": {
"id": "CAD1E31269B76D7A65ACCE45B2E68DFD",
"name": "John Johnson",
"code": "C123"
},
"organisation": {
"id": "4248fab3-67d5-2eb1-eaf6-079ce18cd2ed",
"name": "Bravo Coffee"
},
"state": "POSTED",
"issued_date": 1583846865,
"posted_date": 1583846865,
"amount": 150,
"currency_code": "EUR",
"payment_method": {
"type": "CHEQUE",
"identity": {
"id": "",
"identifier": "Visa *****1234 03/25"
}
},
"notes": "",
"invoices_paid": [
{
"id": "CAD1E31269B76D7A65ACCE45B2E68DFD",
"number": "INV123456",
"reference_number": "123456",
"posted_date": 1583846865,
"due_date": 1583846865,
"total": 100.5
}
],
"external_payable": [
{
"reference": "INV00010234"
}
],
"custom_fields": [
{
"key": "back_office",
"value": "0001-12345"
}
]
}{id}/actionsPerform actions on an existing Payment
Path variables
The unique identification of the payment that the actions will be performed against to
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The action to be performed on the Payment
Posts a Draft Payment
Rejects a Draft Payment
Refunds a Posted Payment. A Payment can be fully or partially refunded
The payment notes available to provide any information on the performed action
Applicable only when refunding a payment. The refunded amount must be less than or equal to the Payment’s amount. If not specified, then the Payment is fully refunded
Responses
Successful Request
Body
The unique identifier of the payment
POST https://sandbox.crm.com/backoffice/v2/payments/CAD1E31269B76D7A65ACCE45B2E68DFD/actions HTTP/1.1
Content-Type: application/json
{
"action": "POST",
"notes": "",
"amount": 9.99
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}A Refund is a financial document issued by a business to a customer in order to fully or partially refund the customer’s payment. The refund transaction returns the money back to the customer’s account through which funds were initially taken because of the payment. Refunds are issued to customers who are not satisfied with their purchase or in cases where an order cannot be fully or partially delivered to the customer. Refunds are not issued to correct invoices.
{id}{id}{id}/actionsCreate a new Refund financial transaction. Through Refund transactions, the business returns money back to the contact/organisation based on a previously sumitted payment. So such transactions fully or partially refund a Payment.
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The account that will be refunded.
The unique identifier of the Refund’s type. If not specified, then the default Refund financial transaction type will be set
The Refund’s code. If not specified, then a random and unique 6-digit code will be assigned to the new Refund
The amount to be refunded. If not specified then it defaults to the payment’s amount. The amount should be less than or equal to the refunded entity’s amount. The amount’s currency is always in the refunded account’s currency
The life cycle state of the financial transaction
The entity based on which the refund will be issued
The type of the event
Issue refund based on a posted Payment
The unique identifier of the refunded entity
The type of the event
The unique identifier of the contac’ts payment method. Applicable and required when the select payment method type is either a Card, an Account Debit or a Wallet.
The issued date of the financial transaction. Defaults to current date.
The posted date of the financial transaction. Required when creating a Posted Refund
Any notes related to the financial transaction
The reason why the refunds was created
The custom field’s unique key
The custom field’s value
Responses
Successful Request
Body
The unique identifier of the new Refund
POST https://sandbox.crm.com/backoffice/v2/refunds HTTP/1.1
Content-Type: application/json
{
"account_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"type_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"code": "6779504440334213",
"amount": 9.99,
"state": "POSTED",
"refunded_entity": {
"type": "PAYMENT",
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
},
"payment_method": {
"type": "CARD",
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
},
"issued_date": 1583846865,
"posted_date": 1583846865,
"notes": "Partially refund payment P0123456",
"issue_reason": "Refund money",
"custom_fields": [
{
"key": "back_office",
"value": "0001-12345"
}
]
}{id}Update a Draft Refund financial transaction
Path variables
The id of the Refund to be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The unique identifier of the financial transaction type id
The amount to be refunded. The updated amount must be less than or equal to the refunded Payment’s amount. Amount’s curency is always in the account’s currency
The type of the event
The unique identifier of the contac’ts payment method. Applicable and required when the select payment method type is either a Card, an Account Debit or a Wallet.
The issued date of the financial transaction. Defaults to current date.
Any notes related to the financial transaction
The reason why the refund was created
The custom field’s unique key
The custom field’s value
Responses
Successful Request
Body
The unique identifier of the financial transaction
PUT https://sandbox.crm.com/backoffice/v2/refunds/{id} HTTP/1.1
Content-Type: application/json
{
"type_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"amount": 200,
"payment_method": {
"type": "WALLET",
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
},
"issued_date": 1583846865,
"notes": "Partially refund the account",
"issue_reason": "Refund Money",
"custom_fields": [
{
"key": "back_office",
"value": "0001-12345"
}
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}List all Refund transactions. Use various filters to retrieve a list of Refunds
Request parameters
The unique ID of the account whose Refunds belong to
The unique ID of the contact whose Refunds belong to
The organisation tha was Refunded
The state of the Refunds to be retrieved
The Payment based on which a Refund was issued
Filters based on custom fields (key/value set should be semicolon separated)
The value of the search using the code
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
OK
Body
The unique identifier of the Refund
The Refund’s code. This is a random and uniue, 16-digit code.
Details about the related contact’s account
The account identifier
The account name
The account number
Details about the related type
The type identifier
The type name
The life cycle state of the financial transaction
Details about the related contact
The contact identifier
The contact full name
The contact unique code
Details about the organisation from where such event was posted
The organisation identifier
The organisation name
The date that the financial transaction was issued
The date that the financial transaction was posted
The amount of the financial transaction
{
"type": "CASH",
"identity": {
"id": "",
"identifier": "Visa *****1234 03/25"
}
}The type of the event
The type of the event
The unique identifier of the contact’s payment method
A short description of the payment method. Depending on the payment method’s type different information is returned:
- Card: the brand, followed by the last 4 digits of the card plus expiration month/year
- Account debit: Name: Bank code followed by the first 5 and the last 9 digits of the account number/IBAN
- Wallet: Name: Email and/or phone used on registration
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/refunds HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"code": "9945554321004453",
"account": {
"id": "8a025412-ec13-550a-4d82-6aef6562ac49",
"name": "ACR1234 John Doe",
"number": "AC123456"
},
"type": {
"id": "c01ecd1b-ff1e-35c2-7236-59ae20339c78",
"name": "Internal Transaction"
},
"state": "POSTED",
"contact": {
"id": "1c060611-0667-313e-b3bf-4cb70ee81cdf",
"name": "John Doe",
"code": "C123"
},
"organisation": {
"id": "4248fab3-67d5-2eb1-eaf6-079ce18cd2ed",
"name": "Bravo Coffee"
},
"issued_date": 1583846865,
"posted_date": 1583846865,
"amount": 150.5,
"currency_code": "EUR",
"payment_method": {
"type": "CASH",
"identity": {
"id": "",
"identifier": "Visa *****1234 03/25"
}
}
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Get detailed information for a Refund
Path variables
The id of the financial transaction to be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
OK
Body
The unique identifier fo the Refund transaction
The financial transaction code
Details about the related contact’s account
The account identifier
The account name
The account number
The amount of the financial transaction
Details about the related type
The type identifier
The type name
Details about the related contact
The contact identifier
The contact full name
The contact unique code
Details about the organisation from where such event was posted
The organisation identifier
The organisation name
The life cycle state of the financial transaction
{
"type": "CASH",
"identity": {
"id": "",
"identifier": "Visa *****1234 03/25"
}
}The type of the event
The type of the event
The unique identifier of the contact’s payment method
A short description of the payment method. Depending on the payment method’s type different information is returned:
- Card: the brand, followed by the last 4 digits of the card plus expiration month/year
- Account debit: Name: Bank code followed by the first 5 and the last 9 digits of the account number/IBAN
- Wallet: Name: Email and/or phone used on registration
The date that the financial transaction was issued
The date that the financial transaction was posted
The reason why the refund was created
Any notes of the financial transaction
The Payment based on which the account was refunded
The unique identifier of the Payment
The payments code
The custom field’s unique key
The custom field’s value
GET https://sandbox.crm.com/backoffice/v2/refunds/4dc0809f-ed91-4b68-b912-5bd6064d901e HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"code": "44400059654543322",
"account": {
"id": "8a025412-ec13-550a-4d82-6aef6562ac49",
"name": "ACR1234 John Doe",
"number": "AC123456"
},
"amount": 150.5,
"currency_code": "EUR",
"type": {
"id": "c01ecd1b-ff1e-35c2-7236-59ae20339c78",
"name": "Internal Transaction"
},
"contact": {
"id": "CAD1E31269B76D7A65ACCE45B2E68DFD",
"name": "John Johnson",
"code": "C123"
},
"organisation": {
"id": "4248fab3-67d5-2eb1-eaf6-079ce18cd2ed",
"name": "Bravo Coffee"
},
"state": "REJECTED",
"payment_method": {
"type": "CRM_WALLET",
"identity": {
"id": "",
"identifier": "Visa *****1234 03/25"
}
},
"issued_date": 1583846865,
"posted_date": 1583846865,
"issue_reason": "Refund Money",
"notes": "",
"payment": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"code": "9996545550123233"
},
"custom_fields": [
{
"key": "back_office",
"value": "0001-12345"
}
]
}{id}/actionsPerform actions on an existing Refund
Path variables
The unique identification of the refund that the actions will be performed against to
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The action to be performed on the Refund
The refund available to provide any information on the performed action
Responses
Successful Request
Body
The unique identifier of the refund
POST https://sandbox.crm.com/backoffice/v2/refunds/CAD1E31269B76D7A65ACCE45B2E68DFD/actions HTTP/1.1
Content-Type: application/json
{
"action": "POST",
"notes": "Some notes"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}A payout is a financial document issued by a business to a customer in order to return back money directly to the customer’s funding source (bank account or card). Use Payouts to return back any amount of money to the customer.
{id}{id}{id}/actionsCreate a new Payout financial transaction against an Account. a single Payout can be issued within a Web API call.
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The account on which the financial transaction will be posted against to
The amount of the payout. The amount’s is in the account’s currency
The Payout’s code. If not specified, then a unique and random 16-digit code will be assigned.
The payment method that will be used to return back money to the contact
The type of the event
The contact’s payment method identifier. Rerquired when an online payment method type is selected like Card, Account Debit or Wallet.
The unique identifier of the Payout financial transaction type. If not specified, then the default Payout fianncial trasnaction type will be automatically set.
The life cycle state of the financial transaction
The issued date of the financial transaction. Defaults to current date.
The posted date of the financial transaction. Automatically set on posting the transaction
Any notes related to the financial transaction
The reason why the payout was issued
Responses
Successful Request
Body
The unique identifier of the financial transaction
POST https://sandbox.crm.com/backoffice/v2/payouts HTTP/1.1
Content-Type: application/json
{
"account_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"amount": 200,
"code": "9994440593230796",
"payment_method": {
"type": "CASH",
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
},
"type_id": "CAD1E31269B76D7A65ACCE45B2E68DFD",
"state": "DRAFT",
"issued_date": 1583846865,
"posted_date": 1583846865,
"notes": "Payout due to wrong payment amount",
"issue_reason": "Refund money",
"currency_code": "EUR"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": ""
}{id}Update a Draft Payout financial transaction
Path variables
The id of the Payout to be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The unique identifier of the financial transaction id
The issued date of the financial transaction. Defaults to current date.
The posted date of the financial transaction.
The amount of the payout
The type of the event
The unique identifier of the contac’ts payment method. Applicable and required when the select payment method type is either a Card, an Account Debit or a Wallet.
The reason why the Payout was created
Any notes related to the Payout
Responses
Successful Request
Body
The unique identifier of the financial transaction
PUT https://sandbox.crm.com/backoffice/v2/payouts/{id} HTTP/1.1
Content-Type: application/json
{
"type_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"issued_date": 1583846865,
"posted_date": 1583846865,
"amount": 200,
"payment_method": {
"type": "CHEQUE",
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
},
"issue_reason": "Refund Money",
"notes": "Money to be returned back to contact's Credit ard"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}{id}REtrieved detailed infromation for a Payout.
Path variables
The id of the financial transaction to be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
OK
Body
The financial transaction code
Details about the related type
The type identifier
The type name
Details about the related contact
The contact identifier
The contact full name
The contact unique code
Details about the related contact’s account
The account identifier
The account name
The account number
The amount of the financial transaction
The life cycle state of the financial transaction
{
"type": "CASH",
"identity": {
"id": "",
"identifier": "Visa *****1234 03/25"
}
}The type of the event
The type of the event
The unique identifier of the contact’s payment method
A short description of the payment method. Depending on the payment method’s type different information is returned:
- Card: the brand, followed by the last 4 digits of the card plus expiration month/year
- Account debit: Name: Bank code followed by the first 5 and the last 9 digits of the account number/IBAN
- Wallet: Name: Email and/or phone used on registration
The date that the financial transaction was issued
The date that the financial transaction was posted
The reason why the refund was created
Any notes of the financial transaction
GET https://sandbox.crm.com/backoffice/v2/payouts/{id} HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"code": "44400059654543322",
"type": {
"id": "c01ecd1b-ff1e-35c2-7236-59ae20339c78",
"name": "Internal Transaction"
},
"contact": {
"id": "CAD1E31269B76D7A65ACCE45B2E68DFD",
"name": "John Johnson",
"code": "C123"
},
"account": {
"id": "8a025412-ec13-550a-4d82-6aef6562ac49",
"name": "ACR1234 John Doe",
"number": "AC123456"
},
"amount": 150.5,
"currency_code": "EUR",
"state": "PENDING",
"payment_method": {
"type": "ACCOUNT_DEBIT",
"identity": {
"id": "",
"identifier": "Visa *****1234 03/25"
}
},
"issued_date": 1583846865,
"posted_date": 1583846865,
"issue_reason": "Refund Money",
"notes": ""
}Returns a list of Payout financial transactions. Use filters to search among all issued Payouts.
Request parameters
The unique ID of the contact whose Payouts belong to
The unique ID of the account whose Payouts belong to
The life cycle state of the Payouts to be retrieved
The value of the search based on the code
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
OK
Body
Unique identifier of the Payout financial transaction
The Payout’s unique and random code
Details about the related type
The type identifier
The type name
Details about the related contact
The contact identifier
The contact full name
The contact unique code
Details about the related contact’s account
The account identifier
The account name
The account number
The life cycle state of the financial transaction
The date that the financial transaction was issued
The date that the financial transaction was posted
The amount of the financial transaction
{
"type": "CASH",
"identity": {
"id": "",
"identifier": "Visa *****1234 03/25"
}
}The type of the event
The type of the event
The unique identifier of the contact’s payment method
A short description of the payment method. Depending on the payment method’s type different information is returned:
- Card: the brand, followed by the last 4 digits of the card plus expiration month/year
- Account debit: Name: Bank code followed by the first 5 and the last 9 digits of the account number/IBAN
- Wallet: Name: Email and/or phone used on registration
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/payouts HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"code": "4545556668909878",
"type": {
"id": "c01ecd1b-ff1e-35c2-7236-59ae20339c78",
"name": "Internal Transaction"
},
"contact": {
"id": "CAD1E31269B76D7A65ACCE45B2E68DFD",
"name": "John Johnson",
"code": "C123"
},
"account": {
"id": "8a025412-ec13-550a-4d82-6aef6562ac49",
"name": "ACR1234 John Doe",
"number": "AC123456"
},
"state": "DRAFT",
"issued_date": 1583846865,
"posted_date": 1583846865,
"amount": 150.5,
"currency_code": "EUR",
"payment_method": {
"type": "CARD",
"identity": {
"id": "",
"identifier": "Visa *****1234 03/25"
}
}
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}/actionsPerform actions on an existing Payout
Path variables
The unique identification of the payout that the actions will be performed against to
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The action to be performed on the Payout
Posts a draft Payout
Rejects a Draft Payout
Provide any information on the performed action
Responses
Successful Request
Body
The unique identifier of the Payout
POST https://sandbox.crm.com/backoffice/v2/payouts/CAD1E31269B76D7A65ACCE45B2E68DFD/actions HTTP/1.1
Content-Type: application/json
{
"action": "POST",
"notes": "Some notes"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}{id}{id}{id}{id}/actions{id}/logsCreates a new integration point between CRM.COM and a 3rd party tool/platform
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The integration name
The 3rd party tool to integrate with
The implementation’s endpoint
The integration description
Defines if integration is enabled or not
A set of parameters required for successfully integrating with the 3rd party platform (at least one is required)
The name of the parameter
The value of the parameter
The parameter’s label
The parameter’s type
Defines whether the parameter is plugin related or not
Details about an array of mapped values between the internal (CRM) and external (integrator) systems
The mapped external reference
The mapped value
The (custom) headers that will be used as part of this integration
The header key
The header value
Defines the plugin type (release based or custom)
Responses
The request has succeeded
Body
The integration identifier
POST https://sandbox.crm.com/backoffice/v2/integrations/ HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"name": "Basic marketing tool",
"connector": "MAILCHIMP",
"type": "PAYMENT_GATEWAYS",
"description": "Utilise marketing tool",
"is_enabled": "true",
"parameters": [
{
"key": "API_key",
"value": "abc-123-dfe-22111",
"label": "API Key",
"type": "NUMBER",
"is_plugin": "false",
"values": [
{
"external_reference": "12",
"value": "725b05ee-cfb3-c950-2db3-562dbbe0fdd4"
}
]
}
]
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "e5f0cbc9-e8a0-93cb-bb13-d6f5f20880fa"
}{id}Updates an existing integration
Path variables
The integration (identifier) that will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The integration name
The integration description
Defines if integration is enabled or not.
A set of parameters required for successfully integrating with the 3rd party platform (at least one is required)
The name of the parameter
The value of the parameter
The parameter’s label
The parameter’s type
Defines whether the parameter is plugin related or not
Details about an array of mapped values between the internal (CRM) and external (integrator) systems
The mapped external reference
The mapped value
The (custom) headers that will be used as part of this integration
The header key
The header value
Responses
The request has succeeded
Body
The integration identifier
PUT https://sandbox.crm.com/backoffice/v2/integrations/a55700d4-e48c-616f-b3a4-06b722207276 HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"name": "Basic marketing tool",
"description": "Utilise marketing tool",
"enabled": "true",
"parameters": [
{
"key": "API_key",
"value": "3234234-324324-234",
"label": "API Key",
"type": "NUMBER",
"is_plugin": "false",
"values": [
{
"external_reference": "201f2adb-174e-50d8-d0aa-f431711c8079",
"value": "12"
}
]
}
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "a55700d4-e48c-616f-b3a4-06b722207276"
}{id}Remove an existing Integration
Path variables
The integration (identifier) that will be deleted
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
DELETE https://sandbox.crm.com/backoffice/v2/integrations/c1a1e2b6-ec65-18fc-d73b-29726f3df06f HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 204 No Content Retrieve a list of configured integration points between CRM.COM and 3rd party platforms based on search criteria (e.g. all enabled integrations)
Request parameters
Filter based on connector
Filter based on integration type
Filter based on whether integrations are enabled or not
If set, retrieve the integrations of the business as usual but if the business does not have configured or enabled an integration and its service owner does, then return the integration of the service owner
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The integration identifier
The integration name
The integration description
The integration connector
The implementation’s endpoint
Defines whether the integration is enabled or not
The media URL for the integration logo (applicable only for PLUGIN types)
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/integrations/ HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "8b724e8a-26a0-4c70-a959-b87d6acf8b50",
"name": "Twinsoft",
"description": "Twinsoft POS Integration",
"connector": "TWINSOFT",
"type": "PAYMENT_GATEWAYS",
"is_enabled": true,
"media_url": "crm.com/provider.png"
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Retrieve detailed information for an integration
Path variables
The integration (identifier) for which details will be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The integration’s identifier
The integration’s name
The integration’s description
The 3rd party tool to integrate with
The implementation’s endpoint
Defines whether the integration is enabled or not
A list of parameters required for the integration
The name of the parameter
The value of the parameter
The parameter’s label
The parameter’s type
Defines whether the parameter is plugin related or not
Defines whether the parameter is for read purposes or not
Details about an array of mapped values between the internal (CRM) and external (integrator) systems
The mapped CRM external reference
The mapped integrator value
The media URL for the integration logo (applicable only for PLUGIN types)
The media (logo) URL for the integration logo (applicable only for PLUGIN types)
The (custom) headers that will be used as part of this integration
The header key
The header value
GET https://sandbox.crm.com/backoffice/v2/integrations/c0ec10d2-2549-3158-4e44-4fd9e833d000 HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "c0ec10d2-2549-3158-4e44-4fd9e833d000",
"name": "Marketing tool",
"description": "Default marketing tool used for forwarding email campaigns",
"connector": "PLUGIN",
"type": "MARKETING",
"is_enabled": "true",
"parameters": [
{
"key": "API_Key",
"value": "dacb48d8-3c1a-2321-b2b8-3b4a3f335a71",
"label": "API Key",
"type": "NUMBER",
"is_plugin": "true",
"is_read_only": "true",
"values": [
{
"external_reference": "201f2adb-174e-50d8-d0aa-f431711c8079",
"value": "12"
}
]
}
],
"media_url": "crm.com/provider.png",
"logo_media_url": "crm.com/logo-provider.png"
}{id}/actionsPerform actions on an existing integration (e.g. change API Key)
Path variables
The integration (identifier) that actions will be performed
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The action that will be applied on the integration
Generate a new API Key for the integration
Responses
The request has succeeded
Body
The integration identifier
POST https://sandbox.crm.com/backoffice/v2/integrations/6346ff58-3691-05c9-513e-f996299a9186/actions HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"action": "API_KEY"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "dad569a1-b5c0-eae2-4659-1753df6a8b7f"
}{id}/logsRetrieve a list of logs (related to an integration plugin) based on search criteria (e.g. all post api requests)
Path variables
The integration (identifier) of which logs should be retrieved
Request parameters
Filter based on the request state
Filter based on contact
Filter based on subscription
Filter based on user
Filter based on the date that such request was submitted
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The request identifier
The request state
The date that such request was made
A code that describes the request
The request body that was sent
The response that was sent
The error that is thrown
The error code
The error description
The contact that owns the subscription
The contact’s identifier
The contact’s name
The contact’s code
The request reference number
The user who performed the event
The user identifier
The user (full) name
The user email address
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/integrations/2dae3ca9-62aa-2e0a-3029-a6ac9afc47c4/logs HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "90f47a4a-344d-2433-234b-553ce143187e",
"state": "SUCCESS",
"submitted_date": 1596093272,
"request_code": "RC012323",
"body": "POST /crm.com/delivery HTTP/1.1 Host: staging.crm.com Content-Type: application/json api_key: 123456789012-1234-1234-1234-123456789012 Content-Type: text/plain { \"contact_id\": \"123456789012-ABCD-ABCD-ABCD-123456789012\", \"amount\": 20.45 }",
"response": "{ \"status\": { \"code\": \"COM.CRM.EXCEPTION.INVALIDTOKENEXCEPTION\", \"description\": \"The specific token is not valid.\", \"message\": \"The token is invalid, please obtain a new one.\" } }",
"error": {
"code": "404",
"description": "bad request"
},
"contact": {
"id": "437f21e8-f2e5-a774-101f-c1a8369d3ab0",
"name": "John Smith",
"code": "18235"
},
"reference_number": "12",
"user": {
"id": "4eac7060-307f-3937-2762-2beed146101f",
"name": "Jane Smith",
"email": "jsmith@acompany.com"
}
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}/user_profilesReturns a list of Cohorts configured in Mixpanel. Any Cohort will then be available to be imported in CRM.COM as a segment
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The cohort identifier
The cohor name
The cohor description
The number of cohors
The cohor created date
GET https://sandbox.crm.com/backoffice/v2/cohorts HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "fb47dde9-7de4-f88f-5430-384ea51ad480",
"name": "Great buyers",
"description": "Customers with moe then £500 purchases during the last month",
"count": 159,
"created_date": 332222331111
}
]
}{id}/user_profilesCreates a new (single) segment within CRM.COM that includes all user profiles of a Mixpanel cohort
Path variables
The Mixpanel Cohort (identifier) whose user profiles will be included in the segment
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The segment identifier
POST https://sandbox.crm.com/backoffice/v2/cohorts/aef5b1c2-d407-e018-6563-d5dfa17870fb/user_profiles HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "bb1ac256-8334-731d-d1f2-f30d95ab61e0"
}Create a new segment in Mailchimp based on a CRM.COM segment
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The segment’s identifier
Responses
The request has succeeded
POST https://sandbox.crm.com/backoffice/v1/lists HTTP/1.1
Content-Type: application/json
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
{
"id": "87A08449A8784063814398C104452B27"
}
HTTP/1.1 200 OK Returns a list of addresses based on the external address registry systems that CRM.COM integrates with
Request parameters
The address registry that lookup will be performed
The address that lookup will be performed against (address and latlng are semi-optional)
The lat and lng coordinates that lookup will be performed against (address and latlng are semi-optional)
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The full address as returned by the address registry
The address information
Additional address information about the address
The state/province/county of the address
The town/city of the address
The postal code of the address
The country code of the address
The latitude of the address
The longitude of the address
The Google textual identifier that uniquely identifies a location
The Google types that will be retrieved
GET https://sandbox.crm.com/backoffice/v1/addresses?address=The address that lookup will be performed against HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"address": "Elia Papakyriakou, Egkomi, 2415, Nicosia, Cyprus",
"address_line_1": "Elia Papakyriakou 21",
"address_line_2": "7 Tower Stars",
"state_province_county": "Egkomi",
"town_city": "Nicosia",
"postal_code": "2415",
"country_code": "CY",
"lan": 12.98,
"lon": 22.98,
"googlePlaceId": "ad23rwef2323f23f2f",
"types": [
"Accounting"
]
}
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"address": "Elia Papakyriakou, Egkomi, 2415, Nicosia, Cyprus",
"address_line_1": "Elia Papakyriakou 21",
"address_line_2": "7 Tower Stars",
"state_province_county": "Egkomi",
"town_city": "Nicosia",
"postal_code": "2415",
"country_code": "CY",
"lan": 12.98,
"lon": 22.98,
"googlePlaceId": "ad23rwef2323f23f2f",
"types": [
"Accounting"
]
}
]
}Retrieve a list of Integrated Receiver/Decoder (IRD) commands (of a device) as implemetned in a provisoning adapter. Either the provisioning adapter’s unique identifier must be specified or the external reference (usually the serial number) of the device
Request parameters
Filter based on the provisioning provider (integration)
Filter based on the device external reference
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The command name
The command label (can be used as a tooltip in the UI)
The command (unique) code. It’s value can be vary according to the implemented IRD commands per provisioning provider.
The command description (can be used as a tooltip in the UI)
Defines a list of extra information that might be required to be provided when sending the command to the provider
The parameter (unique) key
The parameter label (used for UI purposes)
The parameter description
The parameter field type (used for UI purposes)
Indicates whether the parameter is mandatory in order to be send the command successfully
GET https://sandbox.crm.com/backoffice/v1/provisioning/ird_commands HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"name": "Reset PIN",
"label": "Reset Device PIN",
"code": "RESET_PIN",
"description": "Resets the PIN to a given value",
"metadata_attributes": [
{
"key": "pin",
"label": "PIN",
"description": "the new pin",
"field": "SELECTION",
"is_mandatory": true
}
]
}
]
}Send an Integrated Receiver/Decoder (IRD) command for a device over to the provisoning adapter. The supported commands as well as detailed information on how to call them such as the required input paramters, can be retrieved from the plugin integration via the GET provisionig/ird_commands Web API.
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The device external reference (e.g. serial number) to which the IRD command will be sent
The IRD command’s unique code as this is implemented by the provisioning plugin
The device’s location (required only when sending a command related to the device’s physical locatin/region)
Defines a list of extra paramters (apart from the external reference) that is required to successfully send the command. Mandatory input paramters must be specified, otherwise default values set up in Provisioning Providers configuration will be used
The parameter’s key
The parameter’s value
Responses
POST https://sandbox.crm.com/backoffice/v2/provisioning/ird_commands HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"external_reference": "STB00013929322",
"code": "RESET_PIN",
"device_location": "master room",
"metadata_attributes": [
{
"key": "pin",
"value": "1234"
}
]
}
HTTP/1.1 204 No Content Send an Integrated Receiver/Decoder (IRD) command to a group of devices over to the provisoning adapter. The supported commands as well as detailed information on how to call them such as the required input paramters, can be retrieved from the plugin integration via the GET provisioning/ird_commands Web API.
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The device external reference (e.g. serial number) to which the IRD command will be sent
The IRD command’s unique code as this is implemented by the provisioning plugin
Defines a list of extra paramters (apart from the external reference) that is required to successfully send the command. Mandatory input paramters must be specified, otherwise default values set up in Provisioning Providers configuration will be used
The parameter’s key
The parameter’s value
A list of contact (unique) identifiers. The IRD commad is sent to all devices owned/rented by the specified contacts
A list of service product identifiers. The IRD command will be sent to the devices on whicch at least one of the specified service is enabled on.
A list of physical good products (the product of a device). The IRD command is sent only to devices whose product is one of the specified ones
A list of devices external references (e.g. device serial number). Only the specified devices will receive the IRD command
Responses
The request has succeeded
POST https://sandbox.crm.com/backoffice/v1/provisioning/ird_commands HTTP/1.1
Content-Type: application/json
{
"external_reference": "STB00013929322",
"code": "RESET_PIN",
"device_location": "master room",
"metadata_attributes": [
{
"key": "pin",
"value": "1234"
}
]
}
HTTP/1.1 201 Created Retrieves a list of configured payment gateway integration points in CRM.COM
Request parameters
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The integration identifier
The integration name
The integration description
The integration connector
The implementation’s endpoint
Defines whether the integration is enabled or not
The media URL for the integration logo (applicable only for PLUGIN types)
Defines the supported transaction classifications of such integration
Defines the supported payment methods of such integration
Required details per supported pament method
The bank details.Required and applicable if the payment method is set to BANK
IBAN code
Account name
Account Numer
Bank name
Bank code
Branch name
Account type (Savings, Chekings)
roadmap
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v1/payment_gateways HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "8b724e8a-26a0-4c70-a959-b87d6acf8b50",
"name": "PayPal",
"description": "PayPal payment gateway",
"connector": "PLUGIN",
"integration_type": "COMMUNICATIONS",
"enabled": true,
"media_url": "crm.com/provider.png",
"classifications": [
"PAYMENTS"
],
"payment_method_types": [
"CARD"
],
"details": {
"account_debit": [
"SWIFT"
],
"card": "",
"wallet": [
"PHONE"
]
}
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Retrieves the stock balance of the current (business) inventory located into its warehouse
Request parameters
The product for which the stock will be retrieved
The product type for which the stock will be retrieved
The product family for which the stock will be retrieved
Filter based on whether products to be retrieved should be traceable or not
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The ID of the product
The sku of the product
The name of the product
Defines whether the product is traceable
Applicable only for Composite products. Defines the number of variant products also available in stock
Applicable only for variant products as it shpws the composite product
Defines the quantity of products that exist in the warehouse
Defines the latest cost per unit sold on most recent invoice
Defines the average cost per unit
Warehouse items reserved by various processes like non-completed Orders/Service Requests and in Draft Invoices
Warehouse items owned by the business but given out to contacts and not yet invoiced. These items are not located in the warehouse.
Warehouse items owned by the business and given out to contacts as Rentals. These items are not located in the warehouse.
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/warehouses/stock HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"product": {
"id": "6A24D2B5E44F44B28451FE021FCAD51E",
"sku": "sku",
"name": "Set-top-box",
"is_traceable": "true",
"number_of_variants": 3,
"composite_product": {
"id": "",
"sku": "",
"name": ""
}
},
"stock_balance": 100,
"latest_cost_per_unit": 9.99,
"average_cost_per_unit": 3.99,
"currency_code": "EUR",
"reserved": 10,
"dispatched": 105,
"rented": 5
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}Creates a new warehouse transaction. Warehouse transactions of any type can be created with this Web API call.
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Moves items to the warehouse
Removes items from warehouse
Used to adjust the stock in the warehouse
The transaction’s code (if not specified, then a unique random 16-digit code is assigned)
The supplier of the products (applicable and required only for stock in transactions)
The transaction’s description
The contact (identifier) that the device is sold/rented to (applicable only for stock out transactions, when not sold/rented to other organisations)
The organisation (identifier) that the device is sold/rented to (applicable only for stock out transactions, when not sold/rented to contacts)
Triggers Stock Out transactions
Triggers Stock In transactions
Items dispatched to consumers
Items dispatched to consumers
Item added as a Rental on a subscription (when Stocked Out) or rental item returned back to the warehouse when removed from Subscription (Stock ins)
The initiating entity identifier
The items to be included in the transaction
The product (identifier) of the transaction item. (only traceable or not stockable physical goods can be specified)
The quantity to stock in/out. (required for non-traceable physical goods, where for traceable physical goods the quantity is calculated based on the number of device serial numbers)
The cost per unit (applicable only for stock in transaction)
Defines how the stock balance will be adjusted by this transaction. Applicable only for Stock Adjustments.
Stock will be increased
Stock will be decreased
Defines the devices that will be included in the transaction
The device serial number
The device electronic id
Responses
The request has succeeded
Body
The warehouse transaction identifier
POST https://sandbox.crm.com/backoffice/v2/warehouses/transactions HTTP/1.1
Content-Type: application/json
{
"type": "STOCK_OUT",
"code": "5467778889098987",
"supplier": "AluxSat Provider",
"description": "A stock in transaction to import modems",
"organisation_id": "7a31ab39-d4e2-9d75-aadc-3d44d0484fb5",
"items": [
{
"product_id": "7d39062b-5fd9-c4e5-1078-b1dd9186a936",
"quantity": 10,
"unit_cost": 10.5,
"adjust_type": "+",
"item_id": "e4d3b37f-81a4-7f79-38e7-77fafff64078"
}
]
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "e3743be1-54d5-5f67-b187-887b0b47040f"
}Search for warehouse transactions. Transactions of a single warehouse can be retreived.
Request parameters
Filter based on search value (case insensitive) across transaction’s code
Filter based on warehouse transaction’s type
Moves items to the warehouse
Removes items from warehouse
Used to adjust the stock in the warehouse
Filter based on products that exist on transactions
Filter based on the performed date, which may fall within a given date range. The value can be a string with a date in epoch format. Each option must also include an operator. Use up to two options based on the required search (e.g. performed_on[gte]=1618395497&performed_on[lt]=1618395497).
Returns results where the performed date is greater than this value
Returns results where the performed date is greater than or equal to this value
Returns results where the performed date is less than this value
Returns results where the performed date is less then or equal to this value
Filter based on the entity (type) that initiated the transaction
Triggers Stock Out transactions
Triggers Stock In transactions
Items dispatched to consumers
Items dispatched to consumers
Item added as a Rental on a subscription (when Stocked Out) or rental item returned back to the warehouse when removed from Subscription (Stock ins)
Filter based on the entity (identifier) that initiated the transaction (requires initiated_by)
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Filter based on product type
Filter based on user (that submitted such transaction)
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The transaction’s identifier
The transaction’s code
The transaction’s description
Moves items to the warehouse
Removes items from warehouse
Used to adjust the stock in the warehouse
The number of items (products) moved due to the transaction
The date on which the transaction was performed
The user’s identifier
The user’s full name
The user’s credential username
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/warehouses/transactions HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "99cd9de0-93e7-4d73-5ac8-16fa45819c32",
"code": "4345600003321234",
"description": "A stock in transaction to import modems",
"type": "STOCK_OUT",
"number_of_items": 1000,
"performed_date": 1618857652,
"performed_by": {
"id": "a12b282f-e6ce-e618-0a72-becb3ad78033",
"name": "John Smith",
"username": "johnsmith@crm.com"
}
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "99cd9de0-93e7-4d73-5ac8-16fa45819c32",
"code": "4345600003321234",
"description": "A stock in transaction to import modems",
"type": "STOCK_ADJUSTMENT",
"number_of_items": 1000,
"performed_date": 1618857652,
"performed_by": {
"id": "a12b282f-e6ce-e618-0a72-becb3ad78033",
"name": "John Smith",
"username": "johnsmith@crm.com"
}
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Get details for a specific warehouse transaction
Path variables
The warehouse transaction (identifier) to be retrieved
Request headers
Authorization Token
The public api key required for API calls to identify the organisation
Responses
The request has succeeded
Body
The transaction’s identifier
The transaction’s code
The transaction’s description
The supplier that stocked in transaction was made from
Moves items to the warehouse
Removes items from warehouse
Used to adjust the stock in the warehouse
The total cost of the warehouse transaction
The twarehose transaction’s currency
The date on which the transaction was performed
The user’s identifier
The user’s full name
The user’s credential username
Details about the related contact
The contact identifier
The contact full name
The contact unique code
Details about the organisation from where such event was posted
The organisation identifier
The organisation name
The list of items included in the warehouse transaction
The product identifier
The product SKU code
The product name
The products’s quantity (applicable for stock in/out transactions)
The unit cost per product (applicable for stock in/out transactions)
The total cost per transaction item (applicable for stock in/out transactions)
Indicates whether the specified products are added or removed from the warehouse’s stock balance (applicable for stock adjustments)
The devices that were part of the transaction
The device serial number
The device electronic id
The entity that triggered the transaction
Triggers Stock Out transactions
Triggers Stock In transactions
Items dispatched to consumers
Items dispatched to consumers
Item added as a Rental on a subscription (when Stocked Out) or rental item returned back to the warehouse when removed from Subscription (Stock ins)
The unique identifier of the entity e.g. Service Request, Subscription or a financial transaction
The number of the entity
GET https://sandbox.crm.com/backoffice/v2/warehouses/transactions/c52e6ac3-5889-6006-4d7c-0a43c6cfefec HTTP/1.1
api_key: 8c54d563-b991-4b76-8a83-557c08166f95
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "c52e6ac3-5889-6006-4d7c-0a43c6cfefec",
"code": "434000321934812",
"description": "Stock in HD Receivers April 2021",
"supplier": "AluxSat Provider",
"type": "STOCK_ADJUSTMENT",
"total_cost": 99.99,
"currency": "EUR",
"performed_date": 1618859668,
"performed_by": {
"id": "a12b282f-e6ce-e618-0a72-becb3ad78033",
"name": "John Smith",
"username": "johnsmith@crm.com"
},
"contact": {
"id": "1c060611-0667-313e-b3bf-4cb70ee81cdf",
"name": "John Doe",
"code": "C123"
},
"organisation": {
"id": "4248fab3-67d5-2eb1-eaf6-079ce18cd2ed",
"name": "Bravo Coffee"
},
"items": [
{
"product": {
"id": "e283a863-18e1-7cae-48c4-7433bf28cf97",
"sku": "ABC-12345",
"name": "ABC"
},
"quantity": 10,
"unit_cost": 10.99,
"total_cost": 109.9,
"adjust_type": "+"
}
],
"initiated_by": {
"type": "INVOICE",
"id": "321c4a1f-066d-a321-3b5b-f386a9750e4c",
"number": "AT1234RE"
}
}Retrieves the reserved (traceable & non-traceable) products with the reserved by entity and quantity
Request parameters
The product for which the stock will be retrieved
The product type for which the stock will be retrieved
The product family for which the stock will be retrieved
Filter based on whether products to be retrieved should be traceable or not
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Filter based on the order that such products are reserved by
Filter based on the service request that such products are reserved by
Filter based on the invoice that such products are reserved by
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The product identifier
The product SKU code
The product name
The business entity from which the device is reserved
The business entity from which the device is reserved for
The business entity identifier that such device is reserved by
The business entity number that such device is reserved by
The number of reserved products
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/warehouses/stock/reserved HTTP/1.1
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"product": {
"id": "e283a863-18e1-7cae-48c4-7433bf28cf97",
"sku": "ABC-12345",
"name": "ABC"
},
"reserved_by": {
"type": "SERVICE_REQUESTS",
"id": "370324b5-5f55-7f84-43e5-5699cc2ae26d",
"number": "N1234"
},
"quantity": 12
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}A (sales) lead, is a prospect customer who is interested in the products or services your company has to offer. Each new lead is assigned to a queue with stages, the lead progresses through the stages in a predefined order until it’s won or lost.
{id}{id}{id}{id}/queues/stages{id}/actionsCreate a new lead, the state of the lead and the pipeline stage will automatically set to ‘new’.
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Title of the lead, titles must be unique across all leads
The id of the queue assigned to the lead
A description of the lead.
The potential value of the lead if it’s won, the value is always in the base currency of the system
The expected closing date for the lead
The user identifier
The team identifier
The custom field’s unique key
The custom field’s value
Examples
Responses
The request has succeeded
Body
The id of the lead created
POST https://sandbox.crm.com/backoffice/v2/leads HTTP/1.1
Content-Type: application/json
{
"queue_id": "da60dd8f-b124-439d-a7fe-e1bdbd484c71",
"title": "Watch It - new subscriptions lead (London)",
"description": "The client has an existing software but is looking for a better solution due to expansion.",
"value": 10000,
"expected_close_date": 98765342,
"assign_to": {
"user_id": "1edef819-0a1d-4d41-9d2a-d4bbc2ddbedf",
"team_id": "a43f08ca-998b-afbc-6ed4-c9dc2d136935"
},
"custom_fields": [
{
"key": "back_office",
"value": "0001-12345"
}
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "8ade0c06-6ba3-4ed0-9e04-228201e1b30c"
}{id}- Update basic information for a single lead
- Transfer the lead to another queue and assign a new stage within the queue
Path variables
The GUID of the lead to be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The unique title of the lead
Brief description of the lead
The id of the contact linked to the Lead (optional)
The potential value of the lead if it’s won. Value is specified in the business’s base currency
The expected closing date for the lead.
The user identifier
The team identifier
Transfer the lead to another queue, and optionally select a new stage within the queue for the lead. NOT to be used for progressing the lead to another stage within the same queue.
The new queue to transfer the lead to
The id of the stage in the new queue to be acquired by the lead, should only be used in conjunction with queue id. If not specified, then the lead moves into the first stage of the new queue.
The custom field’s unique key
The custom field’s value
Examples
Responses
Body
Id of the lead updated
PUT https://sandbox.crm.com/backoffice/v2/leads/6f279898-d873-4175-941f-77eec76709c1 HTTP/1.1
Content-Type: application/json
{
"title": "Baker's Group of Companies - rewards lead",
"description": "The customer is keen to implement the rewards software in time for their opening.",
"contact_id": "ee814b4b-894d-4353-9a98-485f2b821ff8",
"value": 10000,
"expected_close_date": 98765342,
"assign_to": {
"user_id": "1edef819-0a1d-4d41-9d2a-d4bbc2ddbedf",
"team_id": "a43f08ca-998b-afbc-6ed4-c9dc2d136935"
},
"queue": {
"id": "2f7ab71a-c70e-4a92-ae6d-3d86091eedba",
"stage_id": "ca6f8248-b0dc-4f58-b30b-babacc7533b8"
},
"custom_fields": [
{
"key": "back_office",
"value": "0001-12345"
}
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "6f279898-d873-4175-941f-77eec76709c1"
}{id}Delete a single lead, a lead can be deleted if it’s not in a ‘won’ or ‘lost’ state.
Path variables
The GUID of the lead to be deleted
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
DELETE https://sandbox.crm.com/backoffice/v2/leads/4AD9C84FA60F9FE407140E20F707726A HTTP/1.1
HTTP/1.1 204 No Content Retrieve leads based on filtering parameters
Request parameters
The page number that should be retrieved
The size (total records) of each page
Defines the attribute to be used for sorting the results
Stage of the lead within the queue
Search for a lead using Title, Organisation, Contact person’s name
The queue id (to view leads in this queue)
The queue stage id (to view leads in this stage)
Filter leads based on lead state - comma separated (NEW, IN PROGRESS, WON, LOST)
Filter based on the lead expected close date
Returns results where the expected close date is greater than this value
Returns results where the expected close date is greater than or equal to this value
Returns results where the expected close date is less than this value
Returns results where the expected close date is less then or equal to this value
Display those leads whose expected closing date has passed, but still have a status of NEW or IN PROGRESS.
The id of the Contact associated to the Lead (if it exists)
The ids of the tags to filter by
Defines whether tags should be retrieved or not
Filters based on specific assign to user
Filters based on specific assign to team
Filters based on custom fields (key/value set should be semicolon separated)
Request headers
Authorization Token
Defines whether tags should be retrieved or not
The secret api key required for API calls to ensure that the client is trusted
Responses
Successful Request
Body
The lead unique identifier
The title of the lead
The order life cycle state
Lead queue information
Queue id
Queue name
Lead stage (within the queue) information
Current stage id
Current stage name
Stage colour hex code
A brief description of the lead
Details of the contact linked to the lead (if applicable)
The id of the Contact linked to the Lead
The contact’s code
The full name of the contact linked to the lead
The potential value of the lead to the business (if it’s won)
The expected closing date of the lead
Details about the user that the record is assigned to
The user identifier
The user name
The username of the user
Details about team
The team identifier
The team name
Tag unique id
Tag name
The colour of the tag - for list view only
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/leads HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "9d1da6fc-e97c-4e1a-94e3-68ce1dafb899",
"title": "Burger Time Restaurants (chain)",
"state": "IN_PROGRESS",
"queue": {
"id": "6f279898-d873-4175-941f-77eec76709c1",
"name": "New large-scale business rewards lead"
},
"stage": {
"id": "43528b33-25a1-41b3-8629-431ca3fd58ec",
"name": "Proposal submitted",
"colour": "#2c8ef8"
},
"description": "Interested in loyalty programs, group of companies",
"contact": {
"id": "1fffae21-47ce-41b2-8de8-1be69c67fc89",
"code": "C0001234",
"name": "John Smith"
},
"value": 1,
"currency_code": "EUR",
"expected_close_date": 98765342,
"assigned_to": {
"user": {
"id": "47ac694d-6281-b873-bf46-3fd8da334a3a",
"name": "John Doe",
"username": "j_doe@crm.com"
},
"team": {
"id": "bf1370a1-73ad-0bbf-6fef-f2ce1938d4fe",
"name": "Support"
}
},
"tags": {
"id": "609a369e-3f10-492a-8332-679ecbe56b65",
"name": "Maintenance",
"colour": "FR547F"
}
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Retrieve the information for a specific lead.
Path variables
The lead identifier (GUID) of the lead to be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The lead GUID
The title of the lead, mandatory and unique.
The order life cycle state
Lead queue information
Queue id
Queue name
Stage information within the queue
Current stage id
Current stage name
Stage colour hex code
A brief description of the lead
Details of the Contact linked to the Lead (if applicable)
Contact id
Cotnact code
Contact full name
The potential value of the lead if it’s won
The expected closing date of the lead
Lost reason information (applicable if state = LOST)
Lost reason id
The reason for losing the lead
Details about the user that the record is assigned to
The user identifier
The user name
The username of the user
Details about team
The team identifier
The team name
The custom field’s unique key
The custom field’s value
GET https://sandbox.crm.com/backoffice/v2/leads/9d1da6fc-e97c-4e1a-94e3-68ce1dafb899 HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "9d1da6fc-e97c-4e1a-94e3-68ce1dafb899",
"title": "Burger Time Restaurants (chain)",
"state": "WON",
"queue": {
"id": "6f279898-d873-4175-941f-77eec76709c1",
"name": "New large-scale business rewards lead"
},
"stage": {
"id": "43528b33-25a1-41b3-8629-431ca3fd58ec",
"name": "In Negotiation",
"colour": "#2c8ef8"
},
"description": "Mitchell & Sons - group of companies",
"contact": {
"id": "c0295421-2de8-49c3-accf-6b9a86b903e1",
"code": "C00000123455",
"name": "John Brown"
},
"value": 15000,
"currency_code": "EUR",
"expected_close_date": 98765342,
"lost_reason": {
"id": "eba0a22c-adec-402c-be8e-f1d61e4f4bff",
"name": "Lead has lost interest"
},
"assigned_to": {
"user": {
"id": "47ac694d-6281-b873-bf46-3fd8da334a3a",
"name": "John Doe",
"username": "j_doe@crm.com"
},
"team": {
"id": "bf1370a1-73ad-0bbf-6fef-f2ce1938d4fe",
"name": "Support"
}
},
"custom_fields": [
{
"key": "back_office",
"value": "0001-12345"
}
]
}{id}/queues/stagesRetrieve all the queue stages that a specific lead has progressed through until now.
Path variables
The GUID of the lead whose queue stages will be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
History of lead stages progression
Queue stage id
Stage name
Date of achieving this stage
Stage colour hex code
GET https://sandbox.crm.com/backoffice/v2/leads/1fda2322-ed57-4f2b-93e2-9198eebcea07/queues/stages HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "2eb909cf-2467-4827-81ca-498ad4b2421f",
"name": "Proposal Submitted",
"date": 98765342,
"colour": "#2c8ef8"
}
]
}{id}/actionsAction a lead by:
- changing the state of a lead (e.g. from ‘in progress’ to ‘won’)
- changing the queue stage of a lead (e.g. progress a lead to the next stage in the queue).
- merging two leads into one, any data not available on the lead to be kept will be copied from the source lead (specified in the body)
Path variables
The GUID of the lead for which an action will be taken against, must be one of the following:
- id of the lead whose state will be changed
- id of the lead whose queue stage will be changed
- id of the lead to be kept when merged
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Action to be performed
Change the lead state to In Progress (from New)
Change the lead state to Won
Change the lead state to Lost
Progress/regress a lead to another stage in the queue
Merge two leads into one
Id of the lost reason, optional and applicable only if action = LOST (i.e. the state of the lead becomes 'Lost)
The new queue stage id, applicable and required if action = PROGRESS
The id of the lead to be merged (with the lead id specified in path variables) and then deleted. Applicable and required if action = MERGE
Examples
Responses
Body
The GUID of the lead for which an action was taken
Changing the lead state
POST https://sandbox.crm.com/backoffice/v2/leads/6f279898-d873-4175-941f-77eec76709c1/actions HTTP/1.1
Content-Type: application/json
{
"action": "LOST",
"lost_reason_id": "1fda2322-ed57-4f2b-93e2-9198eebcea07"
}Progressing the lead to another stage in the queue
POST https://sandbox.crm.com/backoffice/v2/leads/6f279898-d873-4175-941f-77eec76709c1/actions HTTP/1.1
Content-Type: application/json
{
"action": "PROGRESS",
"stage_id": "6f279898-d873-4175-941f-77eec76709c1"
}Merging two leads into one
POST https://sandbox.crm.com/backoffice/v2/leads/6f279898-d873-4175-941f-77eec76709c1/actions HTTP/1.1
Content-Type: application/json
{
"action": "MERGE",
"source_id": "54166dd3-cd16-49a6-be97-559aac425914"
}Changing the lead queue and assigning a new stage
POST https://sandbox.crm.com/backoffice/v2/leads/6f279898-d873-4175-941f-77eec76709c1/actions HTTP/1.1
Content-Type: application/json
{
"action": "QUEUE",
"queue": {
"id": "e18ee2bc-c6f3-49e1-8e05-763386378017",
"stage_id": "78b79217-0c14-4285-9c7b-e1701d31f18c"
}
}Change the lead queue stage, the assignee, expected close date for one or more leads that have been selected as part of a bulk update action. The request must include at least one of these three attributes to be updated in bulk mode.
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Selected leads for bullk update
A list of lead unique ids to be updated
The new queue stage id (optional)
The user identifier
The team identifier
The new expected close date (optional)
Examples
Responses
POST https://sandbox.crm.com/backoffice/v2/leads/bulk HTTP/1.1
Content-Type: application/json
{
"leads": [
{
"id": "6f279898-d873-4175-941f-77eec76709c1"
}
],
"stage_id": "c8079ee1-8081-4be1-ab09-5091f55b2d4e",
"assign_to": {
"user_id": "1edef819-0a1d-4d41-9d2a-d4bbc2ddbedf",
"team_id": "a43f08ca-998b-afbc-6ed4-c9dc2d136935"
},
"expected_close_date": 98765342
}
HTTP/1.1 200 OK Notes for internal use only can be added to a lead. Notes can be pinned to always appear at the top of the list.
{id}/notes{id}/notes/{note_id}{id}/notes/{note_id}{id}/notes{id}/notesCreate a new note for a lead
Path variables
Lead GUID for which the note is to be created
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The note contents
Pinned notes appear at the top of the notes list. True = pin note, false = don’t pin note
Examples
Responses
The request has succeeded
Body
The identifier for the note created
POST https://sandbox.crm.com/backoffice/v2/leads/8ade0c06-6ba3-4ed0-9e04-228201e1b30c/notes HTTP/1.1
Content-Type: application/json
{
"note": "After my telephone conversation with Zack this morning, it was decided that....",
"pinned": true
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "1edef819-0a1d-4d41-9d2a-d4bbc2ddbedf"
}{id}/notes/{note_id}Update a note for a lead. Only the user who created the note can edit it.
Path variables
The lead GUID
The note GUID
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The actual note contents
Pinned notes appear at the top of the notes list.
Examples
Responses
Body
The GUID of the updated note
PUT https://sandbox.crm.com/backoffice/v2/leads/8ade0c06-6ba3-4ed0-9e04-228201e1b30c/notes/1edef819-0a1d-4d41-9d2a-d4bbc2ddbedf HTTP/1.1
Content-Type: application/json
{
"note": "After my telephone conversation with Zack this morning, it was decided that....",
"pinned": true
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "1edef819-0a1d-4d41-9d2a-d4bbc2ddbedf"
}{id}/notes/{note_id}Delete a single note for a lead. Only the user who created the note can delete it.
Path variables
The GUID of the lead
The GUID of the note to be deleted
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
DELETE https://sandbox.crm.com/backoffice/v2/leads/8ade0c06-6ba3-4ed0-9e04-228201e1b30c/notes/1edef819-0a1d-4d41-9d2a-d4bbc2ddbedf HTTP/1.1
HTTP/1.1 204 No Content {id}/notesRetrieve all notes for a single lead.
Path variables
The GUID of the lead whose notes are to be retrieved
Request parameters
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Successful Request
Body
The note unique identifier
The note contents
Details of the user who created the note
The GUID of the user who created the note
The name of the user who created the note
Date and time the note was created
Date and time the note was updated
Is note pinned so that it appears at the top of the notes list?
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/leads/8ade0c06-6ba3-4ed0-9e04-228201e1b30c/notes HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "1edef819-0a1d-4d41-9d2a-d4bbc2ddbedf",
"note": "After my telephone conversation with Zack this morning, it was decided that....",
"created_by": {
"id": "c8079ee1-8081-4be1-ab09-5091f55b2d4e",
"username": "Sam Jackson"
},
"created_on": "9876577501",
"updated_on": "9876579547",
"pinned": "true"
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}Add one or more tags to leads to be used for filtering purposes.
{id}/tags{id}/tags{id}/tagsUpdate the tags associated with the lead
Path variables
The lead (identifier) on which tags will be upaded
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The tags that will be associated with the activity
Responses
The request has succeded
Body
The lead identifier
PUT https://sandbox.crm.com/backoffice/v2/leads/d4187991-4d1a-4aa2-fa3e-ce5fe7fdb7d9/tags HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"tags": [
"96c3cb52-c68f-6ba6-e886-ed28f2b594cb"
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "d4187991-4d1a-4aa2-fa3e-ce5fe7fdb7d9"
}{id}/tagsRetrieve a list of tags that are associated with the lead
Path variables
The lead (identifier) of which tags will be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeded
Body
The tag identifier
The tag name
The tag color (hex code) that will be used for visual purposes
GET https://sandbox.crm.com/backoffice/v2/leads/d82881e9-a909-9d44-4f28-4b30fc1ac276/tags HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "1abe9097-d46a-d2ed-3415-fd3e1439d8d4",
"name": "VIP",
"colour": "#0000FF"
}
]
}Upload files related to a Lead for easy referencing. Acceptable file types include: .png, .doc, .docx, .jpeg, .jpg, .pdf, .json, .log, .svg, .eml, . xls, .xslx, .msg, .txt, .csv. Maximum file size is 4GB.
{id}/attachments{id}/attachments/{file_id}{id}/attachments{id}/attachmentsConnect an uploaded attachment to an existing lead using the file id or url
Path variables
The lead (identifier) to which the file will be attached
Notes
Integrating attachments upload for Service Requests should be based on the following APIs
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The uploaded file signature (identifier) to be attached (file or link should be provided)
The URL endpoint to be attached (file or link should be provided)
The file description
Responses
The request has succeeded
Body
The attachment identifier
POST https://sandbox.crm.com/backoffice/v2/leads/66451204-4404-894c-4dc6-486c540ece40/files HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"file_id": "30526723-24a3-e4e3-1a75-b26b1b41f05c",
"url": "https://crmcom.sharepoint.com/:x:/s/servicerequests/EZx2qopbvfN3uj1o3dOqbPm52Ct6bg?rtime=w0ic-hfG2Ug",
"description": "PowerPoint demo"
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "66451204-4404-894c-4dc6-486c540ece40"
}{id}/attachments/{file_id}Delete an attachment from a lead
Path variables
The lead (identifier) from which the attachment will be deleted
The attachment (identifier) to be deleted
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
DELETE https://sandbox.crm.com/backoffice/v2/leads/66451204-4404-894c-4dc6-486c540ece40/files/04c0bebd-8bb0-0b3e-e1a6-716a0fd200b1 HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 204 No Content {id}/attachmentsRetrieve all attachment files for a specific lead
Path variables
The lead (identifier) for which files will be retrieved
Request parameters
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The attachement identifier
The attachement description
The attached file
The attached file identifier
The attached file URL endpoint
The attached file name
The mime type of the uploaded file
The attached URL endpoint
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/leads/66451204-4404-894c-4dc6-486c540ece40/files HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "3ae9d64a-8a3b-f1e1-eed6-05b307f926fb",
"mime": "docx",
"description": "Screenshot sent by customer",
"file": {
"id": "0317868f-28f8-9f56-d248-5a78718b38cc",
"url": "https://crmcom.sharepoint.com/:x:/s/servicerequests/EZx2qopbvfN3uj1o3dOqbPm52Ct6bg?rtime=w0ic-hfG2Ug",
"name": "img.png"
}
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}{id}{id}{id}/actionsCreates a new Order for a contact or organisation(merchant or service provider). An Order can be placed only after an Order estimation. The estimatetion’s identifier is the basic input for this Web API since it includes the order’s details such as the ordered items, so it’s required to call POST /estimates/orders in advance to retrieve the order’s estimation_id.
Notes
The following APIs should be called in order to make an order
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The estimation_id as this is returned back by the estimates/order Web API
List of payments to pay off the order. An order might be paid off using multiple payments; one payment using a contact payment method or an offiline payment method type and a second payment when contacts want to partially pay their orders using CRM Wallet funds.
The payment’s amount. If set to an amount less than th eorder’s total cost, then this implies that account funds will be used to pay off the order.
The type of the event
The unique identifier of the contac’ts payment method. Applicable and required when the select payment method type is either a Card, an Account Debit or a Wallet.
The order general notes
The custom field’s unique key
The custom field’s value
A list of devices unique identifiers. Applicable when order includes traceable physical goods.
[
"37b56acf-665c-1112-93fc-163b3639bcbe"
]Responses
Created
Body
The unique identifier of the new order
POST https://sandbox.crm.com/backoffice/v2/orders HTTP/1.1
Content-Type: application/json
{
"estimation_id": "37b56acf-665c-1112-93fc-163b3639bcbe",
"payments": [
{
"amount": 12.21,
"payment_method": {
"type": "CARD",
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}
}
],
"notes": "Lorem Ipsum",
"custom_fields": [
{
"key": "back_office",
"value": "0001-12345"
}
],
"devices": [
"37b56acf-665c-1112-93fc-163b3639bcbe"
]
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "f3076649-5350-4215-9278-ba95452a72f7"
}{id}Updates an existing Order. Cancelled and Completed Orders cannot be updated.
Path variables
The order identifier that will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Order notes
Order category
A reference provided by external systems
The type of the event
The unique identifier of the contac’ts payment method. Applicable and required when the select payment method type is either a Card, an Account Debit or a Wallet.
The updated stage of the Order. The updated stage must be one of the Order Queue’s stages. The new stage must be the next in lines compared to the current stage of the Order.
Stage identifier.
The comment inserted when a new stage is achieved.
The new address related to the Order. The address can only be changed for Delivery Orders.
One of the contact’s addresses at which the Order will be delivered to. Either a contact address on a one-off address can be specified
The locastion at which the Order will be delivered. This is an one-off delivery address, not registere din CRM.COM but is speicifed manually be the contact on ordering. Either a contact address or a one-off address can be specified per Web API call.
Address Line 1
Address Line 2
State/Province/State
Town/City
Postal Code
Latitude
Longitude
Gougle Place ID
Ad-hoc discount provided to Orders on their total cost.
Determines if the discount is an amount or a percentage
The discount’s amount
List of ordered items. At least one is included in Orders
Ordered product’s unique identifier. All products apart from Modifiers can be included in an Order.
Quantity of purchased items
Order item’s notes
List of produt components. Applicable only if the ordered item is a flexible bundle
Component product’s unique identifier
Component product quantity
Order milestones can be updated on conditions. Milestones already reached or milestones for the order’s previous stages cannot be modified. New milestones for upcoming stages can be added and existing ones can be removed. The total amount among all milestones cannot be greater than the order’s total cost.
Order milestone identifier
The milestone’s stage. Only stages with milestone setting sin the Order’s queue can be specified.
Set a new milestone percentage.
Set an updated milestone amount. This amount cannot be greater than the order’s cost
The custom field’s unique key
The custom field’s value
Examples
Responses
Body
The order identifier
Determines whether approval reuqests are applied or not, if not null an approval is requested
The apporval request identifier
PUT https://sandbox.crm.com/backoffice/v2/orders/f3076649-5350-4215-9278-ba95452a72f7 HTTP/1.1
Content-Type: application/json
{
"notes": "Lorem Ipsum",
"category_id": "f3076649-5350-4215-9278-ba95452a72f7",
"external_reference": "REF1234",
"payment_method": {
"type": "CARD",
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
},
"stage": {
"id": "f3076649-5350-4215-9278-ba95452a72f7",
"comment": ""
},
"address": {
"id": "f3076649-5350-4215-9278-ba95452a72f7",
"other": {
"address_line_1": "Ydras 34",
"address_line_2": "Chaidari",
"state_province_country": "Attica",
"town_city": "Athens",
"postal_code": "1026",
"country_code": "CYP",
"lat": "",
"lon": "",
"google_place_id": ""
}
},
"discount": {
"type": "AMOUNT",
"amount": 1.99
},
"items": [
{
"product_id": "f3076649-5350-4215-9278-ba95452a72f7",
"quantity": 1,
"notes": "Lorem Ipsum",
"components": [
{
"product_id": "f3076649-5350-4215-9278-ba95452a72f7",
"quantity": 2
}
]
}
],
"milestones": [
{
"id": "f3076649-5350-4215-9278-ba95452a72f7",
"stage_id": "f3076649-5350-4215-9278-ba95452a72f7",
"percentage": 5.5,
"amount": "9.99"
}
],
"custom_fields": [
{
"key": "back_office",
"value": "0001-12345"
}
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "f3076649-5350-4215-9278-ba95452a72f7",
"approval_requests": [
{
"id": "3a4aad81-e5c2-72b7-3a86-903239d08767"
}
]
}{id}Deletes an Order. A single order is deleted per Web API call. Cancelled and Completed Orders cannot be deleted. An Order can be deleted if:
- No items were dispatched to the contact
- No Invoicing was performed.
- Has not reached its Point of No Return (if any)
Path variables
The order identifier that will be deleted
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
DELETE https://sandbox.crm.com/backoffice/v2/orders/f3076649-5350-4215-9278-ba95452a72f7 HTTP/1.1
HTTP/1.1 204 No Content Retrieve a list of orders based on search criteria (e.g. today’s new orders). Multiple Orders of different contacts/organisations can be retrieved.
Request parameters
The account agianst which Order was placed
Filters orders based on the contact that placed such orders
The organisation that placed the order
Defines how order was/will be provided
Delivered to the customer’s address
Picked up by the customer from a venue
Online sales of services
Fitlers based on the order state
NEWFilters orders based on whether are marked as favorite or not
Filters orders based on created date
Returns results where the created date is greater than this value
Returns results where the created date is greater than or equal to this value
Returns results where the created date is less than this value
Returns results where the created date is less then or equal to this value
Filter orders based on the organisation that will fulfill such orders
Filter orders based on the organisation’s tap code that will fulfill such orders (tap should be active)
Detemrines if the address will be returned or not
The country (code) in which the order was fulfilled by
The order queue
The status of the order
Point of no return reached
Filters based on custom fields (key/value set should be semicolon separated)
Search for orders based on their number and contact name
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Defines whether approval requests information should be retrieved or not
Filter based on approval state
The date on which an Order was cancelled.
Returns results where the date is greater than this value
Returns results where the date is greater than or equal to this value
Returns results where the date is less than this value
Returns results where the date is less then or equal to this value
The date on which Orders were completed.
Returns results where the date is greater than this value
Returns results where the date is greater than or equal to this value
Returns results where the date is less than this value
Returns results where the date is less then or equal to this value
The date on which the Order’s processing started (went into In Progress state)
Returns results where the date is greater than this value
Returns results where the date is greater than or equal to this value
Returns results where the date is less than this value
Returns results where the date is less then or equal to this value
Search for an Order using its delivery address
Search for an order using the delivery address’s name
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
The order identifier
The order number
A reference identifier (usually an id) provided by an external system that provisioned this order
Details pertaining to the queue
Queue identifier
Queue name
The Order’s current stage
Stage identifier
Stage name
stage colour
The order life cycle state
The type of the event
Delivered to the customer’s address
Picked up by the customer from a venue
Online sales of services
The order general notes
Number of milestones
The number of items included in the Order
Defines whether the point of no return has been reached or not
The total cost of all order items. The cost equals to the total cost of the order’s invoice, taxes and discounts included
The order’s total amount before applying the discount. Includes the tax amount
The amount that was used from wallet funds
The Order’s amount due i.e. how much the contact/organisations needs to pay in order to fully pay off the order’s cost (order total minus any payments already posted for the order, if any)
Total discount amount provided to the ordered items. Ad-hoc discount provided in placing the Order is included
Total discount amount excluding taxes. This amount equals to the sum of all discount amounts among all invoiced items. Note that this amount does not include the taxed amount.
The total discount amount including taxes
The Order’s currency
Contact who placed the Order
The contact identifier
The contact code
The contact name
Details about the organisation from where such event was posted
The organisation identifier
The organisation name
The address line 1
The address line 2
The address state/province/county
The address town/city
The address postal code
The address country (based on ISO 3 char code)
The latitude of the address
The longitude of the address
The Google textual identifier that uniquely identifies an address
Details about the event classification
The category identifier
The category name
Details about the reason that cancelled the order
The cancellation reason identifier
The cvancellation reason
Details about the organisation from where such event was posted
The organisation identifier
The organisation name
Submitted date
Completion date
Cancellation date
When the order is estimated to be fulfilled
How much time to fufill
Unit of time to fulfilled time
The actual date on which the order will be fulfilled
Date when the Order’s processing started
Date on which the cotact requested for the order to be actually delivered
Defines whether the orders are configured to be printed
Defines whether the order has been printed successfully
The custom field’s unique key
The custom field’s value
Details about order provision
Defines whether the order is configured to be provisioned
Defines whether the order has been provisioned successfully (applicable only if the order is available for provision)
Defines the integration on which the order has been provisioned (applicable only if the order is available for provision)
Details about the application
The approval request state
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/orders HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "997f1287-3d83-827a-7199-e5df2c0e4e67",
"number": "O11101",
"external_reference": "23434232345",
"queue": {
"id": "997f1287-3d83-827a-7199-e5df2c0e4e67",
"name": "Installation process"
},
"stage": {
"id": "997f1287-3d83-827a-7199-e5df2c0e4e67",
"name": "In progress",
"colour": ""
},
"state": "NEW",
"supply_method": "DELIVERY",
"notes": "Lorem Ipsum",
"milestones": 1,
"number_of_items": 1,
"ponr_reached": true,
"total": 9.99,
"sub_total": 11.99,
"wallet_funds": 1.59,
"amount_due": 8.4,
"discount": {
"amount": 1.99,
"amount_incl_tax": 2.99
},
"currency_code": "EUR",
"contact": {
"id": "997f1287-3d83-827a-7199-e5df2c0e4e67",
"code": "C0001",
"name": "John Doe"
},
"organisation": {
"id": "4248fab3-67d5-2eb1-eaf6-079ce18cd2ed",
"name": "Bravo Coffee"
},
"address": {
"address_line_1": "Elia Papakyriakou",
"address_line_2": "7 Tower Stars",
"state_province_county": "Egkomi",
"town_city": "Nicosia",
"postal_code": "2015",
"country": "CYP",
"lat": 35.157115,
"lon": 33.313719,
"google_place_id": "ChIJrTLr-GyuEmsRBfy61i59si0"
},
"category": {
"id": "c8d83493-3f50-40df-adb0-762ec5f41863",
"name": "Delivery Purchase"
},
"cancellation_reason": {
"id": "997f1287-3d83-827a-7199-e5df2c0e4e67",
"name": "Void by customer"
},
"fulfilled_by": {
"id": "4248fab3-67d5-2eb1-eaf6-079ce18cd2ed",
"name": "Bravo Coffee"
},
"key_dates": {
"submitted_on": 1592809457,
"completed_on": 1592809457,
"cancelled_on": 1592809457,
"estimated_fulfillment": {
"duration": "30",
"uot": "MINUTES",
"date": "1649337036"
},
"started_on": 1649337036,
"requested_date": 1649337036
},
"available_for_printing": "true",
"is_printed": "true",
"custom_fields": [
{
"key": "back_office",
"value": "0001-12345"
}
],
"order_provision": {
"available_for_provision": "true",
"is_provisioned": "false",
"provisioner": "TWINSOFT"
},
"approvals": {
"state": "PENDING"
}
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Retrieves detailed information of an Order. A single Order is retrieved per Web API call
Path variables
The order (identifier) that will be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
Unique identifier of the Order
Order number
Order external reference as this was set by 3rd party systems
The order life cycle state
Order notes
Number of milestones planed for the Order
Number of ordered items
The type of the event
Delivered to the customer’s address
Picked up by the customer from a venue
Online sales of services
The total cost of the order, i.e. how much the contact needs to pay
The order’s total cost before applying any discounts.
Wallet funds used to pay off the order
Amount due to be paid in order to fully pay off the order.
Total discount applied to the order via Promotions and ad-hoc discount
Discount excuding taxed amount
Discount including tax
Ad hoc discount applied
Discount type
Discount amount
The type of the event
No wallet funds used
No wallet funds used
No wallet funds used
Partially paid using wallet funds and another payment method
Partially paid using wallet funds and another payment method
Fully paid using wallet funds
{
"type": "CASH",
"identity": {
"id": "",
"identifier": "Visa *****1234 03/25"
}
}The type of the event
The type of the event
The unique identifier of the contact’s payment method
A short description of the payment method. Depending on the payment method’s type different information is returned:
- Card: the brand, followed by the last 4 digits of the card plus expiration month/year
- Account debit: Name: Bank code followed by the first 5 and the last 9 digits of the account number/IBAN
- Wallet: Name: Email and/or phone used on registration
ORder is the cotnact’s favourite or not
Contact that placed the Order. An order is placed for either a cotnact or an organisation
Contact unique identifier
Contact code
Contact full name
Email address
Contact phone
Country of contact
Details about the organisation from where such event was posted
The organisation identifier
The organisation name
Order queue
Queue unique identifier
Queue name
List of Order queue stages through which the order has already been through
Stage unique identifier
Stage name
Date on which order updated into the stage
Stage colour
Defines if the stage is considered as the Point of no return (if any was set in the Queue)
Comment specified when the order progressed into this stage
The address line 1
The address line 2
The address state/province/county
The address town/city
The address postal code
The address country (based on ISO 3 char code)
The latitude of the address
The longitude of the address
The Google textual identifier that uniquely identifies an address
Details about the event classification
The category identifier
The category name
Details about the reason that cancelled the order
The cancellation reason identifier
The cvancellation reason
The Organisation that fulfills the order
Unique identifier of the organisation
Organisation name
Organisation phone number
Information about the organisation’s location
The location identifier
The name of the location
The address of the location
Additional address information about the location
The state/province/county of the location
The town/city of the location
The postal code of the location
The country code of the location
The care of information of the location
The latitude of the location
The longitude of the location
The Google textual identifier that uniquely identifies a location
Submitted date
Completion date
Cancellation date
When the order is estimated to be fulfilled
How much time to fufill
Unit of time to fulfilled time
The actual date on which the order will be fulfilled
Date when the Order’s processing started
Date on which the cotact requested for the order to be actually delivered
Order can be printed
Printed or not
Details about order provision
Defines whether the order is configured to be provisioned
Defines whether the order has been provisioned successfully (applicable only if the order is available for provision)
Defines the integration on which the order has been provisioned (applicable only if the order is available for provision)
List of ordered items. At least one is included
Order item unique identifier
Order item notes
How many items were ordered
How many items have been dispatched. Applicable ofor stockable products
How many items have been invoiced so far.Number of invoiced items cannot exceed the number of dispatched items.
The product’s price
Order item’s taxed amount
Applied discounton the ordered item
Applied discount excluding taxed amount
Applied discount including taxed amount
Applied discount percentage
Order item’s total before applying discount
Order item’s total amount
Product that was ordered
Product unique identifier
Product SKU
Product name
The unique identifier of the component’s entity (e.g. the product or product type identifier) as this is specified in “item_type”
Defines whether the component is mandatory or not. When mandatory, then the contact always gets the component by default on ordering it and there’s no option to remove it.
Priority shows the ordering of the components in UI/apps/portals for usability purposes
Applicable for components that include more than one products like product types. It shows the minimum required number of items that must to be selected to be included in the product being ordered. Minimum quantity cannot be greater than the maximum allowed quantity
Applicable for components that include more than one products like product types. It shows the maximum allowed number of items that must to be selected to be included in the product being ordered. Maximum quantity cannot be less than the minimum quantity
When set to “true”, it shows that the item’s price is included within the bundle’s price. Therefore, cotnacts will not have to pay anything if included in the order and despite the fact that the item itself has its own price.
The product identifier of the product that is set as default modifier. Only products marked as modifiers can be set. Applicable only for item types that denote a group of products (like the product type or component set) and as long as within that group, there’s one or more products marked as “modifiers”. The default modifier must be one of these products. Use this setting to easily present to contacts a default option during th eordering flow.
Determines if the product is stockable or not
List of produc tags
Tag unique identifier
Tag name
Tag colour
List of components/modifiers of the ordered product. Applicable for bundle and composite products. In these cases, at least one component was included on ordering the product
Product unique identifier
Product SKU
Product name
Ordered quantity
Product’s price
Ordered item’s net amount
Taxed amount
Applied discount
Order item’s total amount
List of product tags
Tag unique identifier
Tag name
Tag colour
The creative identifier
Information about the creative type
Partner logos configurable by SO, applicable for Business, Merchant, Venue
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
The creative width
The creative height
The creative format
The creative content URL
The creative public identifier
Information about the creative transformations
The transformed creative width
The transformed creative height
The transformed creative URL
The Order’s milestones
Order Milestone identifier
The order milestone’s actual amount to be invoiced. Each order milestone either has a percentage or a specific amount to be invoiced
The order milestone percentage. Each order milestone either has a percentage or a specific amount to be invoiced
Date on which the milestone was achieved which is also the date on which the Orde rmodes to the milestone’s stage
On reaching this stage, the milestone invoice was/will be issued automatically
Stage identifier
Stage name
Milestone Invoice issued on reaching the specified stage
Invoice identifier
Invoice number
The custom field (unique) key
The custom field’s (provided) value
GET https://sandbox.crm.com/backoffice/v2/orders/997f1287-3d83-827a-7199-e5df2c0e4e67 HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "1866a75f-953e-4109-86b4-1cab53fbaaa8",
"number": "ORDER1234",
"external_reference": "REF1234",
"state": "NEW",
"notes": "Lorem Ipsum",
"number_of_milestones": 1,
"number_of_items": 6,
"supply_method": "DELIVERY",
"total": 5.99,
"sub_total": 11.99,
"wallet_funds": 1.98,
"amount_due": 3.01,
"discount": {
"amount": 0.96,
"amount_incl_tax": 0.98
},
"ad_hoc_discount": {
"type": "AMOUNT",
"amount": 9.99
},
"currency_code": "EUR",
"payment_info": "NOT PAID - TO BE PAID IN CASH",
"payment_method": {
"type": "ACCOUNT_DEBIT",
"identity": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"identifier": "Visa *****1234 03/25"
}
},
"is_favorite": true,
"contact": {
"id": "1866a75f-953e-4109-86b4-1cab53fbaaa8",
"code": "1234",
"name": "John Doe",
"email_address": "sue@mymail.com",
"phone_number": "0035799454543",
"country_code": "CYP"
},
"organisation": {
"id": "4248fab3-67d5-2eb1-eaf6-079ce18cd2ed",
"name": "Bravo Coffee"
},
"queue": {
"id": "4248fab3-67d5-2eb1-eaf6-079ce18cd2ed",
"name": "Ordering flow"
},
"stages": [
{
"id": "4248fab3-67d5-2eb1-eaf6-079ce18cd2ed",
"name": "New",
"date_achieved": 1649337035,
"colour": "",
"point_of_no_return": true,
"comment": "Contact delivery confirmation"
}
],
"address": {
"address_line_1": "Elia Papakyriakou",
"address_line_2": "7 Tower Stars",
"state_province_county": "Egkomi",
"town_city": "Nicosia",
"postal_code": "2015",
"country": "CYP",
"lat": 35.157115,
"lon": 33.313719,
"google_place_id": "ChIJrTLr-GyuEmsRBfy61i59si0"
},
"category": {
"id": "c8d83493-3f50-40df-adb0-762ec5f41863",
"name": "Delivery Purchase"
},
"cancellation_reason": {
"id": "997f1287-3d83-827a-7199-e5df2c0e4e67",
"name": "Void by customer"
},
"fulfilled_by": {
"id": "1866a75f-953e-4109-86b4-1cab53fbaaa8",
"name": "Good Burgers",
"phone": "0035799454532",
"address": {
"id": "LOC123456234567345674567895678IK",
"name": "Head Office",
"address_line_1": "Elia Papakyriakou 21",
"address_line_2": "7 Tower Stars",
"state_province_county": "Egkomi",
"town_city": "Nicosia",
"postal_code": "2415",
"country_code": "CY",
"care_of": "c/o Company",
"lat": 35.157115,
"lon": 33.313719,
"google_place_id": "ChIJrTLr-GyuEmsRBfy61i59si0"
}
},
"key_dates": {
"submitted_on": 1592809457,
"completed_on": 1592809457,
"cancelled_on": 1592809457,
"estimated_fulfillment": {
"duration": "30",
"uot": "MINUTES",
"date": "1649337036"
},
"started_on": 1649337036,
"requested_date": 1649337036
},
"available_for_printing": true,
"is_printed": true,
"order_provision": {
"available_for_provision": "true",
"is_provisioned": "false",
"provisioner": "ALOHA"
},
"items": [
{
"id": "1866a75f-953e-4109-86b4-1cab53fbaaa8",
"notes": "Lorem Ipsum",
"quantity": 1,
"price": 1.7,
"tax": 0.45,
"discount": {
"amount": 0.99,
"amount_incl_tax": 0.89,
"percentage": 1.5
},
"sub_total": 1.99,
"total": 3.4,
"product": {
"id": "1866a75f-953e-4109-86b4-1cab53fbaaa8",
"sku": "SKU1234",
"name": "Iced Latte",
"classification": "TRACEABLE_PHYSICAL_GOOD",
"composition": {
"item_type": "PRODUCT",
"item_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"mandatory": true,
"priority": 1,
"minimum_quantity": 1,
"maximum_quantity": 3,
"price_inclusive": true,
"modifier_product_id": "56786309-7a21-8097-e107-6e9aec401840"
},
"is_stockable": true,
"tags": [
{
"id": "80362b63-a576-3540-586b-0dc1f3ab3bfd",
"name": "Coffees",
"colour": ""
}
],
"components": [
{
"id": "1866a75f-953e-4109-86b4-1cab53fbaaa8",
"sku": "B1234",
"name": "Brown Sugar",
"quantity": 1,
"price": 0.5,
"net": 1.55,
"tax": 0.15,
"discount": 0.25,
"total": 1.45,
"tags": [
{
"id": "9c134cf3-c274-ee73-4921-01fb34033d4c",
"name": "Condiment",
"colour": ""
}
]
}
],
"creatives": [
{
"id": "3caf8388-b9c6-6679-1e9b-94a6fda92a41",
"usage_type": "LANDING_PAGE_IMAGE",
"width": 2159,
"height": 3075,
"format": "jpg",
"url": "https://assets.crm.com/image/logo.jpg",
"public_id": "crm-com/image",
"media": [
{
"width": 200,
"height": 300,
"url": "https://asset.crm.com/image/offer/c_scale,w_200/logo.jpg"
}
]
}
]
}
}
],
"milestoness": [
{
"id": "1866a75f-953e-4109-86b4-1cab53fbaaa8",
"amount": 9.99,
"percentage": 5.5,
"date_achieved": 1649337036,
"stage": {
"id": "1866a75f-953e-4109-86b4-1cab53fbaaa8",
"name": "Approved"
},
"invoice": {
"id": "1866a75f-953e-4109-86b4-1cab53fbaaa8",
"number": "INV000001"
}
}
],
"custom_fields": [
{
"key": "back_office",
"value": "Back Office"
}
]
}{id}/actionsUpdates a single order based on the preferred action.
Path variables
The order identifier on which actions are performed
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The action that will be applied on the order
Takes a New Order into the first In progress stage
Complete an Order
Cancel an Order
Print an order for preparation of order at a venue.
Provision an order to a POS
The reason why an order is cancelled (applicable if action = CANCEL)
Defines whether the order is a contact’s favourite one
Defines the integration on which the order has been provisioned (applicable only if the order is available for provision)
Examples
Responses
Body
The order (identifier) that was updated
Determines whether approval reuqests are applied or not, if not null an approval is requested
The apporval request identifier
PUT https://sandbox.crm.com/backoffice/v2/orders/997f1287-3d83-827a-7199-e5df2c0e4e67/actions HTTP/1.1
Content-Type: application/json
{
"action": "START_PROGRESS",
"cancellation_reason_id": "caf332bc-4e90-47b5-a05d-142b264897b9",
"is_favorite": true,
"provisioner": "ALOHA"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "997f1287-3d83-827a-7199-e5df2c0e4e67",
"approval_requests": [
{
"id": "3a4aad81-e5c2-72b7-3a86-903239d08767"
}
]
}{id}/attachments{id}/attachments/{file_id}{id}/files{id}/attachmentsConnect an uploaded attachment to an existing order
Path variables
The order (identifier) that attachment will be attached
Notes
Integrating attachments upload for Orders should be based on the following APIs
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The uploaded file signature (identifier) to be attached (file or link should be provided)
The URL endpoint to be attached (file or link should be provided)
The file description
Responses
The request has succeeded
Body
The attachment identifier
POST https://sandbox.crm.com/backoffice/v2/orders/66451204-4404-894c-4dc6-486c540ece40/files HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"file_id": "30526723-24a3-e4e3-1a75-b26b1b41f05c",
"url": "https://crmcom.sharepoint.com/:x:/s/servicerequests/EZx2qopbvfN3uj1o3dOqbPm52Ct6bg?rtime=w0ic-hfG2Ug",
"description": "Screenshot sent by customer"
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "66451204-4404-894c-4dc6-486c540ece40"
}{id}/attachments/{file_id}Delete a specific order attachment
Path variables
The order (identifier) that file will be deleted
The attachment file (identifier) that will be deleted
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
DELETE https://sandbox.crm.com/backoffice/v2/orders/66451204-4404-894c-4dc6-486c540ece40/files/04c0bebd-8bb0-0b3e-e1a6-716a0fd200b1 HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 204 No Content {id}/filesRetrieve all attachments for a specific order
Path variables
The order (identifier) that files will be retrieved
Request parameters
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The attachement identifier
The attachement description
The attached file
The attached file identifier
The attached file URL endpoint
The attached file name
The mime type of the uploaded file
The attached URL endpoint
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/orders/66451204-4404-894c-4dc6-486c540ece40/files HTTP/1.1
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "3ae9d64a-8a3b-f1e1-eed6-05b307f926fb",
"mime": "png",
"description": "this is a brief description of this image",
"file": {
"id": "0317868f-28f8-9f56-d248-5a78718b38cc",
"name": "img.png"
}
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}A pass plan defines the behaviour and characteristics of the passes to be generated. Pass plans can be created to generate Gift, Top-up or Promotion type passes in printed or electronic format.
{id}{id}{id}{id}/exportCreate a pass plan of type Gift, Top-up or Promotion, along with the particulars which will be inherited by each pass generated for the pass plan. Any pass plan’s amounts are always set in the business’s base currency (all pass plans regardless of their classification, behaviours etc.). A pass plan is created with an ‘inactive’ state and must be activated using another API call.
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The life cycle state of the pass plan
Pass plan in use, passes can be generated
Pass plan not in use
The name of the pass plan. The name must be uniue across all pass plans.
A description of the pass plan
The classification of the pass type
Can be sent as a gift to either a registered or non-registered contact
Used to top-up the wallet of a registered contact
Must be related to a reward offer or a promotion
The validity type
Passes can be redeemed within the set period of time (e.g. within 3 months of being created)
Passes will expire on a specific date (e.g. 31/12/2022)
Passes will never expire (i.e. no validity period)
The validity period value, applicable only if validity type is PERIOD (e.g. expires in X days/months/years). Used in conjunction with ‘uot’ to set the validity period.
The period unit of time, applicable only if validity type is PERIOD. Used in conjunction with ‘period’ to set the validity period.
(e.g. expires within 90 DAYS)
(e.g. expires within 6 MONTHS)
(e.g. expires within 2 YEARS)
The fixed date by which passes can be redeemed, applicable only if validity type is DATE
The id of the promotion that the pass will consume, either promotion_id OR reward_offer_id must be specified
The id of the reward offer that the pass will consume, either promotion_id OR reward_offer_id must be specified
The type of pass codes to be generated by the pass plan
Unique pass codes will be generated for each pass
A single (same) code will be used for all passes
The maximum number of times that the pass can be used, 1 = single use pass, >1 = multiple uses
Will passes be printed? printed = true, electronic = false, applicable only for pass plans with a classification of GIFT or TOP_UP (PROMOTION passes are only available in electronic format)
Will passes have a fixed or variable value? FIXED indicates that the pass value is predefined, VARIABLE allows the value of the pass to be set during creation (within a range of values)
(e.g. 70)
(e.g. 50-250)
The fixed value of the pass (in the base currency of the system), applicable only if value type is FIXED.
The minimum allowed value of the pass, applicable only if value type is VARIABLE. Used in conjunction with ‘maximum’
The maximum allowed value of the pass, applicable only if value type is VARIABLE. Used in conjunction with ‘minimum’
For printed passes - this is the number of passes to create, for electronic passes - this is the maximum number of passes to be created (0 = unlimited)
The pass code type to be used
Pass codes created will be in alphanumeric format (e.g JB73B0L3916)
Pass codes created will be in alphabetic format (e.g. AJKLMEQPCA)
Pass codes created will be in numeric format (7956093213)
Optional prefix for the pass code (appears at the beginning of the pass code)
Optional suffix for the pass code (appears at the end of the pass code)
The length of the code (min.7, max.16), not inlcuding prefix and suffix
Defines whether the passes will be associated with a pin (not for PROMOTION type pass plans)
The single pass code to be used for all passes. Applicable only for PROMOTION type pass plans with pass_code_type = SINGLE
Which wallet balance will be credited when the pass is redeemed? For TOP_UP and GIFT passes only
Open wallet balance - can be spent without restrictions
Commerce wallet balance - spend conditions may apply
GUID of spend group if credit_wallet_balance is COMMERCE. For TOP-UP & GIFT passes only
The custom field’s unique key
The custom field’s value
Responses
Successful Request
Body
The unique identifier of the newly created pass plan
POST https://sandbox.crm.com/backoffice/v2/pass_plans HTTP/1.1
Content-Type: application/json
{
"state": "INACTIVE",
"name": "Gift voucher €50-€200",
"description": "Printed gift vouchers of variable value €50-€200",
"classification": "TOP_UP",
"validity": {
"type": "ALWAYS",
"period": 1,
"uot": "MONTHS",
"fixed_date": 1591703675
},
"promotion_passes": {
"promotion_id": "e2ade504-9b90-92be-0adb-3258475ff695",
"reward_offer_id": "64b8c34d-e7d8-44ff-8bf0-908a8689cbdf",
"pass_code_type": "MULTIPLE",
"maximum_usage": 5
},
"printed": "true",
"value": {
"type": "FIXED",
"fixed_amount": 70,
"minimum": 50,
"maximum": 250
},
"number_of_passes": 100,
"code_format": {
"type": "ALPHANUMERIC",
"prefix": "CRM",
"suffix": "COM",
"length": 10,
"pin_required": "true",
"single_code": "123456"
},
"credit_wallet_balance": "COMMERCE",
"commerce_pool_id": "64b8c34d-e7d8-44ff-8bf0-908a8689cbdf",
"custom_fields": [
{
"key": "back_office",
"value": "0001-12345"
}
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "954ce862-469e-4a6d-9b21-edbf51226c89"
}{id}Update specific details of a pass plan.
A pass plan can only be updated if it’s in ‘inactive’ state and no passes have been created yet
Path variables
The id of the pass plan to be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The state of the pass plan
Pass plan can be used and passes can be generated
Pass plan not in use yet
The name of the pass plan. The name must be uniue across all pass plans.
A description of the pass plan
The validity type
Passes can be redeemed within the set period of time (e.g. within 3 months of being created)
Passes will expire on a specific date (e.g. 31/12/2022)
Passes will never expire (i.e. no validity period)
The validity period value, applicable only if validity type is PERIOD (e.g. expires in X days/months/years). Used in conjunction with ‘uot’ to set the validity period.
The period unit of time, applicable only if validity type is PERIOD. Used in conjunction with ‘period’ to set the validity period.
(e.g. expires within 90 DAYS)
(e.g. expires within 6 MONTHS)
(e.g. expires within 2 YEARS)
The fixed date by which passes can be redeemed, applicable only if validity type is DATE
The id of the promotion that the pass will consume, either promotion_id OR reward_offer_id must be specified
The id of the reward offer that the pass will consume, either promotion_id OR reward_offer_id must be specified
The type of pass codes to be generated by the pass plan
Unique pass codes will be generated for each pass
A single (same) code will be used for all passes
The maximum number of times that the pass can be used, 1 = single use pass, >1 = multiple uses
Will passes be printed? printed = true, electronic = false. Applicable only for pass plans with a classification of GIFT or TOP_UP (PROMOTION passes are only available in electronic format)
For printed passes - this is the number of passes to create, for electronic passes - this is the maximum number of passes to be created. If not specified, then an unlimited number of passes will be created.
The pass code type to be used
Pass codes created will be in alphanumeric format (e.g JB73B0L3916)
Pass codes created will be in alphabetic format (e.g. AJKLMEQPCA)
Pass codes created will be in numeric format (7956093213)
Optional prefix for the pass code (appears at the beginning of the pass code)
Optional suffix for the pass code (appears at the end of the pass code)
The length of the code (min.7, max.16), not inlcuding prefix and suffix
Defines whether the passes will be associated with a pin (not for PROMOTION type pass plans)
The single pass code to be used for all passes. Applicable only for PROMOTION type pass plans with pass_code_type = SINGLE
Which wallet balance will be credited when the pass is redeemed? For TOP_UP and GIFT passes only
Open wallet balance - can be spent without restrictions
Commerce wallet balance - spend conditions may apply
GUID of spend group if credit_wallet_balance is COMMERCE. For TOP-UP & GIFT passes only
The custom field’s unique key
The custom field’s value
Responses
Successful Request
Body
The unique identifier of the pass plan updated
PUT https://sandbox.crm.com/backoffice/v2/pass_plans/954ce862-469e-4a6d-9b21-edbf51226c89 HTTP/1.1
Content-Type: application/json
{
"state": "ACTIVE",
"name": "Xmas Gift Cards",
"description": "Gift Cards for Christmas",
"validity": {
"type": "ALWAYS",
"period": 1,
"uot": "MONTHS",
"fixed_date": 1591703675
},
"promotion_passes": {
"promotion_id": "e2ade504-9b90-92be-0adb-3258475ff695",
"reward_offer_id": "64b8c34d-e7d8-44ff-8bf0-908a8689cbdf",
"pass_code_type": "MULTIPLE",
"maximum_usage": 5
},
"printed": "true",
"number_of_passes": 1,
"code_format": {
"type": "ALPHANUMERIC",
"prefix": "CRM",
"suffix": "COM",
"length": 10,
"pin_required": "true",
"single_code": "123456"
},
"credit_wallet_balance": "COMMERCE",
"commerce_pool_id": "64b8c34d-e7d8-44ff-8bf0-908a8689cbdf",
"custom_fields": [
{
"key": "back_office",
"value": "0001-12345"
}
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "954ce862-469e-4a6d-9b21-edbf51226c89"
}{id}Delete an existing pass plan.
A pass plan can only be deleted if no passes have been created yet
Path variables
The id of the pass plan to delete
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
DELETE https://sandbox.crm.com/backoffice/v2/pass_plans/64b8c34d-e7d8-44ff-8bf0-908a8689cbdf HTTP/1.1
HTTP/1.1 204 No Content Retrieve all pass plans with selected details. Deleted pass plans are excluded.
Request parameters
Defines on which attribute the results should be sorted
Defines how the results will be ordered
Search for pass plans using the pass plan name
Search for pass plans using the classification
Can be sent as a gift to either a registered or non-registered contact
Used to top-up the wallet of a registered contact
Must be related to a reward offer or a promotion
Search for pass plans using a state
Pass plan in use, passes can be generated
Pass plan not in use
Search pass plans using the distribution method (for PROMOTION passes only)
Unique pass codes are generated for each pass
A single (same) code is used for all passes
Search for pass plans based on whether passes are printed or not (true=PRINTED, false=ELECTRONIC)
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Successful Request
Body
Search results
The id of the pass plan
The life cycle state of the pass plan
Pass plan in use, passes can be generated
Pass plan not in use
The name of the pass plan
The description of the pass plan
The classification of the pass type
Can be sent as a gift to either a registered or non-registered contact
Used to top-up the wallet of a registered contact
Must be related to a reward offer or a promotion
Are the passes for the pass plan are printed? (true = PRINTED, false = ELECTRONIC)
Number of passes created to date for the pass plan
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/pass_plans HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "64b8c34d-e7d8-44ff-8bf0-908a8689cbdf",
"state": "ACTIVE",
"name": "Xmas Gift Cards",
"description": "Gift Cards for Christmas",
"classification": "PROMOTION",
"printed": "false",
"created_passes": 100
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Retrieves all details for a single pass plan
Path variables
The id of the pass plan whose details will be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Successful Request
Body
Pass plan id
The life cycle state of the pass plan
Pass plan in use, passes can be generated
Pass plan not in use
The name of the pass type
The description of the pass type
The classification of the pass type
Can be sent as a gift to either a registered or non-registered contact
Used to top-up the wallet of a registered contact
Must be related to a reward offer or a promotion
The validity type
Passes can be redeemed within the set period of time (e.g. within 3 months of being created)
Passes will expire on a specific date (e.g. 31/12/2022)
Passes will never expire (i.e. no validity period)
The validity period value, applicable only if validity type is PERIOD (e.g. expires in X days/months/years). Used in conjunction with ‘uot’ to set the validity period.
The period unit of time, applicable only if validity type is PERIOD. Used in conjunction with ‘period’ to set the validity period.
(e.g. expires within 90 DAYS)
(e.g. expires within 6 MONTHS)
(e.g. expires within 2 YEARS)
The fixed date by which passes can be redeemed, applicable only if validity type is DATE
The id of the promotion that the pass will consume, either promotion_id OR reward_offer_id must be specified
The id of the reward offer that the pass will consume, either promotion_id OR reward_offer_id must be specified
Promotion name or reward offer name (depending on promotion_id or reward_offer_id received)
The type of pass codes to be generated by the pass plan
Unique pass codes will be generated for each pass
A single (same) code will be used for all passes
The maximum number of times that the pass can be used, 1 = single use pass, >1 = multiple uses
Defines whether the passes will be printed (true = printed, false = electronic)
Will passes have a fixed or variable value? FIXED indicates that the pass value is predefined, VARIABLE allows the value of the pass to be set during creation (within a range of values)
(e.g. 70)
(e.g. 50-250)
The fixed pass value amount (in the base currency of the system), applicable only if value type is FIXED
The minimum allowed value of the pass, applicable only if value type is VARIABLE. Used in conjunction with ‘maximum’
The maximum allowed value of the pass, applicable only if value type is VARIABLE. Used in conjunction with ‘minimum’
The base currency code of the system
For printed passes - this is the number of passes to create, for electronic passes - this is the maximum number of passes to be created
The pass code type used
Pass codes are in alphanumeric format (e.g JB73B0L3916)
Pass codes are in alphabetic format (e.g. AJKLMEQPCA)
Pass codes are in numeric format (7956093213)
Optional pass code prefix (appears at the beginning of the pass code)
Optional pass code suffix (appears at the end of the pass code)
Pass code length (min.7, max.16), not inlcuding prefix and suffix
Are passes associated with a pin? (not for PROMOTION type pass plans)
The single pass code to be used for all passes. Applicable only for PROMOTION type pass plans with pass_code_type = SINGLE
The wallet balance to be credited when the pass is redeemed. For TOP_UP and GIFT passes only
Open wallet balance - can be spent without restrictions
Commerce wallet balance - spend conditions may apply
Details about spend condition
The commerce pool identifier
The commerce pool name
The commerce pool description
The custom field’s unique key
The custom field’s value
GET https://sandbox.crm.com/backoffice/v2/pass_plans/af7e3a1b-40ca-46e2-8de5-d461ccb85e58 HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "af7e3a1b-40ca-46e2-8de5-d461ccb85e58",
"state": "ACTIVE",
"name": "Xmas Gift Cards",
"description": "Gift Cards for Christmas",
"classification": "GIFT",
"validity": {
"type": "ALWAYS",
"period": 1,
"uot": "YEARS",
"fixed_date": 1591703675
},
"promotion_passes": {
"promotion_id": "e2ade504-9b90-92be-0adb-3258475ff695",
"reward_offer_id": "64b8c34d-e7d8-44ff-8bf0-908a8689cbdf",
"name": "50% Birthday Offer",
"pass_code_type": "SINGLE",
"maximum_usage": 1
},
"printed": "true",
"value": {
"type": "FIXED",
"fixed_amount": 70,
"minimum": 50,
"maximum": 250,
"currency_code": "EUR"
},
"number_of_passes": 1,
"code_format": {
"type": "ALPHABETIC",
"prefix": "CRM",
"suffix": "COM",
"length": 10,
"pin_required": "true",
"single_code": "123456"
},
"credit_wallet_balance": "COMMERCE",
"commerce_pool": {
"id": "dc01f65b-a482-48f1-9fda-c163df72f28f",
"name": "Redeem Anywhere",
"description": "Ability to redeem on any organisation/day/product"
},
"custom_fields": [
{
"key": "back_office",
"value": "0001-12345"
}
]
}{id}/exportExport the passes of a pass plan to a .csv file and send it to the logged in user’s email
Path variables
The id of the pass plan whose passes will be exported
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
POST https://sandbox.crm.com/backoffice/v2/pass_plans/64b8c34d-e7d8-44ff-8bf0-908a8689cbdf/export HTTP/1.1
HTTP/1.1 204 No Content {id}{id}{id}/actionsRequest to create one or more passes:
- For printed passes - create all the passes for a pass plan
- For electronic pass - create a single pass for a contact and always on demand only via an integration system request, i.e. when an electronic pass is given out or sold to a contact.
Pass attributes are inherited from the pass plan
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The id of the pass plan for which a pass will be created
The value of the pass (in the base currency of the system), applicable for pass plans configured for ‘variable’ value passes
The recipient information. For Top-up passes this is the registered contact who will also be redeeming the pass. For Gift passes this is the registered/unregistered contact who will be redeeming the pass. For Promotion passes this is the contact who consumed the reward offer/promotion
The recipient name
The communication medium to be used to send the pass information to the recipient. Note: For electronic Gift passes - if the registered_contact information has been provided, then medium_type is not mandatory
The value of the communication medium to be used to send the pass information Note: For electronic Gift passes - if the registered_contact information has been provided then medium_value is not mandatory
Details requried if the pass is being created for a registered contact.
Contact id of the existing Contact
Wallet id of the existing contact
Gift sender information (for electronic Gift passes only).
Gift sender name
A short message from the gift sender to accompany the gift pass
The custom field’s unique key
The custom field’s value
Responses
Successful Request
Body
The response will only return pass details if a single electronic pass has been generated, if multiple printed passes have been generated then nothing is returned.
The id of the newly generated pass (if a single electronic pass was generated)
The pass code (if a single electronic pass was generated)
4-digit pass PIN (if applicable, and if a single electronic pass was generated)
POST https://sandbox.crm.com/backoffice/v2/passes HTTP/1.1
Content-Type: application/json
{
"pass_plan_id": "Mobile data top-up €50",
"pass_value": 50,
"recipient": {
"name": "John Smith",
"medium_type": "EMAIL",
"medium_value": "j.smith@crm.com",
"country_code": "CYP",
"registered_contact": {
"contact_id": "acaae121-b4af-4663-8646-47bb541c971d",
"wallet_id": "4613eb36-e5e8-46e8-9517-b1a31e86c89c"
}
},
"gift_sender": {
"name": "Kelly Smith",
"message": "Happy birthday John, have a great day. Hope to see you soon. Kelly"
},
"custom_fields": [
{
"key": "back_office",
"value": "0001-12345"
}
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "aaf1ca4d-2480-453c-9de0-84acbcf320fd",
"pass_code": "AX61YUSWVO",
"pin": "1234"
}{id}Update the pass state, the expiration date, the initial value, the pin or custom fields of a single pass only.
Path variables
The id of pass to be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The new state of the pass
Only a pass in ‘Draft’ state can be activated
Only a pass in 'Draft or ‘Active’ state can be cancelled
The new expiration date
The value that the pass should be loaded with (applicable only for printed passes of variable value, and whose initial value is ‘null’)
PIN has a dual purpose:
- If simply updating the PIN, then provide the new 4-digit PIN value
- If cancelling a redeemed Gift Pass (i.e. state = CANCELLED, and the pass type is Gift) then the pin must also be provided in order for cancellation to proceed.
The custom field’s unique key
The custom field’s value
Responses
Successful Request
Body
The id of the updated pass
PUT https://sandbox.crm.com/backoffice/v2/passes/a0f91720-0a8d-414c-a57c-82ea928be39e HTTP/1.1
Content-Type: application/json
{
"state": "CANCELLED",
"expiration_date": 1592919625,
"initial_load": 50,
"pin": "1908",
"custom_fields": [
{
"key": "back_office",
"value": "0001-12345"
}
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "a0f91720-0a8d-414c-a57c-82ea928be39e"
}Returns a list of passes based on request parameters
Request parameters
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Filter passes based on the expiration date
Returns results where the expiration date is greater than this value
Returns results where the expiration date is greater than or equal to this value
Returns results where the expiration date is less than this value
Returns results where the expiration date is less then or equal to this value
Filter passes using the id of the pass plan
Filer passes using the contact id
Retrieve the details of a specific pass code (either pass_code or pass_code_hash) can be used
Retrieve the details of a hashed pass code (either pass_code or pass_code_hash) can be used
If a pass_code has been specified then the relevant pass pin should be provided too (if applicable) in order to retrieve the information
Retrieve passes of a particular state
[
"REDEEMED"
]Filter based on whether passes are printed or not (printed = true, electronic = false)
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Successful Request
Body
Passes information retrieved
The pass id
The pass code
The pass value (currency is the base currency of the system)
Details about the pass plan
The pass plan identifier
The pass plan name
Date by which the pass must be redeemed, this is inherited from pass plan validity settings
The pass life cycle state
Pass is not ready for use, cannot be redeemed yet
Pass is ready for use and can be redeemed
Pass is cancelled, cannot be redeemed
Pass has been redeemed and can no longer be used
Id of the contact (if a registered contact)
The recipient’s name
The recipient’s contact code (if a registered contact)
The medium used to deliver the pass
The medium value for delivering the pass (i.e. email address or phone number)
Applicable for medium_type ‘SMS’
Promotion id
Promotion name
The reward offer that the promotion pass will consume.
The reward offer identifier
The reward offer name
Defines whether the pass is printed (true), or electronic (false)
Pass usage details, applicable for Promotion passes only
How many times a Promotion type pass can be used
The actual number of times that the pass has been used
The type of entity that the pass was redeemed against
The id of the entity that the pass was redeemed against
The code of the wallet or subscription, or the order number
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/passes HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "4139eabf-c3d7-4e88-a12e-b316f99099a3",
"code": "SIOQWHUFDW",
"value": 100,
"pass_plan": {
"id": "b2bbd932-4b1c-f3e0-54f7-dc15ef715d98",
"name": "Xmas Gift Card"
},
"expiration_date": "1652887300",
"state": "DRAFT",
"recipient": {
"id": "cadbf723-fdc6-4598-8156-f6288e61f356",
"name": "John Jonhson",
"code": "1078033453632307",
"medium_type": "EMAIL",
"medium_value": "john@mail.com",
"country_code": "CYP"
},
"promotion": {
"id": "7d66cc0a-c5d6-491e-b034-96c09bc3f4d8",
"name": "20% off new subscriptions for Kids Channel"
},
"reward_offer": {
"id": "c888dd7a-7476-538c-730a-9f924bd82d04",
"name": "Birthday Offer"
},
"printed": "true",
"usage": {
"allowed_usage": 2,
"used_times": 1
},
"redemption_entity": {
"type": "WALLET",
"id": "d23cae12-02fe-4658-9fcb-8f54dcc07798",
"code": "W097832"
}
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Retrieves the details for a single pass.
Path variables
The unique identifier of the pass to be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Successful Request
Body
The pass ID
The pass code
Pass value information
Pass amount
System base currency code which the pass was created in
Details about the pass plan
The pass plan identifier
The pass plan name
Id of the contact (if a registered contact)
The recipient’s name
The recipient’s contact code (if a registered contact)
The medium used to deliver the pass
The medium value for delivering the pass (i.e. email address or phone number)
Applicable for medium_type ‘SMS’
Promotion id
Promotion name
The reward offer that the promotion pass will consume.
The reward offer identifier
The reward offer name
Indicates a printed pass (true), or electronic pass (false)
The pass life cycle state
Pass is not ready for use, cannot be redeemed yet
Pass is ready for use and can be redeemed
Pass is cancelled, cannot be redeemed
Pass has been redeemed and can no longer be used
Pass creation date
Created by id
Date of update
Updated by id
Date by which the pass must be redeemed, this is inherited from pass plan validity settings
The type of entity that the pass was redeemed against
The id of the entity that the pass was redeemed against
The code of the wallet or subscription, or the order number
Applicable for Promotion type passes only
How many times the Promotion pass can be used
The actual number of times that the pass has been used
The pass pin
Details about spend conditions
The commerce pool identifier
The commerce pool name
The commerce pool description
The custom field’s unique key
The custom field’s value
GET https://sandbox.crm.com/backoffice/v2/passes/485ff648-38f0-4a0e-a99b-28cd293dfc7c HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "4139eabf-c3d7-4e88-a12e-b316f99099a3",
"code": "TTGNPQJUN",
"value": {
"amount": 250,
"currency_code": "EUR"
},
"pass_plan": {
"id": "b2bbd932-4b1c-f3e0-54f7-dc15ef715d98",
"name": "Xmas Gift Card"
},
"recipient": {
"id": "cadbf723-fdc6-4598-8156-f6288e61f356",
"name": "John Jonhson",
"code": "1078033453632307",
"medium_type": "EMAIL",
"medium_value": "john@mail.com",
"country_code": "CYP"
},
"promotion": {
"id": "7d66cc0a-c5d6-491e-b034-96c09bc3f4d8",
"name": "20% off new subscriptions for Kids Channel"
},
"reward_offer": {
"id": "c888dd7a-7476-538c-730a-9f924bd82d04",
"name": "Birthday Offer"
},
"printed": true,
"state": "ACTIVE",
"created_on": 1591796310,
"created_by": "4AD9C84FA60F9FE407140E20F707726A",
"updated_on": 1,
"updated_by": "4AD9C84FA60F9FE407140E20F707726A",
"expiration_date": 1652887300,
"redemption_entity": {
"type": "WALLET",
"id": "d23cae12-02fe-4658-9fcb-8f54dcc07798",
"code": "W097832"
},
"usage": {
"allowed_usage": 2,
"used_times": 1
},
"pin": "0558",
"commerce_pool": {
"id": "dc01f65b-a482-48f1-9fda-c163df72f28f",
"name": "Spend within a year",
"description": "Pass funds will expire 1 year after redemption"
},
"custom_fields": [
{
"key": "back_office",
"value": "0001-12345"
}
]
}Redeem a single pass for a contact. For Gift & Top-up passes the contact’s business wallet blalance (open or commerce) will be credited with the value of the pass in the respective currency.
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The pass code (either pass code or code_hash must be specified)
The hashed pass code (either code or code_hash must be specified)
The pass pin. Required only if the pass is assiociated with a pin
The value of the pass to be redeemed (in the base currency of the system), will only be considered if the initial pass value = null i.e. for variable value passes
Id of the registered contact redeeming the pass. If no contact_id is provided then a new contact will be created using the pass code as the contact name (i.e. un-named contact)
Id of contact’s wallet to be credited with the pass value (for Gift & Top-up passes)
Responses
Successful Request
Body
The id of the pass that has been successfully redeemed
POST https://sandbox.crm.com/backoffice/v1/passes HTTP/1.1
Content-Type: application/json
{
"code": "SLHY678993109PWE",
"code_hash": "11f45e8377aad7bd38910f1a01b4ebda53605eb8",
"otp": "2345",
"pin": "0587",
"value": 100,
"contact_id": "CEEE83D6E0804A30966F684B0269AD91",
"wallet_id": "CAD1E31269B76D7A65ACCE45B2E68DFD"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "4AD9C84FA60F9FE407140E20F707726A"
}{id}/actionsUpdate the state or the expiration date for all passes of a single pass plan
Path variables
The unique identifier of the pass plan whose passes will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The type of action to be applied
Activate all passes
Cancel all passes
Change the expiration date of all passes
The new expiration date (if action is EXPIRY_DATE)
Responses
PUT https://sandbox.crm.com/backoffice/v1/passes/103ddee2-cc09-e790-0f77-773ebb3b6c8c/actions HTTP/1.1
Content-Type: application/json
{
"action": "EXPIRY_DATE",
"expiration_date": 1592919625
}Payment Intents are created to handle the whole process of collecting the money using an online payment method and via a Payment Gateway. The payment intent present’s the intention of collecting a specific amount of money from the payment method, before removing that amount from the consumer’s bank account. The payment intent is created by a trusted server and never by a front-end for security purposes. The intent goes through several states
- Requires confirmation: Customer confirms that he/she is willing to pay using a specific payment method and for a specific amount
- Processing: Indicates that the payment gateway is in the process of collecting the money from the customer’s account and move it to the merchant’s account
- Succeeded: Money successfully moved to the merchant’s account
{id}/actions{id}Creates a new payment intent. Payment intents are created using a payment method (either of a contact or an Organisation) and the required amount. CRM.COM’s default behaviour is to put the requested amount On hold on the Payment Gateway’s side until the process that generated the intention is actually completed.
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The contact’s/organisation’s payment method that will be used for the payment. If a payment method is not specified, then the contact’s primary payment method will be selected.
The amount intended to be retrieved from the consumer’s payment method
Payment intent is created and confirmed in one go. Applicable when consumers have already opt in to automatic payments using their registered payment methods
Determines the money capturing method at the Payment Gateway side.
Money put On hold until the process that tirggered the intention is completed. Money is captured at a later stage
Payment intent generated because a CRM.COM events requires funds to be taken from an online payment method. This entity represents that event.
The entity’s uniqe identifier
Payment Intent’s billing period. Applicable only when recurring billing process submits intents to collect money. The period indirectly shows that the intent was created because of Billing Run
The date from which a subscription is billed
The date until which a subscription is billed
Responses
Body
The unique identifier of the payment intent
A unique key for the payment intent that should be used by front-end processes to process the payment intent since these processes should not have access to the payment intent as such. The client secret cannot modify the payment intent’s info.
The type of the event
POST https://sandbox.crm.com/backoffice/v2/payment_intents HTTP/1.1
Content-Type: application/json
{
"payment_method_id": "2ac0809f-ed91-4b68-b912-5bd6064d901e",
"amount": 9.99,
"currency_code": "EUR",
"confirm": "true",
"capture": "ON_HOLD",
"entity": {
"id": "2ac0809f-ed91-4b68-b912-5bd6064d901e",
"type": "INVOICES"
},
"period": {
"from": 1654698334,
"to": 1657290334
}
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "2ac0809f-ed91-4b68-b912-5bd6064d901e",
"token": "",
"state": "REQUIRES_CAPTURING",
"error_code": "",
"error_description": ""
}{id}/actionsUpdates an existing Payment intent. A Payment intent can only be updated while it’s in Pending or Requires Capturing states. Payment Intents can only be updated at server side using the intent’s identifier.
Path variables
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Change the intent’s state
Applicable only if the intent was not confirmed on its creation
Applicable only if the intent’s state is REQUIRES_CAPTURING
Cancel the pament intent in case where the process that triggered its generation is also cancelled
Payment Intent rejected by the payment gateway
Payment intent is completed when funds are removed from the contact’s payment method successfully.
The entity for which the Payment Intent was generated. The entity also implies the process that triggered the payment intention
The type of the event
The entity’s identifier
Period
Responses
Body
The unique identifier of the payment intent
A unique key for the payment intent that should be used by front-end processes to process the payment intent since these processes should not have access to the payment intent as such. The client secret cannot modify the payetn intent’s info.
The type of the event
PUT https://sandbox.crm.com/backoffice/v2/payment_intents/{id}/actions HTTP/1.1
Content-Type: application/json
{
"action": "CAPTURE",
"entity": {
"type": "ORDER",
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "",
"client_secret": "",
"state": "REQUIRES_CAPTURING",
"error_code": "",
"error_description": ""
}List all submitted payment intents
Request parameters
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
The entity type for which the intent was created
The entity for which the intent was created
Returns results where the created date is greater than this value
Returns results where the created date is greater than or equal to this value
Returns results where the created date is less than this value
Returns results where the created date is less then or equal to this value
The payment intent’s token
The Contact for which the payent intent was created
The Organisation for which the payent intent was created
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
Payment intent identifier
Payment Intent requested amount
The type of the event
The unique identifier of the contact’s payment method
A short description of the payment method. Depending on the payment method’s type different information is returned:
- Card: the brand, followed by the last 4 digits of the card plus expiration month/year
- Account debit: Name: Bank code followed by the first 5 and the last 9 digits of the account number/IBAN
- Wallet: Name: Email and/or phone used on registration
Creation date
The type of the event
The entity for which the intent was created
The entity’s unique identifier
The entity’s number or code
The type of the event
Payment Intent’s billing period. Applicable only when recurring billing process submits intents to collect money. The period indirectly shows that the intent was created because of Billing Run
The date from which a subscription is billed
The date until which a subscription is billed
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/payment_intents HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"amount": 9.99,
"currency_code": "EUR",
"payment_method": {
"id": "",
"identifier": "Visa *****1234 03/25"
},
"created_date": 1653336788,
"state": "REQUIRES_CAPTURING",
"entity": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"number": "O001101011",
"type": "ORDER"
},
"period": {
"from": 1654698334,
"to": 1657290334
}
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Retrieves detailed information for a payment intent
Path variables
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
Payment intent unique identifier
The requested amount to collect
The type of the event
The intent’s capturing method
The payment intent’s client secret that is used by front-end apps/portals to process it
When the payment intent was created
Appicable only on cancelling the payment intent
{
"type": "CASH",
"identity": {
"id": "",
"identifier": "Visa *****1234 03/25"
}
}The type of the event
The type of the event
The unique identifier of the contact’s payment method
A short description of the payment method. Depending on the payment method’s type different information is returned:
- Card: the brand, followed by the last 4 digits of the card plus expiration month/year
- Account debit: Name: Bank code followed by the first 5 and the last 9 digits of the account number/IBAN
- Wallet: Name: Email and/or phone used on registration
The entity for which the Payment Intent was created
The type of the event
The entity’s number or code
The entity’s unique identifier
Applicable only if funds failed to be collected (payment intent’s state is Rejected)
Payment Intent’s billing period. Applicable only when recurring billing process submits intents to collect money. The period indirectly shows that the intent was created because of Billing Run
The date from which a subscription is billed
The date until which a subscription is billed
GET https://sandbox.crm.com/backoffice/v2/payment_intents/{id} HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"amount": 9.99,
"currency_code": "EUR",
"state": "REQUIRES_CAPTURING",
"capture": "ON_HOLD",
"token": "6650493321000231",
"created_date": 1653337233,
"cancelled_date": 1653337233,
"payment_method": {
"type": "CHEQUE",
"identity": {
"id": "",
"identifier": "Visa *****1234 03/25"
}
},
"entity": {
"type": "ORDER",
"number": "O01001110",
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
},
"failure_reason": "Insufficient Funds",
"period": {
"from": "1654698334",
"to": "1657290334"
}
}Use CRM.COM Product Catalogue to set up a business’s Products, their prices as well as Promotions that can be applied on purchasing products.
Products are the physical goods and services that a Business is selling. The product definition includes basic characteristics of the products as well its pricing information. Any products defined in CRM.COM can be sold through an order or an invoice. It’s crucial that Products are configured correctly, since they appear on customer-facing apps/portals for ordering purposes.
{id}{id}{id}{id}/actions{id}/dependencies{id}/media_groupsCreate a new product. A single product can be created per Web API call. Through this API any product can be created; service or physical good, of any type, classification or composition. A single price can also be set for the product.
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The product’s SKU which also has to be unique
The product’s name. Its uniqueness depends on business rules
The product’s type
The product’s SKU in a third-party system. Also kept in CRM.COM for integration pursposes. It has to be unique across all external SKUs of products
A description of the product
Shows when the product is available for sale. If not specified, then it defaults to Always valid
Always available for ordering
Available for ordering during a specific period of time. A product can have a single validity period at a time.
The specific period of time during which the product is available for sale. Applicable and required if the validity setting is set to “Specific Period”
The date from which the product is avialable for ordering
The date until which the product can be ordered. Can be left empty.
The product’s family
The product’s brand
Applicable and mandatory only when creating Usage Services
The supported categories for the product. A product can have multiple categories. Each ategory though must have a different path within Categories tree structure.
Unique identifier of a product category
The product’s price. Mandatory but only for Flat prices. For the rest of the pricing models, multiple prices must be specified in price ranges
Starting tier level per price range
The upper tier. For the last price range it should not be specified
The price of the tiered prices range
The billing period mapped to the specified price. Applicable and required for termed and ne-time services only.
The billing period’s duration
The billing period’s unit of time
Applicable and required for products classified as Fixed/Flexible Bundles or Composite. At least one component must be specified
The unique identifier of the component’s entity (e.g. the product or product type identifier) as this is specified in “item_type”
Defines whether the component is mandatory or not. When mandatory, then the contact always gets the component by default on ordering it and there’s no option to remove it.
Priority shows the ordering of the components in UI/apps/portals for usability purposes
Applicable for components that include more than one products like product types. It shows the minimum required number of items that must to be selected to be included in the product being ordered. Minimum quantity cannot be greater than the maximum allowed quantity
Applicable for components that include more than one products like product types. It shows the maximum allowed number of items that must to be selected to be included in the product being ordered. Maximum quantity cannot be less than the minimum quantity
When set to “true”, it shows that the item’s price is included within the bundle’s price. Therefore, cotnacts will not have to pay anything if included in the order and despite the fact that the item itself has its own price.
The product identifier of the product that is set as default modifier. Only products marked as modifiers can be set. Applicable only for item types that denote a group of products (like the product type or component set) and as long as within that group, there’s one or more products marked as “modifiers”. The default modifier must be one of these products. Use this setting to easily present to contacts a default option during th eordering flow.
The Characteristic’s key as this is specified on the product’s type
The actual value of the attribute for this product. If Characteristic on the product type define a set of allowed values, then one of them must be set here
Set of characteristics that will be inherited by devices created based on this product. Applicable only for traceable physical goods. Any configured variant attribute is available for selection. A value is not required since these characteristic values will be set when creating a device of this product.
The chacteristic’s key. The value will be set on the devices only
Defines which organisations can be access and use it
Defines whether accessibility is inherited by product family or not
Defines which organisations can access and use it
The organisations (Merchants, Service Providers) that can access and use it (applicable only if type = SPECIFIC)
The organisation identifier
Responses
The request has succeeded
Body
The product identifier
POST https://sandbox.crm.com/backoffice/v2/products HTTP/1.1
Content-Type: application/json
{
"sku": "ABC-123",
"name": "HD Decoder",
"type_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"external_sku": "P0000101",
"description": "High definition decoder",
"validity_period": {
"type": "SPECIFIC_PERIOD",
"period": {
"from": 1647499945,
"to": 1679035944
}
},
"family_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"brand_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"measurement_unit_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"categories": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}
],
"pricing": {
"price_model": "TIERED",
"currency_code": "EUR",
"tax_model": "TAX_INCLUSIVE",
"price": 9.99,
"tiers": [
{
"lower_tier": 1,
"upper_tier": 5,
"price": 9.99
}
],
"billing_period": {
"duration": 1,
"uot": "MONTHS"
}
},
"composition": [
{
"item_type": "PRODUCT",
"item_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"mandatory": true,
"priority": 1,
"minimum_quantity": 1,
"maximum_quantity": 3,
"price_inclusive": true,
"modifier_product_id": "56786309-7a21-8097-e107-6e9aec401840"
}
],
"characteristics": [
{
"key": "size",
"value": "Small"
}
],
"device_characteristics": [
{
"key": "static_ip, username, password"
}
],
"accessibility": {
"inherit_family": "false",
"type": "BUSINESS",
"organisations": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}
]
}
}{id}Updates an existing product. The product’s SKU is the only piece of information that cannot be modified.
Path variables
The product identifier that will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The product’s name which has to comply with business rules in terms of uniqueness
The product’s SKU in a third-party system. Also kept in CRM.COM for integration pursposes. It has to be unique across all external SKUs of products
A description for the product
Shows when the product is available for sale. If not specified, then it defaults to Always valid
Always available for ordering
Available for ordering during a specific period of time. A product can have a single validity period at a time.
The specific period of time during which the product is available for sale. Applicable and required if the validity setting is set to “Specific Period”
The date from which the product is avialable for ordering
The date until which the product can be ordered. Can be left empty.
The product’s updated product type. When changing the type for an existing product, restrictions are applied. The type can only change into another type of the same classification. In case of traceable physical goods, they cannot change into a type that marks them as non-traceable
The product family
The product brand
Applicable only when updating Usage Services
The supported categories for the product
The unique identifier of the product category
The unique identifier of the component’s entity (e.g. the product or product type identifier) as this is specified in “item_type”
Defines whether the component is mandatory or not. When mandatory, then the contact always gets the component by default on ordering it and there’s no option to remove it.
Priority shows the ordering of the components in UI/apps/portals for usability purposes
Applicable for components that include more than one products like product types. It shows the minimum required number of items that must to be selected to be included in the product being ordered. Minimum quantity cannot be greater than the maximum allowed quantity
Applicable for components that include more than one products like product types. It shows the maximum allowed number of items that must to be selected to be included in the product being ordered. Maximum quantity cannot be less than the minimum quantity
When set to “true”, it shows that the item’s price is included within the bundle’s price. Therefore, cotnacts will not have to pay anything if included in the order and despite the fact that the item itself has its own price.
The product identifier of the product that is set as default modifier. Only products marked as modifiers can be set. Applicable only for item types that denote a group of products (like the product type or component set) and as long as within that group, there’s one or more products marked as “modifiers”. The default modifier must be one of these products. Use this setting to easily present to contacts a default option during th eordering flow.
The Characteristic’s key as this is specified on the product’s type
The actual value of the attribute for this product. If Characteristic on the product type define a set of allowed values, then one of them must be set here
Set of characteristics that will be inherited by devices created based on this product. Applicable only for traceable physical goods. Any variant attribute is avialable for selection. A value is not required.
The chacteristic’s key. The value will be set on the devices only
Defines which organisations can be access and use it
Defines whether accessibility is inherited by product family or not
Defines which organisations can access and use it
The organisations (Merchants, Service Providers) that can access and use it (applicable only if type = SPECIFIC)
The organisation identifier
Responses
Body
The identifier of the updated product
PUT https://sandbox.crm.com/backoffice/v2/products/22386309-7a21-8097-e107-6e9aec401840 HTTP/1.1
Content-Type: application/json
{
"name": "HD Box",
"external_sku": "P000101",
"description": "High-definition Set Top Box",
"validity_period": {
"type": "SPECIFIC_PERIOD",
"period": {
"from": 1647499945,
"to": 1679035944
}
},
"type_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"family_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"brand_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"measurement_unit_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"categories": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}
],
"composition": [
{
"item_type": "PRODUCT",
"item_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"mandatory": true,
"priority": 1,
"minimum_quantity": 1,
"maximum_quantity": 3,
"price_inclusive": true,
"modifier_product_id": "56786309-7a21-8097-e107-6e9aec401840"
}
],
"characteristics": [
{
"key": "size",
"value": "Small"
}
],
"device_characteristics": [
{
"key": "static_ip"
}
],
"accessibility": {
"inherit_family": "false",
"type": "SPECIFIC_ORG",
"organisations": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}
]
}
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "22386309-7a21-8097-e107-6e9aec401840"
}{id}Deletes an existing product. A product can only be deleted if it was never ordered by a contact (i.e. never included in any financial tansaction like an Invoice). In the case of termed and one-time services, there’s no Active subscriber using the service to be deleted.
Path variables
The product identifier that will be deleted
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
DELETE https://sandbox.crm.com/backoffice/v2/products/22386309-7a21-8097-e107-6e9aec401840 HTTP/1.1
HTTP/1.1 204 No Content Returns the complete list of products within the product catalogue, along with their basic information and price. Variant products are excluded by default since they are listed within their Composite product.
Request parameters
Product type identifier
Product category identifier
Product brand identifier
Product family identifier
The unique identifier of the organisation that will fulfill a contact’s request to purchase a product.
The product’s composition as this is defined by its type
The product’s classification
If not speficied, then all products are returned regardless of their availability in various organisations
Return only products available for sale in various merchants/venues
Return products temporarly unavialable for sale in various merchants/venues
Include Creatives in Response
Filters products based on whether are provisionable or not
The tag id’s of the products for filtering
Defines whether tags should be retrieved or not
If specified, then only products marked as modifiers are returned. A product is marked as modifier through its type. If not specified, then it’s ignored and filtering is not applied.
The date on which a product is sold/added as a charge or a service should also be within its validity date. Applicable only when listing products to get the services available to be ordered, added as charges or included in a subscription either as a new addition or through a service change. Filter based on the validity date, which may fall within a given date range. The value can be a string with a date in epoch format. Each option must also include an operator. Use up to two options based on the required search (e.g. validity_date[gte]=1618395497&validity_date[lt]=1618395497).
Returns results where the validity date is greater than this value
Returns results where the validity date is greater than or equal to this value
Returns results where the validity date is less than this value
Returns results where the validity date is less than or equal to this value
Search for a product using its SKU, its name or description
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
The sales model is the unique identifier used to calssify a product’s prcie
Defines whether stock information will be returned or not
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
Product’s unique identifier
Product SKU
Product name
Product description
Number of component options for this product. Applicable for Fix/Flex bundles as well as Composite products
Number of characteristics set up for this product
Number of variant products. Applicable only for Composite products
Number of prices set up for this product
Shows whether the product is enabled or not at the organisation that fulfills this order. Available and used only when a “fuflfilled by” organisation is specified that indicates that products are listed because of the ordering flow.
Shows if the retrieved product is a variation of a Composite product
Defines whether the product is a stockable product
The product has at least one price of type Rental. Applicable only for traceable physical goods since they are the only ones that can be givedn to contacts as Rentals
Applicable only for stockable physical goods
Defines whether the product is provisionable or not
The price’s uniaue identifier
The product’s price. For Tiered/Volume and Stairstep pricing models, the first range’s price is returned.
Available only Tiered, Volume and Stairstep pricing models. Only the first tier range is returned that has the returned price
The first range’s upper tier. The lower tier is always set to 1.
Total numebr of tiered prices set up
The billing period mapped to the specified price. Applicable only for termed and one-time services only.
The billing period’s duration
The billing period’s unit of time
Aplicabe only for Usage service to show the unit per which the price is applied
Measurement unit identifier
Measurement unit name
Display name
The sales model is the unique identifier used to calssify a product’s prcie
The sales model unique identifier
The sales model name which has to be unique across all sales models
Details about the related type
The type identifier
The type name
Details about the organisation from where such event was posted
The organisation identifier
The organisation name
The creative identifier
Information about the creative type
Partner logos configurable by SO, applicable for Business, Merchant, Venue
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
The creative width
The creative height
The creative format
The creative content URL
The creative public identifier
Information about the creative transformations
The transformed creative width
The transformed creative height
The transformed creative URL
The product stock information (returned only if include_stock is set to true)
The number of items that are in the warehouse (including reserved ones)
The number of items that are reserved
Tag unique id
Tag name
The colour of the tag - for list view only
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/products HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "4ec0809f-ed91-4b68-b912-5bd6064d901e",
"sku": "ABC12345",
"name": "Base TV",
"description": "Basic TV & myFlix",
"classification": "TRACEABLE_PHYSICAL_GOOD",
"type_composition": "FLAT",
"componens": 2,
"characteristics": 2,
"variants": 9,
"prices": 3,
"availability": "ENABLED",
"is_variant": "false",
"is_stockable": "true",
"can_be_rented": true,
"in_stock": "true",
"is_provisionable": "false",
"pricing": {
"id": "4ec0809f-ed91-4b68-b912-5bd6064d901e",
"price_model": "TIERED",
"currency_code": "EUR",
"tax_model": "TAX_INCLUSIVE",
"price": 9.99,
"tiers": {
"upper_tier": 5,
"number_of_tiers": 3
},
"billing_period": {
"duration": 1,
"uot": "MONTHS"
},
"measurement_unit": {
"id": "4ec0809f-ed91-4b68-b912-5bd6064d901e",
"name": "minute",
"display_name": "mins."
},
"sales_model": {
"id": "caf332bc-4e90-47b5-a05d-142b264897b9",
"name": "Retail"
}
},
"type": {
"id": "c01ecd1b-ff1e-35c2-7236-59ae20339c78",
"name": "Internal Transaction"
},
"owner": {
"id": "4248fab3-67d5-2eb1-eaf6-079ce18cd2ed",
"name": "Bravo Coffee"
},
"creatives": [
{
"id": "3caf8388-b9c6-6679-1e9b-94a6fda92a41",
"usage_type": "APP_LOGO",
"width": 2159,
"height": 3075,
"format": "jpg",
"url": "https://assets.crm.com/image/logo.jpg",
"public_id": "crm-com/image",
"media": [
{
"width": 200,
"height": 300,
"url": "https://asset.crm.com/image/offer/c_scale,w_200/logo.jpg"
}
]
}
],
"stock_information": {
"stock_balance": 12,
"reserved": 1
},
"tags": {
"id": "609a369e-3f10-492a-8332-679ecbe56b65",
"name": "Maintenance",
"colour": "FR547F"
}
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "4ec0809f-ed91-4b68-b912-5bd6064d901e",
"sku": "ABC12345",
"name": "Base TV",
"description": "Basic TV & myFlix",
"classification": "TRACEABLE_PHYSICAL_GOOD",
"type_composition": "FLAT",
"componens": 2,
"characteristics": 2,
"variants": 9,
"prices": 3,
"availability": "ENABLED",
"is_variant": "false",
"is_stockable": "true",
"can_be_rented": true,
"in_stock": "true",
"is_provisionable": "false",
"pricing": {
"id": "4ec0809f-ed91-4b68-b912-5bd6064d901e",
"price_model": "TIERED",
"currency_code": "EUR",
"tax_model": "TAX_INCLUSIVE",
"price": 9.99,
"tiers": {
"upper_tier": 5,
"number_of_tiers": 3
},
"billing_period": {
"duration": 1,
"uot": "MONTHS"
},
"measurement_unit": {
"id": "4ec0809f-ed91-4b68-b912-5bd6064d901e",
"name": "minute",
"display_name": "mins."
},
"sales_model": {
"id": "caf332bc-4e90-47b5-a05d-142b264897b9",
"name": "Retail"
}
},
"type": {
"id": "c01ecd1b-ff1e-35c2-7236-59ae20339c78",
"name": "Internal Transaction"
},
"owner": {
"id": "4248fab3-67d5-2eb1-eaf6-079ce18cd2ed",
"name": "Bravo Coffee"
},
"creatives": [
{
"id": "3caf8388-b9c6-6679-1e9b-94a6fda92a41",
"usage_type": "APPLE_LOGO_IMAGE",
"width": 2159,
"height": 3075,
"format": "jpg",
"url": "https://assets.crm.com/image/logo.jpg",
"public_id": "crm-com/image",
"media": [
{
"width": 200,
"height": 300,
"url": "https://asset.crm.com/image/offer/c_scale,w_200/logo.jpg"
}
]
}
],
"stock_information": {
"stock_balance": 12,
"reserved": 1
},
"tags": {
"id": "609a369e-3f10-492a-8332-679ecbe56b65",
"name": "Maintenance",
"colour": "FR547F"
}
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Retrieve detailed information for a specific product. Information of a single product can be retrieved per Web API call.
Path variables
The unique identifier of the product to be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
Product unique identifier
Product SKU
Product name
Product description
The product’s SKU in a third-party system. Also kept in CRM.COM for integration pursposes. It has to be unique across all external SKUs of products
Defines if the product is a variation of a composite product
Defines whether the product is a stockable product
Shows when the product is available for sale. If not specified, then it defaults to Always valid
Always available for ordering
Available for ordering during a specific period of time. A product can have a single validity period at a time.
The specific period of time during which the product is available for sale. Applicable and required if the validity setting is set to “Specific Period”
The date from which the product is avialable for ordering
The date until which the product can be ordered. Can be left empty.
Indicates whether the product can also be sold as a bundle
Shows whether the product is in stock or not. Applicable only for stockable physical goods.
Details about the related type
The type identifier
The type name
The product’s family
Family identifier
Family name
Product Brand
Brand identifier
Brand name
The product categories. A product migth have multiple catagories
Details about the event classification
The category identifier
The category name
The measurement unit of the product. Applicable for usage services only
The unique identifier of the measurement unit
The name of the measurement unit
The display name of the measurement unit
A product’s composition i.e. other products or products of a type/family/component set that can be sold as part of the product. Applicable only or Fixed/Flexible Bundles and Composite products.
The unique identifier of the entity specified in “item_type”
SKU of the product (only when a product is specified in the composition)
Name of product or product type/family/component set depending on item_type selection
Shows if the specified item is always included in the composition and can never be removed.
Minimum required quantity. Applicalbe if the item type is a product type/family/category or component set
Maximum required quantity. Applicalbe if the item type is a product type/family/category or component set
The component’s price is included in the bundle/composite product’s price or not
The priority of the composition
The default modifier of this composition. Applicable only if the item is additionally classified as a modifier. This default modifier is selected by default on ordering
The identifier of the product set as default modifier
The name of the product set as default modifier
List of product characteristics and their values
Characteristic identifier
Key name of the attribute
Attribute value
Defines whether the attribute is mandatory (and cannot be removed from the product) or not
Attribute’s label for UI purposes
The priority of the characteristic attribute.
Applicable only for variant product to present their Composite product
Composite product identifier
Composite product SKU
Composite product name
Set of characteristics that will be inherited by devices created based on this product. Applicable only for traceable physical goods. Any variant attribute is avialable for selection. A value is not required.
The chacteristic’s key. The value will be set on the devices only
Thecharacteristic’s label
Defines how the segment can be accessed from business network
Defines whether accessibility is inherited by product family or not
Defines which organisations can access and use it
The organisations (Merchants, Service Providers) that can access and use it (applicable only if type = SPECIFIC)
The organisation identifier
The organisation name
The creative identifier
Information about the creative type
Partner logos configurable by SO, applicable for Business, Merchant, Venue
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
The creative width
The creative height
The creative format
The creative content URL
The creative public identifier
Information about the creative transformations
The transformed creative width
The transformed creative height
The transformed creative URL
GET https://sandbox.crm.com/backoffice/v2/products/{id} HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "7CD9C84FA60F9FE407140E20F707726A",
"sku": "ABC12345",
"name": "Base TV",
"description": "Basic TV & myFlix",
"external_sku": "P000101",
"classification": "TRACEABLE_PHYSICAL_GOOD",
"type_composition": "FLAT",
"is_variant": true,
"is_stockable": true,
"validity_period": {
"type": "ALWAYS_VALID",
"period": {
"from": 1647499945,
"to": 1679035944
}
},
"included_in_bundle": true,
"in_stock": "true",
"type": {
"id": "c01ecd1b-ff1e-35c2-7236-59ae20339c78",
"name": "Internal Transaction"
},
"family": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "Hardware products"
},
"brand": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "Samsung"
},
"categories": [
{
"id": "c8d83493-3f50-40df-adb0-762ec5f41863",
"name": "Delivery Purchase"
}
],
"measurement_unit": {
"id": "895e8910-ebc2-d6c5-fb49-84bf99176171",
"name": "Call minutes",
"display_name": "min."
},
"composition": [
{
"item_type": "PRODUCT",
"item_id": "895e8910-ebc2-d6c5-fb49-84bf99176171",
"sku": "STB001",
"name": "Decoder",
"mandatory": true,
"minimum_quantity": 1,
"maximum_quantity": 5,
"price_inclusive": true,
"priority": 1,
"default_modifer": {
"id": "23458910-ebc2-d6c5-fb49-84bf99176171",
"name": "Premium Blend"
}
}
],
"characteristics": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"key": "colour",
"value": "RED",
"mandatory": true,
"label": "Red",
"priority": 1
}
],
"composite_product": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"sku": "CLO001",
"name": "Trousers"
},
"device_characteristics": [
{
"key": "static_ip",
"label": "Static IP Address"
}
],
"accessbility": {
"inherit_family": "true",
"type": "SPECIFIC_ORG",
"organisations": [
{
"id": "feedcd4b-8470-04b3-73bf-9ce9a4340822",
"name": "CRM"
}
]
},
"creatives": [
{
"id": "3caf8388-b9c6-6679-1e9b-94a6fda92a41",
"usage_type": "APPLE_LOGO_IMAGE",
"width": 2159,
"height": 3075,
"format": "jpg",
"url": "https://assets.crm.com/image/logo.jpg",
"public_id": "crm-com/image",
"media": [
{
"width": 200,
"height": 300,
"url": "https://asset.crm.com/image/offer/c_scale,w_200/logo.jpg"
}
]
}
]
}{id}/actionsPerform actions on a product by enabling or disabling the product at various organisations and/or supply methods. Only enabled products are available for ordering at the specified organisations.
Path variables
The product’s unique identifier
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Action to be performed
Product available for sale
Product temporarily unavailable for sale
The organisation identifiers for which the product action is applied.
The organisation at which the product is enabled/disabled.
Enable or disable the product for a single supply method.
The type of the event
Delivered to the customer’s address
Picked up by the customer from a venue
Online sales of services
Responses
Body
The product identifier
PUT https://sandbox.crm.com/backoffice/v2/products/{id}/actions HTTP/1.1
Content-Type: application/json
{
"action": "DISABLE",
"organisations": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"supply_method": [
"DELIVERY"
]
}
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}Performs product synchronisation between the products that exist in a third-party system and prodcuts configured in CRM.COM, having the 3rd-party system’s information as the main one and CRM.COM as the system to ge tin sync. Via this sychronisation process
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Details about the products to synchornise
The product sku
The product’s SKU in the third-party system. Also kept in CRM.COM for integration pursposes. It has to be unique across all external SKUs of products
The product name
The product description
The product type (if type is provided, id or name should be specified)
The product type identifier
The product type name
Details about the product brand (if brand is provided, id or name should be specified)
The product brand identifier
The product brand name
Details about the product family (if family is provided, id or name should be specified)
The product family identifier
The product family name
Details about the product categories (for each provided category, id or name or code should be specified)
The product category identifier
The product category name
The product category code
Defines the period that the product will be valid (if not specified, will be always valid)
The date from which the product will be valid
The date up to which the product will be valid
Details about the product tax rate (id or name should be specified)
The tax rate identifier
The tax rate name
Details about the product pricing
The price (amount). Mandatory only for Flat rate models
Details about the pricing tiering (required for Tiered/Volume/Stairstep based rate models). Mandatory and required for these 3 rate models. At leas two tiers must be provided
The lowest tier
The top tier. Not required for the last tier range
The tier price (amount)
Details about the product characteristics
The characteristic key
The characteristics value
Details about the product components (applicable if the synced product is variant attribute or bundle)
The component product sku that will be used as component (sku or family, category or product type should be specified)
The component product family that will be used as component (sku, family, category or product type should be specified)
The product family identifier (id or name should be specified)
The product family name (id or name should be specified)
The component product type that will be used as component (sku or family, category or product type should be specified)
The product type identifier (id or name should be specified)
The product type identifier (id or name should be specified)
The component product category that will be used as component (sku or family, category or product type should be specified)
The product category identifier (id, name or code should be specified)
The product category name (id, name or code should be specified)
The product category code (id, name or code should be specified)
Defines if pricing is inclusive
The maximum number of components that should be added (applicable only for product family and type)
The maximum number of components that should be added (applicable only for product family and type)
Defines whether the component must be added to the product or not
The identifier of the product that is set as default modifier
The product’s measurement unit. A uique name should be specified
The measurement unit identifier
The measurement unit name
The unique product sku of variant_attribute (required if the synced product is a variant attribute of another product)
The creative identifier
Information about the creative type
Partner logos configurable by SO, applicable for Business, Merchant, Venue
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
The creative width
The creative height
The creative format
The creative content URL
The creative public identifier
Information about the creative transformations
The transformed creative width
The transformed creative height
The transformed creative URL
Defines the organisation that owns such product (if not specified, defaults to business)
Identify the owner based on organisation
The organisation identifier
Identify the owner based on organisation’s tap
The tap identifier
The tap code
Responses
OK
Body
A unique identifier of the Web API call which can be used for triggering the webhook and relate the api request to the webhook request (enables integrator to match the api request with the webhook request).
Synchronise stand-alone POS products
POST https://sandbox.crm.com/backoffice/v2/products/synchronisation HTTP/1.1
Content-Type: application/json
{
"products": [
{
"sku": "SKU0001",
"external_sku": "P000101",
"name": "Iced Latte",
"description": "Product Description",
"type": {
"id": "d94ef0f0-59a1-aa28-b49d-0d1edcc864fe",
"name": "Cold"
},
"brand": {
"id": "13b265cb-a607-5d22-1ce5-52ae3585fcdc",
"name": "Fresh Brew Inc"
},
"family": {
"id": "21f9ed6d-ff93-afce-c7f0-b1e96e6b8a04",
"name": "Homebrew"
},
"categories": [
{
"id": "070631e8-c34b-9dd7-24e7-074cc5b3a7e8",
"name": "Drinks",
"code": "500"
}
],
"validity_period": {
"from_date": 11598357038,
"to_date": 1598357038
},
"tax_rate": {
"id": "d1b59cfd-f3dd-1ae0-e96f-935d51ae66b0",
"name": "5% Tax"
},
"pricing": {
"price_model": "TIERED",
"tax_model": "TAX_INCLUSIVE",
"price": 9.99,
"currency_code": "EUR",
"tiers": [
{
"lower_tier": 1,
"upper_tier": 5,
"price": 8.99
}
]
},
"characteristics": [
{
"key": "size",
"value": "Medium"
}
],
"components": [
{
"sku": "CPSKU01",
"family": {
"id": "ab93d2e9-f6b4-ca48-15e1-bff3a468ab4a",
"name": "Dry"
},
"type": {
"id": "ab93d2e9-f6b4-ca48-15e1-bff3a468ab4a",
"name": "Extras"
},
"category": {
"id": "ab93d2e9-f6b4-ca48-15e1-bff3a468ab4a",
"name": "Milks",
"code": "500"
},
"inclusive": true,
"min_amount": 1,
"max_amount": 1,
"mandatory": true,
"modifier_product_id": "56786309-7a21-8097-e107-6e9aec401840"
}
],
"measurement_unit": {
"id": "014a8d1a-62f4-2b0d-84af-16c298a76fe9",
"name": "Liters"
},
"main_product_sku": "SKU000A",
"creatives": [
{
"id": "3caf8388-b9c6-6679-1e9b-94a6fda92a41",
"usage_type": "DIRECT_SALE_IMAGE",
"width": 2159,
"height": 3075,
"format": "jpg",
"url": "https://assets.crm.com/image/logo.jpg",
"public_id": "crm-com/image",
"media": [
{
"width": 200,
"height": 300,
"url": "https://asset.crm.com/image/offer/c_scale,w_200/logo.jpg"
}
]
}
],
"owner": {
"organisation": {
"id": "4e4fdde4-f572-0d3b-5974-f69b819aeaaf"
},
"tap": {
"id": "fac5973a-4f4c-a2ec-b56f-4d16b76aa22f",
"code": "0000257024"
}
}
}
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "a781bbc1-9067-c384-52fe-43586f89110a"
}{id}/dependenciesReturns a list of products on which the specified product has a dependency to
Path variables
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
Dependency rule identifier
The entity at which the product has a dependency to. A product has a dependency to either another product or products of a specific type
Identifier of the dependent product/type
Product or type name
Dependency type. A product requires or cannot coexist with the dependency’s product
Shows if the product requires all or at least ne of the dependaency products
List of products or product types at which the product has a dependency to
Dependency on a product or a product type
The identifier of a product or the type depending on the item_type
The name of the dependent product or type
List of products to which there’s a dependency.
Product identifier
Product SKU
Product name
GET https://sandbox.crm.com/backoffice/v2/products/{id}/dependencies HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"item_type": "PRODUCT",
"item_id": "MOV001",
"name": "Movies",
"type": "REQUIRES",
"classification": "TRACEABLE_PHYSICAL_GOOD",
"operator": "ANY",
"dependencies": [
{
"item_type": "PRODUCT",
"item_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "GIGA Gold",
"products": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"sku": "ABC1234",
"name": "Router"
}
]
}
]
}
]
}{id}/media_groupsLink a product with one or many media groups
Path variables
The product (identifier) that media groups will be set
Notes
Uploading media for a product requires the execution of the following APIs
- Create new Media Group
- Create Product Media Groups
- Upload Media
- Perform Cloudinary Upload (where CRM will send all signature details)
- Cloudinary service calls back CRM media group (using an internal callback)
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The media group identifier
Responses
POST https://sandbox.crm.com/backoffice/v1/products/3f1f9e63-7f40-4e5e-bc42-11a162f7f1fb/media_groups HTTP/1.1
Content-Type: application/json
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
[
{
"media_group_id": "3f1f9e63-7f40-4e5e-bc42-11a162f7f1fb"
}
]
HTTP/1.1 200 OKProduct allowance shows which usage services and/or non-traceable physical goods contact can consume withni a period of time, for example during a billing cycle. Optonally, usage limits can be set up that define how much can be consumed. Allowance is set up per price and only for prices of termed and one-time services.
{id}/allowance{id}/allowance{id}/allowance{id}/allowanceAdds allowance settings for one of the product’s prices. Thi smust be a price of a either a termed or a one-time service since usage can only be consumed via these services. As a result the same service might have multiple allowances, one or each one of its prices. Accumulated usage limis and/or Products allowance must be specified.
Path variables
The price identifier
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
How much money can be spent on consuming any of the allowed usage service/non-traceable physical good within a period. Cash limits are specified in the price’s currency
Maximum allowed amount of money that can be spent on usage per transaction
Maximum allowed amount of money that can be spent on usage per day
Maximum allowed amount of money that can be spend on consuming usage per billing cycle
List of allowance products includes the prodcut that can be consumed as part of subscribing to a service. Only usage servces and nono-traceable physical goods can be specified.
The product that can be consumed
The unique identifier of the item type.
Maximum allowed amount of money that can be spent on usage per transaction
Maximum allowed amount of money that can be spent on usage per day
Maximum allowed amount of money that can be spend on consuming usage per billing cycle
Maximum allowed usage amount per transaction
Maximum allowed usage amount per day
Maximum allowed usage amount per billing cycle
List of Organisations (merchant/venues or service providers/points) at which usage can be consumed.
The organisation’s unique identifier
Responses
Body
The product price’s unique identifier
POST https://sandbox.crm.com/backoffice/v2/prices/4dc0809f-ed91-4b68-b912-5bd6064d901e/allowance HTTP/1.1
Content-Type: application/json
{
"accumulated_allowance": {
"cash_limits": {
"per_transaction": 9.99,
"per_day": 19.99,
"per_billing_cycle": 59.99
}
},
"products_allowance": [
{
"item_type": "PRODUCT",
"item_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"cash_limits": {
"per_transaction": 9.99,
"per_day": 19.99,
"per_billing_cycle": 59.99
},
"usage_limits": {
"per_transaction": 9.99,
"per_day": 19.99,
"per_billing_cycle": 59.99
}
}
],
"organisations": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}
]
}{id}/allowanceAdds allowance for one of the product’s prices
Path variables
The price’s unique identifier
Request body
How much money can be spent on consuming any of the allowed usage service/non-traceable physical good within a period. Cash limits are specified in the price’s currency
Maximum allowed amount of money that can be spent on usage per transaction
Maximum allowed amount of money that can be spent on usage per day
Maximum allowed amount of money that can be spend on consuming usage per billing cycle
List of allowance products includes the prodcut that can be consumed as part of subscribing to a service. Only usage servces and nono-traceable physical goods can be specified.
The product that can be consumed
The unique identifier of the item type.
Maximum allowed amount of money that can be spent on usage per transaction
Maximum allowed amount of money that can be spent on usage per day
Maximum allowed amount of money that can be spend on consuming usage per billing cycle
Maximum allowed usage amount per transaction
Maximum allowed usage amount per day
Maximum allowed usage amount per billing cycle
List of Organisations (merchant/venues or service providers/points) at which usage can be consumed.
The organisation’s unique identifier
Responses
Body
The product price’s unique identifier
PUT https://sandbox.crm.com/backoffice/v2/prices/{id}/allowance HTTP/1.1
Content-Type: application/json
{
"accumulated_allowance": {
"cash_limits": {
"per_transaction": 9.99,
"per_day": 19.99,
"per_billing_cycle": 59.99
}
},
"products_allowance": [
{
"item_type": "PRODUCT",
"item_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"cash_limits": {
"per_transaction": 9.99,
"per_day": 19.99,
"per_billing_cycle": 59.99
},
"usage_limits": {
"per_transaction": 9.99,
"per_day": 19.99,
"per_billing_cycle": 59.99
}
}
],
"organisations": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}
]
}{id}/allowanceReturns usage allowance of a specific product price.
Path variables
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
How much money can be spent on consuming any of the allowed usage service/non-traceable physical good within a period. Cash limits are specified in the price’s currency
Maximum allowed amount of money that can be spent on usage per transaction
Maximum allowed amount of money that can be spent on usage per day
Maximum allowed amount of money that can be spend on consuming usage per billing cycle
List of allowance products includes the prodcut that can be consumed as part of subscribing to a service. Only usage servces and nono-traceable physical goods can be specified.
The product that can be consumed
The unique identifier of the item type.
The item type’s name
The product’s SKU.Available only when item type is set to Product
Maximum allowed amount of money that can be spent on usage per transaction
Maximum allowed amount of money that can be spent on usage per day
Maximum allowed amount of money that can be spend on consuming usage per billing cycle
Maximum allowed usage amount per transaction
Maximum allowed usage amount per day
Maximum allowed usage amount per billing cycle
List of Organisations (merchant/venues or service providers/points) at which usage can be consumed.
The organisation’s unique identifier
The organisation’s name
GET https://sandbox.crm.com/backoffice/v2/prices/{id}/allowance HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"accumulated_allowance": {
"cash_limits": {
"per_transaction": 9.99,
"per_day": 19.99,
"per_billing_cycle": 59.99
}
},
"products_allowance": [
{
"item_type": "PRODUCT",
"item_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "Data",
"sku": "D001",
"cash_limits": {
"per_transaction": 9.99,
"per_day": 19.99,
"per_billing_cycle": 59.99
},
"usage_limits": {
"per_transaction": 9.99,
"per_day": 19.99,
"per_billing_cycle": 59.99
}
}
],
"organisations": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "Good Burgers"
}
]
}Product Variants represent the multiple variations in which a Composite product can be ordered. A composite product has a set of attributes, each attribute having multiple values. Variation products are generated based on these attribute values combinations
{id}/variants{id}/variants{id}/variants/{variant_id}{id}/variants/{variant_id}{id}/variantsCreate the Variant products of a composite product. For each variant product, a unique combination of the composite product’s characteristic values must be set
Path variables
The composite product’s unique idetifier
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The variants of the product (product id and sku/name are semi-optional)
Set an existing product to be specifed as one of the composite product’s variations. This product must not be included in any other composite product.
The new variant product’s SKU
The new variant product’s name
The product’s SKU in a third-party system. Also kept in CRM.COM for integration pursposes. It has to be unique across all external SKUs of products
The new variant product’s description
The variant product’s characteristics. Only characteristics of the Composite product can be included. In addition, the characteristics values must also be one of the allowed ones of the composite product. Each characteristics-value combination must be unique so as to generate one variation product for each combination
The characteristic key
The characteristic value
The priority of the variant to be used when ordering the products during the ordering flow
The product’s price. Mandatory but only for Flat prices. For the rest of the pricing models, multiple prices must be specified in price ranges
Starting tier level per price range
The upper tier. For the last price range it should not be specified
The price of the tiered prices range
The billing period mapped to the specified price. Applicable and required for termed and ne-time services only.
The billing period’s duration
The billing period’s unit of time
Responses
POST https://sandbox.crm.com/backoffice/v2/products/22386309-7a21-8097-e107-6e9aec401840/variants HTTP/1.1
Content-Type: application/json
{
"variants": [
{
"product_id": "704a96be-4bcf-f5cc-12a2-c5038e37d8c5",
"sku": "A11-Red-128",
"name": "A11s Red/128",
"external_sku": "P000101",
"description": "A11 device, colour Red and 128MB capacity",
"characteristics": [
{
"key": "colour",
"value": "Red"
}
],
"priority": 1,
"pricing": {
"price_model": "TIERED",
"currency_code": "EUR",
"tax_model": "TAX_INCLUSIVE",
"price": 9.99,
"tiers": [
{
"lower_tier": 1,
"upper_tier": 5,
"price": 9.99
}
],
"billing_period": {
"duration": 1,
"uot": "MONTHS"
}
}
}
]
}{id}/variantsReturns the list of a composite product’s variants.
Path variables
The product’s unique idetifier
Request parameters
How the order will be supplied
Delivered to the customer’s address
Picked up by the customer from a venue
Online sales of services
The unique identifier of the organisation providing the product. If specified then only products avialable to be ordered at that point of time will be returned
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
Variant product identifier
product SKU
Product name
Product description
The product’s SKU in a third-party system. Also kept in CRM.COM for integration pursposes. It has to be unique across all external SKUs of products
List of attributes based on which the variant product was created.
Attribute key
Attribute value
Label to be used for U purposes
The variant product’s price. A variant product might inherit its price from the Composite product or it might havee a price on its own.
The product’s price. If a Variant product does not have its own price, then the Composite products price is returned. For Tiered/Volume/Stairstep rate models, this it the price of the first tier level.
Applicable only for Tiered/Volume/Stairstep models. Returns only the first tier
Tiered price lower tier
Tiered price upper tier
Number of tiered prices
The creative identifier
Information about the creative type
Partner logos configurable by SO, applicable for Business, Merchant, Venue
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
The creative width
The creative height
The creative format
The creative content URL
The creative public identifier
Information about the creative transformations
The transformed creative width
The transformed creative height
The transformed creative URL
GET https://sandbox.crm.com/backoffice/v2/products/22386309-7a21-8097-e107-6e9aec401840/variants HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"sku": "A1151-Red/128",
"name": "A11 Red/128Mb",
"description": "A11 devices, colour=Red, capacity=128",
"external_sku": "P000101",
"characteristics": [
{
"key": "colour",
"value": "Red",
"label": "Colour"
}
],
"pricing": [
{
"price": 9.99,
"currency": "EUR",
"price_model": "TIERED",
"tax_model": "TAX_INCLUSIVE",
"tiers": {
"lower_tier": 1,
"upper_tier": 3,
"number_of_tiers": 5
}
}
],
"creatives": [
{
"id": "3caf8388-b9c6-6679-1e9b-94a6fda92a41",
"usage_type": "PROFILEIMAGE",
"width": 2159,
"height": 3075,
"format": "jpg",
"url": "https://assets.crm.com/image/logo.jpg",
"public_id": "crm-com/image",
"media": [
{
"width": 200,
"height": 300,
"url": "https://asset.crm.com/image/offer/c_scale,w_200/logo.jpg"
}
]
}
]
}
]
}{id}/variants/{variant_id}Update an existing variant
Path variables
The product’s unique idetifier
The variant product’s unique idetifier
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The priority of the component
Responses
PUT https://stagingapi.crm.com/backoffice/v1/products/{id}/components/{component_id} HTTP/1.1
Content-Type: application/json
{
"classification": "ADDON",
"mandatory": true,
"minimum_quantity": 1,
"maximum_quantity": 5,
"price_inclusive": true
}{id}/variants/{variant_id}Removes a product from the list of a composite product’s variations. The product however is not deleted. It remains and can still be ordered by consumers individually and not as part of a Composite product.
Path variables
The product’s unique idetifier
The variant product’s unique identifer
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
DELETE https://sandbox.crm.com/backoffice/v2/products/22386309-7a21-8097-e107-6e9aec401840/variants/22386309-7a21-8097-e107-6e9aec4018QQ HTTP/1.1
HTTP/1.1 204 No Content {id}/tags{id}/tags{id}/tagsUpdate the tags associated with the product
Path variables
The product (identifier) on which tags will be upaded
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The tags that will be associated with the activity
Responses
The request has succeded
Body
The lead identifier
PUT https://sandbox.crm.com/backoffice/v2/products/d4187991-4d1a-4aa2-fa3e-ce5fe7fdb7d9/tags HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"tags": [
"96c3cb52-c68f-6ba6-e886-ed28f2b594cb"
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "d4187991-4d1a-4aa2-fa3e-ce5fe7fdb7d9"
}{id}/tagsRetrieve a list of tags that are associated with the product
Path variables
The product (identifier) of which tags will be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeded
Body
The tag identifier
The tag name
The tag color (hex code) that will be used for visual purposes
GET https://sandbox.crm.com/backoffice/v2/products/d82881e9-a909-9d44-4f28-4b30fc1ac276/tags HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "1abe9097-d46a-d2ed-3415-fd3e1439d8d4",
"name": "VIP",
"colour": "#0000FF"
}
]
}Products marked as to be used for Provisioning purposes, i.e. their information is passed over to Provisioning Provider Integrations, require some additional information. This information includes by which providers they are provisioned and their external references at these providers.
{id}/providers{id}/providers{id}/providers/{provider_id}{id}/providers{id}/providersAdd a new provisioning provider on a specific product
Path variables
The product (identifier) that provider details will be added
Notes
Within CRM, only products of type traceable physical goods, termed and one time services can be provisioned. Creating such products (given that their type is provisioned enabled) requires to specify the related provider details as described bellow
- Traceable Physical Goods: must specify by which integrator(s) can be provisioned
- Termed & One-Time Services: must specify by which integrator(s) can be provisioned and the supported external reference per provider (a service can be provisioned by more than one provider)
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The provider (integrator identifier) that will provision the product
The provider (integrator) external reference (applicable and required only for termed and one-time services). More than one referenes can be added. If no external reference is defined, then the service will not be provisioned.
[
"EX-REF-01"
]Responses
POST https://sandbox.crm.com/backoffice/v2/products/16dec2ff-f6fb-4d44-c388-0f1f95c03890/providers HTTP/1.1
Content-Type: application/json
[
{
"integration_id": "8812f0cf-7256-2647-ffbd-a7356232f318",
"external_references": [
"EX-REF-01"
]
}
]
HTTP/1.1 200 OK {id}/providersUpdate an existing provisioning provider on a specific product
Path variables
The product (identifier) that provider details will be updated
Notes
Within CRM, only products of type traceable physical goods, termed and one time services can be provisioned. Creating such products (given that their type is provisioned enabled) requires to specify the related provider details as described bellow
- Traceable Physical Goods: must specify by which integrator(s) can be provisioned
- Termed & One-Time Services: must specify by which integrator(s) can be provisioned and the supported external reference per provider (a service can be provisioned by more than one provider)
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The product provider (identifier) that will be updated
The provider (integrator identifier) that will provision the product
The provider (integrator) external reference (applicable and required only for termed and one-time services). Multiple references can be specified. If none is specified, then the service is not provisioned.
[
"EX-REF-01"
]Responses
PUT https://sandbox.crm.com/backoffice/v2/products/16dec2ff-f6fb-4d44-c388-0f1f95c03890/providers HTTP/1.1
Content-Type: application/json
[
{
"id": "10c44dba-6cbe-1015-1ba3-662ca3c24c36",
"integration_id": "8812f0cf-7256-2647-ffbd-a7356232f318",
"external_references": [
"EX-REF-01"
]
}
]
HTTP/1.1 200 OK {id}/providers/{provider_id}Remove an existing provisioning provider from a specific product
Path variables
The product (identifier) that provider details will be deleted
The provider for which details will be removed. This is the integration’s identifier
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
DELETE https://sandbox.crm.com/backoffice/v2/products/16dec2ff-f6fb-4d44-c388-0f1f95c03890/providers/16dec2ff-f6fb-4d44-c388-0f1f95c03890 HTTP/1.1
HTTP/1.1 204 No Content {id}/providersGet a list of all provisioning providers of a specific product
Path variables
The product (identifier) that provider details will be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
The product provider identifier
Details about the provider integrator that provisions the product
The provider integrator identifier
The provider integrator name
The provider’s logo
The provider (integrator) external reference (applicable only for termed and one-time services)
[
"EXT-REF-01"
]The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/products/97ab56be-077b-984a-7499-760f9f15ecd4/providers HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "c9d10f2c-7511-ebc7-1158-3bfbb59ca5c1",
"integration": {
"id": "246af5e7-dd6c-affe-18a5-e8988f12a3da",
"name": "Irdeto",
"media_url": ""
},
"external_references": [
"EXT-REF-01"
]
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}/translations{id}/translations{id}/translations/actions{id}/translationsRetrieve the content translations for an existing product
Path variables
The product (identifier) of which content translations will be retrieved
Request parameters
Filter based on language
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The content translations for the specified language
The content (attribute) key
The content (attribute) translated value
GET https://sandbox.crm.com/backoffice/v2/products/a42dd7c4-e755-92fb-963b-5f658a59908e/translations HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"language_code": "EN",
"translations": [
{
"key": "name",
"value": "10% cashback return"
}
]
}
]
}{id}/translationsUpdate the content translations for an existing product
Path variables
The product (identifier) of which content translations will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The content translations for the specified language
The content (attribute) key
The content (attribute) translated value
Responses
The request has succeeded
PUT https://sandbox.crm.com/backoffice/v2/products/a42dd7c4-e755-92fb-963b-5f658a59908e/translations HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
[
{
"language_code": "EN",
"translations": [
{
"key": "name",
"value": "10% cashback return"
}
]
}
]
HTTP/1.1 204 No Content {id}/translations/actionsPerform content translation actions on a product (e.g. export a product’s translations)
Path variables
The product (identifier) of which content translation actions will be performed
Notes
Importing content translations should be made based on the following API order
Exporting content translations into different file should be made using the following API order
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The action that will be applied
The file (identifier) that will be used for importing translations (required only for import action)
The file (identifier) that will be used for importing translations (required only for import action)
The file (mime type) that will be used for exporting translations (required only for export action)
Responses
The request has succeeded
PUT https://sandbox.crm.com/backoffice/v2/products/a42dd7c4-e755-92fb-963b-5f658a59908e/translations/actions HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"action": "IMPORT",
"file": {
"id": "1e347d4d-ab96-6957-fdb6-35e72b3d9185"
}
}
HTTP/1.1 204 No Content PUT https://sandbox.crm.com/backoffice/v2/products/a42dd7c4-e755-92fb-963b-5f658a59908e/translations/actions HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"action": "EXPORT",
"file": {
"mime": "json"
}
}
HTTP/1.1 204 No Content Manage prices of prodcuts across the Product Catalogue. A product (regardles of its type, composition or classification) might have multiple prices. A price can be set for either a specific product or for all products within a family of products.
{id}/prices{id}/prices{id}/prices{id}/prices/{price_id}{id}/prices{id}/prices{id}/prices/{price_id}{id}/prices{id}/pricesAdd a new price of a product. Within a single Web API call, the price of a product can be specified in multiple currencies, therefore a single price is set up having multiple value; one for each supported currency. Each price has a set of price terms and a set of conditions that specified when the price will be applied.
Path variables
The product’s unique idetifier
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Price is valid as of this date. If not specified, then the new price is valid as of the date that it is created.
Set up one or more product price values. This set of price amounts must be set in the various supported currencies of the business. Setting up a price for the base currency is mandatory.
A single price is required when price model is set to Flat. Either a price or a set tiered prices must be specified
The flat price of a termed service goes out of contract. Applicable only when setting up a price for a termed service and as long as its price terms include a contract period. If not specified, then the service will still be invoiced with the same price when it goes out of contract
The price’s tiers required for Tiered/Volume/Stairstep models. Either a price or a tiered prices must be specified.
The lower tier in the price’s range. The first range’s tier must begin with 1. Then each subsequent range’s lower tier must have a value equal to the previous range’s upper tier +1.
The upper tier. Not rquired (and should remain empty in the last tier range).
The tiered price
Price when termed service goes out of contract. Applicable only when setting up a price for a termed service and as long as its price terms include a contract period. If not specified, then the service will still be invoiced with the same price when it goes out of contract
Defines a product’s default price. A product can optionally have a single default price that is the one presented by default to contacts e.g. on ordering
The type of the event
Delivered to the customer’s address
Picked up by the customer from a venue
Online sales of services
The sales model unique identifier used to
Applicable and required when setting up prices for Termed and One-time services. Price terms determine the terms based on which the consumer subscribes to such services. Also applicable and required when setting up the Rental price of a traceable physical good. In that case, the rental price requires a billing cycle and a rental expense that the contact is billed recurringly.
The service’s billing cycle.
Billing cycle duration
Billing cycle unit of time
Service to be auto-renewed at the end of its termed perior or it will get expired. Applicable and required only for termed services
Termed period duration set in number of billing cycles. Applicable and required only for termed service
How long the service will be in contract period
Contract period duration
Contract period unit of time
The service’s trial period. Applicable only for termed services. At the end of the trial period, the service turns into a paid one, i.e. its billing history begins
Trial period duration
Trial period unit of time
Billing model of the service.
Service is billed for the next billing cycle
Service is billed for the billing cycle that ends
Applicable and reuqired when the price’s Price Type is set to Rental. Rental price can only be set up for traceable physical goods. Only products classified as Expenses can be set up as the rental service since this is the service that will be added on a subscription and billed on a recurring basis.
List of Countries. Each country represents a contact’s Country of Agreement so price is applied based on to which country the contact registered to.
List of Segments that represent a list of Contacts on which the price will be applied. Either a list of Segments or a list of Contacts is specified.
Segment unique identifier
List of Contacts on which the price will be applied. Either a list of Segments or a list of Contacts is specified.
Contact unique identifier
The price is applied when the product is ordered as part of the specified Flex bundle/Composite product. Each product must have a price when sold individually and optionally a price when sold as part of a bundle/composite product. When setting the price of a termed service as a component, then in its price terms, only the billing period is applicable and required. The rest of the terms are inherited by the bundle product.
Applicable only when setting up the price of a Usage service. If specified, then the usage service’s prices is differentiated based on the product through which it was consumed. This product must either be a termed service or a one-time service product.
Responses
Body
The identifier of the new product price
POST https://sandbox.crm.com/backoffice/v2/products/{id}/prices HTTP/1.1
Content-Type: application/json
{
"price_model": "TIERED",
"valid_from": 1652553467,
"prices": [
{
"currency_code": "EUR",
"price": 9.99,
"out_of_contract": 11.99,
"tiers": [
{
"lower_tier": 1,
"upper_tier": 5,
"price": 8.99,
"out_of_contract": 9.99
}
]
}
],
"is_default": "true",
"tax_model": "TAX_INCLUSIVE",
"price_type": "SALE",
"supply_method": "DELIVERY",
"price_terms": {
"billing_period": {
"duration": 1,
"uot": "MONTHS"
},
"auto_renewed": true,
"terms_billing_cycles": 12,
"contract_period": {
"duration": 12,
"uot": "MONTHS"
},
"trial_period": {
"duration": "30",
"uot": "DAYS"
},
"billing_model": "PRE_BILL",
"rental_service_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
},
"country_code": [
"CYP"
],
"segments": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}
],
"contacts": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}
],
"bundle_product_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"used_via_product_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"sales_model_id": "caf332bc-4e90-47b5-a05d-142b264897b9"
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}{id}/pricesUpdates the existing price of a product. Within a single Web API call the price of a products in multiple currencies can be updated as well as the price’s conditions. When setting up a price in multiple currencies, then this price has multiple amounts (one for each currency) and the same set of conditions among all of these prices. The price in the base currency is mandatory.
Path variables
The product’s unique idetifier
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Price is valid from this date onwards
Set price amounts in the various supported currencies of the business. Setting up a price for the base currency is mandatory.
The price amount. A single price is set up when pricing model is set to Flat.
The flat price of a termed service goes out of contract. Applicable only when setting up a price for a termed service and as long as its price terms include a contract period. If not specified, then the service will still be invoiced with the same price when it goes out of contract
Tiered pricing amounts. Required fro Tiered/Volume/Stairstep pricing models. Either a price or a tiered prices must be specified.
The lower tier in the price’s range. The first range’s tier must begin with 1. Then each subsequent range’s lower tier must have a value equal to the previous range’s upper tier +1.
The upper tier. Not rquired (and should remain empty in the last tier range).
The tier range’s price
Price when termed service goes out of contract. Applicable only when setting up a price for a termed service and as long as its price terms include a contract period. If not specified, then the service will still be invoiced with the same price when it goes out of contract
The product’s default price. A single price can be set as the default one.
The sales model is the unique identifier used to calssify a product’s prcie
The type of the event
Delivered to the customer’s address
Picked up by the customer from a venue
Online sales of services
Applicable and required when setting up prices for Termed and One-time services. Price terms determine the terms based on which the consumer subscribes to such services. Also applicable and required when setting up the Rental price of a traceable physical good. In that case, the rental price requires a billing cycle and a rental expense that the contact is billed recurringly.
The service’s billing cycle.
Duration
Duration unit of time
Service to be auto-renewed at the end of its termed perior or it will get expired. Applicable and required only for termed services
Termed period duration set in number of billing cycles. Applicable and required only for termed service
How long the service will be in contract period
Duration
Duraiton unit of time
The service’s trial period. Applicable only for termed services. At the end of the trial period, the service turns into a paid one, i.e. its billing history begins
Duration
Billing model denots when the service will be billed;at the begining of each billing cycle or at the end of it.
Applicable and reuqired when the price’s Price Type is set to Rental. Rental price can only be set up for traceable physical goods. Only products classified as Expenses can be set up as the rental service since this is the service that will be added on a subscription and billed on a recurring basis.
List of Segments that represent a list of Contacts on which the price will be applied
Segment identifier
List of Contacts on which the price will be applied
Contact identifier
The price is applied when the product is ordered as part of the specified Flex bundle/Composite product. Each product must have a price when sold individually and optionally a price when sold as part of a bundle/composite product. When setting the price of a termed service as a component, then in its price terms, only the billing period is applicable and required. The rest of the terms are inherited by the bundle product.
Applicable only when setting up the price of a Usage service. If specified, then the usage service’s prices is differentiated based on the product through which it was consumed. This product must either be a termed service or a one-time service product.
The price’s label
Responses
Body
The identifier of the updated product price
PUT https://sandbox.crm.com/backoffice/v2/products/{id}/prices HTTP/1.1
Content-Type: application/json
{
"price_model": "TIERED",
"valid_from": 1652553467,
"prices": [
{
"currency_code": "EUR",
"price": 9.99,
"out_of_contract": 11.99,
"tiers": [
{
"lower_tier": 1,
"upper_tier": 5,
"price": 8.99,
"out_of_contract": 9.99
}
]
}
],
"is_default": "true",
"tax_model": "TAX_INCLUSIVE",
"price_type": "SALE",
"sales_model_id": "caf332bc-4e90-47b5-a05d-142b264897b9",
"supply_method": "DELIVERY",
"country_code": "CYP",
"price_terms": {
"billing_period": {
"duration": 1,
"uot": "MONTHS"
},
"auto_renewed": true,
"terms_billing_cycles": 12,
"contract_period": {
"duration": 12,
"uot": "MONTHS"
},
"trial_period": {
"duration": "30",
"uot": "DAYS"
},
"billing_model": "PRE_BILL",
"rental_service_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
},
"segments": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}
],
"contacts": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}
],
"bundle_product_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"used_via_product_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}{id}/pricesGet a list of prices of a specific product. The Web API returns the price which is valid on the date the method is called (in case a price undergone price changes or it is scheduled to change).If a price is set up in multiple currencies, then each price amount per currency is returned as an individual price.
Path variables
The product’s unique identifier
Request parameters
The price model
Search for prices of a specific currency
Search for prices applied for a specific Country of agreement
Price applied for a specific supply method
Delivered to the customer’s address
Picked up by the customer from a venue
Online sales of services
Search for Rental or Sale prices
Prices applied for contacts in one or more Segments
Prices applied for one or more contacts
Search for a price based on its terms’ billing cycle
Applicable and required only when a billing period parameter is specified
Search for a product price when sold as part of a bundle/composite product
Search for a product price of a usage service when consumed as part of a termed/one-time service
Search for the default price of the prioduct, if any is set.
Search for product prices that include usage allowance
Search for price terms that offer a trial period (of any duration) to contacts
Price valid at a specific period of time
Price is Tax inclusive or not.
Price set up in multiple currencies or not.
The price’s label
The sales model is the unique identifier
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
Price is valid from this date onwards
Set price amounts in the various supported currencies of the business. Setting up a price for the base currency is mandatory.
The price amount. A single price is set up when pricing model is set to Flat.
The flat price of a termed service goes out of contract. Applicable only when setting up a price for a termed service and as long as its price terms include a contract period. If not specified, then the service will still be invoiced with the same price when it goes out of contract
Tiered pricing amounts. Required fro Tiered/Volume/Stairstep pricing models. Either a price or a tiered prices must be specified.
The lower tier in the price’s range. The first range’s tier must begin with 1. Then each subsequent range’s lower tier must have a value equal to the previous range’s upper tier +1.
The upper tier. Not rquired (and should remain empty in the last tier range).
The tier range’s price
Price when termed service goes out of contract. Applicable only when setting up a price for a termed service and as long as its price terms include a contract period. If not specified, then the service will still be invoiced with the same price when it goes out of contract
Price applied per measurement unit. Applicable only for prices of Usage Services
Measurement unit identifier
Measurement unit name
Measurement unit display name
The sales model is the unique identifier used to calssify a product’s prcie
The sales model unique identifier
The sales model name which has to be unique across all sales models
The type of the event
Delivered to the customer’s address
Picked up by the customer from a venue
Online sales of services
Applicable and required when setting up prices for Termed and One-time services. Price terms determine the terms based on which the consumer subscribes to such services. Also applicable and required when setting up the Rental price of a traceable physical good. In that case, the rental price requires a billing cycle and a rental expense that the contact is billed recurringly.
The service’s billing cycle.
Duration
Duration unit of time
Service to be auto-renewed at the end of its termed perior or it will get expired. Applicable and required only for termed services
Termed period duration set in number of billing cycles. Applicable and required only for termed service
How long the service will be in contract period
Duration
Duraiton unit of time
The service’s trial period. Applicable only for termed services. At the end of the trial period, the service turns into a paid one, i.e. its billing history begins
Duration
Billing model denots when the service will be billed;at the begining of each billing cycle or at the end of it.
Applicable and reuqired when the price’s Price Type is set to Rental. Rental price can only be set up for traceable physical goods. Only products classified as Expenses can be set up as the rental service since this is the service that will be added on a subscription and billed on a recurring basis.
Product identifier
Product SKU
Product name
List of Countries in which the price is applied. This setting is validated agianst the contact’s Country of Agreement in order to decide which price to apply
List of Segments that represent a list of Contacts on which the price will be applied
Segment identifier
Segment name
List of Contacts on which the price will be applied
Contact identifier
Contact name
Contact Code
The price is applied when the product is ordered as part of the specified Flex bundle/Composite product. Each product must have a price when sold individually and optionally a price when sold as part of a bundle/composite product. When setting the price of a termed service as a component, then in its price terms, only the billing period is applicable and required. The rest of the terms are inherited by the bundle product.
Product identifier
Product SKU
Product name
Applicable only when setting up the price of a Usage service. If specified, then the usage service’s prices is differentiated based on the product through which it was consumed. This product must either be a termed service or a one-time service product.
Product identifier
Product SKU
Product name
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/products/{id}/prices HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"price_model": "TIERED",
"valid_from": 1652553467,
"prices": [
{
"currency_code": "EUR",
"price": 9.99,
"out_of_contract": 11.99,
"tiers": [
{
"lower_tier": 1,
"upper_tier": 5,
"price": 8.99,
"out_of_contract": 9.99
}
],
"measurement_unit": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "Gigabytes",
"display_name": "GB"
}
}
],
"tax_model": "TAX_INCLUSIVE",
"price_type": "SALE",
"sales_model": {
"id": "caf332bc-4e90-47b5-a05d-142b264897b9",
"name": "Retail"
},
"supply_method": "DELIVERY",
"price_terms": {
"billing_period": {
"duration": 1,
"uot": "MONTHS"
},
"auto_renewed": true,
"terms_billing_cycles": 12,
"contract_period": {
"duration": 12,
"uot": "MONTHS"
},
"trial_period": {
"duration": "30",
"uot": "DAYS"
},
"billing_model": "PRE_BILL",
"rental_service": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"sku": "RFEE",
"name": "Rental Fee"
}
},
"countries": [
"CYP"
],
"segments": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "VIP"
}
],
"contacts": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "John Smith",
"code": "C000101011"
}
],
"bundle_product": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"sku": "3PLAY",
"name": "3Play"
},
"used_via_product": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"sku": "5GBDAY",
"name": "Daily 5GB Now!"
}
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}/prices/{price_id}Delete an existing product price. When deleting the price in the base currency and at the same time the same price is also specified in other currencies, then this results in deleting all of the price amounts as well.
Path variables
Product nique identifier
Price unique identifier
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
DELETE https://sandbox.crm.com/backoffice/v2/products/4dc0809f-ed91-4b68-b912-5bd6064d901e/prices/2ac0809f-ed91-4b68-b912-5bd6064e981a HTTP/1.1
HTTP/1.1 204 No Content Returns a list of all prices of the product catalogue, regardless of the products. Use this Web API to search for all prices of a product or a group of products, or prices for a specific pricing area.
Request parameters
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Returns prices configured for a specific contact
Returns prices configured for a specific Segment
Search for prices applied to contacts with the specified Country of agreement
Returns prices configured for a specific Sales Model
Returns prices of a specific product
Returns prices of a specific product type
Returns prices of a specific product brand
Returns prices of a specific product family
Returns prices of a product classification
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
List of prices for quantity-based price models
The type of the event
Delivered to the customer’s address
Picked up by the customer from a venue
Online sales of services
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/prices HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"product": {
"id": "",
"sku": "",
"name": "",
"description": "",
"classification": "TRACEABLE_PHYSICAL_GOOD"
},
"price": {
"id": "",
"label": "",
"price_model": "TIERED",
"prices": [
{
"price": 8.99,
"currency_code": "EUR",
"tiers": [
{
"lower_tier": 1,
"upper_tier": 5,
"price": 9.99
}
]
}
],
"tax_model": "TAX_INCLUSIVE",
"measurement_unit": {
"id": "",
"name": "",
"display_name": ""
},
"price_type": "SALE",
"supply_method": "DELIVERY",
"sales_model": {
"id": "",
"name": ""
},
"segments": [
{
"id": "",
"name": ""
}
],
"contact": [
{
"id": "",
"code": "",
"name": ""
}
],
"agrement_countries": [
"CYP"
],
"price_terms": {
"billing_period": {
"duration": 1,
"uot": ""
},
"auto_renew": true,
"terms_billing_cycles": 1,
"billing_model": "POST_BILL",
"contract_period": {
"duration": 1,
"uot": ""
},
"trial_period": {
"duration": 1,
"uot": ""
}
}
}
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}Performs a bulk updated on multiples prices in one go.
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
["123"]["CYP"]Responses
PUT https://sandbox.crm.com/backoffice/v2/prices/bulk HTTP/1.1
Content-Type: application/json
[
{
"id": "",
"label": "",
"price_model": "TIERED",
"prices": [
{
"price": 8.99,
"currency_code": "EUR",
"tiers": [
{
"lower_tier": 1,
"upper_tier": 5,
"price": 9.99
}
]
}
],
"tax_model": "TAX_INCLUSIVE",
"price_type": "SALE",
"supply_method": "DELIVERY",
"sales_model_id": "",
"segments": [
"123"
],
"contacts": [
""
],
"agrement_countries": [
"CYP"
],
"price_terms": {
"billing_period": {
"duration": "",
"uot": ""
},
"auto_renew": true,
"terms_billing_cycles": 1,
"billing_model": "POST_BILL",
"contract_period": {
"duration": 1,
"uot": ""
},
"trial_period": {
"duration": 1,
"uot": ""
}
}
}
]
HTTP/1.1 200 OK {id}/pricesAdds new prices to a product family. Within a single Web API call, the same price in multiple currencies can be added for a product family. Maintaining a price in the base currency of the business is required, so adding a price in that currency is mandatory.
Path variables
The product family’s unique idetifier
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Price is valid from this date onwards
Set price amounts in the various supported currencies of the business. Setting up a price for the base currency is mandatory.
The price amount. A single price is set up when pricing model is set to Flat.
Tiered pricing amounts. Required fro Tiered/Volume/Stairstep pricing models. Either a price or a tiered prices must be specified.
The lower tier in the price’s range. The first range’s tier must begin with 1. Then each subsequent range’s lower tier must have a value equal to the previous range’s upper tier +1.
The upper tier. Not rquired (and should remain empty in the last tier range).
The tier range’s price
The sales model is the unique identifier used to calssify a product’s prcie
The type of the event
Delivered to the customer’s address
Picked up by the customer from a venue
Online sales of services
List of Segments that represent a list of Contacts on which the price will be applied
Segment identifier
List of Contacts on which the price will be applied
Contact identifier
Responses
Body
The identifier of the new price of the product family
POST https://sandbox.crm.com/backoffice/v2/product_families/{id}/prices HTTP/1.1
Content-Type: application/json
{
"price_model": "TIERED",
"valid_from": 1652553467,
"prices": [
{
"currency_code": "EUR",
"price": 9.99,
"tiers": [
{
"lower_tier": 1,
"upper_tier": 5,
"price": 8.99
}
]
}
],
"tax_model": "TAX_INCLUSIVE",
"price_type": "SALE",
"sales_model_id": "caf332bc-4e90-47b5-a05d-142b264897b9",
"supply_method": "DELIVERY",
"country_code": "CYP",
"segments": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}
],
"contacts": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}
]
}{id}/pricesUpdates the price of products of a specific family. Within a single update, the same price in multiple currencies can be updated. Maintaining a price in the base currency of the business is required, so that price cannot be removed, whereas prices in an other suported currency can be updated/removed.
Path variables
The product family’s unique idetifier
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Price is valid from this date onwards
Set price amounts in the various supported currencies of the business. Setting up a price for the base currency is mandatory.
The price amount. A single price is set up when pricing model is set to Flat.
Tiered pricing amounts. Required fro Tiered/Volume/Stairstep pricing models. Either a price or a tiered prices must be specified.
The lower tier in the price’s range. The first range’s tier must begin with 1. Then each subsequent range’s lower tier must have a value equal to the previous range’s upper tier +1.
The upper tier. Not rquired (and should remain empty in the last tier range).
The tier range’s price
The sales model is the unique identifier used to calssify a product’s prcie
The type of the event
Delivered to the customer’s address
Picked up by the customer from a venue
Online sales of services
List of Segments that represent a list of Contacts on which the price will be applied
Segment identifier
List of Contacts on which the price will be applied
Contact identifier
Responses
Body
The unique identifier of the price of the product family
PUT https://sandbox.crm.com/backoffice/v2/product_families/{id}/prices HTTP/1.1
Content-Type: application/json
{
"price_model": "TIERED",
"valid_from": 1652553467,
"prices": [
{
"currency_code": "EUR",
"price": 9.99,
"tiers": [
{
"lower_tier": 1,
"upper_tier": 5,
"price": 8.99
}
]
}
],
"tax_model": "TAX_INCLUSIVE",
"price_type": "SALE",
"sales_model": "RETAIL",
"supply_method": "DELIVERY",
"country_code": "CYP",
"segments": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}
],
"contacts": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}
]
}{id}/prices/{price_id}Deletes a price of a product family. Deleting a price in the based currency and at the same time keeping the same price in any other supported currency is not allowed.
Path variables
Product family uique identifier
Price unique identifier
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
DELETE https://sandbox.crm.com/backoffice/v2/product_families/{id}/prices/{price_id} HTTP/1.1
HTTP/1.1 204 No Content {id}/pricesGet a list of all prices of a specific product family
Path variables
The product family’s unique identifier
Request parameters
Delivered to the customer’s address
Picked up by the customer from a venue
Online sales of services
The sales model is the unique identifier used to calssify a product’s prcie
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
Price is valid from this date onwards
Set price amounts in the various supported currencies of the business. Setting up a price for the base currency is mandatory.
The price amount. A single price is set up when pricing model is set to Flat.
Tiered pricing amounts. Required fro Tiered/Volume/Stairstep pricing models. Either a price or a tiered prices must be specified.
The lower tier in the price’s range. The first range’s tier must begin with 1. Then each subsequent range’s lower tier must have a value equal to the previous range’s upper tier +1.
The upper tier. Not rquired (and should remain empty in the last tier range).
The tier range’s price
Price applied per measurement unit. Applicable only for prices of Usage Services
Measurement unit identifier
Measurement unit name
Measurement unit display name
The sales model is the unique identifier used to calssify a product’s prcie
The sales model unique identifier
The sales model name which has to be unique across all sales models
The type of the event
Delivered to the customer’s address
Picked up by the customer from a venue
Online sales of services
List of Segments that represent a list of Contacts on which the price will be applied
Segment identifier
Segment name
List of Contacts on which the price will be applied
Contact identifier
Contact name
Contact Code
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/product_families/4dc0809f-ed91-4b68-b912-5bd6064d901e/prices HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"price_model": "TIERED",
"valid_from": 1652553467,
"prices": [
{
"currency_code": "EUR",
"price": 9.99,
"tiers": [
{
"lower_tier": 1,
"upper_tier": 5,
"price": 8.99
}
],
"measurement_unit": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "Gigabytes",
"display_name": "GB"
}
}
],
"tax_model": "TAX_INCLUSIVE",
"price_type": "SALE",
"sales_model": {
"id": "caf332bc-4e90-47b5-a05d-142b264897b9",
"name": "Retail"
},
"supply_method": "DELIVERY",
"country_code": "CYP",
"segments": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "VIP"
}
],
"contacts": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "John Smith",
"code": "C000101011"
}
]
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}Promotions provide a discount to contacts, usually when a set od conditions are met such as when, where and which products are ordered by the contacts. A promotion has offerrings that include, apart from the discount amount/percentage, the discounted products and whether the discount will be applied per product or at invoice level.
{id}{id}{id}{id}/media_groupsCreate a new Promotion. A single Promotion can be created per Web API call. When created, the Promotion is set to Inactive state and will have to be activated in a separate Web API call.
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Promotion name. The name must be unique
A short description for the Promotion
A long description for the Promotion
Determines the period of time during which the Promotion will be applied on ordering services and physical goods.
The date from which the Promotion will be applied
The date until which the Promotion will be applied on ordering. If not specified, then the Promotion will always be applied
Promotion Targets. Optional informaiton that can be used to address the promotion to specific contact and location targets
[
" 4dc0809f-ed91-4b68-b912-5bd6064d901e"
]Promotion is applied if the purchase is performed within the specified period off time. Either a fixed period or promotion availability must be specified
Promotion applied if purchase is performed from this date (inclusive) and onwards
If pseicifed, then purchase must be performed up until this date. Optional.
Promotion is applied if the purchase is performed within the specified day(s), month(s) and/or times. Either a fixed period or promotion availability must be specified. Each availibility option should be unique
Starting time
End time
Day of week. Allowed values 1 to 7, where 1 is Sunday
Month during which protion is applied. Allowed values 1-12 where 1 is January
Rules that -if specified- should be met in order for the Promotion to be applied.
Contact should pay using one of the specified payment method types to get the offerring
The type of the event
Purchase is fulfiflled using one of the specified supply methods for the contact to get the offering
The type of the event
Delivered to the customer’s address
Picked up by the customer from a venue
Online sales of services
Minimum required basket total amount for the promotion to be applied. The amount is always set in the business’s base currency
Miminum required quantity of basket items
Products that should be included in the basket for the Promotion to be applied. Product conditions are defined as groups of conditions. In Each group there’s a product setting and the conditions that should be met. Multiple groups can be added, logically separated by AND/OR operators.
Group of product conditions.
The group’s name. Each group name must be unique
Logical operator used amount the product conditions
List of product conditions. Mulitple conditions can be added, each one referring to a single product. All product conditions mus tbe met to apply the promotion
The product that should be included in the basket
Product settings must be one fot he following
The identifier of the product/type/brand/family.
The minimum required quantity of items to be included in the basket for the promotion to be applied
The minimum required basket items cost. Cost is defined in the business’s base currency
The billing cycle of the basket item. Applicable only for termed services. The billing cycle is the one specified in the service’s price terms selected on ordering
Billing cycle duration
Billin cycle unit of time
The contract period of the basket item. Applicable only for termed services. The contract period is the one specified in the service’s price terms selected on ordering
Contract period duration
Contract period unti of time
List of services to which a contact must already be subscribed to in order to get the promotion. Only termed services can be specified. Available and applicable only when the basket item is a termed service or a product type of Termed service classification.
The termed service product identifier
Minimum required subscription service quantity to get the promotion
The promotion’s offerrings. At least one must be specified
Defines whether the offering is an actual discount amount or a discount percentage
The discount amount or percentage. Monetaty amounts are always set in the business’s base currency
The product on which the discount will be applied
Each item must be one of the following types
The item’s identifier
How long the offering will be applied. Applicable only when the offering’s product is a termed service
Indicates whether the offering will be applied once, for period of time or forever.
Discount applied once
Discount applied in a limited number of billing cycles
Discount applied forever
Applicable and required only when the offering will be applied for a specific PERIOD
The period’s duration
The period’s unit of time
Responses
Body
The unique identifier of the new Promotion
POST https://sandbox.crm.com/backoffice/v2/promotions HTTP/1.1
Content-Type: application/json
{
"name": "Sales season",
"short_description": "£10 off during Sales season",
"long_description": "£10% off on all products during Summaer sales season",
"availability": {
"from_date": 1648067185,
"to_date": 1648067185
},
"targets": {
"segments": [
"4dc0809f-ed91-4b68-b912-5bd6064d901e"
],
"organisations": [
"4dc0809f-ed91-4b68-b912-5bd6064d901e"
],
"timings": {
"fixed_period": {
"start_date": 1648067185,
"end_date": 1648067185
},
"availability": [
{
"start_time": "13:00",
"end_time": "14:00",
"day": 1,
"month": 1
}
]
}
},
"basket": {
"rules": {
"payment_method_types": [
"CARD"
],
"supply_methods": [
"DELIVERY"
],
"value": 9.99,
"quantity": 5
},
"products": {
"groups": [
{
"group": "G1",
"operator": "AND",
"conditions": [
{
"operator": "OR",
"condition": "",
"product": {
"item_type": "SKU",
"item_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
},
"quantity": 1,
"value": 9.99,
"billing_cycle": {
"duration": 1,
"uot": "DAY"
},
"contract_period": {
"duration": 12,
"uot": "MONTH"
},
"services": [
{
"id": "1af94364-b0f2-d656-aed6-bd3e3978cab4",
"quantity": 2
}
]
}
]
}
]
}
},
"offerings": [
{
"type": "AMOUNT",
"amount": 1.99,
"product": {
"item_type": "SKU",
"item_id": "2f6a70b6-84d4-2859-d230-093cb7e95c62"
},
"duration": {
"type": "PERIOD",
"period": {
"duration": 6,
"uot": "MONTH"
}
}
}
]
}{id}Updates an existing Promotion. A single Promotion can be updated per Web API call.
Path variables
Promotion identifier
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Promotion name which has to be unique
A short description for the Promotion
A long description for the Promotion
The promotion’s state
Promotion can be applied on ordering
Inactive Promotions not applied even if conditions are met.
Determines the period of time during which the Promotion will be applied on ordering services and physical goods.
The date from which the Promotion will be applied
The date until which the Promotion will be applied on ordering. If not sepcified, then the Promotion will always be applied
Promotion Targets. Optional information that can be used to address the promotion to specific contact and location targets
[
" 4dc0809f-ed91-4b68-b912-5bd6064d901e"
]Promotion is applied if the purchase is performed within the specified period off time. Either a fixed period or promotion availability must be specified
Promotion applied if purchase is performed from this date (inclusive) and onwards
If pseicifed, then purchase must be performed up until this date. Optional.
Promotion is applied if the purchase is performed within the specified day(s), month(s) and/or times. Either a fixed period or promotion availability must be specified. Each availibility option should be unique
Starting time
End time
Day of week. Allowed values 1 to 7, where 1 is Sunday
Month during which protion is applied. Allowed values 1-12 where 1 is January
Rules that -if specified- should be met in order for the Promotion to be applied.
Contact should pay using one of the specified payment method types to get the offerring
The type of the event
Purchase is fulfiflled using one of the specified supply methods for the contact to get the offering
The type of the event
Delivered to the customer’s address
Picked up by the customer from a venue
Online sales of services
Minimum required basket total amount for the promotion to be applied. The amount is always set in the business’s base currency
Miminum required quantity of basket items
Products that should be included in the basket for the Promotion to be applied. Product conditions are defined as groups of conditions. In Each group there’s a product setting and the conditions that should be met. Multiple groups can be added, logically separated by AND/OR operators.
Group of product conditions.
The group’s name. Each group name must be unique
Logical operator used amount the product conditions
List of product conditions. Mulitple conditions can be added, each one referring to a single product. All product conditions mus tbe met to apply the promotion
The product that should be included in the basket
Product settings must be one fot he following
The identifier of the product/type/brand/family.
The minimum required quantity of items to be included in the basket for the promotion to be applied
The minimum required basket items cost. Cost is defined in the business’s base currency
The billing cycle of the basket item. Applicable only for termed services. The billing cycle is the one specified in the service’s price terms selected on ordering
Billing cycle duration
Billin cycle unit of time
The contract period of the basket item. Applicable only for termed services. The contract period is the one specified in the service’s price terms selected on ordering
Contract period duration
Contract period unti of time
List of services to which a contact must already be subscribed to in order to get the promotion. Only termed services can be specified. Available and applicable only when the basket item is a termed service or a product type of Termed service classification.
The termed service product identifier
Minimum required subscription service quantity to get the promotion
The promotion’s offerrings. At least one must be specified
Defines whether the offering is an actual discount amount or a discount percentage
The discount amount or percentage. Monetaty amounts are always set in the business’s base currency
The product on which the discount will be applied
Each item must be one of the following types
The item’s identifier
How long the offering will be applied. Applicable only when the offering’s product is a termed service
Indicates whether the offering will be applied once, for period of time or forever.
Discount applied once
Discount applied in a limited number of billing cycles
Discount applied forever
Applicable and required only when the offering will be applied for a specific PERIOD
The period’s duration
The period’s unit of time
Responses
Body
The unique identifier of the updated Promotion
PUT https://sandbox.crm.com/backoffice/v2/promotions/4dc0809f-ed91-4b68-b912-5bd6064d901e HTTP/1.1
Content-Type: application/json
{
"name": "Sales season",
"short_description": "£10 off during Sales season",
"long_description": "£10% off on all products during Summaer sales season",
"state": "ACTIVE",
"availability": {
"from_date": 1648067185,
"to_date": 1648067185
},
"targets": {
"segments": [
"4dc0809f-ed91-4b68-b912-5bd6064d901e"
],
"organisations": [
"4dc0809f-ed91-4b68-b912-5bd6064d901e"
],
"timings": {
"fixed_period": {
"start_date": 1648067185,
"end_date": 1648067185
},
"availability": [
{
"start_time": "13:00",
"end_time": "14:00",
"day": 1,
"month": 1
}
]
}
},
"basket": {
"rules": {
"payment_method_types": [
"ELECTRONIC_TRANSFER"
],
"supply_methods": [
"DELIVERY"
],
"value": 9.99,
"quantity": 5
},
"products": {
"groups": [
{
"group": "G1",
"operator": "AND",
"conditions": [
{
"operator": "OR",
"condition": "",
"product": {
"item_type": "SKU",
"item_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
},
"quantity": 1,
"value": 9.99,
"billing_cycle": {
"duration": 1,
"uot": "DAY"
},
"contract_period": {
"duration": 12,
"uot": "MONTH"
},
"services": [
{
"id": "1af94364-b0f2-d656-aed6-bd3e3978cab4",
"quantity": 2
}
]
}
]
}
]
}
},
"offerings": [
{
"type": "AMOUNT",
"amount": 1.99,
"product": {
"item_type": "SKU",
"item_id": "2f6a70b6-84d4-2859-d230-093cb7e95c62"
},
"duration": {
"type": "PERIOD",
"period": {
"duration": 6,
"uot": "MONTH"
}
}
}
]
}{id}Deletes an existing Promotion. Deletion includes deleting all information of the promotion including target and basket conditions and offerrings. A Promotion cannot be deleted if it was applied to a termed service and that service still has some period left to benefit from the Promotion.
Path variables
The unique identifier of the Promotion
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
DELETE https://sandbox.crm.com/backoffice/v2/promotions/4dc0809f-ed91-4b68-b912-5bd6064d901e HTTP/1.1
HTTP/1.1 204 No Content Returns a list of promotions that can be applied per organisation, for specific period etc
Request parameters
The state of the promotion
Required if a list of discounted items is specified. Indicates if the item is a product or a product type, brand, family or category.
Items that get a discount from the promotions. The list includes a set of identifiers. All of the identifiers must have the same “item_type”.
[
" 4dc0809f-ed91-4b68-b912-5bd6064d901e"
]List of customer segments
Search for an promotion using its name
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
The unique identifier of the Promotion
The Promotion’s name
A short description for the Promotion
A more detailed description of the Promotion and its targets/offerrings
The Promotion’s state
When the Promotion is available that means that it is applied only during the specified period.
Promotion applied as of the start date
Promotion applied up until this date, if specified
The creative identifier
Information about the creative type
Partner logos configurable by SO, applicable for Business, Merchant, Venue
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
The creative width
The creative height
The creative format
The creative content URL
The creative public identifier
Information about the creative transformations
The transformed creative width
The transformed creative height
The transformed creative URL
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/promotions HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "20% Xmas",
"short_description": "20% off during Xmas time",
"long_description": "20% off, unconditional avialable during Xmas time and up until the end of year",
"state": "ACTIVE",
"availability": {
"from_date": 1648067185,
"to_date": 1648067185
},
"creatives": [
{
"id": "3caf8388-b9c6-6679-1e9b-94a6fda92a41",
"usage_type": "DELIVERY_IMAGE",
"width": 2159,
"height": 3075,
"format": "jpg",
"url": "https://assets.crm.com/image/logo.jpg",
"public_id": "crm-com/image",
"media": [
{
"width": 200,
"height": 300,
"url": "https://asset.crm.com/image/offer/c_scale,w_200/logo.jpg"
}
]
}
]
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Retrieves detailed information for a Promotion
Path variables
Promotion identifier
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
Unique identifier of the Promotion
Promotion name
Promotion’s state. The Promotion must be in Active state in order to be applied on ordering
Short description for the Promotion
More detailed description of the Promotion
Determines when the Promotion will be applied on products ordering.
Contacts get the Promotion on orders performed from this date onward
Promotion applied on orders up until this date
Conditions that should be met for contacts to benefit from the Promotion. Set of conditions include who (segment), where (orgnaisations) and when (timings) services or physical goods should be ordered to get the Promotin’s discount.
The unique identifier of the Segment
The name of the Segment
The unique identifier of the Organisation
The name of the Organisation
Promotion is applied if the purchase is performed within the specified period off time. Either a fixed period or promotion availability must be specified
Promotion applied if purchase is performed from this date (inclusive) and onwards
If specified, then purchase must be performed up until this date. Optional.
Promotion is applied if the purchase is performed within the specified day(s), month(s) and/or times. Either a fixed period or promotion availability must be specified. Each availibility option should be unique
Day of the week.Allowed values 1 to 7, where 1 is Sunday
Month of year. Allowed values 1 to 12, where 1 is Januaryt
Starting time
End time
Rules that -if specified- should be met in order for the Promotion to be applied.
Contact should pay using one of the specified payment method types to get the offerring
The type of the event
Purchase is fulfiflled using one of the specified supply methods for the contact to get the offering
The type of the event
Delivered to the customer’s address
Picked up by the customer from a venue
Online sales of services
Minimum required basket total amount for the promotion to be applied. The amount is always set in the business’s base currency
Miminum required quantity of basket items
Products that should be included in the basket for the Promotion to be applied. Product conditions are defined as groups of conditions. In Each group there’s a product setting and the conditions that should be met. Multiple groups can be added, logically separated by AND/OR operators.
Group of product conditions.
The group’s name. Each group name must be unique
Logical operator used amount the product conditions
List of product conditions. Mulitple conditions can be added, each one referring to a single product. All product conditions mus tbe met to apply the promotion
The product that should be included in the basket
The identifier of the product/type/brand/family.
The product’s SKU. Applicable only when item type is set to Product
The name of the product/type/brand/family
The minimum required quantity of items to be included in the basket for the promotion to be applied
The minimum required basket items cost. Cost is defined in the business’s base currency
The billing cycle of the basket item. Applicable only for termed services. The billing cycle is the one specified in the service’s price terms selected on ordering
Billing cycle duration
Billing cycle unit of time
The contract period of the basket item. Applicable only for termed services. The contract period is the one specified in the service’s price terms selected on ordering
Contract period duration
Contract period unti of time
List of services to which a contact must already be subscribed to in order to get the promotion. Only termed services can be specified. Available and applicable only when the basket item is a termed service or a product type of Termed service classification.
Termed service product identifier
Product SKU
Product name
Minimum reuqired subscirpiton service quantity to get the promotion
Defines whether the offerring is an actual discount amount or a discount percentage
The discount amount or percentage depending on the offerring’s type
The product on which the discount will be applied
Determines on which product the discount will be applied.
The unique identifier of the product item
The product’s SKU. Applicable only for SKU item types
The product/type/brand/family name
How long the offering will be applied. Applicable only when the offerring’s product is a termed service
Indicates whether the offerring will be applied once, for period fo time or forever.
Applicable and required nly when the offeering ill be applied for a specific PERIOD
The period’s duration
The period’s unit of time
The creative identifier
Information about the creative type
Partner logos configurable by SO, applicable for Business, Merchant, Venue
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
The creative width
The creative height
The creative format
The creative content URL
The creative public identifier
Information about the creative transformations
The transformed creative width
The transformed creative height
The transformed creative URL
GET https://sandbox.crm.com/backoffice/v2/promotions/4dc0809f-ed91-4b68-b912-5bd6064d901e HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "Sales season",
"state": "ACTIVE",
"short_description": "£10 off",
"long_description": "Get as £10 off for your Orders during this year's Summer Sales season!",
"availability": {
"from_date": 1649231923,
"to_date": 1649231924
},
"targets": {
"segments": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "VIP contacts"
}
],
"organisations": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "Good Burgers"
}
],
"timings": {
"fixed_period": {
"start_date": 1648067185,
"end_date": 1648067185
},
"availability": [
{
"day": 1,
"month": 1,
"start_time": "13:00",
"end_time": "14:00"
}
]
}
},
"barket": {
"rules": {
"payment_method_type": [
"WALLET"
],
"supply_method": [
"DELIVERY"
],
"value": 9.99,
"quantity": 5
},
"products": {
"groups": [
{
"group": "G1",
"operator": "AND",
"conditions": [
{
"operator": "OR",
"condition": "",
"product": {
"item_type": "SKU",
"item_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"sku": "HDSTB123",
"name": "HD STB"
},
"quantity": 1,
"value": 9.99,
"billing_cycle": {
"duration": 1,
"uot": "DAY"
},
"contract_period": {
"duration": 12,
"uot": "MONTH"
},
"services": [
{
"id": "1af94364-b0f2-d656-aed6-bd3e3978cab4",
"sku": "TV001",
"name": "Films",
"quantity": 2
}
]
}
]
}
]
}
},
"offerings": [
{
"type": "AMOUNT",
"amount": 1.99,
"product": {
"item_type": "TYPE",
"item_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"sku": "STB12345",
"name": "HD STB"
},
"duration": {
"type": "PERIOD",
"period": {
"duration": 6,
"uot": "MONTH"
}
}
}
],
"creatives": [
{
"id": "3caf8388-b9c6-6679-1e9b-94a6fda92a41",
"usage_type": "BACKGROUND",
"width": 2159,
"height": 3075,
"format": "jpg",
"url": "https://assets.crm.com/image/logo.jpg",
"public_id": "crm-com/image",
"media": [
{
"width": 200,
"height": 300,
"url": "https://asset.crm.com/image/offer/c_scale,w_200/logo.jpg"
}
]
}
]
}{id}/media_groupsLink a promotion with one or more media groups
Path variables
The promotion (identifier) that media groups will be set
Notes
Uploading media for a promotion requires the execution of the following APIs
- Create new Media Group
- Create Promotion Media Groups
- Upload Media
- Perform Cloudinary Upload (where CRM will send all signature details)
- Cloudinary service calls back CRM media group (using an internal callback)
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The media group identifier
Responses
POST https://sandbox.crm.com/backoffice/v2/promotions/3f1f9e63-7f40-4e5e-bc42-11a162f7f1fb/media_groups HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
[
{
"media_group_id": "3f1f9e63-7f40-4e5e-bc42-11a162f7f1fb"
}
]
HTTP/1.1 204 No Content {id}/translations{id}/translations{id}/translations/actions{id}/translationsUpdate the content translations for an existing promotion
Path variables
The promotion (identifier) of which content translations will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The content translations for the specified language
The content (attribute) key
The content (attribute) translated value
Responses
The request has succeeded
PUT https://sandbox.crm.com/backoffice/v2/promotions/a42dd7c4-e755-92fb-963b-5f658a59908e/translations HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
[
{
"language_code": "EN",
"translations": [
{
"key": "name",
"value": "10% cashback return"
}
]
}
]
HTTP/1.1 204 No Content {id}/translationsRetrieve the content translations for an existing promotion
Path variables
The promotion (identifier) of which content translations will be retrieved
Request parameters
Filter based on language
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The content translations for the specified language
The content (attribute) key
The content (attribute) translated value
GET https://sandbox.crm.com/backoffice/v2/promotions/a42dd7c4-e755-92fb-963b-5f658a59908e/translations HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"language_code": "EN",
"translations": [
{
"key": "name",
"value": "10% cashback return"
}
]
}
]
}{id}/translations/actionsPerform content translation actions on a promotion (e.g. export a promotion’s translations)
Path variables
The promotion (identifier) of which content translation actions will be performed
Notes
Importing content translations should be made based on the following API order
Exporting content translations into different file should be made using the following API order
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The action that will be applied
The file (identifier) that will be used for importing translations (required only for import action)
The file (identifier) that will be used for importing translations (required only for import action)
The file (mime type) that will be used for exporting translations (required only for export action)
Responses
The request has succeeded
PUT https://sandbox.crm.com/backoffice/v2/promotions/a42dd7c4-e755-92fb-963b-5f658a59908e/actions HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"action": "IMPORT",
"file": {
"id": "1e347d4d-ab96-6957-fdb6-35e72b3d9185"
}
}
HTTP/1.1 204 No Content PUT https://sandbox.crm.com/backoffice/v2/promotions/a42dd7c4-e755-92fb-963b-5f658a59908e/actions HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"action": "EXPORT",
"file": {
"mime": "json"
}
}
HTTP/1.1 204 No Content An Order Catalogue is a sub-set of the Product Catalogue. An Order Catalogue is created by an Organisation to be used for ordering purposes on front-end systems like mobile apps and portals. So consumers are able to order products from various Order Catalogues depending on the day or time or organisation from which they are ordering products.
{id}{id}{id}{id}/media_groupsCreate a new Order Catalogue. Once created, the catalogue will be in Inactive state i.e. still not available durng the Ordering process and needs to be activated in a separate call. Within the catalogue products are included in Categories and their sub-categories. Either a category or its sub-categories must include products. The priority of products can also be set. Products that cannot be included in Order Catalogues
- Usage Services
- Expenses
- Modifiers
- Variants
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The name of the Order Catalogue. The name should be unique across all Order Catalogues.
The description of the Order Catalogue
The display name of the Order Catalogue. If not specified, then it defaults to the the catalogue’s name
The supported supply methods of the Order Catalogue
DELIVERYThe type of the event
Delivered to the customer’s address
Picked up by the customer from a venue
Online sales of services
List of organisations that have access and call fulfill orders of items ordered based on the Order Catalogue.
Order cataogue is accessible by all Organisations under a Business or by specific ones.
List of organisations that have access to the order catalogue. Applicable and required when the accessibility is set to Specific.
Organisation unique identifier
Order catalogue available from this time
Order catalogue available up until this time
An Order catalogue requires at least one category. Categories group together products of the product catalogue. A Category might or might not have sub-categories.
Order catalogue category name. The name must be unique among the same catalogue’s categories
Category code. Should also be unique.
Category’s description
Determines how categories will be prioritised within the UI
List of products included in the Category. A product might be included in multiple Categories of the same catalogue. Products are specified either under the Cataogry and, if a cateogry has sub-categories, then products are added per sub-category. Products cannot be added in both.
Product unique identifier
The product’s priority (ordering) within the catalogue. Used for display purposes.
Further catagorisation of the products into sub-categories.Sub-categories cannot have their own child nodes.
Name of sub-category. Must be unique across sub-categories of the same category
Code for sub-category
Description for sub-category
Determines how sub-categories will be prioritised within the UI
List of products included in the sub-category. A product can only be added once within a Category’s sub-categories. But it can be added in another Category as well. At least one product must be specified
Product unique identifier
The product’s priority (ordering) within the catalogue. Used for display purposes.
Responses
The request has succeeded
Body
The order catalogue identifier
POST https://sandbox.crm.com/backoffice/v2/order_catalogues HTTP/1.1
Content-Type: application/json
{
"name": "Summer Catalogue",
"description": "Services and Physical goods avialable fo rsale during summer time",
"display_name": "Summer!",
"supply_methods": [
"DELIVERY"
],
"accessibility": {
"type": "SPECIFIC",
"organisations": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}
]
},
"time_availability": [
{
"day_of_week": "WEDNESDAY",
"start_time": "09::00",
"end_time": "17:00"
}
],
"categories": [
{
"name": "Drinks",
"code": "CD001",
"description": "Cold drinks served during lunch hours",
"priority": 1,
"products": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"priority": 1
}
],
"sub_categories": [
{
"name": "Cold Drinks",
"code": "CDD001",
"description": "Juice & Soft-drinks",
"priority": "1",
"products": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"priority": 1
}
]
}
]
}
]
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}Returns a list of order catalogues
Request parameters
Search for an order catalogue using its name, display name or description
Retreive order catalogues based on organisation
Retrieve order catalogue based on supply method
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
The order catalogue identifier
The name of the order catalogue
The description of the order catalogue
The dislpay name of the order catalogue
The state that the order catalogue
Details about the organisation from where such event was posted
The organisation identifier
The organisation name
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/order_catalogues HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "Monday menu",
"description": "Monday menu for Food & Drinks",
"dislpay_name": "Monday Menu",
"state": "ACTIVE",
"owner": {
"id": "4248fab3-67d5-2eb1-eaf6-079ce18cd2ed",
"name": "Bravo Coffee"
}
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Retrieve detailed information for a specific order catalogue
Path variables
The order catalogue identifier
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
The order catalogue identifier
The name of the order catalogue
The description of the order catalogue
The dislay name of the order catalogue
The supported supply methods of the Order catalogue
DELIVERYThe type of the event
Delivered to the customer’s address
Picked up by the customer from a venue
Online sales of services
The state that the order catalogue
Order catalogue available from this time
Order catalogue available up until this time
Order cataogue is accessible by all Organisations under a Business or by specific ones.
List of organisations that have access to the order catalogue. Applicable and required when the accessibility is set to Specific.
Organisation uniue identifier
Order catalogue categories
Order catalogue category identifier
Category name
Category code
Prioriy of the category, used for display (ordering) UI purposes
List of products included in the Category. A product might be included in multiple Catagories of the same catalogue. Products are specified either under the Cataogry and, if a cateogry has sub-categories, then products are added per sub-category. Products cannot be added in both.
Product identifier
Product SKU
Product name
Sub-category unique identifier
Sub-category name
Sub-category code
Prioriy of the sub-category, used for display (ordering) UI purposes
List of products included in the sub-category. A product can only be added once within a Category’s sub-categories. But it can be added in another Category as well.
Product identifier
Product SKU
Product name
The creative identifier
Information about the creative type
Partner logos configurable by SO, applicable for Business, Merchant, Venue
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
The creative width
The creative height
The creative format
The creative content URL
The creative public identifier
Information about the creative transformations
The transformed creative width
The transformed creative height
The transformed creative URL
GET https://sandbox.crm.com/backoffice/v2/order_catalogues/{id} HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "Monday menu",
"description": "Monday menu for food and drinks",
"display_name": "Monday Menu",
"supply_methods": [
"DELIVERY"
],
"state": "ACTIVE",
"time_availability": [
{
"day_of_week": "SATURDAY",
"start_time": "09::00",
"end_time": "17:00"
}
],
"accessibility": {
"type": "SPECIFIC",
"organisations": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}
]
},
"categories": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "Food",
"code": "FOOD",
"priority": 1,
"products": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"sku": "ABC1234",
"name": "Coffee"
}
],
"sub_categories": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "Main dishes",
"code": "MD001",
"priority": 1,
"products": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"sku": "ABC1234",
"name": "Coffee"
}
]
}
]
}
],
"creatives": [
{
"id": "3caf8388-b9c6-6679-1e9b-94a6fda92a41",
"usage_type": "DELIVERY_IMAGE",
"width": 2159,
"height": 3075,
"format": "jpg",
"url": "https://assets.crm.com/image/logo.jpg",
"public_id": "crm-com/image",
"media": [
{
"width": 200,
"height": 300,
"url": "https://asset.crm.com/image/offer/c_scale,w_200/logo.jpg"
}
]
}
]
}{id}Updates an existing Order Catalogue. Within the catalogue products are included in Categories and their sub-categories. Either a category or its sub-categories must include products. The priority of products can also be set. Products that cannot be included in Order Catalogues
- Usage Services
- Expenses
- Modifiers
- Variants
Path variables
The order catalogue identifier that will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The name of the Order Catalogue
Update the state of the catalogue
The description of the Order Catalogue
The display name of the Order Catalogue
The supported supply method of the Order Catalogue
DELIVERYThe type of the event
Delivered to the customer’s address
Picked up by the customer from a venue
Online sales of services
Order cataogue is accessible by all Organisations under a Business or by specific ones.
List of organisations that have access to the order catalogue. Applicable and required when the accessibility is set to Specific.
Organisation uniue identifier
Order catalogue available from this time
Order catalogue available up until this time
An Order catalogue requires at least one category. Categories group together products of the product catalogue. A Category might or might not have sub-categories.
Order catalogue catagory identifier
Catagory name which has to be uique across the same catalogue’s categories
Category code which has to be unique across the same catalogue’s categories
A description for the category
The category’s priority. Used for sorting purposes within the UI
List of products included in the Category. A product might be included in multiple Categories of the same catalogue. Products are specified either under the Cataogry and, if a cateogry has sub-categories, then products are added per sub-category. Products cannot be added in both.
Product identifier
The product’s priority. Used for sorting purposes within the UI
Further catagorisation of the products into sub-categories.Sub-categories cannot have their own child nodes.
Sub-category identifier
Sub-category name that has to be unique across the same Category’s sub-categories
Sub-category code that has to be unique across the same Category’s sub-categories
Sub-category description
The sub-category’s priority. Used for sorting purposes within the UI
List of products included in the sub-category. A product can only be added once within a Category’s sub-categories. But it can be added in another Category as well. At least one product must be specified
Product identifier
The product’s priority. Used for sorting purposes within the UI
Responses
The request has succeeded
Body
The order catalogue identifier
PUT https://sandbox.crm.com/backoffice/v2/order_catalogues/4dc0809f-ed91-4b68-b912-5bd6064d901e HTTP/1.1
Content-Type: application/json
{
"name": "Monday menu",
"state": "ACTIVE",
"description": "Food & Drinks Monday meu",
"display_name": "Monday menu",
"supply_methods": [
"DELIVERY"
],
"accessibility": {
"type": "SPECIFIC",
"organisations": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}
]
},
"time_availability": [
{
"day_of_week": "THURSDAY",
"start_time": "09::00",
"end_time": "17:00"
}
],
"categories": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "Drinks",
"code": "D0001",
"description": "Hot & Clond drinks offered on weekends",
"priority": 1,
"products": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"priority": 1
}
],
"sub_categories": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "Cold Drinks",
"code": "C0001",
"description": "Cold Drinks",
"priority": 1,
"products": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"priority": 1
}
]
}
]
}
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}{id}Deletes an existing Order Catalogue
Path variables
The Order Catalogue identifier that will be deleted
Responses
DELETE https://sandbox.crm.com/backoffice/v2/order_catalogues/CA123456789AQWSXZAQWS1236547896541 HTTP/1.1
HTTP/1.1 204 No Content {id}/media_groupsLink an order catalogue with one or more media groups
Path variables
The order catalogue (identifier) that media groups will be set
Notes
Uploading media for an order requires the execution of the following APIs
- Create new Media Group
- Create Order Catalog Media Groups
- Upload Media
- Perform Cloudinary Upload (where CRM will send all signature details)
- Cloudinary service calls back CRM media group (using an internal callback)
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The media group identifier
Responses
POST https://sandbox.crm.com/backoffice/v2/order_catalogues/6A24D2B5E44F44B28451FE021FCAD51E/media_groups HTTP/1.1
Content-Type: application/json
[
{
"media_group_id": "7ec65711-8f3b-538c-dec9-8c36ce818382"
}
]{id}/detailsRetrieve a list of reward events based on search criteria (e.g. all purchase events)
Request parameters
Filter based on event type
Filter based on the performed date, which may fall within a given date range. The value can be a string with a date in epoch format. Each option must also include an operator. Use up to two options based on the required search (e.g. performed_on[gte]=1618395497&performed_on[lt]=1618395497).
Returns results where the performed date is greater than this value
Returns results where the performed date is greater than or equal to this value
Returns results where the performed date is less than this value
Returns results where the performed date is less then or equal to this value
Filter based on the total amount, which may fall within a given amount range. The value can be a string with an amount in numeric format. Each option must also include an operator. Use up to two options based on the required search (e.g. total_amount[gte]=12.99&total_amount[lt]=99.99).
Returns results where the total amount is greater than this value
Returns results where the total amount is greater than or equal to this value
Returns results where the total amount is less than this value
Returns results where the total amount is less then or equal to this value
Filter based on contact (identifier) that such event was performed against
Filters based on organisation (identifier) that such event was performed on (applicable only for purchase events)
Filters based on organisation tap (code) that such event was performed on (applicable only for purchase events)
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
Details about the reward event
The event identifier
The type of the event
The event reference number uniquely identifing the Customer Events
The export definition status
The date that the event was created
The amount that was posted as part of the event (applicable for PUCHASE and Ad Hoc Returns)
Details about the organisation that such event was created by (if event = PURCHASE, defaults to the performed by organisation)
The organisation identifier
The organisation name
The organisation type
Details about the event classification
The classification identifier
The classification name
Details about the contact related to this event
The contact identifier
The contact full name
The contact code
The contact unique cim (contact identification medium)
Details about the rewards related to this event
The total amount awarded for this event
The total amount redeemed for this event (applicable only for PURCHASE)
The total amount spent by this event
GET https://sandbox.crm.com/backoffice/v2/rewards/events HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"event": {
"id": "5ee16b3d-090c-c178-d18f-c0035eeb1edb",
"type": "PURCHASE",
"reference_number": "CE1234",
"state": "CANCELLED",
"date": 1614948921,
"total_amount": 17.99,
"organisation": {
"id": "5ee16b3d-090c-c178-d18f-c0035eeb1edb",
"name": "CRM",
"type": "VENUE"
},
"classification": {
"id": "c8d83493-3f50-40df-adb0-762ec5f41863",
"name": "Delivery Purchase"
}
},
"contact": {
"id": "9ec78c62-d56a-a43c-95e9-d6da4cc22d08",
"name": "John Ray Doe",
"code": "123456789",
"cim": "1602754465"
},
"rewards": {
"award": 140.59,
"redeem": 15.33,
"spend": 12.21
}
}
]
}{id}/detailsRetrieves all transactions (e.g. award, redeem, spend, wallet, financial) related to a reward event
Path variables
The reward event (identifer) for which additional details will be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
Details about award and spend transactions related to the event
The reward transaction type
The transaction (unique) code
The amount that was awarded, redeemed or spent
Defines which redeem methods are allowed
The transaction state
Only for Award Transactions
The date on which such transaction was posted
The reward offer that the promotion pass will consume.
The reward offer identifier
The reward offer name
Details about financial event related to the reward event (can be the initiated transaction or the end result)
The transaction type
Credit Note can initiate a reward event (purchase cancellation)
Invoice can initiate a reward event (purchase creation)
Refund can be the result of a reward event (due to spend)
Top-Up can initiate a reward event (achievement creation)
The transaction identifier
The transaction number
The transaction reference number
The life cycle state of the financial transaction
The transaction amount
The date on which such transaction was posted
Details about the wallet fees related to the event
Defines the reason for which the fee was applied on wallet
On Credit Wallet Transactions
On Debit Wallet Transactions
The wallet transaction identifier
The fee amount
The fee rule name
The date on which such fee was applied
GET https://sandbox.crm.com/backoffice/v1/reward_events/d46788e6-2c77-2948-2bb9-9521a0f54a8c/details HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"reward_transactions": [
{
"type": "AWARD",
"code": "123234342342432342324r43",
"amount": 14.99,
"currency":"EUR",
"spend_method": "INSTANT",
"state": "CANCELLED",
"date": 1614954223,
"reward_offer": {
"id": "7ff08bc0-c7e9-c9fe-f752-71cfb3ee0dc3",
"name": "Birthday Offer"
}
}
],
"financial_events": [
{
"type": "CREDIT_NOTE",
"id": "7ff08bc0-c7e9-c9fe-f752-71cfb3ee0dc3",
"number": "1234",
"reference_number": "REF12343",
"state": "POSTED",
"amount": 112.24,
"currency":"EUR",
"date": 1614954223
}
],
"wallet_fees": [
{
"type": "CREDIT",
"id": "4af933c7-2594-9c9c-d2d5-1ab4ff89fd59",
"amount": 12.12,
"currency":"EUR",
"name": "1% on all wallet transactions",
"date": 1614954223
}
]
}
]
}{id}{id}{id}{id}/contactsCreate a new reward offer under an existing reward scheme, based on which contacts can be awarded (given target conditions are met).
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The reward offer name
The reward scheme identifier that the offer will belong to it
The offer availability (from-to) dates (whithin this period contacts will be awarded)
The from date that the offer will be applicable
The to date that the offer will be applicable to
The offer goal
The offer type (each goal is related with a type)
The offer short description
The offer long description
The offer terms and conditions
Defines whether the reward offer will be featured (ordered higher) in customer facing clients
Details about the reward offer’s target conditios
The targerted achievement (monetary) condition
Details about monetary achievement
The transaction currency
The transaction value
The transaction value operator that should be met
Value should be equal to the configured one
Value should be greater or equal to the configured one
Value should be greater or less to the configured one
Value should be less to the configured one
Value should be greater to the configured one
The targerted contact segments
The targerted contact profile completness details
The profile information that is provided
The targerted contact reward tiers
The targeted event classification
Details about the evaluation time
The date that the offer will be evaluaed (just once)
The repeat frequency provided as a cron expression pattern
The targerted organisations that events performed on should be located at
The targerted (organisations) countries that events performed on should be located at
Defines what is required to award such referral
Award will be provided after the referred customer registers and makes a purchases
Award will be provided after the referred customers registers
The targerted subscription maturity
The period for subscription maturity check
The maturity period
List conditions on transaction
Total transaction conditions
The transaction currency
The transaction value
The period for which cumulative will be performed
The condition operator
Product conditions
List of product group conditions
The group name
The group operator
Details about group conditions
The condition name
the product condition (sku/brand/etc) identifier
The condition type
The condition name
The product condition quantity
The product condition value
The currency for product value
The period for which cumulative will be performed
The condition operator
Timing Conditions
Offer targets condition on customer birthday
Offer targets condition on customer nameday
Offer will target X days before birthday/nameday
Offer will target X days after birthday/nameday
List of days/times that offer will target
The availability month
The day of the week as condition (1-7), 1 is Sunday
The availability start time
The availability end time
The targeted contact events that entries will be based on (e.g. every purchase made counts as 2 entries)
The frequency of an event, i.e hw many times an Event occured withn a period of time. Applicable and required for Event conditions.
The operator that shows he period of time during which Events must fall within in order for contacts to be included in the segment. Operators Between, On, Since require date(s) filters, whereas the rest of the operators need an integrer value(s)
The period of time that events will be evaluated for entries
The events that will be converted into lottery entries
Details about contact behavioral actions
The event that a contact performed
The name of the event that a contact performed or not. Applicable and required only for conditions of type Event. If not specified, then contacts that performed any event are eligible to be included in the segment
The related event type conditions that contact should meet as part of the performed event (applicable only for type based on product skus, families, brands and types)
Defines the ratio between events and counted entries
The frequency’s operator
Applicable for single value
Applicable for range values
The number of event value or in the case of range operator like Between, the starting value
The maximum number of event value, required when using “range” operators like Between.
The number of entries that will be counted for for this event
Multiple properties can be added to apply additional filtering on the conditions. If more than one properties are specified, an operator is required that defines the logic between properties
All conditions should be met
At least one condition should be met
Detais about properties/attibutes that can be used as additional filtering conditions
The event property
The property’s data type
The property’s condition operator
The property value or in the case of range operator like Between, the starting value
The maximum value for the property, required when using “range” operators like Between.
List of (string) values required when the operator implies multiple values comparison, such as contains or does not contain
Represents the list name (applicable only if property is list based)
The award settings based on which a reward offer’s award is defined (e.g. amount or percentage based)
The award type
Award will be based on a fixed amount
Award will be based on a percentage amount
Award will be differentiated based on item quantity
Award will be based on a free product (brand, family, sku, type)
The award amount
Defines the quantity based on which a award will be provided (e.g. 1 litres)
The award product conditions
The product condition identifier (can be the identifier of a product sku, brand, family or type)
The product condition type
Product SKU
Product Family
Product Brand
Product Type
All targeted based products
Award Restrictions
The number of contacts that can win a lotter draw
The total number of contacts that can be awarded. After that the offer (still active) will not award any more contacts
The maximum awarded amount that can be provided (applicable when award is based on percentage)
Restrict awards provided to a maximum threshold, such as 1 per day
How many times an award will be provided
Period duration
Unit of Time of Period
Award Restrictions
Defines which redeem methods are allowed
The commerce pool identifier (required only if redeem method is deferred)
Expiration (valid to) condition
The award expiration type
The date that the amount expires (applicable for specific expiration type)
The expiration period (applicable for period expiration type)
The award validity period unit (applicable for period validity type)
Responses
The request has succeeded
Body
The reward offer identifier
POST https://sandbox.crm.com/backoffice/v2/reward_offers HTTP/1.1
Content-Type: application/json
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
{
"name": "10% off any purchase",
"scheme_id": "4e485cda-e55a-b672-a9bd-a341335193a5",
"availability": {
"from": 1606819297,
"to": 1606819297
},
"goal": "MEMBERSHIP",
"type": "DISCOUNT",
"short_description": "Enjoy awards with this new offer",
"long_description": "Enjoy awards with this new offer and explore how rewards is good for you",
"terms_and_conditions": "Applicable for all EU residents",
"is_featured": "false",
"targets": {
"organisations": [
"771993f9-ba38-9765-f1ac-1131de34a774"
]
},
"awards": [
{
"amount": 10.99,
"currency_type": "DEFAULT"
}
],
"restrictions": {
"total_contacts": 1
},
"redeem": {
"method": "DEFERRED",
"commerce_pool_id": "1783d4bb-2c1c-b40a-2955-ea89abc929d0"
}
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "36b13448-dd9c-5a67-06e3-72ebda536c5c"
}{id}Update an existing reward offer
Path variables
The reward offer (identifier) that will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The offer name
The offer availability (from-to) dates (whithin this period contacts will be awarded)
The from date that the offer will be applicable
The to date that the offer will be applicable to
The offer short description
The offer long description
Terms and Conditions
Defines whether the reward offer will be featured (ordered higher) in customer facing clients
The offer life cycle state
Details about the reward offer’s target conditios
The targerted achievement (monetary) condition
Details about monetary achievement
The transaction currency
The transaction value
The transaction value operator that should be met
Value should be equal to the configured one
Value should be greater or equal to the configured one
Value should be greater or less to the configured one
Value should be less to the configured one
Value should be greater to the configured one
The targerted contact segments
The targerted contact profile completness details
The profile information that is provided
The targerted contact reward tiers
The targeted event classification
Details about the evaluation time
The date that the offer will be evaluaed (just once)
The repeat frequency provided as a cron expression pattern
The targerted organisations that events performed on should be located at
The targerted (organisations) countries that events performed on should be located at
Defines what is required to award such referral
Award will be provided after the referred customer registers and makes a purchases
Award will be provided after the referred customers registers
The targerted subscription maturity
The period for subscription maturity check
The maturity period
List conditions on transaction
Total transaction conditions
The transaction currency
The transaction value
The period for which cumulative will be performed
The condition operator
Product conditions
List of product group conditions
The group name
The group operator
Details about group conditions
The condition name
the product condition (sku/brand/etc) identifier
The condition type
The condition name
The product condition quantity
The product condition value
The currency for product value
The period for which cumulative will be performed
The condition operator
Timing Conditions
Offer targets condition on customer birthday
Offer targets condition on customer nameday
Offer will target X days before birthday/nameday
Offer will target X days after birthday/nameday
List of days/times that offer will target
The availability month
The day of the week as condition (1-7), 1 is Sunday
The availability start time
The availability end time
The targeted contact events that entries will be based on (e.g. every purchase made counts as 2 entries)
The frequency of an event, i.e hw many times an Event occured withn a period of time. Applicable and required for Event conditions.
The operator that shows he period of time during which Events must fall within in order for contacts to be included in the segment. Operators Between, On, Since require date(s) filters, whereas the rest of the operators need an integrer value(s)
The period of time that events will be evaluated for entries
The events that will be converted into lottery entries
Details about contact behavioral actions
The event that a contact performed
The name of the event that a contact performed or not. Applicable and required only for conditions of type Event. If not specified, then contacts that performed any event are eligible to be included in the segment
The related event type conditions that contact should meet as part of the performed event (applicable only for type based on product skus, families, brands and types)
Defines the ratio between events and counted entries
The frequency’s operator
Applicable for single value
Applicable for range values
The number of event value or in the case of range operator like Between, the starting value
The maximum number of event value, required when using “range” operators like Between.
The number of entries that will be counted for for this event
Multiple properties can be added to apply additional filtering on the conditions. If more than one properties are specified, an operator is required that defines the logic between properties
All conditions should be met
At least one condition should be met
Detais about properties/attibutes that can be used as additional filtering conditions
The event property
The property’s data type
The property’s condition operator
The property value or in the case of range operator like Between, the starting value
The maximum value for the property, required when using “range” operators like Between.
List of (string) values required when the operator implies multiple values comparison, such as contains or does not contain
Represents the list name (applicable only if property is list based)
The award type
Award will be based on a fixed amount
Award will be based on a percentage amount
Award will be differentiated based on item quantity
Award will be based on a free product (brand, family, sku, type)
The award amount
Defines the quantity based on which a award will be provided (e.g. 1 litres)
The award product conditions
The product condition identifier (can be the identifier of a product sku, brand, family or type)
The product condition type
Product SKU
Product Family
Product Brand
Product Type
All targeted based products
Award Restrictions
The number of contacts that can win a lotter draw
The total number of contacts that can be awarded. After that the offer (still active) will not award any more contacts
The maximum awarded amount that can be provided (applicable when award is based on percentage)
Restrict awards provided to a maximum threshold, such as 1 per day
How many times an award will be provided
Period duration
Unit of Time of Period
Award Restrictions
Defines which redeem methods are allowed
The commerce pool identifier (required only if redeem method is deferred)
Expiration (valid to) condition
The award expiration type
The date that the amount expires (applicable for specific expiration type)
The expiration period (applicable for period expiration type)
The award validity period unit (applicable for period validity type)
Responses
The request has succeeded
Body
The reward offer identifier
PUT https://sandbox.crm.com/backoffice/v2/reward_offers/ffb711de-2733-251f-e437-9bbdc864c4f2 HTTP/1.1
Content-Type: application/json
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
{
"name": "10% off any purchase",
"availability": {
"from": 1606819297,
"to": 1606819297
},
"short_description": "Reward Offer Short Description",
"long_description": "Reward Offer Long Description",
"terms_and_conditions": "Applicable for all EU residents",
"is_featured": "false",
"state": "ACTIVE",
"targets": {
"organisations": [
"771993f9-ba38-9765-f1ac-1131de34a774"
]
},
"awards": {
"amount": 10.99
},
"restrictions": {
"total_contacts": 1,
},
"redeem": {
"method": "DEFERRED",
"commerce_pool_id": "1783d4bb-2c1c-b40a-2955-ea89abc929d0"
}
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "ffb711de-2733-251f-e437-9bbdc864c4f2"
}{id}Delete an existing reward offer
Path variables
The reward offer (identifier) that will be deleted
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
DELETE https://sandbox.crm.com/backoffice/v2/reward_offers/95f609ed-412e-d969-40c1-e283707a49f8 HTTP/1.1
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
HTTP/1.1 204 No Content Retrieve a list of reward offers based on search criteria (e.g. all featured reward offers)
Request parameters
Filter based on search value (case insensitive) across name
Filter based on reward offer name
Filter based on reward offer state
Filter based on reward scheme (defaults to All)
Filter based on organisation (identifier) that such reward offer is created for
Filter based on organisation (identifier) that such reward offers are owned by them
Filter based on reward offer type
Filter based on whether the reward offers will be featured (ordered higher)
Defines whether approval requests information should be retrieved or not
Filter based on approval state
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The reward offer identifier
The reward offer name
Short description used in Mobile or other APP experiences
The reward offer description
The reward scheme that the offer belongs to
The reward scheme identifier
The reward scheme name
The offer goal
The offer type (each goal is related with a type)
The offer availability (from-to) dates (whithin this period customers will be awarded)
The date of start period for offer
The date of end period for offer
The offer life cycle state
The creative identifier
Information about the creative type
Partner logos configurable by SO, applicable for Business, Merchant, Venue
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
The creative width
The creative height
The creative format
The creative content URL
The creative public identifier
Information about the creative transformations
The transformed creative width
The transformed creative height
The transformed creative URL
Defines whether the reward offer will be featured (ordered higher) in contact facing clients
Details about the organisation from where such event was posted
The organisation identifier
The organisation name
Details about the application
The approval request state
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v1/reward_offers HTTP/1.1
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "6A24D2B5E44F44B28451FE021FCAD51E",
"name": "10% off any purchase",
"short_description": "Reward Offer Short Description",
"long_description": "Reward Offer Long Description",
"scheme": {
"id": "622175bf-03b0-4e9e-9df9-adf85080a889",
"name": "Coffee Scheme"
},
"goal": "SPEND",
"reward_type": "KPI",
"availability": {
"available_from": 1606819297,
"available_to": 1606819297
},
"tags": [
{
"id": "wer-3rwefsf2rf-wef-2f-wef-2r",
"name": "Seasonal"
}
],
"life_cycle_state": "PENDING_APPROVAL",
"creatives": [
{
"id": "CA123456789AQWSXZAQWS1236547896541",
"usage_type": "MARKETING",
"width": 2159,
"height": 3075,
"format": "jpg",
"url": "https://assets.crm.com/image/logo.jpg",
"public_id": "crm-com/image",
"media": [
{
"width": 200,
"height": 300,
"url": "https://asset.crm.com/image/offer/c_scale,w_200/logo.jpg"
}
]
}
],
"is_featured": "false",
"owner": {
"id": "0d943fdb-c30a-924a-a1ee-d7dbdff99cc5",
"name": "CRM.COM"
}
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Retrieve detailed information for a reward offer
Path variables
The reward offer (identifier) that will be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The reward offer identifier
The reward offer name
The reward scheme that the offer belongs to
The reward scheme identifier
The reward scheme name
The offer goal
The offer type (each goal is related with a type)
The offer short description
The offer long description
The offer terms and conditions
The offer availability (from-to) dates (whithin this period customers will be awarded)
The date of start period for offer
The date of end period for offer
The offer life cycle state
Defines whether the reward offer will be featured (ordered higher) in customer facing clients
Details about the organisation from where such event was posted
The organisation identifier
The organisation name
The creative identifier
Information about the creative type
Partner logos configurable by SO, applicable for Business, Merchant, Venue
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
The creative width
The creative height
The creative format
The creative content URL
The creative public identifier
Information about the creative transformations
The transformed creative width
The transformed creative height
The transformed creative URL
The targeted contact segments
The segment identifier
The segment name
The segment description
The number of results for that segment
The targeted reward tiers
Details about reward tier
The reward tier identifier
The reward tier name
The targeted profile completeness conditions
The profile information that is provided
The targerted organisations that events performed on should be located at
The organisation identifier
The organisation type
The organisation name
The organisation locations
Information about the organisation’s location
The name of the location
The address of the location
Additional address information about the location
The state/province/county of the location
The town/city of the location
The postal code of the location
The country code of the location
The latitude of the location
The longitude of the location
The Google textual identifier that uniquely identifies a location
The targerted countries that events performed on should be located at
The country (code) that is targetted
The targeted transactions (items & total value)
Transaction (total) Conditions
The transaction currency
The transaction value
The period for which cumulative will be performed
Condition operator
Product Conditions
A list of group conditions
The group name
The group condition operator
List group conditions
The condition name
The condition identifier (e.g. family identifier)
The condition type
The product condition (sku/brand/family) name
The product condition (sku/brand/family) description
The product condition quantity
The product condition value
The currency code
The period for which cumulative will be performed
The condition operator
The targeted timings
Offer targets condition on customer birthday
Offer targets condition on customer nameday
Offer will target X days before birthday/nameday
Offer will target X days after birthday/nameday
List of days/times that offer will target
The availability month
The day of the week as condition (1-7), 1 is Sunday
The availability start time
The availability end time
The targeted evaluation time period
DEtails about the evaluation time
The date that the offer will be evaluaed (just once)
The repeat frequency provided as a cron expression pattern
The targeted pass redemption
Details about the related type
The type identifier
The type name
The targeted referrals
Defines what is required to award such referral
Award will be provided after the referred customer registers and makes a purchases
Award will be provided after the referred customers registers
The targeted customer event classifications
Details about the event classification
The classification identifier
The classification name
Tha targeted achievement monetary conditions
Defines the monetary (amount) conditions
The transaction currency
The transaction value
The transaction value operator that should be met
Value should be equal to the configured one
Value should be greater or equal to the configured one
Value should be greater or less to the configured one
Value should be less to the configured one
Value should be greater to the configured one
Tha targeted subscription maturity
The period for subscription maturity check
The maturity period
The targeted contact events that entries will be based on (e.g. every purchase made counts as 2 entries)
The frequency of an event, i.e hw many times an Event occured withn a period of time. Applicable and required for Event conditions.
The operator that shows he period of time during which Events must fall within in order for contacts to be included in the segment. Operators Between, On, Since require date(s) filters, whereas the rest of the operators need an integrer value(s)
The period of time that events will be evaluated for entries
The events that will be converted into lottery entries
Details about contact behavioral actions
The event that a contact performed
The name of the event that a contact performed or not. Applicable and required only for conditions of type Event. If not specified, then contacts that performed any event are eligible to be included in the segment
The related event type conditions that contact should met as part of the performed event (applicable only for types based on product skus, families, brands and types)
The type entity identifier
The type entity name (e.g. product name)
The type entity sku (e.g. product SKU) applicable only for products
Defines the ratio between events and counted entries
The frequency’s operator
Applicable for single value
Applicable for range values
The number of event value or in the case of range operator like Between, the starting value
The maximum number of event value, required when using “range” operators like Between.
The number of entries that will be counted for for this event
Multiple properties can be added to apply additional filtering on the conditions. If more than one properties are specified, an operator is required that defines the logic between properties
All conditions should be met
At least one condition should be met
Detais about properties/attibutes that can be used as additional filtering conditions
The event property
The property’s data type
The property’s condition operator
The property value or in the case of range operator like Between, the starting value
The maximum value for the property, required when using “range” operators like Between.
List of (string) values required when the operator implies multiple values comparison, such as contains or does not contain
Represents the list name (applicable only if property is list based)
The award settings based on which a reward offer’s award is defined (e.g. amount or percentage based)
The award type
Award will be based on a fixed amount
Award will be based on a percentage amount
Award will be differentiated based on item quantity
Award will be based on a free product (brand, family, sku, type)
The award amount
The product quantity ratio for award
Details about award product conditions
The product condition identifier (can be the identifier of a product sku, brand, family or type)
The product condition type
Product SKU
Product Family
Product Brand
Product Type
All targeted based products
The product condition name (can be the identifier of a product sku, family or type)
The product condition description (can be the identifier of a product sku, family or type)
The award restrictions
The number of contacts that can win a lotter draw
The total number of contacts that can get the award
The maximum amount that can be provided by a offer that awards based on percentage
Details about the frequency that contacts can get the award
The frequency of the award
The frequency period
Unit of Time of Period
The award restrictions
Defines which redeem methods are allowed
Details about spend condition
The commerce pool identifier
The commerce pool name
The commerce pool description
Expiration (valid to) condition
The award expiration type
The date that the amount expires (applicable for specific expiration type)
The specific expiration period (applicable for period expiration type)
The award validity period unit (applicable for period validity type)
GET https://sandbox.crm.com/backoffice/v2/reward_offers/fb144452-703f-786c-7fb9-f3b4b3dbd042 HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "fb144452-703f-786c-7fb9-f3b4b3dbd042",
"name": "10% off any purchase",
"scheme": {
"id": "622175bf-03b0-4e9e-9df9-adf85080a889",
"name": "Coffee Scheme"
},
"goal": "MEMBERSHIP",
"type": "REACH_TIER",
"short_description": "Reward Offer Short Description",
"long_description": "Reward Offer Long Description",
"terms_and_conditions": "Applicable for all EU residents",
"availability": {
"from": 1606819297,
"to": 1606819297
},
"state": "ACTIVE",
"is_featured": "false",
"owner": {
"id": "4248fab3-67d5-2eb1-eaf6-079ce18cd2ed",
"name": "Bravo Coffee"
},
"media_groups": [
{
"id": "6A24D2B5E44F44B28451FE021FCAD51E",
"name": "Marketing Media",
"creatives": [
{
"id": "CA123456789AQWSXZAQWS1236547896541",
"usage_type": "LANDING_PAGE_BACKGROUND_IMAGE",
"width": 2159,
"height": 3075,
"format": "jpg",
"url": "https://assets.crm.com/image/logo.jpg",
"public_id": "crm-com/image",
"media": [
{
"width": 200,
"height": 300,
"url": "https://asset.crm.com/image/offer/c_scale,w_200/logo.jpg"
}
]
}
]
}
],
"awards": [
{
"amount_type": "FIXED",
"currency_type": "DEFAULT",
"amount": 10.99
}
],
"restrictions": {
"total_contacts": 1
},
"targets": {
"segments": [
{
"id": "65019442-661a-6b5e-c0db-7d62b5b624a6",
"name": "VIP Customers",
"description": "All customers that are classified as VIP",
"size": 112
}
],
"reward_tiers": [
{
"id": "a67e6e67-9752-9c58-d4d3-f166f6751fca",
"name": "Gold"
}
]
},
"redeem": {
"commerce_pool": {
"id": "dc01f65b-a482-48f1-9fda-c163df72f28f",
"name": "Spend Anywhere"
},
"method": "DEFERRED"
}
}{id}/contactsRetrieve a list of contacts that have been awarded from the reward offer (only for Lottery offers)
Path variables
The reward offer (identifier) whose awarded contacts will be returned
Request parameters
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
Details about the related contact
The contact identifier
The contact full name
The contact unique code
Details about award
The awarded amount
The awarded product (free product)
The awarded product type
The awarded product identifier
The awarded product name
The date that the award was provided
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/reward_offers/9f2e66af-d42d-4c15-9346-7e2cc0a89f6e/contacts HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"contact": {
"id": "1c060611-0667-313e-b3bf-4cb70ee81cdf",
"name": "John Johnson",
"code": "C123"
},
"award": {
"amount": 9.99,
"date": 1606376717
}
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}Retrieve the allowed reward offer type(s) and redeen method(s) that can be used on reward offer creation
Notes
Service Owner restrictions will be applied on all Businesses (and their Merchants/Service Providers) that share the same contact registry, while Business restrictions (that have their own contact registry) will be applied only on their Merchants/Service Providers.
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Successful Request
Body
Defines the offer types that will be allowed to be created
The offer type (each goal is related with a type)
Defines which redeem methods are allowed
Defines which redeem methods are allowed
GET https://sandbox.crm.com/backoffice/v2/reward_offers/restrictions HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"offer_types": [
"BUNDLE"
],
"redeem_methods": [
"DEFERRED"
]
}{id}/media_groups{id}/media_groupsLink a reward offer with one or more media groups
Path variables
The reward offer (identifier) that media groups will be set
Notes
Uploading media for a reward offer requires the execution of the following APIs
- Create new Media Group
- Create Reward Offer Media Groups
- Upload Media
- Perform Cloudinary Upload (where CRM will send all signature details)
- Cloudinary service calls back CRM media group (using an internal callback)
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The media group identifier
Responses
POST https://sandbox.crm.com/backoffice/v2/reward_offers/1769c374-a4d4-5254-a9b5-1ea21325145a/media_groups HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
[
{
"media_group_id": "70b85ee1-c291-634d-2ddf-1f39c42e4f42"
}
]
HTTP/1.1 204 No Content {id}/translations{id}/translations{id}/translations/actions{id}/translationsUpdate the content translations for an existing reward offer
Path variables
The reward offer (identifier) of which content translations will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The content translations for the specified language
The content (attribute) key
The content (attribute) translated value
Responses
The request has succeeded
PUT https://sandbox.crm.com/backoffice/v2/reward_offers/a42dd7c4-e755-92fb-963b-5f658a59908e/translations HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
[
{
"language_code": "EN",
"translations": [
{
"key": "name",
"value": "10% cashback return"
}
]
}
]
HTTP/1.1 204 No Content {id}/translationsRetrieve the content translations for an existing reward offer
Path variables
The reward offer (identifier) of which content translations will be retrieved
Request parameters
Filter based on language
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The content translations for the specified language
The content (attribute) key
The content (attribute) translated value
GET https://sandbox.crm.com/backoffice/v2/reward_offers/a42dd7c4-e755-92fb-963b-5f658a59908e/translations HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"language_code": "EN",
"translations": [
{
"key": "name",
"value": "10% cashback return"
}
]
}
]
}{id}/translations/actionsPerform content translation actions on an existing entity (e.g. export a reward offer’s translations)
Path variables
The reward offer (identifier) of which content translation actions will be performed
Notes
Importing content translations should be made based on the following API order
Exporting content translations into different file should be made using the following API order
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The action that will be applied
The file (identifier) that will be used for importing translations (required only for import action)
The file (identifier) that will be used for importing translations (required only for import action)
The file (mime type) that will be used for exporting translations (required only for export action)
Responses
The request has succeeded
PUT https://sandbox.crm.com/backoffice/v2/reward_offers/a42dd7c4-e755-92fb-963b-5f658a59908e/translations/actions HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"action": "IMPORT",
"file": {
"id": "1e347d4d-ab96-6957-fdb6-35e72b3d9185"
}
}
HTTP/1.1 204 No Content PUT https://sandbox.crm.com/backoffice/v2/reward_offers/a42dd7c4-e755-92fb-963b-5f658a59908e/translations/actions HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"action": "EXPORT",
"file": {
"mime": "json"
}
}
HTTP/1.1 204 No Content {id}{id}Create a reward scheme. Contacts can sign up to reward schemes and based on their behavioral events (e.g. purchase, achievement) can be awarded from offers that are created under such schemes (given offer’s target conditions are met).
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The reward scheme name
The reward scheme description
Defines how customers can sign up to the reward scheme
Contacts will sign up upon registration automatically
Contacts can sign up manually
Contacts can be signed up on a selective and controlled manner (request to sign up), usually based on domain specific emails
Defines whether close loop (controlled) sign ups will be validated based on a third-party identification (external system) or domain specific emails. Required if the sign up option = controlled sign up
Defines the supported email domains for closed loop sign ups based on domain. Required when sign up is based on email domain
The reward scheme terms and conditions
Responses
The request has succeeded
Body
The reward scheme identifier
POST https://sandbox.crm.com/backoffice/v2/reward_schemes HTTP/1.1
Content-Type: application/json
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
{
"name": "CRMdotCOM Scheme",
"description": "The main reward scheme of CRMdotCOM",
"sign_up_option": "CLOSED_SIGN_UP",
"sign_up_code": "EMAIL_DOMAIN",
"email_domains": [
"crm.com"
],
"terms_and_conditions": "Only customers that already have CRMdotCOM reward app can join this scheme"
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "9fa92a4e-575e-7b76-6f8a-c189112789d6"
}{id}Update an existing reward scheme
Path variables
The reward scheme (identifier) that will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The reward scheme name
The reward scheme description
Defines the supported email domains for closed loop sign ups based on domain. Required on closed loop reward schemes and the sign up is based on email domain
The reward scheme terms and conditions
The offer life cycle state
Responses
The request has succeeded
Body
The reward scheme identifier
PUT https://sandbox.crm.com/backoffice/v2/reward_schemes/9fa92a4e-575e-7b76-6f8a-c189112789d6 HTTP/1.1
Content-Type: application/json
{
"name": "CRMdotCOM Scheme",
"description": "The main reward scheme of CRMdotCOM",
"email_domains": [
"crm.com"
],
"terms_and_conditions": "Only contacts that already have CRMdotCOM reward app can join this scheme"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "9fa92a4e-575e-7b76-6f8a-c189112789d6"
}Retrieve a list of reward schemes based on search criteria (e.g. all closed loop reward schemes)
Request parameters
Filter based on reward scheme name
Filter based on how contacts can sign up to a reward scheme
Contacts will sign up upon registration automatically
Contacts can sign up manually
Contacts can be signed up on a selective and controlled manner (request to sign up), usually based on domain specific emails
Filter based on reward scheme state
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The reward scheme identifier
The reward scheme name
The reward scheme description
Defines how customers can sign up to the reward scheme
Contacts will sign up upon registration automatically
Contacts can sign up manually
Contacts can be signed up on a selective and controlled manner (request to sign up), usually based on domain specific emails
The reward scheme state
GET https://sandbox.crm.com/backoffice/v2/reward_schemes HTTP/1.1
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "9fa92a4e-575e-7b76-6f8a-c189112789d6",
"name": "CRMdotCOM Scheme",
"description": "The main reward scheme of CRMdotCOM",
"sign_up_option": "SELF_SIGN_UP",
"state": "INACTIVE"
}
]
}{id}Retrieve detailed information for a reward scheme
Path variables
The reward scheme (identifier) that will be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The reward scheme identifier
The reward scheme name
The reward scheme description
The reward scheme terms and conditions
Defines how customers can sign up to the reward scheme
Contacts will sign up upon registration automatically
Contacts can sign up manually
Contacts can be signed up on a selective and controlled manner (request to sign up), usually based on domain specific emails
Defines whether close loop (controlled) sign ups will be validated based on a third-party identification (external system) or domain specific emails. Required if the sign up option = controlled sign up
Defines the supported email domains for closed loop sign ups based on domain. Required when the sign up is based on email domain
The reward scheme state
GET https://sandbox.crm.com/backoffice/v1/reward_schemes/9fa92a4e-575e-7b76-6f8a-c189112789d6 HTTP/1.1
authorization: 4AD9C84FA60F9FE407140E20F707726A
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "9fa92a4e-575e-7b76-6f8a-c189112789d6",
"name": "CRMdotCOM Scheme",
"description": "The main reward scheme of CRMdotCOM",
"sign_up_option": "SELF_SIGN_UP"
}{id}/translations{id}/translations{id}/translations/actions{id}/translationsUpdate the content translations for an existing reward scheme
Path variables
The reward scheme (identifier) of which content translations will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The content translations for the specified language
The content (attribute) key
The content (attribute) translated value
Responses
The request has succeeded
PUT https://sandbox.crm.com/backoffice/v2/reward_schemes/a42dd7c4-e755-92fb-963b-5f658a59908e/translations HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
[
{
"language_code": "EN",
"translations": [
{
"key": "name",
"value": "10% cashback return"
}
]
}
]
HTTP/1.1 204 No Content {id}/translationsRetrieve the content translations for an existing reward scheme
Path variables
The reward scheme (identifier) of which content translations will be retrieved
Request parameters
Filter based on language
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The content translations for the specified language
The content (attribute) key
The content (attribute) translated value
GET https://sandbox.crm.com/backoffice/v2/reward_schemes/a42dd7c4-e755-92fb-963b-5f658a59908e/translations HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"language_code": "EN",
"translations": [
{
"key": "name",
"value": "10% cashback return"
}
]
}
]
}{id}/translations/actionsPerform content translation actions on a reward scheme (e.g. export a reward scheme’s translations)
Path variables
The reward scheme (identifier) of which content translation actions will be performed
Notes
Importing content translations should be made based on the following API order
Exporting content translations into different file should be made using the following API order
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The action that will be applied
The file (identifier) that will be used for importing translations (required only for import action)
The file (identifier) that will be used for importing translations (required only for import action)
The file (mime type) that will be used for exporting translations (required only for export action)
Responses
The request has succeeded
PUT https://sandbox.crm.com/backoffice/v2/reward_schemes/a42dd7c4-e755-92fb-963b-5f658a59908e/translations/actions HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"action": "IMPORT",
"file": {
"id": "1e347d4d-ab96-6957-fdb6-35e72b3d9185"
}
}
HTTP/1.1 204 No Content PUT https://sandbox.crm.com/backoffice/v2/reward_schemes/a42dd7c4-e755-92fb-963b-5f658a59908e/translations/actions HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"action": "EXPORT",
"file": {
"mime": "json"
}
}
HTTP/1.1 204 No Content Retrieve a list of organisations (business, merchant/service provider) based on search criteria (e.g. all merchants)
Request parameters
Filter based on organisation name
Filter based on whether the organisation (business/merchant) has (non-blocked) reward commercial terms
Defines whether transaction acquiring points should be retrieved or not
Defines whether reward scheme information should be retrieved or not
Defines whether venue/service point information should be retrieved or not
Defines whether custom fields will be retrieved or not
Filters based on custom fields (key/value set should be semicolon separated)
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The organisation identifier
The organisation name
Indicates whether the organisation has no other child organisations
Information about the transaction acquiring points (retrieved only if requested)
Information about the organisation’s external references
The tap identifier
The tap name
The tap code
The transaction acquiring point type
Optional specification of external reference
Defines whethe tap is active or not
Information about the reward schemes that the organisation participates (retrieved only if requested)
The reward scheme that the offer belongs to
The reward scheme identifier
The reward scheme name
Details about the venues of the merchant (retrieved only if requested)
The organisation identifier
The organisation name
Details about the organisation’s taps (retrieved only if requested)
Information about the organisation’s external references
The tap identifier
The tap name
The tap code
The custom field’s unique key
The custom field’s value
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/rewards/merchants HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "4f234f2f-d993-4c36-2c80-ba2ff7e5df24",
"name": "Delicious Burger",
"is_parent": true,
"taps": [
{
"id": "cd953fe3-e2f6-2ae2-8a40-1bd8154c0f29",
"name": "ePOS",
"code": "EP12"
}
],
"reward_schemes": [
{
"id": "622175bf-03b0-4e9e-9df9-adf85080a889",
"name": "Coffee Scheme"
}
],
"venues": [
{
"id": "01f18103-75e0-10b1-31c1-74523f240911",
"name": "Delicious Burger Nicosia",
"taps": [
{
"id": "cd953fe3-e2f6-2ae2-8a40-1bd8154c0f29",
"name": "ePOS",
"code": "EP12"
}
]
}
],
"custom_fields": [
{
"key": "back_office",
"value": "0001-12345"
}
]
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}{id}{id}{id}/actions{id}/contactsCreate a new segment
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The segment’s name which i smandatory and has to be unique
How often the segment is automatically refreshed - provided in a cron expression pattern
Defines which organisations can be access and use it
Defines which organisations can access and use it
The organisations (Merchants, Service Providers) that can access and use it (applicable only if type = SPECIFIC)
The segment conditions
The segment’s groups of conditions
The name of the conditions group. If not specified, then the group is named after a letter of the Latin alphabet starting from A, then B etc.
Each group includes conditions that refer to either an Event that was performed or Contact information
The name of the event that a contact performed or not. Applicable and required only for conditions of type Event. If not specified, then contacts that performed any event are eligible to be included in the segment
Defines the operator that will be used accoridng to the condition’s type. When the condition refers to an Event, then contact are included in the segment if they did or did not perform that Event. When the condition refers to Contact information, then contacts are included in the segment if they have or do not have the specified contact related information.
Applicable for Events only
Applicable for Events only
Applicable for Contacts only
Applicable for Contacts only
The frequency of an event, i.e hw many times an Event occured withn a period of time. Applicable and required for Event conditions.
The frequency’s operator
The minimum number of times the Event occured.
The maximum number of times the Event occured. Required only when the operator is set to BETWEEN
The period of time during which the Event(s) occured
The operator that shows he period of time during which Events must fall within in order for contacts to be included in the segment. Operators Between, On, Since require date(s) filters, whereas the rest of the operators need an integrer value(s)
The starting period of time. For dates, this should be an epoch value
The ending period. Required only for Between operator. For dates, this should be an epoch value
The from/to filters date type depending on the selected operator.
Multiple properties can be added to apply additional filtering on the conditions. So if more than one properties are specified, an operator is required that defines the logic between properties. This operator can only be ALL (all properties must be met) or ANY (at least one must be met) to incldue the contact in the segment.
List of event properties/attibutes that can be used as additional filtering conditions.
The name of the property which depends on the selected event. Each event has its own set of properties.
The property’s condition operator
The property’s value or in the case of range operator like Between, the starting value.
The maximum value for the property, required when using “range” operators like Between.
List of String values required when the operator implies multiple values comparison like Contains,Does not contain.
The property’s data type
Applicable only if the property is a list and represents the list name
The logical expression between the Groups. Required if more than one groups are specified
Examples
Responses
The request has succeeded
Body
The segment identifier
POST https://sandbox.crm.com/backoffice/v2/segments HTTP/1.1
Content-Type: application/json
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
{
"name": "Marketing customers",
"description": "A list of customers that own an accoun",
"refresh_frequency": "0 0 12 * * ?",
"accessibility": {
"type": "SPECIFIC_ORG",
"organisations": [
"CAD1E31269B76D7A65ACCE45B2E68DFD"
]
},
"conditions": {
"groups": [
{
"name": "A",
"type": "CONTACT",
"event_name": "ORDER",
"inclusion": "HAVE",
"frequency": {
"operator": "AT_LEAST",
"min_times": 1,
"max_times": 5,
"period": {
"operator": "LAST_HOURS",
"from": "1",
"to": "3",
"type": "DATE"
}
},
"properties_operator": "ALL",
"properties": [
{
"property": "purchase.amount",
"operator": "LIKE",
"min_value": "5.00",
"max_value": "10",
"value_list": [
""
],
"type": "INTEGER",
"list_name": "products"
}
]
}
],
"logical_expression": "(A OR B) AND C"
}
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "a48eedcf-566f-de3e-684b-570bfbb4010c"
}{id}Update an existing segment
Path variables
The segment (identifier) that will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The segment name
The segment’s description
How often the segment is automatically refreshed - provided in a cron expression pattern
Defines which organisations can be access and use it
Defines which organisations can access and use it
The organisations (Merchants, Service Providers) that can access and use it (applicable only if type = SPECIFIC)
The segment conditions
The segment’s groups of conditions
The name of the conditions group. If not specified, then the group is named after a letter of the Latin alphabet starting from A, then B etc.
Each group includes conditions that refer to either an Event that was performed or Contact information
The name of the event that a contact performed or not. Applicable and required only for conditions of type Event. If not specified, then contacts that performed any event are eligible to be included in the segment
Defines the operator that will be used accoridng to the condition’s type. When the condition refers to an Event, then contact are included in the segment if they did or did not perform that Event. When the condition refers to Contact information, then contacts are included in the segment if they have or do not have the specified contact related information.
Applicable for Events only
Applicable for Events only
Applicable for Contacts only
Applicable for Contacts only
The frequency of an event, i.e hw many times an Event occured withn a period of time. Applicable and required for Event conditions.
The frequency’s operator
The minimum number of times the Event occured.
The maximum number of times the Event occured. Required only when the operator is set to BETWEEN
The period of time during which the Event(s) occured
The operator that shows he period of time during which Events must fall within in order for contacts to be included in the segment. Operators Between, On, Since require date(s) filters, whereas the rest of the operators need an integrer value(s)
The starting period of time. For dates, this should be an epoch value
The ending period. Required only for Between operator. For dates, this should be an epoch value
The from/to filters date type depending on the selected operator.
Multiple properties can be added to apply additional filtering on the conditions. So if more than one properties are specified, an operator is required that defines the logic between properties. This operator can only be ALL (all properties must be met) or ANY (at least one must be met) to incldue the contact in the segment.
List of event properties/attibutes that can be used as additional filtering conditions.
The name of the property which depends on the selected event. Each event has its own set of properties.
The property’s condition operator
The property’s value or in the case of range operator like Between, the starting value.
The maximum value for the property, required when using “range” operators like Between.
List of String values required when the operator implies multiple values comparison like Contains,Does not contain.
The property’s data type
Applicable only if the property is a list and represents the list name
The logical expression between the Groups. Required if more than one groups are specified
Responses
The request has succeeded
Body
The segment identifier
PUT https://sandbox.crm.com/backoffice/v2/segments/c0d4712e-6688-4604-b3d6-d084e4d2dc05 HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"name": "All Contacts",
"description": "List of contacts owning a non-terminated account",
"refresh_frequency": "0 0 12 * * ?",
"accessibility": {
"type": "BUSINESS",
"organisations": [
"CAD1E31269B76D7A65ACCE45B2E68DFD"
]
},
"conditions": {
"groups": [
{
"name": "A",
"type": "EVENT",
"event_name": "PAYMENT",
"inclusion": "HAVE_NOT",
"frequency": {
"operator": "AT_LEAST",
"min_times": 1,
"max_times": 5,
"period": {
"operator": "LAST_MONTHS",
"from": "1",
"to": "3",
"type": "DATE"
}
},
"properties_operator": "ALL",
"properties": [
{
"property": "purchase.amount",
"operator": "IS_NOT",
"min_value": "5.00",
"max_value": "10",
"value_list": [
""
],
"type": "NUMBER",
"list_name": "products"
}
]
}
],
"logical_expression": "(A OR B) AND C"
}
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "c0d4712e-6688-4604-b3d6-d084e4d2dc05"
}{id}Delete an existing segment
Path variables
The segment (identifier) that will be deleted
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeded
DELETE https://sandbox.crm.com/backoffice/v2/segments/c0d4712e-6688-4604-b3d6-d084e4d2dc05 HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 204 No Content Retrieve a list of segments based on search criteria (e.g. all contacts)
Request parameters
Search for segments based on their name or description
The date on which the segment was created. The value can be a string with a date in epoch format. Each option must also include an operator. Use up to two of the following options based on the required search:
Returns results where the ‘created on’ field is greater than this value.
Return results where the ‘created on’ field is greater than or equal to this value.
Return results where the ‘created on’ field is less than or equal to this value.
Return results where the ‘created on’ field is less than or equal to this value.
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeded
Body
The segment identifier
The segment name
The segment description
The segment size (total number of contacts)
The analytics tool from which the segment was imported
How often the segment is automatically refreshed (represented as a cron expression)
Defines how the segment can be accessed from business network
Defines which organisations can access and use it
The organisations (Merchants, Service Providers) that can access and use it (applicable only if type = SPECIFIC)
The organisation identifier
The organisation name
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/segments HTTP/1.1
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "3c936a49-0a40-1785-a636-ff7e872a987e",
"name": "Marketing customers",
"descripion": "List customers owning an account",
"size": 95,
"imported_from": "MIXPANEL",
"resfresh_frequency": "0 0 12 * * ?",
"accessibility": {
"type": "SPECIFIC_ORG",
"organisations": [
{
"id": "feedcd4b-8470-04b3-73bf-9ce9a4340822",
"name": "CRM"
}
]
}
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Retrieve detailed information for a segment
Path variables
The segment (identifier) that will be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The segment identifier
The segment name
The segment description
How often the segment is automatically refreshed (represented as a cron expression)
The segment size (total number of contacts)
The analytics tool from which the segment was imported
Defines how the segment can be accessed from business network
Defines which organisations can access and use it
The organisations (Merchants, Service Providers) that can access and use it (applicable only if type = SPECIFIC)
The organisation identifier
The organisation name
The segment conditions
The segment’s groups of conditions
The name of the conditions group. If not specified, then the group is named after a letter of the Latin alphabet starting from A, then B etc.
Each group includes conditions that refer to either an Event that was performed or Contact information
The name of the event that a contact performed or not. Applicable and required only for conditions of type Event. If not specified, then contacts that performed any event are eligible to be included in the segment
Defines the operator that will be used accoridng to the condition’s type. When the condition refers to an Event, then contact are included in the segment if they did or did not perform that Event. When the condition refers to Contact information, then contacts are included in the segment if they have or do not have the specified contact related information.
Applicable for Events only
Applicable for Events only
Applicable for Contacts only
Applicable for Contacts only
The frequency of an event, i.e hw many times an Event occured withn a period of time. Applicable and required for Event conditions.
The frequency’s operator
The minimum number of times the Event occured.
The maximum number of times the Event occured. Required only when the operator is set to BETWEEN
The period of time during which the Event(s) occured
The operator that shows he period of time during which Events must fall within in order for contacts to be included in the segment. Operators Between, On, Since require date(s) filters, whereas the rest of the operators need an integrer value(s)
The starting period of time. For dates, this should be an epoch value
The ending period. Required only for Between operator. For dates, this should be an epoch value
The operator that shows he period of time during which Events must fall within in order for contacts to be included in the segment. Operators Between, On, Since require date(s) filters, whereas the rest of the operators need an integrer value(s)
Multiple properties can be added to apply additional filtering on the conditions. So if more than one properties are specified, an operator is required that defines the logic between properties. This operator can only be ALL (all properties must be met) or ANY (at least one must be met) to incldue the contact in the segment.
List of event properties/attibutes that can be used as additional filtering conditions.
The name of the property which depends on the selected event. Each event has its own set of properties.
The property’s condition operator
The property’s value or in the case of range operator like Between, the starting value.
The maximum value for the property, required when using “range” operators like Between.
List of String values required when the operator implies multiple values comparison like Contains,Does not contain.
The property’s data type
Applicable only if the property is a list and represents the list name
The logical expression between the Groups. Required if more than one groups are specified
GET https://sandbox.crm.com/backoffice/v2/segments/ad7a97fe-104a-8eb1-a49b-1f4b766e53a8 HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "ad7a97fe-104a-8eb1-a49b-1f4b766e53a8",
"name": "Marketing contacts",
"description": "List contacts owning an account",
"refresh_frequency": "0 0 12 * * ?",
"size": 2,
"imported_from": "MIXPANEL",
"accessibility": {
"type": "BUSINESS",
"organisations": [
{
"id": "feedcd4b-8470-04b3-73bf-9ce9a4340822",
"name": "CRM"
}
]
},
"conditions": {
"groups": [
{
"name": "A",
"type": "CONTACT",
"event_name": "AWARD",
"inclusion": "DID",
"frequency": {
"operator": "AT_LEAST",
"min_times": 1,
"max_times": 5,
"period": {
"operator": "LAST_MONTHS",
"from": "3",
"to": "5",
"type": "SINCE"
}
},
"properties_operator": "ALL",
"properties": [
{
"property": "purchase.amount",
"operator": "BETWEEN",
"min_value": "5.00",
"max_value": "10",
"value_list": [
""
],
"type": "INTEGER",
"list_name": "products"
}
]
}
],
"logical_expression": "(A OR B) AND C"
}
}{id}/actionsPerform an action on an existing segment.
Path variables
The segment (identifier) on which an action is performed
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The action to be performed on the segment
Update the segment contacts based on conditions
Export the contacts of a segment to a .csv file and send it to the logged in user’s email
Responses
The request has succeeded
Body
The segment identifier
PUT https://sandbox.crm.com/backoffice/v2/segments/d24a32fd-fac8-3bc0-66a1-533ae7c4707f/actions HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"action": "REFRESH"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "d24a32fd-fac8-3bc0-66a1-533ae7c4707f"
}{id}/contactsReturns a list of contacts which are included in an existing segment.
Path variables
The segment (identifier) of which contact will be retrieved
Request parameters
Search for contacts based on their code, name, phone or email address
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The contact’s unique identifier
The contact’s name (full name for Persons, company name for Companies)
The contact’s code
The contact’s phone number (including counry code)
The contact’s email address
The contact’s phone number
The phone country code (based on ISO 3 char code)
The phone number
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v1/segments/{id}/contacts HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "4AD9C84FA60F9FE407140E20F707726A",
"name": "John Smith",
"code": "0049304938571623",
"phone_number": "+306954000112",
"email_address": "bill@gmail.com"
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}Service Requests are customer requests submitted either by a back-end user (using CRM.COM), or a Contact (via a self-service platform such as an app or portal), to initiate a service action.
{id}{id}{id}{id}/actions{id}/queues/stagesCreate a new service request for a contact. New service requests will automatically acquire a state of ‘New’, and a queue stage of ‘New’ (i.e. the first stage in the queue set up).
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The unique identifier of the contact for whom the service request is being raised
The id of the queue which will be assigned to the service request
Description of the required service
Service request address information
The contact’s address id associated to the service request (either ‘id’ or ‘other’ can be specified)
The address line 1
The address line 2
The address state/province/county
The address town/city
The address postal code
The address country (based on ISO 3 char code)
The latitude of the address
The longitude of the address
The Google textual identifier that uniquely identifies an address
List any entities being affected by the issue on the service request
The unique id of the entity (e.g. id of a subscription service)
The entity type
The categories applicable to this service request. Each service request has a unique set of categories.
Service request category unique id
Service request owner
The user identifier
The team identifier
Urgency and impact settings are used to calculate the priority of a service request according to queue settings, if not provided then defaults to MEDIUM for both levels
Other service requests linked to this one
The id of the service request to be linked
Custom fields relevant to this service request
The custom field’s unique key
The custom field’s value
Responses
Body
The GUID for the new service request created
POST https://sandbox.crm.com/backoffice/v2/service_requests HTTP/1.1
Content-Type: application/json
{
"contact_id": "33f6614d-0c25-4bc6-b360-fa74687956b8",
"queue_id": "3203babc-8588-477c-9fe4-d5c6da754fb8",
"description": "The customer has a recurring issue with their billing.",
"address": {
"id": "61c943c8-dfeb-4c09-a25c-b054f48bf244",
"other": {
"address_line_1": "Elia Papakyriakou",
"address_line_2": "7 Tower Stars",
"state_province_county": "Egkomi",
"town_city": "Nicosia",
"postal_code": "2015",
"country": "CYP",
"lat": 35.157115,
"lon": 33.313719,
"google_place_id": "ChIJrTLr-GyuEmsRBfy61i59si0"
}
},
"affected_entities": [
{
"id": "33f6614d-0c25-4bc6-b360-fa74687956b8",
"type": "SUBSCRIPTION_SERVICES"
}
],
"categories": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}
],
"assign_to": {
"user_id": "1edef819-0a1d-4d41-9d2a-d4bbc2ddbedf",
"team_id": "a43f08ca-998b-afbc-6ed4-c9dc2d136935"
},
"priority_matrix": {
"urgency": "MEDIUM",
"impact": "LOW"
},
"links": [
{
"id": "12640ac3-effa-406e-a09f-a8e6e9c3c120"
}
],
"custom_fields": [
{
"key": "back_office",
"value": "0001-12345"
}
]
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "33f6614d-0c25-4bc6-b360-fa74687956b8"
}{id}Update an existing service request for a contact
Path variables
The GUID of the service request to be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Description of the required service
The approximate closing date & time of the service request (based on queue and priority settings)
The calculated alert time based on the queue type and priority set for this service request, alert times are configured to notify users when a service request has not progressed from the ‘New’ status
Urgency and impact settings are used to calculate the priority of a service request according to queue configuration
One or more categories associated to service request
Service request category unique id
If the service request is being raised for a particular contact entity (e.g. subscription) then provide details here
The unique id of the entity (e.g. id of a subscription service)
The entity type
The user identifier
The team identifier
Service request address information
The contact’s address id associated to the service request (either ‘id’ or ‘other’ can be specified)
The address line 1
The address line 2
The address state/province/county
The address town/city
The address postal code
The address country (based on ISO 3 char code)
The latitude of the address
The longitude of the address
The Google textual identifier that uniquely identifies an address
Other service requests linked to this one
The id of the service request to be linked
Custom fields relevant to this service request
The custom field’s unique key
The custom field’s value
Update the comments of a stage
Stage id
Specific stage comment
Responses
Body
The GUID for the updated service request
PUT https://sandbox.crm.com/backoffice/v2/service_requests/33f6614d-0c25-4bc6-b360-fa74687956b8 HTTP/1.1
Content-Type: application/json
{
"description": "The customer has a recurring issue with their billing.",
"approximate_close_date": 1653310820,
"alert_date": 1655989275,
"priority_matrix": {
"urgency": "MEDIUM",
"impact": "LOW"
},
"categories": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}
],
"affected_entities": [
{
"id": "33f6614d-0c25-4bc6-b360-fa74687956b8",
"type": "SUBSCRIPTION_SERVICES"
}
],
"assign_to": {
"user_id": "1edef819-0a1d-4d41-9d2a-d4bbc2ddbedf",
"team_id": "a43f08ca-998b-afbc-6ed4-c9dc2d136935"
},
"address": {
"id": "61c943c8-dfeb-4c09-a25c-b054f48bf244",
"other": {
"address_line_1": "Elia Papakyriakou",
"address_line_2": "7 Tower Stars",
"state_province_county": "Egkomi",
"town_city": "Nicosia",
"postal_code": "2015",
"country": "CYP",
"lat": 35.157115,
"lon": 33.313719,
"google_place_id": "ChIJrTLr-GyuEmsRBfy61i59si0"
}
},
"links": [
{
"id": "12640ac3-effa-406e-a09f-a8e6e9c3c120"
}
],
"custom_fields": [
{
"key": "back_office",
"value": "0001-12345"
}
],
"stage": {
"id": "609a369e-3f10-492a-8332-679ecbe56b65",
"comment": "Ensure that customer submits signed agreement prior to progressing to the next stage"
}
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "33f6614d-0c25-4bc6-b360-fa74687956b8"
}{id}Delete a single service request. The service request can be in any stage or state (New, In Progress, Closed)
Path variables
The segment (identifier) that will be deleted
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeded
DELETE https://sandbox.crm.com/backoffice/v2/service_requests/c0d4712e-6688-4604-b3d6-d084e4d2dc05 HTTP/1.1
HTTP/1.1 204 No Content Retrieve service requests according to applied filters
Request parameters
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Search for a service request using Contact person’s name, Owner, Description, number,status, date_created, date_closed
he queue GUID (to view service request)
The unique contact id
Whether the SR is resolved. Default is unresolved
Filter based on the created date, which may fall within a given date range. The value can be a string with a date in epoch format. Each option must also include an operator. Use up to two options based on the required search (e.g. created_on[gte]=1618395497&created_on[lt]=1618395497).
Returns results where the created date is greater than this value
Returns results where the created date is greater than or equal to this value
Returns results where the created date is less than this value
Returns results where the created date is less then or equal to this value
Filter based on priority
Array of queue stage ids
List of tag ids to filter by
Defines whether tags should be retrieved or not
List of closure reasons to filter by
The approximate closure date of SR. Date range. ie. between today and next week Monday.The value can be a string with a date in epoch format. Each option must also include an operator. Eg: &approximate_close_date.[gte]=1609459200&approximate_close_date.[lt]=1609459200. Use up to two of the following options based on the required search:
Returns results where the ‘approx_close_date’ field is greater than this value.
Return results where the ‘approx_close_date’ field is greater than or equal to this value.
Return results where the ‘approx_close_date’ field is less than or equal to this value.
Return results where the ‘approx_close_date’ field is less than or equal to this value.
The alert dates of SR’s. Date range. ie. between today and next week Monday.The value can be a string with a date in epoch format. Each option must also include an operator. Eg: &alert_date.[gte]=1609459200&alert_date.[lt]=1609459200. Use up to two of the following options based on the required search:
Returns results where the ‘alert_date’ field is greater than this value.
Return results where the ‘alert_date’ field is greater than or equal to this value.
Return results where the ‘alert_date’ field is less than or equal to this value.
Return results where the ‘alert_date’ field is less than or equal to this value.
Defines whether custom fields should be retrieved or not (via List/Get APIs)
Filters based on custom fields (key/value set should be semicolon separated)
Filter by category ids
Filters based on specific assign to user
Filters based on specific assign to team
Defines whether approval requests information should be retrieved or not
Filter based on approval state
Filer according to service request state(s)
Search for Service Requests based on the address at which they will be delivered
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
The service request unique identifier
The unique Service Request number geerated based on Numbering schemes.
A brief description of the service request
Date service request was created
The calculated alert time based based on queue and priority settings of the service request
The approximate closing date of the service request, calculated according to the queue and priority of the service request
Has the service request been resolved?
service request queue information
The service request queue id
The service request queue name
Current queue stage information of the service request
Id of the current queue stage that the service request is in
The name of the current queue stage
The hex colour code associated to the status
Details about the related contact
The contact identifier
The contact full name
The contact unique code
The service request closure reason, applicable only when a service request has been closed
The id of the closure reason for this service request
The closure reason name
Tags associated with the service request
Tag unque id
Tag name
The colour of the tag - for list view only
Details about the user that the record is assigned to
The user identifier
The user name
The username of the user
Details about team
The team identifier
The team name
Details about the application
The approval request state
The custom field (unique) key
The custom field’s (provided) value
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/service_requests HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "33f6614d-0c25-4bc6-b360-fa74687956b8",
"number": "SR123ABC",
"description": "Customer is interested in upgrading to DELUXE 10",
"state": "CLOSED",
"creation_date": 1655989220,
"alert_date": 1672837220,
"approximate_close_date": 1,
"priority": "URGENT",
"resolved": true,
"queue": {
"id": "c84beadd-52f0-4d2a-aa5e-5b81a9978056",
"name": "Billing Issues"
},
"stage": {
"id": "07132e7d-b4a0-4070-ad7b-7df2a8be0ebf",
"name": "Proposal submitted",
"colour": "#FDS7GH"
},
"contact": {
"id": "1c060611-0667-313e-b3bf-4cb70ee81cdf",
"name": "John Doe",
"code": "C12905723"
},
"closure_reason": {
"id": "a90b9421-195f-4e41-867f-b8fcb4c5161a",
"name": "Referred to associate Tech.Com"
},
"tags": [
{
"id": "609a369e-3f10-492a-8332-679ecbe56b65",
"name": "Maintenance",
"colour": "FR547F"
}
],
"assign_to": {
"user": {
"id": "47ac694d-6281-b873-bf46-3fd8da334a3a",
"name": "John Doe",
"username": "j_doe@crm.com"
},
"team": {
"id": "bf1370a1-73ad-0bbf-6fef-f2ce1938d4fe",
"name": "Support"
}
},
"approvals": {
"state": "APPROVED"
},
"custom_fields": [
{
"key": "back_office",
"value": "Back Office"
}
]
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Retrieve the information for a specific service request.
Path variables
The service request GUID to be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
Service request id
Service request number
Service request description
Details about the related contact
The contact identifier
The contact full name
The contact unique code
Applicable if the service request has been ‘Closed’
Date service request was created
The approximate closing date of the service request, calculated according to the queue and priority of the service request
The calculated alert time based based on queue and priority settings of the service request
Has service request been resolved? Applicable only when service request has been closed
Service request queue information
The service request queue id
The service request queue name
Current queue stage information of the service request
Id of the current queue stage that the service request is in
The name of the queue stage
The hex colour code used for this stage
Priority information
The closure reason, applicable only if service request has been closed without being resolved
The id of the closure reason
Closure reason name
The invoice raised against the service request when the service request was closed, applicable only if charges have been incurred
Invoice unique id
Invoice number
If the service request raised for a specific contact entity
The unique GUID of the affected entity (e.g. a subscription service)
The type of entity
The name/number of the object. If the entity_type is SUBSCRIPTION_SERVICES then the entity_value should be the service’s name (product name)
The categories assigned to the service request
The id of the category
The name of the category
Details about the user that the record is assigned to
The user identifier
The user name
The username of the user
Details about team
The team identifier
The team name
Details about the application
The approval request state
The id of the service request to be linked
The ticket number of the linked service request
The custom field’s unique key
The custom field’s value
GET https://sandbox.crm.com/backoffice/v2/service_requests/609a369e-3f10-492a-8332-679ecbe56b65 HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "609a369e-3f10-492a-8332-679ecbe56b65",
"number": "SR0001ABC",
"description": "STB error",
"contact": {
"id": "1c060611-0667-313e-b3bf-4cb70ee81cdf",
"name": "John Doe",
"code": "C123"
},
"closing_comment": "Installation issue resolved by external counterpart H & P Ltd.",
"creation_date": 1672837220,
"approximate_close_date": 1704459620,
"alert_date": 1672837220,
"resolved": true,
"queue": {
"id": "84beadd-52f0-4d2a-aa5e-5b81a9978056",
"name": "Billing issues"
},
"stage": {
"id": "07132e7d-b4a0-4070-ad7b-7df2a8be0ebf",
"name": "Response submitted",
"colour": "#FA89CB"
},
"priority_matrix": {
"priority": "MEDIUM",
"urgency": "LOW",
"impact": "MEDIUM"
},
"closure_reason": {
"id": "07132e7d-b4a0-4070-ad7b-7df2a8be0ebf",
"name": "To be handled by associate Tech.Com"
},
"invoice": {
"id": "33f6614d-0c25-4bc6-b360-fa74687956b8",
"number": "INV87386IUGY"
},
"affected_entities": [
{
"id": "a5a02147-3d9b-4363-aaf0-83eb0a3f6e92",
"type": "SUBSCRIPTION_SERVICES",
"value": "Streaming service P007NDR"
}
],
"categories": [
{
"id": "c8ddcdbc-3873-46e6-adb8-6b317e5f8079",
"name": "Maintenance"
}
],
"assign_to": {
"user": {
"id": "47ac694d-6281-b873-bf46-3fd8da334a3a",
"name": "John Doe",
"username": "j_doe@crm.com"
},
"team": {
"id": "bf1370a1-73ad-0bbf-6fef-f2ce1938d4fe",
"name": "Support"
}
},
"address": {
"address_line_1": "Elia Papakyriakou",
"address_line_2": "7 Tower Stars",
"state_province_county": "Egkomi",
"town_city": "Nicosia",
"postal_code": "2015",
"country": "CYP",
"lat": 35.157115,
"lon": 33.313719,
"google_place_id": "ChIJrTLr-GyuEmsRBfy61i59si0"
},
"approval": {
"state": "APPROVED"
},
"links": [
{
"id": "12640ac3-effa-406e-a09f-a8e6e9c3c120",
"number": "SR00103"
}
],
"custom_fields": [
{
"key": "back_office",
"value": "0001-12345"
}
]
}{id}/actionsAction a service request, in one of the following ways:
- Progress a service request to another stage in the queue
- Regress a service request to the previous stage in the queue
- Change the state of a service request (e.g. from ‘In Progress’ to ‘Closed’)
Path variables
The GUID of the service request for which an action will be performed against, can be one of:
- id of the service request whose state will be changed
- id of the service request whose queue stage will be changed
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Action to be performed against the service request
Change the service request state to ‘In Progress’ from ‘New’
Change the service request state to ‘Closed’
Progress a service request to the next stage in the queue
Regress a service request to a previous stage in the queue
The new queue stage id, applicable and required if action = PROGRESS
Date & time action was performed, defaults to current date & time. Required for all actions
Optional comments relevant to the stage of the queue, applicable if action = PROGRESS or REGRESS. Multiple comments can be created per stage
Has the ticket been resolved? Applicable only when action = CLOSE
Reason for closing the ticket, appliable only when action = CLOSE and resolved = false
The account id relating to the charges associated with the service request. This account will be invoiced for the charges when closing the service request.
Any user comments added prior to closing the service request, appliable only when action = CLOSE
Responses
Body
The GUID of the service request which has been actioned
Determines whether approval reuqests are applied or not, if not null an approval is requested
The service approval identifier
PUT https://sandbox.crm.com/backoffice/v2/service_requests/6f279898-d873-4175-941f-77eec76709c1/actions HTTP/1.1
Content-Type: application/json
{
"action": "PROGRESS",
"stage_id": "6f279898-d873-4175-941f-77eec76709c1",
"date_achieved": 1583846865,
"comment": "The customer must submit their signed contract asap",
"resolved": true,
"closure_reason_id": "6f89ff50-4dc8-42cc-862f-4f0a50e5f8f9",
"account_id": "038af54e-282c-40ad-ae5d-cc74f2c80f40",
"closing_comment": "This issue is closed and mitigated. Faulty installation."
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "6f279898-d873-4175-941f-77eec76709c1",
"approval_requests": [
{
"id": "3a4aad81-e5c2-72b7-3a86-903239d08767"
}
]
}{id}/queues/stagesRetrieve all the queue stages that a service request has progressed through until now.
Path variables
The GUID of the service request whose queue stages will be retrieved
Request parameters
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
The id of the service request
Date of achieving this stage
Service request current state
Queue stage information
Queue stage unique id
Queue stage order within the queue
Queue stage name
Stage hex colour code
Comment type - optional when progresssing to the next stage, mandatory if regressing to a previous stage
The comment body
Details of the user who performed the action
The GUID of the user
The name of the user
Date SR stage modified (relevant to service request history)
GET https://sandbox.crm.com/backoffice/v2/service_requests/1fda2322-ed57-4f2b-93e2-9198eebcea07/queues/stages HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "1fda2322-ed57-4f2b-93e2-9198eebcea07",
"date_achieved": 1653397883,
"state": "IN_PROGRESS",
"stage": {
"id": "2eb909cf-2467-4827-81ca-498ad4b2421f",
"order": 1,
"name": "Service Scheduled",
"colour": "#2c8ef8"
},
"comment_type": "REGRESS",
"comment": "The customer must submit their signed contract asap",
"performed_by": {
"id": "2fc8c9c8-9d66-4c58-84e1-949c68273e22",
"username": "Sam Jackson"
},
"modified_date": "1668428511"
}
]
}{id}/notes{id}/notes/{note_id}{id}/notes/{note_id}{id}/notes{id}/notesCreate a new note for a service request
Path variables
The service request (identifier) that a note will be added
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The note contents
Pinned notes appear at the top of the notes list
Examples
Responses
The request has succeeded
Body
The note identifier
POST https://sandbox.crm.com/backoffice/v2/service_requests/8ade0c06-6ba3-4ed0-9e04-228201e1b30c/notes HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"note": "After my telephone conversation with Zack this morning, it was decided that....",
"pinned": true
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "1edef819-0a1d-4d41-9d2a-d4bbc2ddbedf"
}{id}/notes/{note_id}Update a note for a service request. Only the user who created the note can edit it.
Path variables
The service request (identifier) whose note will be updated
The note (identifier) that will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The actual note contents
Pinned notes appear at the top of the notes list.
Examples
Responses
The request has succeeded
Body
The note identifier
PUT https://sandbox.crm.com/backoffice/v2/service_requests/8ade0c06-6ba3-4ed0-9e04-228201e1b30c/notes/1edef819-0a1d-4d41-9d2a-d4bbc2ddbedf HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"note": "After my telephone conversation with Zack this morning, it was decided that....",
"pinned": true
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "1edef819-0a1d-4d41-9d2a-d4bbc2ddbedf"
}{id}/notes/{note_id}Delete a single note for a service request. Only the user who created the note can delete it.
Path variables
The service request (identifier) of which a note will be deleted
The note (identifier) to be deleted
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
DELETE https://sandbox.crm.com/backoffice/v2/service_requests/8ade0c06-6ba3-4ed0-9e04-228201e1b30c/notes/1edef819-0a1d-4d41-9d2a-d4bbc2ddbedf HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 204 No Content {id}/notesRetrieve all notes for a single service request
Path variables
The service request (identifier) whose notes are to be retrieved
Request parameters
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Successful Request
Body
The note identifier
The note contents
Details of the user who created the note
The GUID of the user who created the note
The name of the user who created the note
Date and time the note was created
Date and time the note was updated
Is note pinned so that it appears at the top of the notes list?
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/service_requests/8ade0c06-6ba3-4ed0-9e04-228201e1b30c/notes HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "1edef819-0a1d-4d41-9d2a-d4bbc2ddbedf",
"note": "After my telephone conversation with Zack this morning, it was decided that....",
"created_by": {
"id": "c8079ee1-8081-4be1-ab09-5091f55b2d4e",
"username": "Sam Jackson"
},
"created_on": "9876577501",
"updated_on": "9876579547",
"pinned": "true"
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}/tags{id}/tags{id}/tagsUpdate the tags associated with the service request
Path variables
The service request (identifier) on which tags will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The tags that will be associated with the activity
Responses
The request has succeded
Body
The organisation identifier
PUT https://sandbox.crm.com/backoffice/v2/service_requests/d4187991-4d1a-4aa2-fa3e-ce5fe7fdb7d9/tags HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"tags": [
"96c3cb52-c68f-6ba6-e886-ed28f2b594cb"
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "d4187991-4d1a-4aa2-fa3e-ce5fe7fdb7d9"
}{id}/tagsRetrieve a list of tags that are associated with the service request
Path variables
The service request (identifier) of which tags will be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeded
Body
The tag identifier
The tag name
The tag color (hex code) that will be used for visual purposes
GET https://sandbox.crm.com/backoffice/v2/service_requests/d82881e9-a909-9d44-4f28-4b30fc1ac276/tags HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "1abe9097-d46a-d2ed-3415-fd3e1439d8d4",
"name": "VIP",
"colour": "#0000FF"
}
]
}{id}/attachments{id}/attachments/{file_id}{id}/files{id}/attachmentsConnect an uploaded attachment to an existing service request
Path variables
The service request (identifier) that attachment will be attached
Notes
Integrating attachments upload for Service Requests should be based on the following APIs
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The uploaded file signature (identifier) to be attached (file or link should be provided)
The URL endpoint to be attached (file or link should be provided)
The file description
Responses
The request has succeeded
Body
The attachment identifier
POST https://sandbox.crm.com/backoffice/v2/service_requests/66451204-4404-894c-4dc6-486c540ece40/files HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"file_id": "30526723-24a3-e4e3-1a75-b26b1b41f05c",
"url": "https://crmcom.sharepoint.com/:x:/s/servicerequests/EZx2qopbvfN3uj1o3dOqbPm52Ct6bg?rtime=w0ic-hfG2Ug",
"description": "Screenshot sent by customer"
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "66451204-4404-894c-4dc6-486c540ece40"
}{id}/attachments/{file_id}Delete a specific service request attachment
Path variables
The service request (identifier) that file will be deleted
The attachment file (identifier) that will be deleted
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
DELETE https://sandbox.crm.com/backoffice/v2/service_requests/66451204-4404-894c-4dc6-486c540ece40/files/04c0bebd-8bb0-0b3e-e1a6-716a0fd200b1 HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 204 No Content {id}/filesRetrieve all attachments for a specific service request
Path variables
The service request (identifier) that files will be retrieved
Request parameters
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The attachement identifier
The attachement description
The attached file
The attached file identifier
The attached file URL endpoint
The attached file name
The mime type of the uploaded file
The attached URL endpoint
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/service_requests/66451204-4404-894c-4dc6-486c540ece40/files HTTP/1.1
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "3ae9d64a-8a3b-f1e1-eed6-05b307f926fb",
"mime": "png",
"description": "this is a brief description of this image",
"file": {
"id": "0317868f-28f8-9f56-d248-5a78718b38cc",
"name": "img.png"
}
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}Charge the contact for a service request by adding products of type ‘non-traceable physical goods’, ‘expenses’, ‘one-time services’.
{id}/charges{id}/charges{id}/charges{id}/chargesCreate one or more charges for a service request with prices and taxes
Path variables
The service request (identifier) to create charges for
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Id of the account to be charged. If not specified, then the primary is used.
Line item information
The unique identifier of the product to be charged for, must be a product of type ‘physical goods’, ‘expenses’, ‘one-time service’
Quantity of product
The unit price of the product. If specified, then the pricing strategy is not applied.
Discount information
Product discount amount
Product discount percentage
Product discount including tax
Sub total
A note regarding the item
Total discount information
Total discount amount
Discount type
Responses
The request has succeeded
Body
The unique identifier of the Service Request
POST https://sandbox.crm.com/backoffice/v2/service_requests/{id}/charges HTTP/1.1
Content-Type: application/json
{
"account_id": "33f6614d-0c25-4bc6-b360-fa74687956b8",
"lines": [
{
"product_id": "3203babc-8588-477c-9fe4-d5c6da754fb8",
"quantity": 1,
"price": 9.99,
"discount": {
"amount": 2.05,
"percentage": 10.5,
"discount_incl_tax": 3.48
},
"sub_total": 10.36,
"notes": ""
}
],
"ad_hoc_discount": {
"amount": 1.49,
"type": "PERCENTAGE"
}
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}{id}/chargesUpdates charges for a service request
Path variables
The service request (identifier) to update charges for
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The account (identifier) of service request charges
The discount of service request charges
The discount amount
The discount type
The line items of service request charges
The product (identifier) item
The quantity of the item
The price of the item
The notes of the item
The sub-total of the item
The discount information
The discount amount
The discount percentage
The discount amount, including tax
Responses
Body
The service request identifier
PUT https://sandbox.crm.com/backoffice/v2/service_requests/4dc0809f-ed91-4b68-b912-5bd6064d901e/charges HTTP/1.1
Content-Type: application/json
{
"account_id": "",
"discount": {
"amount": 1,
"type": "AMOUNT"
},
"lines": [
{
"product_id": "",
"quantity": 1,
"price": 9.99,
"notes": "",
"sub_total": 1,
"discount": {
"amount": 1,
"percentage": 1,
"discount_incl_tax": 1
}
}
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}{id}/chargesRetrieve the charges associated to a service request
Path variables
The service request (identifier) to retrieve charges for
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
The account that the charges are associated with
The account identifier
The account name
The account number
The currency (code) applied on the charge
The ad hoc discount applied on the charge
The ad hoc discount amount
The ad hoc discount type
The line items of service request charge
The charged product
The product identifier
The product SKU
The product name
The quantity of the charged product item
The price of the charged product item
The tax model applied on the product item
The notes of the charged product item
The tax applied on the product item
The discount applied on the product item
The discount amount
The discount percentage
The discount including tax
The sub total of the charged line
The charge total amount
The charge net amount
The charge tax amount
The discount applied on the charge
The discunt amount
The discunt including tax
The charge sub-total amount
The charge due amount
GET https://sandbox.crm.com/backoffice/v2/service_requests/4dc0809f-ed91-4b68-b912-5bd6064d901e/charges HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"account": {
"id": "8f42c964-7049-0553-06da-04b06e99b3d5",
"name": "John Doe Account",
"number": "AR234234"
},
"currency_code": "EUR",
"ad_hoc_discount": {
"amount": 1,
"type": "PERCENTAGE"
},
"lines": [
{
"product": {
"id": "df42c964-7049-0553-06da-04b06e99b3a1",
"sku": "ILC0234",
"name": "Support Service"
},
"quantity": 1,
"price": 9.99,
"tax_model": "TAX_INCLUSIVE",
"notes": "",
"tax": 1,
"discount": {
"discount_amount": 1,
"discount_percentage": 1,
"discount_incl_tax": 1
},
"sub_total": 1
}
],
"total": 2,
"net": 1,
"tax": 1,
"discount": {
"amount": 1,
"amount_incl_tax": 1
},
"sub_total": 1,
"amount_due": 1
}{id}{id}/subscriptions{id}{id}/services{id}/billing{id}/allowance{id}/services{id}/services{id}{id}/devices{id}/devices{id}/devices{id}/devices/{device_id}{id}/devices{id}/allowed_devices{id}/services{id}/servicesCreates a new subscription for a Contact or an Organisation. A single subscription can be created per Web API call. The Web API can be used to set up the basic information of the subscription. Services can be added in a different Web API call.
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Contacts unique identifier. Either a contact or an orgnaisation should be specified
The organisaton’s unique identifier. This is the organisation that owns the subscription. Either a contact or an orgnaisation should be specified
The unique identifier of the contact’s or the organisation’s account. If not specified, then the primary account is used
The type of the event
If one of the contact’s payment methods is specified as the subscription’s payment method as well, then the Account is considered as the funding source. The account is also the default funding source if no payment method is specified.
The Wallet is the subscription’s funding source if subscriber specifically states that he/she wants to pay for the services using available wallet funds.
One of the contact’s/organisation’s payment methods that will be used for automatically paying off the subscription. If not specified, then the primary payment method will be used (if any).
The subscription’s address which must be one of the contact’s addresses. One of the two parameters must be specified
The unique identifer of the contact’s address
If set to true, then the primary address will be selected as the new subscription’s address
The subscription’s billing day which can either be a day of a month (for subscriptions with billing cycles longer than a month) or a week day (for subscriptions with cycles of duration less than a month)/
Day of month
The billing cycle’s duration
Billing cycle duration
Billing cycle unit of time
Examples
Responses
The request has succeeded
Body
The GUID for the new subscription
POST https://sandbox.crm.com/backoffice/v2/subscriptions HTTP/1.1
Content-Type: application/json
{
"contact_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"organisation_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"account_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"funding_source": "ACCOUNT",
"payment_method_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"address": {
"address_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"use_primary": "true"
},
"billing_day": {
"day_of_month": 1,
"day_of_week": "THURSDAY"
},
"billing_period": {
"duration": 1,
"uot": "MONTHS"
}
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}{id}Update the Subscription’s billing terms or perform changes for group of services. Services of the same billing period are grouped under the same subscription, so by updating the subscription, these changes are applied to all of its services.
Path variables
The subscription (identifier) that will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The change to be performed on the Subscription.
Change the billing day
Set, remove or change the subscription’s payment method
Activate all of the services of the subscription
Deactivate all of the subscription services
Cancel all of the subscription services
Regret all of the subscription services
Pause all of the subscription services
Resume all of the subscription services. Applicable only when services are Paused.
Apply a grace period that prevents deactivations due to debt.
Perform any other updates on generin subscription information.
The action’s category unique identifier
Schedule the update’s execution on a future date.
In case where business rules dectate an allowed date of execution for the update, set this fields to True so as the update will be automatically performed on the system’s proposed scheduled date (instead of setting the scheduled_date manually).
One of the contact’s/organisation’s payment methods. Required when changing the payment preference of the subscription’s terms
Required when changing the billing day of the subscription’s terms
Applies for weekly subscriptions
Applies for subscriptions with billing cycles over a month
Required when pausing all of the services of a subscription or when applying a grace period to the subscription
The updated subscription’s address which must be one of the contact’s addresses. Applicable only when using the UPDATE action
The type of the event
If one of the contact’s payment methods is specified as the subscription’s payment method as well, then the Account is considered as the funding source. The account is also the default funding source if no payment method is specified.
The Wallet is the subscription’s funding source if subscriber specifically states that he/she wants to pay for the services using available wallet funds.
Responses
Body
The new subscripton action’s unique identifier
A proposed date on which the requested changes can be scheduled (indicates that the update cannot be immediatelly performed). This date is returned when business rules dectate the scheduled date of the update. Use this date on a subsequest call to schedule the required update or in a subsequent call set “use_proposed_date” as True.
PUT https://sandbox.crm.com/backoffice/v2/subscriptions/ac5401c3-b2e6-2d99-171f-276084d97536 HTTP/1.1
Content-Type: application/json
{
"action": "CANCEL",
"category_id": "ac5401c3-b2e6-2d99-171f-276084d97536",
"scheduled_date": 1667981700,
"use_proposed_date": true,
"payment_method_id": "ac5401c3-b2e6-2d99-171f-276084d97536",
"billing_day": {
"day_of_week": "MONDAY",
"day_of_month": 15
},
"number_of_days": 5,
"address_id": "ac5401c3-b2e6-2d99-171f-276084d97536",
"funding_source": "ACCOUNT"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "ac5401c3-b2e6-2d99-171f-276084d97536",
"scheduled_date": 1667981700
}{id}/subscriptionsReturns a list of subscriptions owned by the contact.
Path variables
The contact’s unique identifier
Request parameters
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
By default, Churned (cancelled) subscriptions are excluded. Use this parameter to get a list of Churned Subscriptions only.
By default, billing information is not returned
By default billing terms are not returned
Filter based on the subscription’s state
[
"ACTIVE"
]Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
The unique identifier of the subscription
The subscription’s code.
The type of the event
The Subscription has at least one service in Effective state
The Subscription has one or more non-churned services but none of them are active (might be in Not Effective, Paused or Draft state)
All of the Subscription’s services are churned (either Cancelled or Regretted)
Number of Effective services. Recurring expenses are excluded. Service in Trial are excluded.
Number of Inactive services. Includes Not Effective and Paused services. Recurring expenses excluded
Number of Draft services (services ordered but never activated)
Number of services which might be active on the subscription, but they are still in trial period. These services are not included in the number of active (paid) services of the subscription
Number of devices
The date on which the subscription was activated for the first time
Determines whether usage is allowed to be consumed as part of at least one of the active services of the subscription. Usage might be allowed by one of the services, but at the time the Web API is triggered, the customer is blocked for consuming usage
Detailed billing information of the subscription’s services.
The date until which the subscription’s services are billed
The next date on which the subscription will be billed
The date on which the next payment is expected. Usually it’s the next billing date unless the subscriber’s payment terms allow them a period to pay off the subscription’s bill
The subscription’s billing terms
The subscription’s billing cycle duration
The billing cycle’s duration
The billing cycle’s unit of time
The day of month/week until which the subscripton’s services will be billed. Either a day of month or day of week is returned, depnding on the subscription’s billing cycle (if it is less than a month, then a day of week is returned)
Day of month
Day of week
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/contacts/{id}/subscriptions HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "0df9936c-7d5f-a878-4c05-9b942aa14295",
"code": "4347869878000989",
"state": "ACTIVE",
"active_services": 3,
"inactive_services": 2,
"draft_services": "0",
"trial_services": 1,
"number_of_devices": 1,
"first_activation_date": 1620981309,
"usage_blocked": "true",
"billing_info": {
"billed_up_date": 1620981311,
"next_billing_date": 1620981311,
"next_payment_date": 1620981311
},
"terms": {
"billing_period": {
"duration": 1,
"uot": "MONTHS"
},
"billing_day": {
"day_of_month": 1,
"day_of_week": "SATURDAY"
}
}
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}Returns a list of subscriptions
Request parameters
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
By default, Churned subscriptions are excluded. Use this parameter to get a list of Churned Subscriptions only.
The date on which the subscriptions was activated for the first time. Each option includes the field name, the operator and the date field in epoch format. Use up to two of the following options based on the required search:
The date on which one of the subscription’s services gets expired
The date on which one of the subscription’s services will be renewed
The date on which the contract of one of the subscription’s services ends
The contact who owns the subscription
The organisation that owns the subscription
The account of the contact who ows the subscription
The device thatis provisioned by the subscriptions to be retrieved
By default, the subscription’s billing details are not returned. Set the value to True to get the basic billing information
By default, the subscription’s billing terms are not returned. Set the value to True to get the subscription’s billing day and period
Search for a subscription based on its code
the subscription’s funding source.
The state of the subscription
Termed service’s product identifier. Subscription must have such a non-churned termed service
Defines whether MRR metrics should be returned or not
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
Subscription identifier
Subscription’s code. If not specified on creating the subscirpiton, then a unique and random 16-digit code is assigned as the subscription’s code.
The type of the event
The Subscription has at least one service in Effective state
The Subscription has one or more non-churned services but none of them are active (might be in Not Effective, Paused or Draft state)
All of the Subscription’s services are churned (either Cancelled or Regretted)
Date on which the subscirption was activated for the first time (when the first service was activated)
Number of non-churned services (in any state other than Cancelled, regretted or Swapped). Recurring expenses are excluded. Services in Trial are excluded
Number of inactive services
Number of Draft services
Number of services still in trial period. Trial services might be in Effective state but they are not considered in the number of active services
Number of devices on which all of the subscription’s non-churned services are enabled on.
Details about the organisation from where such event was posted
The organisation identifier
The organisation name
The contact who owns the subscription
Contact identifier
Contact name
Contact code
Detailed billing information for the Subscription
The date until which the subscription’s services are billed
The next date on which the subscription will be billed
The date on which the next payment is expected. Usually it’s the next billing date unless the subscriber’s payment terms allow them a period to pay off the subscription’s bill
The subscription’s billing terms
The subscription’s billing cycle duration
Duration
Duraiotion unit of time
The day of month/week until which the subscripton’s services will be billed. Either a day of month or day of week is returned, depnding on the subscription’s billing cycle (if it is less than a month, then a day of week is returned)
Day of Month
Day of week
Determines whether usage is allowed to be consumed as part of at least one of the active services of the subscription. Usage might be allowed by one of the services, but at the time the Web API is triggered, the customer is blocked for consuming usage
The subscription MRR metrics
The subscription’s total MRR
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/subscriptions HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"code": "5545458883212050",
"state": "ACTIVE",
"first_activation_date": 1620984119,
"active_services": 3,
"inactive_services": "1",
"draft_services": "1",
"trial_services": 1,
"number_of_devices": 3,
"organisation": {
"id": "4248fab3-67d5-2eb1-eaf6-079ce18cd2ed",
"name": "Bravo Coffee"
},
"contact": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "John Smith",
"code": "1234534333"
},
"billing_info": {
"billed_up_date": 1620981311,
"next_billing_date": 1620981311,
"next_payment_date": 1620981311
},
"terms": {
"billing_period": {
"duration": 1,
"uot": "MONTHS"
},
"billing_day": {
"day_of_month": 1,
"day_of_week": "MONDAY"
}
},
"usage_blocked": "false"
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Returns detailed inormation for a single subscription.
Path variables
The unique identifier of the subscription
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
Subscription identifier
Subscription’s code. If not specified on creating the subscirpiton, then a unique and random 16-digit code is assigned as the subscription’s code.
The type of the event
The Subscription has at least one service in Effective state
The Subscription has one or more non-churned services but none of them are active (might be in Not Effective, Paused or Draft state)
All of the Subscription’s services are churned (either Cancelled or Regretted)
Date on which the subscirpiton was activated for the first time (when the first service was activated)
Date on which the last non-churned service of the subscription was removed (either cancelled or regretted). That removal also cause the Subscription to move into Churned state.
Number of Effective services. Recurring expenses And Trial services are excluded
Number of recurring charged. These charges are considered as services, but because of their Expense classification, they are not includd in the list of services that the contact subscribed for.
Number of services still in trial period. Trial services might be in Effective state but they are not considered in the number of active services
Number of devices on which all of the subscription’s non-churned services are enabled on.
Determines whether the subscirption is in Grace Period at the time the subscription is accessed
Determines whether usage is allowed to be consumed as part of at least one of the active services of the subscription. Usage might be allowed by one of the services, but at the time the Web API is triggered, the customer is blocked for consuming usage
Detailed billing information of the subscription
Date up until which the subscirption is billed
The next date on which the subscription will be billed
the date on which the subscriber is expected to pay
Details about the organisation from where such event was posted
The organisation identifier
The organisation name
contact who owns the subscription
Contact idnetifier
Contact name
Contact code
The account of the Subscription. Account might bbe owned by a Contact or an Organisation
Account identifier
Account number
Account Name
Subscription’s billing terms
How often the subscirption is billed
Billing cycle duration
Duration unit of time
On which day of month (for subscriptions with cycles longer than a month) or day of the week (for subscriptions shorter than a month)
Day of month
Day of week
The payment method used to automatically pay off the subscription’s billing. This is one of the contact’s/organisation’s online payment methods.
Contact/Organisation Payment Method identifier
Payment method type
Basin information fo the payment method to clearly identify the payment method
The type of the event
If one of the contact’s payment methods is specified as the subscription’s payment method as well, then the Account is considered as the funding source. The account is also the default funding source if no payment method is specified.
The Wallet is the subscription’s funding source if subscriber specifically states that he/she wants to pay for the services using available wallet funds.
The address identifier
The address type. Many of the same type.
A short address name so that it’s easily recognised in a list
Defines whether the address is the primary one
The address line 1
The address line 2
The address state/province/county
The address town/city
The address postal code
The latitude of the address
The longitude of the address
The Google textual identifier that uniquely identifies an address
List of grace periods applied for this subscription
Date on which Grace period was applied
Date until which he subscirption was in Grace period
GET https://sandbox.crm.com/backoffice/v2/subscriptions/{id} HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"code": "9955454333211380",
"state": "ACTIVE",
"first_activation_date": 12345567,
"cancellation_date": 12345678,
"active_services": 3,
"recurring_charges": 1,
"trial_services": 1,
"number_of_devices": 1,
"in_grace_period": "true",
"usage_blocked": "true",
"billing_info": {
"billed_up_date": 1620981311,
"next_billing_date": 1620981311,
"next_payment_date": 1620981311
},
"organisation": {
"id": "4248fab3-67d5-2eb1-eaf6-079ce18cd2ed",
"name": "Bravo Coffee"
},
"contact": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "John Smith",
"code": "12345"
},
"account": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"number": "AR000001",
"name": "AR000001 John Smith"
},
"terms": {
"billing_period": {
"duration": 1,
"uot": "MONTHS"
},
"billing_day": {
"day_of_month": 1,
"day_of_week": "MONDAY"
},
"payment_method": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"type": "CARD",
"idnetifier": "Visa ***** 1234"
},
"funding_source": "ACCOUNT"
},
"address": {
"id": "0df9936c-7d5f-a878-4c05-9b942aa14295",
"type": "HOME",
"name": "Mum's house",
"is_primary": true,
"address_line_1": "21 Elia Papakyriakou",
"address_line_2": "7 Stars Tower",
"state_province_county": "Egkomi",
"town_city": "Nicosia",
"postal_code": "2415",
"country_code": "CYP",
"lat": 35.157115,
"lon": 33.313719,
"google_place_id": "ChIJrTLr-GyuEmsRBfy61i59si0"
},
"grace_periods": [
{
"start_date": 1,
"end_date": 1
}
]
}{id}/servicesReturns a list of services to which a contact is subscribed to. The list includes service across all subscriptions, of different billing cycles.
Path variables
The contact’s unique identifier
Request parameters
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
By default, churned (terminated) are excluded. Use this parameter to get a list of churned services only.
Product classification of the subscription services to be retrieved. If not specified, all services are returned
Determine whether subscription and its billing terms will additionally be inclded in the response. Defaults to false
Unique identifier of the subscription that groups services by their billing cycle
Returns services in trial
Returns services currenlty in contract period
Returns services that have a scheduled action pending
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
Subscription servcie identifier
The type of the event
Date added to the subscription
First activation date
Date removed from the subscription (applies for churned services)
Applicable for expense services to indicate whether they are charged on a recurring basis
Shows whether the service allows subscribers to consume usage
Shows whether there are pending scheduled actions for the service
Service product information
Product identifier
Product SKU
Product name
The service product’s classification
Service pricing information
Price identifier
Price
Taxation model
How often the service is billed
Billing cycle duration
Duration unit of time
Latest billing information of the service
Latest billed from date
Billed up to date
Services’s price terms
Billing model
Auto-renewed or not
Service in contract or not
Service quantity
Contract period details
How long the service will be/was in contract
Contract period unit of time
Contract period start date
Contract period end date
Service’s termed period
How many billing cycles each termed period covers
Latest termed period start date
Termed period end date
Service’s trial period details
Service currently in trial or not
Trial period start date
Tiral period end date
Trial period duration
Trial period unit of time
Applicable while the service is paused
Paused period start date
Paused perido end date
Applicable when the service was added as part of a bundled service.
The bundle service’s identifier
Bundle service product
Product identifier
Product SKU
Product name
Applicable for bundle services and returns a list of component services.
Component service identifier
Component service added date
Componenent service first activation date
Component service in contract or not
The type of the event
Component service product
Product identifier
Product SKU
Product name
The component service’s price
Component service price
The subscription of the service
Subscriptionidentifier
Subscription code
Subscription pricing terms
Subscription’s funding source
How often services are billed
Billing cycle duration
Billing cycle unit of time
Billing day
Day of month specified for subscriptions with cycles longer than a month
Day of week specified for subscriptions with cycles shorter than a month
{
"type": "CASH",
"identity": {
"id": "",
"identifier": "Visa *****1234 03/25"
}
}The type of the event
The type of the event
The unique identifier of the contact’s payment method
A short description of the payment method. Depending on the payment method’s type different information is returned:
- Card: the brand, followed by the last 4 digits of the card plus expiration month/year
- Account debit: Name: Bank code followed by the first 5 and the last 9 digits of the account number/IBAN
- Wallet: Name: Email and/or phone used on registration
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/contacts/4dc0809f-ed91-4b68-b912-5bd6064d901e/services HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"state": "EFFECTIVE",
"added_on": 1625555027,
"first_activated_on": 1625555027,
"removed_on": 1625555027,
"is_recurring_charge": true,
"has_allowance": "true",
"scheduled_actions": "true",
"product": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"sku": "TV001",
"name": "Films",
"classification": "TERMED",
"type_composition": "FLAT"
},
"price": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"price": 9.99,
"currency_code": "EUR",
"tax_model": "TAX_INCLUSIVE",
"billing_period": {
"duration": 1,
"uot": "MONTHS"
}
},
"billing": {
"billed_from": 1625555027,
"billed_to": 1625555027
},
"terms": {
"billing_model": "POST_BILL",
"auto_renew": true,
"in_contract": true,
"quantity": 1,
"contract_period": {
"duration": 18,
"uot": "MONTHS",
"start_date": 1625555027,
"end_date": 1625555027
},
"termed_period": {
"billing_cycles": 1,
"start_date": 1625555027,
"end_date": 1625555027
}
},
"trial_period": {
"trial_state": "IN_TRIAL",
"start_date": 1625555027,
"end_date": 1625555027,
"duration": 7,
"uot": "DAYS"
},
"paused_period": {
"start_date": 1625555027,
"end_date": 1625555027
},
"bundled_service": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"product": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"sku": "GOLD",
"name": "Gold Package"
}
},
"components": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"added_on": 1625555027,
"first_activated_on": 1625555027,
"in_contract": true,
"state": "EFFECTIVE",
"product": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"sku": "FILMS",
"name": "Films"
},
"price": {
"price": 9.99,
"currency_code": "EUR"
}
}
],
"subscription": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"code": "60012321123",
"terms": {
"funding_source": "ACCOUNT",
"billing_period": {
"duration": 1,
"uot": "MONTHS"
},
"billing_day": {
"day_of_month": 1,
"day_of_week": "WEDNESDAY"
},
"payment_method": {
"type": "ELECTRONIC_TRANSFER",
"identity": {
"id": "",
"identifier": "Visa *****1234 03/25"
}
}
}
}
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}/billingBills in advance a subscription for a number of upcoming billig cycles. Any scheduled changes planned within this period will be taken into account. In cases of exceeded credit limit, billing is successful only if it can also be paid using an online paymnt method or the CRM Wallet accordinly. Subscription services billed on a post-bill basis and usage service can never be billed in advance.
Path variables
The subscription’s unique identifier
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Number of billing cycles to bill in advance
The date up until which the subscirption will be billed. This date must be one of the future billing cycles’ start date i.e. it must be have the subscription’s billing date. This date however must be set within the next 24 months.
Responses
Body
Invoice unique identifier
Credit Note unique identifier
POST https://sandbox.crm.com/backoffice/v2/subscriptions/4dc0809f-ed91-4b68-b912-5bd6064d901e/billing HTTP/1.1
Content-Type: application/json
{
"upcoming_billing_cycles": 3,
"bill_up_to_date": 1689948097
}{id}/allowanceReturns the usage allowance provided through a termed/one-time service as well as the service’s remaining usage.
Path variables
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
The service’s accumulated cash allowance, i.e. how much can be consumed among all products which are consumed through the service. This allowance is defined only in amount of money and it’s evaluated based on the usage’s rating (how much it costs).
How much can be consumed
Maximum allowed cash amount every time the service is consumed.
Maximum allowed cash amount among all transactions performed within the calendar day.
Maximum allowed cash amount among all transactions performed within the service’s billing cycle.
Remaining allowance in amount of money
How much money can be spent per transaction
How much usage, in terms of money, can be spent within the day
How much usage, in terms of money, can be spent for the current billing cycle of the subscription service
List of items which can be consumed through the subscription service. This set of items includes usage and non-traceable physical goods. If nothing is specified, then usage is allowed among all usage services/non-traceable physical goods that the business is selling.
Product setting. Allowa usage to either a specific product or to products of a specific type.
The idnetifier of the item (the product or the product type’s)
The product name or product type name depending on item_type
Measurement unit. Applicable only when a specific usage product is included in the allowance.
Measurement unit identifier
Measurement unit name
Measurement unit display name
How much rated usage can be consumed
The allowance’s allowed cash amount
Maximum cash amount to be used per transaction
Maximumu cash amount to be used among all transactions of a calendar day
Maximum cash amount to be used among all transactions performed within the service’s billing cycle.
Remaining rated usage allowance
Remaining usage in the next transaction
Remaining rated usage can be consumed within the day
Remaining rated usage can be consumed within the service’s billing cycle
Actual allowed and remaining usage (based on measurement units)
Maximum allowed usage that can be consumed
Maximum usage to be consumed per transaction
Maximum usage to be consumed per calendar day
Maximum usage to be consumed during the service’s billing cycle
Remaining usage
Remaining usage to be consumed in the next transaction
Remaining usage that can be consumed within the rest of the day
Remaining usage that can be consumed within the rest of the service’s billing cycle.
GET https://sandbox.crm.com/backoffice/v2/services/{id}/allowance HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"cash_amounts": {
"allowed": {
"per_transaction": 9.99,
"per_day": 19.99,
"per_billing_cycle": 59.99
},
"remaining": {
"per_transaction": 1.99,
"per_day": 9.99,
"per_billing_cycle": 19.99
}
},
"products_allowance": [
{
"item_type": "PRODUCT",
"item_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "",
"measurement_unit": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "Gigabytes",
"display_name": "GB"
},
"cash_amounts": {
"allowed": {
"per_transaction": 9.99,
"per_day": 19.99,
"per_billing_cycle": 59.99
},
"remaining": {
"per_transaction": 5.99,
"per_day": 19.99,
"per_billing_cycle": 59.99
}
},
"usage_amounts": {
"allowed": {
"per_transaction": 9.99,
"per_day": 19.99,
"per_billing_cycle": 59.99
},
"remaining": {
"per_transaction": 9.99,
"per_day": 19.99,
"per_billing_cycle": 59.99
}
}
}
]
}{id}/servicesAdds a new service on a subscription. A single service can be added within a single Web API call. Subscription must exist in advance in order to successfully amend it by adding a new service. Adding a service to a subscription will trigger billing as well which results in billing the new service based on the subscription’s current billing cycle.
Path variables
The subscription’s unique identifier
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The service product identifier
The service’s price. The selected price terms must have the same billing cycle as the rest of the services of the subscription, otherwise the additiong of the new service fails.
The new service’s quantity. If not specified, then it defaults to 1.
Schedules the addition of the service. The scheduled dat emust be after the current date.
Applicable and required when adding a service of flexible bundle composition. In that case, at least one component service must be specified, and that product must follow the flexible bundle’s allowed composition.
The component product’s identifier. Only termed service products are allowed to be added as components and these product must be includd on the flexible bundle’s composition.
The service’s price terms. The service price terms must follow the bundle services (and subsequently the subscription’s) billing cycle.
List of devices to which the service should be enabled on. Applicable only when the service is provisionable. List of allowed devices includes all devices of the contact (they might already exist on the subscription or not) that are provisioned by the same provider as the service. If nothing is specified, then the service is not enabled on any device
Device unique identifier
A pass that unlocks a promotion for the new service
Pass’s unique code
Pass’s OTP
Responses
Body
The subscription action’s identifier
POST https://sandbox.crm.com/backoffice/v2/subscriptions/4dc0809f-ed91-4b68-b912-5bd6064d901e/services HTTP/1.1
Content-Type: application/json
{
"product_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"price_terms_id": "edc0809f-ed91-4b68-b912-5bd6064d901e",
"quantity": 5,
"scheduled_date": 1621236949,
"components": [
{
"product_id": "2dc0809f-ed91-4b68-b912-5bd6064d901e",
"price_terms_id": "32c0809f-ed91-4b68-b912-5bd6064d901e"
}
],
"devices": [
{
"id": "edc0809f-ed91-4b68-b912-5bd6064d901e"
}
],
"pass": {
"code": "HPX68933209",
"otp": "456079"
}
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "edc0809f-ed91-4b68-b912-5bd6064d901e"
}{id}/servicesAdds a new service for a contact. A single service can be added per Web API call. In cases where the contact does not own a subscription in the same billing cycle as the new service’s cycle, then a new subscirption is also created with this Web API call. Otherwise, the existing subscription is amended with the new service and this new service’s billing cycle is adjusted to the subscription’s.
Path variables
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Service product identifier. Only Termed and One-time services can be added.
The new service’s price which also defines its billing cycle
The service quantity, default to 1 if not specified
Schedule the addition of the service. Scheduled date must be set in the future.
Applicable when adding a termed service with a flex bundle composition. In that case, at least one item must be specified.
The component service product identifier. Only termed services can be added and as long as they meet the bundle service’s allowed composition
The component’s price terms. The price’s billing cycle must be the same as the bundle service’s cycle.
List of device to which the new service can be enabled on.
Device identifier.
A pass that unlocks a promotion for the new service
Pass code
Pass OTP to verify the pass
Responses
Body
The unique identifier of the new subscription action
POST https://sandbox.crm.com/backoffice/v2/contacts/{id}/services HTTP/1.1
Content-Type: application/json
{
"product_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"price_terms_id": "edc0809f-ed91-4b68-b912-5bd6064d901e",
"quantity": 5,
"scheduled_date": 1621236954,
"components": [
{
"product_id": "2dc0809f-ed91-4b68-b912-5bd6064d901e",
"price_terms_id": "32c0809f-ed91-4b68-b912-5bd6064d901e"
}
],
"devices": [
{
"id": "edc0809f-ed91-4b68-b912-5bd6064d901e"
}
],
"pass": {
"code": "HPX68933209",
"otp": "456079"
}
}
HTTP/1.1 200 OK
Content-Type: application/json
[
{
"id": "3ac0809f-ed91-4b68-b912-5bd6064d901f"
}
]{id}Updates a single suscsription service. A service might change due to various reasons and multiple changes can be logged per Web API log:
- Change the service’s state
- Change the service with another service
- Change the service’s terms
- Change the service’s quantity
- Change a flex service’s components
Path variables
The subscription service identifier
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The type of the event
Activate the service
Deactivate the service
Cancel the service
Regret the service
Pause the service
Resume a paused service
Change the service
The action’s category unique identifier
The date on which the action is scheduled to be executed. If not specified, the action is immediatelly executed.
Applicable when business rules enforce an action to be performed on a future scheduled date. Set this parameter to True to indirectly use the business rules’ prposed scheduled date without explicitly defining it
Applicable and required when pausing a service. Defines the paused period’s duration in days.
Applicable when changing the terms of a service OR changing/swapping services
If set to True, then contact opts-in to auto-renewals, otherwsie, when set to False, the contact opts out and the service will get expired at the end of the termed period.
Applicable when changing a service’s price.
Extends the service’s contract period
The period’s duration
The period’s unit of time
Applicable and required when upgrading or downgrading a service
The new service product to which the service will be changed with
Required when the new service has multiple price terms. If the new service product has a single price, then it will be used by default
Applicable when amending a service bundle. At least one components to be added or to be removed must be specified
Component services to be added
Component service product identifier. This product must be a termed service and must also meet the flex bundle’s composition settings.
The price terms of the product to be added as a component. Required only when the component has multiple price terms and if its price is not included in the bundles price. If a single price exist, then it is used by default. If a service has no prices at all, then the service is added on a subscription with no billing information/terms
Component services to be removed
Service identifier of the component to be removed
A list of contact addresses that represents the actual locations at which the service is being delivered/used. Locations are represented by the contact’s addresses
The contact address identifier
Responses
Body
The new subscripton action’s unique identifier. Returned only when the action is successfully logged to be executed immediatelly or as a scheduled one.
A proposed date on which the requested changes can be scheduled to be executed. If a date is returned, then no action is logged yet and it has to be scheduled. A proposed scheduled date is returned when business rules do not allow the action’s immediate execution.
PUT https://sandbox.crm.com/backoffice/v2/services/4dc0809f-ed91-4b68-b912-5bd6064d901e HTTP/1.1
Content-Type: application/json
{
"action": "ACTIVATE",
"category_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"scheduled_date": 1656962736,
"use_proposed_date": true,
"number_of_days": 5,
"quantity": 5,
"renewal_opt_in": "true",
"price_terms_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"extend_contract": {
"period": 1,
"period_uot": "MONTHS"
},
"change_to_service": {
"product_id": "",
"price_terms_id": ""
},
"components": {
"added": [
{
"product_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"price_terms_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}
],
"removed": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}
]
},
"locations": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"proposed_date": 1656962736
}{id}/devicesA service can be enabled on multiple devices. This Web API returns a list of devices on which the specified service is already enabled on and any other devices owned/rented by the contact on which the service could be enabled on.
Path variables
The service’s unique identifier
Request parameters
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
Defines whether the service is already enabled on the device or not. If disabled, then the service can be enabled on the related device
Service connected to the device
Service not connected to the device.
Code that uniquely identifies the distribution of the service to a device. This is a random and unique 16-digit code
The device on which the service is already or could be enabled on. This device is owned or it was rented by the contact.
The unique identifier of the device
The device’s serial number
The device’s electronic ID
The product of the device
The unique dentifier of the product
The product’s SKU
The product’s name
GET https://sandbox.crm.com/backoffice/v2/services/4dc0809f-ed91-4b68-b912-5bd6064d901e/devices HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"state": "ENABLED",
"code": "4345665678888897",
"device": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"serial_number": "STB0001023222",
"eletronic_id": "",
"product": {
"id": "2dc0809f-ed91-4b68-b912-5bd6064d901e",
"sku": "STB001",
"name": "Set-Top-Box"
}
}
}
]
}{id}/devicesManage the device(s) of a service. A service can be enabled to one or more devices, so this Web API can be used to enable the service on new devices and/or disable it. Use “List Service Devices” Web API to see a list of devices to which the service can be enabled on.
Path variables
The subscription’s unique identifier
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Define whether the service will be enabled or disabled on the specified device
The unique identifier of the device
Responses
Body
The unique identiier of the subscription action
POST https://sandbox.crm.com/backoffice/v2/services/4dc0809f-ed91-4b68-b912-5bd6064d901e/devices HTTP/1.1
Content-Type: application/json
[
{
"action": "ENABLE",
"device_id": "3dc0809f-ed91-4b68-b912-5bd6064d901e"
}
]
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}{id}/devicesAdds a new device on a subscription. A single device can be added within a single Web API call.Devices that can be added on a subscription are:
- Devices already purchased or rented by the contact (and not already added to this subscription).
- Devices located at the business’s warehouse and can be rented to contacts. Once these devices are added to the subscription, then they will be classified as Rentals.
Path variables
The subscription’s identifier
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The device identifier
Applicable and required when the Device is added to the subscription as a result of the ordering flow. In this flow, the contact selects to get a device based on its rental price. Therefore, the device is added as a rental to the subscription and a rental recurring charge is added as well.
Responses
Body
The unique identifer of the subscription action that adds the device on a subscription
POST https://sandbox.crm.com/backoffice/v2/subscriptions/4dc0809f-ed91-4b68-b912-5bd6064d901e/devices HTTP/1.1
Content-Type: application/json
{
"device_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"price_terms_id": "3ec0809f-ed91-4b68-b912-5bd6064d9436"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}{id}/devices/{device_id}Updates a single susbcription device. The update witl either:
- remove the device from the subscription. If the device is owned by the contact, then contact keeps this ownership. If the device is a Rental the removing it from the last subscirption of the contact results in returning it back to the business warehouse.
- replaces it with another one. The new device might be owned by the contact or provided by the business as a rental,i.e. sam eas when adding a new device to the subscription. However in this case, the new device apart from replacing the existing device, it will also be enabled on the same service(s) as the device being removed.
Path variables
The unique identifier of the subscription
The unique identifier of the Device
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Required device action
Removes the device from the subscription
Replaces the device with another device
Applicable and required when replacing a device.
Responses
Body
The new subscripton action’s unique identifier
PUT https://sandbox.crm.com/backoffice/v2/subscriptions/4dc0809f-ed91-4b68-b912-5bd6064d901e/devices/4dc0809f-ed91-4b68-b912-5bd6064d901e HTTP/1.1
Content-Type: application/json
{
"action": "REPLACE",
"replaced_by_device_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}{id}/devicesReturns a list of subscription devices. These devices are not necesserally enabled on subscription services, but they are still related to the subscription and can be enabled to any of its devices at any point.
Path variables
The subscription’s unique identifier
Request parameters
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
The Subscription Device identifier
Date on which the device was added to the subscription
Number of services currently enabled on the device
Dietailed Device information
The device identifier
Device serial number
The device’s electronic ID
Device state
Contact rented the device
Contact owns the device
The provisioning integration(s), if applicable. Information depends on the device’s product and its type. A device
The provisioning integration’s identifier
The provisioning integration’s name
Device product whicf is of traceable physical good classification
Product identifier
Product SKU
Product name
The custom field (unique) key
The custom field’s (provided) value
GET https://sandbox.crm.com/backoffice/v2/subscriptions/4dc0809f-ed91-4b68-b912-5bd6064d901e/devices HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"added_on": 1668235865,
"enabled_services": 2,
"device": {
"id": "1668235865",
"serial_number": "STB3332222111",
"electronic_id": "STB3332222111",
"state": "RENTAL",
"provisioning": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "IRDETO"
},
"product": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"sku": "HDSTB",
"name": "HD Set Top Box"
},
"custom_fields": [
{
"key": "back_office",
"value": "Back Office"
}
]
}
}
]
}{id}/allowed_devicesReturns a list of devices that can be added on a subscription. The list includes devices already owned by the contact and devices owned by the business and will be added on the subscription as Rentals.
Path variables
The subscription’s unique identifier
Request parameters
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Device’s ownership
Search for a device using its serial number
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
The ownership of the device
The available device
Device identifier
Device serial number
Device product
Product identifier
Product SKU
Product name
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/subscriptions/{id}/allowed_devices HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"ownership": "OWNED_BY_BUSINESS",
"device": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"serial_number": "100002392112",
"product": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"sku": "HDSTB",
"name": "HD Set Top Box"
}
}
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}/servicesAdds a new service for an Organisation. A single service can be added per Web API call. In cases where the Organisation does not own a subscription in the same billing cycle as the new service’s cycle, then a new subscirption is also created with this Web API call. Otherwise, the existing subscription is amended with the new service and this new service’s billing cycle is adjusted to the subscription’s. It is important to note that services can only be added to Merchants/Service Provider organisations.
Path variables
The Organisation’s idnetifier
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Service product identifier. Only Termed and One-time services can be added.
The new service’s price which also defines its billing cycle
The service quantity, default to 1 if not specified
Schedule the addition of the service. Scheduled date must be set in the future.
Applicable when adding a termed service with a flex bundle composition. In that case, at least one item must be specified.
The component service product identifier. Only termed services can be added and as long as they meet the bundle service’s allowed composition
The component’s price terms. The price’s billing cycle must be the same as the bundle service’s cycle.
List of device to which the new service can be enabled on.
Device identifier.
Responses
Body
The unique identifier of the new subscription action
POST https://sandbox.crm.com/backoffice/v2/organisations/{id}/services HTTP/1.1
Content-Type: application/json
{
"product_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"price_terms_id": "edc0809f-ed91-4b68-b912-5bd6064d901e",
"quantity": 5,
"scheduled_date": 1621236954,
"components": [
{
"product_id": "2dc0809f-ed91-4b68-b912-5bd6064d901e",
"price_terms_id": "32c0809f-ed91-4b68-b912-5bd6064d901e"
}
],
"devices": [
{
"id": "edc0809f-ed91-4b68-b912-5bd6064d901e"
}
]
}
HTTP/1.1 200 OK
Content-Type: application/json
[
{
"id": "3ac0809f-ed91-4b68-b912-5bd6064d901f"
}
]{id}/servicesReturns a list of services to which an Organisation is subscribed to. The list includes service across all subscriptions, of different billing cycles. Only MErvhant/Service Provider organisations can subscribe to services.
Path variables
The Organisation’s unique identifier
Request parameters
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
By default, churned (terminated) are excluded. Use this parameter to get a list of churned services only.
Product classification of the subscription services to be retrieved. If not specified, all services are returned
Determine whether subscription and its billing terms will additionally be inclded in the response. Defaults to false
Unique identifier of the subscription that groups services by their billing cycle
Returns services in trial
Returns services currenlty in contract period
Returns services that have a scheduled action pending
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
Subscription servcie identifier
The type of the event
Date added to the subscription
First activation date
Date removed from the subscription (applies for churned services)
Applicable for expense services to indicate whether they are charged on a recurring basis
Shows whether the service allows subscribers to consume usage
Shows whether there are pending scheduled actions for the service
Service product information
Product identifier
Product SKU
Product name
The service product’s classification
Service pricing information
Price identifier
Price
Taxation model
How often the service is billed
Billing cycle duration
Duration unit of time
Latest billing information of the service
Latest billed from date
Billed up to date
Services’s price terms
Billing model
Auto-renewed or not
Service in contract or not
Service quantity
Contract period details
How long the service will be/was in contract
Contract period unit of time
Contract period start date
Contract period end date
Service’s termed period
How many billing cycles each termed period covers
Latest termed period start date
Termed period end date
Service’s trial period details
Service currently in trial or not
Trial period start date
Tiral period end date
Trial period duration
Trial period unit of time
Applicable while the service is paused
Paused period start date
Paused perido end date
Applicable when the service was added as part of a bundled service.
The bundle service’s identifier
Bundle service product
Product identifier
Product SKU
Product name
Applicable for bundle services and returns a list of component services.
Component service identifier
Component service added date
Componenent service first activation date
Component service in contract or not
The type of the event
Component service product
Product identifier
Product SKU
Product name
The component service’s price
Component service price
The subscription of the service
Subscriptionidentifier
Subscription code
Subscription pricing terms
Subscription’s funding source
How often services are billed
Billing cycle duration
Billing cycle unit of time
Billing day
Day of month specified for subscriptions with cycles longer than a month
Day of week specified for subscriptions with cycles shorter than a month
{
"type": "CASH",
"identity": {
"id": "",
"identifier": "Visa *****1234 03/25"
}
}The type of the event
The type of the event
The unique identifier of the contact’s payment method
A short description of the payment method. Depending on the payment method’s type different information is returned:
- Card: the brand, followed by the last 4 digits of the card plus expiration month/year
- Account debit: Name: Bank code followed by the first 5 and the last 9 digits of the account number/IBAN
- Wallet: Name: Email and/or phone used on registration
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/organisations/4dc0809f-ed91-4b68-b912-5bd6064d901e/services HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"state": "EFFECTIVE",
"added_on": 1625555027,
"first_activated_on": 1625555027,
"removed_on": 1625555027,
"is_recurring_charge": true,
"has_allowance": "true",
"scheduled_actions": "true",
"product": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"sku": "TV001",
"name": "Films",
"classification": "ONE_TIME",
"type_composition": "FLAT"
},
"price": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"price": 9.99,
"currency_code": "EUR",
"tax_model": "TAX_INCLUSIVE",
"billing_period": {
"duration": "",
"uot": ""
}
},
"billing": {
"billed_from": 1625555027,
"billed_to": 1625555027
},
"terms": {
"billing_model": "PRE_BILL",
"auto_renew": true,
"in_contract": true,
"quantity": 1,
"contract_period": {
"duration": 18,
"uot": "MONTHS",
"start_date": 1625555027,
"end_date": 1625555027
},
"termed_period": {
"billing_cycles": 1,
"start_date": 1625555027,
"end_date": 1625555027
}
},
"trial_period": {
"trial_state": "IN_TRIAL",
"start_date": 1625555027,
"end_date": 1625555027,
"duration": 7,
"uot": "DAYS"
},
"paused_period": {
"start_date": 1625555027,
"end_date": 1625555027
},
"bundled_service": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"product": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"sku": "GOLD",
"name": "Gold Package"
}
},
"components": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"added_on": 1625555027,
"first_activated_on": 1625555027,
"in_contract": true,
"state": "EFFECTIVE",
"product": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"sku": "FILMS",
"name": "Films"
},
"price": {
"price": 9.99,
"currency_code": "EUR"
}
}
],
"subscription": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"code": "60012321123",
"terms": {
"funding_source": "ACCOUNT",
"billing_period": {
"duration": 1,
"uot": "MONTHS"
},
"billing_day": {
"day_of_month": 1,
"day_of_week": "WEDNESDAY"
},
"payment_method": {
"type": "ACCOUNT_DEBIT",
"identity": {
"id": "",
"identifier": "Visa *****1234 03/25"
}
}
}
}
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}/actions{id}{id}{id}/allowed_actions{id}/allowed_actions{id}/actionsRetrieves a list of actions for a subscription. This set includes all actions already performed on the subscripiton and actions which are still pending.
Path variables
Subscription unique identifier
Request parameters
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
The action’s state
Action successfully executed
Action pending to be performed
Action rejected on its execution
Action cancelled prior its scheduled date
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
Subscription action identifier
A unique 16-digit code for the subscription action
The type of the event
Action successfully executed
Action pending to be performed
Action rejected on its execution
Action cancelled prior its scheduled date
Date of execution. Available only for Executed actions
The scheduled date of a pending action. Available for Scheduled actions as well as Canelled/Rejected ones to indicate there intended scheduled date
The date on which a Scheduled action was cancelled
The date on which the action was rejected.
The action’s category.
Action category identifier
Action category name
The user’s identifier
The user’s full name
The user’s credential username
The user’s identifier
The user’s full name
The user’s credential username
The action’s related Subscription
Subscription identifier
Subscripton code
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/subscriptions/4dc0809f-ed91-4b68-b912-5bd6064d901e/actions HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"code": "5443456789999098",
"state": "SCHEDULED",
"behaviour_code": "REMOVE_SERVICE",
"business_classification_code": "",
"executed_on": 1658412097,
"scheduled_on": 1658412097,
"cancelled_on": 1658412097,
"rejected_on": 1658412097,
"category": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "Regret service"
},
"submitted_by": {
"id": "a12b282f-e6ce-e618-0a72-becb3ad78033",
"name": "John Smith",
"username": "johnsmith@crm.com"
},
"cancelled_by": {
"id": "a12b282f-e6ce-e618-0a72-becb3ad78033",
"name": "John Smith",
"username": "johnsmith@crm.com"
},
"subscription": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"code": "6544445670091232"
}
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Retrieves detailed information of an existing subscription action
Path variables
Subscription Action’s identifier
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
Action’s 16-digit code
The type of the event
Action successfully executed
Action pending to be performed
Action rejected on its execution
Action cancelled prior its scheduled date
The date on which the action was performed
Scheduled date of execution
Applicable when cancelling scheduled actions
Date on which the action’s execution was rejected.
Reason of rejecting the action. The reason is usually the system error’s description.
The subscirption for which the action was performed
Subscription identifier
Subscription code
The user’s identifier
The user’s full name
The user’s credential username
The user’s identifier
The user’s full name
The user’s credential username
Action’s category providing reasoning on why the action was performed
Action Category identifier
Action category name
A list of sevices affected by the subscription action. With a single action one or more services are affected. An action might affect a subscription’s services in 3 different ways
Service change type
Service added to the subscrption
Service removed from subscription (product change, cancellation or regret)
The service’s statwas changed
The new quantity of the service
The new price of the service. Applicable when changing a service’s price
The price’s unique identifier
The new price
The service’s new billing period according to the new price trms
Billing period duration
Billing period unit of time
The affected service’s product
Product identifier
Product SKU
Product name
The action’s affected Devices. With a single actions one or more devices might be affected
How the action affetced the subscription’s devices
A device addded to the subscription (new one added or an existing device was replaced)
Device removed (removed individually or replaced by another device)
Device updated due to service distribution changes
Device details
Device identifier
Serial number of device
Device’s electronic ID
Device product details
Product identifier
Product SKU
Product name
GET https://sandbox.crm.com/backoffice/v2/subscriptions/actions/4dc0809f-ed91-4b68-b912-5bd6064d901e HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"code": "5444567099900907",
"state": "SCHEDULED",
"behaviour_code": "",
"business_classification_code": "",
"executed_on": 1658412644,
"scheduled_on": 1658412644,
"cancelled_on": 1658412643,
"rejected_on": 1658412643,
"rejection_reason": "Service already exists on the subscription",
"subscription": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"code": "9900004343331234"
},
"submitted_by": {
"id": "a12b282f-e6ce-e618-0a72-becb3ad78033",
"name": "John Smith",
"username": "johnsmith@crm.com"
},
"cancelled_by": {
"id": "a12b282f-e6ce-e618-0a72-becb3ad78033",
"name": "John Smith",
"username": "johnsmith@crm.com"
},
"category": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "High cost"
},
"services": [
{
"change_type": "REMOVED",
"quantity": 2,
"price": {
"price_terms_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"price": 9.99,
"billing_period": {
"duration": 1,
"uot": "MONTHS"
}
},
"product": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"sku": "SVOD",
"name": "Auxsat TV"
}
}
],
"devices": [
{
"change_type": "ADDED",
"device": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"serial_number": "001112912232",
"electronic_id": "001112912232",
"product": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"sku": "HDSTB",
"name": "HD Set Top Box"
}
}
}
]
}{id}Updates an existing subscription action.
Path variables
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
How the action is updated.
Cancel the scheduled action
Resubmit a Rejected action. A new duplicate action is created.
Update informaiton of the scheduled action
The action’s category
Set a new scheduled date for the action, The new scheduled date must comply with business rules
Reschedule the action by applying business rules such as when a service can be cancelled
Applicable only for Scheduled actions that include period settings such as Paused period.
The new period’s duration in days
The new period’s end date
Responses
Body
The updated action’s identifier
The action’s proposed scheduled date as this is defines by business rules. Use this date in a subsequent call to schedule the action based on these rules.
PUT https://sandbox.crm.com/backoffice/v2/subscription_actions/4dc0809f-ed91-4b68-b912-5bd6064d901e HTTP/1.1
Content-Type: application/json
{
"action": "RESUBMIT",
"category_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"scheduled_date": 1668242869,
"use_proposed_date": "true",
"period_settings": {
"duration_in_days": 5,
"ends_on": 1234567
}
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"proposed_date": 1668242869
}{id}/allowed_actionsRetrieves a list of subscription actions tha can be perofrmed on a specific subscription at a specific period of time
Path variables
Request parameters
The date on which the subscription action will be executed. If not specified, the current date is considered
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
A list of services that will be affected by the action
GET https://sandbox.crm.com/backoffice/v1/subscriptions/{id}/allowed_actions HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"behaviour_code": "",
"business_classification_code": "",
"services": [
{
"id": "",
"product": {
"id": "",
"sku": "",
"name": ""
}
}
]
}{id}/allowed_actionsRetrieves a list of subscription actions that can be perofrmed on a specific services at a specific period of time
Path variables
Request parameters
The date on which the subscription action will be executed. If not specified, the current date is considered
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
GET https://sandbox.crm.com/backoffice/v1/services/{id}/allowed_actions HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"behaviour_code": "",
"business_classification_code": ""
}{id}/locations{id}/locations{id}/locationsUpdates the locations at which the service is used/consumed. A service is consumed/used at one of the contact’s/organisation’s addresses.
Path variables
Subscription service identifier
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
A list of contact addresses that represent the various locations at which a service is being used/consumed. At least one address must be specified and must be one of the subscription owner’s addresses.
A contact address unique identifier.
Responses
Body
The subscription service’s unique identifier
PUT https://sandbox.crm.com/backoffice/v2/services/4dc0809f-ed91-4b68-b912-5bd6064d901e/locations HTTP/1.1
Content-Type: application/json
{
"locations": [
{
"id": "1ac0809f-ed91-4b32-b912-5b45064d90af"
}
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}{id}/locationsReturns a list of locations at which a service is being used/consumed. This is a set of addresses of the contact or organisation who owns the subscription service
Path variables
The service’s unique identifier
Request parameters
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
The address identifier
The address type. Many of the same type.
A short address name so that it’s easily recognised in a list
Defines whether the address is the primary one
The address line 1
The address line 2
The address state/province/county
The address town/city
The address postal code
The latitude of the address
The longitude of the address
The Google textual identifier that uniquely identifies an address
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/services/4dc0809f-ed91-4b68-b912-5bd6064d901e/locations HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "0df9936c-7d5f-a878-4c05-9b942aa14295",
"type": "BUSINESS",
"name": "Mum's house",
"is_primary": true,
"address_line_1": "21 Elia Papakyriakou",
"address_line_2": "7 Stars Tower",
"state_province_county": "Egkomi",
"town_city": "Nicosia",
"postal_code": "2415",
"country_code": "CYP",
"lat": 35.157115,
"lon": 33.313719,
"google_place_id": "ChIJrTLr-GyuEmsRBfy61i59si0"
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}The following group will detail the API’s required in order to monitor the events and logs taking place in the system.
{id}{id}Retrieve a list of events logged in Mongo based on search criteria (e.g. all purchase events)
Request parameters
Filter based on search value (case insensitive) across name or description
Filter based on contact (identifier) associated to such event
Filter based on entity associated to such event
Filter based on API Log (identifier)
Filter based on the submitted date, which may fall within a given date range. The value can be a string with a date in epoch format. Each option must also include an operator. Use up to two options based on the required search (e.g. submitted_date[gte]=1618395497&submitted_date[lt]=1618395497).
Returns results where the submitted date is greater than this value
Returns results where the submitted date is greater than or equal to this value
Returns results where the submitted date is less than this value
Returns results where the submitted date is less then or equal to this value
Filter based on user (identifier) that submitted such event
The user’s email that submitted such request
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Filter based on entity (identifier) associated to such event
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The event identifier
The date and time that the event was created
The event description (pre-defined text)
The event associated with the event
The entity identifier
The event method
Details about API log associated with the event
The API log identifier
The API log name
The user’s identifier
The user’s full name
The user’s credential username
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/events HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "03fd3775-0c07-dfda-e46e-b294d52c1e1c",
"submitted_date": 1625472619,
"description": "New order O10102 for Echo Mars",
"entity": {
"id": "f30e0969-a4be-aaf5-8db7-da66077c51bf",
"type": "SERVICE_REQUEST"
},
"api_log": {
"id": "fc6cca11-8d9d-8ef2-f37e-09f144ae0933",
"name": "createOrder"
}
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Retrieve detailed information for an Event as logged in Mongo DW
Path variables
The event (identifier) to retrieve additional information
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The event identifier
The event description (pre-defined text)
Details about API log associated with the event
The API log identifier
The API log name
The entity associated with the event
The entity identifier
The event method
The entity data based on Mongo DW event objects (more details can be found under the Internal speca page for Mongo DW Events)
Details about user that submitted such request
The user identifier
The user full name
The date that such event was submitted
GET https://sandbox.crm.com/backoffice/v2/event_logs/407eebd4-dd56-f522-60f5-929dfe3f58df HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "407eebd4-dd56-f522-60f5-929dfe3f58df",
"description": "New order O10102 for Echo Mars",
"api_log": {
"id": "fc6cca11-8d9d-8ef2-f37e-09f144ae0933",
"name": "createOrder"
},
"entity": {
"id": "d6e20ee9-3fd2-d9dc-5726-7a7c4d48679f",
"type": "PAYMENT",
"data": {}
},
"submitted_by_user": {
"id": "6feb5a88-7a6c-658b-83bd-a3a23ca0bcdf",
"name": "John Doe"
},
"submitted_date": 1651237192
}Retrieve a list of API logs based on search criteria (e.g. all post api requests)
Request parameters
Filter based on search value (case insensitive) across entity (identifier) and resounrce
Filter based on source
Filter based on entity (identifier)
Filter based on API method
Filter based on API response status
Filter based on the submitted date, which may fall within a given date range. The value can be a string with a date in epoch format. Each option must also include an operator. Use up to two options based on the required search (e.g. submitted_date[gte]=1618395497&submitted_date[lt]=1618395497).
Returns results where the submitted date is greater than this value
Returns results where the submitted date is greater than or equal to this value
Returns results where the submitted date is less than this value
Returns results where the submitted date is less then or equal to this value
Filter based on user (identifier) that submitted such API request
The user’s email that submitted such request
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The API log identifier
The event method
The API source
The date that such API request was submitted
Details about API response status
The event status (based on HTTP response codes)
OK
Created
No Content
Unauthorized
Forbidden
Not Found
Too Early
Internal Server Error
Bad Gateway
Service Unavailable
Gateway Timeout
The API response status name (based on HTTP response names)
The user’s identifier
The user’s full name
The user’s credential username
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/api_logs HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "b6c1c158-7ef8-4f1a-82d1-060dcc9e3da2",
"method": "POST",
"source": "/organisations/ba7944ab-53ef-4425-ac7c-faaf2e33a4a1/switch\"",
"submitted_date": 1651236236,
"status": {
"code": "201",
"name": "OK"
}
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Retrieve detailed information for an API log
Path variables
The log (identifier) to be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The API log identifier
The API name
The event method
The API version
The IP Address from which the API request was submitted
The API request URL endpoint
The API request
Details about API response status
The event status (based on HTTP response codes)
OK
Created
No Content
Unauthorized
Forbidden
Not Found
Too Early
Internal Server Error
Bad Gateway
Service Unavailable
Gateway Timeout
The API response status name (based on HTTP response names)
The API response
The date that such API request was submitted
Details about user that submitted such request
The user identifier
The user full name
GET https://sandbox.crm.com/backoffice/v2/api_logs/6ccff6a9-b0fe-a6f5-878b-b982d293d3ca HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "e7e5ef61-8d70-efea-972a-650ce6fe8e02",
"name": "updateProductTypes",
"method": "PUT",
"api_version": "V2",
"ip_address": "172.30.202.22",
"source": "/product_types/1b964e48-8867-55c4-a86a-c5bc024f0f9c",
"request": "\"composition_method\\\":\\\"FLAT\\\",\\\"name\\\":\\\"Consumables\\\",\\\"description\\\":null,\\\"negative_balance_allowed\\\":false,\\\"display_name\\\":\\\"\\\",\\\"is_modifier\\\":false,\\\"is_stockable\\\":false,\\\"variant_attributes\\\":[]}",
"status": {
"code": "404",
"name": "OK"
},
"response": "{\\\"id\\\":\\\"9EAA2884B6D04DD89F324A26D63944C9\\\"}\", \"id\":\"849a07f0-f180-47ef-9c4a-89a67306ebfe\", \"ip_address\":\"172.30.182.233\", \"api_version\":\"V1\", \"reason_phrase\":\"OK\", \"submitted_date\":1630312452 \":[]}",
"submitted_date": 11651235756,
"submitted_by_user": {
"id": "6feb5a88-7a6c-658b-83bd-a3a23ca0bcdf",
"name": "John Doe"
}
}Top-ups is an easy way to add money to an Account or a Wallet. Contacts top up their accounts or wallet with funds to be used in upcoming payments.Top-ups might retrieve money from one of the contact’s payment methods.
{id}Create a new top-up transaction for a specific account or wallet.
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The account unique identification for which the topup will be performed. Either account or wallet is applicable and mandatory
The wallet unique identification for which the topup will be performed. Either account or wallet is applicable and mandatory
The amount of the topup. This amount is in the account’s/wallet’s currency
The type of the event
The unique identifier of the contac’ts payment method. Applicable and required when the select payment method type is either a Card, an Account Debit or a Wallet.
A unique and random 16-digit code will be auto-generated if not provided
Date of Topup Request
Group of conditions that define how the top up’s amount can be spent. Specifying spend conditions will move the money to the wallet’s Commerce balance otherwise, money goes to Open balance.
The custom field’s unique key
The custom field’s value
Responses
Created
Body
The top-up unique identifier
POST https://sandbox.crm.com/backoffice/v2/topups HTTP/1.1
Content-Type: application/json
{
"account_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"wallet_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"amount": 9.99,
"payment_method": {
"type": "WALLET",
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
},
"code": "1234567891234567",
"topup_date": 1618298816,
"commerce_pool_id": "f283a863-18e1-7cae-48c4-7433bf28cf97",
"custom_fields": [
{
"key": "back_office",
"value": "0001-12345"
}
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "2b98beb3-df11-f14d-561b-a93fcd4a246a"
}{id}Retrieve details of an existing topup transaction
Path variables
The unique identifier of the topup to be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Successful Request
Body
The code of the topup transaction
The state of the topup transaction
The creation date of the topup. Defaults to the current date
The amount of the topup
The topup’s currency code
{
"type": "CASH",
"identity": {
"id": "",
"identifier": "Visa *****1234 03/25"
}
}The type of the event
The type of the event
The unique identifier of the contact’s payment method
A short description of the payment method. Depending on the payment method’s type different information is returned:
- Card: the brand, followed by the last 4 digits of the card plus expiration month/year
- Account debit: Name: Bank code followed by the first 5 and the last 9 digits of the account number/IBAN
- Wallet: Name: Email and/or phone used on registration
Details about the related contact
The contact identifier
The contact full name
The contact unique code
The account for which the topup was performed. Either account or wallet is applicable.
The unique ID
The unique number
The wallet for which the topup was performed. Either account or wallet is applicable.
The unique ID
The unique code
Details about spend condition
The commerce pool identifier
The commerce pool name
The commerce pool description
The custom field’s unique key
The custom field’s value
GET https://sandbox.crm.com/backoffice/v2/topups/4AD9C84FA60F9FE407140E20F707726A HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"code": "1234567891234567",
"state": "POSTED",
"topup_date": 1583846865,
"amount": 9.99,
"currency_code": "EUR",
"payment_method": {
"type": "CHEQUE",
"identity": {
"id": "",
"identifier": "Visa *****1234 03/25"
}
},
"contact": {
"id": "1c060611-0667-313e-b3bf-4cb70ee81cdf",
"name": "John Doe",
"code": "C123"
},
"account": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"number": "AC123456"
},
"wallet": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"code": "123456AAVV123685"
},
"commerce_pool": {
"id": "dc01f65b-a482-48f1-9fda-c163df72f28f",
"name": "Redeem Anywhere",
"description": "Ability to redeem on any organisation/day/product"
},
"custom_fields": [
{
"key": "back_office",
"value": "0001-12345"
}
]
}Transfers can be used to move money between accounts or even betwen an accout ad a wallet (and vise-versa).
{id}Create a new Transfer between accounts, wallets or account and wallet
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Transfer amount. The amount is in the origin entity’s currency.
The origin of the transfer. Can be either an account or a wallet
Source account unique id.
Source wallet unique id
The destination of the transfer. Can be either an account or a wallet
Destination account unique id
Destination wallet unique id
Date of transfer
A unique and random 16-digit code will be auto-generated if not provided
Applicable only when transfering funds to a wallet. If specified, then the amount will be transfered to the wallet’s Commerce Balance and reserved to be spent based on the conditions. Otheewise, money is transferred to the wallet’s Open balance
Responses
Created
Body
The unique identifier of the transfer
POST https://sandbox.crm.com/backoffice/v2/transfers HTTP/1.1
Content-Type: application/json
{
"amount": 9.99,
"origin": {
"account_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"wallet_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
},
"destination": {
"account_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"wallet_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
},
"transfer_date": 1620999582,
"code": "1234567891234567",
"commerce_pool_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}{id}Get details of an existing transfer transaction
Path variables
The unique identifier of the transfer to be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Successful Request
Body
The transfer code.
The state of the transfer
Date of transfer
Transfer amount
The origin entity of the transfer. Can be either an account or a wallet. Information about the Contact is retrieved in either case
Origin account details
The unique ID of the source account
The unique number of the source account
Origin wallet details
The unique ID of the source wallet
The unique code of the source wallet
Details of the contact that owns the origin entity
Contact’s unique ID
The full name of the contact that originated the transfer
The unique code of the contact that originated the transfer
The organisation that owns the account
Organisation identifier
Organisation name
The destination of the transfer. Can be either an account or a wallet. Information about the Contact is retrieved in either case
Destination account details
Destination account unique ID
Destination account unique number
Destination wallet details
Destiantion wallet unique ID
Destiantion wallet unique code
Destination contact’s details
Uiue identifier of the contact that owns the destination entity
The full name of the contact that the transfer was sent to
The unique code of the contact that the transfer was sent to
The organisation that owns the destination account
Organisation identifier
Organisation name
The transfer currency, defaults to the origin account currency
The group of conditions that define how the transfered amount can be spend. Applicable only when trasnfering money to a wallet.
The unique identifier fo the spend condition
The name of the spend condition
GET https://sandbox.crm.com/backoffice/v2/transfers/4AD9C84FA60F9FE407140E20F707726A HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"code": "1234567891234567",
"state": "POSTED",
"transfer_date": 1,
"amount": 9.99,
"origin": {
"account": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"number": "AC123456"
},
"wallet": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"code": "W123456AA"
},
"contact": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "John Smith",
"code": "C1230955623"
},
"organisation": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "Good Burgers"
}
},
"destination": {
"account": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"number": "AC123456"
},
"wallet": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"code": "W321456AA"
},
"contact": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "Janet Smith",
"code": "C1249044512"
},
"organisation": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "AC Coffees"
}
},
"currency_code": "EUR",
"commerce_pool": {
"id": "E68DFDCAD1E37A65ACCE45B21269B76D",
"name": "TV services"
}
}{id}{id}{id}Creates a usage detail record. A single usage record can be created per Web AP call
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The usage service being consumed
The usage’s amount
The date and time at which usage was consumed
The contact’s code, used to identiy the contact who is cnsuming usage.
Used to identify the contact who is consuming usage
The contact consuming usage
The subscription through which service is consumed by one of its services
The termed subscription service through which service is consumed
The one time service that a contact purchases and through which usage is consumed
Specify whether usage record will be processed in Sync or Async mode… In the latter case, a webhook will send back to the caller the processing’s result, i.e. if usage is accepted or rejected
The consume usage’s cost. Specified only if the system that records the usage also defines its cost. In this case, CRM will not apply pricing durng billing. Promotions however will be applied, if any, on the charged amount.
The charged amount’s currency
The organisation (merchant or venue) at which usage was consumed.
Indicates that usage consumption is authorised or not. If authorised, then remaining usage allowance is not validated on submitting usage.
Responses
Body
The usage record identifier
POST https://sandbox.crm.com/backoffice/v1/usage_records HTTP/1.1
Content-Type: application/json
{
"usage_service_id": "897f0809f-ed91-4b68-b912-5bd6064ade12",
"usage_amount": 1.99,
"usage_timestamp": 1637318444,
"contact_code": "C00012345",
"mac_address": "00-D0-56-F2-B5-12",
"contact_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"subscription_id": "65fa809f-ed91-4b68-b912-5b23464d9acb",
"termed_service_id": "00af0809f-ed91-4b68-b912-5bd60643253d",
"one_time_service_id": "c2eb205b-98e1-052e-e63c-eff3ac96c585",
"processing": "ASYNC",
"charged_amount": 1.99,
"currency": "EUR",
"organisation_id": "601a809f-ed91-4b68-b912-5b23464deac7"
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "65fa809f-ed91-4b68-b912-5b23464d9acb"
}{id}Update a single usage record.
Path variables
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Responses
Body
PUT https://sandbox.crm.com/backoffice/v1/usage_records/{id} HTTP/1.1
Content-Type: application/json
{
"state": "REJECTED",
"billing_state": "",
"billing_directive": "",
"invoice_id": "",
"credit_note_id": ""
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": ""
}{id}Deletes a single usage record
Path variables
The usage record (identifier) that will be deleted
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
DELETE https://sandbox.crm.com/backoffice/v1/usage_records/{id} HTTP/1.1
HTTP/1.1 200 OK Retuns a list of usage records
Request parameters
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
The unique identifier of the termed subscrpiton service or contact one-time service
The unique identifier of the usage product
Filter based on the usage date, which may fall within a given date range. The value can be a string with a date in epoch format. Each option must also include an operator. Use up to two options based on the required search (e.g. usage_timestamp[gte]=1618395497&usage_timestamp[lt]=1618395497).
The invoice in which the usage records were included
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v1/usage_records HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "",
"code": "",
"usage_amount": 1.99,
"usage_timestamp": 12345678,
"charged_amount": 1.99,
"currency": "EUR",
"state": "REJECTED",
"billing_state": "PENDING",
"billing_directive": "TO_BE_BILLED",
"contact": {
"id": "",
"code": "",
"name": ""
},
"usage_service": {
"id": "",
"sku": "",
"name": ""
},
"service": {
"id": "",
"sku": "",
"name": "",
"classification": "ONE_TIME_SERVICE"
},
"measurement_unit": {
"id": "",
"name": "",
"display_name": ""
}
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Returns detailed information of a usage record. A single usage record is returned per Web API call
Path variables
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
Applicable and mandatory only if a usage record is cancelled. Provides information on the user and the date on whiche the usage record was cancelled.
GET https://sandbox.crm.com/backoffice/v1/usage_records/{id} HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "",
"code": "",
"state": "REJECTED",
"billing_state": "COMPLETED",
"billing_directive": "NOT_TO_BE_BILLED",
"usage_timestamp": 1637320345,
"charged_amount": 9.99,
"currency": "EUR",
"usage_amount": 1.99,
"usage_service": {
"id": "",
"sku": "",
"name": ""
},
"measurement_unit": {
"id": "",
"name": "",
"display_name": ""
},
"service": {
"id": "",
"sku": "",
"name": "",
"classification": "ONE_TIME_SERVICE"
},
"contact": {
"id": "",
"code": "",
"name": "John Smith"
},
"subscription": {
"id": "",
"code": ""
},
"organisation": {
"id": "",
"type": "MERCHANT",
"name": "merchant name"
},
"cancellation": {
"date": 1,
"user": {
"id": "",
"username": ""
}
},
"financials": {
"invoice": {
"id": "",
"number": ""
},
"credit_note": {
"id": "",
"number": ""
}
}
}Users represent an organisation’s employees that are responsible for the configuration and business flows of such organisation
{id}{id}/my_profile{id}{id}{id}/my_profile{id}/actions{id}/mode{id}/sign_outAuthenticate a user and provide a token that needs to be used for subsequent API requests
Request headers
The public api key required for API calls to identify the organisation
Request body
The user’s identity provider
The user’s username (required for EMAIL provider)
The user’s password (required for EMAIL provider)
The user’s (configured) two-factor methods
Defines the type of the user 2FA method
The two-factor method value (applicable only for email, phone and back-up code based two-factor methods)
The user’s token as provided by the SSO (OIDC/oAuth) provider (required for OIDC_OAUTH provider)
The token taken from the OIDC/oAuth service provider
The state taken from the OIDC/oAuth service provider
Responses
The request has succeeded
Body
Authentication information provided for an admin user
The token that can be used in subsequent API calls
The token that can be used to generate a new access token (when previous is expired)
The token expiration date
The authenticated user details
{
"first_name": "John",
"last_name": "Doe",
"email": "johndoe@crm.com"
}The first name
The last name
The email address
The organisation mode
Organisation was not live enabled
Organisation is in test mode (therefore User is signed in test mode)
Organisation supports live mode (therefore User is signed in live mode)
The organisations that the user is a member at
The organisation identifier
The type of the organisation
The organisation name
The organisation status
The organisation progress status
Defines whether a user (other than the owner) is invited
Defines whether a contact is created (applicable only for business)
Defines whether a reward scheme is created (applicable only for business)
Defines whether a reward offer is created
Defines whether a merchant is created (applicable only for business)
Defines whether a venue is created
Defines whether password has been expired or not
Defines the date on which the user’s lockout will be expired
Defines whether two factor authentication is required or not (true only for authentication API, false to all others)
The two-factor method that is used and all user’s (configured) two-factor methods
The method that is used for the two-factor authentication
Defines the type of the user 2FA method
The two-factor method obfuscated value (applicable only for email and phone based two-factor methods)
The user’s (configured) two-factor methods
The user’s (configured) two-factor methods
Defines the type of the user 2FA method
The two-factor method obfuscated value (applicable only for email and phone based two-factor methods)
Defines the number of days that are left until password is expired
The client request has not been completed because it lacks valid authentication credentials for the requested resource
POST https://sandbox.crm.com/backoffice/v2/users/authenticate HTTP/1.1
api_key: 8c54d563-b991-4b76-8a83-557c08166f95
Content-Type: application/json
{
"username": "johndoe@crm.com",
"password": "password1234"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"access_token": "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJhY2U5ZDRkMi0wYjhkLTExZWEtOTUxOC00MjAxMGE5YTAwMDMiLCJ0eXBlIjoiYWNjZXNzIiwicHJpbWFyeU9yZ2FuaXNhdGlvbiI6IjhkY2MzNjgwLTBiOGEtMTFlYS05NTE4LTQyMDEwYTlhMDAwMyIsImN1cnJlbnRPcmdhbmlzYXRpb24iOiI4ZGNjMzY4MC0wYjhhLTExZWEtOTUxOC00MjAxMGE5YTAwMDMiLCJzY29wZSI6WyJjdXN0b21lci13cml0ZSIsIm9yZGVyLXJlYWQiXSwicHJlZmVycmVkX3VzZXJuYW1lIjoiamQiLCJlbWFpbCI6ImpkQGNybS5jb20iLCJleHAiOjE1Nzk4ODA2Mjl9.-uJyEW-Y_QgHb1q-WHBBMew3J_TnUfvqy-NDFmIzFhbS3gkerE5QAqp4cgNMr5BiGcyt174UVhYGXp2Fg7BKcw",
"refresh_token": "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJhY2U5ZDRkMi0wYjhkLTExZWEtOTUxOC00MjAxMGE5YTAwMDMiLCJ0eXBlIjoicmVmcmVzaCIsInByaW1hcnlPcmdhbmlzYXRpb24iOiI4ZGNjMzY4MC0wYjhhLTExZWEtOTUxOC00MjAxMGE5YTAwMDMiLCJjdXJyZW50T3JnYW5pc2F0aW9uIjoiOGRjYzM2ODAtMGI4YS0xMWVhLTk1MTgtNDIwMTBhOWEwMDAzIiwic2NvcGUiOlsiY3VzdG9tZXItd3JpdGUiLCJvcmRlci1yZWFkIl0sInByZWZlcnJlZF91c2VybmFtZSI6ImpkIiwiZW1haWwiOiJqZEBjcm0uY29tIiwiZXhwIjoxNTc5ODgwNjI5fQ.cW_g6ozy2OaP5Tx3l2QuzNeRBSXnNrP1AN6QoOqf6s95eVoUrld6bHRUdBt3H74CZyrxhp7Rs_uXtv17GhVz5w",
"expiration_date": 1579880629,
"user": {
"first_name": "John",
"last_name": "Doe",
"email": "johndoe@crm.com"
},
"mode": "TEST",
"organisations": [
{
"id": "b907f6f0-5f3c-9b67-bcf1-9ee13d747294",
"type": "SERVICE_OWNER",
"name": "CRM.COM"
}
],
"progress": {
"invite_user": "true",
"create_contact": "false",
"create_scheme": "true",
"create_offer": "false",
"create_merchant": "false",
"create_venue": "false"
},
"password_expired": true,
"lockout_date": 1615897181,
"two_factor_enabled": true
}POST https://sandbox.crm.com/backoffice/v2/users/authenticate HTTP/1.1
api_key: 8c54d563-b991-4b76-8a83-557c08166f95
Content-Type: application/json
{
"username": "johndoe@crm.com",
"password": "password1234"
}
HTTP/1.1 401 Unauthorized
Content-Type: application/json
{
"user": {
"first_name": "John",
"last_name": "Doe",
"email": "johndoe@crm.com"
},
"two_factor_methods": {
"send_method": {
"method": "EMAIL",
"value": "jo****@crm.com"
},
"options": [
{
"method": "EMAIL",
"value": "jo****@crm.com"
},
{
"method": "GOOGLE"
}
]
}
}Authenticate a user over to an OIDC provider
Request parameters
The user’s username that will be used for OIDC purposes
Request headers
The public api key required for API calls to identify the organisation
Responses
The request has succeeded
Body
The URL that users should be redirected for OIDC authentication purposes
The client request has not been completed because it lacks valid authentication credentials for the requested resource
GET https://sandbox.crm.com/backoffice/v2/users/oidc?username=johndoe@crm.com HTTP/1.1
api_key: 8c54d563-b991-4b76-8a83-557c08166f95
HTTP/1.1 200 OK
Content-Type: application/json
{
"authorization_url": "azure.crm.com"
}Refresh the user session based on a refresh token and provide a token that needs to be used for subsequent API requests
Request headers
The refresh token
Responses
The request has succeeded
Body
Authentication information provided for an admin user
The token that can be used in subsequent API calls
The token that can be used to generate a new access token (when previous is expired)
The token expiration date
The authenticated user details
{
"first_name": "John",
"last_name": "Doe",
"email": "johndoe@crm.com"
}The first name
The last name
The email address
The organisation mode
Organisation was not live enabled
Organisation is in test mode (therefore User is signed in test mode)
Organisation supports live mode (therefore User is signed in live mode)
The organisations that the user is a member at
The organisation identifier
The type of the organisation
The organisation name
The organisation status
The organisation progress status
Defines whether a user (other than the owner) is invited
Defines whether a contact is created (applicable only for business)
Defines whether a reward scheme is created (applicable only for business)
Defines whether a reward offer is created
Defines whether a merchant is created (applicable only for business)
Defines whether a venue is created
Defines whether password has been expired or not
Defines the date on which the user’s lockout will be expired
Defines whether two factor authentication is required or not (true only for authentication API, false to all others)
The two-factor method that is used and all user’s (configured) two-factor methods
The method that is used for the two-factor authentication
Defines the type of the user 2FA method
The two-factor method obfuscated value (applicable only for email and phone based two-factor methods)
The user’s (configured) two-factor methods
The user’s (configured) two-factor methods
Defines the type of the user 2FA method
The two-factor method obfuscated value (applicable only for email and phone based two-factor methods)
Defines the number of days that are left until password is expired
The client request has not been completed because it lacks valid authentication credentials for the requested resource
POST https://devapi.crm.com/backoffice/v1/users/refresh HTTP/1.1
refresh_token: eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJhMjc4ZDNlNS05YjhlLTQzNmUtOTIzMC03MGYzZTJkZjFjYTUiLCJleHAiOjE1Njg1NTQxMjJ9.LemqPPThkqfakkKS6CdkNvV1Lnc88CWirEpHOPnWjJPQz02zgkKSwfbvrEsl3OmR2LUhDILsOXf4x-GPFmNJCg
HTTP/1.1 200 OK
Content-Type: application/json
{
"access_token": "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJhY2U5ZDRkMi0wYjhkLTExZWEtOTUxOC00MjAxMGE5YTAwMDMiLCJ0eXBlIjoiYWNjZXNzIiwicHJpbWFyeU9yZ2FuaXNhdGlvbiI6IjhkY2MzNjgwLTBiOGEtMTFlYS05NTE4LTQyMDEwYTlhMDAwMyIsImN1cnJlbnRPcmdhbmlzYXRpb24iOiI4ZGNjMzY4MC0wYjhhLTExZWEtOTUxOC00MjAxMGE5YTAwMDMiLCJzY29wZSI6WyJjdXN0b21lci13cml0ZSIsIm9yZGVyLXJlYWQiXSwicHJlZmVycmVkX3VzZXJuYW1lIjoiamQiLCJlbWFpbCI6ImpkQGNybS5jb20iLCJleHAiOjE1Nzk4ODA2Mjl9.-uJyEW-Y_QgHb1q-WHBBMew3J_TnUfvqy-NDFmIzFhbS3gkerE5QAqp4cgNMr5BiGcyt174UVhYGXp2Fg7BKcw",
"refresh_token": "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJhY2U5ZDRkMi0wYjhkLTExZWEtOTUxOC00MjAxMGE5YTAwMDMiLCJ0eXBlIjoicmVmcmVzaCIsInByaW1hcnlPcmdhbmlzYXRpb24iOiI4ZGNjMzY4MC0wYjhhLTExZWEtOTUxOC00MjAxMGE5YTAwMDMiLCJjdXJyZW50T3JnYW5pc2F0aW9uIjoiOGRjYzM2ODAtMGI4YS0xMWVhLTk1MTgtNDIwMTBhOWEwMDAzIiwic2NvcGUiOlsiY3VzdG9tZXItd3JpdGUiLCJvcmRlci1yZWFkIl0sInByZWZlcnJlZF91c2VybmFtZSI6ImpkIiwiZW1haWwiOiJqZEBjcm0uY29tIiwiZXhwIjoxNTc5ODgwNjI5fQ.cW_g6ozy2OaP5Tx3l2QuzNeRBSXnNrP1AN6QoOqf6s95eVoUrld6bHRUdBt3H74CZyrxhp7Rs_uXtv17GhVz5w",
"expiration_date": 1579880629,
"first_name": "John",
"last_name": "Doe",
"email": "johndoe@crm.com",
"organisations": [
{
"external_id": "QWERTY12345671234567324ETFTGBY78",
"org_type": "BUSINESS",
"name": "CRMdotCOM"
}
],
"progress": {
"invite_user": "true",
"create_contact": "false",
"create_reward_offer": "false",
"create_merchant": "false",
"create_venue": "false"
}
}Request a new password for an existing user (providing the user’s login email address, where such password reset email will be sent)
Request headers
The public api key required for API calls to identify the organisation
Request body
The email that will be used to request a new password
Responses
The request has succeeded
POST https://sandbox.crm.com/backoffice/v2/users/forgot_password HTTP/1.1
api_key: 8c54d563-b991-4b76-8a83-557c08166f95
Content-Type: application/json
{
"email": "jd@crm.com"
}
HTTP/1.1 204 No Content Changes the password for a user (when a user requested a new one via Forgot Password)
Request body
The token that will verify that the client is trusted
The user’s new password
Responses
The request has succeeded
The client request has not been completed because it lacks valid authentication credentials for the requested resource
POST https://sandbox.crm.com/backoffice/v2/users/change_password HTTP/1.1
Content-Type: application/json
{
"token": "ABCTKN123456798VGP2020",
"password": "password1234"
}
HTTP/1.1 204 No Content {id}/modeSwitch the user mode between test and live
Path variables
The user (identifer) that its mode will be changed
Request headers
Authorization Token
Responses
The request has succeeded
Body
Authentication information provided for an admin user
The token that can be used in subsequent API calls
The token that can be used to generate a new access token (when previous is expired)
The token expiration date
The authenticated user details
{
"first_name": "John",
"last_name": "Doe",
"email": "johndoe@crm.com"
}The first name
The last name
The email address
The organisation mode
Organisation was not live enabled
Organisation is in test mode (therefore User is signed in test mode)
Organisation supports live mode (therefore User is signed in live mode)
The organisations that the user is a member at
The organisation identifier
The type of the organisation
The organisation name
The organisation status
The organisation progress status
Defines whether a user (other than the owner) is invited
Defines whether a contact is created (applicable only for business)
Defines whether a reward scheme is created (applicable only for business)
Defines whether a reward offer is created
Defines whether a merchant is created (applicable only for business)
Defines whether a venue is created
Defines whether password has been expired or not
Defines the date on which the user’s lockout will be expired
Defines whether two factor authentication is required or not (true only for authentication API, false to all others)
The two-factor method that is used and all user’s (configured) two-factor methods
The method that is used for the two-factor authentication
Defines the type of the user 2FA method
The two-factor method obfuscated value (applicable only for email and phone based two-factor methods)
The user’s (configured) two-factor methods
The user’s (configured) two-factor methods
Defines the type of the user 2FA method
The two-factor method obfuscated value (applicable only for email and phone based two-factor methods)
Defines the number of days that are left until password is expired
POST https://sandbox.crm.com/backoffice/v2/users/3c9fc0df-3948-a933-b594-ab1bf7f1ce5c/mode HTTP/1.1
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
HTTP/1.1 200 OK
Content-Type: application/json
{
"access_token": "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJhY2U5ZDRkMi0wYjhkLTExZWEtOTUxOC00MjAxMGE5YTAwMDMiLCJ0eXBlIjoiYWNjZXNzIiwicHJpbWFyeU9yZ2FuaXNhdGlvbiI6IjhkY2MzNjgwLTBiOGEtMTFlYS05NTE4LTQyMDEwYTlhMDAwMyIsImN1cnJlbnRPcmdhbmlzYXRpb24iOiI4ZGNjMzY4MC0wYjhhLTExZWEtOTUxOC00MjAxMGE5YTAwMDMiLCJzY29wZSI6WyJjdXN0b21lci13cml0ZSIsIm9yZGVyLXJlYWQiXSwicHJlZmVycmVkX3VzZXJuYW1lIjoiamQiLCJlbWFpbCI6ImpkQGNybS5jb20iLCJleHAiOjE1Nzk4ODA2Mjl9.-uJyEW-Y_QgHb1q-WHBBMew3J_TnUfvqy-NDFmIzFhbS3gkerE5QAqp4cgNMr5BiGcyt174UVhYGXp2Fg7BKcw",
"refresh_token": "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJhY2U5ZDRkMi0wYjhkLTExZWEtOTUxOC00MjAxMGE5YTAwMDMiLCJ0eXBlIjoicmVmcmVzaCIsInByaW1hcnlPcmdhbmlzYXRpb24iOiI4ZGNjMzY4MC0wYjhhLTExZWEtOTUxOC00MjAxMGE5YTAwMDMiLCJjdXJyZW50T3JnYW5pc2F0aW9uIjoiOGRjYzM2ODAtMGI4YS0xMWVhLTk1MTgtNDIwMTBhOWEwMDAzIiwic2NvcGUiOlsiY3VzdG9tZXItd3JpdGUiLCJvcmRlci1yZWFkIl0sInByZWZlcnJlZF91c2VybmFtZSI6ImpkIiwiZW1haWwiOiJqZEBjcm0uY29tIiwiZXhwIjoxNTc5ODgwNjI5fQ.cW_g6ozy2OaP5Tx3l2QuzNeRBSXnNrP1AN6QoOqf6s95eVoUrld6bHRUdBt3H74CZyrxhp7Rs_uXtv17GhVz5w",
"expiration_date": 1579880629,
"user": {
"first_name": "John",
"last_name": "Doe",
"email": "johndoe@crm.com"
},
"mode": "TRIAL",
"organisations": [
{
"id": "b907f6f0-5f3c-9b67-bcf1-9ee13d747294",
"type": "TRANSACTION_PROCESSOR",
"name": "CRM.COM"
}
],
"progress": {
"invite_user": "true",
"create_contact": "false",
"create_scheme": "true",
"create_offer": "false",
"create_merchant": "false",
"create_venue": "false"
},
"password_expired": true,
"lockout_date": 1615897181,
"two_factor_enabled": true
}Request an one-time password for a specific user. The request will check the user details and send an outbound validation number that can be used to verify the contact
Request headers
Authorization Token
The public api key required for API calls to identify the organisation
Request body
Information on how the user will be identified
The predetermined information that will be used to identify the user
Two-factor Authentication based on Email
Two-factor Authentication based on Phone (SMS)
The value of the credential to check
Responses
The request has succeeded
Body
The one time password authentication identifier that is generated as per otp request and will be used for validating such otp
POST https://sandbox.crm.com/backoffice/v1/users/otp HTTP/1.1
Content-Type: application/json
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
{
"credentials": [
{
"name": "TFA_EMAIL",
"value": "j_ioannou@crm.com"
}
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"auth_otp": "0e5efc4e-5dc7-ea54-cf9d-498914806e0f"
}Verify an one-time password that was requested and provide authentication information that can be used for subsequent API calls
Request headers
The public api key required for API calls to identify the organisation
Request body
The one time password authentication identifier that is generated as per otp request and will be used for validating such otp
The one time password that was sent to the contact and should be used for verification purposes
Responses
The request has succeeded
Body
Authentication information provided for an admin user
The token that can be used in subsequent API calls
The token that can be used to generate a new access token (when previous is expired)
The token expiration date
The authenticated user details
{
"first_name": "John",
"last_name": "Doe",
"email": "johndoe@crm.com"
}The first name
The last name
The email address
The organisation mode
Organisation was not live enabled
Organisation is in test mode (therefore User is signed in test mode)
Organisation supports live mode (therefore User is signed in live mode)
The organisations that the user is a member at
The organisation identifier
The type of the organisation
The organisation name
The organisation status
The organisation progress status
Defines whether a user (other than the owner) is invited
Defines whether a contact is created (applicable only for business)
Defines whether a reward scheme is created (applicable only for business)
Defines whether a reward offer is created
Defines whether a merchant is created (applicable only for business)
Defines whether a venue is created
Defines whether password has been expired or not
Defines the date on which the user’s lockout will be expired
Defines whether two factor authentication is required or not (true only for authentication API, false to all others)
The two-factor method that is used and all user’s (configured) two-factor methods
The method that is used for the two-factor authentication
Defines the type of the user 2FA method
The two-factor method obfuscated value (applicable only for email and phone based two-factor methods)
The user’s (configured) two-factor methods
The user’s (configured) two-factor methods
Defines the type of the user 2FA method
The two-factor method obfuscated value (applicable only for email and phone based two-factor methods)
Defines the number of days that are left until password is expired
The client request has not been completed because it lacks valid authentication credentials for the requested resource
POST https://sandbox.crm.com/backoffice/v2/users/validate_otp HTTP/1.1
api_key: 8c54d563-b991-4b76-8a83-557c08166f95
Content-Type: application/json
{
"auth_otp": "47c7-318202dbe45d",
"code": 123456
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"access_token": "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJhY2U5ZDRkMi0wYjhkLTExZWEtOTUxOC00MjAxMGE5YTAwMDMiLCJ0eXBlIjoiYWNjZXNzIiwicHJpbWFyeU9yZ2FuaXNhdGlvbiI6IjhkY2MzNjgwLTBiOGEtMTFlYS05NTE4LTQyMDEwYTlhMDAwMyIsImN1cnJlbnRPcmdhbmlzYXRpb24iOiI4ZGNjMzY4MC0wYjhhLTExZWEtOTUxOC00MjAxMGE5YTAwMDMiLCJzY29wZSI6WyJjdXN0b21lci13cml0ZSIsIm9yZGVyLXJlYWQiXSwicHJlZmVycmVkX3VzZXJuYW1lIjoiamQiLCJlbWFpbCI6ImpkQGNybS5jb20iLCJleHAiOjE1Nzk4ODA2Mjl9.-uJyEW-Y_QgHb1q-WHBBMew3J_TnUfvqy-NDFmIzFhbS3gkerE5QAqp4cgNMr5BiGcyt174UVhYGXp2Fg7BKcw",
"refresh_token": "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJhY2U5ZDRkMi0wYjhkLTExZWEtOTUxOC00MjAxMGE5YTAwMDMiLCJ0eXBlIjoicmVmcmVzaCIsInByaW1hcnlPcmdhbmlzYXRpb24iOiI4ZGNjMzY4MC0wYjhhLTExZWEtOTUxOC00MjAxMGE5YTAwMDMiLCJjdXJyZW50T3JnYW5pc2F0aW9uIjoiOGRjYzM2ODAtMGI4YS0xMWVhLTk1MTgtNDIwMTBhOWEwMDAzIiwic2NvcGUiOlsiY3VzdG9tZXItd3JpdGUiLCJvcmRlci1yZWFkIl0sInByZWZlcnJlZF91c2VybmFtZSI6ImpkIiwiZW1haWwiOiJqZEBjcm0uY29tIiwiZXhwIjoxNTc5ODgwNjI5fQ.cW_g6ozy2OaP5Tx3l2QuzNeRBSXnNrP1AN6QoOqf6s95eVoUrld6bHRUdBt3H74CZyrxhp7Rs_uXtv17GhVz5w",
"expiration_date": 1579880629,
"user": {
"first_name": "John",
"last_name": "Doe",
"email": "johndoe@crm.com"
},
"mode": "TRIAL",
"organisations": [
{
"id": "b907f6f0-5f3c-9b67-bcf1-9ee13d747294",
"type": "TRANSACTION_PROCESSOR",
"name": "CRM.COM"
}
],
"progress": {
"invite_user": "true",
"create_contact": "false",
"create_scheme": "true",
"create_offer": "false",
"create_merchant": "false",
"create_venue": "false"
},
"password_expired": true,
"lockout_date": 1615897181,
"two_factor_enabled": true
}{id}/sign_outSigns out a user by terminating his/her session, such user will not be able to access the client (SPA) and should sign in again in order to do so
Path variables
The user (identifer) that will be signed out
Request headers
Authorization Token
Responses
POST https://sandbox.crm.com/backoffice/v2/users/3fd82b4e-94c3-e11e-a090-0b48261f788a/sign_out HTTP/1.1
HTTP/1.1 204 No Content {id}Update an existing user
Path variables
The user (identifier) that will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The user’s first name
The user’s last name
The user’s email address
The phone country code (based on ISO 3 char code)
The phone number
The user role
The language preferred by the user for communication
The language preferred by the user for software translation
The teams that the user will be part of
The user state
Responses
The request has succeeded
Body
The user identifier
PUT https://sandbox.crm.com/backoffice/v2/users/010cd9e5-d10d-1b4c-2cf2-daa0c06c835e HTTP/1.1
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
Content-Type: application/json
{
"first_name": "Jane",
"last_name": "Doe",
"email_address": "john@crm.com",
"phone": {
"country_code": "CYP",
"number": "99123456"
},
"role_id": "03486d93-c68a-721c-e8a4-e30f3a0f8252",
"preferred_language": "EN",
"software_language": "EN",
"teams": [
"5da28aca-b0f1-636f-0f03-2a732eb0fb65"
],
"is_active": "true"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "CAD1E31269B76D7A65ACCE45B2E68DFD"
}{id}/my_profileUpdate the signed-in user details
Path variables
The (signed-in) user (identifer) that will be updated
Request headers
Authorization Token
Request body
The user’s first name
The user’s last name
The language preferred by the user for communications
The language preferred by the user for software translation
The user’s email address
The phone country code (based on ISO 3 char code)
The phone number
Responses
The request has succeeded
Body
The user identifier
PUT https://sandbox.crm.com/backoffice/v2/users/42204ef7-0613-4379-2525-4afc284e694a/my_profile HTTP/1.1
Content-Type: application/json
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
{
"first_name": "Jane",
"last_name": "Doe",
"preferred_language": "EN",
"software_language": "EN",
"email_address": "john@crm.com",
"phone": {
"country_code": "CYP",
"number": "99123456"
}
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "42204ef7-0613-4379-2525-4afc284e694a"
}{id}Delete a user from a specific organisation
Path variables
The user (identifer) that will be deleted
Notes
Users can belong to multiple organisations under a cloud operator. Deleting a user from a specific organisation will be removed only from that organisation, but such user can still sign in to all other organisations that might belong to.
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
DELETE https://sandbox.crm.com/backoffice/v2/users/aeb209b7-bea9-9508-f053-cf82bb8ccc28 HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 204 No Content Retrieve a list of users based on search criteria (e.g. all active users)
Request parameters
Filter based on search value (case insensitive) across full name, email address and phone number
Filter based on user first name
Filter based on user last name
Filter based on user email address
Filter based on whether users have accepted their invitation (false), have pending invitation (true) or both (null)
Filter based on user roles that are assigned to
Filter based on teams that belong to
Filter based on whether users are locked due to incorrect password (true if locked, false if not locked)
Filter based on whether users are active or not
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The user identifier
The user’s first name
The user’s last name
The user’s email address
The phone country code (based on ISO 3 char code)
The phone number
The language preferred by the user for communication
The language preferred by the user for software translation
The user state
The date when the user was invited
Defines whether two-factor authentication is set or not
Defines when the user lockout period will end (applicable if the user is locked out due to reaching the maximum invalid password attempts)
Information about the user roles
The user role identifier
The user role name
The timestamp of the user’s last login
The timestamp of the user’s last deactivation
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/users HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "a15947aa-3596-29d2-9a99-c9c3e5114904",
"first_name": "John",
"last_name": "Doe",
"email_address": "john@crm.com",
"phone": {
"country_code": "CYP",
"number": "99123456"
},
"preferred_language": "GR",
"software_language": "EN",
"is_active": "true",
"invitation_date": 1581009106,
"two_factor_enabled": "true",
"lock_expiration": 1617094607,
"role": {
"id": "1a917631-b103-c47d-283f-53cc50ba1e2b",
"name": "Owner"
}
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Retrieve detailed information for a user
Path variables
The user (identifer) that will be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The user identifier
The user’s first name
The user’s last name
The user’s email address
The phone country code (based on ISO 3 char code)
The phone number
The language preferred by the user for communication
The language preferred by the user for software translation
Information about the user roles
The user role identifier
The user role name
The user identities
The user’s identity
The user identity
The provider of the identity
The identity’s challenge
The teams that the user is part of
Details about team
The team identifier
The team name
The timestamp of the user’s last login
The timestamp of the user’s last deactivation
GET https://sandbox.crm.com/backoffice/v2/users/42204ef7-0613-4379-2525-4afc284e694a HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "42204ef7-0613-4379-2525-4afc284e694a",
"first_name": "John",
"last_name": "Doe",
"email_address": "john@crm.com",
"phone": {
"country_code": "CYP",
"number": "99123456"
},
"preferred_language": "EN",
"software_language": "GR",
"role": {
"id": "1a917631-b103-c47d-283f-53cc50ba1e2b",
"name": "Owner"
},
"identities": [
{
"id": "e51778aa-3493-6a19-d015-5ed883f0eb39",
"provider": "EMAIL",
"identity_challenge": "johndoe@crm.com"
}
],
"teams": [
{
"id": "bf1370a1-73ad-0bbf-6fef-f2ce1938d4fe",
"name": "Support"
}
]
}{id}/my_profileRetrieve detailed information for the signed-in user
Path variables
The (signed-in) user (identifer) that will be retrieved
Request headers
Authorization Token
Responses
The request has succeeded
Body
The user identifier
The user’s first name
The user’s last name
The user’s email address
The phone country code (based on ISO 3 char code)
The phone number
The language preferred by the user for communication
The language preferred by the user for software translation
Information about the user roles
The user role identifier
The user role name
The user identities
The user’s identity
The user identity
The provider of the identity
The identity’s challenge
The teams that the user is part of
Details about team
The team identifier
The team name
GET https://sandbox.crm.com/backoffice/v2/users/42204ef7-0613-4379-2525-4afc284e694a/my_profile HTTP/1.1
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "42204ef7-0613-4379-2525-4afc284e694a",
"first_name": "John",
"last_name": "Doe",
"email_address": "john@crm.com",
"phone": {
"country_code": "CYP",
"number": "99123456"
},
"preferred_language": "EN",
"software_language": "GR",
"role": {
"id": "1a917631-b103-c47d-283f-53cc50ba1e2b",
"name": "Owner"
},
"identities": [
{
"id": "e51778aa-3493-6a19-d015-5ed883f0eb39",
"provider": "EMAIL",
"identity_challenge": "johndoe@crm.com"
}
],
"teams": [
{
"id": "bf1370a1-73ad-0bbf-6fef-f2ce1938d4fe",
"name": "Support"
}
]
}Retrieve a list of organisations that a user is a member to
Request parameters
The user’s username that will be used for retrieving the organisations that such user is a member to
Responses
The request has succeeded
Body
The organisation identifier
The organisation name
The user’s last name
The public API Key for the organisation
GET https://sandbox.crm.com/backoffice/v2/users/organisations?username=johndoe@crm.com HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "a15947aa-3596-29d2-9a99-c9c3e5114904",
"name": "CRM.COM",
"login_method": "USERNAME_PASSWORD",
"public_api_key": "bb511dbf-cdb0-b446-c329-01bb12de4126"
}
]
}{id}/actionsPerform actions on existing user (e.g. cancel user lockout)
Path variables
The user (identifer) that an action will be applied
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The action that will be applied on the user
Cancel the lockout that is applied on user due to invalid authentication (reaching the max auth attemps with no success)
Resend an invitation to a user, given that such invitation was not accepted yet
Revoke an invitation from a user, given that such invitation was not accepted yet
Responses
The request has succeeded
Body
The user identifier
PUT https://sandbox.crm.com/backoffice/v2/users/42204ef7-0613-4379-2525-4afc284e694a/actions HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"actions": "CANCEL_LOCK"
}
HTTP/1.1 204 No Content PUT https://sandbox.crm.com/backoffice/v2/users/42204ef7-0613-4379-2525-4afc284e694a/actions HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"actions": "INVITE_RESEND"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "0bb44610-f77c-85e0-f8a1-d35da22f5c78"
}Invite a new user to an organisation with a specific role (invitation will be sent via the specified identity)
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The user’s first name
The user’s last name
The organisation identifier that the user is invited to
The role that will be assigned on the invited user
The user’s identity
The provider of the identity
The identity challenge
Defines the teams that the user will be part of
Responses
The request has succeeded
Body
The user identifier
POST https://sandbox.crm.com/backoffice/v2/users/invite HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"first_name": "Jane",
"last_name": "Doe",
"organisation_id": "1fd4d25a-48c0-801c-1880-8ed9a6795f29",
"role_id": "c7acbdb4-8d27-d8ef-e73c-b5467cdfdea8",
"identity": {
"type": "EMAIL",
"challenge": "jd@crm.com"
},
"teams": [
"1bd7328c-edf4-2cb3-c640-f6c27bbdbd43"
]
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "2ff8f7c0-e232-ea2b-2e28-c75db5d5ab12"
}Accept a user’s invitation for joining an organisation
Request body
The token that will verify that the client is trusted
The user’s password
Responses
The request has succeeded
POST https://sandbox.crm.com/backoffice/v2/users/accept_invite HTTP/1.1
Content-Type: application/json
{
"token": "ABCTKN123456798VGP2020",
"password": "password1234"
}
HTTP/1.1 204 No ContentRequest another email or phone verification for a user after an email or phone verification has been sent, but not verified
Request headers
The secret api key required for API calls to ensure that the client is trusted
Request body
The email that was used during registration (email or phone should be provided)
The phone number
Responses
The request has succeeded
Body
The one time password authentication identifier that is generated as per otp request and will be used for validating such otp
POST https://sandbox.crm.com/backoffice/v2/users/resend_verification HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"email_address": "john@crm.com"
}
HTTP/1.1 204 No Content {id}/identities{id}/identities/{identity_id}{id}/identities/{identity_id}{id}/identitiesCreate an identity for a specific user
Path variables
The user (identifer) that an identity will be created
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The provider of the identity
The identity challenge
The identity value (e.g. password) - applicable only for EMAIL based identities
Responses
The request has succeeded
Body
The user identity identifier
POST https://sandbox.crm.com/backoffice/v2/users/42204ef7-0613-4379-2525-4afc284e694a/identities HTTP/1.1
Content-Type: application/json
{
"type": "EMAIL",
"challenge": "johndoe@crm.com",
"value": "1234"
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "a84a13f9-36d5-7dca-50e6-a2936a6f4b00"
}{id}/identities/{identity_id}Update an existing identity for a specific user
Path variables
The user (identifer) that an identity will be created
The identity (identifer) that will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The identity challenge
The identity value (e.g. password) - applicable only for EMAIL based identities
The current identity value (e.g. password) - applicable only for EMAIL based identities
Responses
The request has succeeded
Body
The user identity identifier
PUT https://sandbox.crm.com/backoffice/v2/users/42204ef7-0613-4379-2525-4afc284e694a/identities/285318e8-e309-2e4d-fc5e-f75030dd460e HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"challenge": "johndoe@crm.com",
"value": "1234"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "285318e8-e309-2e4d-fc5e-f75030dd460e"
}{id}/identities/{identity_id}Delete an identity for a specific user
Path variables
The user (identifer) whose identity will be deleted
The identity (identifer) that will be deleted
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
DELETE https://sandbox.crm.com/backoffice/v2/users/42204ef7-0613-4379-2525-4afc284e694a/identities/ade2c35a-abb6-9dcd-c703-1b36605bf344 HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 204 No Content {id}/two_factor_methods{id}/two_factor_methods/{method_id}{id}/two_factor_methods{id}/two_factor_methods/{method_id}/actions{id}/two_factor_methods/backup{id}/two_factor_methodsCreate a 2FA method for a specific user
Path variables
The user (identifier) for which a 2FA method will be created
Request headers
Authorization Token
Request body
Defines the type of the user 2FA method
The two-factor authentication value
Responses
The request has succeeded
Body
The two-factor authentication method identifier
The two-factor authentication time-based one-time password (TOTP) details
The TOTP URL that will be used for the QR code
The TOTP key that can be used for manual registration on an authenticator app
POST https://sandbox.crm.com/backoffice/v2/users/993d849e-b5b0-be3e-1486-9334200757cd/two_factor_methods HTTP/1.1
Content-Type: application/json
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
{
"method": "EMAIL",
"value": "johndoe@crm.com"
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "d464860c-4ca3-0e84-a48c-6819a3406791"
}{id}/two_factor_methods/{method_id}Delete a user’s existing two-factor authentication method
Path variables
The user (identifier) whose two-factor authentication method will be deleted
The two-factor authentication method (identifier) that will be deleted
Request headers
Authorization Token
Responses
The request has succeeded
DELETE https://sandbox.crm.com/backoffice/v2/users/993d849e-b5b0-be3e-1486-9334200757cd/two_factor_methods/30213192-3bd2-868e-128e-b93495526e8f HTTP/1.1
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
HTTP/1.1 204 No Content {id}/two_factor_methodsRetrieve a list of a user’s two-factor authentication methods based on search criteria (e.g. all methods)
Path variables
The user (identifier) whose two-factor authentication methods will be retrieved
Request headers
Authorization Token
Responses
The request has succeeded
Body
The two-factor authentication method identifier
Defines the type of the user 2FA method
The two-factor authentication obfuscated value (applicable only for email and phone based methods)
GET https://sandbox.crm.com/backoffice/v2/users/2c317000-5d39-bec9-a1d3-037b9a17057e/two_factor_methods HTTP/1.1
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "zerd7b18-c4b1-c7d7-30ef-7e5a01c77cd0",
"method": "GOOGLE"
},
{
"id": "e44d7b18-c4b1-c7d7-30ef-7e5a01c77cf0",
"method": "EMAIL",
"value": "j_*****@crm.com"
}
]
}{id}/two_factor_methods/{method_id}/actionsPerform actions on a user’s newly added two-factor authentication method
Path variables
The user (identifier) whose two-factor authentication method will be updated
The two-factor authentication method that actions will be applied on
Request headers
Authorization Token
Request body
The action that will be applied on the two-factor authentication method
The 6-digit verification code (required for VERIFY action)
Responses
The request has succeeded
Body
The two-factor authentication method identifier
PUT https://sandbox.crm.com/backoffice/v2/users/993d849e-b5b0-be3e-1486-9334200757cd/two_factor_methods/0bb44610-f77c-85e0-f8a1-d35da22f5c78/actions HTTP/1.1
Content-Type: application/json
{
"action": "VERIFY",
"code": "123456"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "0bb44610-f77c-85e0-f8a1-d35da22f5c78"
}{id}/two_factor_methods/backupGenerate a new back-up code (unique 24-alphanumeric character code) as part of a user’s two-factor authentication method
Path variables
The user (identifier) for which a two-factor authentication backup code will be generated
Notes
Back-up code can be used for authentication purposes (sign-in) when user forgets all two-factor authentication methods does not have access to them
Request headers
Authorization Token
Responses
The request has succeeded
Body
The two-factor authentication back-up code
POST https://sandbox.crm.com/backoffice/v2/users/993d849e-b5b0-be3e-1486-9334200757cd/two_factor_methods HTTP/1.1
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
HTTP/1.1 200 OK
Content-Type: application/json
{
"backup_code": "1234567891234567891234"
}{id}/wallets{id}{id}/topup_settings{id}/limits{id}/limits{id}{id}/currencies{id}/commerce_balances{id}/statement{id}/statement_detailsRequest headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Responses
GET https://sandbox.crm.com/backoffice/v1/wallets/otp HTTP/1.1
Content-Type: application/json
{
"identity": {
"type": "PHONE",
"value": "some_email@email.com"
}
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"otp": ""
}{id}/walletsPath variables
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The Wallet’s code. If not specified, then a unique and random 16-digit code is assigned to the Wallet.
The Wallet’s identity which can either b the contact’s email or phone
Email address or phone number depending on the identity type
Responses
Body
The wallet’s identifier
POST https://sandbox.crm.com/backoffice/v2/contacts/{id}/wallets HTTP/1.1
Content-Type: application/json
{
"code": "994434532330012",
"currency_code": "EUR",
"otp": "",
"identity": {
"type": "EMAIL",
"value": "john.smith@email.com",
"country_code": "CYP"
}
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}{id}Retrieves detailed information of a single Wallet.
Path variables
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
GET https://sandbox.crm.com/backoffice/v1/wallets/{id} HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "",
"code": "",
"balances": [
{
"type": "BUSINESS",
"currency_code": "",
"total": 1,
"open": 1,
"commerce": 1
}
]
}{id}/topup_settingsRetireves the wallet’s Auto and Termed Top up settings, if any specified by the customer.
Path variables
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
GET https://sandbox.crm.com/backoffice/v1/wallets/{id}/topup_settings HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"auto_topup": {
"threshold": 0.01,
"amount": 10.5,
"currency_code": "EUR",
"payment _method": {
"type": "CARD",
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"identifier": "****1234"
}
},
"termed_topup": {
"amount": 10.5,
"currency_code": "",
"frequency": {
"period": "MONTHS",
"value": 1
},
"topup_day": {
"day_of_month": 1,
"day_of_week": "THURSDAY"
},
"payment_method": {
"type": "CARD",
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"identifier": "****1234"
}
}
}{id}/limitsPath variables
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
["DEBIT"]Responses
Body
PUT https://sandbox.crm.com/backoffice/v1/wallets/{id}/limits HTTP/1.1
Content-Type: application/json
{
"limit_rules": [
{
"name": "Monthly topups",
"maximum_number": 1,
"maximum_amount": 200,
"currency_code": "",
"period": "DAY",
"applies_for": [
"DEBIT"
]
}
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": ""
}{id}/limitsRetrieves the wallet’s limits
Path variables
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
["DEBIT"]GET https://sandbox.crm.com/backoffice/v1/wallets/{id}/limits HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"limit_rules": [
{
"id": "",
"name": "Monthly topups",
"maximum_number": 1,
"maximum_amount": 1,
"currency_code": "",
"period": "DAY",
"applies_for": [
"DEBIT"
]
}
]
}{id}Updates a single Wallet.
Path variables
The unique identifier of the Wallet to be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
["TOPUP"]Responses
Body
The unique identifier of the updated Wallet
PUT https://sandbox.crm.com/backoffice/v1/wallets/{id} HTTP/1.1
Content-Type: application/json
{
"auto_topup": {
"threshold": 0.01,
"amount": 10.5,
"payment_method": "CARD",
"payment_method_id": ""
},
"termed_topup": {
"amount": 10.5,
"frequency": {
"period": "MONTHS",
"value": 1
},
"topup_day": {
"day_of_month": 1,
"day_of_week": "MONDAY"
},
"payment_method": "CARD",
"payment_method_id": ""
},
"currencies": [
{
"currency_code": "EUR",
"is_primary": true
}
],
"limit_rules": [
{
"name": "VIP",
"maximum_amount": 9.99,
"maximum_number": 10,
"period": "ANNUAL",
"transaction_type": [
"TOPUP"
]
}
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "3ac0809f-ed91-4b68-b912-5bd6064d901e"
}{id}/currenciesPath variables
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Responses
Body
PUT https://sandbox.crm.com/backoffice/v1/wallets/{id}/currencies HTTP/1.1
Content-Type: application/json
{
"currencies": [
{
"currency_code": "EUR"
}
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": ""
}Returns a list of Wallets. Only Wallets related to the logged in user’s Business are returned per Web API call.
Request parameters
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
Wallet unique identifier
Wallet code. If not specified on creating the Wallet, the CRM.COM assigned a unique and random 16-digit code.
The owner of the Wallet
Contact identifier
Contact code
Contact full name
The wallet’s balances in the primary currency. When Web API is called by a user of a Business, then only that business balances are returned. Triggering the Web API by a Cloud user additionally returns the CRM balance.
Wallet balance type
Total wallet balance
Open Balance
Commece Balance. Not available for CRM Balance
The Business at which the contact has a business walet balance. Appicable only for Cloud users.
Organisation identifier
Organisation name
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/wallets HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"code": "7767654434909989",
"contact": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"code": "0012023444",
"name": "John Smith"
},
"balances": [
{
"type": "BUSINESS",
"total": 9.99,
"open": 1.55,
"commerce": 8.45,
"currency_code": "EUR",
"organisation": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "Good Burgers"
}
}
]
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}/commerce_balancesRetrieves a wallet’s business balance breakdown. The balance is returned per spend condition which credited the wallet’s business balance, along with the spend condition’s details
Path variables
The unique identification of the wallet whose balance spend conditions will be retrieved.
Request parameters
The id of a specific spend condition (optional). If not provided then all spend conditions are retrieved
If set to true, then the expiration information will also be retrieved
If not specified, then the balance breakdown of the wallet’s primary currency will be returned by default.
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
OK
Body
The commerce pool condition identifier
The name of the spend condition group
The amount that is allocated to the specified spend condition
The organisations where the amount can be spent at
The organisation identifier
The name of the organisation
The location of the organisation
Information about the organisation’s location
The name of the location
The address of the location
Additional address information about the location
The state/province/county of the location
The town/city of the location
The postal code of the location
The country code of the location
The latitude of the location
The longitude of the location
The Google textual identifier that uniquely identifies a location
The products that the amount can be spent for
The type of the ID to be provided
The ID of the product (based on the type provided)
The name of the product
The descrtipion of the product
The time when the amount can be spent
The month as a condition (1-12)
The day of the week as condition (1-7), 1 is Sunday
The start time of the day in 24 Hour format
The end time of the day in 24 Hour format
Defines the amounts expiring in periods. Available only if the parameter include_expiration is set to true
The amount that will expire in up to 30 days
The amount that will expire from 30 to 60 days
The amount that will expire from 60 to 90 days
The amount that will expire in more than 90 days
GET https://sandbox.crm.com/backoffice/v2/wallets/234fbc54-bc32-1990-ce59-76c45e6377a8/commerce_balances HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
[
{
"id": "234fbc54-bc32-1990-ce59-76c45e6377a8",
"name": "Happy Hour",
"amount": 100.5,
"curency_code": "",
"organisations": [
{
"id": "234fbc54-bc32-1990-ce59-76c45e6377a8",
"name": "Cafe",
"locations": [
{
"name": "Head Office",
"address_line_1": "Elia Papakyriakou 21",
"address_line_2": "7 Tower Stars",
"state_province_county": "Egkomi",
"town_city": "Nicosia",
"postal_code": "2415",
"country_code": "CY",
"lat": 35.157115,
"lon": 33.313719,
"google_place_id": "ChIJrTLr-GyuEmsRBfy61i59si0"
}
]
}
],
"products": [
{
"item_type": "PRODUCT",
"item_id": "234fbc54-bc32-1990-ce59-76c45e6377a8",
"name": "Coffee",
"description": "Brazilian Coffee"
}
],
"timings": [
{
"month": 1,
"day": 1,
"start_time": "19:00",
"end_time": "21:00"
}
],
"expiration": {
"zero_to_thirty": 50.5,
"thirty_to_sixty": 50.5,
"sixty_to_ninety": 50.5,
"ninety_plus": 50.5
}
}
]Creates a Wallet Journal Entry that either debits or credits the wallet. A single journal entry is created per Web API call.
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The unique identifier for which the journal entry will be created
The amount of the journal
If not specified, then the wallet’s primary currency is used to log the journal entry
The description of the journal
The type of the journal
The unique identifier of the related spend condition. If specified, then the journal entry’s amount is move to the wallet’s business balance
The valid from date
The valid to date
The date and time when the journal actually created
Allows a wallet debit journal to take the wallet balance below zero. By default, the wallet balance cannot go below zero.
Responses
OK
Body
The wallet journal identifier
POST https://devapi.crm.com/backoffice/v1/journals HTTP/1.1
Content-Type: application/json
{
"wallet_id": "4AD9C84FA60F9FE407140E20F707726A",
"amount": 10,
"type": "DEBIT",
"description": "Credit adjustment by 10 EUR",
"spend_condition_id": "4AD9C84FA60F9FE407140E20F707726A",
"valid_from": 1587988965,
"valid_to": 1587988965,
"created_on": 1588081851
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "CAD1E31269B76D7A65ACCE45B2E68DFD"
}{id}/statementReturns the wallet’s statement for a period of time.
Path variables
Request parameters
The date as of which the statement wll be produced
If not specified, then the wallet’s statement is produced for all of its supported currencies
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
GET https://sandbox.crm.com/backoffice/v1/wallets/{id}/statement?currency_code=EUR HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "",
"from_date": 1635324134,
"to_date": 1635324134,
"currency_code": "EUR",
"opening_balances": [
{
"type": "BUSINESS",
"total": 0.03,
"open": 0.01,
"commerce": 0.02
}
]
}{id}/statement_detailsReturns the wallet’s statement that ncludes a list of wallet jounals performed within a period of time
Path variables
Request parameters
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
If not specified, then the statement is produced based on the wallet’s primary currency
The date as of which the statement will be produced
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v1/wallets/{id}/statement_details HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "",
"date": 312321312312,
"amount": 0.01,
"currency_code": "EUR",
"type": "DEBIT",
"activity": {
"type": "PURCHASE",
"id": "",
"reference": "P0123922"
}
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}/payment_methods/{payment_method_id}{id}/payment_methods{id}/payment_methods/{payment_method_id}{id}/payment_methods/{payment_method_id}Update a payment method for the wallet
Path variables
The payment method id that will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Notes related to te payment method
The bank details.Required and applicable if the payment method is set to BANK
The bank account number.
The IBAN code.
The name of the customer’s bank
Institution number of the customer’s bank.
The identifier of the bank branch
The bank account swift number
The sort code
The mandate (sequence) type
The type of the event
The payment gateway’s integration identifier
The country the bank account is located in.
Responses
Body
The unique identifier of the updated payment method
PUT https://sandbox.crm.com/backoffice/v1/wallets/payment_methods/{id} HTTP/1.1
Content-Type: application/json
{
"name": "",
"notes": "",
"account_debit": {
"account_name": "",
"account_number": "001002001",
"iban": "0143240434320434",
"bank": "Barclays",
"bank_code": "0032933-1123",
"branch": "Ascot",
"swift": "12345678",
"sort_code": "20-02-53",
"mandate": {
"reference": "",
"sign_date": 1
},
"account_type": "SAVINGS",
"integration_id": ""
}
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}{id}/payment_methodsList of Payment methods allocated to the wallet
Path variables
The wallet identifier for which the payment methods will be retrieved
Request parameters
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Filters the contact’s payment methods based on type
Credit/Debit/Prepaid cards
Wallet related to either a card, bank account or has a monetary value
Collect money directly from an account
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The payment method identifier
The type of the event
Credit/Debit/Prepaid cards
Wallet related to either a card, bank account or has a monetary value
Collect money directly from an account
The card’s main information. Required and applicable if the payment method type is CARD
The card’s name
The card’s brand
The type of the event
The first 6 digits of the card. Either the card number or the first 6 and last 4 digits must be specified
The last 4 digits f the card. Either the card number or the first 6 and last 4 digits must be specified
The card expiration month
The card expiration year
The card issue country (3 char country code)
Information about the card holder
The name of the card holder
The address related to the card
Additional address information related to the card
The city related to the card
The zip code related to the card
The state related to the card
The country related to the card
The bank details.Required and applicable if the payment method is set to BANK
The bank account number.
The IBAN code.
The name of the customer’s bank
Institution number of the customer’s bank.
The identifier of the bank branch
The bank account swift number
The sort code
The country the bank account is located in.
The type of the event
The mandate (sequence) type
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v1/wallets/CAD1E31269B76D7A65ACCE45B2E68DFD/payment_methods HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "CAD1E31269B76D7A65ACCE45B2E68DFD",
"name": "",
"payment_method_type": "CARD",
"card": {
"name": "Default Card",
"brand": "VISA",
"funding_type": "CREDIT",
"first6": "",
"last4": "",
"expiration_month": 1,
"expiration_year": 2020,
"country_of_issue": "CYP",
"cvc": "",
"card_holder_details": {
"card_holder_name": "John Doe",
"address_line_1": "Elia Papakyriakou",
"address_line_2": "7 Tower Star",
"address_city": "Nicosia",
"address_zip": "2415",
"address_state": "Nicosia",
"address_country": "CYP"
},
"gateway_token": [
{
"token": "",
"gateway": "JCC_MERCHANT",
"integration": {
"id": "",
"name": ""
}
}
]
},
"account_debit": {
"account_name": "",
"account_number": "001002001",
"iban": "0143240434320434",
"bank": "Barclays",
"bank_code": "0032933-1123",
"branch": "Ascot",
"swift": "12345678",
"sort_code": "20-02-53",
"account_type": "SAVINGS",
"mandate": {
"reference": "",
"sign_date": 1
},
"gateway_token": [
{
"token": "",
"gateway": "JCC",
"integration": {
"id": "",
"name": ""
}
}
]
}
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}/payment_methods/{payment_method_id}Deletes a payment method for the wallet
Path variables
The id of the contact
The id of the payment method.
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
DELETE https://sandbox.crm.com/backoffice/v1/contacts/JGKDJHAK76786JUGJHDG/payment_methods/SHDGJKSHDJKHS86876HGFHDGSFHSF HTTP/1.1
HTTP/1.1 204 No Content Retrieve Account Settings
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Successful Request
Body
Shows how the account name will be automatically set
Account name is the same as the account number
Account name is set as the account’s numer and the contact’s name
The allocation principle applied on crediting an account
First-In-First-Out. Credit transactions allocated to the oldest unallocated debit
Credit transaction allocated against specified debit transaction and if there’s remaining amount, then this is allocated based on FIFO
Settings related to how accounting periods are managed
Accounting period closes automatically X months after its end date
Account Credit Terms that include default Credit Limit and Payment Terms
The default Credit Limit that a contact will be assigned when creating a new Account. Defined in the business’s base currency
Payment Terms define when debit trasnactions will be due.
Payment terms unique identifier
Label of Payment Terms
Number of days within which an Invoice is due to be paid
Conditional Credit Terms. If specified, then an account’s credit limit and/or Payment Terms will be differentiated compared to the default rules. Conditional rules are applied based on the account owner’s classification.
Conditional term rule identifier
Conditional term rule name
Credit limit to be applied on account owners with the related classiciation
Payment Terms to be applied on account owners with the related classification
Payment terms identifier
Payment terms label
Number of days within which an Invoice is due to be paid
The account classificationa that meet the conditions in orer to apply the conditional credit terms. Each classification is specified once per conditioal credit terms rules
Account Classification identifier
Account Classification name
Numbering schemes used for Accounts, Invoices and Credit Notes
The type of the event
The entity for which the numbering scheme is configured
The prefix of the numbering scheme. Defaults to the first letter(s) of the entity’s name
The starting number of the nuberig scheme (excluding prefix). Defaults to 10001
Number of digits (excluding prefix). Defaults to 5
The last number generated for this numbering scheme
GET https://sandbox.crm.com/backoffice/v2/accounts/settings HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"name_settings": "NUMBER",
"allocation_settings": "FIFO",
"accounting_period_settings": {
"close_months_before": 1
},
"credit_terms_settings": {
"credit_limit": 9.99,
"currency_code": "EUR",
"payment_terms": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"label": "Net 7",
"net_term_days": 7
},
"conditional_terms": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "VIP account owners credit terms",
"credit_limit": 8.99,
"payment_terms": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"label": "Net 7",
"net_term_days": 7
},
"account_classifications": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "VIP"
}
]
}
]
},
"numbering_schemes": [
{
"entity": "SERVICE_REQUESTS",
"prefix": "SR",
"starting_number": "0000001",
"number_of_digits": "7",
"last_number": "SR000001"
}
]
}Update the generic account settings
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Shows how the account name will be automatically set
Account name is the same as the account number
Account name is the same as the account number and contact’s name
The allocation principle applied on crediting an account
First-In-First-Out. Credit transactions allocated to the oldest unallocated debit
Credit transaction allocated against specified debit transaction and if there’s remaining amount, then this is allocated based on FIFO
Settings related to how accounting periods are managed
Accounting period closes automatically X months after its end date
Account Credit Terms that include default Credit Limit and Payment Terms
The default Credit Limit that a contact will be assigned when creating a new Account. Defined in the business’s base currency. The Credit Limits defines the maximum allowed balance per account. This limit is never exceeded.
Payment Terms define when debit trasnactions will be due.
Conditional Credit Terms. If specified, then an account’s credit limit and/or Payment Terms will be differentiated compared to the default rules. Conditional rules are applied based on the account owner’s classification. Credit term rules specified in base currency of the business.
Conditional terms rule name. Has to be unique across rule names
Credit limit to be applied on account owners with the related classiciation.
Payment Terms to be applied on account owners with the related classiciation
Account classifications for which the conditional terms apply. At least one must be specified. Each classification is specified once per conditioal credit terms rules
The classification’s ientifier
Numbering schemes used for Accounts, Invoices and Credit Notes
The entity for whichthe numberig scheme is specified
The numbering scheme’s prefix. “A” for Accounts, “I” for Invoices ad “CR” for Credit Notes
Number of dgitis following the scheme’s Prefix
Starting number of the scheme.
Responses
Successful Request
Body
Unique identifier of Account Settings
PUT https://sandbox.crm.com/backoffice/v2/accounts/settings HTTP/1.1
Content-Type: application/json
{
"name_settings": "NUMBER",
"allocation_settings": "FIFO",
"accounting_period_settings": {
"close_months_before": 3
},
"credit_terms_settings": {
"credit_limit": 9.99,
"payment_terms_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"conditional_terms": [
{
"name": "VIP credit terms",
"credit_limit": 8.99,
"payment_terms_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"account_classifications": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}
]
}
]
},
"numbering_schemes": [
{
"entity": "ACCOUNTS",
"prefix": "",
"number_of_digits": 5,
"starting_number": "00001"
}
]
}Retrieve the Accounting Periods
Request parameters
Defines on which attribute the results should be sorted
The page number that should be retrieved
The size (total records) of each page
Defines how the results will be ordered
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Successful Request
Body
The unique identifier of the accounting period
The name of the accounting period (month and year)
A unique number fo the accounting period (month and year)
Defines whether the accounting period is open or closed. A single accounting period can be set as Open over time
The first day of the accounting period
The last day of the accounting period
The date on which the accounting period was closed
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/accounting_periods HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "8d734d8b-abef-4e06-a6cf-d3efd5496590",
"name": "MARCH2022",
"number": "032022",
"state": "OPEN",
"from_date": 1646092800,
"to_date": 1648771199,
"closed_date": 1648771199
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}{id}Creates a new account classification. Each classification must have a unique name
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The name of the classification to be created. The nae of the classification must be unique
Determines whether it’s the default classification
Responses
Successful Request
Body
The unique identifier of the classification
POST https://sandbox.crm.com/backoffice/v2/accounts/classifications HTTP/1.1
Content-Type: application/json
{
"name": "VIP",
"is_default": "true"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}{id}Update a specific account classification
Path variables
The account classification identifier that will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The name of the classification which must be unique across the lis tof account classifications
Determines whether it’s the default classification
Responses
Successful Request
Body
The unique identifier of the account classification
PUT https://sandbox.crm.com/backoffice/v2/accounts/classifications/CAD1E31269B76D7A65ACCE45B2E68DFD HTTP/1.1
Content-Type: application/json
{
"name": "VIP",
"is_default": "true"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}{id}Delete a specific account classification
Path variables
The account classification identifier that will be deleted
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Responses
Successful Request
DELETE https://sandbox.crm.com/backoffice/v2/accounts/classifications/4dc0809f-ed91-4b68-b912-5bd6064d901e HTTP/1.1
Content-Type: application/json
HTTP/1.1 204 No Content List all the available account classifications
Request parameters
Defines on which attribute the results should be sorted
The page number that should be retrieved
The size (total records) of each page
Defines how the results will be ordered
The name of the account classification
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Successful Request
Body
The account lassification’s unique identifier
The name of the account classification
Marks the default account classification.
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/accounts/classifications HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "7b3a5787-1f0f-4062-b373-df2ecf943658",
"name": "Normal",
"is_default": true
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}List all the available Payment Terms
Request parameters
Defines on which attribute the results should be sorted
The page number that should be retrieved
The size (total records) of each page
Defines how the results will be ordered
The name of the Payment Term
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Successful Request
Body
Payment Terms unique identifier
Payment Terms name
The payment terms number of days, i.e. the credit period’s duration
Marks the default payment terms
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v1/payment_terms HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "Net 7",
"net_term_days": 7,
"is_default": "true"
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}Updates the set of available Payment Terms.
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The unique identifier of the payment term to be updated
Payment terms name. If not specified, then the name is automaticalyl set as “Net” plus the number of payment terms days
Payment mterms days
Responses
Successful Request
Body
The unique identifier account settings
PUT https://sandbox.crm.com/backoffice/v1/payment_terms/ HTTP/1.1
Content-Type: application/json
{
"content": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "Net 7",
"net_term_days": 7
}
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "4AD9C84FA60F9FE407140E20F707726A"
}{id}{id}{id}Create an activity type
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The activity type (unique) name
The activity type description
The activity type (unique) color that will be used for visual identification
Examples
Responses
The request has succeeded
Body
The activity type identifier
POST https://sandbox.crm.com/backoffice/v2/activities/types HTTP/1.1
Content-Type: application/json
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
{
"name": "Installations",
"description": "A contact requires an installation of some sorts.",
"color": "FAC9990"
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "abcfd606-3a2c-2cb2-5650-d0d3fc8ba893"
}{id}Update an existing activity type
Path variables
The activity type (identifier) that will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The activity type (unique) name
The type of the activity
The activity type description
The activity type (unique) color that will be used for visual identification
Examples
Responses
The request has succeeded
Body
The activity type identifier
PUT https://sandbox.crm.com/backoffice/v2/activities/types/abcfd606-3a2c-2cb2-5650-d0d3fc8ba893 HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"name": "Installations",
"state": "Active",
"description": "A customer requires an installation of some sorts.",
"color": "FAC9990",
"owner": [
{
"user id": "4KHSKUFGKNS8369874KJGJKS",
"name": "John Smith"
}
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "abcfd606-3a2c-2cb2-5650-d0d3fc8ba893"
}{id}Delete an existing activity type
Path variables
The activity type (identifier) that will be deleted
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
DELETE https://sandbox.crm.com/backoffice/v2/activities/types/abcfd606-3a2c-2cb2-5650-d0d3fc8ba893 HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 204 No Content Retrieve a list of activity types based on search criteria (e.g. all active activity types)
Request parameters
Filter based on name (behave as like)
Filter based on activity type state
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The activity type identifier
The activity type (unique) name
The activity type description
The activity type (unique) color that will be used for visual identification
The activity type state
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/activity_types HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "74D9C84FA60F9FE407140E20F707726A",
"name": "Billing Issues",
"description": "The user requires installation of some type.",
"color": "F56CSD",
"state": "Active"
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Retrieve detailed information for an activity type
Path variables
The activity type (identifier) that will be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The activity type identifier
The activity type name
The type of the activity
The activity type description
The activity type (unique) color that will be used for visual identification
GET https://sandbox.crm.com/backoffice/v2/activities/types/45930303-926d-a7d2-3dcd-174a32580323 HTTP/1.1
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "45930303-926d-a7d2-3dcd-174a32580323",
"name": "Installation",
"state": "ACTIVE",
"description": "The user requires an installation of some sorts.",
"color": "TRD45F"
}Retrieve business network settings
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
Defines which organisation types will consist the business network
Merchants & Venues will be supported
Service Providers & Service Points will be supported
GET https://sandbox.crm.com/backoffice/v2/business_network/settings HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"model": "SERVICE_PROVIDER_POINT"
}Update the generic business network settings
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Defines which organisation types will consist the business network
Merchants & Venues will be supported
Service Providers & Service Points will be supported
Responses
The request has succeeded
Body
The organisation identifier
PUT https://sandbox.crm.com/backoffice/v2/business_network_settings HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"model": "MERCHANT_VENUE"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "55b2ac29-f2b1-396f-75f8-f4418ae5f983"
}Update the community commerce settings (e.g. B2B Settlement)
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Details about settlement settings (required if settlement is enabled)
Defines whether settlement is enabled or not
Defines when settlement will take place
The repeat frequency provided as a cron expression pattern
Details about the settlement fee(s) that will be applied on award and/or spend transactions (applicable only if settlement is enabled)
Defines whether settlement fees will be applied or not
Defines whether the related type will be amount or percentage based
Defines the default fee on award that will be applied on all organisations (merchants/service providers)
Defines the default fee on spend that will be applied on all organisations (merchants/service providers)
Defines the fees that will be applied explicitly on specific organisations (merchants/service providers)
Defines the entity type that fees will be explicitly applied
Defines the entity identifier that fees will be explicitly applied
The explicit award fee
The explicit spend fee
Defines the settlement rules that will be applied during settlement (e.g. financial transaction types)
Defines the financial transaction types that will be used when posting a payment/payout during settlement
The payment type identifier that will be used. If not specified, then the default type will be used
The payout type identifier that will be used. If not specified, then the default type will be used
Defines the min/max amount that can be settled against an organisation account
The min amount that can be settled against an organisation account
The max amount that can be settled against an organisation account
Responses
The request has succeeded
Body
The organisation identifier
PUT https://sandbox.crm.com/backoffice/v1/community_commerce HTTP/1.1
Content-Type: application/json
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
{
"settlement_settings": {
"enable_settlement": "false",
"settlement_evaluation": "DAILY",
"frequency": "0 0 12 * * ?"
},
"settlement_fees": {
"enable_settlement_fees": "true",
"fee_type": "AMOUNT",
"default_award_fee": 1.99,
"default_spend-fee": 2.91,
"explicit_fees": [
{
"entity_type": "ORGANISATION",
"entity_id": "3a4ff705-356d-16e4-d5f7-dd5e7c3c29d5",
"award_fee": 5.91,
"spend_fee": 1.99
}
]
}
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "a331211c-7a48-c107-096e-870a574f0e85"
}Retrieve the community commerce settings (e.g. B2B Settlement)
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
Details about settlement settings
Defines whether settlement is enabled or not
Defines when settlement will take place
The repeat frequency provided as a cron expression pattern
Details about the settlement fee(s) that will be applied on award and/or spend transactions (applicable only if settlement is enabled)
Defines whether settlement fees will be applied or not
Defines whether the related type will be amount or percentage based
Defines the default fee on award that will be applied on all organisations (merchants/service providers)
Defines the default fee on spend that will be applied on all organisations (merchants/service providers)
Defines the fees that will be applied explicitly on specific organisations (merchants/service providers)
Defines the entity type that fees will be explicitly applied
Defines the entity that fees will be explicitly applied
Defines the entity (identifier) that fees will be explicitly applied
Defines the entity (name) that fees will be explicitly applied
Defines the entity (identifier) that fees will be explicitly applied
The explicit award fee
The explicit award fee
Defines the settlement rules that will be applied during settlement (e.g. financial transaction types)
Defines the financial transaction types that will be used when posting a payment/payout during settlement
Details about the payment type that should be used for settlement
The payment type identifier
The payment type name
Details about the payout type that should be used for settlement
The payout identifier
The payout name
Defines the min/max amount that can be settled against an organisation account
The min amount that can be settled against an organisation account
The max amount that can be settled against an organisation account
GET https://sandbox.crm.com/backoffice/v1/community_commerce HTTP/1.1
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
HTTP/1.1 200 OK
Content-Type: application/json
{
"settlement_settings": {
"enable_settlement": "true",
"settlement_evaluation": "DAILY",
"frequency": "0 0 12 * * ?"
},
"settlement_fees": {
"enable_settlement_fees": "true",
"fee_type": "AMOUNT",
"default_award_fee": 1.98,
"default_spend_fee": 9.99,
"explicit_fees": [
{
"entity_type": "ORGANISATION",
"entity": {
"id": "4c6a4cbb-7b47-b360-0654-e50cb52bd891",
"name": "Nice Restaurant"
},
"entity_id": "3a4ff705-356d-16e4-d5f7-dd5e7c3c29d5",
"award_fee": 5.91,
"spend_fee": 1.99
}
]
}
}Retrieve the settlement transactions related to B2B Settlement
Request parameters
Filter based on the settlement transaction type
Award Transaction
Spend Transaction
Award Settlement Fee
Spend Settlement Fee
Filter based on the accounting transaction type
Filter based on settlement transaction state
Filters based on the organisation (identifier) that the settlement transaction is posted against
Filter based on the created date, which may fall within a given date range. The value can be a string with a date in epoch format. Each option must also include an operator. Use up to two options based on the required search (e.g. created_on[gte]=1618395497&created_on[lt]=1618395497).
Returns results where the created date is greater than this value
Returns results where the created date is greater than or equal to this value
Returns results where the created date is less than this value
Returns results where the created date is less then or equal to this value
Filter based on an account journal entry
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The settlement transaction identifier
Defines the settlement transaction type
Award Transaction
Spend Transaction
Award Settlement Fee
Spend Settlement Fee
Defines the accounting type of the settlement transaction
The settlement transaction status
The initial amount to be settled (before applying the applicable contribution/settlement fee)
The amount to be settled (after contribution/settlement fee is applied)
The contribution/settlement fee that was applied on the settlement transaction
Defines the fee type
Contribution fee, applied on award transactions
Settlement fee, applied on award/spend transactions
Defines whether the fee is amount or percentage based
Fee will be amount based
Fee will be percentage based
The fee value
The organisation that the settlement transaction is posted against
The organisation type
The organisation identifier
The organisation name
Details about the event that initiated such settlement request
Defines the type of the event that is related to the settlement transaction
The event identifier
The event reference number/code (if applicable)
The event amount
The date on which the event was posted
Details about the reward offer (related to the award type)
The reward offer identifier
The reward offer name
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/settlement_transactions HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "daf23f03-e267-fe94-9965-5c81e9ab4a4d",
"settlement_type": "AWARD",
"accounting_type": "CREDIT",
"state": "POSTED",
"event_amount": 2.22,
"settlement_amount": 20.12,
"fee": {
"fee_type": "CONTRIBUTION",
"value_type": "AMOUNT",
"value": 2.84
},
"organisation": {
"type": "MERCHANT",
"id": "f2c2d9ea-5a94-729d-0c45-7fdd1d540e7b",
"name": "CRM"
},
"settlement_event": {
"type": "PURCHASE",
"id": "598c02d3-1978-3585-3a3b-2311d6c94d1c",
"reference_number": "2833205645375343",
"amount": 102.79,
"posted_date": 1635170879
},
"reward_offer": {
"id": "1b5f5824-e05f-bb8e-d2ee-19eb5ed83240",
"name": "10% instant discount"
}
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}{id}{id}Create an organisation group
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The organisation group name
The organisation group description
Responses
The request has succeded
Body
The organisation group identifier
POST https://sandbox.crm.com/backoffice/v2/organisations/groups HTTP/1.1
Content-Type: application/json
{
"name": "Seasonal",
"description": "Lorem Ipsum"
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "f68f4851-b02b-6eee-e0e7-d80f4a2dc8bd"
}{id}Update an existing organisation group
Path variables
The organisation group (identifier) that will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The organisation group name
The organisation group description
Responses
The request has succeded
Body
The organisation group identifier
PUT https://sandbox.crm.com/backoffice/v2/organisations/groups/867a46bd-bd1f-4312-073d-134ef2b98249 HTTP/1.1
Content-Type: application/json
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
{
"name": "Seasonal",
"description": "Lorem Ipsum"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "867a46bd-bd1f-4312-073d-134ef2b98249"
}{id}Delete an existing organisation group
Path variables
The organisation group (identifier) that will be deleted
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
DELETE https://sandbox.crm.com/backoffice/v2/organisations/groups/f477a0d2-eb40-0e77-d3db-7ca729d04a5f HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 204 No Content Retrieve a list of organisation groups based on search criteria (e.g. all groups)
Request parameters
Filter based on the organisation group name
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeded
Body
Information about the organisation groups
The organisation group identifier
The organisation group name
The organisation group description
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/organisations/groups HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "b97b6dba-e118-12ca-d4a5-d17e8f897f2f",
"name": "Nicosia Dinners",
"description": "Lorem Ipsum"
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Retrieve detailed infromation for an organisation group
Path variables
The organisation group (identifier) that will be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeded
Body
The organisation group identifier
The organisation group name
The organisation group description
GET https://sandbox.crm.com/backoffice/v2/organisations/groups/9216e37e-f0d7-2ee7-7377-0cc66e134366 HTTP/1.1
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "9216e37e-f0d7-2ee7-7377-0cc66e134366",
"name": "Seasonal",
"description": "Lorem Ipsum"
}Updates the tracking settings of communications
Request headers
Authorization Token
The public api key required for API calls to identify the organisation
Request body
Enables the tracking functionality
Responses
PUT https://devapi.crm.com/backoffice/v1/tracking_settings HTTP/1.1
api_key: 8c54d563-b991-4b76-8a83-557c08166f95
Content-Type: application/json
{
"enable_tracking": true,
"track_end_point": "",
"track_custom_url": "",
"email_tracking_mode": "ALL",
"link_tracking_mode": "ALL"
}
HTTP/1.1 200 OK Retrieves the tracking settings for communications
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
Enables the tracking functionality
GET https://devapi.crm.com/backoffice/v1/tracking_settings HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"enable_tracking": true,
"track_end_point": "",
"track_custom_url": "",
"email_tracking_mode": "ALL",
"link_tracking_mode": "COMM_PLANS"
}Returns the general system settings for contacts
Responses
The request has succeeded
Body
Name display setting defining how the contact name is presented throughout the software
first name, last name
last name, first name
first name, middle name, last name
last name, middle name, first name
Contact Identification Medium (CIM) settings, how the contact is uniquely identified throughout the system
Medium type
card number
phone number
email address
gift pass code
Is the cim setting enabled? i.e. in use?
Contact Identities settings, applying additional security precautions
Defines whether credentials (username&password) will require verification or not
GET https://sandbox.crm.com/backoffice/v2/contact_generic_settings HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"name_display_settings": "FIRST_LAST",
"cim_settings": [
{
"medium": "PHONE",
"is_enabled": true
}
]
}Update the generic contact system settings
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
This setting defines how contact names will appear throughout the system
first name, last name
last name, first name
first name, middle name, last name
last name, middle name, first name
Contact Identification Medium (CIM) settings, how the contact is uniquely identified throughout the system
Medium type
card number
phone number
email address
gift pass code
Is the cim setting enabled? i.e. in use?
Contact Identities settings, applying additional security precautions
Defines whether credentials (username&password) will require verification or not
Responses
Successful Request
Body
The unique identifier of the organisation
PUT https://sandbox.crm.com/backoffice/v2/contact_generic_settings HTTP/1.1
Content-Type: application/json
{
"name_display_settings": "FIRST_LAST",
"cim_settings": [
{
"medium": "PHONE",
"is_enabled": true
}
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": ""
}{id}{id}Create a contact category definition
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The name of the category to be created
Responses
Successful Request
Body
The unique identifier of the category
POST https://sandbox.crm.com/backoffice/v2/contact_categories HTTP/1.1
Content-Type: application/json
{
"name": "VIP"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "473539a2-1cb9-4674-9260-d68d3d639b5c"
}{id}Update a specific contact category
Path variables
The contact category identifier to be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The new category name
Responses
Successful Request
Body
The unique id of the updated contact category
PUT https://sandbox.crm.com/backoffice/v2/contact_categories/473539a2-1cb9-4674-9260-d68d3d639b5c HTTP/1.1
Content-Type: application/json
{
"name": "VIP"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "473539a2-1cb9-4674-9260-d68d3d639b5c"
}{id}Delete a specific contact category
Path variables
The contact category identifier to be deleted
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Responses
Successful Request
DELETE https://sandbox.crm.com/backoffice/v2/contact_categories/473539a2-1cb9-4674-9260-d68d3d639b5c HTTP/1.1
Content-Type: application/json
HTTP/1.1 200 OK List all the available contact categories
Request parameters
Defines on which attribute the results should be sorted
The page number that should be retrieved
The size (total records) of each page
Defines how the results will be ordered
The name of the contact category
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Successful Request
Body
Contact categories retrieved
The unique id of the contact category
The contact category name
GET https://sandbox.crm.com/backoffice/v2/contact_categories HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "473539a2-1cb9-4674-9260-d68d3d639b5c",
"name": "VIP"
}
]
}{id}{id}Create a name day rule
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The day of the name day (1-31)
The month of the name day (1-12)
A comma separated list of names that celebrate on the specific day
A description of the name day
Responses
Successful Request
Body
The unique identifier of the name day rule created
POST https://sandbox.crm.com/backoffice/v2/name_day_rules HTTP/1.1
Content-Type: application/json
{
"day": 15,
"month": 8,
"names": "Mario, Maria, Panayiota",
"description": "Assumption of the Virgin Mary"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "e18ee2bc-c6f3-49e1-8e05-763386378017"
}{id}Update a single name day rule
Path variables
Unique id of the name day to be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The day of the name day (1-31)
The month of the name day (1-12)
A comma separated list of names that celebrate on the specific day
A description of the name day
Responses
Successful Request
Body
The unique identifier of the name day rule updated
PUT https://sandbox.crm.com/backoffice/v2/name_day_rules/78b79217-0c14-4285-9c7b-e1701d31f18c HTTP/1.1
Content-Type: application/json
{
"day": 15,
"month": 8,
"names": "Mario, Maria, Panayiota",
"description": "Assumption of the Virgin Mary"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "78b79217-0c14-4285-9c7b-e1701d31f18c"
}Retrieve all the name day rules
Request parameters
Filter using one of the name day ‘names’
Defines on which attribute the results should be sorted
The page number that should be retrieved
The size (total records) of each page
Defines how the results will be ordered
Filter using a specific day to list names related to the chosen day
Filter using a specific month to list names related to the chosen month
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Successful Request
Body
The unique identification of the name day rule
The day of the name day
The month of the name day
A comma separated list of names celebrating on this day
A description of the name day
GET https://sandbox.crm.com/backoffice/v2/name_day_rules?name=Mario HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "78b79217-0c14-4285-9c7b-e1701d31f18c",
"day": 15,
"month": 8,
"names": "Mario, Maria, Panayiota",
"description": "Assumption of the Virgin Mary"
}
]
}{id}Delete a single name day rule
Path variables
Unique name day rule id to be deleted
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Successful Request
Body
The unique identifier of the deleted name day rule
DELETE https://sandbox.crm.com/backoffice/v2/name_day_rule/78b79217-0c14-4285-9c7b-e1701d31f18c HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "78b79217-0c14-4285-9c7b-e1701d31f18c"
}{id}{id}Create a new contact community relation
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The contact community type relation
Responses
The request has succeeded
Body
The contact community relation identifier
POST https://sandbox.crm.com/backoffice/v2/communities/relations HTTP/1.1
Content-Type: application/json
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
{
"name": "Employees"
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "01bdde91-ba65-dcb1-02c2-131c641ea8da"
}{id}Update an existing contact community relation
Path variables
The contact community relation (identifier) that will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The contact community type relations
Responses
The request has succeeded
Body
The contact community relation identifier
PUT https://sandbox.crm.com/backoffice/v2/communities/relations/01bdde91-ba65-dcb1-02c2-131c641ea8da HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
Content-Type: application/json
{
"name": "Employees"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "01bdde91-ba65-dcb1-02c2-131c641ea8da"
}{id}Delete an existing contact community relation
Path variables
The contact community relation (identifer) that will be deleted
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
DELETE https://sandbox.crm.com/backoffice/v2/communities/relations/01bdde91-ba65-dcb1-02c2-131c641ea8da HTTP/1.1
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
HTTP/1.1 204 No Content Retrieve a list of contact community relations based on search criteria (e.g. all contact community relations)
Request parameters
Filter based on contact community relation name (behave as like)
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The contact community relation identifier
The contact community relation name
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/communities/relations HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "01bdde91-ba65-dcb1-02c2-131c641ea8da",
"name": "Employees"
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}Retrieve the customer event settings
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
Information about handling invalid product information on purchase customer events
The product type identifier that will be used when creating invalid products from purchase customer events
GET /customer_event_generic_settings HTTP/1.1
authorization: 4AD9C84FA60F9FE407140E20F707726A
HTTP/1.1 200 OK
Content-Type: application/json
{
"purchase_settings": {
"invalid_product_type_id": "QWERTY1234543212345678UJIKY76HJR"
}
}Set the customer event settings
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Information about handling invalid product information on purchase customer events
The product type identifier that will be used when creating invalid products from purchase customer events
Responses
The request has succeeded
Body
The organisation identifier
PUT /customer_event_generic_settings HTTP/1.1
Content-Type: application/json
authorization: 4AD9C84FA60F9FE407140E20F707726A
{
"purchase_settings": {
"invalid_product_type_id": "QWERTY1234543212345678UJIKY76HJR"
}
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "QWERTY1234543212345678UJIKY76HJR"
}{id}{id}{id}Create a customer event classification
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The classification name
The classification description
The classification type
Responses
The request has succeeded
Body
The classification identifier
POST https://sandbox.crm.com/backoffice/v2/customer_event_classifications HTTP/1.1
Content-Type: application/json
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
{
"name": "Cash",
"description": "Cash driven customer event",
"type": "PURCHASE"
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "df843f9e-a263-4ed3-e4ea-5678266bd465"
}{id}Update a customer event classification
Path variables
The classification (identifier) that will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The name of the classification
The description of the classification
Responses
The request has succeeded
Body
The classification identifier
PUT https://sandbox.crm.com/backoffice/v2/customer_events/classifications/08ad0805-6059-b0d0-b253-e4fcc8cb4bd0 HTTP/1.1
Content-Type: application/json
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
{
"name": "Cash",
"description": "Represent cash driven customer events"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "08ad0805-6059-b0d0-b253-e4fcc8cb4bd0"
}{id}Delete a customer event classification
Path variables
The classification (identifier) that will be deleted
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
DELETE https://sandbox.crm.com/backoffice/v2/customer_events/classifications/ba702382-ad09-8bbe-e661-97bdb838cdad HTTP/1.1
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
HTTP/1.1 204 No Content Retrieve a list of customer event classifications based on search criteria (e.g. all purchase classifications)
Request parameters
Filter based on classification name
Filter based on classification type
Defines on which attribute the results should be sorted
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The classification identifier
The classification name
The classification description
The classification type
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/customer_events/classifications HTTP/1.1
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "08ad0805-6059-b0d0-b253-e4fcc8cb4bd0",
"name": "Cash",
"description": "Cash driven customer event",
"type": "ACHIEVEMENT"
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Retrieve detailed information for a customer event classification
Path variables
The classification (identifier) that will be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The classification identifier
The classification name
The classification description
The classification type
GET https://sandbox.crm.com/backoffice/v2/customer_events/classifications/08ad0805-6059-b0d0-b253-e4fcc8cb4bd0 HTTP/1.1
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "08ad0805-6059-b0d0-b253-e4fcc8cb4bd0",
"name": "Cash",
"description": "Cash driven customer event",
"type": "PURCHASE"
}Get the generic financial settings
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Successful Request
Body
The default tax model that is automatically set when setting up product prices
Prices include taxes
Prices does not include tax
Business rules that enable a payment retry attempt on failing to pay off an invoice or a subscription
Enable payment retries
How often an attempt will be perfomed right after a payment failure
The frequency value
The frequency’s unit of time
How many payment attempts will be performed
The maximum period of time that the system will retry. A payment retry will not be performed if maximum period of time is reached ad regardless of the fact that not all retries were perforemd.
The period of time
Period of time unit of time
Defines what happens to the subscription if all payment retries fail
The allowed payment method types that can be used across the system
The type of the event
Defines whether the payment method type is allowed or not. Not allowed types canno tbe used when adding contac tpayment methods, posting payments etc
Defines how automated payments are managed when using an online contact payment method.
Defaults to Invoiced Amount. On using an online payment method, the invoicing process will collect the appropriate amount on automated payments.
GET https://sandbox.crm.com/backoffice/v2/financials/settings HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"tax_model": "TAX_INCLUSIVE",
"payment_retries": {
"enable": true,
"frequency": {
"value": 1,
"uot": "HOURS"
},
"retries": 3,
"maximum_period": {
"period": 3,
"uot": "DAYS"
},
"subscription_action": "DEACTIVATE"
},
"payment_methods": [
{
"type": "CRM_WALLET",
"is_allowed": "false"
}
],
"payment_on_file": {
"amount_to_collect": "INOIVED_AMOUNT"
}
}Update the generic financial settings
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The default tax model that is automatically set when setting up product prices
Prices include taxes
Prices do not include taxes
Business rules that enable a payment retry attempt on failing to pay off an invoice or a subscription
Enable payment retries
How often an attempt will be perfomed right after a payment failure
The frequency value
The frequency’s unit of time
How many payment attempts will be performed
The maximum period of time that the system will retry. A payment retry will not be performed if maximum period of time is reached ad regardless of the fact that not all retries were perforemd.
The period’s value
Period of time unit of time
Defines what happens to the subscription of all payment retries fail
The type of the event
Defines how automated payments are managed when using an online contact payment method.
Defaults to Invoiced Amount. On using an online payment method, the invoicing process will collect the appropriate amount on automated payments.
Collect only the invoiced amount
Make a payment to pay off the account’s outstanding amount
Responses
Successful Request
Body
The organisation identifier
PUT https://sandbox.crm.com/backoffice/v2/financial_settings HTTP/1.1
Content-Type: application/json
{
"tax_model": "TAX_INCLUSIVE",
"payment_retries": {
"enable": true,
"frequency": {
"value": 1,
"uot": "HOURS"
},
"retries": 3,
"maximum_period": {
"period": 3,
"uot": "DAYS"
},
"subscription_action": "DEACTIVATE"
},
"payment_methods": [
{
"type": "ACCOUNT_DEBIT"
}
],
"payment_on_file": {
"amount_to_collect": "INVOICED_AMOUNT"
}
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "81560181-f08f-4a83-a683-8ca6555b608a"
}Use financial transaction types to differentiate various transactions issued throughout the software and by various processes like the ordering flow and subscriptions billing.
{id}{id}Create a new financial transaction type
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The name of the financial transaction type. The name should be unique between types of the same transaction classification.
The type of the event
Sets the financial transaction type as the default of its classification. One type must be set as the default among types of the same classification
A description of the financial transaction type
Responses
Successful Request
Body
The unique identifier of the financial transaction type
POST https://sandbox.crm.com/backoffice/v2/financials/types HTTP/1.1
Content-Type: application/json
{
"name": "Sales Invoices",
"classification": "INVOICE",
"is_default": "true",
"description": "Used on manyally debiting contacts during hardware sales"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}Get a list of all financial transaction types
Request parameters
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
The value of the search across name, classification (case insensitive)
The classification of the financial transaction
Filters only the default types
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Successful Request
Body
Unique identifier of the financial transaction type
The name of the financial transaction type
The type of the event
Sets the financial transaction tyep as the default of its classification
A description of the financial transaction type
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/financials/types HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "Sale sInvoice",
"classification": "INVOICE",
"is_default": "true",
"description": "Used during hardware sales"
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Update the financial transaction type
Path variables
The id of the financial transaction type to be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The name of the financial transaction type
Sets the financial transaction type as the default of its classification
A description of the financial transaction type
Responses
Successful Request
Body
The unique identifier of the financial transaction type
PUT https://sandbox.crm.com/backoffice/v2/financials/types/4dc0809f-ed91-4b68-b912-5bd6064d901e HTTP/1.1
Content-Type: application/json
{
"name": "Sales Invoice",
"is_default": "true",
"description": "Used during hardware sales"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}{id}Delete a financial transaction type
Path variables
The id of the financial transaction type to be deleted
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Successful Request
DELETE https://sandbox.crm.com/backoffice/v2/financials/types/4dc0809f-ed91-4b68-b912-5bd6064d901e HTTP/1.1
HTTP/1.1 204 No Content {id}{id}Create a new device status
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The device status name
The device status description
The device’ state
Defines whether the device status is the default one
Responses
The request has succeeded
Body
The device status identifier
POST https://sandbox.crm.com/backoffice/v2/devices/statuses HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"name": "under maintenance",
"description": "devices under this status are blocked and are under maintenance",
"state": "SOLD",
"is_default": "false"
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "42db5477-a544-11c5-45dc-2d444b34056f"
}{id}Update an existing device status
Path variables
The device status (identifier) that will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The device status name
The device status description
Defines whether the device status is the default one
Responses
The request has succeeded
Body
The device status identifier
PUT https://sandbox.crm.com/backoffice/v2/devices/statuses/8580cba8-73f4-6bde-7ac6-b6713d6df89c HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"name": "under maintenance",
"description": "devices under this status are blocked and are under maintenance",
"is_default": "false"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "42db5477-a544-11c5-45dc-2d444b34056f"
}{id}Delete an existing device status
Path variables
The device status (identifier) that will be deleted
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
DELETE https://sandbox.crm.com/backoffice/v2/devices/statuses/8580cba8-73f4-6bde-7ac6-b6713d6df89c HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 204 No Content Retrieve a list of device statuses based on search criteria (e.g. all used device statuses)
Request parameters
Filter based on device status attributes (name and classification)
Filter based on device state
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The device status identifier
The device status name
The device status description
The device’ state
Defines whether the device status is the default one or not
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/devices/statuses HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "a7025bb4-100e-b64b-eaf0-cbbe3327515a",
"name": "under maintenance",
"description": "devices are under maintenance",
"state": "RENTED",
"is_default": "false"
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}Define and manage the possible reasons why a lead may be lost. A lost reason must be provided when a lead takes on the state of ‘Lost’.
{id}{id}Create a possible reason for losing a lead
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
A unique name for the lost reason
A description for the lost reason
Examples
Responses
Body
The unique identifier of the newly created lost reason
POST https://sandbox.crm.com/backoffice/v2/leads/lost_reasons HTTP/1.1
Content-Type: application/json
{
"name": "Competitor",
"description": "Lost to a competitor"
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "2964aaff-df07-4798-b585-82a813800b3e"
}{id}Update a lost (lead) reason
Path variables
The GUID of the lost reason to be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
A unique lost reason name
A description of the lost lead reason
Examples
Responses
Body
The unique identifier of the updated lost reason
PUT https://sandbox.crm.com/backoffice/v2/leads/lost_reasons/2964aaff-df07-4798-b585-82a813800b3e HTTP/1.1
Content-Type: application/json
{
"name": "Too expensive",
"description": "Pricing is not within organisation's budget."
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "2964aaff-df07-4798-b585-82a813800b3e"
}{id}Delete a lost lead reason
Path variables
The GUID of the lost reason to be deleted
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
DELETE https://sandbox.crm.com/backoffice/v2/leads/lost_reasons/2964aaff-df07-4798-b585-82a813800b3e HTTP/1.1
HTTP/1.1 204 No Content List all available reasons for losing a lead
Request parameters
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Search for a lost reason based on its name and description
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
The id of the lost reason
The name of the lost reason
The description of the lost reason
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/leads/lost_reasons HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "2964aaff-df07-4798-b585-82a813800b3e",
"name": "Pricing",
"description": "Pricing not within organisation's budget"
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}Queues are defined and assigned to leads upon creation. A queue contains the stages that a lead will progresses through from start to finish during it’s life cycle. Multiple queues can be created based on your leads classifications.
{id}{id}{id}{id}/stage/{stage_id}Create a queue for leads with it’s stages. By default a Lead Queue is created as ‘Inactive’ and should be activated in a separate Web API call.
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
A unique name for the lead queue
A description for the Lead queue
Queue state, set to ‘inactive’ by default, can be changed to ‘active’ through another API call
Can be assigned to a Lead
Can’t be assigned to a Lead
Queue stages information. At least three stages must be specified, i.e. one for each one of that available states of the lead; New, In Progress, Won and Lost
The order of the stage within the queue
Stage name
Stage description
Stage colour hex code
The order life cycle state
Examples
Responses
Body
The unique identifier of the newly created queue
POST https://sandbox.crm.com/backoffice/v2/leads/queues HTTP/1.1
Content-Type: application/json
{
"name": "International subscriptions lead",
"description": "Queue that manages B2B leads",
"state": "ACTIVE",
"stages": [
{
"order": 1,
"name": "Proposal Submitted",
"description": "Proposal has been forwarded to the customer",
"colour": "#fa5c7c",
"state": "LOST"
}
]
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "2964aaff-df07-4798-b585-82a813800b3e"
}{id}Update a lead queue and it’s stages
Path variables
The GUID of the lead queue to be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The unique queue name
Lead queue state
Can be assigned to a lead
Cannot be assigned to a lead
The stages of the queue. Each stage must have a unique name, order and colour.
Order of the stage within the queue
Stage name
Stage description
Stage colour hex code
The order life cycle state
Examples
Responses
Body
The unique identifier of the updated lead queue
PUT https://sandbox.crm.com/backoffice/v2/leads/queues/2964aaff-df07-4798-b585-82a813800b3e HTTP/1.1
Content-Type: application/json
{
"name": "Large-scale business lead",
"description": "",
"state": "INACTIVE",
"stages": [
{
"order": 4,
"name": "Proposal Submitted",
"description": "Proposal has been submitted to the customer",
"colour": "#fa5c7c",
"state": "IN_PROGRESS"
}
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "2964aaff-df07-4798-b585-82a813800b3e"
}Retrieve all queues configured for leads
Request parameters
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Search for a queue by name and description
The state of the leads queue
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
The GUID of the queue
The name of the queue
Lead queue description
The state of the queue
Number of stages that the queue is comprised of
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/leads/queues HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "2964aaff-df07-4798-b585-82a813800b3e",
"name": "Small local business lead",
"description": "Manages local businesses leads flows",
"state": "INACTIVE",
"number_of_stages": 5
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Retrieve a lead queue with it’s stages
Path variables
The GUID of the lead queue to be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
The GUID of the retrieved queue
Queue name
Queue description
The state of the queue
Queue stages information
Stage id
Stage name
Stage description
The order of the stage within the queue
stage colour hex code
The order life cycle state
GET https://sandbox.crm.com/backoffice/v2/leads/queues/2964aaff-df07-4798-b585-82a813800b3e HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "2964aaff-df07-4798-b585-82a813800b3e",
"name": "Small local business lead",
"description": "Manage leads of small local businesses",
"state": "ACTIVE",
"stages": [
{
"id": "61c943c8-dfeb-4c09-a25c-b054f48bf244",
"name": "Proposal submitted",
"description": "Proposal has been forwarded to the customer",
"order": 5,
"colour": "#fa5c7c",
"state": "NEW"
}
]
}{id}Delete a lead queue definition
Path variables
The GUID of the lead queue to be deleted
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
DELETE https://sandbox.crm.com/backoffice/v2/leads/queues/2964aaff-df07-4798-b585-82a813800b3e HTTP/1.1
HTTP/1.1 204 No Content {id}/stage/{stage_id}Delete a stage from a lead queue. If there are any existing leads in that stage then they must be transferred to another stage of the same queue.
Path variables
The GUID of the queue
The GUID of the queue stage to be deleted
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The GUID of the new stage (in the same queue) to which any existing leads will be transferred to. Required only if there are one or more leads in the stage to be deleted
Responses
DELETE https://sandbox.crm.com/backoffice/v2/leads/queues/2964aaff-df07-4798-b585-82a813800b3e/stage/61c943c8-dfeb-4c09-a25c-b054f48bf244 HTTP/1.1
Content-Type: application/json
{
"stage_id": "e4119c11-2437-4c80-b321-0fc2143020e7"
}
HTTP/1.1 200 OK {id}{id}{id}/licenses{license_id}{id}/actions{id}/assets{id}{id}{id}Create a new license
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The name of the license
The description of the license
Responses
Body
The license identifier
POST https://sandbox.crm.com/backoffice/v1/licenses HTTP/1.1
Content-Type: application/json
{
"name": "Trial License",
"description": "This is free Trial License with limited access to features"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "42f3752c-676a-8245-1c87-130b93f960c7"
}{id}Update a license
Path variables
The identifier of the license that will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The name of the license
The description of the license
Responses
Body
The license identifier
PUT https://sandbox.crm.com/backoffice/v1/licenses/42f3752c-676a-8245-1c87-130b93f960c7 HTTP/1.1
Content-Type: application/json
{
"name": "Trial License",
"description": "This is free Trial License with limited access to features"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "42f3752c-676a-8245-1c87-130b93f960c7"
}{id}Delete a single license
Path variables
The license (identifier) that will be deleted
Responses
Successfull Request
DELETE https://sandbox.crm.com/backoffice/v1/licenses/42f3752c-676a-8245-1c87-130b93f960c7 HTTP/1.1
HTTP/1.1 200 OK {id}/licensesReturns a list of licenses of the organisation
Path variables
The oginasation identifier
Request parameters
Search for license based on name and description
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
The license identifier
The name of the license
The description of the license
The life cycle state of the license
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v1/organization/d332dd8a-254e-47c9-ba1f-3f369877a9b3/licenses HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "42f3752c-676a-8245-1c87-130b93f960c7",
"name": "Trial License",
"description": "The is Trial License",
"life_cycle_state": "ACTIVE"
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{license_id}Returns the details of a license of the organisation.
Path variables
The license (identifier) for which information will be retreived
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Successful Request
Body
The license identifier
The name of the license
The description of the license
The life cycle state of the license
The assets of a license
The asset identifier
The name of the asset
The description of the asset
The modules of the asset
The name of the module
The features of the module
The name of the feature
The license code of the feature
GET https://sandbox.crm.com/backoffice/v1/organization/d332dd8a-254e-47c9-ba1f-3f369877a9b3/licenses/42f3752c-676a-8245-1c87-130b93f960c7 HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": {
"id": "42f3752c-676a-8245-1c87-130b93f960c7",
"name": "Trial License",
"description": "The is a Trial License with limited access to features",
"life_cycle_state": "ACTIVE",
"assets": [
{
"id": "1a7fc6dc-9932-5965-b028-14843782c843",
"name": "CRM",
"description": "Asset for CRM modules",
"modules": [
{
"name": "Contacts",
"features": [
{
"name": "View Contacts",
"license_code": "CRM_CON_VIEW"
},
{
"name": "Manage Contacts",
"license_code": "CRM_CON_MANAGE"
}
]
},
{
"name": "Activities",
"features": [
{
"name": "View Activities",
"license_code": "CRM_ACT_VIEW"
},
{
"name": "Manage Activities",
"license_code": "CRM_ACT_MANAGE"
}
]
}
]
},
{
"id": "a744fded-8f08-0dd9-97ef-8a97c5512c38",
"name": "Analytics",
"description": "Asset for Analytics modules",
"modules": [
{
"name": "Insights",
"features": [
{
"name": "View Insights",
"license_code": "ANA_INS_VIEW"
},
{
"name": "Manage Insights",
"license_code": "ANA_INS_MANAGE"
}
]
},
{
"name": "Reports",
"features": [
{
"name": "View Reports",
"license_code": "ANA_REP_VIEW"
},
{
"name": "Manage Reports",
"license_code": "ANA_REP_MANAGE"
}
]
}
]
}
]
}
}{id}/actionsPerform an action on an existing license
Path variables
The license (identifier) whose life cycle state will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The life cycle state that the license will changed into
Responses
Successfull Requst
Body
The license identifier
POST https://sandbox.crm.com/backoffice/v1/licenses/42f3752c-676a-8245-1c87-130b93f960c7/actions HTTP/1.1
Content-Type: application/json
{
"life_cycle_state": "ACTIVE"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "42f3752c-676a-8245-1c87-130b93f960c7"
}{id}/assetsAdd assets to license
Path variables
The license (identifier) for which assets will be set
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The assets added to the license
The asset identifier to add to the license
Responses
Successful Request
Body
The license identifier
POST https://sandbox.crm.com/backoffice/v1/licenses/42f3752c-676a-8245-1c87-130b93f960c7/assets HTTP/1.1
Content-Type: application/json
{
"assets": [
{
"id": "2b7adb86-ef99-a693-699f-ca2f48b75b91"
}
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "42f3752c-676a-8245-1c87-130b93f960c7"
}Create an asset
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The name of the asset
The description of the asset
The modules of the asset
The name of the module
The features of the module
The name of the feature
The unique license code of the feature
Responses
Successsful Request
Body
The asset identifier
POST https://sandbox.crm.com/backoffice/v1/assets HTTP/1.1
Content-Type: application/json
{
"name": "CRM",
"description": "The CRM related modules of the system",
"modules": [
{
"name": "Contacts",
"features": [
{
"name": "Manage Contacts",
"license_code": "CRM_COM_MANAGE"
}
]
}
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "92357407-15a3-4228-6581-383ffc5c9a74"
}Returns a list of assets
Request parameters
Search for assets based on name and description
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
The asset identifier
The name of the asset
The description of the asset
The modules of the asset
The name of the module
The features of the module
The name of the feature
The license code of the feature
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v1/assets HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "81c3f16b-9d36-3eef-6fc3-f9206f2edc6c",
"name": "CRM",
"description": "The asset related the CRM modules of the system",
"modules": [
{
"name": "Contacts",
"features": [
{
"name": "Manage Contacts",
"license_code": "CRM_CON_MANAGE"
}
]
}
]
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Returns the details of a single asset
Path variables
The asset (identifier) for which information will be retrieved
Responses
Body
The asset identifier
The name of the asset
The description of the asset
The modules of the asset
The name of the module
The features of the module
The name of the feature
The license code of the feature
GET https://sandbox.crm.com/backoffice/v1/assets/addd8657-b32a-fa54-b7d8-3ba166f37779 HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "addd8657-b32a-fa54-b7d8-3ba166f37779",
"name": "CRM",
"description": "The asset related to CRM modules",
"modules": [
{
"name": "Contacts",
"features": [
{
"name": "View Contacts",
"license_code": "CRM_CON_VIEW"
}
]
},
{
"name": "Activities",
"features": [
{
"name": "View Activities",
"license_code": "CRM_ACT_VIEW"
}
]
}
]
}{id}Update an asset
Path variables
The asset (identifier) which will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The name of the asset
The description of the asset
The modules of the asset
The name of the module
The features of the module
The name of the feature
The unique license code of the feature
Responses
Successsful Request
Body
The asset identifier
POST https://sandbox.crm.com/backoffice/v1/assets/92357407-15a3-4228-6581-383ffc5c9a74 HTTP/1.1
Content-Type: application/json
{
"name": "CRM",
"description": "The CRM related modules of the system",
"modules": [
{
"name": "Contacts",
"features": [
{
"name": "Manage Contacts",
"license_code": "CRM_COM_MANAGE"
}
]
}
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "92357407-15a3-4228-6581-383ffc5c9a74"
}{id}Delete a single asset
Path variables
The asset (identifier) that will be deleted
Responses
Successfull Request
DELETE https://sandbox.crm.com/backoffice/v1/assets/1c64097c-1f09-82d3-5d5e-2f662a254a3d HTTP/1.1
HTTP/1.1 200 OK {id}{id}Create a new measurement unit. A single measurement unit can be created per Web API call.
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The name of the measurement unit which is mandatory and unique.
The name of the unit that wll be used for display and checkout purposes.
The measurement unit description.
Responses
Body
The unique identifier of the new measurement unit
POST https://sandbox.crm.com/backoffice/v1/measurement_units HTTP/1.1
Content-Type: application/json
{
"name": "Phone calls",
"display_name": "minutes",
"description": "Unit that measures the duration of a phone call in minutes"
}Returns a list of measurement units
Request parameters
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Search for measurement units using their name or display name.
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
The unique identifier of the measurement unit
The name of measurement unit
The display name of the measurement unit
The measurement unit’s description
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v1/measurement_units HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "3FD9C84FA60F9FE407140E20F707726A",
"name": "Minutes",
"display_name": "min.",
"description": "Phone call minutes"
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Update an existing unit of measurement. A sinly measurement unit can be updated per Web API call
Path variables
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The name of the measurement unit
The display name of the measurement unit
The measurement unit’s description
Responses
Body
The unique identifier of the updated measurement unit
PUT https://sandbox.crm.com/backoffice/v1/measurement_units/{id} HTTP/1.1
Content-Type: application/json
{
"name": "Phone call minutes",
"display_name": "minutes",
"description": "Measures a phone call's duration in minutes"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "2dc0809f-ed91-4b68-b912-5bd6064d901e"
}{id}Deletes an existing unit of measurement. A single measurement unit can be deleted per Web API call
Path variables
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
DELETE https://sandbox.crm.com/backoffice/v1/measurement_units/{id} HTTP/1.1
HTTP/1.1 200 OK Retrieve Order generic settings
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Orders numbering scheme
Scheme name
Prefix for Order numbers
Starting number for the scheme
Number of digits following the prefix
Rules on how financial trasnactions will be issued on managing Orders
The type of the event
Delivered to the customer’s address
Picked up by the customer from a venue
Online sales of services
The invoice type identifier that will be used. If not specified, then the default invoice type will be used
The credit note type identifier that will be used. If not specified, then the default credit note type will be used
Business rules that define how Invoices will be generated for milestone-based Orders
The invoice type identifier that will be used. If not specified, then the default invoice type will be used
The invoice milestone product, i.e. the product that will be included in the milestone invoice. Only products classified as expenses can be specified.
Responses
Body
Order settings unique identifier
PUT https://sandbox.crm.com/backoffice/v2/orders/settings HTTP/1.1
Content-Type: application/json
{
"numbering_schemes": [
{
"entity": "ORDERS",
"prefix": "O",
"starting_number": "00000001",
"number_of_digits": 5
}
],
"financial_settings": [
{
"supply_method": "DELIVERY",
"invoice_type_id": "4ea25d61-ebfe-3a7b-2a45-96d8b059d369",
"credit_note_type_id": "4ea25d61-ebfe-3a7b-2a45-96d8b059d369"
}
],
"milestone_settings": {
"invoice_type_id": "4ea25d61-ebfe-3a7b-2a45-96d8b059d369",
"product_id": "4ea25d61-ebfe-3a7b-2a45-96d8b059d369"
}
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}Retrieve Order generic settings
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
The type of the event
The entity for which the numbering scheme is configured
The prefix of the numbering scheme. Defaults to the first letter(s) of the entity’s name
The starting number of the nuberig scheme (excluding prefix). Defaults to 10001
Number of digits (excluding prefix). Defaults to 5
The last number generated for this numbering scheme
Business rules that define how financial transactions will be issued for Orders
The type of the event
Delivered to the customer’s address
Picked up by the customer from a venue
Online sales of services
Details about the invoice type that will be used
The invoice type identifier
The invoice type name
Details about the credit note type that will be used
The credit note type identifier
The credit note type name
Business rules that define how Invoices will be generated for milestone-based Orders
The invoice type that will be used. If not specified, then the default invoice type will be used
Invoice financial transaction type identifier
Invoice type name
The invoice milestone product, i.e. the product that will be included in the milestone invoice. Only products classified as expenses can be specified.
Product identifier
Product SKU
Product name
GET https://sandbox.crm.com/backoffice/v2/orders/settings HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"numbering_schemes": {
"entity": "SERVICE_REQUESTS",
"prefix": "SR",
"starting_number": "0000001",
"number_of_digits": "7",
"last_number": "SR000001"
},
"financial_settings": [
{
"supply_method": "DELIVERY",
"invoice_type": {
"id": "The invoice type identifier that will be used",
"name": "Order Invoice"
},
"credit_note_type": {
"id": "a4b059a3-2aa7-b2c2-4191-a966168e97d7",
"name": "ORDER Credit Note"
}
}
],
"milestone_settings": {
"invoice_type": {
"id": "4ea25d61-ebfe-3a7b-2a45-96d8b059d369",
"name": "Milestone Invoice"
},
"product": {
"id": "4ea25d61-ebfe-3a7b-2a45-96d8b059d369",
"sku": "FEE1",
"name": "Pre-payment"
}
}
}{id}{id}Retrieve all reasons that will justify an order cancellation
Request parameters
Search for a cancellation reason based on its name or description
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
The cancellation reason identifier
The cancellation reason name
The cancellation reason description
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/orders/cancellation_reasons HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "caf332bc-4e90-47b5-a05d-142b264897b9",
"name": "Cancelled by Customer",
"description": "Customer requested to cancel an order due to mistake"
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}Creates a new Cancellation Reason that will be used when cancelling orders
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Cancellation reason name
Cncellation reason descripiton
Responses
Body
Cancellation reason name
POST https://sandbox.crm.com/backoffice/v2/orders/cancellation_reasons/ HTTP/1.1
Content-Type: application/json
{
"name": "Cancelled by consumer",
"description": "Set in orders that are cancelled on consumer request"
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}{id}Updates an existing Cancellation reason
Path variables
Unique identifier of the Cancellation reason
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Cancellation reason name
Canellation reason description
Responses
Body
Cancellation reason unique identifier
PUT https://sandbox.crm.com/backoffice/v2/orders/cancellation_reasons/{id} HTTP/1.1
Content-Type: application/json
{
"name": "On consumer request",
"description": "Used in cases where consumer cancels the Order"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}{id}Deletes an existing Cancellation reason
Path variables
The cancellation reason (identifier) that will be deleted
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
DELETE https://sandbox.crm.com/backoffice/v2/orders/cancellation_reasons/4dc0809f-ed91-4b68-b912-5bd6064d901e HTTP/1.1
HTTP/1.1 204 No Content {id}{id}Creates a new Order Category. Order categories have a tree structure so on creating a new category it is optonal to specify the parent category as well to structure the tree.
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Category name
Category description
Parent category identifier
Responses
Body
Unique identifier of the Category
POST https://sandbox.crm.com/backoffice/v2/orders/categories HTTP/1.1
Content-Type: application/json
{
"name": "Soft drinks",
"descripion": "All soft drinks",
"parent_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}{id}Deletes an existing Order Category. A Category cannot be deleted ift it was used in at least one Order. A Category with chile categories cannot be deleted either. All of its child categories must be deleted first.
Path variables
Unique identifier of an Order Category
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
DELETE https://sandbox.crm.com/backoffice/v2/orders/categories/4dc0809f-ed91-4b68-b912-5bd6064d901e HTTP/1.1
HTTP/1.1 204 No Content {id}Updates a single Order Category. During update, an Order’s parent cateogry can be updated as well
Path variables
Order category unique identifier
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Category name
Category description
Updated parent category
Responses
Body
Category unique identifier
PUT https://sandbox.crm.com/backoffice/v2/orders/categories/4dc0809f-ed91-4b68-b912-5bd6064d901e HTTP/1.1
Content-Type: application/json
{
"name": "Soft drinks",
"description": "All soft drinks",
"parent_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}Returns a list of Order Categories
Request parameters
Returns all cateogries under this parent category
If set to True , then all categories are returned, regardless of their parent-child relation.
Search for a category using its name or description
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
Category identfier
Category name
Category description
Number of child nodes if a category is a parent
The parent category
Unique identifier of parent category
Parent caregory name
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/orders/categories HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "Soft Drinks",
"description": "All soft drinks",
"child_nodes": 2,
"parent": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "Cold Drinks"
}
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}{id}{id}Creates a new Order Queue
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Order queue name which has to be unique across all Queues
Queue description
Queue state. If not specified, then the queue is created a Inactive and has to change in a different call
Determines if Orders on this queue will be invoiced up front (on placing them and setting their state into New)
List of Queue stages. At least 2 stages must be incuded for the New and Completed Order states (one stage for each state). Multiple stages can be set up while Orders are In Progress
The stage’s ordering sequence
The order life cycle state
Stage name
Stage description
Stage colour. It has to be unique across the colours among stages of the same queue
Defines whether an Invoice milestone is planned as soon as Orders reach this stage.
The milestone’s percentage. This percentage defines the Invoice’s total amount which will be the specfied X% on the order’s total amount.
Responses
Body
Order queu unique identifier
POST https://sandbox.crm.com/backoffice/v2/orders/queues HTTP/1.1
Content-Type: application/json
{
"name": "Support Calls",
"description": "Deals with support calls",
"state": "ACTIVE",
"invoice_upfront": "true",
"stages": [
{
"order": 1,
"state": "CANCELLED",
"name": "Awaiting customer",
"description": "This status is awaiting confirmation from a customer",
"colour": "F1SJ86",
"invoice_milestone": {
"percentage": 13.5
}
}
]
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}{id}Updates an existing Order Queue
Path variables
Order Queue identifier
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Order queue name which has to be unique across all Queues
Queue description
Queue state. Only Active queues can be used for managing Orders
Determines if Orders will be invoiced upfront(on their creation)
List of Queue stages. At least 2 stages must be incuded for the New and Completed Order states (one stage for each state). Multiple stages can be set up while Orders are In Progress
The stage’s ordering sequence
The order life cycle state
Stage name
Staeg description
Stage colour. Has to be unique across colous of stages in the same queue
Milestone Invoices issued on reaching this stage
the Invoice lmilesotne’s amont calculated based on this X5 on the Oder’s total cost
Indicates that this stage will be the Point of No Return for Orders following the queue
Responses
Body
Order queue unique identifier
PUT https://sandbox.crm.com/backoffice/v2/orders/queues/{id} HTTP/1.1
Content-Type: application/json
{
"name": "Support Calls",
"description": "Manage Support Calls",
"state": "ACTIVE",
"invoice_upfront": "true",
"stages": [
{
"order": 1,
"state": "COMPLETED",
"name": "Awaiting customer",
"description": "This status is awaiting confirmation from a customer",
"colour": "F1SJ86",
"invoice_milestone": {
"percentage": 11.5
},
"is_ponr": "true"
}
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}{id}Deletes an Order Queue A Queue can only be delete dif it was never used in any Orders
Path variables
Order queue unique identifier
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
DELETE https://sandbox.crm.com/backoffice/v2/orders/queues/4dc0809f-ed91-4b68-b912-5bd6064d901e HTTP/1.1
HTTP/1.1 204 No Content Returns a list of Order Queues
Request parameters
Search Queues by name, description
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
The state of the order queue
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
Unique identifier of the Queue
Queue name
Queue description
Queue state
Number of stages included in the Queue
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/orders/queues HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "74D9C84FA60F9FE407140E20F707726A",
"name": "Basic food ordering queue",
"description": "Basic food ordering queue",
"state": "ACTIVE",
"stages": 3
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Returns detailed information of an Order Queue
Path variables
Order Queue unique identifier
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
Queue unique identifer
Queue name
Queue description
Queue state
Determine sif Orders will be invoiced up front (on their creation) or on their completion
List of stages through which Orders using this queue will go through
Queue stage uniue identifier
Stage ordering sequence
Stage name
Stage description
The type of the event
Only one status is allowed for the NEW state per queue
Multiple statuses are allowed for the IN PROGRESS state per queue.
Only one status is allowed for the COMPLETED state per queue
Shows which order queue status also marks the point of no return for Orders
Stage colour
Milestone invoice issued when Orders of this queue reach the specified stage
The milestones percentage that defines the Invoice’s amount.
GET https://sandbox.crm.com/backoffice/v2/orders/queues/4dc0809f-ed91-4b68-b912-5bd6064d901e HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "74D9C84FA60F9FE407140E20F707726A",
"name": "Basic food ordering queue",
"description": "Basic food ordering queue",
"state": "ACTIVE",
"invoice_upfront": "true",
"stages": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"order": 1,
"name": "Awaiting customer",
"description": "Awaiting customer lorem ipsulum",
"state": "NEW",
"point_of_no_return": true,
"colour": "FSD56F",
"invoice_milestone": {
"percentage": 11.5
}
}
]
}{id}{id}{id}Creates a Fulfillment Policy that defines business rules on how Orders will be fulfilled. A business might have multiple Fuflfillement policies as long as their business rules are unique.
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Fulfillment policy name which has to be unique across all policies.
Description of Fulfillment policy
The type of the event
Delivered to the customer’s address
Picked up by the customer from a venue
Online sales of services
Minimum required amount in order to place Orders. the amount is set in the business’s base Currency. This amount is validated against an Order’s final cost (i.e. after applying taxes and discounts).
Automatically mark an Order as Completed after a period of time. Such Orders must be in In progress state and also invoiced up-frond
Set the Order as Completed after this duration elapses
Duration’s unit of time
Defines whether average completion time will be calculated.
Used to calculate the average completion time for an Order
Time required on an average basis
Average completion time’s unit of time
List of expenses that will be applied as part of fulfilling an Order
Expense product to be applied on the Order’s cost. Only services marked as Expenses can be specified.
The type of the event
Delivered to the customer’s address
Picked up by the customer from a venue
Online sales of services
Defines the maximum threshold for applying the expense on the order (i.e. apply 2 euro delivery expense for orders less than 10 euros)
Defines whether the fulfillment policy is applicable for all organisations under the Business or specific organisations
Fulfillment policy to be applie don all or specific Organisations of the Business
The organisations (Merchants, Venues) that will fulfill orders based on this policy (applicable only if type = SPECIFIC)
[
"CAD1E31269B76D7A65ACCE45B2E68DFD"
]The applicable payment method types for this policy. If not specified then all allowed payment method types are applicable.
The type of the event
Responses
The request has succeeded
Body
The fulfillment policy identifier
POST https://sandbox.crm.com/backoffice/v2/orders/fulfillment_policies/ HTTP/1.1
Content-Type: application/json
{
"name": "Delivery Orders",
"description": "Business rules on fulfilling Delivery orders",
"supply_methods": "DELIVERY",
"minimum_amount": 9.99,
"automatic_completion": {
"duration": 5,
"uot": "MINUTES"
},
"enable_completion_time": "true",
"average_completion_time": {
"time_to_complete": 30,
"uot": "MINUTES"
},
"expenses": [
{
"product_id": "",
"supply_method": "DELIVERY",
"order_amount": 9.99
}
],
"accessibility": {
"type": "SPECIFIC",
"organisations": [
""
]
},
"payment_method_types": [
"ACCOUNT_DEBIT"
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "d892c9b4-0a6b-baf9-8a32-913c932bd2ab"
}{id}Update an existing Fulfillement Policy of Orders.
Path variables
The order fulfillment policy that will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Fulfillment policy name
Fulfillment policy description
The type of the event
Delivered to the customer’s address
Picked up by the customer from a venue
Online sales of services
Minimum required amount in order to place Orders. the amount is set in the business’s base Currency. This amount is validated against an Order’s final cost (i.e. after applying taxes and discounts).
Automatically mark an Order as Completed after a period of time. Such Orders must be in In progress state and also invoiced up-frond
Set the Order as Completed after this duration elapses
Unit of time
Defines whether average completion time will be calculated.
Used to calculate the average completion time for an Order
Time required on an average basis
Unit of time
List of expenses that will be applied as part of fulfilling an Order
The expense to be applied on fulfilling Orders. Only Expense service products can be specified
The type of the event
Delivered to the customer’s address
Picked up by the customer from a venue
Online sales of services
Defines the maximum threshold for applying the expense on the order (i.e. apply 2 euro delivery expense for orders less than 10 euros)
Defines whether the fulfillment policy is applicable for all organisations under the Business or specific organisations
Define whether the fulfillment policy is applied to all or specific organisations of the business
The organisations (Merchants, Venues) that will fulfill orders based on this policy (applicable only if type = SPECIFIC)
[
"CAD1E31269B76D7A65ACCE45B2E68DFD"
]The applicable payment method types for this policy. If not specified then all allowed payment method types are applicable.
The type of the event
Responses
The request has succeeded
Body
The order fulfillment policy identifier
PUT https://sandbox.crm.com/backoffice/v2/orders/fulfillment_policies/d892c9b4-0a6b-baf9-8a32-913c932bd2ab HTTP/1.1
Content-Type: application/json
{
"name": "Pick Up Orders",
"description": "Business rules on fuflfilling Pick Up Orders",
"supply_methods": "DELIVERY",
"minimum_amount": 1,
"automatic_completion": {
"duration": "30",
"uot": "MINUTES"
},
"enable_completion_time": "true",
"average_completion_time": {
"time_to_complete": 30,
"time_to_complete_UOT": "MINUTES"
},
"expenses": [
{
"product_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"supply_method": "DELIVERY",
"order_amount": 9.99
}
],
"accessibility": {
"type": "SPECIFIC",
"organisations": [
""
]
},
"payment_method_types": [
"CHEQUE"
]
}{id}Deletes an existing Fulfillment Policy.
Path variables
The order fulfillment poilicy that will be deleted
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
DELETE https://sandbox.crm.com/backoffice/v2/orders/fulfillment_policies/d892c9b4-0a6b-baf9-8a32-913c932bd2ab HTTP/1.1
HTTP/1.1 204 No Content Return a list of configured Fulfillment Polcies for Orders.
Request parameters
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Search by name or description
Search by the Organisation that fulfills Orders (base don policy’s Accessibility information).
Search by Supply method
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
Fulfillment Policy name
Fulfillment Policy Description
The type of the event
Delivered to the customer’s address
Picked up by the customer from a venue
Online sales of services
List of Organisations that can fulfill Orders based on this policy. If not specified, then policy is applied in the same way across all Organisations
Organisation identifier
Organisation name
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/orders/fulfillment_policies HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"name": "Delivery Orders",
"description": "Business rules on fulfilling Delibery orders",
"supply_method": "DELIVERY",
"organisations": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "Good Burgers"
}
]
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Returns detailed information for an Order fulfillment policy
Path variables
The order fulfillment policy that will be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
Fulfillment Policy name
Fulfillment Policy description
Policy applied on fulfilling orders of the specified supply method.
Minimum required amount in order to place Orders. the amount is set in the business’s base Currency. This amount is validated against an Order’s final cost (i.e. after applying taxes and discounts).
Automatically mark an Order as Completed after a period of time. Such Orders must be in In progress state and also invoiced up-frond
Set the Order as Completed after this duration elapses
Unit of time
Defines whether average completion time will be calculated.
Used to calculate the average completion time for an Order
Time required on an average basis
Unit of time
Defines whether the fulfillment policy is applicable for all organisations under the Business or specific organisations
Fulfillment policy to be applie don all or specific Organisations of the Business
The organisations (Merchants, Venues) that will fulfill orders based on this policy (applicable only if type = SPECIFIC)
The organisation identifier
The name of the organisation
The applicable payment method types for this policy
The type of the event
List of expenses that will be applied as part of fulfilling an Order
The type of the event
Delivered to the customer’s address
Picked up by the customer from a venue
Online sales of services
The Expense to be applied
Product identifier
Product SKU
Product name
Defines the maximum threshold for applying the expense on the order (i.e. apply 2 euro delivery expense for orders less than 10 euros)
GET https://sandbox.crm.com/backoffice/v2/orders/fulfillment_policies/c011cb43-b76e-7e5a-436c-f5917e358849 HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"name": "Deivery Orders",
"description": "Business rules on fulfilling Delivery orders",
"supply_method": "DIRECT_SALE",
"minimum_amount": 9.99,
"automatic_completion": {
"duration": "30",
"uot": "MINUTES"
},
"enable_completion_time": "true",
"average_completion_time": {
"time_to_complete": 30,
"uot": "MINUTES"
},
"accessibility": {
"type": "SPECIFIC",
"organisations": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "Good Burgers"
}
]
},
"payment_method_types": [
"CHEQUE"
],
"expenses": [
{
"supply_method": "DELIVERY",
"product": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"sku": "DFEE",
"name": "Delivery Fee"
},
"order_amount": 1
}
]
}{id}{id}Creates a new rule for completing orders. These rules can be used in order to calculate an Order’s estimated completion time based on the Orders already placed within the Business. Multiple rules can be set up, as long as their business conditions are unique. If a rule’s conditions are met, then an additional completion time is added to the order’s estimated delivery time (the one that might be calculated based on average estimations of the Fulfillment Policy).
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
An additional completion time will be required and will be added to the Order’s estimated completion time if this rule’s conditions are met
Additional completion time duration
Unit of time
The Organisation that will fulfill the Orders
Number of pending, i.e. non-completed, Orders at the time that a new one is placed.
Minimum number of Orders
Maximum number of Orders
Number of items pending to be delivered i.e. the total number of items among all pending Orders
Minimum ordered items in pending Orders
Maximum ordered items in pending Orders
Conditions related to the Ordered items (among the Orders which are pending)
Item type
The product identifier or product type identifier depending on the selected item type.
Timing conditions mthat must be met at the time a new Order is placed
Order placed during a week day
Order placed from this time of the day
Order place until this time of day (must be specified after the start_time
Responses
Body
The Completion rule’s identifier
POST https://sandbox.crm.com/backoffice/v2/orders/completion_rules HTTP/1.1
Content-Type: application/json
{
"additional_completion_time": {
"duration": "5",
"uot": "MINUTES"
},
"organisation_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"pending_orders": {
"minimum": 1,
"maximum": 10
},
"pending_items": {
"minimum": 10,
"maximum": 22
},
"product_conditions": [
{
"item_type": "PRODUCT",
"item_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}
],
"timing_conditions": [
{
"day_of_week": "MONDAY",
"start_time": "09:00",
"end_time": "11:00"
}
]
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}{id}Updates an existing rule for completing orders. An Order completion rule can be removed at any point of time.
Path variables
Order Completion Rule identifier
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
An additional completion time will be required and will be added to the Order’s estimated completion time if this rule’s conditions are met
Additional completion time duration
Unit of time
The Organisation that will fulfill the Orders
Number of pending, i.e. non-completed, Orders at the time that a new one is placed.
Minimum number of Orders
Maximum number of Orders
Number of items pending to be delivered i.e. the total number of items among all pending Orders
Minimum ordered items in pending Orders
Maximum ordered items in pending Orders
Conditions related to the Ordered items (among the Orders which are pending)
Item type
The product identifier or product type identifier depending on the selected item type.
Timing conditions mthat must be met at the time a new Order is placed
Order placed during a week day
Order placed from this time of the day
Order place until this time of day (must be specified after the start_time
Responses
PUT https://sandbox.crm.com/backoffice/v2/orders/completion_rules/4dc0809f-ed91-4b68-b912-5bd6064d901e HTTP/1.1
Content-Type: application/json
{
"additional_completion_time": {
"duration": "5",
"uot": "MINUTES"
},
"organisation_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"pending_orders": {
"minimum": 1,
"maximum": 10
},
"pending_items": {
"minimum": 10,
"maximum": 22
},
"product_conditions": [
{
"item_type": "PRODUCT",
"item_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}
],
"timing_conditions": [
{
"day_of_week": "MONDAY",
"start_time": "09:00",
"end_time": "11:00"
}
]
}
HTTP/1.1 200 OK Retrieves a list of all Order Completion Rules.
Request parameters
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Search for completion rules based on the Organisation that fulfills orders
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
An additional completion time will be required and will be added to the Order’s estimated completion time if this rule’s conditions are met
Additional completion time duration
Unit of time
The Organisation that will fulfill the Orders
Organisation identifier
Organisation name
Number of pending, i.e. non-completed, Orders at the time that a new one is placed.
Minimum number of Orders
Maximum number of Orders
Number of items pending to be delivered i.e. the total number of items among all pending Orders
Minimum ordered items in pending Orders
Maximum ordered items in pending Orders
Conditions related to the Ordered items (among the Orders which are pending)
Item type
The product identifier or product type identifier depending on the selected item type.
Product or Product type name
Product SKU
Timing conditions mthat must be met at the time a new Order is placed
Order placed during a week day
Order placed from this time of the day
Order place until this time of day (must be specified after the start_time
Responses
GET https://sandbox.crm.com/backoffice/v2/orders/completion_rules/ HTTP/1.1
Content-Type: application/json
{
"additional_completion_time": {
"duration": "5",
"uot": "MINUTES"
},
"organisation": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "Good Burgers"
},
"pending_orders": {
"minimum": 1,
"maximum": 10
},
"pending_items": {
"minimum": 10,
"maximum": 22
},
"product_conditions": [
{
"item_type": "TYPE",
"iid": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "Coffee",
"SKU": "COFFEE"
}
],
"timing_conditions": [
{
"day_of_week": "MONDAY",
"start_time": "09:00",
"end_time": "11:00"
}
]
}
HTTP/1.1 200 OK {id}Delete an existing order completion rule
Path variables
Order Completion Rule identifier
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
DELETE https://sandbox.crm.com/backoffice/v2/orders/completion_rules/4dc0809f-ed91-4b68-b912-5bd6064d901e HTTP/1.1
HTTP/1.1 204 No Content Generic settings for passes
Get the generic settings for financial passes
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Successful Request
Body
Pass code hashing details
Is pass code hashing enabled?
Hashing algorithm (if hashing is enabled)
GET https://sandbox.crm.com/backoffice/v1/pass_settings HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"pass_code_hashing": {
"is_enabled": "true",
"algorithm": "SHA-1"
}
}Update generic financial pass settings
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Pass code hashing details
Is pass code hashing enabled?
Hashing algorithm (if hashing is enabled)
Responses
PUT https://sandbox.crm.com/backoffice/v1/pass_settings HTTP/1.1
Content-Type: application/json
{
"pass_code_hashing": {
"is_enabled": "true",
"algorithm": "SHA-1"
}
}Platform enables the ability to configure system settings applicable across the software
Set (generic) platform settings that will be applicable across the software
Notes
Timezone defines the local time that the business operates in.
Countries of agreement defines the countries that a business operates in (multi-regional business) and are assigned on contacts during their registration - based on a contry of agreement a business can target specific reward offers or segment contacts.
Communication languages can be configured per business and are used for sending a communication content in different languages (based on contact’s preferred communication language).
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The timezone of the organisation (applicable for business organisations)
The languages that can be used in communications and content translations
Defines the countries that will be assigned on a contact during registration
Defines whether the country is the default one or not
List of supported currencies per Country of agreement used in cases where a business requires different currency options per operating country. If nothing is specified, then contacts of this Country of agremeent can have accounts in any of the supported currencies of the business, having the business base currency applied on creating a default account. If currencies are set, then contacts of this country can only hav accounts in currencies of this restrictive list. The set of currencies must include only the business’s supported currencies.
One (and only one) currency must be marked as the default one
Responses
PUT https://sandbox.crm.com/backoffice/v2/platform/settings HTTP/1.1
Content-Type: application/json
{
"timezone": "EUROPE/ATHENS",
"content_languages": [
"EN"
],
"agreement_countries": [
{
"country_code": "CYP",
"is_default": true,
"currencies": [
{
"currency_code": "EUR",
"is_default": "true"
}
]
}
]
}
HTTP/1.1 200 OK Get (generic) platform settings that are applicable across the software
Notes
Timezone defines the local time that the business operates in.
Countries of agreement defines the countries that a business operates in (multi-regional business) and are assigned on contacts during their registration - based on a contry of agreement a business can target specific reward offers or segment contacts.
Software languages is a pre-defined list of languages that the CRM.COM back-end SPA can be translated into and each user can select the preferred software language. Such languages cannot be configured and come our of the box.
Communication languages can be configured per business and are used for sending a communication content in different languages (based on contact’s preferred communication language).
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The organisation timezone
The languages that the back-end software can be translated to
The languages that can be used in communications and content translations
Defines a contact’s Country of Agreement that could be assigned on contact registration. One of them (and only one) must be specified as the default i.e. the base Country of agreement that usually represents the Business’s base country
Defines whether the country is the default one or not
List of supported currencies per Country of agreement used in cases where a business requires different currency options per operating country. If nothing is specified, then contacts of this Country of agremeent can have accounts in any of the supported currencies of the business, having the business base currency applied on creating a default account. If currencies are set, then contacts of this country can only hav accounts in currencies of this restrictive list. The set of currencies must include only the business’s supported currencies.
One (and only one) currency must be marked as the default one
GET https://sandbox.crm.com/backoffice/v2/platform/settings HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"timezone": "EUROPE/ATHENS",
"software_languages": [
"GR"
],
"content_languages": [
"EN"
],
"agreement_countries": [
{
"country_code": "CYP",
"is_default": "true",
"currencies": [
{
"currency_code": "EUR",
"is_default": "true"
}
]
}
]
}Applications provided by CRM.COM is an ultra modern approach to enabling contacts to register, earn and keep track of their loyalty progress, view reward offers, place online orders and view & manage their subscriptions
{id}{id}{id}Create a new application
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The application name
The application description
The application type
Mobile Contact Applications
Mobile Merchant Applications
Web Portal
Captive Portal
The application appearance settings
The application color style
Defines the component on which the color will be applied
The color (hex) code
The application text font style
Defines the component on which the font will be applied
The text font style that the app will use
The colour scheme of the app
The application type
JSON script contaning specific mapping of existing colour settings to particular elements of the app. Used in special circumstances to allow fine tuning of colour mapping without the need to rebuild the app. This is maintatined solely by CRMI and is not visible on the back-end UI.
The application feature settings
Details about the features that will be supported by the app
Defines the supported business network features
Defines whether business network features should be available
Defines whether multitenancy features will be available
Defines whether multitenancy is supported
Defines the supported contact features
How the contact code will be depicted on the app/portal, for scanning purposes
As a barcode
As a QR code
Defines whether app will prompt contacts to link their past loyalty account with CRM
Defines whether communities (relationships between contacts) features will be available
Defines whether communities is supported
Defines the details that a contact can provide
The contact detail
Defines if such detail is supported or not
Defines the supported crm features
Defines whether contact features should be available
Defines the supported service request features
Defines whether contacts will be able to create service requests
Defines whether and which service request queue, contacts will be able to select
The service request queue identifier
Defines the supported finance features
Defines whether finance features should be available
Defines whether contacts will be able to top up their wallets
Defines the supported redeem pass features
Defines whether contacts will be able to redeem a pass
Defines whether pass redemption should be supported by other attributes
The type of supplementary attribute
Defines the supported ordering features
Defines whether order features should be available
Defines whether pick up is supported as supply method
Defines whether delivery is supported as supply method
Defines whether direct sale is supported as supply method
Defines whether contact can set preferred organisation for ordering
Defines the countries where orders can be made
The country (code)
Defines a list of order catalogs that should filter available products to order
The order catalog identifier
Defines the wallet funds features
Defines whether contact can pay for order using wallet funds
Defines whether contacts can specific the wallet funds amount to use on orders
Defines whether the wallet fund amount must cover the full basket amount
Defines the supported rewards features
Defines whether reward features should be available
Defines whether reward tiering will be supported
Defines whether contact can select his/her preferred organisation for rewards
Defines the supported refer a friend features
Defines whether refer a friend will be supported
Defines the communication method that should be used for refer a friend (required when refer a friend is enabled)
Defines the supported OTP spend features
Defines whether OTP spend will be supported
Defines the supplementary attributes that will be supported for OTP spends (required when OTP spend is enabled)
The type of supplementary attribute
Defines the supported contact self-submit purchase events features
Defines whether contact can self-submit purchase events
Defines how self-submit (reclaim) purchase identification will be made (required when contact self-submit purchase is enabled)
Defines the supported marketing content features
Defines whether marketing content should be available
Define links for embedded browser in front-end systems
Defines the title of the link
Defines the URL of the link
The creative identifier
Information about the creative type
Partner logos configurable by SO, applicable for Business, Merchant, Venue
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
The creative width
The creative height
The creative format
The creative content URL
The creative public identifier
Information about the creative transformations
The transformed creative width
The transformed creative height
The transformed creative URL
Defines the supported mobile pass features
Defines whether mobile pass should be available
The features that will be supported by the application
Defines the supported reward features
Defines whether reward features should be available
Defines the supported purchase event features
Defines whether merchants can submit purchase events
Defines whether the merchant app supports submission of spend requests
Defines whether the purchase will be posted successfully only if requested spend amount fully covers the purchase amount
The application authentication settings, i.e. how contacts can register and sign-in
Defines whether contacts can register & sign-in based on email and password
Defines whether contacts can register & sign-in based on email and one-time password
Defines whether contacts can register & sign-in based on phone and one-time password
Defines whether contacts can register & sign-in based on Facebook (including Facebook authentication details)
Defines whether Facebook authentication is enabled or not
The Facebook App ID required for Google authentication (required when Facebook Auth is enabled)
The Facebook App Secret for Server-to-Server communication (must not be sent to client) (required when Facebook Auth is enabled)
Defines whether contacts can register & sign-in based on Google (including Google authentication details)
Defines whether Google authentication is supported or not
The Google App ID required for Google authentication (required when Google Auth is enabled)
The Google App Secret for Server-to-Server communication (must not be sent to client) (required when Google Auth is enabled)
The contact assigned as demo contact (used for app store verification purposes)
Defines whether demo contact is supported or not
The contact (identifier) that will be assigned as demo contact (required only if demo contact is enabled)
The one-time password that will be accepted for sign-in purposes (required only if demo contact is enabled)
Defines whether contacts will be able to manager their authentication details
Defiens whether contact will be able to add new authentication details
Defiens whether contact will be able to update existing authentication details
Defiens whether contact will be able to delete existing authentication details
The application platform identifiers (e.g. operating platform, version, cloud name)
The platform on which the application will be published
The platform identifier on which such application is published (applicable for native mobile applications)
The cloud name on which such application is published (applicable for browser based applications)
The application version
The application “about” settings (e.g. terms & conditions, FAQs)
The application content information
The content type
About
Terms & Conditions
Privacy Policy
Frequently-Asked Questions
The detail URL endpoint (URL or Content is required)
The detail rich content (URL or Content is required)
The application “contact us” details
The contact email address
The phone number
The contact website (URL endpoint)
Responses
The request has succeeded
Body
The application identifier
POST https://sandbox.crm.com/backoffice/v2/applications HTTP/1.1
Content-Type: application/json
{
"name": "Brew Coffee",
"description": "Best coffee application",
"type": "NATIVE",
"appearance": {
"colors": [
{
"type": "SCREEN_BUTTON",
"value": "#eb4034"
}
],
"fonts": [
{
"type": "TEXT",
"font": "Roboto"
}
],
"dark_mode": true,
"homepage_layout": "LAYOUT1",
"advanced_colour_mapping": "let appearance = { main_color: '#ffffff', //landing_page.text_color, landing_page.button_text_color, main_page.card_text_color, main_page.icon_color, side_bar.text_color, side_bar.icon_color, tab_bar.background_color button_color: '#50e3c2',//landing_page.button_color, main_page.button_color, main_page.button_selected, side_bar.background_color, tab_bar.selected, card_color: '#F0F0F3', //main_page.button_unselected, main_page.card_bg_color, main_page.input_background_color background_color: '#d32166', //landing_page.background_color text_normal_color: '#212121', //main_page.text_label_color, main_page.input_label_color text_main_color: '#03041D', //main_page.button_unselected_text_color, main_page.text_color, main_page.text_title_color, main_page.card_icon_color, main_page.input_text_color border_color: 'rgba(3, 4, 29, 0.16)', //main_page.border_button_color, main_page.border_input_color, tab_bar.unselected, darkmode_color: '#212121', //background pages when dark_mode = true darkmode_text: '#ffffff', //main_page.text_color }"
},
"features": {
"contact": {
"business_network": {
"is_supported": true,
"multitenancy": {
"is_supported": "true"
}
},
"contact": {
"code_representation": "BARCODE",
"existing_contacts": "false",
"people": {
"is_supported": "true"
},
"profile": [
{
"type": "GENDER",
"is_supported": "true"
}
]
},
"crm": {
"is_supported": true,
"service_requests": {
"is_supported": true,
"supported_queues": [
{
"id": "8237416b-ecca-769a-a38a-293320b0ffdf"
}
]
}
},
"finance": {
"is_supported": true,
"wallet_top_up": "true",
"redeem_pass": {
"is_supported": "false",
"pass_attributes": [
{
"type": "VALUE"
}
]
}
},
"order": {
"is_supported": true,
"pick_up": true,
"delivery": true,
"direct_sale": true,
"preferred_organisation": "true",
"order_countries": [
{
"country": "CYP"
}
],
"order_catalogs": [
{
"id": "676055d9-fe79-6836-8a50-c2d3764e9919"
}
],
"use_wallet_funds": {
"is_supported": "false",
"specific_funds_amount": "false",
"cover_full_basket": "false"
}
},
"reward": {
"is_supported": "true",
"tiering": "true",
"preferred_organisation": "true",
"refer_friend": {
"is_supported": "true",
"refer_methods": [
"EMAIL"
]
},
"otp_spend": {
"is_supported": "true",
"spend_attributes": [
{
"type": "AMOUNT"
}
]
},
"self_submit_purchases": {
"is_supported": "true",
"self_submit_methods": [
"BARCODE"
]
}
},
"marketing": {
"is_supported": true,
"embedded_links": [
{
"title": "New and upcoming events",
"url": "https://www.guababechbar.com/news&events",
"creatives": [
{
"id": "3caf8388-b9c6-6679-1e9b-94a6fda92a41",
"usage_type": "WALLET_IMAGE",
"width": 2159,
"height": 3075,
"format": "jpg",
"url": "https://assets.crm.com/image/logo.jpg",
"public_id": "crm-com/image",
"media": [
{
"width": 200,
"height": 300,
"url": "https://asset.crm.com/image/offer/c_scale,w_200/logo.jpg"
}
]
}
]
}
]
},
"mobile_pass": {
"is_supported": "true"
}
},
"merchant": {
"reward": {
"is_supported": true,
"purchase": {
"is_supported": "true",
"allow_spend": "false",
"restrict_fully_covered": "true"
}
}
}
},
"authentication": {
"email_password": true,
"email_otp": "true",
"sms_otp": true,
"facebook": {
"is_supported": "true",
"app_id": "dsf-w-f-esf-23f-w-eff2f",
"app_secret": "qqsdf-23-we-wer-3ew-qq"
},
"google": {
"is_supported": "true",
"app_id": "dsf-w-f-esf-23f-w-eff2f",
"app_secret": "qqsdf-23-we-wer-3ew-qq"
},
"demo_contact": {
"is_supported": "true",
"contact_id": "17e32149-1da4-6a55-456e-8874b7afac56",
"otp": "123456"
}
},
"platforms": [
{
"platform": "GOOGLE",
"platform_id": "1762e052-4805-73eb-36f2-e77d6dc883e8",
"cloud_name": "",
"version": "1.1"
}
],
"information": {
"content": [
{
"type": "ABOUT",
"url": "https?/crm.com",
"rich_content": "Terms & Conditions"
}
],
"contact_us": {
"email_address": "info@crm.com",
"phone": {
"country_code": "CYP",
"number": "99123456",
"type": "LANDLINE"
},
"website": "https://crm.com"
}
}
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "118e64a6-85ad-413a-b6a1-9aeffd678ef3"
}{id}Update an existing application
Path variables
The application (identifier) that will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The application name
The application description
The application appearance settings
The application color style
Defines the component on which the color will be applied
The color (hex) code
The application text font style
Defines the component on which the font will be applied
The text font style that the app will use
The colour scheme of the app
The application type
JSON script contaning specific mapping of existing colour settings to particular elements of the app. Used in special circumstances to allow fine tuning of colour mapping without the need to rebuild the app. This is maintatined solely by CRMI and is not visible on the back-end UI.
The application feature settings
Details about the features that will be supported by the app
Defines the supported business network features
Defines whether business network features should be available
Defines whether multitenancy features will be available
Defines whether multitenancy is supported
Defines the supported contact features
How the contact code will be depicted on the app/portal, for scanning purposes
As a barcode
As a QR code
Defines whether app will prompt contacts to link their past loyalty account with CRM
Defines whether communities (relationships between contacts) features will be available
Defines whether communities is supported
Defines the details that a contact can provide
The contact detail
Defines if such detail is supported or not
Defines the supported crm features
Defines whether contact features should be available
Defines the supported service request features
Defines whether contacts will be able to create service requests
Defines whether and which service request queue, contacts will be able to select
The service request queue identifier
Defines the supported finance features
Defines whether finance features should be available
Defines whether contacts will be able to top up their wallets
Defines the supported redeem pass features
Defines whether contacts will be able to redeem a pass
Defines whether pass redemption should be supported by other attributes
The type of supplementary attribute
Defines the supported ordering features
Defines whether order features should be available
Defines whether pick up is supported as supply method
Defines whether delivery is supported as supply method
Defines whether direct sale is supported as supply method
Defines whether contact can set preferred organisation for ordering
Defines the countries where orders can be made
The country (code)
Defines a list of order catalogs that should filter available products to order
The order catalog identifier
Defines the wallet funds features
Defines whether contact can pay for order using wallet funds
Defines whether contacts can specific the wallet funds amount to use on orders
Defines whether the wallet fund amount must cover the full basket amount
Defines the supported rewards features
Defines whether reward features should be available
Defines whether reward tiering will be supported
Defines whether contact can select his/her preferred organisation for rewards
Defines the supported refer a friend features
Defines whether refer a friend will be supported
Defines the communication method that should be used for refer a friend (required when refer a friend is enabled)
Defines the supported OTP spend features
Defines whether OTP spend will be supported
Defines the supplementary attributes that will be supported for OTP spends (required when OTP spend is enabled)
The type of supplementary attribute
Defines the supported contact self-submit purchase events features
Defines whether contact can self-submit purchase events
Defines how self-submit (reclaim) purchase identification will be made (required when contact self-submit purchase is enabled)
Defines the supported marketing content features
Defines whether marketing content should be available
Define links for embedded browser in front-end systems
Defines the title of the link
Defines the URL of the link
The creative identifier
Information about the creative type
Partner logos configurable by SO, applicable for Business, Merchant, Venue
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
The creative width
The creative height
The creative format
The creative content URL
The creative public identifier
Information about the creative transformations
The transformed creative width
The transformed creative height
The transformed creative URL
Defines the supported mobile pass features
Defines whether mobile pass should be available
The features that will be supported by the application
Defines the supported reward features
Defines whether reward features should be available
Defines the supported purchase event features
Defines whether merchants can submit purchase events
Defines whether the merchant app supports submission of spend requests
Defines whether the purchase will be posted successfully only if requested spend amount fully covers the purchase amount
The application authentication settings, i.e. how contacts can register and sign-in
Defines whether contacts can register & sign-in based on email and password
Defines whether contacts can register & sign-in based on email and one-time password
Defines whether contacts can register & sign-in based on phone and one-time password
Defines whether contacts can register & sign-in based on Facebook (including Facebook authentication details)
Defines whether Facebook authentication is enabled or not
The Facebook App ID required for Google authentication (required when Facebook Auth is enabled)
The Facebook App Secret for Server-to-Server communication (must not be sent to client) (required when Facebook Auth is enabled)
Defines whether contacts can register & sign-in based on Google (including Google authentication details)
Defines whether Google authentication is supported or not
The Google App ID required for Google authentication (required when Google Auth is enabled)
The Google App Secret for Server-to-Server communication (must not be sent to client) (required when Google Auth is enabled)
The contact assigned as demo contact (used for app store verification purposes)
Defines whether demo contact is supported or not
The contact (identifier) that will be assigned as demo contact (required only if demo contact is enabled)
The one-time password that will be accepted for sign-in purposes (required only if demo contact is enabled)
Defines whether contacts will be able to manager their authentication details
Defiens whether contact will be able to add new authentication details
Defiens whether contact will be able to update existing authentication details
Defiens whether contact will be able to delete existing authentication details
The application platform identifiers (e.g. operating platform, version, cloud name)
The platform on which the application will be published
The platform identifier on which such application is published (applicable for native mobile applications)
The cloud name on which such application is published (applicable for browser based applications)
The application version
The application “about” settings (e.g. terms & conditions, FAQs)
The application content information
The content type
About
Terms & Conditions
Privacy Policy
Frequently-Asked Questions
The detail URL endpoint (URL or Content is required)
The detail rich content (URL or Content is required)
The application “contact us” details
The contact email address
The phone number
The contact website (URL endpoint)
Responses
The request has succeeded
Body
The application identifier
PUT https://sandbox.crm.com/backoffice/v2/applications/5fd79941-e4ce-e6b9-2a3c-b455e3fb0220 HTTP/1.1
Content-Type: application/json
{
"name": "Brew Coffee",
"description": "Best coffee application",
"appearance": {
"colors": [
{
"type": "SCREEN_CARD",
"value": "#eb4034"
}
],
"fonts": [
{
"type": "TEXT",
"font": "Roboto"
}
],
"dark_mode": true,
"homepage_layout": "LAYOUT2",
"advanced_colour_mapping": "let appearance = { main_color: '#ffffff', //landing_page.text_color, landing_page.button_text_color, main_page.card_text_color, main_page.icon_color, side_bar.text_color, side_bar.icon_color, tab_bar.background_color button_color: '#50e3c2',//landing_page.button_color, main_page.button_color, main_page.button_selected, side_bar.background_color, tab_bar.selected, card_color: '#F0F0F3', //main_page.button_unselected, main_page.card_bg_color, main_page.input_background_color background_color: '#d32166', //landing_page.background_color text_normal_color: '#212121', //main_page.text_label_color, main_page.input_label_color text_main_color: '#03041D', //main_page.button_unselected_text_color, main_page.text_color, main_page.text_title_color, main_page.card_icon_color, main_page.input_text_color border_color: 'rgba(3, 4, 29, 0.16)', //main_page.border_button_color, main_page.border_input_color, tab_bar.unselected, darkmode_color: '#212121', //background pages when dark_mode = true darkmode_text: '#ffffff', //main_page.text_color }"
},
"features": {
"contact": {
"business_network": {
"is_supported": true,
"multitenancy": {
"is_supported": "true"
}
},
"contact": {
"code_representation": "BARCODE",
"existing_contacts": "false",
"people": {
"is_supported": "true"
},
"profile": [
{
"type": "GENDER",
"is_supported": "true"
}
]
},
"crm": {
"is_supported": true,
"service_requests": {
"is_supported": true,
"supported_queues": [
{
"id": "8237416b-ecca-769a-a38a-293320b0ffdf"
}
]
}
},
"finance": {
"is_supported": true,
"wallet_top_up": "true",
"redeem_pass": {
"is_supported": "false",
"pass_attributes": [
{
"type": "VALUE"
}
]
}
},
"order": {
"is_supported": true,
"pick_up": true,
"delivery": true,
"direct_sale": true,
"preferred_organisation": "true",
"order_countries": [
{
"country": "CYP"
}
],
"order_catalogs": [
{
"id": "676055d9-fe79-6836-8a50-c2d3764e9919"
}
],
"use_wallet_funds": {
"is_supported": "false",
"specific_funds_amount": "false",
"cover_full_basket": "false"
}
},
"reward": {
"is_supported": "true",
"tiering": "true",
"preferred_organisation": "true",
"refer_friend": {
"is_supported": "true",
"refer_methods": [
"EMAIL"
]
},
"otp_spend": {
"is_supported": "true",
"spend_attributes": [
{
"type": "AMOUNT"
}
]
},
"self_submit_purchases": {
"is_supported": "true",
"self_submit_methods": [
"BARCODE"
]
}
},
"marketing": {
"is_supported": true,
"embedded_links": [
{
"title": "New and upcoming events",
"url": "https://www.guababechbar.com/news&events",
"creatives": [
{
"id": "3caf8388-b9c6-6679-1e9b-94a6fda92a41",
"usage_type": "ATTACHMENT",
"width": 2159,
"height": 3075,
"format": "jpg",
"url": "https://assets.crm.com/image/logo.jpg",
"public_id": "crm-com/image",
"media": [
{
"width": 200,
"height": 300,
"url": "https://asset.crm.com/image/offer/c_scale,w_200/logo.jpg"
}
]
}
]
}
]
},
"mobile_pass": {
"is_supported": "true"
}
},
"merchant": {
"reward": {
"is_supported": true,
"purchase": {
"is_supported": "true",
"allow_spend": "false",
"restrict_fully_covered": "true"
}
}
}
},
"authentication": {
"email_password": true,
"email_otp": "true",
"sms_otp": true,
"facebook": {
"is_supported": "true",
"app_id": "dsf-w-f-esf-23f-w-eff2f",
"app_secret": "qqsdf-23-we-wer-3ew-qq"
},
"google": {
"is_supported": "true",
"app_id": "dsf-w-f-esf-23f-w-eff2f",
"app_secret": "qqsdf-23-we-wer-3ew-qq"
},
"demo_contact": {
"is_supported": "true",
"contact_id": "17e32149-1da4-6a55-456e-8874b7afac56",
"otp": "123456"
}
},
"platforms": [
{
"platform": "WEB",
"platform_id": "1762e052-4805-73eb-36f2-e77d6dc883e8",
"cloud_name": "",
"version": "1.1"
}
],
"information": {
"content": [
{
"type": "ABOUT",
"url": "https?/crm.com",
"rich_content": "Terms & Conditions"
}
],
"contact_us": {
"email_address": "info@crm.com",
"phone": {
"country_code": "CYP",
"number": "99123456",
"type": "LANDLINE"
},
"website": "https://crm.com"
}
}
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "5fd79941-e4ce-e6b9-2a3c-b455e3fb0220"
}{id}Delete an existing application
Path variables
The application (identifer) that will be deleted
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
DELETE https://sandbox.crm.com/backoffice/v2/applications/eac1f771-2608-85c1-9289-08abb5c1d7a0 HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 204 No Content Retrieve a list of applications based on search criteria (e.g. all native applications)
Request parameters
Filters based on application name (behave as like)
Filters based on application type
Filter based on platform application identifier
Filter based on cloud name (behave as like)
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The application identifier
The application name
The application description
The application type
Mobile Contact Applications
Mobile Merchant Applications
Web Portal
Captive Portal
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/applications HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "6d2652b7-9b8d-6174-65c3-c3fefc87e8cd",
"name": "Coffee App",
"description": "Best coffee app description",
"type": "CAPTIVE"
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Retrieve detailed information for an application
Path variables
The application (identifer) that will be returned
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The application identifier
The application name
The application description
The application type
Mobile Contact Applications
Mobile Merchant Applications
Web Portal
Captive Portal
The application appearance settings
The application color style
Defines the component on which the color will be applied
The color (hex) code
The application text font style
Defines the component on which the font will be applied
The text font style that the app will use
The colour scheme of the app
The application type
Details about the features that will be supported by the app
Details about the features that will be supported by the app
Defines the supported contact features
How the contact code will be depicted on the app/portal, for scanning purposes
As a barcode
As a QR code
Defines whether contacts will be prompted to connect their past loyalty account to CRM
Defines the details that a contact can provide
The contact detail
Defines if such detail is supported or not
Defines whether communities (relationships between contacts) features will be available
Defines whether communities is supported
Defines the supported business network features
Defines whether business network features should be available
Defines whether multitenancy features will be available
Defines whether multitenancy is supported
Defines the supported crm features
Defines whether contact features should be available
Defines the supported service request features
Defines whether contacts will be able to create service requests
Defines whether and which service request queues, contacts will be able to select
The queue identifier
The queue name
Defines the supported finance features
Defines whether finance features should be available
Defines whether contacts will be able to top up their wallets
Defines the supported redeem pass features
Defines whether contacts will be able to redeem a pass
Defines whether pass redemption should be supported by other attributes
The type of supplementary attribute
Defines the supported ordering features
Defines whether order features should be available
Defines whether pick up is supported as supply method
Defines whether delivery is supported as supply method
Defines whether direct sale is supported as supply method
Defines whether contacts will be able to select from which location an order will be placed (via a list of merchants/venues) or not
Ability to select location
Location won’t be selectable
Defines whether contact can set preferred organisation for ordering
Defines the countries where orders can be made
The country (code)
Defines a list of order catalogs that should filter available products to order
The order catalog identifier
The order catalog name
Defines whether contact can pay for order using wallet funds
Defines whether contact can pay for orders using wallet funds
Defines whether contacts can specific the wallet funds amount to use on orders
Defines whether the wallet fund amount must cover the full basket amount
Defines the supported rewards features
Defines whether reward features should be available
Defines whether reward tiering will be supported
Defines whether contact can select his/her preferred organisation for rewards
Defines the supported refer a friend features
Defines whether refer a friend will be supported
Defines the communication method that should be used for refer a friend (required when refer a friend is enabled)
Defines the supported OTP spend features
Defines whether OTP spend will be supported
Defines the supplementary attributes that will be supported for OTP spends (required when OTP spend is enabled)
The type of supplementary attribute
Defines the supported contact self-submit purchase events features
Defines whether contact can self-submit purchase events
Defines how self-submit (reclaim) purchase identification will be made (required when contact self-submit purchase is enabled)
Defines the supported marketing content features
Defines whether marketing content should be available
Define links for embedded browser in front-end systems
Defines the title of the link
Defines the URL of the link
The creative identifier
Information about the creative type
Partner logos configurable by SO, applicable for Business, Merchant, Venue
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
The creative width
The creative height
The creative format
The creative content URL
The creative public identifier
Information about the creative transformations
The transformed creative width
The transformed creative height
The transformed creative URL
Defines the supported mobile pass features
Defines whether mobile pass should be available
The features that will be supported by the application
Defines the supported reward features
Defines whether reward features should be available
Defines the supported purchase event features
Defines whether merchants can submit purchase events
Defines whether the merchant app supports submission of spend requests
Defines whether the purchase will be posted successfully only if requested spend amount fully covers the purchase amount
The application authentication settings, i.e. how contacts can register and sign-in
Defines whether contacts can register & sign-in based on email and password
Defines whether contacts can register & sign-in based on email and one-time password
Defines whether contacts can register & sign-in based on phone and one-time password
Defines whether contacts can register & sign-in based on Facebook (including Facebook authentication details)
Defines whether Facebook authentication is enabled or not
The App ID required for Facebbok authentication (required when Facebook Auth is enabled)
The Facebook App Secret for Server-to-Server communication (must not be sent to client) (required when Facebook Auth is enabled)
Defines whether contacts can register & sign-in based on Google (including Google authentication details)
Defines whether Google authentication is supported or not
The Google App ID required for Google authentication (required when Google Auth is enabled)
The Google App Secret for Server-to-Server communication (must not be sent to client) (required when Google Auth is enabled)
The contact assigned as demo contact (used for app store verification purposes)
Defines whether demo contact is supported or not
The (demo) contact (required only if demo contact is enabled)
The (demo) contact identifier
The (demo) contact full name
The one-time password that will be accepted for sign-in purposes (required only if demo contact is enabled)
Defines whether contacts will be able to manage their authentication details
Defiens whether contact will be able to add new authentication details
Defiens whether contact will be able to update existing authentication details
Defiens whether contact will be able to delete existing authentication details
The application platform identifiers (e.g. operating platform, version, cloud name)
The platform on which the application will be published
The platform identifier on which such application is published (applicable for native mobile applications)
The cloud name on which such application is published (applicable for browser based applications)
The application version
The application “about” settings (e.g. terms & conditions, FAQs)
The application content information
The content type
About
Terms & Conditions
Privacy Policy
Frequently-Asked Questions
The detail URL endpoint (URL or Content is required)
The detail rich content (URL or Content is required)
The application “contact us” details
The contact email address
The phone number
The contact website (URL endpoint)
The creative identifier
Information about the creative type
Partner logos configurable by SO, applicable for Business, Merchant, Venue
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
The creative width
The creative height
The creative format
The creative content URL
The creative public identifier
Information about the creative transformations
The transformed creative width
The transformed creative height
The transformed creative URL
GET https://sandbox.crm.com/backoffice/v2/applications/bd909bd2-2397-8af8-b256-87e496620209 HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "bd909bd2-2397-8af8-b256-87e496620209",
"name": "Brew Coffee App",
"description": "Best coffee app",
"type": "WEB",
"appearance": {
"colors": [
{
"type": "LANDING_TEXT",
"value": "#eb4034"
}
],
"fonts": [
{
"type": "TEXT",
"font": "Gilroy"
}
],
"dark_mode": true,
"homepage_layout": "LAYOUT3"
},
"features": {
"contact": {
"contact": {
"code_representation": "BARCODE",
"existing_contact": "false",
"profile": [
{
"type": "NAMEDAY",
"is_supported": "true"
}
],
"people": {
"is_supported": "false"
}
},
"business_network": {
"is_supported": true,
"multitenancy": {
"is_supported": "true"
}
},
"crm": {
"is_supported": true,
"service_requests": {
"is_supported": true,
"supported_queues": [
{
"id": "848f9c93-e95f-4188-55fb-bb51326f66d5",
"name": "Customer Support"
}
]
}
},
"finance": {
"is_supported": true,
"wallet_top_up": "true",
"redeem_pass": {
"is_supported": "false",
"pass_attributes": [
{
"type": "CODE"
}
]
}
},
"order": {
"is_supported": true,
"pick_up": true,
"delivery": true,
"direct_sale": true,
"model": "SINGLE_BUSINESS",
"preferred_organisation": "true",
"order_countries": [
{
"country": "CYP"
}
],
"order_catalogs": [
{
"id": "676055d9-fe79-6836-8a50-c2d3764e9919",
"name": "Network Products"
}
],
"use_wallet_funds": {
"is_supported": "true",
"specific_funds_amount": "true",
"cover_full_basket": "true"
}
},
"reward": {
"is_supported": "true",
"tiering": "true",
"preferred_organisation": "true",
"refer_friend": {
"is_supported": "true",
"refer_methods": [
"SMS"
]
},
"otp_spend": {
"is_supported": "true",
"spend_attributes": [
{
"type": "AMOUNT"
}
]
},
"self_submit_purchases": {
"is_supported": "true",
"self_submit_methods": [
"TRX_CODE"
]
}
},
"marketing": {
"is_supported": true,
"embedded_links": [
{
"title": "New and upcoming events",
"url": "https://www.guababechbar.com/news&events",
"creatives": [
{
"id": "3caf8388-b9c6-6679-1e9b-94a6fda92a41",
"usage_type": "MARKETING",
"width": 2159,
"height": 3075,
"format": "jpg",
"url": "https://assets.crm.com/image/logo.jpg",
"public_id": "crm-com/image",
"media": [
{
"width": 200,
"height": 300,
"url": "https://asset.crm.com/image/offer/c_scale,w_200/logo.jpg"
}
]
}
]
}
]
},
"mobile_pass": {
"is_supported": "false"
}
},
"merchant": {
"reward": {
"is_supported": true,
"purchase": {
"is_supported": "true",
"allow_spend": "false",
"restrict_fully_covered": "true"
}
}
}
},
"authentication": {
"email_password": true,
"email_otp": "true",
"sms_otp": true,
"facebook": {
"is_supported": "true",
"app_id": "dsf-w-f-esf-23f-w-eff2f",
"app_secret": "qqsdf-23-we-wer-3ew-qq"
},
"google": {
"is_supported": "true",
"app_id": "dsf-w-f-esf-23f-w-eff2f",
"app_secret": "qqsdf-23-we-wer-3ew-qq"
},
"demo_contact": {
"is_supported": "true",
"contact": {
"id": "76ee374d-cd38-4cde-9fa3-4eaa26e67a06",
"name": "John Doe"
},
"otp": "123456"
}
},
"platforms": [
{
"platform": "WEB",
"platform_id": "1762e052-4805-73eb-36f2-e77d6dc883e8",
"cloud_name": "",
"version": "1.1"
}
],
"information": {
"content": [
{
"type": "FAQS",
"url": "https?/crm.com",
"rich_content": "Terms & Conditions"
}
],
"contact_us": {
"email_address": "info@crm.com",
"phone": {
"country_code": "CYP",
"number": "99123456",
"type": "LANDLINE"
},
"website": "https://crm.com"
}
},
"creatives": [
{
"id": "3caf8388-b9c6-6679-1e9b-94a6fda92a41",
"usage_type": "GOOGLE_LOGO_IMAGE",
"width": 2159,
"height": 3075,
"format": "jpg",
"url": "https://assets.crm.com/image/logo.jpg",
"public_id": "crm-com/image",
"media": [
{
"width": 200,
"height": 300,
"url": "https://asset.crm.com/image/offer/c_scale,w_200/logo.jpg"
}
]
}
]
}{id}/media_groups{id}/media_groupsLink an application with one or more media groups
Path variables
The application (identifier) that media groups will be set
Notes
Uploading media for an application requires the execution of the following APIs
- Create new Media Group
- Create Application Media Groups
- Upload Media
- Perform Cloudinary Upload (where CRM will send all signature details)
- Cloudinary service calls back CRM media group (using an internal callback)
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The media group identifier
Responses
POST https://sandbox.crm.com/backoffice/v2/applications/6A24D2B5E44F44B28451FE021FCAD51E/media_groups HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
[
{
"media_group_id": "3f1f9e63-7f40-4e5e-bc42-11a162f7f1fb"
}
]
HTTP/1.1 204 No Content {id}/translations{id}/translations{id}/translations/actions{id}/translationsUpdate the content translations for an existing application
Path variables
The application (identifier) of which content translations will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The content translations for the specified language
The content (attribute) key
The content (attribute) translated value
Responses
The request has succeeded
PUT https://sandbox.crm.com/backoffice/v2/applications/a42dd7c4-e755-92fb-963b-5f658a59908e/translations HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
[
{
"language_code": "EN",
"translations": [
{
"key": "name",
"value": "10% cashback return"
}
]
}
]
HTTP/1.1 204 No Content {id}/translationsRetrieve the content translations for an existing application
Path variables
The application (identifier) of which content translations will be retrieved
Request parameters
Filter based on language
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The content translations for the specified language
The content (attribute) key
The content (attribute) translated value
GET https://sandbox.crm.com/backoffice/v2/applications/a42dd7c4-e755-92fb-963b-5f658a59908e/translations HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"language_code": "EN",
"translations": [
{
"key": "name",
"value": "10% cashback return"
}
]
}
]
}{id}/translations/actionsPerform content translation actions on an application (e.g. export an application’s translations)
Path variables
The application (identifier) of which content translation actions will be performed
Notes
Importing content translations should be made based on the following API order
Exporting content translations into different file should be made using the following API order
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The action that will be applied
The file (identifier) that will be used for importing translations (required only for import action)
The file (identifier) that will be used for importing translations (required only for import action)
The file (mime type) that will be used for exporting translations (required only for export action)
Responses
The request has succeeded
PUT https://sandbox.crm.com/backoffice/v2/applications/a42dd7c4-e755-92fb-963b-5f658a59908e/translations/actions HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"action": "IMPORT",
"file": {
"id": "1e347d4d-ab96-6957-fdb6-35e72b3d9185"
}
}
HTTP/1.1 204 No Content PUT https://sandbox.crm.com/backoffice/v2/applications/a42dd7c4-e755-92fb-963b-5f658a59908e/translations/actions HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"action": "EXPORT",
"file": {
"mime": "json"
}
}
HTTP/1.1 204 No Content List of basic activities of the signed up Business
Retrieve a list of business activities based on search criteria (e.g. all business activities)
Notes
Business Activities can be assigned against organisations only
Request parameters
Filter based on business activity name (behaves as a like)
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The business activity identifier
The business activity name
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/business_activities HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "c101c49a-5d47-8264-c82d-5eee9fe1236f",
"name": "Information Services"
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}Copyright notice informs the public regarding the platform’s copyright ownership. Such notice can be configured only on the Cloud Operator level and will be applied throughout the software.
Returns the copyright notice of the software
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The copyright text
GET https://sandbox.crm.com/backoffice/v2/copyright_notice HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"copyright_text": "CRM.COM Software 2005-2021"
}Update the copyright notice
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The actual copyright text
Responses
The request has succeeded
Body
The organisation identifier
PUT https://sandbox.crm.com/backoffice/v2/copyright_notice HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"copyright_text": "CRM.COM Software 2005-2021"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "7cc1b26a-459f-4b47-a09f-6b121ae947da"
}Each Business within CRM.COM must have a base currecy and optionalyl a list of supported currecies in case of multi-currency businesses. The base currency is used when setting up the product catalogue (i.e. prices and promotions) as well as reward offerns. In all of these cases, the Business must set the values in the base currrency. Then, optionally, prices can also be specified in any other currency that is supported. Contacts signing up to the Business can have accounts in any of the supported currencies.
{id}{id}{id}/ratesAdd a new supported currency for a business, using ISO 4217 currency codes.
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The currency code (based on ISO 4217)
The conversaion rate of the currency in regards to the base currency (not required for default currency)
Responses
The request has succeeded
Body
The currency identifier
POST https://sandbox.crm.com/backoffice/v2/currencies HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"code": "EUR",
"rate": 1.234
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "b449cd6a-d077-1bf0-66f5-d4944c465e20"
}{id}Update an existing currency. When updating a supported business currecy, only its exchange rate over the base currncy can be updated. The new exchange rate will be in immediate effect.
Path variables
The currency (identifer) that will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The conversion rate of the currency in regards to the base currency
Responses
The request has succeeded
Body
The currency identifier
PUT https://sandbox.crm.com/backoffice/v2/currencies/edf4a34c-4932-4941-9957-aeb5b55873b6 HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"rate": 1.2345
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "b449cd6a-d077-1bf0-66f5-d4944c465e20"
}{id}Delete an existing currency from the supported ones. A supported currency can be removed only as long as there are no Active/Suspended accounts in that currency
Path variables
The currency (identifer) that will be removed from the supported ones
Notes
Base currency cannot be removed
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
DELETE https://sandbox.crm.com/backoffice/v2/currencies/b449cd6a-d077-1bf0-66f5-d4944c465e20 HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 204 No Content Retrieve a list of currencies based on search criteria (e.g. only the EURO based currency) that are supported (not all ISO 4217 supported currencies)
Request parameters
Filter based on currency code (based on ISO 4217)
Filter based on whether the currency is the base (default) one or not
Defines on which attribute the results should be sorted
The page number that should be retrieved
The size (total records) of each page
Defines how the results will be ordered
The Country of agreement. Use this pramters to retrieve the supported currencies for a specific Country of agreement. If for that country there are no supported currencies, then the business’s supported currencies are returned.
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The currency identifer
The currency code
The conversion rate of the currency in regards to the base currency (not applicable for the base, default, currency)
Defines whether the currency is the base (default)
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/currencies HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "b449cd6a-d077-1bf0-66f5-d4944c465e20",
"code": "EUR",
"is_default": true
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}/ratesRetrieve a currency’s rate history. Whenever a new exchange rate is set, then the previous one is logged in the currency’s rates history.
Path variables
The currency (identifer) that rate details will be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
Information about the currencty conversion rate history
The conversion rate identifier
The conversion rate with the base currency
The date from which the rate is effective
The date up to which the rate is effective
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/currencies/b449cd6a-d077-1bf0-66f5-d4944c465e20/rates HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "1647eda8-5dbb-4be4-32d1-2bbdecb8390f",
"rate": 1.234,
"from_date": "1588171696",
"to_date": "1588171696"
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}Custom Fields allow storing and managing additional information for various entities, such as contacts. Each custom field is related to a single entity and can be edited or viewed from the UI or through Web APIs. Once a custom field is set up for an entity, then all instances of that entity can be assigned a value for the Custom Field.
{id}{id}{id}/Creates a new custom field
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The custom field key (for integrations and API purposes)
The custom field label (for display purposes)
The type of the event
The custom field description
The custom field tooltip
The custom field’s UI field type
The custom field module (applicable only if type = module)
Defines whether the custom field will be avaialble in the user interface or not
Apllicable options for custom fields (required for selections, checkboxes and radio buttons)
The option key (for integrations and API purposes)
The option text (for display purposes)
Defines whethet the option will be the default one or not
Defines the order that will be used for displaying purposes
Defines the restrictions that will be applied on a custom field’s content (if applicable)
The maximum allowed number of alphanumeric characters that the custom field can support
The minimum allowed number that the custom field can support
The maximum allowed number that the custom field can support
The maximum allowed number of decimals that the custom field can support
The minimum number of digits that the custom field can support
The prefix that the custom field can support
The suffix that the custom field can support
Defines whether check digit (based on Luhn algorithm) will be generated (applicable for numbering scheme custom fields)
Responses
The request has succeeded
Body
The custom field identifier
POST https://sandbox.crm.com/backoffice/v2/custom_fields HTTP/1.1
Content-Type: application/json
{
"key": "back_office",
"label": "Back Office",
"entity": "PASSES",
"description": "The account's back office code",
"tooltip": "lorem ipsum",
"type": "NUMBER",
"content": "USERS",
"visible": true,
"options": [
{
"key": "option_1",
"text": "my option 1",
"default": true,
"order": 1
}
],
"webhook": {
"url_endpoint": "https://crm.com/validations",
"url_auth": "NO_AUTH",
"username": "johndoe",
"password": "crm.com",
"api_key": "qwert-12345-qwewerwer-123234234-werwerwr",
"trigger_event": "ON_FORM_SAVE"
},
"restrictions": {
"max_characters": 1024,
"min_number": 2,
"max_number": 100,
"decimals_number": 2,
"digits_number": 10,
"prefix": "MJ",
"suffix": "GS",
"check_digit": "true"
}
}{id}Updates an existing custom field
Path variables
The custom field (identifer) that will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The custom field label (for display purposes)
The custom field description
The custom field tooltip
Defines whether the custom field will be avaialble in the user interface or not
The custom field’s order sequence (used on which order custom fields will be displayed)
Apllicable options for custom fields (required for selections, checkboxes and radio buttons)
The option key (for integrations and API purposes)
The option text (for display purposes)
Defines whethet the option will be the default one or not
Defines the order that will be used for displaying purposes
Defines the restrictions that will be applied on a custom field’s content (if applicable)
The maximum allowed number of alphanumeric characters that the custom field can support
The minimum allowed number that the custom field can support
The maximum allowed number that the custom field can support
The maximum allowed number of decimals that the custom field can support
The minimum number of digits that the custom field can support
The prefix that the custom field can support
The suffix that the custom field can support
Defines whether check digit (based on Luhn algorithm) will be generated (applicable for numbering scheme custom fields)
Responses
The request has succeeded
Body
The custom field identifier
PUT https://sandbox.crm.com/backoffice/v2/custom_fields/f68fad29-4a1b-3a1e-5cfa-6540a5b1609a HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"label": "Back Office",
"description": "The account's back office code",
"tooltip": "Accounts Back Office Code",
"visible": true,
"options": [
{
"key": "option_1",
"text": "my option 1",
"default": true,
"order_number": 1
}
],
"webhook": {
"url_endpoint": "https://crm.com/validations",
"url_auth": "NO_AUTH",
"username": "johndoe",
"password": "crm.com",
"api_key": "qwert-12345-qwewerwer-123234234-werwerwr",
"trigger_event": "ON_FIELD_FOCUS_CHANGE"
}
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "f68fad29-4a1b-3a1e-5cfa-6540a5b1609a"
}{id}Deletes a custom field
Path variables
The custom field (identifier) that will be deleted
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
DELETE https://sandbox.crm.com/backoffice/v2/custom_fields/f68fad29-4a1b-3a1e-5cfa-6540a5b1609a HTTP/1.1
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
HTTP/1.1 204 No Content Retrieve a list of custom fields based on search criteria (e.g. all lead custom fields)
Request parameters
Filter based on the entity of which custom fields will be retrieved
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The custom field identifier
The custom field (unique) key
The custom field’s label
The custom field’s description
The custom field’s tooltip
Defines whether the custom field is visible in the UI or not
The custom field’s UI field type
The custom field module (applicable only if type = module)
The type of the event
The custom field’s order sequence (used on which order custom fields will be displayed)
The available options that a user can select when the custom field is selection, checkbox or radio button based
The field option key
The field option text
Defines whether the field option is the default one
The field option order number
Defines the restrictions that will be applied on a custom field’s content (if applicable)
The maximum allowed number of characters that the custom field can support
The minimum allowed number that the custom field can support
The maximum allowed number that the custom field can support
The maximum allowed number of decimals that the custom field can support
The minimum number of digitsthat the custom field can support
The prefix that the custom field can support
The suffix that the custom field can support
Defines whether check digit (based on Luhn algorithm) will be generated (applicable for numbering scheme custom fields)
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/custom_fields HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "f68fad29-4a1b-3a1e-5cfa-6540a5b1609a",
"key": "back_office",
"label": "Back Office",
"description": "The account's back office code",
"tooltip": "External system account reference number",
"visible": true,
"type": "DATE",
"content": "USERS",
"entity": "REFUNDS",
"order": 1,
"options": [
{
"key": "option_1",
"text": "my option 1",
"default": true,
"order_number": 1
}
],
"restrictions": {
"max_characters": 1024,
"min_number": 2,
"max_number": 100,
"number_decimals": 2
}
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}/Retrieve detailed information for a custom field
Path variables
The custom field (identifier) that will be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The custom field identifier
The custom field (unique) key
The custom field’s label
The custom field’s description
The custom field’s tooltip
Defines whether the custom field is visible in the UI or not
The custom field’s UI field type
The type of the event
The custom field’s order sequence (used on which order custom fields will be displayed)
The custom field module (applicable only if type = module)
The available options that a user can select when the custom field is selection, checkbox or radio button based
The field option key
The field option text
Defines whether the field option is the default one
The field option order number
Defines the restrictions that will be applied on a custom field’s content (if applicable)
The maximum allowed number of characters that the custom field can support
The minimum allowed number that the custom field can support
The maximum allowed number that the custom field can support
The maximum allowed number of decimals that the custom field can support
The minimum number of digitsthat the custom field can support
The prefix that the custom field can support
The suffix that the custom field can support
Defines whether check digit (based on Luhn algorithm) will be generated (applicable for numbering scheme custom fields)
GET https://sandbox.crm.com/backoffice/v2/custom_fields/f68fad29-4a1b-3a1e-5cfa-6540a5b1609a/ HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
[
{
"id": "f68fad29-4a1b-3a1e-5cfa-6540a5b1609a",
"key": "back_office",
"label": "Back Office",
"description": "The account's back office code",
"tooltip": "External system account reference number",
"visible": true,
"type": "CHECKBOXES",
"entity": "TOP_UPS",
"order": 1,
"content": "USERS",
"options": [
{
"key": "option_1",
"text": "my option 1",
"default": true,
"order_number": 1
}
],
"webhook": {
"url_endpoint": "https://crm.com/validations",
"url_auth": "NO_AUTH",
"username": "johndoe",
"password": "crm.com",
"api_key": "qwert-12345-qwewerwer-123234234-werwerwr",
"trigger_event": "ON_FIELD_FOCUS_CHANGE"
},
"restrictions": {
"max_characters": 1024,
"min_number": 2,
"max_number": 100,
"number_decimals": 2
}
}
]Custom Forms are stand-alone external form integrations that can cover custom flows of a definitive purpose associated with CRM.COM.
{id}{id}{id}Creates a new custom form
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The custom form name
The custom form description
The URL endpoint where the form is hosted
Authentication signature that will verify that the form requests are trusted
Details about the UI details that should be applied for this custom form
The icon to be used
The name to be displayed
Defines whether the custom form should be loaded as modal or embedded data page
Defines where the custom form should exist (e.g. navigation menu, within a page)
The custom form state
Responses
The request has succeeded
Body
The custom form identifier
POST https://sandbox.crm.com/backoffice/v2/custom_forms HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"name": "Register Customers",
"description": "Custom form flow",
"url_endpoint": "http://crm.com/integrations/register-contact",
"signature": "46145c04-d4a4-827f-2863-49b2823fcf64",
"component": {
"icon": "mdi mdi-plus",
"name": "Register Contact",
"type": "EMBEDDED",
"location": "CONTACTS_DATAPAGE"
},
"state": "ACTIVE"
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "f68fad29-4a1b-3a1e-5cfa-6540a5b1609a"
}{id}Updates an existing custom form
Path variables
The custom form (identifier) to be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The custom form name
The custom form description
The URL endpoint where the form is hosted
Authentication signature that will verify that the form requests are trusted
Details about the UI details that should be applied for this custom form
The icon to be used
The name to be displayed
Defines whether the custom form should be loaded as modal or embedded data page
Defines where the custom form should exist (e.g. navigation menu, within a page)
The custom form state
Responses
The request has succeeded
Body
The custom form identifier
PUT https://sandbox.crm.com/backoffice/v2/custom_forms/f6913302-f341-6a8b-8b22-adc4e006e0a6 HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"name": "Register Customers",
"description": "Custom form flow",
"url_endpoint": "http://crm.com/integrations/register-contact",
"signature": "46145c04-d4a4-827f-2863-49b2823fcf64",
"component": {
"icon": "mdi mdi-plus",
"name": "Register Contact",
"type": "MODAL",
"location": "CONTACTS_DATAPAGE"
},
"state": "INACTIVE"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "f68fad29-4a1b-3a1e-5cfa-6540a5b1609a"
}{id}Deletes an existing custom form
Path variables
The custom form (identifier) to be deleted
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
DELETE https://sandbox.crm.com/backoffice/v2/custom_forms/f6913302-f341-6a8b-8b22-adc4e006e0a6 HTTP/1.1
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
HTTP/1.1 204 No Content Retrieve a list of custom forms based on search criteria (e.g. all active custom forms)
Request parameters
Filters based on custom form name
Filters based on custom form state
Filter based on custom form location
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The custom form identifier
The custom form name
The custom form description
The URL endpoint where such custom form is hosted
The custom form state
Details about the UI details that should be applied for this custom form
The icon to be used
The name to be displayed
Defines whether the custom form should be loaded as modal or embedded data page
Defines where the custom form should exist (e.g. navigation menu, within a page)
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/custom_forms HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "30176eac-2ce3-0ea9-9418-7bd65aff8c56",
"name": "Register",
"description": "Custom Registration Form",
"url_endpoint": "http://crm.com/integrations/register",
"state": "ACTIVE",
"component": {
"icon": "mdi mdi-plus",
"name": "Register Contact",
"type": "MODAL",
"location": "CONTACTS_DATAPAGE"
}
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Retrieve detailed information for a custom field
Path variables
The custom form (identifier) to be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The custom form identifier
The custom form name
The custom form description
The URL endpoint where the custom form is hosted
Authentication signature that will verify that the form requests are trusted
Details about the UI details that should be applied for this custom form
The icon to be used
The name to be displayed
Defines whether the custom form should be loaded as modal or embedded data page
Defines where the custom form should exist (e.g. navigation menu, within a page)
The custom form state
GET https://sandbox.crm.com/backoffice/v2/custom_forms/4af1ee3a-a0f6-8a87-3d24-08a7d56c9ab9 HTTP/1.1
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "30176eac-2ce3-0ea9-9418-7bd65aff8c56",
"name": "Register",
"description": "Custom Registration Form",
"url_endpoint": "http://crm.com/integrations/register",
"signature": "46145c04-d4a4-827f-2863-49b2823fcf64",
"component": {
"icon": "mdi mdi-plus",
"name": "Register Contact",
"type": "EMBEDDED",
"location": "CONTACTS_DATAPAGE"
},
"state": "ACTIVE"
}{id}{id}{id}Create a new filter for a specific module (e.g. contacts, service requests)
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The filter name
The module for which the filter will be applied
Defines which organisations can be access and use it
Defines which organisations can access and use it
Available only for the user that created it
Available for all users under the same organisation
The attribute which will be considered as a filter
The comparison operator between the property and the related value
The (primary) value that will be compared to the property
The (secondary) value that will be compared to the property, applicable for range comparisons
The record (identifier) that will be compared to the propery (applicable when filtering based on specific records, such as specific contacts, offers, products)
[
"1ccf5401-e4b1-d173-2301-4c639b62c26f"
]The type of the propery attribute
Examples
Responses
The request has succeeded
Body
The filter identifier
POST https://sandbox.crm.com/backoffice/v2/filter HTTP/1.1
Content-Type: application/json
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
{
"name": "Active Discount Offers",
"module": "OFFERS",
"accessibility": {
"type": "PRIVATE"
}
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "ADD1E31269B76D7A65ACCE45B2E68DFD"
}{id}Update an existing filter
Path variables
The filter (identifier) that will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The filter name
Defines which organisations can be access and use it
Defines which organisations can access and use it
Available only for the user that created it
Available for all users under the same organisation
The attribute which will be considered as a filter
The comparison operator between the property and the related value
The (primary) value that will be compared to the property
The (secondary) value that will be compared to the property, applicable for range comparisons
The record (identifier) that will be compared to the propery (applicable when filtering based on specific records, such as specific contacts, offers, products)
[
"1ccf5401-e4b1-d173-2301-4c639b62c26f"
]The type of the propery attribute
Responses
The request has succeeded
Body
The filter identifier
PUT https://sandbox.crm.com/backoffice/v2/filters/49bad38a-efab-86cb-e501-e2c141099e50 HTTP/1.1
Content-Type: application/json
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
{
"name": "Active Discount Offers"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "ADD1E31269B76D7A65ACCE45B2E68DFD"
}{id}Delete an existing filter
Path variables
The filter (identifier) that will be deleted
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
DELETE https://sandbox.crm.com/backoffice/v2/filters/49bad38a-efab-86cb-e501-e2c141099e50 HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 204 No Content Retrieve a list of filters based on search criteria (e.g. all service request filters)
Request parameters
Narrow down filter results based on module
Defines whether conditions should be returned as well
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The filter identifier
The filter name
The user’s identifier
The user’s full name
The user’s credential username
The module for which the filter will be applied
Defines how the segment can be accessed from business network
Defines which organisations can access and use it
Available only for the user that created it
Available for all users under the same organisation
The attribute which will be considered as a filter
The comparison operator between the property and the related value
The (primary) value that will be compared to the property
The (secondary) value that will be compared to the property, applicable for range comparisons
The record (identifier) that will be compared to the propery (applicable when filtering based on specific records, such as specific contacts, offers, products)
[
"1ccf5401-e4b1-d173-2301-4c639b62c26f"
]The type of the propery attribute
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v1/filters HTTP/1.1
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "49bad38a-efab-86cb-e501-e2c141099e50",
"name": "Active Discount Offers",
"module": "OFFERS"
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Retrieve detailed information for a filter
Path variables
The filter (identifier) which attributes will be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The filter identifier
The filter name
Defines how the segment can be accessed from business network
Defines which organisations can access and use it
Available only for the user that created it
Available for all users under the same organisation
The filtering conditions that will be applied
The attribute which will be considered as a filter
The comparison operator between the property and the related value
The (primary) value that will be compared to the property
The (secondary) value that will be compared to the property, applicable for range comparisons
The record (identifier) that will be compared to the propery (applicable when filtering based on specific records, such as specific contacts, offers, products)
[
"1ccf5401-e4b1-d173-2301-4c639b62c26f"
]The type of the propery attribute
GET https://sandbox.crm.com/backoffice/v1/filters/514aefa7-ec78-3229-e70e-9935c84fa0b9 HTTP/1.1
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "49bad38a-efab-86cb-e501-e2c141099e50",
"name": "Active Discount Offers",
"accessibility": {
"type": "ACROSS_NETWORK"
}
}{id}/filters{id}/filters{id}/filtersSaves the latest filter applied on a summary page by the user for a specific module
Path variables
The user (identifier) for which the filter will be set
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The module for which the filter will be applied
The filter (identifier) that will be set as the default of the related module
Responses
The request has succeeded
Body
The filter identifier
POST https://sandbox.crm.com/backoffice/v2/users/03397197-6e67-ab75-ae69-76d3d66e06fb/filters HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"module": "TAPS",
"filter_id": "9a3c41c6-3450-bb0a-10d2-acbfd836a385"
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "a4896470-09c4-bd61-7502-4c4bc54fb6d6"
}{id}/filtersRetrieves the latest filters applied on a summary page by the user for specific modules
Path variables
The user (identifier) for which the filter will be retrieved
Request parameters
Filter based on module
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The module for which the filter will be applied
Details about the filter that was previously applied by the user
The filter identier
GET https://sandbox.crm.com/backoffice/v2/users/03397197-6e67-ab75-ae69-76d3d66e06fb/filters HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"module": "REWARD_OFFERS",
"filter": {
"id": "26fb9432-75ca-628e-50ef-3c7be9466bc5"
}
}{id}{id}{id}Create a new industry
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The name of the industry to be created
Responses
The request has succeeded
Body
The industry identifier
POST https://sandbox.crm.com/backoffice/v2/industries HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"name": "TRAVEL"
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "289be4e0-4d54-6bec-3517-bd27bc67c1ac"
}{id}Update an existing industry
Path variables
The industry (identifier) that will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The name of the industry to be updated
Responses
The request has succeeded
Body
The industry identifier
PUT https://sandbox.crm.com/backoffice/v1/industries/c18fb5e3-3ecb-c5ed-016c-16fa584a5203 HTTP/1.1
Content-Type: application/json
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
{
"name": "Marketing"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": ""
}{id}Delete an existing industry
Path variables
The industry (identifier) that will be deleted
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
DELETE https://sandbox.crm.com/backoffice/v2/industry/c18fb5e3-3ecb-c5ed-016c-16fa584a5203 HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 204 No Content Retrieve a list of industries based on search criteria (e.g. all “education” industries)
Request parameters
Filter based on industry name
Defines on which attribute the results should be sorted
The page number that should be retrieved
The size (total records) of each page
Defines how the results will be ordered
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The industry identifier
The industry name
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/industries HTTP/1.1
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "d7c39ece-0fa5-d94f-1830-c8278c9d290f",
"name": "Travel"
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Retrieve detailed information for an industry
Path variables
The industry (identifier) that will be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The industry identifier
The industry name
GET https://sandbox.crm.com/backoffice/v2/industries/d7c39ece-0fa5-d94f-1830-c8278c9d290f HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "d7c39ece-0fa5-d94f-1830-c8278c9d290f",
"name": "Travel"
}{id}{id}{id}Create industry sectors against specific industries
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The industry sector name
Details about industries that are associated with the industry sector
The industry (identifier) related to the industry sector
Responses
The request has succeeded
Body
The industry sector identifier
POST https://sandbox.crm.com/backoffice/v2/industry_sectors HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"name": "TRAVEL AGENTS",
"industries": [
{
"industry_id": "4AD9C84FA60F9FE407140E20F707726A"
}
]
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "d6e7e8ce-5516-4153-9e94-63f5ff54511b"
}{id}Update an existing industry sector
Path variables
The industry sector (identifier) that will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The industry sector name
Details about industries that are associated with the industry sector
The industry (identifier)
Responses
The request has succeeded
Body
The industry sector identifier
PUT https://sandbox.crm.com/backoffice/v2/industry_sectors/d7c39ece-0fa5-d94f-1830-c8278c9d290f HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"name": "Science",
"industries": [
{
"industry_id": "fbc0db4d-a7f5-ac5b-da88-c64e9d07c3de"
}
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "d7c39ece-0fa5-d94f-1830-c8278c9d290f"
}{id}Delete an existing industry sector
Path variables
The industry sector (identifier) that will be deleted
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
DELETE https://sandbox.crm.com/backoffice/v2/industry_sectors/d6e7e8ce-5516-4153-9e94-63f5ff54511b HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 204 No Content Retrieve a list of industry sectors based on search criteria (e.g. all “restaurants” industry sectors)
Request parameters
Filter based on industry sector name
Filter based on industry name (where industry sector is associated with)
Defines on which attribute the results should be sorted
The page number that should be retrieved
The size (total records) of each page
Defines how the results will be ordered
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The industry sector identifier
The industry sector name
Details about industries that are associated with the industry sector
The industry identifier
The industry name
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/industry_sectors HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "4AD9C84FA60F9FE407140E20F707726A",
"name": "Science",
"industries": [
{
"id": "d6e7e8ce-5516-4153-9e94-63f5ff54511b",
"name": "Computer"
}
]
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Retrieve detailed information for an industry sector
Path variables
The industry sector (identifier) that will be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The industry sector identifier
The industry sector name
Details about industries that are associated with the industry sector
The industry identifier
The industry name
GET https://sandbox.crm.com/backoffice/v2/industry_sectors/f47e682a-5910-4714-9030-44469e2a6f85 HTTP/1.1
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "f47e682a-5910-4714-9030-44469e2a6f85",
"name": "Science",
"industries": [
{
"id": "84b4495e-5e5e-b11f-7a86-2487aa7bd206",
"name": "Computer"
}
]
}Set up of a web page which serves as the entry point for a website or a particular section of a website.
{id}{id}/{id}Create a new landing page
Request headers
Authorization Token
The public api key required for API calls to identify the organisation
Request body
The landing page name
The landing page description
The landing page enum
Used for contact registration
Used for purchasing a gift pass
Defines whether a mobile pass provision is allowed or not
The pass plan id for which passes will be created, only required when ‘type’ = PURCHASE_PASS (i.e. the landing page is used for purchasing a gift pass)
The text in the header
The title to be dispayed on the landing page
The description on the landing page
The footer text
The text to be displayed on the button
The success message to be displayed on the success response page.
The failure message to be displayed on the failure response page.
Defines whether the logo image will be positioned
The landing page components coloring
The landing page component that the color will be applied
The color code (hex code value)
The landing page images opacity
The image type.
The opacity percentage
Details pertaining to the enrollment form fields
The property to be added as a field
The label defined to the field
The priority in which the fields are displayed on the row or the section
Responses
The request has succeeded
Body
The GUID of the landing page created
POST https://sandbox.crm.com/backoffice/v2/landing_pages HTTP/1.1
api_key: 8c54d563-b991-4b76-8a83-557c08166f95
Content-Type: application/json
{
"name": "Enrolment form for Mobile pass cards",
"description": "Enrolment landing page for mobile pass cards.",
"type": "REGISTER",
"mobile_pass": true,
"pass_plan_id": "5f1316d2-dfce-42f0-b7bf-c543b8df7702",
"form": {
"header": "This is a header",
"title": "Enrolment form",
"description": "Please enter detail to enrol for mobile pass cards.",
"footer": "Please sign up",
"button": "Submit",
"success": "Congratulations!",
"fail": "Failed.",
"logo_img_position": "RIGHT",
"colors": [
{
"type": "BUTTON",
"value": "FSR4ER"
}
],
"opacity": [
{
"image": "HEADER",
"value": 1
}
],
"fields": [
{
"property": "contact.email",
"label": "email",
"priority": "1 , 2 , 3"
}
]
}
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "HGJSDYGFUY87686GFJHFASD"
}{id}Updates an existing landing page
Path variables
The landing page (identifier) to be updated
Request headers
Authorization Token
The public api key required for API calls to identify the organisation
Request body
The landing page name
The landing page description
The landing page state
Defines whether a mobile pass provision is allowed or not
The pass plan id for which passes will be created, only required when ‘type’ = PURCHASE_PASS (i.e. the landing page is used for purchasing a gift pass)
The text in the header
The title to be dispayed on the landing page
The description on the landing page
The footer text
The text to be displayed on the button
The success message to be displayed on the success response page.
The failure message to be displayed on the failure response page.
Defines whether the logo image will be positioned
The landing page components coloring
The landing page component that the color will be applied
The color code (hex code value)
The landing page images opacity
The image type.
The opacity percentage
Details pertaining to the enrollment form fields
The property to be added as a field
The label defined to the field
The priority in which the fields are displayed on the row or the section
Responses
The request has succeeded
Body
The landing page identifier
PUT https://sandbox.crm.com/backoffice/v2/landing_pages/a974a078-1fcb-9f60-782f-5989e4881f24 HTTP/1.1
api_key: 8c54d563-b991-4b76-8a83-557c08166f95
Content-Type: application/json
{
"name": "Enrolment form for Mobile pass cards",
"description": "Enrolment landing page for mobile pass cards.",
"state": "ACTIVE",
"mobile_pass": true,
"pass_plan_id": "5f1316d2-dfce-42f0-b7bf-c543b8df7702",
"form": {
"header": "This is a header",
"title": "Enrolment form",
"description": "Please enter detail to enrol for mobile pass cards.",
"footer": "Please sign up",
"button": "Submit",
"success": "Congratulations!",
"fail": "Failed.",
"logo_img_position": "LEFT",
"colors": [
{
"type": "BACKGROUND",
"value": "FSR4ER"
}
],
"opacity": [
{
"image": "BACKGROUND",
"value": 1
}
],
"fields": [
{
"property": "contact.email",
"label": "email",
"priority": "1 , 2 , 3"
}
]
}
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "a974a078-1fcb-9f60-782f-5989e4881f24"
}{id}/Delete an existing landing page
Path variables
The landing page (identifier) that will be deleted
Request headers
Authorization Token
The public api key required for API calls to identify the organisation
Request body
Responses
The request has succeeded
DELETE https://sandbox.crm.com/backoffice/v2/landing_pages/d2ce805b-e2f1-d853-c68f-d157fef21a79/ HTTP/1.1
api_key: 8c54d563-b991-4b76-8a83-557c08166f95
Content-Type: application/json
HTTP/1.1 204 No Content Retrieve a list of landing pages based on search criteria (e.g. all active landing pages)
Request parameters
Search for landing pages based on their name or description
Filter based on landing page state
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The landing pages identifier
The landing pages name
The landing page description
The landing page state
the link associated to the landing page
The landing page enum
Used for contact registration
Used for purchasing a gift pass
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/landing_pages HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "4AD9C84FA60F9FE407140E20F707726A",
"name": "Enrolment form for Mobile pass cards",
"description": "Enrolment landing page for mobile pass cards.",
"state": "INACTIVE",
"link": "https://abc.com",
"type": "REGISTER"
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Retrieve detailed information for a landing page
Path variables
The mobile pass (identifier) to be retrieved
Request headers
Authorization Token
The public api key required for API calls to identify the organisation
Request body
Responses
The request has succeeded
Body
The name of the landing page.
The description of the landing page
The landing page enum
Used for contact registration
Used for purchasing a gift pass
The link associated to the landing page
Defines whether a mobile pass provision is allowed or not
The pass plan id for which passes will be created, only set when ‘type’ = PURCHASE_PASS (i.e. the landing page is used for purchasing a gift pass)
The landing page state
The text in the header
The title to be dispayed on the landing page
The text in the description
The footer text
The text to be displayed on the button
The success message to be displayed on the success response page
The failure message to be displayed on the failure response page
Defines whether the logo image will be positioned
The landing page components coloring
The landing page component that the color will be applied
The color code (hex code value)
The landing page images opacity
The image type.
The opacity percentage
Details pertaining to the enrollment form fields
The property to be added as a field
The label defined to the field
The priority in which the fields are displayed on the row or the section
The creative identifier
Information about the creative type
Partner logos configurable by SO, applicable for Business, Merchant, Venue
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
The creative width
The creative height
The creative format
The creative content URL
The creative public identifier
Information about the creative transformations
The transformed creative width
The transformed creative height
The transformed creative URL
GET https://sandbox.crm.com/backoffice/v2/landing_pages/7e63eda8-5881-b078-6dfb-c658a6f71676 HTTP/1.1
api_key: 8c54d563-b991-4b76-8a83-557c08166f95
Content-Type: application/json
HTTP/1.1 200 OK
Content-Type: application/json
{
"name": "My loyalty pass enrolment form",
"description": "Enrolment landing page for mobile pass cards.",
"type": "PURCHASE_PASS",
"link": "https://abc.com",
"mobile_pass": true,
"pass_plan_id": "5f1316d2-dfce-42f0-b7bf-c543b8df7702",
"state": "INACTIVE",
"form": {
"header": "This is a header",
"title": "Enrolment form",
"description": "test",
"footer": "Please sign up",
"button": "Submit",
"success": "Congratulations!",
"fail": "Failed.",
"logo_img_position": "LEFT",
"colors": [
{
"type": "FOOTER",
"value": "FSR4ER"
}
],
"opacity": [
{
"image": "BACKGROUND",
"value": 1
}
],
"fields": [
{
"property": "contact.email",
"label": "email",
"priority": "1 , 2 , 3"
}
],
"creatives": [
{
"id": "3caf8388-b9c6-6679-1e9b-94a6fda92a41",
"usage_type": "LANDING_PAGE_BACKGROUND_IMAGE",
"width": 2159,
"height": 3075,
"format": "jpg",
"url": "https://assets.crm.com/image/logo.jpg",
"public_id": "crm-com/image",
"media": [
{
"width": 200,
"height": 300,
"url": "https://asset.crm.com/image/offer/c_scale,w_200/logo.jpg"
}
]
}
]
}
}{id}/media_groups{id}/media_groupsLink a landing page with one or more media groups
Path variables
The landing page (identifier) that media groups will be set
Notes
Uploading media for a landing page requires the execution of the following APIs
- Create new Media Group
- Create Landing Pages Media Groups
- Upload Media
- Perform Cloudinary Upload (where CRM will send all signature details)
- Cloudinary service calls back CRM media group (using an internal callback)
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The media group identifier
Responses
The request has succeeded
POST https://sandbox.crm.com/backoffice/v2/landing_pages/3f1f9e63-7f40-4e5e-bc42-11a162f7f1fb/media_groups HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
[
{
"media_group_id": "3f1f9e63-7f40-4e5e-bc42-11a162f7f1fb"
}
]
HTTP/1.1 204 No Content Mobile Passes are the collective term for the non payment cards, such as coupons, loyalty cards, subscription cards, rewards and anything that is not a payment card. These mobile pass cards will be set up by the CRM.com user and shall be linked to contacts that ‘enroll’ into this card scheme.
{id}{id}{id}Create a new mobile pass
Request headers
Authorization Token
The public api key required for API calls to identify the organisation
Request body
The mobile pass name
The name of the program that applies to this pass card (required for Google)
The mobile pass description
Details regarding the fields added to the pass
The wallet platform to which this field relates to.
The label defined to the field
Whether the field is at a row or a section
The row or section number
The priority in which the fields are displayed on the row or the section
The property in that field
Whether the field is on the front or the back
The value of the property (applicable only for platform APPLE and property portal_url)
The placement of the text.
The nature of the field
The attributes relating to the pass
The parameter type
The attribute type
the background colour.
the text colour.
the label colour.
The attribute value
The type of barcode to be displayed on the pass
The content to be stored as the barcode. Defaulted to contacts.id as lexicon
Responses
The request has succeeded
Body
The mobile pass identifier
POST https://sandbox.crm.com/backoffice/v2/mobile_passes HTTP/1.1
api_key: 8c54d563-b991-4b76-8a83-557c08166f95
Content-Type: application/json
{
"name": "My loyalty pass",
"description": "This card is for reward purposes.",
"fields": [
{
"platform": "GOOGLE",
"label": "Points",
"location": "ROW",
"location_number": "1 , 2 , 3",
"priority": "1 , 2 , 3",
"property": "wallet.points , https://abc.com",
"side": "BACK",
"property_value": "https//releaseportal.crm.com",
"text_alignment": "CENTER",
"type": "CALENDAR"
}
],
"attributes": [
{
"parameter": "FONT",
"type": "LABEL",
"value": "FA76VC1"
}
],
"barcode": {
"type": "AZTEC",
"content": "contact.loyalty_number"
}
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "19bc382b-fdf6-57a4-803e-425cf1530fa6"
}{id}Update an existing mobile pass
Path variables
The mobile pass (identifier) to be updated
Request headers
Authorization Token
The public api key required for API calls to identify the organisation
Request body
The name of the pass card
The name of the program that applies to this pass card (required for Google)
The description of the pass card
The landing page state
Details regarding the fields added to the pass
The field (identifier) that will be updated
The wallet platform to which this field relates to.
The label defined to the field
Whether the field is at a row or a section
The row or section number
The priority in which the fields are displayed on the row or the section
The property in that field
Whether the field is on the front or the back
The value of the property (applicable only for platform APPLE and property portal_url)
The placement of the text.
The nature of the field
The attributes relating to the pass
The attribute identifier
The parameter type
The attribute type
the background colour.
the text colour.
the label colour.
The attribute value
The type of barcode to be displayed on the pass
The content to be stored as the barcode. Defaulted to contacts.id as lexicon
Responses
The request has succeeded
Body
The mobile pass card identifier
PUT https://sandbox.crm.com/backoffice/v2/mobile_passes/7fb8da7b-6a67-04d4-167b-a979c68e49e3 HTTP/1.1
api_key: 8c54d563-b991-4b76-8a83-557c08166f95
Content-Type: application/json
{
"name": "My loyalty pass",
"program_name": "My loyalty program",
"description": "This card is for reward purposes.",
"state": "ACTIVE",
"fields": [
{
"id": "26c8ad53-bb05-f62e-88c6-ff64face3087",
"platform": "GOOGLE",
"label": "Points",
"location": "SECTION",
"location_number": "1 , 2 , 3",
"priority": "1 , 2 , 3",
"property": "wallet.points , https://abc.com",
"side": "FRONT",
"property_value": "https//releaseportal.crm.com",
"text_alignment": "RIGHT",
"type": "LOCATION"
}
],
"attributes": [
{
"id": "d875bee3-0975-5301-ff56-0d4c5fb027cf",
"parameter": "FONT",
"type": "LABEL",
"value": "FA76VC1"
}
],
"barcode": {
"type": "CODE_128",
"content": "contact.loyalty_number"
}
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "7fb8da7b-6a67-04d4-167b-a979c68e49e3"
}{id}Update an existing mobile pass
Path variables
The mobile pass (identifier) to be deleted
Request headers
Authorization Token
The public api key required for API calls to identify the organisation
Responses
The request has succeeded
DELETE https://sandbox.crm.com/backoffice/v2/mobile_passes/7fb8da7b-6a67-04d4-167b-a979c68e49e3 HTTP/1.1
api_key: 8c54d563-b991-4b76-8a83-557c08166f95
HTTP/1.1 204 No Content Retrieve a list of mobile passes based on search criteria (e.g. all mobile passes)
Request parameters
Filters based on mobile pass name (behave as like)
Filter based on mobile pass state
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The public api key required for API calls to identify the organisation
Responses
The request has succeeded
Body
The mobile pass identifier
The mobile pass name
The landing page state
The mobile pass description
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/mobile_passes HTTP/1.1
api_key: 8c54d563-b991-4b76-8a83-557c08166f95
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "927d5e79-15b8-8e6e-9e12-cff545ae2db0",
"name": "CRM Mobile Pass",
"state": "INACTIVE",
"description": "CRM Mobile Pass Card"
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Retrieve detailed information for a mobile pass
Path variables
The mobile pass (identifier) to be retrieved
Request headers
Authorization Token
The public api key required for API calls to identify the organisation
Request body
Responses
The request has succeeded
Body
The mobile pass identifier
The name of the mobile pass
The descri-ption of the mobile pass
The landing page state
Details regarding the fields added to the pass
The field (identifier) that will be updated
The wallet platform to which this field relates to.
The label defined to the field
Whether the field is at a row or a section
The row or section number
The priority in which the fields are displayed on the row or the section
The property in that field
Whether the field is on the front or the back
The value of the property (applicable only for platform APPLE and property portal_url)
The placement of the text.
The nature of the field
The attributes relating to the pass
The attribute identifier
The parameter type
The attribute type
the background colour.
the text colour.
the label colour.
The attribute value
The type of barcode to be displayed on the pass
The content to be stored as the barcode. Defaulted to contacts.id as lexicon
The creative identifier
Information about the creative type
Partner logos configurable by SO, applicable for Business, Merchant, Venue
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
The creative width
The creative height
The creative format
The creative content URL
The creative public identifier
Information about the creative transformations
The transformed creative width
The transformed creative height
The transformed creative URL
GET https://sandbox.crm.com/backoffice/v2/mobile_passes/7fb8da7b-6a67-04d4-167b-a979c68e49e3 HTTP/1.1
api_key: 8c54d563-b991-4b76-8a83-557c08166f95
Content-Type: application/json
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "7fb8da7b-6a67-04d4-167b-a979c68e49e3",
"name": "My loyalty pass",
"description": "This card is for reward purposes.",
"state": "INACTIVE",
"fields": [
{
"id": "26c8ad53-bb05-f62e-88c6-ff64face3087",
"platform": "GOOGLE",
"label": "Points",
"location": "SECTION",
"location_number": "1 , 2 , 3",
"priority": "1 , 2 , 3",
"property": "wallet.points , https://abc.com",
"side": "FRONT",
"property_value": "https//releaseportal.crm.com",
"text_alignment": "LEFT",
"type": "CALENDAR"
}
],
"attributes": [
{
"id": "d875bee3-0975-5301-ff56-0d4c5fb027cf",
"parameter": "COLOUR",
"type": "TEXT",
"value": "FA76VC1"
}
],
"barcode": {
"type": "AZTEC",
"content": "contact.code"
},
"creatives": [
{
"id": "3caf8388-b9c6-6679-1e9b-94a6fda92a41",
"usage_type": "LANDING_PAGE_IMAGE",
"width": 2159,
"height": 3075,
"format": "jpg",
"url": "https://assets.crm.com/image/logo.jpg",
"public_id": "crm-com/image",
"media": [
{
"width": 200,
"height": 300,
"url": "https://asset.crm.com/image/offer/c_scale,w_200/logo.jpg"
}
]
}
]
}{id}/media_groups{id}/media_groupsLink a mobile pass with one or more media groups
Path variables
The mobile pass (identifier) that media groups will be set
Notes
Uploading media for a mobile pass card requires the execution of the following APIs
- Create new Media Group
- Create Mobile Passes Media Groups
- Upload Media
- Perform Cloudinary Upload (where CRM will send all signature details)
- Cloudinary service calls back CRM media group (using an internal callback)
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The media group identifier
Responses
The request has succeeded
POST https://sandbox.crm.com/backoffice/v2/mobile_pass_cards/3f1f9e63-7f40-4e5e-bc42-11a162f7f1fb/media_groups HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
[
{
"media_group_id": "3f1f9e63-7f40-4e5e-bc42-11a162f7f1fb"
}
]
HTTP/1.1 204 No Content Partners (associates) can be defined at the Service Owner level and assigned to individual Businesses. As a result, the partner logo will appear at the bottom of the menu bar when a business user is logged-in.
{id}{id}{id}{id}/media_groupsCreates a new partner for the service owner
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Partner name
Contact person information
Contact person name
Contact person email
Contact person phone number
Phone number country code
The partner state
Responses
The request has succeeded
Body
The unique partner identifier
POST https://sandbox.crm.com/backoffice/v2/partners HTTP/1.1
Content-Type: application/json
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
{
"name": "Yellow Umbrella Corp.",
"contact_person": {
"name": "John Smith",
"email": "john.smith@yellowumberlla.com",
"phone": "22499019",
"country_code": "CYP"
},
"state": "INACTIVE"
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "f68fad29-4a1b-3a1e-5cfa-6540a5b1609a"
}{id}Update an existing partner
Path variables
The partner (identifier) that will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The partner name
Details about contact (person)
The contact name
The contact email
The contact phone number
The contact phone country code
The partner state
Responses
The request has succeeded
Body
The partner identifier
PUT https://sandbox.crm.com/backoffice/v2/partners/f6913302-f341-6a8b-8b22-adc4e006e0a6 HTTP/1.1
Content-Type: application/json
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
{
"name": "Yellow Umbrella Corp.",
"contact_person": {
"name": "John Smith",
"email": "john.smith@yellowumberlla.com",
"phone": "22499346",
"country_code": "CYP"
},
"state": "ACTIVE"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "f68fad29-4a1b-3a1e-5cfa-6540a5b1609a"
}{id}Delete an existing partner
Path variables
The partner (identifier) that will be deleted
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
DELETE https://sandbox.crm.com/backoffice/v2/partners/f6913302-f341-6a8b-8b22-adc4e006e0a6 HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 204 No Content Retrieve a list of partners based on search criteria (e.g. all inactive partners)
Request parameters
Filter based on partner name
Filter based on state
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The partner identifier
The partner name
Details about contact (person)
The partner contact (person) name
The partner state
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/partners HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "30176eac-2ce3-0ea9-9418-7bd65aff8c56",
"name": "Yellow Umbrella Corp.",
"contact_person": {
"name": "John Smith"
},
"state": "INACTIVE"
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Retrieve detailed information for a partner
Path variables
The partner (identifier) that will be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The partner identifier
The partner name
Details about contact (person)
The contact name
The contact email
The contact phone
The contact phone country code
The partner state
GET https://sandbox.crm.com/backoffice/v2/partners/4af1ee3a-a0f6-8a87-3d24-08a7d56c9ab9 HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "30176eac-2ce3-0ea9-9418-7bd65aff8c56",
"name": "Yellow Umbrella Corp.",
"contact_person": {
"name": "John Smith",
"email": "john.smith@yellowumbrella.com",
"phone": "22480900",
"country_code": "CYP"
},
"state": "ACTIVE"
}{id}/media_groupsLink a partner with one or more media groups
Path variables
The partner (identifier) that media groups will be set
Notes
Uploading media for an partner requires the execution of the following APIs
- Create new Media Group
- Create Partner Media Groups
- Upload Media
- Perform Cloudinary Upload (where CRM will send all signature details)
- Cloudinary service calls back CRM media group (using an internal callback)
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The media group identifier
Responses
The request has succeeded
POST https://sandbox.crm.com/backoffice/v2/partners/sdfsfsdf-32-fwef-wef-wefwef23/media_groups HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
[
{
"media_group_id": "3f1f9e63-7f40-4e5e-bc42-11a162f7f1fb"
}
]
HTTP/1.1 204 No Content Service Owner details provide details about the service owner branding for the entire back-office experience
Update the service owner details
Notes
Privacy Policy and Terms & Conditions agreements are both legally binding contracts to protect your clients and your company (respectively).
SaaS Pricing & Billing details define the pricing strategy of your operations and the organisation that will handle the billing of any business that agrees and signs up to one of the available price plans.
Can be configured only on the Service Owner level and will be applied throughout their business network.
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The terms of service URL
The privacy policy URL
The pricing policy URL
Responses
The request has succeeded
Body
The organisation identifier
PUT https://sandbox.crm.com/backoffice/v2/service_owner HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"terms_service": "https://www.crm.com/terms-and-conditions/",
"privacy_policy": "https://www.crm.com/privacy-policy/",
"pricing_policy": "http://crm.com",
"default_service_id": "fc03cae7-3b78-6f08-64a9-209730a85475",
"billing_business_id": "d215502e-581b-20ae-26bc-c15aa3a9ef82"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "7cc1b26a-459f-4b47-a09f-6b121ae947da"
}Returns the service owner details
Notes
Privacy Policy and Terms & Conditions agreements are both legally binding contracts to protect your clients and your company (respectively).
SaaS Pricing & Billing details define the pricing strategy of your operations and the organisation that will handle the billing of any business that agrees and signs up to one of the available price plans.
Can be configured only on the Service Owner level and will be applied throughout their business network.
Request parameters
The service owner cloud name
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
The public api key required for API calls to identify the organisation
Responses
The request has succeeded
Body
The default (live) public key of the service owner
Details about service owner organisation
The organisation identifier
The organisation name
The organisation cloud name
The terms of service URL
The privacy policy URL
The creative identifier
Information about the creative type
Partner logos configurable by SO, applicable for Business, Merchant, Venue
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
The creative width
The creative height
The creative format
The creative content URL
The creative public identifier
Information about the creative transformations
The transformed creative width
The transformed creative height
The transformed creative URL
The billing business that will house all contacts and subscriptions that sign up via self sign up.
The default service applied to each new contact that signs up and is added as a contact to the billing business.
GET https://sandbox.crm.com/backoffice/v1/service_owner?cloud_name=crmdotcom HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"public_key": "sdf3ref32rwerf324r134rw23rfd32r23r23r32r",
"organisation": {
"id": "a47fb812-9d74-392c-ee52-443cc940e014",
"name": "CRM.COM",
"cloud_name": "crmdotcom"
},
"terms_service": "https://www.crm.com/terms-and-conditions/",
"privacy_policy": "https://www.crm.com/privacy-policy/",
"creatives": [
{
"id": "CA123456789AQWSXZAQWS1236547896541",
"usage_type": "PROFILEIMAGE",
"width": 2159,
"height": 3075,
"format": "jpg",
"url": "https://assets.crm.com/image/logo.jpg",
"public_id": "crm-com/image",
"media": [
{
"width": 200,
"height": 300,
"url": "https://asset.crm.com/image/offer/c_scale,w_200/logo.jpg"
}
]
}
]
}Tags are unique identifiers that allow users to label records of an entity. This is to help simplify sorting and accessing records. Users can create and access tags for any of their records— Leads, Contacts, Service Requests etc.
{id}{id}{id}Create a new tag
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The tag name
The tag description
The entity that the tag will be associated to
The tag color (hex code) that will be used for visual purposes
The tag state
Responses
The request has succeded
Body
The tag identifier
POST https://sandbox.crm.com/backoffice/v2/tags HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"name": "Maintenance",
"description": "This tag relates to maintenance issues",
"entity": "CONTACTS",
"colour": "75FG77"
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "ec9603d6-dbc3-10ff-a28f-99e855e79f57"
}{id}Update an existing tag
Path variables
The tag (identifier) that will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The tag name
The tag description
The tag color (hex code) that will be used for visual purposes
The tag state
Responses
The request has succeeded
Body
The tag identifier
PUT https://sandbox.crm.com/backoffice/v2/tags/fd566027-3bb0-46ab-2b34-974b026c545a HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"name": "Maintenance",
"description": "This tag depicts that some form of maintenance is required",
"colour": "#0000FF",
"state": "INACTIVE"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "fd566027-3bb0-46ab-2b34-974b026c545a"
}{id}Delete an existing tags
Path variables
The tag (identifier) that will be deleted
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
DELETE https://sandbox.crm.com/backoffice/v2/tags/de89f95d-fd57-3bd5-e460-2545ea0622c1 HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 204 No Content Retrieve a list of tags based on search criteria (e.g. all contact tags)
Request parameters
Filter based on entity
Filter based on state
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The public api key required for API calls to identify the organisation
Responses
The request has succeeded
Body
The tag identifier
The tag name
The tag description
The entity that the tag will be associated to
The tag state
The tag color (hex code) that will be used for visual purposes
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/tags HTTP/1.1
api_key: 8c54d563-b991-4b76-8a83-557c08166f95
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "05ac88a3-f448-8e96-f68f-26948529588e",
"name": "Maintenance",
"description": "Maintenance activity in progress",
"entity": "SERVICE_REQUESTS",
"state": "ACTIVE",
"colour": "#0000FF"
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Retrieve detailed information for a tag
Path variables
The tag (identifier) that will be retrived
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The tag identifier
The tag name
The tag description
The entity that the tag will be associated to
The tag state
The tag color (hex code) that will be used for visual purposes
GET https://sandbox.crm.com/backoffice/v2/tags/93d52b5f-3df1-8b4b-ebac-ff1e0ee43fb1 HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "93d52b5f-3df1-8b4b-ebac-ff1e0ee43fb1",
"name": "Maintenance",
"description": "Maintenance issues",
"entity": "ACTIVITIES",
"state": "ACTIVE",
"colour": "#0000FF"
}Time Travel is a simulation feature which imitates the key behavior and characteristics of rewards, billing & subscription configurations. It is a virtual time travelling utility tool which is available only on test environment and facilitates the ability to go back in time and test features, such as settlement, subscription invoicing and states scheduling on a specific time frame.
Upon launching the time travel, all contact and organisation related data (e.g. subscriptions, orders, rewards, financial transactions & customer events) will be staged and new one should be created with a limit of up to five (5) contacts and five (5) organisations (parent organisations). When exiting the time travel, all contacts & organisation and their related records (e.g. financial transactions) will be deleted.
Perform actions on the time travel utility tool (e.g. take the system back in time)
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The action to be performed
Start the time travel utility tool by goind back to the origin time
Terminate the time travel utility tool and return to the current time
Travel forward in time and simulate system’s behavior
The start time of the time travel utility tool (applicable and required when action is START_AFRESH)
The destination time to which the time travel utility tool is travelling forward. Should be between the “current” destination time and present time (applicable and required when action is TRAVEL_FORWARD)
Responses
The request has succeeded
Start (Restart) the time travel utility tool by goind back to the origin time
PUT https://sandbox.crm.com/backoffice/v2/time_travel/actions HTTP/1.1
Content-Type: application/json
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
{
"action": "START_AFRESH",
"origin_time": 1643629992
}
HTTP/1.1 204 No ContentTravel forward in time and simulate system’s behavior
PUT https://sandbox.crm.com/backoffice/v2/time_travel/actions HTTP/1.1
Content-Type: application/json
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
{
"action": "TRAVEL_FORWARD",
"destination_time": 1643630252
}
HTTP/1.1 204 No ContentTerminate the time machine feature and return to the current time
PUT https://sandbox.crm.com/backoffice/v2/time_travel/actions HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"action": "TERMINATE"
}
HTTP/1.1 204 No ContentGet details of a specific time travel
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The start time of the time travel utility tool
The destination time to which the time travel utility tool is travelling forward. Should be between the “current” destination time and present time
Defines whether time travel is enabled or not
The current status of time travel utility tool
Time travel is in progress
Time travel has succeeded
Time travel has failed
Details about why the time travel utility tool failed
GET https://sandbox.crm.com/backoffice/v2/time_travel HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"origin_time": 1643629992,
"destination_time": 1643630252,
"is_enabled": "true",
"status": "FAILURE",
"failure_reason": "Incorrect details"
}Webhooks are event notification methods where an application (or a system) is provided with real time information for a CRM.COM entity without requiring additional integration. Once a webhook for an event is created via automation, CRM.COM will automatically start sending webhook requests to that webhook endpoint every time the automation is triggered, with the necessary details relating to that event.
{id}{id}{id}Create a new webhook
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The webhook name
The webhook method type
The webhook url endpoint
Details about webhook authentication
Defines how the webhook will be protected
The username that will auth the webhook requests (applicable if url_auth = USERNAME_PASSWORD)
The password that will auth the webhook requests (applicable if url_auth = USERNAME_PASSWORD)
The api key that will auth the webhook requests (applicable if url_auth = API_KEY)
Details about webhook retries
The total number of retries
The wait period between retries (in seconds)
Responses
The request has succeeded
Body
The webhook identifier
POST https://sandbox.crm.com/backoffice/v2/webhooks HTTP/1.1
Content-Type: application/json
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
{
"name": "CRMdotCOM Delivery",
"method": "PUT",
"url_endpoint": "https://crm.com/delivery",
"authentication": {
"type": "NO_AUTH"
},
"retries": {
"count": 2,
"after": 4
}
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "9152cc24-f41d-2890-bbb5-fcb1c2cf5bd5"
}{id}Update an existing webhook
Path variables
The webhook (identifier) that will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The webhook name
The webhook url endpoint
Details about webhook authentication
Defines how the webhook will be protected
The username that will auth the webhook requests (applicable if url_auth = USERNAME_PASSWORD)
The password that will auth the webhook requests (applicable if url_auth = USERNAME_PASSWORD)
The api key that will auth the webhook requests (applicable if url_auth = API_KEY)
Details about webhook retries
The total number of retries
The wait period between retries (in seconds)
Responses
The request has succeeded
Body
The webhook identifier
PUT https://sandbox.crm.com/backoffice/v2/webhooks/9152cc24-f41d-2890-bbb5-fcb1c2cf5bd5 HTTP/1.1
Content-Type: application/json
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
{
"name": "CRMdotCOM Delivery",
"url_endpoint": "https://crm.com/delivery",
"authentication": {
"type": "NO_AUTH"
},
"retries": {
"count": 2,
"after": 4
}
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "9152cc24-f41d-2890-bbb5-fcb1c2cf5bd5"
}{id}Delete an existing webhook
Path variables
The webhook (identifier) that will be deleted
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
DELETE https://sandbox.crm.com/backoffice/v2/webhooks/9152cc24-f41d-2890-bbb5-fcb1c2cf5bd5 HTTP/1.1
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
HTTP/1.1 204 No Content Retrieve a list of webhooks based on search criteria (e.g. all webhooks with failed requests)
Request parameters
Filter based on search value (case insensitive) across webhook name and url endpoint
Filter based on the name
Filter based on the url endpoint
Filter based on related automation entity
Filter based on related automation event
Filter based on whether webhook has at least one failed request
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The webhook identifier
The webhook name
The webhook method type
The webhook url endpoint
Details about webhook authentication
Defines how the webhook will be protected
Details about webhook retries
The total number of retries
The wait period between retries (in seconds)
Details (overall metrics) about webhook requests
The number of pending requests
The number of successful requests
The number of failed requests
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/webhooks HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "9152cc24-f41d-2890-bbb5-fcb1c2cf5bd5",
"name": "Registration Name",
"method": "PUT",
"url_endpoint": "https;//crm.com/delivery",
"authentication": {
"type": "NO_AUTH"
},
"retries": {
"count": 2,
"after": 4
},
"request_metrics": {
"pending": 3,
"successful": 2,
"failed": 1
}
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Retrieve detailed information for a webhook
Path variables
The webhooks (identifier) that will be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The webhook identifier
The webhook name
The webhook method type
The webhook url endpoint
Details about webhook authentication
Defines how the webhook will be protected
The username that will auth the webhook requests (applicable if url_auth = USERNAME_PASSWORD)
The password that will auth the webhook requests (applicable if url_auth = USERNAME_PASSWORD)
The api key that will auth the webhook requests (applicable if url_auth = API_KEY)
Details about webhook retries
The total number of retries
The wait period between retries (in seconds)
Details (overall metrics) about webhook requests
The number of pending requests
The number of successful requests
The number of failed requests
GET https://sandbox.crm.com/backoffice/v2/webhooks/9152cc24-f41d-2890-bbb5-fcb1c2cf5bd5 HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "99f19d3b-9542-5927-85ff-bd3b272c68e5",
"name": "push webhook to external system",
"method": "POST",
"url_endpoint": "crm.com",
"authentication": {
"type": "API_KEY",
"api_key": "qwert-12345-qwewerwer-123234234-werwerwr"
},
"retries": {
"count": 2,
"after": 4
},
"request_metrics": {
"pending": 3,
"successful": 2,
"failed": 1
}
}Retrieve a list of webhook requests based on search criteria (e.g. all failied webhook requests)
Request parameters
Filter based on search value (case insensitive) across webhook name and url endpoint
Filter based on webhook (identifier)
Filter based on url endpoint
Filter based on request state
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The webhook request identifier
The state of the webhook request
The total number of request retries
The date that webhook request was made
Details about webhook request attributes
The url endpoint
Defines how the webhook will be protected
The request body that was sent
The response that was received
Details about webhook
The webhook identifier
The webhook name
Details about the automation
The automation identifer
The automation name
Details about related entity that request is created for
The entity type that the webhook request is created for
The entity’s reference name/code/number
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/webhook_requests HTTP/1.1
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "9152cc24-f41d-2890-bbb5-fcb1c2cf5bd5",
"state": "SUCCESS",
"retries": 3,
"date": 1596093272,
"request": {
"url_endpoint": "https;//crm.com/delivery",
"auth": "NO_AUTH",
"body": "POST /crm.com/delivery HTTP/1.1 Host: staging.crm.com Content-Type: application/json api_key: 123456789012-1234-1234-1234-123456789012 Content-Type: text/plain { \"contact_id\": \"123456789012-ABCD-ABCD-ABCD-123456789012\", \"amount\": 20.45 }",
"response": "{ \"status\": { \"code\": \"COM.CRM.EXCEPTION.INVALIDTOKENEXCEPTION\", \"description\": \"The specific token is not valid.\", \"message\": \"The token is invalid, please obtain a new one.\" } }"
},
"webhook": {
"id": "c0a3953b-237a-52da-aa5d-74408f21b12d",
"name": "CRMdotCOM Delivery"
},
"automation": {
"id": "cf010c72-a2cb-48f8-a9fa-1ed99c8d6ec0",
"name": "Request approval on newly activated offers"
},
"entity": {
"type": "CONTACT",
"reference": "ORD1234ER"
}
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}Perform actions on existing webhook requests (e.g. resend a number of failed requests)
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The action that will be applied
Resend failed webhook requests
Defines a list all failed webhook requests that should be resend (applicable for resend action)
Responses
The request has succeeded
PUT https://sandbox.crm.com/backoffice/v2/webhooks/requests/actions HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"action": "RESEND",
"requests": [
{
"id": "9e840572-9eca-be97-113f-a3428770bc31"
}
]
}
HTTP/1.1 204 No Content Get the generic product settings
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Successful Request
Body
The product name settings
Defines whether products with duplicated names can be supported or not
GET https://sandbox.crm.com/backoffice/v2/products/settings HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"name_settings": {
"allow_duplicate_names": "true"
}
}Update the generic product settings
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The product name settings
Defines whether products with duplicated names can be supported or not
Responses
Successful Request
Body
Unique idetifier of product settings
PUT https://sandbox.crm.com/backoffice/v2/products/settings HTTP/1.1
Content-Type: application/json
{
"name_settings": {
"allow_duplicate_names": "true"
}
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}Use Component Sets to group together various products of different types, brands, families etc. Component sets are avaiable duing the Ordering process so contacts can select ne or more products within the same set.
{id}{id}{id}Create a component set consisting of products
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The component set unique name
The component set display name
The component set description
List of products in the component set
Product unique id
The order of the product within the component set
Responses
Body
The unique id of the component set created
POST https://sandbox.crm.com/backoffice/v2/component_sets HTTP/1.1
Content-Type: application/json
{
"name": "Milk & Alternatives",
"display_name": "Milks",
"descripion": "Milk and dairy substitute options",
"products": [
{
"id": "a2b88272-c9e4-418d-83d3-8e7561b4e392",
"order": 3
}
]
}Retrieve a list of available component sets
Request parameters
Search for component set based on name, display name and description
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
The component set unique identifier
The component set name
The component set dislay_name
The component set description
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/component_sets/ HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "a2b88272-c9e4-418d-83d3-8e7561b4e392",
"name": "Sugar Options",
"display_name": "milks001",
"description": "Sugar & alternative options"
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Retrieve details of a single component set along with the products it contains
Path variables
The component set unique identifier to be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
The component set unique identifier
The component set name
The component set display name
The component set description
Array of products belonging to the component set
Product unique id
Product sku
Product name
The order of the product within the component set
GET https://sandbox.crm.com/backoffice/v2/component_sets/a2b88272-c9e4-418d-83d3-8e7561b4e392 HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "a2b88272-c9e4-418d-83d3-8e7561b4e392",
"name": "Blends for Cappuccino",
"display_name": "Blends",
"description": "Coffee Blends",
"products": [
{
"id": "3d935540-6d17-432a-9d37-3895eb46b6bf",
"sku": "BLENDS-1908",
"name": "Single Origin",
"order": 1
}
]
}{id}Update a component set
Path variables
The component set identifier that will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The component set unique name
The component set display name
The component set description
Lis to fProducts included in the Component set
The unique id of the product
The order of the product within the component set
Responses
Body
The component set identifier
PUT https://sandbox.crm.com/backoffice/v2/component_sets/283ec6c8-db3d-07e2-be54-6e4baeca6196 HTTP/1.1
Content-Type: application/json
{
"name": "Milk & Alternatives",
"display_name": "milks001",
"descripion": "Milk & alternative dairy options",
"products": [
{
"id": "a2b88272-c9e4-418d-83d3-8e7561b4e392",
"order": 3
}
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "283ec6c8-db3d-07e2-be54-6e4baeca6196"
}{id}Delete an existing component set
Path variables
The component set identifier to be deleted
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
DELETE https://sandbox.crm.com/backoffice/v2/component_sets/a2b88272-c9e4-418d-83d3-8e7561b4e392 HTTP/1.1
HTTP/1.1 204 No Content Dependencies between products can be used in Subscriptions to indicate which service(s) or traceable physical good(s) are required in order for another service to be delivered to the contact properly. For example, a service requires a device to be activated.
{id}{id}{id}Creates a new product dependency rule. A Dependency rule is set up for a product or a product type. Multiple rules can be set up per product/product type, as long as they have a unique configuration.
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Unique name for the Dependency rule.
Dependency rule description
Specific product or all products of a specific type have a dependency on other product(s)
The unique identifier of the product or the product type
Dependency rule type. A product requires another product or cannot coexist (on the same subscription) with another product
Required services/physical goods must exist on the subscription to deliver the rule’s service
Service cannot co-exist on a subscription with the specified services/physical goods
Defines if the specified item has a dependency to all (all must exist on a subscription) or at least one of the product dependencies
All specified products must (or cannot) exist on the subscription
At least one of the specified products must exist
List of Product or Product types to which the specified item has a dependency to
Dependency on a product or products of a specific type
Unique identifier of the product or product type
Responses
Body
The unique identifier of the product dependency rule
POST https://sandbox.crm.com/backoffice/v2/products/dependency_rules HTTP/1.1
Content-Type: application/json
{
"name": "PVR required services",
"description": "TV Service requiring a decoder",
"item_type": "PRODUCT",
"item_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"type": "REQUIRES",
"operator": "ANY",
"dependencies": [
{
"item_type": "PRODUCT",
"item_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}
]
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}Returns a list of all product dependency rules
Request parameters
Search by name of the rule or name of product or product type name
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
Dependency rule unique identifier
Dependency rule name
Dependency rule description
Indicates whether the ule is applied when all or at elast one of the product condtions are met
All product conditions mus tbe met
At least one of the product conditions must be met
Type of dependency
Product requires another product
Prouct cannot coexist with another one.
Dependency set up for a Product or a Product Type
The name of the product or the product type for which the dependency rule is set up
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/products/dependency_rules HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "PVR requirements",
"description": "PVR Services required services",
"operator": "ANY",
"type": "REQUIRES",
"item_type": "TYPE",
"item_name": "TV Services"
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Returns a single product dependency rule
Path variables
Dependency rule identifier
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
Dependency rule name
Dependency rule description
Dependency of a Product or product of a specific Type.
Unique identifier of the Product or Product Type
Product or Product Type name
Dependency type
Indicates if the item specified has a dependency on at least one or all of the specified dependencies
List of products or products types on which the item has a dependecy to
Dependency on another product or products of a specfic type
Unique identifier of the Product or Product Type
Product or Product Type name
GET https://sandbox.crm.com/backoffice/v2/products/dependency_rules/{id} HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"name": "PVR requirements",
"description": "TV service requirung HD Decoder",
"item_type": "PRODUCT",
"item_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"item_name": "TV Services",
"type": "REQUIRES",
"operator": "ANY",
"dependencies": [
{
"item_type": "PRODUCT",
"item_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"item_name": "HD Decoder"
}
]
}{id}Updates an existing product dependency rule
Path variables
Dependency rule identifier
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Depedency rule name that has to be unique across all rules
Dependency rule description
Specific product or all products of a specific type have a dependency on other product(s)
The unique identifier of the product or the product type
Dependency rule type. A product requires another product or cannot coexist (on the same subscription) with another product
Defines if the specified item has a dependnecy to all or at least one of the product dependencies
Dependency on a product or products of a specific type
Unique identifier of the product or product type
Responses
Body
The unique identifier of the product dependency rule
PUT https://sandbox.crm.com/backoffice/v2/products/dependency_rules/4dc0809f-ed91-4b68-b912-5bd6064d901e HTTP/1.1
Content-Type: application/json
{
"name": "PVR requirements",
"description": "PVR Service requiring a decoder",
"item_type": "PRODUCT",
"item_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"type": "REQUIRES",
"operator": "ALL",
"dependencies": [
{
"item_type": "TYPE",
"item_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}{id}Deletes a product dependency rule
Path variables
Dependency rule identifier
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
DELETE https://sandbox.crm.com/backoffice/v2/dependency_rules/4dc0809f-ed91-4b68-b912-5bd6064d901e HTTP/1.1
HTTP/1.1 204 No Content Classify Products based on their Brands. A product can be assigned a single Brand
{id}{id}{id}Create a new product brand
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Brand name. Has to be unique across brands
Brand description
Responses
Body
The unique identifier of the newlly created product brand
POST https://sandbox.crm.com/backoffice/v2/products/brands HTTP/1.1
Content-Type: application/json
{
"name": "Orange",
"description": "Orange services"
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}List product brands
Request parameters
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Search for a brand based on its name and description
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
Brand unique identifier
Brand name
Brand decription
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/products/brands/ HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "Orange",
"description": "Orange services"
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Get a single product brand
Path variables
Brand unique idnetifier
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
Brand uniue identifier
Brand name
Brand description
GET https://sandbox.crm.com/backoffice/v2/products/brands/4dc0809f-ed91-4b68-b912-5bd6064d901e HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "Orange",
"description": "Orange software products"
}{id}Update product brand
Path variables
Brand uniue identifier
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Brand name
Brand description
Responses
Body
The unique identifier of the updated product brand
PUT https://sandbox.crm.com/backoffice/v2/products/brands/4dc0809f-ed91-4b68-b912-5bd6064d901e HTTP/1.1
Content-Type: application/json
{
"name": "Orange",
"description": "Orange services"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}{id}Delete a product brand
Path variables
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
DELETE https://sandbox.crm.com/backoffice/v2/products/brands/{id} HTTP/1.1
HTTP/1.1 204 No Content Categorise Products based on one or more Categories. Categories is a tree-structure entity.
{id}{id}Create a sngle Prodct category which can either be a parent node or a leaf node in a category’s tree structure.
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The product category name which is unique
The product category display name
The product category code
The product category decription
The product category parent id. Required for leaf nodes. If not specified then the category is a parent category.
Define whether product category visible in front-end systems like mobile apps
Responses
Body
Product Category unique identifier
POST https://sandbox.crm.com/backoffice/v2/products/categories HTTP/1.1
Content-Type: application/json
{
"name": "Milk Options Cappuccino",
"display_name": "Milk Options",
"code": "milks001",
"descripion": "Milk Options for Cappuccino",
"parent_id": "345809f-ed91-erff-b912-5bd6064d901e",
"available_in_order_menus": "false"
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}Return a list of product categories
Request parameters
If specified, then all categories under the parent node will be returned. If not specified, then all root nodes of the tree are returned.
Returns all categories of the tree if set to True, ignoring parent_id and include_chid_nodes parameters
Search for a category based on name, dislay name and description
Filter product categories on whether to include in the order menu or not
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
The identifier of the product category
The product category name which is unique
The product category display name
The product category code
The product category decription
Number of child nodes of this category
The product category parent
The product category parent id
The product category parent name
Define whether product category visible in front-end systems like mob apps
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/products/categories HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "4fhht9f-ed91-erff-b912-5bd6064d901e",
"name": "Milk Options Cappuccino",
"display_name": "Milk Options",
"code": "milks001",
"description": "Milk Options for Cappuccino",
"child_nodes": 2,
"parent": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "Coffee Milk options"
},
"available_in_order_menus": "false"
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Updates an existing product category.
Path variables
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The product category name which is unique within a parent category’s path
The product category display name
The product category code
The product category decription
The product category parent id
If set to True, the category is available when listing products in the Ordering flow
Examples
Responses
Body
Product category unique identifier
PUT https://sandbox.crm.com/backoffice/v2/products/categories/{id} HTTP/1.1
Content-Type: application/json
{
"name": "Milk Options Cappuccino",
"display_name": "Milk Options",
"code": "milks001",
"description": "Milk Options for Cappuccino",
"parent_id": "345809f-ed91-erff-b912-5bd6064d901e",
"available_in_order_menus": "false"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}{id}Delete a product category
Path variables
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
DELETE https://sandbox.crm.com/backoffice/v2/products/categories/{id} HTTP/1.1
HTTP/1.1 204 No Content Group Products based on a family i.e. products that have a common set of characteristics. A prouct can have a single family
{id}{id}{id}Creates a new Product Family. A single Product Family can be created per Web API call.
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The product family name which is unique
The product family dislay name
The product family description
Defines which organisations can be access and use it
Defines which organisations can access and use it
The organisations (Merchants, Service Providers) that can access and use it (applicable only if type = SPECIFIC)
Responses
Body
The unique identifier of the new product family
POST https://sandbox.crm.com/backoffice/v2/products/families HTTP/1.1
Content-Type: application/json
{
"name": "Cold Drinks Delivery",
"display_name": "Cold Drinks",
"descripion": "Cold Drinks for Delivery",
"accessibility": {
"type": "BUSINESS",
"organisations": [
"CAD1E31269B76D7A65ACCE45B2E68DFD"
]
}
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}Returns a list of Product Families
Request parameters
Search for product family based on name, dislay name and description
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
The product family identifier
The product family name
The product family display name
The product family description
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/products/families/ HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "a2b88272-c9e4-418d-83d3-8e7561b4e392",
"name": "Cold Drinks Delivery",
"display_name": "Cold Drinks",
"description": "Cold Drinks for Delivery"
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Return a single product family
Path variables
The product family (identifier) that will be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
The product family identifier
The product family name
The product family display name
The product family description
Defines how the segment can be accessed from business network
Defines which organisations can access and use it
The organisations (Merchants, Service Providers) that can access and use it (applicable only if type = SPECIFIC)
The organisation identifier
The organisation name
GET https://sandbox.crm.com/backoffice/v2/product_families/a2b88272-c9e4-418d-83d3-8e7561b4e392 HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "a2b88272-c9e4-418d-83d3-8e7561b4e392",
"name": "Cold Drinks Delivery",
"display_name": "Cold Drinks",
"description": "Cold Drinks for Delivery",
"accessibility": {
"type": "ACROSS_NETWORK",
"organisations": [
{
"id": "feedcd4b-8470-04b3-73bf-9ce9a4340822",
"name": "CRM"
}
]
}
}{id}Update a product family
Path variables
The product family (identifier) that will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The product family name which is unique
The product family display name
The product family description
Defines which organisations can be access and use it
Defines which organisations can access and use it
The organisations (Merchants, Service Providers) that can access and use it (applicable only if type = SPECIFIC)
Responses
Body
The product family identifier
PUT https://sandbox.crm.com/backoffice/v2/products/families/283ec6c8-db3d-07e2-be54-6e4baeca6196 HTTP/1.1
Content-Type: application/json
{
"name": "Cold Drinks Delivery",
"display_name": "Cold Drinks",
"descripion": "Cold Drinks for Delivery",
"accessibility": {
"type": "ACROSS_NETWORK",
"organisations": [
"CAD1E31269B76D7A65ACCE45B2E68DFD"
]
}
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "283ec6c8-db3d-07e2-be54-6e4baeca6196"
}{id}Delete an existing product family
Path variables
The product family (identifier) that will be deleted
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
DELETE https://sandbox.crm.com/backoffice/v2/products/families/a2b88272-c9e4-418d-83d3-8e7561b4e392 HTTP/1.1
HTTP/1.1 204 No Content Product Synchronisation utility settings
Retrieve the setting of the product synchronisation process
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
Defines whether synced product brands, families and categories will be automatically created into CRM (applicable only if such attributes do not exist)
Defines whether existing product categories will be removed or not from the synced product. If attribute is false, then the existing categories will be removed and new ones will be set - otherwise, the existing ones will not be removed and new ones will be added as well
Defines whether existing product name will be overwritten or not. If attribute is false, then the existing name will be replaced by the synced one - otherwise, the existing one will not be updated
The product brand that will be automatically set on a product (applicable only if the synced product does not have a brand attribute during synchronization)
The brand identifier
The brand name
The product family that will be automatically set on a product (applicable only if the synced product does not have a family attribute during synchronization)
The family identifier
The family name
The product category that will be automatically set on a product (applicable only if the synced product does not have a category attribute during synchronization)
The category identifier
The category name
The product type that will be automatically set on a product (applicable only if the synced product does not have a type attribute during synchronization)
The type identifier
The type name
GET https://stagingapi.crm.com/backoffice/v1/product_synchronisation_settings HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"auto_generated_config": true,
"product_brand": {
"id": "",
"name": ""
},
"product_family": {
"id": "",
"name": ""
},
"product_category": {
"id": "",
"name": ""
},
"product_type": {
"id": "",
"name": ""
}
}Update the settings of the product synchronisation process
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The product brand that will be automatically set on a product (applicable only if the synced product does not have a brand attribute during synchronization)
The product family that will be automatically set on a product (applicable only if the synced product does not have a family attribute during synchronization)
The product category that will be automatically set on a product (applicable only if the synced product does not have a category attribute during synchronization)
The product type that will be automatically set on a product (applicable only if the synced product does not have a type attribute during synchronization)
Defines whether synced product brands, families and categories will be automatically created into CRM (applicable only if such attributes do not exist)
Defines whether existing product categories will be removed or not from the synced product. If attribute is false, then the existing categories will be removed and new ones will be set - otherwise, the existing ones will not be removed and new ones will be added as well
Defines whether existing product name will be overwritten or not. If attribute is false, then the existing name will be replaced by the synced one - otherwise, the existing one will not be updated
Responses
PUT https://stagingapi.crm.com/backoffice/v1/product_synchronisation_settings HTTP/1.1
Content-Type: application/json
{
"auto_generated_config": true,
"product_brand_id": "",
"product_family_id": "",
"product_category_id": "",
"product_type_id": ""
}Product Types are used to group together products based on their basic CRM.COM related charecteristic such as their classification and composition. A Product’s behaviour is based on its product’s characteristics.
{id}{id}{id}Create a new product type. A single Product Type can be created per Web API call
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The name of the product type which is unique
The display name of the product type
The description of the product type
Defines whether products of classification TRACEABLE_PHYSICAL_GOOD or NON_TRACEABLE_PHYSICAL_GOOD are stockable or not
Defines whether products of classification NON_TRACEABLE_PHYSICAL_GOOD are modifiers of products or not. Only Flat products can be classified as modifiers
Defines whether it is allowed for a stockable product’s stock balance to go below zero
Defines whether product of this type are provisionable or not. Applicable for classifications: TRACEABLE_PHYSICAL_GOOD (flat and fixed bundle), TERMED_SERVICE (flat and fixed bundle) and ONE_TIME_SERVICE (flat)
List of attributes that can be set on the product. The list includes just the attributes, their values are set on creating the product.
Unique identifier of the characteristic
Defines whether this attribute will be mandatory to be specified and have a value when creating a new product. Defaults to False
List of values that will be available for selection when setting up the characteristic on the product of this type
[
"RED", "WHITE"
]Responses
Body
The unique indentifier of the newlly created product type
POST https://sandbox.crm.com/backoffice/v2/products/types HTTP/1.1
Content-Type: application/json
{
"name": "Decoders",
"display_name": "Decoders",
"description": "Used to set up various Decoder products",
"classification": "TRACEABLE_PHYSICAL_GOOD",
"composition_method": "FLAT",
"is_stockable": true,
"is_modifier": "false",
"negative_balance_allowed": "false",
"is_provisionable": "false",
"characteristics": [
{
"id": "2c0809f-ed91-4b68-b912-5bd6064d901e",
"mandatory": true,
"values": [
""
]
}
]
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "2c0809f-ed91-4b68-b912-5bd6064d901e"
}{id}Updates an existing product type. A single product type can be updated per Web API call.
Path variables
The product type identifier that will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The name of the product type which is unique
The display name of the product type
Product type description
Defines whether products of classification TRACEABLE_PHYSICAL_GOOD or NON_TRACEABLE_PHYSICAL_GOOD are stockable or not
Defines whether products of classification TRACEABLE_PHYSICAL_GOOD or NON_TRACEABLE_PHYSICAL_GOOD are modifiers of products or not
Defines whether product of this type are provisionable or not. Applicable for classifications: TRACEABLE_PHYSICAL_GOOD (flat and fixed bundle), TERMED_SERVICE (flat and fixed bundle) and ONE_TIME_SERVICE (flat)
Applicable for stockable physical goods only. Defines is their balanc ein the warehouse can go below 0.
List of characteristics to be set on products of this type.
Characteristic unique identifier
Characteristic is mandatory to be set on products or not
Available values that can be set on characteristics when selected to be added on a product
[
"RED", "WHITE"
]Responses
Body
The unique identifier of the updated product type
PUT https://sandbox.crm.com/backoffice/v2/product_types/d76f36ef-824f-a57c-4642-0afb4901d5a1 HTTP/1.1
Content-Type: application/json
{
"name": "Decoders",
"display_name": "Decoders",
"description": "HD and SD descoders",
"composition_method": "FLAT",
"is_stockable": true,
"is_modifier": "false",
"is_provisionable": "true",
"negative_balance_allowed": true,
"characteristics": [
{
"id": "d76f36ef-824f-a57c-4642-0afb4901d5a1",
"mandatory": true,
"values": [
""
]
}
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "2c0809f-ed91-4b68-b912-5bd6064d901e"
}{id}Deletes a Product Type
Path variables
The product type identifier that will be deleted
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
DELETE https://sandbox.crm.com/backoffice/v2/products/types/d76f36ef-824f-a57c-4642-0afb4901d5a1 HTTP/1.1
HTTP/1.1 204 No Content Returns a list of product types
Request parameters
Search for product types based on their Name, Display Name or Description
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
If specified, then only product types classified as modifiers are returned
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
The identifier of the product type
The name of the product type
The display name of the product type
Product type description
Defines whether products of classification TRACEABLE_PHYSICAL_GOOD or NON_TRACEABLE_PHYSICAL_GOOD are stockable or not
Defines whether products of classification TRACEABLE_PHYSICAL_GOOD or NON_TRACEABLE_PHYSICAL_GOOD are modifiers of products or not
Defines whether product of this type are provisionable or not. Applicable for classifications: TRACEABLE_PHYSICAL_GOOD (flat and fixed bundle), TERMED_SERVICE (flat and fixed bundle) and ONE_TIME_SERVICE (flat)
Defines whether stockable physical goods’ balance can go below 0 in the warehouse
Number of characteristics set for this prodyuct type
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/products/types/ HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "Decoders",
"display_name": "Decoders",
"description": "All Decoder products",
"classification": "TRACEABLE_PHYSICAL_GOOD",
"composition_method": "FLAT",
"is_stockable": true,
"is_modifier": "false",
"is_provisionable": "false",
"negative_balance_allowed": "false",
"characteristics": 3
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Returns a single Product Type
Path variables
The product type identifier that will be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
The identifier of the product type
The name of the product type
The display name of the product type
Product type description
Defines whether products of classification TRACEABLE_PHYSICAL_GOOD or NON_TRACEABLE_PHYSICAL_GOOD are stockable or not
Defines whether products of classification TRACEABLE_PHYSICAL_GOOD or NON_TRACEABLE_PHYSICAL_GOOD are modifiers of products or not
Defines whether product of this type are provisionable or not. Applicable for classifications: TRACEABLE_PHYSICAL_GOOD (flat and fixed bundle), TERMED_SERVICE (flat and fixed bundle) and ONE_TIME_SERVICE (flat)
Defines if stockable phsical goods balance can go below 0 in the warehouse
List of characteristic that can be set on products of this type.
Characteristic unique identifier
Characteristic key
Allowed values that this attribute can have when set on the product
Defines whether this attribute must be set on the product or not
Attribute’s label
GET https://sandbox.crm.com/backoffice/v2/products/types/d76f36ef-824f-a57c-4642-0afb4901d5a1 HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "d76f36ef-824f-a57c-4642-0afb4901d5a1",
"name": "Decoders",
"display_name": "Decoders",
"description": "All decoders",
"classification": "TRACEABLE_PHYSICAL_GOOD",
"composition_method": "FLAT",
"is_stockable": true,
"is_modifier": "false",
"is_provisionable": "false",
"negative_balance_allowed": "false",
"characteristics": [
{
"id": "d76f36ef-824f-a57c-4642-0afb4901d5a1",
"key": "colour",
"values": [
""
],
"mandatory": true,
"label": "Colour"
}
]
}Additional attributes that can be set on product to provide additional information of their nature, behaviour or usage. Characteristics are included in Product types so as to define for which products they are avialable to be set
{id}{id}Creates a new Characteristic for Products. A single Characteristics can be created per Web API call.
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The characteristic’s key which is unique. The key must not include spaces
The characteristic’s label which is unique
The characteristic’s description
List of values that are available for this attribute. An attribute can have from one to multiple values (at least one must be specified)
The name of the attribute value. The name must be unique across the rest of the variant attribute’s values.
Responses
Body
The unique identifier of the new Characteristic
POST https://sandbox.crm.com/backoffice/v2/products/characteristics HTTP/1.1
Content-Type: application/json
{
"key": "colour",
"label": "Colour",
"description": "The colour of the product",
"values": [
{
"name": "RED"
}
]
}Returns a list of Characteristics that can be set in Products
Request parameters
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Search for variants based on key, label and description
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
The unique identifier of the characteristic
The characteristic’s key which is unique
The characteristic’s label i.e. how it is displayed in the UI
The variant characteristic’s description
List of values that are available for this attribute. An attribute can have from one to multiple values.
The unique identifier of the attribute value
The name of the attribute value as this will be displayed
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/products/characteristics/ HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "3dc0809f-ed91-4b68-b912-5bd6064d901e",
"key": "colour",
"label": "Colour",
"description": "The colour of the product",
"values": [
{
"id": "2dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "Red"
}
]
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Updates an existing Characteristic. A single Characteristic can be updated per Web API call.
Path variables
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The characteristic’s key which is unique. The key must not include spaces
The characteristic’s label which is unique
The characteristic’s description
List of values that are available for this attribute. An attribute can have from one to multiple values. At least one must be specified.
The name of the attribute value. The name must be unique across the rest of the variant attribute’s values.
Responses
Body
The unique identifier of the updated Characteristic
PUT https://sandbox.crm.com/backoffice/v2/products/characteristics/{id} HTTP/1.1
Content-Type: application/json
{
"key": "colour",
"label": "Colour",
"description": "The colour of the product",
"values": [
{
"name": "Red"
}
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}{id}Deletes an existing Characteristic. A single characteristic can be deleted per Web API call.
Path variables
Characteristic unique identifier
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
DELETE https://sandbox.crm.com/backoffice/v2/products/characteristics/4dc0809f-ed91-4b68-b912-5bd6064d901e HTTP/1.1
HTTP/1.1 204 No Content Tier path rules group together termed services so as to facilitate service changes. If a termed service is in a tiered path, then it can only be changed into another service within the same path. If service is not included in any path, then it can be changed into any other service again, not in any path.
{id}{id}{id}Creates a new tier path that includes a list of termed services. A path must have at least two services
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Tier path name
Tier path description
The tier path for a list of service products.
The unique identifier of a product. The product must be classified as a termed service
The tier level of the product within the path. Each level is unique
Responses
Body
The unique identifier of the newlly created tier path
POST https://sandbox.crm.com/backoffice/v2/products/tier_paths HTTP/1.1
Content-Type: application/json
{
"name": "Packages",
"description": "Packages tiering path",
"tiers": [
{
"product_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"level": 1
}
]
}Returns a list of product tier paths
Request parameters
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Search for product types based on their Name or Description
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
Tier path uniue identifier
Tier path name
Tier path description
Number of services included in the Tier path
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/products/tier_paths/ HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "Packages",
"description": "Packages changes",
"services": 5
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Returns a single product tier path
Path variables
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
Tier path name
Tier path description
List of tered services included in the tier path.
Termed service product included in the tier path
Product identifier
Product SKU
Product name
Service’s level wihin the path
GET https://sandbox.crm.com/backoffice/v2/products/tier_paths/{id} HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"name": "Packages",
"description": "Packages changes",
"tiers": [
{
"product": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"sku": "GLD",
"name": "Gold"
},
"level": 1
}
]
}{id}Updates an existing tier path
Path variables
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Tier path name
Tier path description
List of termed services included in the Tier path
The unique identifier of a product. The product must be classified as a tiered service
The tier level of the product within the path
Responses
Body
The unique identifier of the updated tier path
PUT https://sandbox.crm.com/backoffice/v2/products/tier_paths/{id} HTTP/1.1
Content-Type: application/json
{
"name": "Packages",
"description": "Packages changes",
"tiers": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"level": 2
}
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}{id}Deletes a tier path
Path variables
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
DELETE https://sandbox.crm.com/backoffice/v2/products/tier_paths/{id} HTTP/1.1
HTTP/1.1 204 No Content A reward scheme is a reward plan made by the business to target specific market groups (e.g. families, students) and through dedicated reward offers to provide awards based on their behavior.
There are two types of schemes
- Open Loop Schemes where contacts can be auto-signed up (e.g. on registration) or self-signed up
- Closed Loop Schemes where contacts can be signed up in a controlled manner (request to join), usually based on a specific email domains. Closed loop sign ups are controlled based on unique codes that are automatically generated and communicated only to the targeted market group (e.g. contacts that have a “crm(dot)com” email address)
Reward Offers are incentives for awarding contacts a cashback amount that can be redeemed to an open balance. Each offer defines a goal that contacts should reach in order to earn an award, along with the conditions that the award can be redeemed.
The reward offers are grouped into the following goals; where each offer goal has distinct types of offer types affecting how a contact can be awarded
- Reward Achievement handles awarding contacts when they reach an accomplishment of pushing past a goal post (e.g. Facebook like)
- Lottery awards a specific market group (contact segmentation) by picking a winner on a lottery basis (event: time). Enhancements for lottery
- Thank You Gift does an ad-hoc award to a specific market group (contact segmentation) (event: time)
- Achievement awards contact’s accomplishments of pushing past a goal post
- Reach a Tier awards contacts for advancing to the next tier (event: advance to next tier)
- Subscription Maturity awards contacts for being loyal subscribers, i.e. uninterrupted subscriptions based on subscription activation date, ignoring disconnection (event: time lapsed based on subscription activation date)
- Increase Spend handles awarding contacts based on their purchases (e.g. product bundle, venue based)
- Monetary Discount awards contacts on their overall purchase value (e.g. 1% cashback, 50% birthday discount) (event: purchase)
- Products Discount awards contacts based on a group of purchased products (event: purchase)
- Improve Memberships handles awarding contacts based on their incentive to promote/support the organisation (e.g. sign up)
- Sign up awards new contacts (event: account registration)
- Referral awards existing contacts who have referred new contacts (event: referral event & -optional- purchase from the referred contact/account)
- Profile Completeness awards contacts that provided their personal data (e.g. email address, date of birth) (event: contact update)
- Increase Visits handles awarding contacts based on the date/time of their purchases (e.g. time based)
- Happy Hour awards contacts’ purchases based on specific locations/time (event: purchase)
Retrieve the reward settings for an organisation
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
Defines from which reward offers contacts will be awarded
Defines which reward offers will be provided
Defines only if the best instant discount offer will be provided. Applicable only if the resolution method = ALL_MATCHED_OFFERs
Defines whether awards will be restricted (not provided) when wallet (commerce) balance is spent
Defines how contacts can redeem their awards
The redeem method that will be applied
The payout reconciliation that will be appled for redeemed amounts
Defines whether payout reconciliation is enabled or not
Defines how redeemed amount will be payout to the contact
Details about the related type
The type identifier
The type name
Details about the integration
The integration identifier
The integration name
Defines the minimum amount that should be met in order to post a payout (minimum amount = available wallet balance + redeem amount from current purchase)
Defines how reward tiering will be calculated based on contact purchase behavior
Defines whether reward tiers are supported or not
Defines the conversion rate between real currency and value units
Defines the unit of time that tiering will be applied
Defines the interval based on which contact will be advanced/downgraded to a tier
The date when contacts will be tiered for the first time
Defines whether contacts can advance to the next tier as soon as the next tier’s value units are reached
Information about the reward tiers
The tier identifier
The tier name
The tier description
The tier color (used for marketing purposes)
The tier value units (inclusive)
The creative identifier
Information about the creative type
Partner logos configurable by SO, applicable for Business, Merchant, Venue
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
Applicable only for Applications
The creative width
The creative height
The creative format
The creative content URL
The creative public identifier
Information about the creative transformations
The transformed creative width
The transformed creative height
The transformed creative URL
Defines which reward offers types can be setup within a buiness network
Defines whether reward offer restrictions is enabled or not
Defines the offer types that will be allowed to be created
The offer type (each goal is related with a type)
Defines which redeem methods are allowed
Defines which redeem methods are allowed
Defines how purchase events will be matched (against a transaction processor or as stand-alone purchases)
The mode that will be applied on purchase matching resolution
List of all organisations that will have different match mode
Details about the organisation from where such event was posted
The organisation identifier
The organisation name
Defines how purchased products will be matched (identified): against performed by organisation or not
Defines whether purchased product matching is enabled or not
GET https://sandbox.crm.com/backoffice/v2/rewards/settings HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"resolution": {
"resolution_method": "ALL_MATCHED_OFFERS",
"only_best_discount": "true",
"restrict_awards": "false"
},
"reward_tiers": {
"enable_tier": "true",
"conversion_rate": 1000,
"tier_evaluation": "TIME_INTERVAL",
"tier_interval": 12,
"initial_month": "OCTOBER",
"auto_advance": "false",
"tiers": [
{
"id": "TIER001234543212345678UJIKY76HJR",
"name": "Gold",
"description": "Gold Customers",
"color": "#d4af37",
"value_units": 150000,
"creatives": [
{
"id": "CA123456789AQWSXZAQWS1236547896541",
"usage_type": "PROFILEIMAGE",
"width": 2159,
"height": 3075,
"format": "jpg",
"url": "https://assets.crm.com/image/logo.jpg",
"public_id": "crm-com/image",
"media": [
{
"width": 200,
"height": 300,
"url": "https://asset.crm.com/image/offer/c_scale,w_200/logo.jpg"
}
]
}
]
}
]
},
"offer_restrictions": {
"enable_restrictions": "true",
"offer_types": [
"BUNDLE"
],
"redeem_methods": [
"INSTANT"
]
},
"purchase_matching": {
"mode": "TP_MODE",
"explicit_mode": [
{
"organisation": {
"id": "4248fab3-67d5-2eb1-eaf6-079ce18cd2ed",
"name": "Bravo Coffee"
}
}
]
}
}Update the reward settings
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Defines from which reward offers contacts will be awarded
Defines which reward offers will be provided
Defines only if the best instant discount offer will be provided. Applicable only if the resolution method = ALL_MATCHED_OFFERs
Defines whether awards will be restricted (not provided) when wallet (commerce) balance is spent
Defines how contacts can redeem their awards
The redeem method that will be applied
The payout reconciliation that will be appled for redeemed amounts
Defines how redeemed amount will be payout to the contact
The payout (financial transaction) type that will be used for paying out the redeem amount - if not defined then the default payout type will be used
The integration through which payouts will be posted (applicable only if method is payment gateway)
Defines the minimum amount that should be met in order to post a payout (minimum amount = available wallet balance + redeem amount from current purchase)
Defines how reward tiering will be calculated based on contact purchase behavior
Defines whether reward tiers are supported
Defines the conversion rate between real currency and value units
Defines the unit of time that tiering will be applied
Defines the interval based on which customer will be advanced/downgraded to a tier (Applicable only if the tier evaluation is based on time interval)
The date when contacts will be tiered for the first time
Defines whether customers can advance to the next tier as soon as the next tier’s value units are reached
Supported reward tiers
The tier identifier
The tier name
The tier description
The tier color (used for marketing purposes)
The tier value units (inclusive)
The tier related media group (identifier)
Defines which reward offers types can be setup within a buiness network
Defines whether reward offer restrictions is enabled or not
Defines the offer types that will be allowed to be created
The offer type (each goal is related with a type)
Defines which spend methods are allowed
Defines which redeem methods are allowed
Defines how purchase events will be matched (against a transaction processor or as stand-alone purchases)
The mode that will be applied on purchase matching resolution
List of all organisations that will have different match mode
The organisation (identifier) that will have different match mode
Defines how purchased products will be matched (identified): against performed by organisation or not
Defines whether purchased product matching against the performed organisation is enabled or not
Responses
The request has succeeded
Body
The organisation identifier
PUT https://sandbox.crm.com/backoffice/v2/rewards/settings HTTP/1.1
Content-Type: application/json
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
{
"resolution": {
"resolution_method": "ALL_MATCHED_OFFERS",
"only_best_discount": "true"
},
"reward_tiers": {
"enable_tier": "true",
"conversion_rate": 1000,
"tier_evaluation": "SIGN_UP_DATE",
"tier_interval": 12,
"initial_month": "MAY",
"auto_advance": "true",
"tiers": [
{
"id": "6064cd43-1ab5-08fb-6c47-2c4ad3af03d9",
"name": "Gold",
"description": "Gold Customers",
"color": "#d4af37",
"value_units": 150000,
"media_group_id": "3ac1788d-cead-365b-25a5-9d0854c40c1f"
}
]
},
"offer_restrictions": {
"enable_restrictions": "false",
"offer_types": [
"BUNDLE"
],
"redeem_methods": [
"INSTANT"
]
},
"purchase_matching": {
"mode": "TP_MODE",
"explicit_mode": [
{
"organisation_id": "3b21975a-e072-a6cc-c424-63d69ac9ef7e"
}
]
}
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "a6984610-f1da-247d-83a9-a63f1c945391"
}Retrieve the security settings for an organisation
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
Details about password policy for users
Details about password expiration
Defines whether user passwords will be expired or not
Defines in how long password will be expired (in days)
Defines in how long users will be notified for upcoming expired passwords (in days)
Settings about strong password
Defines whether strong password will be required for contacts or not
Defines whether strong password will be enhanced for users or not
The explicit strong password policy for users
The minimum length that a password should have
Details about concurrent sessions for contacts and users
Defines whether concurrent session policy will be applied
Max allowed user concurrent sessions
Details about two factor authentication
Defines whether two factor authentication will be required for users or not
Details about OIDC settings
Defines whether OIDC is enabled or not
The OIDC settings (e.g. oAuth redirection URL, scope) that will be used as part of the OIDC flow
The application (identifier) as configured in the OIDC provider
GET https://sandbox.crm.com/backoffice/v2/security/settings HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"password_policies": {
"expiration": {
"is_enabled": true,
"period": 15
}
},
"concurrent_sessions": {
"is_enabled": "true",
"contact_sessions": 3,
"user_sessions": 3
}
}Update the security settings (e.g. password policy)
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Details about password policy for users
Details about password expiration
Defines whether user passwords will be expired or not
Defines in how long password will be expired (in days)
Defines in how long users will be notified for upcoming expired passwords (in days)
Settings about strong password
Defines whether strong password will be required for contacts or not
Defines whether strong password will be enhanced for users or not
The explicit strong password policy for users
The minimum length that a password should have
Details about concurrent sessions for contacts and users
Defines whether concurrent session policy will be applied
Max allowed user concurrent sessions
Details about two factor authentication
Defines whether two factor authentication will be required for users or not
Details about OIDC settings
Defines whether OIDC is enabled or not
The OIDC settings (e.g. oAuth redirection URL, scope) that will be used as part of the OIDC flow
The application (identifier) as configured in the OIDC provider (required if OIDC is enabled)
Responses
The request has succeeded
Body
The organisation identifier
PUT https://sandbox.crm.com/backoffice/v2/security/settings HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"password_policies": {
"expiration": {
"is_enabled": "true",
"period": 15
}
},
"concurrent_sessions": {
"is_enabled": "true",
"contact_sessions": 3,
"user_sessions": 3
}
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "fc286176-12f8-cb96-bd00-fb4d4fa80680"
}{id}/api_keys{org_id}/api_keys/{key_id}{org_id}/api_keys/{key_id}{org_id}/api_keys{org_id}/api_keys/{key_id}{org_id}/api_keys/{key_id}{id}/api_keysCreate an active API Key for a specific organisation
Path variables
The organisation (identifier) where an API Key will be created
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The api key name
Defines the type of the api key
Responses
The request has succeeded
Body
The api key identifier
The non-encrypted secret key that will be used for subsuquent API authentication
POST https://sandbox.crm.com/backoffice/v2/organisations/f55af35a-29ee-37ba-3be8-036194b46e36/api_keys HTTP/1.1
Content-Type: application/json
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
{
"name": "Registration Portal",
"type": "SECRET"
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "148c2997-8f91-9d6a-7ee8-5d8db4ca7373",
"key": "123465789"
}{org_id}/api_keys/{key_id}Update a single api key of a specific organisation
Path variables
The organisation (identifier) whose api key will be updated
The api key (identifier) that will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The api key name
Defines whether the api key will be active or not
Responses
The request has succeeded
Body
The api key identifier
PUT /organisations/CAD1E31269B76D7A65ACCE45B2E68DFD/apikeys/SEC1E31269B76D7A65ACCE45B2E68DFD HTTP/1.1
Content-Type: application/json
{
"name": "Registration Portal",
"is_active": "false"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "API1E31269B76D7A65ACCE45B2E68DFD"
}{org_id}/api_keys/{key_id}Delete a specific api key from a specific organisation
Path variables
The organisation (identifier) from which api key will be deleted
The api key (identifier) that will be deleted
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
DELETE https://sandbox.crm.com/backoffice/v1/organisations/CAD1E31269B76D7A65ACCE45B2E68DFD/apikeys/CAD1E31269B76D7A65ACCE45B2E68DFD HTTP/1.1
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
HTTP/1.1 200 OK {org_id}/api_keysRetrieve a list of api keys based on search criteria (e.g. all expired api keys)
Path variables
The organisation (identifier) whose api keys will be retrieved
Request parameters
Filter based on the name
Filter based on the api key type
Filters based on whether API Keys are active or not
Filters the default API Key
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The api key identifier
The api key name
Defines the type of the api key
Defines whether the api (public or secret) key is active or not
The public api key’s value
The secret api key obfuscated value
The secret api key encrypted value
Defines the date up until the secret api key will be active
Defines if the api key is the default one (applicable only for public API keys)
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v1/organisations/CAD1E31269B76D7A65ACCE45B2E68DFD/apikeys HTTP/1.1
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "API1E31269B76D7A65ACCE45B2E68DFD",
"name": "Registration Name",
"type": "PUBLIC",
"is_active": "true",
"public_key": "API1E31269B76D",
"obfuscated": "********MG12",
"encrypted": "qwertyasd123",
"active_end": 1580292120,
"is_default": "false"
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{org_id}/api_keys/{key_id}Retrieve detailed information for an api key
Path variables
The organisation (identifier) whose api keys will be retrieved
The api key (identifier) that will be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
The api key identifier
The api key name
Defines the type of the api key
Defines whether the api key is active or not
The public api key value
The secret api key obfuscated value
The secret api key encrypted value
Defines the date up until the secret api key will be active
Defines if the api key is the default one (applicable only for public API keys)
Retrieve details for a public API Key
GET https://sandbox.crm.com/backoffice/v2/organisations/f55af35a-29ee-37ba-3be8-036194b46e36/api_keys/bdbe6526-10ce-f4e2-6f38-623b0a7fef80 HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "bdbe6526-10ce-f4e2-6f38-623b0a7fef80",
"name": "Registration Key",
"type": "PUBLIC",
"is_active": true,
"public_key": "API1E31269B76D",
"is_default": true
}Retrieve details for a secret API Key
GET https://sandbox.crm.com/backoffice/v2/organisations/f55af35a-29ee-37ba-3be8-036194b46e36/api_keys/bdbe6526-10ce-f4e2-6f38-623b0a7fef80 HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "bdbe6526-10ce-f4e2-6f38-623b0a7fef80",
"name": "Registration Key",
"type": "SECRET",
"is_active": true,
"obfuscated": "********ML71",
"encrypted": "qwerty1234a8",
"active_end": 1580292120,
"is_default": false
}{org_id}/api_keys/{key_id}Perform actions on an existing api key (e.g. roll secret api key)
Path variables
The organisation (identifier) of which api key will be updated
The api key (identifier) that actions will be applied
Notes
Only secret keys can be rolled. The previous key will be revoked (and no longer can be used until expired), while a new one will be generated based on GUID standard methods.
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The action that will be applied on the api key
Defines up until the api key will be valid (applicable only for secret api key and on roll action)
Responses
The request has succeeded
Body
The api key identifier
The non-encrypted api key value that will be used for subsuquent API authentication
POST https://sandbox.crm.com/backoffice/v2/organisations/f55af35a-29ee-37ba-3be8-036194b46e36/api_keys/bdbe6526-10ce-f4e2-6f38-623b0a7fef80 HTTP/1.1
Content-Type: application/json
authorization: eyJraWQiOiIvcHJpdmF0ZUtleS5wZW0iLCJ0eXAiOiJKV
{
"action": "ROLL",
"expiry_date": 1582034284
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "a6126f78-f880-7bd8-ebcd-7e5397b59c80",
"key": "123456789"
}{id}{id}{id}Create a new team
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The team name
The team description
Responses
The request has succeeded
Body
The team identifier
POST https://sandbox.crm.com/backoffice/v2/teams HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"name": "Admin",
"description": "Admin Team"
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "609de9a4-8220-be54-63ca-a7044b1326e0"
}{id}Update an existing team
Path variables
The team (identifer) that will be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The team name
The team description
Responses
The request has succeeded
Body
The team identifier
PUT https://sandbox.crm.com/backoffice/v2/teams/dfdeb9f9-003d-fca7-c548-0a88676bb9cf HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"name": "Admin",
"description": "Admin Team"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "609de9a4-8220-be54-63ca-a7044b1326e0"
}{id}Delete an existing team
Path variables
The team (identifer) that will be deleted
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
DELETE https://sandbox.crm.com/backoffice/v2/teams/dfdeb9f9-003d-fca7-c548-0a88676bb9cf HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 204 No Content Retrieve a list of teams based on search criteria (e.g. all “admin” teams)
Request parameters
Filters based on the team name
Defines whether the number of users per team will be retrieved
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The team identifier
The team name
The team description
The number of users that belong to the team
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/teams?include_user_count=true HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "a9dca18e-1d60-8d5b-cf46-848d9fa91dd6",
"name": "Admin",
"description": "Admin Team",
"users_count": 112
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Retrieve detailed information for a team
Path variables
The team (identifer) that will be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The team identifier
The team name
The team description
GET https://sandbox.crm.com/backoffice/v2/teams/d64e7544-aba8-d6de-f8d0-54e02b1daba3 HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "6646193b-9177-1d1a-aca9-7c16ee67e786",
"name": "Admin",
"description": "Admin Team Description"
}{id}{id}{id}Create a new user role
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The user role name
The user role description
Defines whether the role will be used as the owner role on new sign ups
Defines whether the role can be used across all child business network
The user role permissions
Responses
The request has succeeded
Body
The user role identifier
POST https://sandbox.crm.com/backoffice/v2/users/roles HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"name": "Rewards Manager",
"description": "Provide full access to rewards module",
"is_owner": "false",
"is_default": "false",
"permissions": [
"CONTACT_READ"
]
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "01bdde91-ba65-dcb1-02c2-131c641ea8da"
}{id}Update an existing user role
Path variables
The user role (identifer) that will be updated
Notes
Admin (owner) user role is the first user role that is created in an organisation and is assigned to the user that registered such organisation. Admin (owner) user role has full access and cannot be updated.
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The user role name
The user role description
Defines whether the role will be used as the owner role on new sign ups
Defines whether the role can be used across all child business network
The user role permissions
Responses
The request has succeeded
Body
The user role identifier
PUT https://sandbox.crm.com/backoffice/v2/users/roles/9ea0181c-73be-c44e-9ef2-a0b26c585423 HTTP/1.1
Content-Type: application/json
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
{
"name": "Rewards Manager",
"description": "Provide full access to rewards module",
"is_owner": "false",
"is_default": "false",
"permissions": [
"CONTACT_WRITE"
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "9ea0181c-73be-c44e-9ef2-a0b26c585423"
}{id}Delete an existing user role
Path variables
The user role (identifer) that will be deleted
Notes
Admin (owner) user role is the first user role that is created in an organisation and is assigned to the user that registered such organisation. Admin (owner) user role has full access and cannot be deleted.
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
DELETE https://sandbox.crm.com/backoffice/v2/users/roles/9ea0181c-73be-c44e-9ef2-a0b26c585423 HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 204 No Content Retrieve a list of user roles based on search criteria (e.g. all user roles)
Request parameters
Filter based on user role name
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The user role identifier
The user role name
The user role description
Defines whether the role will be used as the owner role on new sign ups
Defines whether the role can be used across all child business network
Defines whether the role provides full access to all product areas
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/users/roles HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "9ea0181c-73be-c44e-9ef2-a0b26c585423",
"name": "Rewards Manager",
"description": "Provides full access on Rewards module",
"is_owner": false,
"is_default": true,
"is_full_access": false
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Retrieve detailed infromation for a user role
Path variables
The user role (identifer) that will be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The user role identifier
The user role name
The user role description
The user role permissions
[
"CONTACT_READ",
"CONTACT_WRITE"
]Defines whether the role will be used as the owner role on new sign ups
Defines whether the role can be used across all child business network
Defines whether the role has full permissions
GET https://sandbox.crm.com/backoffice/v2/users/roles/9ea0181c-73be-c44e-9ef2-a0b26c585423 HTTP/1.1
api_key: 4dc0809f-ed91-4b68-b912-5bd6064d901e
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "9ea0181c-73be-c44e-9ef2-a0b26c585423",
"name": "Rewards Manager",
"description": "Rewards module full access",
"permissions": [
"CONTACT_READ"
],
"is_owner": false,
"is_default": true,
"is_full_access": false
}Get the generic settings for Service Requests
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
The request has succeeded
Body
The type of the event
The entity for which the numbering scheme is configured
The prefix of the numbering scheme. Defaults to the first letter(s) of the entity’s name
The starting number of the nuberig scheme (excluding prefix). Defaults to 10001
Number of digits (excluding prefix). Defaults to 5
The last number generated for this numbering scheme
Retreives the priority model configured for this organisation
GET https://sandbox.crm.com/backoffice/v2/service_requests/settings HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"numbering_schemes": {
"entity": "SERVICE_REQUESTS",
"prefix": "SR",
"starting_number": "0000001",
"number_of_digits": "7",
"last_number": "SR000001"
},
"priorities_model": {
"impact": "HIGH",
"urgency": "HIGH"
}
}Update generic service request settings
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Service request numbering scheme settings, service request numbers are automatically generated by the system
Entity name
Service request number prefix
Starting number
Number of digits for service request number, not including prefix
Set up the service request priorities model based on impact and urgency
Responses
The request has succeeded
Body
Service requets settings identifier
PUT https://sandbox.crm.com/backoffice/v2/service_requests/settings HTTP/1.1
Content-Type: application/json
{
"numbering_schemes": [
{
"entity": "SERVICE_REQUESTS",
"prefix": "SR",
"starting_number": "00001",
"number_of_digits": 5
}
],
"priorities_model": {
"urgency": "HIGH",
"impact": "HIGH",
"priority": "HIGH"
}
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}Queues define the stages that a Service Request will progress through until it’s closed. Multiple queues can be defined, and one of these must be assigned to each Service Request when it’s created.
{id}{id}{id}{id}/stages/{stage_id}Create a queue and it’s stages to be used for service requests. Optionally define alert times, closure times for the various priorities of the queue and permitted categories.
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
A unique name for the queue
The state of the queue
Can be assigned to service requests
Can’t be used
Queue stages information
The order of the stage within the queue
The name of the queue stage
Queue stage description
The unique hex colour code representing the stage
The priority relating to the alert/closure time
The unit of time relating to the alert/closure time
The unit value relating to the alert/closure time setting
The priority relating to the alert/closure time
The unit of time relating to the alert/closure time
The unit value relating to the alert/closure time setting
The default priority set for all service requests created for this queue
Service Request category id
Examples
Responses
Body
The unique id of the newly created service request queue
POST https://sandbox.crm.com/backoffice/v2/service_requests/queues HTTP/1.1
Content-Type: application/json
{
"name": "Billing Issues",
"state": "ACTIVE",
"stages": [
{
"order": "4",
"name": "Corresponding with customer",
"description": "Agent is in communication with the customer to reslove the issue",
"colour": "#FAC8890",
"state": "CLOSED"
}
],
"alert_times": [
{
"priority": "MEDIUM",
"time": 4,
"unit": "HOUR"
}
],
"closure_times": [
{
"priority": "MEDIUM",
"time": 4,
"unit": "HOUR"
}
],
"priority": {
"urgency": "HIGH",
"impact": "HIGH"
},
"categories": [
{
"id": "b6e03e7c-6ff6-4a7b-934b-2367fe8383e0"
}
]
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "86f2a0df-7378-4a13-a908-ebc3589b08ba"
}{id}Update an existing service request queue and it’s stages, as well as optional settings
Path variables
The GUID of the queue to be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
A unique name for the queue
The state of the queue
Can be assigned to a service request
Can’t be assigned to a service request
The queues’s stages
The order of the stage within the queue
Stage name
A short description of the stage
The unique hex colour code representing the queue stage
The priority relating to the alert/closure time
The unit of time relating to the alert/closure time
The unit value relating to the alert/closure time setting
The priority relating to the alert/closure time
The unit of time relating to the alert/closure time
The unit value relating to the alert/closure time setting
The default priority set for all service requests created for this queue f
Service Request category id
Examples
Responses
Body
The unique identifier of the updated service request queue
PUT https://sandbox.crm.com/backoffice/v2/service_requests/queues/86f2a0df-7378-4a13-a908-ebc3589b08ba HTTP/1.1
Content-Type: application/json
{
"name": "Billing Issues",
"state": "ACTIVE",
"stages": [
{
"order": "3",
"name": "Investigating",
"description": "Investigating the problem",
"colour": "#2C8EF8",
"state": "NEW"
}
],
"alert_times": [
{
"priority": "MEDIUM",
"time": 4,
"unit": "HOUR"
}
],
"closure_times": [
{
"priority": "MEDIUM",
"time": 4,
"unit": "HOUR"
}
],
"priority": {
"urgency": "HIGH",
"impact": "HIGH"
},
"categories": [
{
"id": "b6e03e7c-6ff6-4a7b-934b-2367fe8383e0"
}
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "86f2a0df-7378-4a13-a908-ebc3589b08ba"
}Retrieve service request queues based on filtering options
Request parameters
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Search for a queue using its name
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
Retrieved service request queue information
The GUID of the queue
The name of the queue
The state of the queue
Number of stages that the queue is comprised of
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/service_requests/queues HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "86f2a0df-7378-4a13-a908-ebc3589b08ba",
"name": "Billing Issues",
"state": "ACTIVE",
"number_of_stages": 5
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Retrieve a service request queue, it’s stages and any other optional settings
Path variables
The GUID of the queue whose details will be retrieved
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
The GUID of the retrieved queue
The queue’s name
The state of the queue
The queue’s stages information
Queue stage id
Stage order within the queue
Stage name
A short decsription of the stage
The unique hex colour code of the stage
Id of the alert/closure time setting
The priority relating to the alert/closure time
The unit of time relating to the alert/closure time
The unit value relating to the alert/closure time setting
Id of the alert/closure time setting
The priority relating to the alert/closure time
The unit of time relating to the alert/closure time
The unit value relating to the alert/closure time setting
The default priority set for all service requests created for this queue
The root service request category id
The root category name
The root category description
Sub-cateogry id
Sub-category name
Sub-category description
GET https://sandbox.crm.com/backoffice/v2/service_requests/queues/bf58e2a0-f73b-4ebb-8425-92ff4253d6be HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "bf58e2a0-f73b-4ebb-8425-92ff4253d6be",
"name": "Billing Issues",
"state": "ACTIVE",
"stages": [
{
"id": "86f2a0df-7378-4a13-a908-ebc3589b08ba",
"order": 5,
"name": "Schedule Service",
"description": "Technical team to schedule the service and notify customer",
"colour": "#FA89CB",
"state": "CANCELLED"
}
],
"alert_times": [
{
"id": "33f6614d-0c25-4bc6-b360-fa74687956b8",
"priority": "MEDIUM",
"time": 4,
"unit": "HOUR"
}
],
"closure_times": [
{
"id": "33f6614d-0c25-4bc6-b360-fa74687956b8",
"priority": "MEDIUM",
"time": 4,
"unit": "HOUR"
}
],
"priority": {
"urgency": "HIGH",
"impact": "HIGH"
},
"categories": [
{
"id": "b6e03e7c-6ff6-4a7b-934b-2367fe8383e0",
"name": "Technical issues",
"description": "Technical issues which can be managed remotely or on-site",
"sub_category": [
{
"id": "2f4ffc37-9463-4f17-9549-dd3cbc24f7e7",
"name": "Receiver Installation (on-site visit)",
"description": "Receiver installation including wiring"
}
]
}
]
}{id}Delete a service request queue. A queue can b deleted as long as there’s no pending Service Request (not completed yet) that uses the queue.
Path variables
The GUID of the service request queue to be deleted
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
DELETE https://sandbox.crm.com/backoffice/v2/service_requests/queues/86f2a0df-7378-4a13-a908-ebc3589b08ba HTTP/1.1
HTTP/1.1 204 No Content {id}/stages/{stage_id}Delete a stage from a service request queue, and transfer any existing service requests currently in that stage to another stage in the same queue
Path variables
The GUID of the queue whose stage will be deleted
The GUID of the queue stage to be deleted
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The new stage id to transfer to.
Responses
DELETE https://sandbox.crm.com/backoffice/v2/service_requests/queues/2964aaff-df07-4798-b585-82a813800b3e/stages/61c943c8-dfeb-4c09-a25c-b054f48bf244 HTTP/1.1
Content-Type: application/json
{
"stage_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}
HTTP/1.1 204 No Content Optionally setup categories to provide a business classification for Service Requests, categories can be defined in a hierarchical structure. Service Request can be assigned multiple categories, and can be used for reporting and filtering purposes.
{id}{id}Create a category for service requests to be assigned to.
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Name of the category. A Category’s name must be uniue within this category’s path.
The description of the category
The id of the parent category
Responses
Body
The unique id of the newly created category
POST https://sandbox.crm.com/backoffice/v2/service_requests/categories HTTP/1.1
Content-Type: application/json
{
"name": "Maintenance",
"descripion": "General maintenance issues",
"parent_id": "33f6614d-0c25-4bc6-b360-fa74687956b8"
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}{id}Update an existing category to which service requests can be assigned to.
Path variables
The id of the category to be updated
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Name of category that has to be unique across the cateogry’s path.
The description of the category
The id of the parent category
Responses
Body
Id of the successfully updated service request category
PUT https://sandbox.crm.com/backoffice/v2/service_requests/categories/4dc0809f-ed91-4b68-b912-5bd6064d901e HTTP/1.1
Content-Type: application/json
{
"name": "Maintenance",
"descripion": "General maintenance issues",
"parent_id": "33f6614d-0c25-4bc6-b360-fa74687956b8"
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}{id}Delete a service request category. A category cannot be deleted if:
- It has been assigned to a service request
- It has child categories, all of its child categories must be deleted first
Path variables
The id of the category to be deleted.
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Successfully deleted
DELETE https://sandbox.crm.com/backoffice/v1/sr_categories/JGSFJHGSHGuy7767JHGSHJFG HTTP/1.1 Return a list of all defined service request categories, or based on filtering parameters.
Request parameters
Retrieve service request categories for a specific queue
Returns all cateogries under this parent category
If set to ‘true’, then all categories are returned, regardless of their parent-child relation
Search for a category based on name and description
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
The id of the category
The name of the category
The decsription of the category
The number of child nodes (if a category is a parent category)
Details pertaining to the parent of this category (if a child category)
The id of the parent category
The name of the parent category
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/service_requests/categories?queue_id=93981d3b-68e6-4a01-915a-8690e5ad79aa HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "33f6614d-0c25-4bc6-b360-fa74687956b8",
"name": "Maintenance on location",
"description": "General maintenance issues carried out on premises",
"child_nodes": 2,
"parent": {
"id": "dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "Maintenance"
}
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}The following API’s relate to the ability to configure closure reasons for service requests. A closure reason must be provided for a service request in cases where a service request is closed without being resolved.
{id}{id}Creates specific closure reasons for service requests
Request headers
Authorization Token
The public api key required for API calls to identify the organisation
Request body
Name of closure reason that as to be unique
Short description for closure reason
Responses
Successfully created
Body
The id of the successfully created closure reason
POST https://sandbox.crm.com/backoffice/v2/service_requests/closure_reasons HTTP/1.1
api_key: 8c54d563-b991-4b76-8a83-557c08166f95
Content-Type: application/json
{
"name": "Terminated account",
"description": "Customer has terminated their account"
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}{id}Update an existing closure reason for service requests
Path variables
Id of the closure reason to be updated
Request headers
Authorization Token
The public api key required for API calls to identify the organisation
Request body
Name of the closure reason. Name must be unique
Terminated account
Responses
Body
Id of the successfully updated closure reason
PUT https://sandbox.crm.com/backoffice/v2/service_requests/closure_reasons/33f6614d-0c25-4bc6-b360-fa74687956b8 HTTP/1.1
api_key: 8c54d563-b991-4b76-8a83-557c08166f95
Content-Type: application/json
{
"name": "Terminated account",
"description": "Customer has terminated their account"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "33f6614d-0c25-4bc6-b360-fa74687956b8"
}Retrieves all closure reasons configured for service requests.
Responses
Body
The id of the closure reason
The name of the closure reason
The description of the closure reason
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/service_requests/closure_reasons HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "33f6614d-0c25-4bc6-b360-fa74687956b8",
"name": "Reffered to installer",
"description": "The service request has been handed over to the installation team"
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Deletes a closure reason. A reason can only be deleted if it was never used in any Service Request.
Path variables
Id of the closure reason to be deleted
Responses
DELETE https://sandbox.crm.com/backoffice/v2/service_requests/closure_reasons/33f6614d-0c25-4bc6-b360-fa74687956b8 HTTP/1.1
HTTP/1.1 204 No Content Configure the required default settings to enable service requests to be created from a self service platform.
{id}/application_settings{id}/application_settings{id}/application_settingsRetrieves the self service application settings configured for a specific queue.
Path variables
Service Request Queue identifier
Responses
Body
Enable the ability to create service requests from a self service platform?
The classification name to be displayed on the self service platform for this queue. Required if state = true.
Details about the user that the record is assigned to
The user identifier
The user name
The username of the user
Details about team
The team identifier
The team name
List of tags added to every service request created from self service. This is applicable when state = true
Default categories assigned to Service Requests raised through front-end platforms for this Service Request queue
GET https://sandbox.crm.com/backoffice/v2/queues/bf58e2a0-f73b-4ebb-8425-92ff4253d6be/application_settings HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"state": true,
"classification": "Billing Issues",
"assign_to": {
"user": {
"id": "47ac694d-6281-b873-bf46-3fd8da334a3a",
"name": "John Doe",
"username": "j_doe@crm.com"
},
"team": {
"id": "bf1370a1-73ad-0bbf-6fef-f2ce1938d4fe",
"name": "Support"
}
},
"tags": [
""
],
"categories": [
""
]
}{id}/application_settingsUpdate the application settings for a single service request queue when creating a service request from a self-service platform.
Path variables
The unique queue id for which application settings will be updated
Request body
Enable the ability to create service requests from a self service platform?
The classification name to be displayed on the self service platform for this queue. Required if state = true.
The user identifier
The team identifier
List of tags that shall be added to every service request created from self service. This is optional when state = true and not required if state = false
Default categories assigned to Service Requests raised through front-end platforms for this Service Request queue
Responses
Body
Id of successfully updated application settings for a service request queue
PUT https://sandbox.crm.com/backoffice/v2/service_requests/queues/33f6614d-0c25-4bc6-b360-fa74687956b8/application_settings HTTP/1.1
Content-Type: application/json
{
"state": true,
"classification": "Billing issues",
"assign_to": {
"user_id": "1edef819-0a1d-4d41-9d2a-d4bbc2ddbedf",
"team_id": "a43f08ca-998b-afbc-6ed4-c9dc2d136935"
},
"tags": [
""
],
"categories": [
""
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "33f6614d-0c25-4bc6-b360-fa74687956b8"
}Retrieve Subscription Settings that include various Subscriptions business rules
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
Defines when services eligible to be deactivated will be picked up by the Service Delivery process to be deactivated.
Defines when the actual deactivation of a service will be performed by also considering the day and time at which the service was activated.
Deactivation will be performed during the day, regardless of the time the service was activated
Deactivation will be performed be also considering the time at which the service was activated. Service is deactivated only afte rthis time of day
Defines the automatic cancellation process’s behaviour. Services being deactivated longer than the specified minimum period of time will be automatically cancelled.
The minimum deactivation period of time duration
The unit of time for the minimum deactivation period.
Rules that describe when a subscriber is allowed to request for a cancellation of services when these are not in contract (contract period ended or service was never in contract).
Settings on when the cancellation is allowed. Once must be specified
Requires a notice period befor cancellation
Immediate cancellation allowed
Cancellation allowed only after the next billing cycle (from the next billing cycle’s start date - inclusive - and onwards)
Applicable and required only if cancellation is allowed On notice
The notice period’s duration
The notice period unit of time
Rules that describe when a subscriber is allowed to request for a cancellation of services when these are still in contract.
Settings on when the cancellation is allowed. Once must be specified
Immediate cancellation allowed
Cancellation allowed only after the cotnract end date (from the contract end date - inclusive - and onwards)
Cancellation allowed only after the next billing cycle (from the next billing cycle’s start date - inclusive - and onwards)
Rules that describe when a subscriber is allowed to request for a regret. If specified then a service can be regretted only X period after its first activation. After this period the service cannot be regretted, but it should be cancelled.
Define whether service regret is allowed or not. If the business does not want to allow service regret, then it should be set to False. If allowed, then a period should be specified
Define when a service regret is allowed, e.g. 14 days after its activation . Mandatory if regret is allowed
The regret period’s unit of time.Mandatory if regret is allowed
Rules that describe how ften and for long a customer can request a service pause. If no rules are specified, then no restrictions are applied hwn pausing a service.
How many days per year a service can be paused.
Maximum allowed number of days that a service can be paused within a year
Definition of the what is a “year” which maps to the service’s first activation date
The service’s first activation date
How many times per year a service can be paused.
How many times within a year a service can be paused (regardless of each paused period’s duration)
Definition of the what is a “year”, i.e. if it’s the calencar year or a year starting from a service’s milestone like its activation date
The service’s first activation date
Restrction on the number of days for each paused period, i.e. everytime that a service is paused, the paused period will have a minimum and a maximum allowed duration. At least one of the tw settings must be specified.
The mininum number of days per paused period
The maximuum number of days per paused period
Rules that describe when a subscriber is allowed to request for a service change. A rule per service change type is allowed.
The service change type.
Settings on when the service change is allowed. Once must be specified
Immediate serice change is allowed
Service change is allowed only after the next billing cycle (from the next billing cycle’s start date - inclusive - and onwards)
Service change is allowed only after the contract end date (from the cotnract end date - inclusive - and onwards)
Rules that define the maximum number of services that a customer can subscribe to. Multiple rules can be specified but they have to be unique i.e. refer to different classification of account.
Maximum number of services that a customer can subscribed to
The account classification of the customer. If specified, then restrictions are applied only to these customers.
The account classification’s unique identifier
The account classification’s name
Rule that determines if and when a service can remain Effective or it’s eligible to move into the Effective state
Account oustanding amount threshold. Service is eligible to go into Effective state if the oustanding amount is less than or equal to the threshold. If not specified, it defaults to 0. Always set in the business’s base currency
If automation is enabled, then service(s) are automatically activated once their outstanding Invoice is settled. When not enabled, then Actvation is performed on request. Activation is successfull as long as the threshold is met.
Rules that describe how often and for long a customer can request for a Grace period to avoif deactivation. If no rules are specified, then no restrictions are applied when applying a grace period to a subscription.
How many days per year services can get a grace period.
Number of days
Definition of what is a year by setting a starting date
How many times a grace period can be provided to a subscription
Number of times
Definition of what is a year during which grace periods can be applied
Minimum and maximum number of days per grace period
Minimum number of days
Maximum number of days
Trial Management rules
Defines at which level the Trial period is applied. Trials are applied per Contact (i.e. contacts get a Trial service only once) or per Service (i.e. subscribing to a service also grants the contact a Trial period)
Each contact can only get Trial service once
Apply trial once per subscribed service.
GET https://sandbox.crm.com/backoffice/v2/subscriptions/settings HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"automatic_deactivations": {
"deactivation_method": "BASED_ON_DAY"
},
"automatic_cancellations": {
"minimum_period": 3,
"uot": "MONTHS"
},
"out_of_contract_cancellation": {
"allow_cancellation": "ON_NEXT_BILLING_CYCLE",
"notice_period": {
"duration": "1",
"uot": "MONTHS"
}
},
"in_contract_cancellation": {
"allow_cancellation": "ON_CONTRACT_END_DATE"
},
"regret": {
"allow_regret": "true",
"regret_period": 14,
"uot": "DAYS"
},
"paused_period": {
"days_per_year": {
"allowed_days": 30,
"starting_from": "SERVICE_FIRST_EFFECTIVE_DATE"
},
"times_per_year": {
"allowed_times": 3,
"starting_from": "SERVICE_FIRST_EFFECTIVE_DATE"
},
"days_per_pause": {
"minimum": 3,
"maximum": 30
}
},
"service_changes": [
{
"change_type": "UPGRADE",
"allow_change": "ON_NEXT_BILLING_CYCLE"
}
],
"service_restrictions": [
{
"maximum_services": 5,
"account_classification": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "VIP"
}
}
],
"activation_rule": {
"threshold": 0.01,
"currency_code": "EUR",
"enable_automation": "true"
},
"grace_period": {
"days_per_year": {
"allowed_days": 30,
"starting_from": "INITIATION_DATE"
},
"times_per_year": {
"allowed_times": 3,
"starting_from": "INITIATION_DATE"
},
"days_per_grace": {
"minimum": 5,
"maximum": 10
}
},
"trial_period": {
"allowed_trials": "CONTACT"
}
}Updates Subscriptions business rules.
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Defines the deactivation process’s behaviour
Defines when the actual deactivation of a service will be performed by also considering the day and time at which the service was activated.
Deactivation will be performed during the day, regardless of the time the service was activated
Deactivation will be performed be also considering the time at which the service was activated. Service is deactivated only afte rthis time of day
Defines the automatic cancellation process’s behaviour. Services being deactivated longer than the specified minimum period of time will be automatically cancelled.If not specified, the automatic cancelledaitons are disabled.
The minimum deactivation period of time duration
The unit of time for the minimum deactivation period.
Rules that describe when a subscriber is allowed to request for a cancellation of services when these are not in contract (contract period ended or service was never in contract).
Settings on when the cancellation is allowed. Once must be specified
Immediate cancellation allowed
Requires a notice period befor cancellation
Cancellation allowed only after the next billing cycle (from the next billing cycle’s start date - inclusive - and onwards)
Applicable and required only if cancellation is allowed On notice
The notice period’s duration
The notice period’s unit of time
Rules that describe when a subscriber is allowed to request for a cancellation of services when these are still in contract.
Settings on when the cancellation is allowed. Once must be specified
Immediate cancellation allowed
Cancellation allowed only after the cotnract end date (from the contract end date - inclusive - and onwards)
Cancellation allowed only after the next billing cycle (from the next billing cycle’s start date - inclusive - and onwards)
Rules that describe when a subscriber is allowed to request for a regret. If specified then a service can be regretted only X period after its first activation. After this period the service cannot be regretted, but it should be cancelled.
Define whether service regret is allowed or not. If the business does not want to allow service regret, then it should be set to False. If allowed, then a period should be specified
Define when a service regret is allowed, e.g. 14 days after its activation . Mandatory if regret is allowed
The regret period’s unit of time.Mandatory if regret is allowed
Rules that describe how ften and for long a customer can request a service pause. If no rules are specified, then no restrictions are applied hwn pausing a service.
How many days per year a service can be paused.
Maximum allowed number of days that a service can be paused within a year
Definition of the what is a “year” which maps to the service’s first activation date
The service’s first activation date
How many times per year a service can be paused.
How many times within a year a service can be paused (regardless of each paused period’s duration)
Definition of the what is a “year”, i.e. if it’s the calencar year or a year starting from a service’s milestone like its activation date
The service’s first activation date
Restrction on the number of days for each paused period, i.e. everytime that a service is paused, the paused period will have a minimum and a maximum allowed duration. At least one of the tw settings must be specified.
The mininum number of days per paused period
The maximum number of days per paused period
Rules that describe when a subscriber is allowed to request for a service change. A rule per service change type is allowed.
Service change type
Settings on when the service change is allowed. Once must be specified
Immediate serice change is allowed
Service change is allowed only after the next billing cycle (from the next billing cycle’s start date - inclusive - and onwards)
Service change is allowed only after the contract end date (from the cotnract end date - inclusive - and onwards)
Rules that define the maximum number of services that a customer can subscribe to. Multiple rules can be specified but they have to be unique i.e. refer to different classification of account.
Maximum number of services that a customer can subscribed to
The account classification of the customer. If specified, then restrictions are applied only to these customers.
Rule that determines if and when a service can remain Effective or it’s eligible to move into the Effective state
Account oustanding amount threshold. Service is eligible to go into Effective state if the oustanding amount is less than or equal to the threshold. If not specified, it defaults to 0. Always set in the business’s base currency
If automation is enabled, then service(s) are automatically activated once their outstanding Invoice is settled. When not enabled, then Actvation is performed on request. Activation is successfull as long as the threshold is met.
Rules that describe how often and for long a customer can request for a Grace period to avoif deactivation. If no rules are specified, then no restrictions are applied when applying a grace period to a subscription.
How many days per year services can get a grace period.
Number of days
Definition of what is a year by setting a starting date
How many times a grace period can be provided to a subscription
Number of times
Definition of what is a year during which grace periods can be applied
Minimum and maximum number of days per grace period
Minimum number of days
Maximum number of days
Trial Management Rules
Defines at which level the Trial period is applied. Trials are applied per Contact (i.e. contacts get a Trial service only once) or per Service (i.e. subscribing to a service also grants the contact a Trial period)
Each contact can only get Trial service once
Apply trial once per subscribed service.
Responses
Body
Unique identifier of subscirption settings
PUT https://sandbox.crm.com/backoffice/v2/subscriptions/settings HTTP/1.1
Content-Type: application/json
{
"automatic_deactivations": {
"deactivation_method": "BASED_ON_DAY"
},
"automatic_cancellations": {
"minimum_period": 3,
"uot": "MONTHS"
},
"out_of_contract_cancellation": {
"allow_cancellation": "ON_NOTICE",
"notice_period": {
"duration": "30",
"uot": "DAYS"
}
},
"in_contract_cancellation": {
"allow_cancellation": "ON_NEXT_BILLING_CYCLE"
},
"regret": {
"allow_regret": true,
"regret_period": 14,
"uot": "DAYS"
},
"paused_period": {
"days_per_year": {
"allowed_days": 30,
"starting_from": "SERVICE_FIRST_EFFECTIVE_DATE"
},
"times_per_year": {
"allowed_times": 3,
"starting_from": "FIRST_DAY_OF_YEAR"
},
"days_per_pause": {
"minimum": 1,
"maximum": 5
}
},
"service_changes": [
{
"change_type": "UPGRADE",
"allow_change": "ON_NEXT_BILLING_CYCLE"
}
],
"service_restrictions": [
{
"maximum_services": 5,
"account_classification_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}
],
"activation_rule": {
"threshold": 0.01,
"enable_automation": "true"
},
"grace_period": {
"days_per_year": {
"allowed_days": 30,
"starting_from": "INITIATION_DATE"
},
"times_per_year": {
"allowed_times": 3,
"starting_from": "INITIATION_DATE"
},
"days_per_grace": {
"minimum": 3,
"maximum": 6
}
},
"trial_period": {
"allowed_trials": "SERVICE"
}
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}Retrieve general settings that define Billing business rules.
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
Calendar billing defines whether subscribers will be billed on their services’ Annniversary or on a specific Period. In the first case, service is billind on its urchase Anniversay day of month, in the case of PEriod billing, all services among all subscribers are billing on a defined day of month
Applies Anniversary or Period Billing
Applicable and mandatory for Period billing. This is the day of month from which all services will be billed
Defines when and if a subscription’s billing cycle will be reset. Applicable only for Anniversary billing. A subscription’s billing periodis reset when the event being performed affects all of the subscription’s services.
Set of events on which the billing period will be reset based on the event’s performed date. If none is selected, then billing period is never reset.
Service re-activated after a Deactivation period.
Service upgraded
Service downgraded
Service re-activated after a Paused Period
By default services are billed only for the Effective period. This list includes any other service states which are additinally billable
List of subscription service states considered as additional billable ones.
["NOT_EFFECTIVE"]List of service products for which the additional billable states are applied. If not specified, then all services will be additionally billed. Only termed services can be specified
Service product identifier
Product SKU
Product name
A set of subscription service life cycle states that will be considered as non creditable ones during billing. By default, only the Draft and Effective life cycle states are considered as non creditable
List of service states considered as nono-creditable ones
["NOT_EFFECTIVE"]List of service products for which the non-creditable states are applied. If not specified, then all services will be considered as non-creditable. Only termed services can be specified
Service product identifier
Product SKU
Product name
Defines billing rules on when and how services will be billed
By default, services are billed on their billing day of month. If this settng is specified, then servces can be billed in advance a specific period prior the next billing cycle begins
The period’s value
The period’s unit of time
Specifies whether sevice’s billing will be prorated or not
Enable service proration
The day of month used as a threshold to deide whether the service is prorated or not. If service is purchased prior this day, then the service is not prorated. Required if proratng is enabled
Defines how invoices and/or credit notes will be generated during recurring billing. If not specified, then the default financial transaction types are used.
The Invoie financial transaction’s type
The unique identifier od the financal transaction type
Tha name of financial trasnaciton type
The Credit Note’s financial transaction’s type
The unique identifier of the financal transaction type
The name of the financial transaction type
Usage Billing Settings
Defines whether usage allowance is verified when a usage record is processed or not. If set to True, then usage record is posted only if there’s remaining allowance enough to cover the record’s usage amount, otherwise it gets Rejected. If set to False, then remaining allowance is not verified on posting the record.
GET https://sandbox.crm.com/backoffice/v2/billing/settings HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"calendar_billing": {
"type": "ANNIVERSARY",
"billing_day": 1,
"reset_billing_period": {
"on_events": [
"REACTIVATE"
]
}
},
"additional_billable_states": {
"states": [
"PAUSED"
],
"services": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"sku": "FILMS001",
"name": "Films"
}
]
},
"non_creditable_states": {
"states": [
"NOT_EFFECTIVE"
],
"services": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"sku": "SPORTS001",
"name": "Sports"
}
]
},
"rating": {
"bill_in_advance": {
"period": 3,
"uot": "DAYS"
},
"prorate_period": {
"enabled": true,
"threshold_day": 15
}
},
"invoicing": {
"invoice_type": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "BR Invoice"
},
"credit_note_type": {
"id": "3dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "BR Credit Note"
}
},
"usage_billing": {
"verify_allowance": "true"
}
}Update general billing settings
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Calendar billing defines whether subscribers will be billed on their services’ Annniversary or on a specific Period. In the first case, service is billind on its urchase Anniversay day of month, in the case of PEriod billing, all services among all subscribers are billing on a defined day of month
Applies Anniversary or Period Billing
Applicable and mandatory for Period billing. this is the day of month from which all services will be billed
Defines when and if a subscription’s billing cycle will be reset. Applicable only for Anniversary billing. A subscription’s billing periodis reset when the event being performed affects all of the subscription’s services.
Set of events on which the billing period will be reset based on the event’s performed date. If none is selected, then billing period is never reset.
Service re-activated after a Deactivation period.
Service upgraded
Service upgraded
Service re-activated after a Paused Period
By default services are billed only for the Effective period. This list includes any other service states which are additinally billable
["NOT_EFFECTIVE"]List of services product idnetifiers for which the additional billable states are applied. If not specified, then all services will be additionally billed. Only termed service products can be specified
[
"4dc0809f-ed91-4b68-b912-5bd6064d901e"
]A set of subscription service life cycle states that will be considered as non creditable ones during billing. By default, only the Draft and Effective life cycle states are considered as non creditable
["NOT_EFFECTIVE"]List of services product idnetifiers for which the non-creditable states are applied. If not specified, then all services will be considered as non-creditable. Only termed service products can be specified
[
"4dc0809f-ed91-4b68-b912-5bd6064d901e"
]Defines billing rules on when and how services will be billed
By default, services are billed on their billing day of month. If this settng is specified, then servces can be billed in advance a specific period prior the next billing cycle begins
The period’s value
The period’s unit of time
Specifies whether sevice’s billing will be prorated or not
Enable service proration
The day of month used as a threshold to deide whether the service is prorated or not. If service is purchased prior this day, then the service is not prorated. Required if proratng is enabled
Defines how invoices and/or credit notes will be generated during recurring billing. If not specified, then the default financial transaction types are used.
The invoice type’s unique identifier
The credit note type’s unique identifier
Usage Billing Settings
Defines whether usage allowance is verified when a usage record is processed or not. If set to True, then usage record is posted only if there’s remaining allowance enough to cover the record’s usage amount, otherwise it gets Rejected. If set to False, then remaining allowance is not verified on posting the record.
Responses
Body
Unique identifier of Billing Settings
PUT https://sandbox.crm.com/backoffice/v2/billing/settings HTTP/1.1
Content-Type: application/json
{
"calendar_billing": {
"type": "ANNIVERSARY",
"billing_day": 1,
"reset_billing_period": {
"on_events": [
"DOWNGRADE"
]
}
},
"additional_billable_states": {
"states": [
"PAUSED"
],
"services": [
"4dc0809f-ed91-4b68-b912-5bd6064d901e"
]
},
"non_creditable_states": {
"states": [
"NOT_EFFECTIVE"
],
"services": [
"4dc0809f-ed91-4b68-b912-5bd6064d901e"
]
},
"rating": {
"bill_in_advance": {
"period": 3,
"uot": "DAYS"
},
"prorate_period": {
"enabled": true,
"threshold_day": 15
}
},
"invoicing": {
"invoice_type_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"credit_note_type_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
},
"usage_billing": {
"verify_allowance": "true"
}
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}{id}{id}{id}Returns a list of subscription action categories
Request parameters
Search for action categories using their name
The business classification code of the category
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
The unique identifier of the action category
The action category name
The action category description
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/actions/categories HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "Cancellation due to cost",
"description": "Service cancelled due to high monthly cost"
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Returns a single subscription action category
Path variables
The action category identifier
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
The action category name
The action category description
List of subscription actions business classification codes
The action’s behaviour code
The action’s business classification code
Applicable when business code is set to Remove Service
Applicable when business code is set to Remove Service
Applicable when business code is set to Change Service
Applicable when business code is set to Change Service
Applicable when business code is set to Grace Period
GET https://sandbox.crm.com/backoffice/v2/action/categories/{id} HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"name": "Cancellation due to cost",
"description": "Cancellation due to high monthly cost",
"actions": [
{
"behaviour_code": "CHANGE_SERVICE",
"business_classification_code": "DOWNGRADE_SERVICE"
}
]
}Creates a new subscription action category
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The action category’s name which has to be unique across all categories
The action category’s description
List of subscription actions business classification codes
The behaviour code fo the action
The business classification code of the action
Applicable when business code is set to Remove Service
Applicable when business code is set to Remove Service
Applicable when business code is set to Change Service
Applicable when business code is set to Change Service
Applicable when business code is set to Grace Period
Responses
Body
The unique identifier of the subscription action category
POST https://sandbox.crm.com/backoffice/v2/actions/categories HTTP/1.1
Content-Type: application/json
{
"name": "Cancellation due to cost",
"description": "Cancellation because of high monthly cost",
"actions": [
{
"behaviour_code": "CHANGE_SERVICE",
"business_classification_code": "DOWNGRADE_SERVICE"
}
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": ""
}{id}Updates an existing subscription action category
Path variables
The unique identifier of the subscription action category
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The action category’s name which has to be unique across all categories
The action category’s description
The behaviour code of the action
The business classification code of the action
Applicable when business code is se to Remove Service
Applicable when business code is se to Remove Service
Applicable when business code is set to Change Service
Applicable when business code is set to Change Service
Applicable when business code is set to Grace Period
Responses
Body
The unique identifier of the subscription action category
PUT https://sandbox.crm.com/backoffice/v2/actions/categories/{id} HTTP/1.1
Content-Type: application/json
{
"name": "Cancellation due to cost",
"description": "Cancellation because of high monthly cost",
"actions": [
{
"behaviour_code": "CHANGE_SERVICE",
"business_classification_code": "UPGRADE_SERVICE"
}
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": ""
}{id}Deletes a subscrpion action category
Path variables
The action category identifier
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
DELETE https://sandbox.crm.com/backoffice/v2/actions/categories/{id} HTTP/1.1
HTTP/1.1 204 No Content List of Web aPIs for creating and managing Event-based Charges
Returns the list of event-based charges
Request parameters
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
The unique identifier of the event-based conditional charge
Defines when the charge will be applied if the conditions are met
The charge is immediatelly invoiced
The charge is included in the upcoming bill
The event that will trigger this rule.
The expense service that will be invoiced
The unique identifier of the expense
The expense’s SKU
The expenses name
A set of conditions that should be met in order for the expense to be applied. Multiple conditinos can be set up. The event-based charge is appied when at least one condition is met.
Unique identifer of the condition
The service should be in contract period for the expense to be applied?
The service on which the subscription event is performed on
Define whether the condition applies for a product, a product type or a family.
The unique identifier of the product, type or family
The name of the product, type or family
The service to which a service changes to. Applicable only for Downgrade subscription events
Define whether the condition applies for a product, a product type or a family.
The unique identifier of the product, type or family
The name of the product, type or family
The condition is met if the subscription event occurs a period after the contract started. Applicable only if the condition is applied while the sevice is still in contract
The period’s value
The period’s unit of time
The service’s contract period, in terms of duration
The contract period’s duration
The unit of time of the contract period
Expense is applied only if the service was in the same state for a minimum period of time before the event was performed.
The value for the period of time
Period’s unit of time
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/subscription/charges HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"apply_on": "NEXT_BILLING_CYCLE",
"event": "CANCELLATION",
"expense": {
"id": "90c0809f-ed91-4b68-b912-5bd6064d901e",
"sku": "CANCEL01",
"name": "Cancellation Fee"
},
"conditions": [
{
"id": "10c0809f-ed91-4b68-b912-5bd6064d901e",
"in_contract": true,
"existing_service": {
"item_type": "TYPE",
"item_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"item_name": "Add-ons"
},
"change_to_service": {
"item_type": "PRODUCT",
"item_id": "3dc0809f-ed91-4b68-b912-5bd6064d901e",
"item_name": "Gold"
},
"contract_started": {
"period": "1",
"uot": "MONTHS"
},
"contract": {
"duration": 12,
"uot": "MONTHS"
},
"in_previous_state": {
"period": "60",
"uot": "DAYS"
}
}
]
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}Updates the list of event-based charges
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Defines when the charge will be applied if the conditions are met
The event that will trigger this rule.
The expense service that will be invoiced. This is a product classified as an Expense service.
A set of conditions that should be met in order for the expense to be applied. Conditions are optional but if one should be specified, then at least one of its criteria must be set.
The service should be in contract period.
The service on which the subscription eent is performed on
Define whether the condition applies for a product, a product type or a family.
The unique identifie rof the product, product type or family.
The service to which a service changes to. Applicable only for Downgrade and Switch subscription events
Define whether the condition applies for a product, a product type or a family.
The unique identifie rof the product, product type or family.
The service’s contract period duration.
The contract period’s duration
The contract period’s unit of time
The condition is met if the subscription event occurs a period after the contract started. Applicable only if the condition is applied while the sevice is still in contract
The period’s value
The period’s unit of time
Expense is applied only if the service was in the same state for a minimum period of time before the event was performed.
The value for the period of time
Period’s unit of time
The page number
The number of records per page
The overal number of records
Responses
PUT https://sandbox.crm.com/backoffice/v2/subscriptions/charges HTTP/1.1
Content-Type: application/json
{
"content": [
{
"apply_on": "ON_NEXT_BILLING_CYCLE",
"event": "DOWNGRADE",
"expense_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"conditions": [
{
"in_contract": true,
"existing_service": {
"item_type": "PRODUCT",
"item_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
},
"change_to_service": {
"item_type": "PRODUCT",
"item_id": "2ac0809f-ed91-4b68-b912-5bd6064d901e"
},
"contract": {
"duration": 12,
"uot": "MONTHS"
},
"contract_started": {
"period": 1,
"uot": "MONTHS"
},
"in_previous_state": {
"period": "6",
"uot": "MONTHS"
}
}
]
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}
HTTP/1.1 200 OK Event-based recurring charges is a set of policies triggered on various subscription events that identify if and which Expenses will be applied on a subscription and will be charged on a recurring basis, i.e per subscriber billing cycle. Recurring charges policies include two major events the event that will add the recurring expense on the subscription and the event that will remove it.
Returns the list of configured event-based recurring charges
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
Event-based recurring charge policy identifier
The event that adds the recurring expense on the subscription
Service set to Effective state for the first time
Service enabled on a device
The event that adds the recurring expense on the subscription
Service removed from a subscription
Service disabled from a service
The expense service that will be added/removed from the subscription
Expense product identifier
Expense product SKU
Expense product name
Set of conditions that should be met to apply the policy.
Policy applied when the service is in contract
The service’s contract period
Contract period duration
Contrat period’s unit of time
The event’s service. The service is represented by a specific product or it migth be a service products fo a specific type
What’s the item’s type
The item’s identifier
The item’s name
The minimum number of devices on which th service is already enabled on. Applicable only if the event in Enable service to a device. The policy is applied if the service is already enabled on at least this number of devices(excluding the event’s device)
Defines to which devices the service is enabled on for the condition to apply. Optional and applicable when enabled_devices is set. This setting refers to the device’s product specification
The devicee’s product specification. A device might be of a specific product or any product of a type
The item’s identifier
The item’s name
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/subscriptions/recurring_charges HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"event_to_apply": "INITIATION",
"event_to_terminate": "REMOVE",
"expense": {
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"sku": "RFEE",
"name": "Rental Fee"
},
"conditions": [
{
"in_contract": true,
"contract_period": {
"duration": 12,
"uot": "MONTHS"
},
"service": {
"item_type": "TYPE",
"item_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"item_name": "TV Services"
},
"enabled_devices": 1,
"device": {
"item_type": "PRODUCT",
"item_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"item_name": "HD Decoder"
}
}
]
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}Updates the set of event-based recurring charges policies.
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Set of Event-based recurring charges rules.
The expense service that will be added/removed from the subscription. This product must be classified as an Expense service.
The event that adds the recurring expense on the subscription
Service set to Effective state for the first time
Service enabled on a device
The event that adds the recurring expense on the subscription
Service removed from a subscription
Service disabled from a device
Set of conditions that should be met to apply the policy. Conditions are optional, so if nothing is specified, then the recurring expense is added on a subscription per event. If a condition is required, then at least one of its settings must be specified.
Policy applied when the service is in contract
The service’s contract period
Contract period duration
Contract period unit of time
The event’s service. The service is represented by a specific product or it migth be a service products fo a specific type
What’s the item’s type
The item’s identifier
The minimum number of devices on which th service is already enabled on. Applicable only if the event in Enable service to a device. The policy is applied if the service is already enabled on at least this number of devices(excluding the event’s device)
Defines to which devices the service is enabled on for the condition to apply. Optional and applicable when enabled_devices is set. This setting refers to the device’s product specification
The devicee’s product specification. A device might be of a specific product or any product of a type
The item’s identifier
Responses
Body
Unique identifier of the Event-based recurring expense policy
PUT https://sandbox.crm.com/backoffice/v2/subscriptions/recurring_charges HTTP/1.1
Content-Type: application/json
{
"rules": [
{
"event_to_apply": "INITIATION",
"event_to_terminate": "REMOVE",
"expense_id": "",
"conditions": [
{
"in_contract": true,
"contract_period": {
"duration": 12,
"uot": "MONTHS"
},
"service": {
"item_type": "TYPE",
"item_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
},
"enabled_devices": 1,
"device": {
"item_type": "PRODUCT",
"item_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}
}
]
}
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}{id}{id}Create new rule for Usage Charge Limits. Each rule must include a maximum allowed non-billed usage amount or number of usage records that a business allows. On reaching these limits, subscribers are billed for their un-billed usage immediatelly. So this usage might be billed some time during a billing cycle.
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Usage Charge Limits rule name that has to be unique across all rules
Usage Charge Limit rule applied when unbilled usage amount reaches this usage amount limit
Usage Charge Limit rule applied when the number of unbilled usage records reaches this limit
List of products related to the non-billed usage. Only usage service prodcuts can be specified.
The item type
The item’s identifier which depending on the selection of item_type might be a product identifier or a product type identifier.
Responses
Body
The unique identfier of the new Usage Charge Limit Rule
POST https://sandbox.crm.com/backoffice/v2/subscriptions/usage_charge_limits HTTP/1.1
Content-Type: application/json
{
"name": "Usage Exceeded",
"usage_amount": 999.99,
"usage_records": 10,
"products": [
{
"item_type": "PRODUCT",
"item_id": "5cc0809f-ed91-4b68-b912-5bd6064d901e"
}
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "5cc0809f-ed91-4b68-b912-5bd6064d901e"
}Returns the list of Usage Charge Limits Rules on maximum allowed un-billed-usage. Either a usage amount or number of usage records is specified per rule.
Request parameters
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
Unique identifier of the Usage Charge Limit rule
Usage Charge Limit Rule name
The maximum allowed un-billed usage amount. Defined in default currency
The maximum allownce number of un-billed usage records
List of products and/or product types on which usage charge limits will be applied, i.e. once the usage of the speified products is reached, then their usage is immediatelly billed.
Define whether usage charge limit is applied per product or product type
The unique identifier of the product or product type accordingly.
The name of the product or the product type
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/subscriptions/usage_charge_limits HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "5cc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "Movies ordered",
"usage_amount": 999.99,
"usage_records": 10,
"currency_code": "EUR",
"products": [
{
"item_type": "TYPE",
"item_id": "5cc0809f-ed91-4b68-b912-5bd6064d901e",
"item_name": "TV Service"
}
]
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Returns the list of Usage Charge Limits. Rules on maximum allowed un-billed-usage. Either a usage amount or number of usage records is specified per rule.
Path variables
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Responses
Body
The unique identfier of the updated sage Charge Limit Rule
PUT https://sandbox.crm.com/backoffice/v1/usage_charge_limits/{id} HTTP/1.1
Content-Type: application/json
{
"name": "",
"usage_amount": 999.99,
"usage_records": 10,
"products": [
{
"item_type": "PRODUCT",
"item_id": "5cc0809f-ed91-4b68-b912-5bd6064d901e"
}
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": ""
}{id}Deletes a Usage Charge Limits rule.
Path variables
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
DELETE https://sandbox.crm.com/backoffice/v1/usage_charge_limits/{id} HTTP/1.1
HTTP/1.1 204 No Content Use CRM.COM Taxes to set up Tax Rates and define which and how products in the Product Cataogue will be taxed. Taxes are applied automatially whenever an account is debited/credited.
{id}{id}{id}Creates a new Tax Rate. A single Tax Rate can be created per Web API call.
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The name of the tax rate that has to be unique.
The description of the tax rate
Tax rate percentage
The tax rate’s reated tax code
The date from which the tax rate is applied. If not specified, it defaults to the date on which the rate % is set.
The type of the event
Delivered to the customer’s address
Picked up by the customer from a venue
Online sales of services
Defines whether tax rate is the default one. Default tax rates are applied when invoicing process cannot identify a tax to be applied because of missing country of agreement of contact’s billing address. Defaults to False. Only one tax rate per tax code and per country of agreement can be specified. On creating the first tax rate per code and per country, then it is automatically set to True.
A set of products on which the tax rate will be applied
Tax rate is applied to either a specific product or products of a family.
The identifier of the product or product family
Define additional location conditions in free text
Town/City
State/Province/County
Responses
Body
The unique identifier of the new Tax Rate
POST https://sandbox.crm.com/backoffice/v2/tax_rates/ HTTP/1.1
Content-Type: application/json
{
"name": "Standard VAT",
"description": "Standard VAT of 20%",
"percentage": 19,
"country_code": "CYP",
"tax_code": "VAT",
"as_of_date": 1623225742,
"supply_method": "DELIVERY",
"is_default": "true",
"product_conditions": [
{
"item_type": "PRODUCT",
"item_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}
],
"location_conditions": [
{
"town_city": "Athens",
"state_province_county": "Attica"
}
]
}{id}Updates an existing Tax Rate. A single Tax Rate can be updated per Web API call.
Path variables
Tax Rate unique identifier
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The name of the tax rate
The description of the tax rate
Tax rate percentage
The date from which the tax rate is applied. If not specified, it defaults to the date on which the rate % is set. On updating the percentage of the tax, this date is automatically reset on the date of this update
The tax rate’s related tax code
The type of the event
Delivered to the customer’s address
Picked up by the customer from a venue
Online sales of services
Defines whether tax rate is the default one. Default tax raes are applied when invoicing process cannot identify a tax to be applied because of missing country of agreement of contact’s billing address. Defaults to False. Only one tax rate per tax code and per country can be specified.
A set of products on which the tax rate will be applied
The product family’s unique identifier
The unique identifier of either a product or product family depending on the item_type selection
Define additional location conditions in free text
Town/City
State/Province/County
Responses
Body
The unique identifier of the updated Tax Rate
PUT https://sandbox.crm.com/backoffice/v2/tax_rates/4dc0809f-ed91-4b68-b912-5bd6064d901e HTTP/1.1
Content-Type: application/json
{
"name": "Standard VAT",
"description": "Stadard VAT for 24%",
"percentage": 19,
"as_of_date": 1623226230,
"country_code": "CYP",
"tax_code": "VAT",
"supply_method": "DELIVERY",
"is_default": "true",
"product_conditions": [
{
"item_type": "PRODUCT",
"item_id": "3dc0809f-ed91-4b68-b912-5bd6064d901e"
}
],
"location_conditions": [
{
"town_city": "Athens",
"state_province_county": "Attica"
}
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}{id}Deletes an existing Tax Rate. A single Tax Rate can be deleted per Web API call. A tax rate can be deleted only if it was never applied in an Invoice or Credit Note
Path variables
The Tax rate identifier
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
DELETE https://sandbox.crm.com/backoffice/v2/tax_rates/{id} HTTP/1.1
HTTP/1.1 204 No Content Returns a list of all configured Tax Rates
Request parameters
Filters Tax Rates per country
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Search for Tax rates based on their Name or Description
The identifier of the product on which the tax rate is applied
The identifier of the product family on which the tax rate is applied
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
The unique identifer of the tax rate
Tax rate name
Tax rate description
Tax rate percentage
The tax code
Defines whether the Tax rate is the defualt one for the specified country
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/tax_rates/ HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "Standard VAT",
"description": "Cyprus Standard VAT",
"percentage": 19.5,
"country_code": "CYP",
"tax_code": "VAT",
"is_default": "true"
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}{id}Returns detailed information of a Tax Rate. A single Tax Rate is returned in each Web API call.
Path variables
The Tax rate’s identifier
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
Tax Rate unique identifier
Tax Rate name
Tax Rate description
Tax Rate percentage
The date from which the tax rate is applied.
The tax code
The type of the event
Delivered to the customer’s address
Picked up by the customer from a venue
Online sales of services
Defines whether tax rate is the default one. Default tax raes are applied when invoicing process cannot identify a tax to be applied because of missing country of agreement of contact’s billing address. Defaults to False. Only one tax rate per tax code and per country can be specified.
List of products or product families at which the tax rate will be applied
Define either a product or a product family
The identfier of the product or the product family
List of location conitions at which the tax rate will be applied. this lis tof conditions are appleid additionally compared to the rate’s Country condition. Conditions are specified in free text
Town.City
State/Privince/County
GET https://sandbox.crm.com/backoffice/v2/tax_rates/{id} HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "4dc0809f-ed91-4b68-b912-5bd6064d901e",
"name": "Standard VAT",
"description": "Standard VAt for Cyprus",
"percentage": 19.5,
"as_of_date": 1623227590,
"country_code": "CYP",
"tax_code": "VAT",
"supply_method": "DELIVERY",
"is_default": "true",
"product_conditions": [
{
"item_type": "PRODUCT",
"item_id": "4dc0809f-ed91-4b68-b912-5bd6064d901e"
}
],
"location_conditions": [
{
"town_city": "Athens",
"state_province_county": "Attica"
}
]
}Retrieves the configured Wallet Settings that include Limits and Fees applied on performing various walet-related transactions such as Top-ups and Transfers.
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Successful Request
Body
Defines the limit rules applied on specific wallet.
The name of the rule
The maximum allowed amount among all wallet-related transactions. The amount is always set to the business’s base currency
The maximum number of wallet-related transactions allowed
Limits are applied on transactions performed within the specified period of time. In all cases, the period is defined based on calendar. e.g. Montlhy refers to a calendar month
The wallet transaction type for which the limit is applied
The conditions that should be met to apply the limit
The entity’s unique identifier
The name of the entity
Defines the global fees to be applied over a period or on transactions executed against wallets
The name of the rule
The value type of the fee
The value of the fee
The event to apply the fee
The period when the fees will be applied
The UOT of the period
The transactions that the fee will be applied on
The unique identifier of the entity
The name of the entity
GET https://sandbox.crm.com/backoffice/v1/wallet_settings HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"limit_rules": [
{
"name": "Monthly Limits for VIP",
"maximum_amount": 9.99,
"maximum_number": 10,
"period": "DAILY",
"transaction_type": [
"TOPUP"
],
"conditions": [
{
"entity": "ACCOUNT_CLASSIFICATION",
"id": "4AD9C84FA60F9FE407140E20F707726A",
"name": "VIP"
}
]
}
],
"fees_rules": [
{
"name": "VIP",
"value_type": "AMOUNT",
"value": 0.01,
"applied_on": "TRANSACTION",
"period": 1,
"period_uot": "MONTH",
"applied_transaction": [
"TOPUP"
],
"conditions": [
{
"entity": "ACCOUNT_CLASSIFICATION",
"id": "4AD9C84FA60F9FE407140E20F707726A",
"name": "Enhanced"
}
]
}
]
}Update the wallet settings
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
Defines the limit rules applied on specific wallet. Applied on all wallets unless overriden
The name of the rule
The maximum amount allowed
The maximum number of transactions allowed
The period for which the limit is applied
The wallet transaction type for which the limit is applied
The unique identifier of the entity
The name of the entity
Defines the global fees to be applied over a period or on transactions executed against wallets
The name of the rule
The value of the fee
The value type of the fee
The event to apply the fee
The period when the fees will be applied
The UOT of the period
The transactions that the fee will be applied on
The unique identifier of the entity
The name of the entity
Responses
Successful Request
PUT https://sandbox.crm.com/backoffice/v1/wallet_settings HTTP/1.1
Content-Type: application/json
{
"limit_rules": [
{
"name": "VIP",
"maximum_amount": 100,
"maximum_number": 1,
"period": "DAILY",
"transaction_type": [
"TOPUP"
],
"conditions": [
{
"entity": "ACCOUNT_CLASSIFICATION",
"id": "4AD9C84FA60F9FE407140E20F707726A",
"name": "Enhanced"
}
]
}
],
"fees_rules": [
{
"name": "VIP",
"value": 0.1,
"value_type": "PERCENTAGE",
"applied_on": "PERIOD",
"period": 1,
"period_uot": "YEAR",
"applied_transaction": [
"TOPUP"
],
"conditions": [
{
"entity": "ACCOUNT_CLASSIFICATION",
"id": "4AD9C84FA60F9FE407140E20F707726A",
"name": "Enhanced"
}
]
}
]
}
HTTP/1.1 200 OK Sales Model configuration will give the possibility for the business to use the default pricing group or add custom ones that will be applied to product prices and can be defined to companies, persons, contact category or specified contact as well
{id}{id}Retrieve all the Sales Models
Request parameters
Defines on which attribute the results should be sorted
Defines how the results will be ordered
The page number that should be retrieved
The size (total records) of each page
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
Body
The sales model unique identifier
The sales model name which has to be unique across all sales models
The sales model description
The page number
The number of records per page
The overal number of records
GET https://sandbox.crm.com/backoffice/v2/sales_models HTTP/1.1
HTTP/1.1 200 OK
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "caf332bc-4e90-47b5-a05d-142b264897b9",
"name": "Retail",
"description": "Sales model available for all contact Person"
}
],
"paging": {
"page": 2,
"size": 20,
"total": 5124
}
}Creates a new Sales Model that will be used when adding a price to a product or for setting the sales model of a contact.
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The sales model name which has to be unique across all sales models
The sales model description
Examples
Responses
Body
The unique identifier of the sales model created
POST https://sandbox.crm.com/backoffice/v2/sales_models HTTP/1.1
Content-Type: application/json
{
"name": "Wealth model",
"description": "Sales model available for all contact Person"
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "caf332bc-4e90-47b5-a05d-142b264897b9"
}{id}Updates an existing Sales Model
Path variables
Unique identifier of the Sales Model
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Request body
The sales model name which has to be unique across all sales models.
The sales model description
Responses
Body
Sales Model unique identifier
PUT https://sandbox.crm.com/backoffice/v2/sales_models/caf332bc-4e90-47b5-a05d-142b264897b9 HTTP/1.1
Content-Type: application/json
{
"name": "Retail bank sales",
"description": "Sales Model available for retail banks"
}{id}Deletes an existing Sales Model
Path variables
The unique identifier of sales model that will be deleted
Request headers
Authorization Token
The secret api key required for API calls to ensure that the client is trusted
Responses
DELETE https://sandbox.crm.com/backoffice/v2/sales_models/caf332bc-4e90-47b5-a05d-142b264897b9 HTTP/1.1