{"info":{"_postman_id":"473a0b00-8885-4720-82bf-09a727c42acc","name":"Atreemo API (Version :1.29.0.0)","description":"

Welcome to the Atreemo API Guide by Acteol (an Access company)

You will be able to find all the needed API methods explained and with the possibility to test them on the sandbox instance. The Guide does not explain the purpose or functions of Atreemo features.

Getting Started

The API is REST based, which is easy to work with and familiar for developers. The base endpoint for the current version of the API is:

https://{{Host}}/

To use the API, a login and a password are required for authentication. These credentials are provided by Atreemo support team.

Basic Authentication

Authentication is done through the following endpoint:

https://{{Host}}/token

The login and the password are used in the previous endpoint, in exchange for a token that will be appended to every future request. The request should contain: Atreemo uses token based authentication through OAuth2.This means that you use a token on every request to authorize yourself. Obtaining an access token is done by sending a HTTP POST request to the above endpoint.

The request should contain:

The following headers: Content-Type: application/x-www-form-urlencoded/
And the following request body: grant_type=password&username=[username]&password=[password]

If your request is composed correctly, and your credentials were correct, the server will return an access_token in JSON format for you to use:

{\"access_token\":\"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9(...)\",\"token_type\":\"Bearer\",\"expires_in\":3600,\"userName\":\"username\",}

Making it easier for you:

Throughout the documentation you'll see the use of variables like {Host} ,{access_token},{UserName},{Password} that can be swapped out using your real Credentials. If you use Postman, this collection is available for download along with a shared variable template to define your host and Credentials variables.

you can now get the collection added to your Postman Workspace, set your credentials and test all the methods with one token request and automatically via the sandbox instance

We hope you find it simpler to use, more intuitive, and better documented, we will keep updating this guide with any new Methods or updates to the currents ones.

","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Welcome to the Atreemo API Guide by Acteol (an Access company)","slug":"welcome-to-the-atreemo-api-guide-by-acteol-an-access-company"}],"owner":"10141267","collectionId":"473a0b00-8885-4720-82bf-09a727c42acc","publishedId":"2sBXikmWLc","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"2084f1"},"publishDate":"2026-03-25T08:09:57.000Z"},"item":[{"name":"Access Token (Authentication)","item":[{"name":"token","event":[{"id":null,"listen":"test","script":{"id":"7936d76f-3d7a-476e-8266-380cd7d52976","type":"text/javascript","exec":["var data = JSON.parse(responseBody);postman.setEnvironmentVariable(\"access_token\", data.access_token);"],"src":null,"name":"testscript"},"disabled":false}],"id":"5be77069-9e4a-4dbe-93f8-071dcdacc526","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"username","value":"{{UserName}}","type":"text"},{"key":"password","value":"{{Password}}","type":"text"},{"key":"grant_type","value":"password","type":"text"}]},"url":"https://{{Host}}/token","description":"

\n Get Access token\n \n

","urlObject":{"protocol":"https","path":["token"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"1f51ca22-8f36-479b-a174-4a948e975bc1","name":"token Sample","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"username","value":"{{UserName}}","type":"text"},{"key":"password","value":"{{Password}}","type":"text"},{"key":"grant_type","value":"password","type":"text"}]},"url":"https://{{Host}}/token","description":"

\r\n Get Access token\r\n \n

"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{ \"access_token\": \"KD5eAHF7ahIYEnWWEUtwWwOpr590n-1TgaOetPhtJ1RwC1dYaUh4AW2vJGF0kudPsXRNXIswGTZNscy1O4Wln-p5wLm6InuoIToA23PGYvhHGLKkUmc...\" , \"token_type\": \"bearer\", \"expires_in\": 0, \"userName\": \"username\", \".issued\": \"issued date\", \".expires\": \"expiry date\"}"}],"_postman_id":"5be77069-9e4a-4dbe-93f8-071dcdacc526"}],"id":"b7f518b6-9263-42ce-a9dd-c278b4dcb5c7","description":"

Api method to get access token

\n","_postman_id":"b7f518b6-9263-42ce-a9dd-c278b4dcb5c7"},{"name":"AddToMyCalendar","item":[{"name":"AddToMyCalendar","id":"ac427574-63ee-4a2e-bbc7-ecf72c61c1dd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"EventID\": 1,\r\n \"MeetingID\": 2,\r\n \"SlotID\": 3,\r\n \"CtcID\": 4,\r\n \"UserID\": 5,\r\n \"StartDate\": \"2026-03-25T07:30:07.3547923+00:00\",\r\n \"EndDate\": \"2026-03-25T07:30:07.3547923+00:00\",\r\n \"EventName\": \"sample string 8\",\r\n \"Location\": \"sample string 9\",\r\n \"ContactEmail\": \"sample string 10\",\r\n \"GoogleAccessToken\": \"sample string 11\",\r\n \"UserTZOfSet\": \"sample string 12\"\r\n}"},"url":"https://{{Host}}/api/AddToMyCalendar/AddToMyCalendar","description":"

Body Payload

Name	Type	Required
CalendarEvent Description
ContactEmail	String	False
CtcID	Int32	False
EndDate	DateTime	False
EventID	Int32	False
EventName	String	False
GoogleAccessToken	String	False
Location	String	False
MeetingID	Int32	False
SlotID	Int32	False
StartDate	DateTime	False
UserID	Int32	False
UserTZOfSet	String	False

Response Payload

Name	Type	Description
CalendarEventOutput Description
CalendarEvent	CalendarEvent
Error	List<String>	Gets or sets the Error.
Response	Boolean	Gets or sets a value indicating whether Response.
CalendarEvent Description
Name	Type	Description
ContactEmail	String
CtcID	Int32
EndDate	DateTime
EventID	Int32
EventName	String
GoogleAccessToken	String
Location	String
MeetingID	Int32
SlotID	Int32
StartDate	DateTime
UserID	Int32
UserTZOfSet	String

","urlObject":{"protocol":"https","path":["api","AddToMyCalendar","AddToMyCalendar"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"c29b995e-5852-4bb1-b6be-ed2e4482cf8d","name":"api/AddToMyCalendar/AddToMyCalendar Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"EventID\": 1,\r\n \"MeetingID\": 2,\r\n \"SlotID\": 3,\r\n \"CtcID\": 4,\r\n \"UserID\": 5,\r\n \"StartDate\": \"2026-03-25T07:30:07.3547923+00:00\",\r\n \"EndDate\": \"2026-03-25T07:30:07.3547923+00:00\",\r\n \"EventName\": \"sample string 8\",\r\n \"Location\": \"sample string 9\",\r\n \"ContactEmail\": \"sample string 10\",\r\n \"GoogleAccessToken\": \"sample string 11\",\r\n \"UserTZOfSet\": \"sample string 12\"\r\n}"},"url":"https://{{Host}}/api/AddToMyCalendar/AddToMyCalendar","description":"

Body Payload

Name	Type	Required
CalendarEvent Description
ContactEmail	String	False
CtcID	Int32	False
EndDate	DateTime	False
EventID	Int32	False
EventName	String	False
GoogleAccessToken	String	False
Location	String	False
MeetingID	Int32	False
SlotID	Int32	False
StartDate	DateTime	False
UserID	Int32	False
UserTZOfSet	String	False

Response Payload

Name	Type	Description
CalendarEventOutput Description
CalendarEvent	CalendarEvent
Error	List<String>	Gets or sets the Error.
Response	Boolean	Gets or sets a value indicating whether Response.
CalendarEvent Description
Name	Type	Description
ContactEmail	String
CtcID	Int32
EndDate	DateTime
EventID	Int32
EventName	String
GoogleAccessToken	String
Location	String
MeetingID	Int32
SlotID	Int32
StartDate	DateTime
UserID	Int32
UserTZOfSet	String

"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"CalendarEvent\": {\r\n \"EventID\": 1,\r\n \"MeetingID\": 2,\r\n \"SlotID\": 3,\r\n \"CtcID\": 4,\r\n \"UserID\": 5,\r\n \"StartDate\": \"2026-03-25T07:30:07.4016706+00:00\",\r\n \"EndDate\": \"2026-03-25T07:30:07.4016706+00:00\",\r\n \"EventName\": \"sample string 8\",\r\n \"Location\": \"sample string 9\",\r\n \"ContactEmail\": \"sample string 10\",\r\n \"GoogleAccessToken\": \"sample string 11\",\r\n \"UserTZOfSet\": \"sample string 12\"\r\n },\r\n \"Response\": true,\r\n \"Error\": [\r\n \"sample string 1\",\r\n \"sample string 2\"\r\n ]\r\n}"}],"_postman_id":"ac427574-63ee-4a2e-bbc7-ecf72c61c1dd"},{"name":"AddToMyGoogleCalendar","id":"30841504-6393-48af-a2a1-77bdace46eaf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"EventID\": 1,\r\n \"MeetingID\": 2,\r\n \"SlotID\": 3,\r\n \"CtcID\": 4,\r\n \"UserID\": 5,\r\n \"StartDate\": \"2026-03-25T07:30:07.4329151+00:00\",\r\n \"EndDate\": \"2026-03-25T07:30:07.4329151+00:00\",\r\n \"EventName\": \"sample string 8\",\r\n \"Location\": \"sample string 9\",\r\n \"ContactEmail\": \"sample string 10\",\r\n \"GoogleAccessToken\": \"sample string 11\",\r\n \"UserTZOfSet\": \"sample string 12\"\r\n}"},"url":"https://{{Host}}/api/AddToMyCalendar/AddToMyGoogleCalendar","description":"

Body Payload

Name	Type	Required
CalendarEvent Description
ContactEmail	String	False
CtcID	Int32	False
EndDate	DateTime	False
EventID	Int32	False
EventName	String	False
GoogleAccessToken	String	False
Location	String	False
MeetingID	Int32	False
SlotID	Int32	False
StartDate	DateTime	False
UserID	Int32	False
UserTZOfSet	String	False

Response Payload

Name	Type	Description
CalendarEventOutput Description
CalendarEvent	CalendarEvent
Error	List<String>	Gets or sets the Error.
Response	Boolean	Gets or sets a value indicating whether Response.
CalendarEvent Description
Name	Type	Description
ContactEmail	String
CtcID	Int32
EndDate	DateTime
EventID	Int32
EventName	String
GoogleAccessToken	String
Location	String
MeetingID	Int32
SlotID	Int32
StartDate	DateTime
UserID	Int32
UserTZOfSet	String

","urlObject":{"protocol":"https","path":["api","AddToMyCalendar","AddToMyGoogleCalendar"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"4ad3c25b-b84e-4ee1-802e-341f6bcc335c","name":"api/AddToMyCalendar/AddToMyGoogleCalendar Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"EventID\": 1,\r\n \"MeetingID\": 2,\r\n \"SlotID\": 3,\r\n \"CtcID\": 4,\r\n \"UserID\": 5,\r\n \"StartDate\": \"2026-03-25T07:30:07.4329151+00:00\",\r\n \"EndDate\": \"2026-03-25T07:30:07.4329151+00:00\",\r\n \"EventName\": \"sample string 8\",\r\n \"Location\": \"sample string 9\",\r\n \"ContactEmail\": \"sample string 10\",\r\n \"GoogleAccessToken\": \"sample string 11\",\r\n \"UserTZOfSet\": \"sample string 12\"\r\n}"},"url":"https://{{Host}}/api/AddToMyCalendar/AddToMyGoogleCalendar","description":"

Body Payload

Name	Type	Required
CalendarEvent Description
ContactEmail	String	False
CtcID	Int32	False
EndDate	DateTime	False
EventID	Int32	False
EventName	String	False
GoogleAccessToken	String	False
Location	String	False
MeetingID	Int32	False
SlotID	Int32	False
StartDate	DateTime	False
UserID	Int32	False
UserTZOfSet	String	False

Response Payload

Name	Type	Description
CalendarEventOutput Description
CalendarEvent	CalendarEvent
Error	List<String>	Gets or sets the Error.
Response	Boolean	Gets or sets a value indicating whether Response.
CalendarEvent Description
Name	Type	Description
ContactEmail	String
CtcID	Int32
EndDate	DateTime
EventID	Int32
EventName	String
GoogleAccessToken	String
Location	String
MeetingID	Int32
SlotID	Int32
StartDate	DateTime
UserID	Int32
UserTZOfSet	String

Api Methods for AddToMyCalendar

\n","_postman_id":"b16e4eb5-9188-475d-9419-dec7c048b9a0"},{"name":"ApiOpenAI","item":[{"name":"AnalyzeEmailSpam","id":"91f9f1e6-afe8-4a5f-b55a-f014dfc4f9c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"model\": \"sample string 1\",\r\n \"messages\": [\r\n {\r\n \"role\": \"sample string 1\",\r\n \"content\": {}\r\n },\r\n {\r\n \"role\": \"sample string 1\",\r\n \"content\": {}\r\n }\r\n ],\r\n \"temperature\": 2.1,\r\n \"top_p\": 3.1,\r\n \"n\": 4,\r\n \"max_tokens\": 1,\r\n \"tools\": [\r\n {},\r\n {}\r\n ],\r\n \"tool_choice\": {}\r\n}"},"url":"https://{{Host}}/api/ApiOpenAI/AnalyzeEmailSpam?SourceID=SourceID-value&Subscription_Key=Subscription_Key-value&FunctionName=FunctionName-value&SourceObjectID=SourceObjectID-value","description":"

Body Payload

Name	Type	Description	Required
ChatCompletionRequest Description
max_tokens	Int32 (nullable)		False
messages	IList<Messages>		False
model	String		False
n	Int32		False
temperature	Single		False
tool_choice	Object		False
tools	List<Object>		False
top_p	Single		False
Messages Description
Name	Type	Description	Required
content	Object		False
role	String		False

","urlObject":{"protocol":"https","path":["api","ApiOpenAI","AnalyzeEmailSpam"],"host":["{{Host}}"],"query":[{"key":"SourceID","value":"SourceID-value"},{"key":"Subscription_Key","value":"Subscription_Key-value"},{"key":"FunctionName","value":"FunctionName-value"},{"key":"SourceObjectID","value":"SourceObjectID-value"}],"variable":[]}},"response":[{"id":"9387c464-3be2-4910-989a-f7f60d9407d4","name":"api/ApiOpenAI/AnalyzeEmailSpam?SourceID={SourceID}&Subscription_Key={Subscription_Key}&FunctionName={FunctionName}&SourceObjectID={SourceObjectID} Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"model\": \"sample string 1\",\r\n \"messages\": [\r\n {\r\n \"role\": \"sample string 1\",\r\n \"content\": {}\r\n },\r\n {\r\n \"role\": \"sample string 1\",\r\n \"content\": {}\r\n }\r\n ],\r\n \"temperature\": 2.1,\r\n \"top_p\": 3.1,\r\n \"n\": 4,\r\n \"max_tokens\": 1,\r\n \"tools\": [\r\n {},\r\n {}\r\n ],\r\n \"tool_choice\": {}\r\n}"},"url":{"raw":"https://{{Host}}/api/ApiOpenAI/AnalyzeEmailSpam?SourceID=SourceID-value&Subscription_Key=Subscription_Key-value&FunctionName=FunctionName-value&SourceObjectID=SourceObjectID-value","protocol":"https","host":["{{Host}}"],"path":["api","ApiOpenAI","AnalyzeEmailSpam"],"query":[{"key":"SourceID","value":"SourceID-value"},{"key":"Subscription_Key","value":"Subscription_Key-value"},{"key":"FunctionName","value":"FunctionName-value"},{"key":"SourceObjectID","value":"SourceObjectID-value"}]},"description":"

Body Payload

Name	Type	Description	Required
ChatCompletionRequest Description
max_tokens	Int32 (nullable)		False
messages	IList<Messages>		False
model	String		False
n	Int32		False
temperature	Single		False
tool_choice	Object		False
tools	List<Object>		False
top_p	Single		False
Messages Description
Name	Type	Description	Required
content	Object		False
role	String		False

"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"91f9f1e6-afe8-4a5f-b55a-f014dfc4f9c1"},{"name":"GenerateCampaignSubject","id":"4c4a5b8c-b6ae-47de-a841-1d19e9e90dee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"model\": \"sample string 1\",\r\n \"messages\": [\r\n {\r\n \"role\": \"sample string 1\",\r\n \"content\": {}\r\n },\r\n {\r\n \"role\": \"sample string 1\",\r\n \"content\": {}\r\n }\r\n ],\r\n \"temperature\": 2.1,\r\n \"top_p\": 3.1,\r\n \"n\": 4,\r\n \"max_tokens\": 1,\r\n \"tools\": [\r\n {},\r\n {}\r\n ],\r\n \"tool_choice\": {}\r\n}"},"url":"https://{{Host}}/api/ApiOpenAI/GenerateCampaignSubject?SourceID=SourceID-value&Subscription_Key=Subscription_Key-value&FunctionName=FunctionName-value&SourceObjectID=SourceObjectID-value&usingTools=usingTools-value","description":"

\n Generates a campaign subject using OpenAI's chat completion API.\n \n

Body Payload

Name	Type	Description	Required
ChatCompletionRequest Description
max_tokens	Int32 (nullable)		False
messages	IList<Messages>		False
model	String		False
n	Int32		False
temperature	Single		False
tool_choice	Object		False
tools	List<Object>		False
top_p	Single		False
Messages Description
Name	Type	Description	Required
content	Object		False
role	String		False

","urlObject":{"protocol":"https","path":["api","ApiOpenAI","GenerateCampaignSubject"],"host":["{{Host}}"],"query":[{"key":"SourceID","value":"SourceID-value"},{"key":"Subscription_Key","value":"Subscription_Key-value"},{"key":"FunctionName","value":"FunctionName-value"},{"key":"SourceObjectID","value":"SourceObjectID-value"},{"key":"usingTools","value":"usingTools-value"}],"variable":[]}},"response":[{"id":"692a9006-ee31-4ba7-8b26-e1ffa21036c9","name":"api/ApiOpenAI/GenerateCampaignSubject?SourceID={SourceID}&Subscription_Key={Subscription_Key}&FunctionName={FunctionName}&SourceObjectID={SourceObjectID}&usingTools={usingTools} Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"model\": \"sample string 1\",\r\n \"messages\": [\r\n {\r\n \"role\": \"sample string 1\",\r\n \"content\": {}\r\n },\r\n {\r\n \"role\": \"sample string 1\",\r\n \"content\": {}\r\n }\r\n ],\r\n \"temperature\": 2.1,\r\n \"top_p\": 3.1,\r\n \"n\": 4,\r\n \"max_tokens\": 1,\r\n \"tools\": [\r\n {},\r\n {}\r\n ],\r\n \"tool_choice\": {}\r\n}"},"url":{"raw":"https://{{Host}}/api/ApiOpenAI/GenerateCampaignSubject?SourceID=SourceID-value&Subscription_Key=Subscription_Key-value&FunctionName=FunctionName-value&SourceObjectID=SourceObjectID-value&usingTools=usingTools-value","protocol":"https","host":["{{Host}}"],"path":["api","ApiOpenAI","GenerateCampaignSubject"],"query":[{"key":"SourceID","value":"SourceID-value"},{"key":"Subscription_Key","value":"Subscription_Key-value"},{"key":"FunctionName","value":"FunctionName-value"},{"key":"SourceObjectID","value":"SourceObjectID-value"},{"key":"usingTools","value":"usingTools-value"}]},"description":"

\r\n Generates a campaign subject using OpenAI's chat completion API.\r\n \n

Body Payload

Name	Type	Description	Required
ChatCompletionRequest Description
max_tokens	Int32 (nullable)		False
messages	IList<Messages>		False
model	String		False
n	Int32		False
temperature	Single		False
tool_choice	Object		False
tools	List<Object>		False
top_p	Single		False
Messages Description
Name	Type	Description	Required
content	Object		False
role	String		False

"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"4c4a5b8c-b6ae-47de-a841-1d19e9e90dee"},{"name":"GenerateRFMSegmentMovement","id":"eea30b84-a83e-4ca8-94f1-44f57d60d4c6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"model\": \"sample string 1\",\r\n \"messages\": [\r\n {\r\n \"role\": \"sample string 1\",\r\n \"content\": {}\r\n },\r\n {\r\n \"role\": \"sample string 1\",\r\n \"content\": {}\r\n }\r\n ],\r\n \"temperature\": 2.1,\r\n \"top_p\": 3.1,\r\n \"n\": 4,\r\n \"max_tokens\": 1,\r\n \"tools\": [\r\n {},\r\n {}\r\n ],\r\n \"tool_choice\": {}\r\n}"},"url":"https://{{Host}}/api/ApiOpenAI/GenerateRFMSegmentMovement?SourceID=SourceID-value&Subscription_Key=Subscription_Key-value&FunctionName=FunctionName-value&SourceObjectID=SourceObjectID-value","description":"

\n Generates RFM Segment Movement Summary using OpenAI's chat completion API.\n \n

Body Payload

Name	Type	Description	Required
ChatCompletionRequest Description
max_tokens	Int32 (nullable)		False
messages	IList<Messages>		False
model	String		False
n	Int32		False
temperature	Single		False
tool_choice	Object		False
tools	List<Object>		False
top_p	Single		False
Messages Description
Name	Type	Description	Required
content	Object		False
role	String		False

","urlObject":{"protocol":"https","path":["api","ApiOpenAI","GenerateRFMSegmentMovement"],"host":["{{Host}}"],"query":[{"key":"SourceID","value":"SourceID-value"},{"key":"Subscription_Key","value":"Subscription_Key-value"},{"key":"FunctionName","value":"FunctionName-value"},{"key":"SourceObjectID","value":"SourceObjectID-value"}],"variable":[]}},"response":[{"id":"27faca70-9071-4df3-8ae9-f42c331ba3e6","name":"api/ApiOpenAI/GenerateRFMSegmentMovement?SourceID={SourceID}&Subscription_Key={Subscription_Key}&FunctionName={FunctionName}&SourceObjectID={SourceObjectID} Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"model\": \"sample string 1\",\r\n \"messages\": [\r\n {\r\n \"role\": \"sample string 1\",\r\n \"content\": {}\r\n },\r\n {\r\n \"role\": \"sample string 1\",\r\n \"content\": {}\r\n }\r\n ],\r\n \"temperature\": 2.1,\r\n \"top_p\": 3.1,\r\n \"n\": 4,\r\n \"max_tokens\": 1,\r\n \"tools\": [\r\n {},\r\n {}\r\n ],\r\n \"tool_choice\": {}\r\n}"},"url":{"raw":"https://{{Host}}/api/ApiOpenAI/GenerateRFMSegmentMovement?SourceID=SourceID-value&Subscription_Key=Subscription_Key-value&FunctionName=FunctionName-value&SourceObjectID=SourceObjectID-value","protocol":"https","host":["{{Host}}"],"path":["api","ApiOpenAI","GenerateRFMSegmentMovement"],"query":[{"key":"SourceID","value":"SourceID-value"},{"key":"Subscription_Key","value":"Subscription_Key-value"},{"key":"FunctionName","value":"FunctionName-value"},{"key":"SourceObjectID","value":"SourceObjectID-value"}]},"description":"

\r\n Generates RFM Segment Movement Summary using OpenAI's chat completion API.\r\n \n

Body Payload

Name	Type	Description	Required
ChatCompletionRequest Description
max_tokens	Int32 (nullable)		False
messages	IList<Messages>		False
model	String		False
n	Int32		False
temperature	Single		False
tool_choice	Object		False
tools	List<Object>		False
top_p	Single		False
Messages Description
Name	Type	Description	Required
content	Object		False
role	String		False

"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"eea30b84-a83e-4ca8-94f1-44f57d60d4c6"},{"name":"GetEngagementAIAnalysis","id":"fcfb6d49-e74a-47d5-aeb3-a1081a8335fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"https://{{Host}}/api/OpenAI/GetEngagementAIAnalysis?UserID=UserID-value&BrandID=BrandID-value&ClientID=ClientID-value&NbDaysSinceLastRun=NbDaysSinceLastRun-value","description":"

","urlObject":{"protocol":"https","path":["api","OpenAI","GetEngagementAIAnalysis"],"host":["{{Host}}"],"query":[{"key":"UserID","value":"UserID-value"},{"key":"BrandID","value":"BrandID-value"},{"key":"ClientID","value":"ClientID-value"},{"key":"NbDaysSinceLastRun","value":"NbDaysSinceLastRun-value"}],"variable":[]}},"response":[{"id":"816084f8-c162-427b-a3b5-0f6210e3e50a","name":"api/OpenAI/GetEngagementAIAnalysis?UserID={UserID}&BrandID={BrandID}&ClientID={ClientID}&NbDaysSinceLastRun={NbDaysSinceLastRun} Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":{"raw":"https://{{Host}}/api/OpenAI/GetEngagementAIAnalysis?UserID=UserID-value&BrandID=BrandID-value&ClientID=ClientID-value&NbDaysSinceLastRun=NbDaysSinceLastRun-value","protocol":"https","host":["{{Host}}"],"path":["api","OpenAI","GetEngagementAIAnalysis"],"query":[{"key":"UserID","value":"UserID-value"},{"key":"BrandID","value":"BrandID-value"},{"key":"ClientID","value":"ClientID-value"},{"key":"NbDaysSinceLastRun","value":"NbDaysSinceLastRun-value"}]},"description":"

"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"fcfb6d49-e74a-47d5-aeb3-a1081a8335fe"}],"id":"d08fd401-4670-4d1f-ae6e-c04ab2b133c2","description":"

Api Methods for ApiOpenAI

\n","_postman_id":"d08fd401-4670-4d1f-ae6e-c04ab2b133c2"},{"name":"App","item":[{"name":"GetCtcIDByPushNotificationToken","id":"d5dd4655-cc67-4678-a163-236d950abe22","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"https://{{Host}}/api/App/GetCtcIDByPushNotificationToken?Token=Token-value","description":"

\n Get the list of push notification tokens linked to a contact\n \n

Response Payload

Name	Type	Description
CtcIDOutPut Description
CtcID	Int32
Error	String
Response	Boolean

","urlObject":{"protocol":"https","path":["api","App","GetCtcIDByPushNotificationToken"],"host":["{{Host}}"],"query":[{"key":"Token","value":"Token-value"}],"variable":[]}},"response":[{"id":"529fe760-2351-442c-afce-b6b5c19ff890","name":"api/App/GetCtcIDByPushNotificationToken?Token={Token} Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":{"raw":"https://{{Host}}/api/App/GetCtcIDByPushNotificationToken?Token=Token-value","protocol":"https","host":["{{Host}}"],"path":["api","App","GetCtcIDByPushNotificationToken"],"query":[{"key":"Token","value":"Token-value"}]},"description":"

\r\n Get the list of push notification tokens linked to a contact\r\n \n

Response Payload

Name	Type	Description
CtcIDOutPut Description
CtcID	Int32
Error	String
Response	Boolean

"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"Error\": \"sample string 1\",\r\n \"Response\": true,\r\n \"CtcID\": 3\r\n}"}],"_postman_id":"d5dd4655-cc67-4678-a163-236d950abe22"},{"name":"GetPushNotificationTokensByContact","id":"e41ea664-b416-4d93-83ac-69e8ffd86f52","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"https://{{Host}}/api/App/GetPushNotificationTokensByContact?CtcID=CtcID-value","description":"

\n Get the list of push notification tokens linked to a contact\n \n

Response Payload

Name	Type	Description
TokensOutPut Description
Error	String
Response	Boolean
Tokens	List<String>	List of tokens

","urlObject":{"protocol":"https","path":["api","App","GetPushNotificationTokensByContact"],"host":["{{Host}}"],"query":[{"key":"CtcID","value":"CtcID-value"}],"variable":[]}},"response":[{"id":"f6b62eca-d558-48da-8cec-ea9fa198810d","name":"api/App/GetPushNotificationTokensByContact?CtcID={CtcID} Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":{"raw":"https://{{Host}}/api/App/GetPushNotificationTokensByContact?CtcID=CtcID-value","protocol":"https","host":["{{Host}}"],"path":["api","App","GetPushNotificationTokensByContact"],"query":[{"key":"CtcID","value":"CtcID-value"}]},"description":"

\r\n Get the list of push notification tokens linked to a contact\r\n \n

Response Payload

Name	Type	Description
TokensOutPut Description
Error	String
Response	Boolean
Tokens	List<String>	List of tokens

"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"Error\": \"sample string 1\",\r\n \"Response\": true,\r\n \"Tokens\": [\r\n \"sample string 1\",\r\n \"sample string 2\"\r\n ]\r\n}"}],"_postman_id":"e41ea664-b416-4d93-83ac-69e8ffd86f52"},{"name":"LinkTo","id":"70a42d27-3ce0-4617-b482-3a8a91159f52","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"CustomerID\": 1,\r\n \"Token\": \"sample string 2\",\r\n \"ExpiryDate\": \"2026-03-25T07:30:07.4797814+00:00\",\r\n \"AppID\": 3,\r\n \"OS\": \"sample string 4\",\r\n \"SourceID\": \"sample string 5\",\r\n \"OriginID\": \"sample string 6\"\r\n}"},"url":"https://{{Host}}/api/App/LinkTo","description":"

\n Link token to customer that will be used for mobile App notifications\n \n

Body Payload

Name	Type	Description	Required
LinkToInput Description
AppID	Int32	Clients having more than one customer application should also use an AppID which will be supplied by Acteol	False
CustomerID	Int32	The ID of the customer (CtcID)	False
ExpiryDate	DateTime (nullable)	the expiry date of the token	False
OriginID	String	Origin ID	False
OS	String	Device \"IOS\" or \"Android\"	False
SourceID	String	Source ID	False
Token	String	The notification token	False

Response Payload

Name	Type	Description
ApiOutput Description
Error	String	Error description
Response	Boolean	The status call

","urlObject":{"protocol":"https","path":["api","App","LinkTo"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"b3450855-9557-4586-8357-7e761a0e7e6b","name":"api/App/LinkTo Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"CustomerID\": 1,\r\n \"Token\": \"sample string 2\",\r\n \"ExpiryDate\": \"2026-03-25T07:30:07.4797814+00:00\",\r\n \"AppID\": 3,\r\n \"OS\": \"sample string 4\",\r\n \"SourceID\": \"sample string 5\",\r\n \"OriginID\": \"sample string 6\"\r\n}"},"url":"https://{{Host}}/api/App/LinkTo","description":"

\r\n Link token to customer that will be used for mobile App notifications\r\n \n

Body Payload

Name	Type	Description	Required
LinkToInput Description
AppID	Int32	Clients having more than one customer application should also use an AppID which will be supplied by Acteol	False
CustomerID	Int32	The ID of the customer (CtcID)	False
ExpiryDate	DateTime (nullable)	the expiry date of the token	False
OriginID	String	Origin ID	False
OS	String	Device \"IOS\" or \"Android\"	False
SourceID	String	Source ID	False
Token	String	The notification token	False

Response Payload

Name	Type	Description
ApiOutput Description
Error	String	Error description
Response	Boolean	The status call

"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"Response\": true,\r\n \"Error\": \"sample string 2\"\r\n}"}],"_postman_id":"70a42d27-3ce0-4617-b482-3a8a91159f52"},{"name":"RemovePushNotificationToken","id":"ecf28b9c-d528-44df-8b9a-706be8b7971c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{Host}}/api/App/RemovePushNotificationToken?Token=Token-value","description":"

\n Remove push notification token\n \n

Body Payload

Response Payload

","urlObject":{"protocol":"https","path":["api","App","RemovePushNotificationToken"],"host":["{{Host}}"],"query":[{"key":"Token","value":"Token-value"}],"variable":[]}},"response":[{"id":"269c11c3-37f9-47bc-9388-223eba6e703d","name":"api/App/RemovePushNotificationToken?Token={Token} Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://{{Host}}/api/App/RemovePushNotificationToken?Token=Token-value","protocol":"https","host":["{{Host}}"],"path":["api","App","RemovePushNotificationToken"],"query":[{"key":"Token","value":"Token-value"}]},"description":"

\r\n Remove push notification token\r\n \n

Body Payload

Response Payload

"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"true"}],"_postman_id":"ecf28b9c-d528-44df-8b9a-706be8b7971c"},{"name":"WebLinkTo","id":"fb276729-28bc-4ee6-8bba-06adaba18351","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"CustomerID\": 1,\r\n \"Token\": \"sample string 2\",\r\n \"ExpiryDate\": \"2026-03-25T07:30:07.495419+00:00\",\r\n \"AppID\": 3,\r\n \"OS\": \"sample string 4\",\r\n \"SourceID\": \"sample string 5\",\r\n \"OriginID\": \"sample string 6\"\r\n}"},"url":"https://{{Host}}/api/App/WebLinkTo","description":"

\n Link token to customer that will be used for web notifications\n \n

Body Payload

Name	Type	Description	Required
LinkToInput Description
AppID	Int32	Clients having more than one customer application should also use an AppID which will be supplied by Acteol	False
CustomerID	Int32	The ID of the customer (CtcID)	False
ExpiryDate	DateTime (nullable)	the expiry date of the token	False
OriginID	String	Origin ID	False
OS	String	Device \"IOS\" or \"Android\"	False
SourceID	String	Source ID	False
Token	String	The notification token	False

","urlObject":{"protocol":"https","path":["api","App","WebLinkTo"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"468beb59-929d-4d09-afe6-2ba944faa017","name":"api/App/WebLinkTo Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"CustomerID\": 1,\r\n \"Token\": \"sample string 2\",\r\n \"ExpiryDate\": \"2026-03-25T07:30:07.495419+00:00\",\r\n \"AppID\": 3,\r\n \"OS\": \"sample string 4\",\r\n \"SourceID\": \"sample string 5\",\r\n \"OriginID\": \"sample string 6\"\r\n}"},"url":"https://{{Host}}/api/App/WebLinkTo","description":"

\r\n Link token to customer that will be used for web notifications\r\n \n

Body Payload

Name	Type	Description	Required
LinkToInput Description
AppID	Int32	Clients having more than one customer application should also use an AppID which will be supplied by Acteol	False
CustomerID	Int32	The ID of the customer (CtcID)	False
ExpiryDate	DateTime (nullable)	the expiry date of the token	False
OriginID	String	Origin ID	False
OS	String	Device \"IOS\" or \"Android\"	False
SourceID	String	Source ID	False
Token	String	The notification token	False

"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"fb276729-28bc-4ee6-8bba-06adaba18351"}],"id":"68ffe133-9341-46da-826f-763f9fb5079d","description":"

Api Methods for App

\n","_postman_id":"68ffe133-9341-46da-826f-763f9fb5079d"},{"name":"AtreemoTranslator","item":[{"name":"Translate","id":"fe90e45b-15ae-4072-9306-2ca3b072fe3d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"Texts\": [\r\n \"sample string 1\",\r\n \"sample string 2\"\r\n ],\r\n \"LanguageCode\": \"sample string 1\"\r\n}"},"url":"https://{{Host}}/api/AtreemoTranslator/Translate","description":"

Body Payload

Name	Type	Required
TranslationRequest Description
LanguageCode	String	False
Texts	List<String>	False

","urlObject":{"protocol":"https","path":["api","AtreemoTranslator","Translate"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"61628c2c-d635-465b-8c36-4517ef8b2051","name":"api/AtreemoTranslator/Translate Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"Texts\": [\r\n \"sample string 1\",\r\n \"sample string 2\"\r\n ],\r\n \"LanguageCode\": \"sample string 1\"\r\n}"},"url":"https://{{Host}}/api/AtreemoTranslator/Translate","description":"

Body Payload

Name	Type	Required
TranslationRequest Description
LanguageCode	String	False
Texts	List<String>	False

"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"fe90e45b-15ae-4072-9306-2ca3b072fe3d"}],"id":"82e04f4c-91fa-48fd-a214-e7700a6d613f","description":"

Api Methods for AtreemoTranslator

\n","_postman_id":"82e04f4c-91fa-48fd-a214-e7700a6d613f"},{"name":"Basket","item":[{"name":"AutoRedeemBenefit","id":"7c4b86ba-de51-4d05-afff-76d1f91ec6e8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"CustomerID\": 1,\r\n \"Basket\": {\r\n \"OrderID\": 1,\r\n \"LocationID\": \"sample string 2\",\r\n \"OrderDate\": \"2026-03-25T07:30:07.495419+00:00\",\r\n \"BasketItems\": [\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"DiscountAmount\": 6.1,\r\n \"PointsDiscount\": 7.1,\r\n \"TotalAmountExclTax\": 8.1,\r\n \"TotalAmount\": 9.1,\r\n \"CustomerID\": 10,\r\n \"ModifierItems\": [\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"TotalAmountExclTax\": 6.1,\r\n \"TotalAmount\": 7.1,\r\n \"DiscountAmount\": 8.1,\r\n \"PointsDiscount\": 9.1\r\n },\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"TotalAmountExclTax\": 6.1,\r\n \"TotalAmount\": 7.1,\r\n \"DiscountAmount\": 8.1,\r\n \"PointsDiscount\": 9.1\r\n }\r\n ]\r\n },\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"DiscountAmount\": 6.1,\r\n \"PointsDiscount\": 7.1,\r\n \"TotalAmountExclTax\": 8.1,\r\n \"TotalAmount\": 9.1,\r\n \"CustomerID\": 10,\r\n \"ModifierItems\": [\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"TotalAmountExclTax\": 6.1,\r\n \"TotalAmount\": 7.1,\r\n \"DiscountAmount\": 8.1,\r\n \"PointsDiscount\": 9.1\r\n },\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"TotalAmountExclTax\": 6.1,\r\n \"TotalAmount\": 7.1,\r\n \"DiscountAmount\": 8.1,\r\n \"PointsDiscount\": 9.1\r\n }\r\n ]\r\n }\r\n ],\r\n \"TotalCostExclTax\": 3.1,\r\n \"TotalCost\": 4.1,\r\n \"SourceID\": \"sample string 5\",\r\n \"VATNumber\": \"sample string 6\"\r\n }\r\n}"},"url":"https://{{Host}}/api/Basket/AutoRedeemBenefit","description":"

\n Auto select voucher for redemption\n \n

Body Payload

Name	Type	Description	Required
AutoRedemptionValidationInput Description
Basket	Basket	The basket	False
CustomerID	Int32	The ID of the customer (CtcID)	False
Basket Description
Name	Type	Description	Required
BasketItems	List<BasketItem>	The list of basket details	False
LocationID	String	the ID of the site	False
OrderDate	DateTime (nullable)	The Date of order	False
OrderID	Int32	The order ID	False
SourceID	String	The source of the basket	False
TotalCost	Double	The total amount	False
TotalCostExclTax	Double	The total amount without VAT	False
VATNumber	String	VAT ID	False
BasketItem Description
Name	Type	Description	Required
CustomerID	Int32	The ID of the customer (CtcID).It should be empty when the order is linked to one customer	False
DiscountAmount	Double	The discount amount	False
ItemID	Int32	the Unique identifier of the basket item	False
ModifierItems	List<BasketModifiersItem>	The list of modifiers	False
Name	String	The name of the product	False
PointsDiscount	Double	The points to be burnt	False
ProductCode	String	The code of the product	False
Quantity	Double	Quantity	False
TotalAmount	Double	The amount paid (will be used to calculate the number of points earnt)	False
TotalAmountExclTax	Double	The total amount of the basket item without VAT	False
UnitPrice	Double	The unit price of the product	False
BasketModifiersItem Description
Name	Type	Description	Required
DiscountAmount	Double	The discount amount	False
ItemID	Int32	the Unique identifier of the basket item	False
Name	String	The name of the product	False
PointsDiscount	Double	The points to be burnt	False
ProductCode	String	The code of the product	False
Quantity	Double	Quantity	False
TotalAmount	Double	The amount paid (will be used to calculate the number of points earnt)	False
TotalAmountExclTax	Double	The total amount of the basket item witout VAT	False
UnitPrice	Double	The unit price of the product	False

Response Payload

Name	Type	Description
RedemptionValidationOutput Description
DiscountItem	BasketDiscountItem	The discount details
Error	List<String>	The list of errors description
Response	Boolean	The status of the call
BasketDiscountItem Description
Name	Type	Description
DiscountAmount	Double	The amount of the discount related to this item
RedemptionID	String	The unique identifier of the redemption
VoucherCode	String	The benefit code used for this discount

","urlObject":{"protocol":"https","path":["api","Basket","AutoRedeemBenefit"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"4e3586d9-786b-4a55-9676-b704f01cbd5c","name":"api/Basket/AutoRedeemBenefit Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"CustomerID\": 1,\r\n \"Basket\": {\r\n \"OrderID\": 1,\r\n \"LocationID\": \"sample string 2\",\r\n \"OrderDate\": \"2026-03-25T07:30:07.495419+00:00\",\r\n \"BasketItems\": [\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"DiscountAmount\": 6.1,\r\n \"PointsDiscount\": 7.1,\r\n \"TotalAmountExclTax\": 8.1,\r\n \"TotalAmount\": 9.1,\r\n \"CustomerID\": 10,\r\n \"ModifierItems\": [\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"TotalAmountExclTax\": 6.1,\r\n \"TotalAmount\": 7.1,\r\n \"DiscountAmount\": 8.1,\r\n \"PointsDiscount\": 9.1\r\n },\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"TotalAmountExclTax\": 6.1,\r\n \"TotalAmount\": 7.1,\r\n \"DiscountAmount\": 8.1,\r\n \"PointsDiscount\": 9.1\r\n }\r\n ]\r\n },\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"DiscountAmount\": 6.1,\r\n \"PointsDiscount\": 7.1,\r\n \"TotalAmountExclTax\": 8.1,\r\n \"TotalAmount\": 9.1,\r\n \"CustomerID\": 10,\r\n \"ModifierItems\": [\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"TotalAmountExclTax\": 6.1,\r\n \"TotalAmount\": 7.1,\r\n \"DiscountAmount\": 8.1,\r\n \"PointsDiscount\": 9.1\r\n },\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"TotalAmountExclTax\": 6.1,\r\n \"TotalAmount\": 7.1,\r\n \"DiscountAmount\": 8.1,\r\n \"PointsDiscount\": 9.1\r\n }\r\n ]\r\n }\r\n ],\r\n \"TotalCostExclTax\": 3.1,\r\n \"TotalCost\": 4.1,\r\n \"SourceID\": \"sample string 5\",\r\n \"VATNumber\": \"sample string 6\"\r\n }\r\n}"},"url":"https://{{Host}}/api/Basket/AutoRedeemBenefit","description":"

\r\n Auto select voucher for redemption\r\n \n

Body Payload

Name	Type	Description	Required
AutoRedemptionValidationInput Description
Basket	Basket	The basket	False
CustomerID	Int32	The ID of the customer (CtcID)	False
Basket Description
Name	Type	Description	Required
BasketItems	List<BasketItem>	The list of basket details	False
LocationID	String	the ID of the site	False
OrderDate	DateTime (nullable)	The Date of order	False
OrderID	Int32	The order ID	False
SourceID	String	The source of the basket	False
TotalCost	Double	The total amount	False
TotalCostExclTax	Double	The total amount without VAT	False
VATNumber	String	VAT ID	False
BasketItem Description
Name	Type	Description	Required
CustomerID	Int32	The ID of the customer (CtcID).It should be empty when the order is linked to one customer	False
DiscountAmount	Double	The discount amount	False
ItemID	Int32	the Unique identifier of the basket item	False
ModifierItems	List<BasketModifiersItem>	The list of modifiers	False
Name	String	The name of the product	False
PointsDiscount	Double	The points to be burnt	False
ProductCode	String	The code of the product	False
Quantity	Double	Quantity	False
TotalAmount	Double	The amount paid (will be used to calculate the number of points earnt)	False
TotalAmountExclTax	Double	The total amount of the basket item without VAT	False
UnitPrice	Double	The unit price of the product	False
BasketModifiersItem Description
Name	Type	Description	Required
DiscountAmount	Double	The discount amount	False
ItemID	Int32	the Unique identifier of the basket item	False
Name	String	The name of the product	False
PointsDiscount	Double	The points to be burnt	False
ProductCode	String	The code of the product	False
Quantity	Double	Quantity	False
TotalAmount	Double	The amount paid (will be used to calculate the number of points earnt)	False
TotalAmountExclTax	Double	The total amount of the basket item witout VAT	False
UnitPrice	Double	The unit price of the product	False

Response Payload

Name	Type	Description
RedemptionValidationOutput Description
DiscountItem	BasketDiscountItem	The discount details
Error	List<String>	The list of errors description
Response	Boolean	The status of the call
BasketDiscountItem Description
Name	Type	Description
DiscountAmount	Double	The amount of the discount related to this item
RedemptionID	String	The unique identifier of the redemption
VoucherCode	String	The benefit code used for this discount

"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"DiscountItem\": {\r\n \"RedemptionID\": \"sample string 1\",\r\n \"DiscountAmount\": 2.1,\r\n \"VoucherCode\": \"sample string 3\"\r\n },\r\n \"Response\": true,\r\n \"Error\": [\r\n \"sample string 1\",\r\n \"sample string 2\"\r\n ]\r\n}"}],"_postman_id":"7c4b86ba-de51-4d05-afff-76d1f91ec6e8"},{"name":"Burn","id":"2cab2b94-0edd-4e62-ae7f-c5e268d78e0d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"CustomerID\": 1,\r\n \"Description\": \"sample string 2\",\r\n \"Basket\": {\r\n \"OrderID\": 1,\r\n \"LocationID\": \"sample string 2\",\r\n \"OrderDate\": \"2026-03-25T07:30:07.5266608+00:00\",\r\n \"BasketItems\": [\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"DiscountAmount\": 6.1,\r\n \"PointsDiscount\": 7.1,\r\n \"TotalAmountExclTax\": 8.1,\r\n \"TotalAmount\": 9.1,\r\n \"CustomerID\": 10,\r\n \"ModifierItems\": [\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"TotalAmountExclTax\": 6.1,\r\n \"TotalAmount\": 7.1,\r\n \"DiscountAmount\": 8.1,\r\n \"PointsDiscount\": 9.1\r\n },\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"TotalAmountExclTax\": 6.1,\r\n \"TotalAmount\": 7.1,\r\n \"DiscountAmount\": 8.1,\r\n \"PointsDiscount\": 9.1\r\n }\r\n ]\r\n },\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"DiscountAmount\": 6.1,\r\n \"PointsDiscount\": 7.1,\r\n \"TotalAmountExclTax\": 8.1,\r\n \"TotalAmount\": 9.1,\r\n \"CustomerID\": 10,\r\n \"ModifierItems\": [\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"TotalAmountExclTax\": 6.1,\r\n \"TotalAmount\": 7.1,\r\n \"DiscountAmount\": 8.1,\r\n \"PointsDiscount\": 9.1\r\n },\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"TotalAmountExclTax\": 6.1,\r\n \"TotalAmount\": 7.1,\r\n \"DiscountAmount\": 8.1,\r\n \"PointsDiscount\": 9.1\r\n }\r\n ]\r\n }\r\n ],\r\n \"TotalCostExclTax\": 3.1,\r\n \"TotalCost\": 4.1,\r\n \"SourceID\": \"sample string 5\",\r\n \"VATNumber\": \"sample string 6\"\r\n },\r\n \"Payment\": {\r\n \"PaymentMethodName\": \"sample string 1\",\r\n \"AmountPaid\": 2.1\r\n }\r\n}"},"url":"https://{{Host}}/api/Basket/Burn","description":"

\n Burn points\n \n

Body Payload

Name	Type	Description	Required
BasketPointInput Description
Basket	Basket	The basket	False
CustomerID	Int32	The ID of the customer (CtcID)	False
Description	String	Description of the transaction	False
Payment	BasketPayment	The payment method used to earn point	False
Basket Description
Name	Type	Description	Required
BasketItems	List<BasketItem>	The list of basket details	False
LocationID	String	the ID of the site	False
OrderDate	DateTime (nullable)	The Date of order	False
OrderID	Int32	The order ID	False
SourceID	String	The source of the basket	False
TotalCost	Double	The total amount	False
TotalCostExclTax	Double	The total amount without VAT	False
VATNumber	String	VAT ID	False
BasketItem Description
Name	Type	Description	Required
CustomerID	Int32	The ID of the customer (CtcID).It should be empty when the order is linked to one customer	False
DiscountAmount	Double	The discount amount	False
ItemID	Int32	the Unique identifier of the basket item	False
ModifierItems	List<BasketModifiersItem>	The list of modifiers	False
Name	String	The name of the product	False
PointsDiscount	Double	The points to be burnt	False
ProductCode	String	The code of the product	False
Quantity	Double	Quantity	False
TotalAmount	Double	The amount paid (will be used to calculate the number of points earnt)	False
TotalAmountExclTax	Double	The total amount of the basket item without VAT	False
UnitPrice	Double	The unit price of the product	False
BasketModifiersItem Description
Name	Type	Description	Required
DiscountAmount	Double	The discount amount	False
ItemID	Int32	the Unique identifier of the basket item	False
Name	String	The name of the product	False
PointsDiscount	Double	The points to be burnt	False
ProductCode	String	The code of the product	False
Quantity	Double	Quantity	False
TotalAmount	Double	The amount paid (will be used to calculate the number of points earnt)	False
TotalAmountExclTax	Double	The total amount of the basket item witout VAT	False
UnitPrice	Double	The unit price of the product	False
BasketPayment Description
Name	Type	Description	Required
AmountPaid	Double	Amount paid	False
PaymentMethodName	String	The Payment method name	False

Response Payload

Name	Type	Description
BasketPointOutput Description
CashBalance	Double	The cash balance of the customer
CustomerID	Int32	The ID of the customer (CtcID)
Error	List<String>	The list of errors description
PointBalance	Double	The point balance of the customer
Response	Boolean	The status of the call

","urlObject":{"protocol":"https","path":["api","Basket","Burn"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"dc80ee65-c97c-4247-a07e-2c70bd526bb0","name":"api/Basket/Burn Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"CustomerID\": 1,\r\n \"Description\": \"sample string 2\",\r\n \"Basket\": {\r\n \"OrderID\": 1,\r\n \"LocationID\": \"sample string 2\",\r\n \"OrderDate\": \"2026-03-25T07:30:07.5266608+00:00\",\r\n \"BasketItems\": [\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"DiscountAmount\": 6.1,\r\n \"PointsDiscount\": 7.1,\r\n \"TotalAmountExclTax\": 8.1,\r\n \"TotalAmount\": 9.1,\r\n \"CustomerID\": 10,\r\n \"ModifierItems\": [\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"TotalAmountExclTax\": 6.1,\r\n \"TotalAmount\": 7.1,\r\n \"DiscountAmount\": 8.1,\r\n \"PointsDiscount\": 9.1\r\n },\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"TotalAmountExclTax\": 6.1,\r\n \"TotalAmount\": 7.1,\r\n \"DiscountAmount\": 8.1,\r\n \"PointsDiscount\": 9.1\r\n }\r\n ]\r\n },\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"DiscountAmount\": 6.1,\r\n \"PointsDiscount\": 7.1,\r\n \"TotalAmountExclTax\": 8.1,\r\n \"TotalAmount\": 9.1,\r\n \"CustomerID\": 10,\r\n \"ModifierItems\": [\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"TotalAmountExclTax\": 6.1,\r\n \"TotalAmount\": 7.1,\r\n \"DiscountAmount\": 8.1,\r\n \"PointsDiscount\": 9.1\r\n },\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"TotalAmountExclTax\": 6.1,\r\n \"TotalAmount\": 7.1,\r\n \"DiscountAmount\": 8.1,\r\n \"PointsDiscount\": 9.1\r\n }\r\n ]\r\n }\r\n ],\r\n \"TotalCostExclTax\": 3.1,\r\n \"TotalCost\": 4.1,\r\n \"SourceID\": \"sample string 5\",\r\n \"VATNumber\": \"sample string 6\"\r\n },\r\n \"Payment\": {\r\n \"PaymentMethodName\": \"sample string 1\",\r\n \"AmountPaid\": 2.1\r\n }\r\n}"},"url":"https://{{Host}}/api/Basket/Burn","description":"

\r\n Burn points\r\n \n

Body Payload

Name	Type	Description	Required
BasketPointInput Description
Basket	Basket	The basket	False
CustomerID	Int32	The ID of the customer (CtcID)	False
Description	String	Description of the transaction	False
Payment	BasketPayment	The payment method used to earn point	False
Basket Description
Name	Type	Description	Required
BasketItems	List<BasketItem>	The list of basket details	False
LocationID	String	the ID of the site	False
OrderDate	DateTime (nullable)	The Date of order	False
OrderID	Int32	The order ID	False
SourceID	String	The source of the basket	False
TotalCost	Double	The total amount	False
TotalCostExclTax	Double	The total amount without VAT	False
VATNumber	String	VAT ID	False
BasketItem Description
Name	Type	Description	Required
CustomerID	Int32	The ID of the customer (CtcID).It should be empty when the order is linked to one customer	False
DiscountAmount	Double	The discount amount	False
ItemID	Int32	the Unique identifier of the basket item	False
ModifierItems	List<BasketModifiersItem>	The list of modifiers	False
Name	String	The name of the product	False
PointsDiscount	Double	The points to be burnt	False
ProductCode	String	The code of the product	False
Quantity	Double	Quantity	False
TotalAmount	Double	The amount paid (will be used to calculate the number of points earnt)	False
TotalAmountExclTax	Double	The total amount of the basket item without VAT	False
UnitPrice	Double	The unit price of the product	False
BasketModifiersItem Description
Name	Type	Description	Required
DiscountAmount	Double	The discount amount	False
ItemID	Int32	the Unique identifier of the basket item	False
Name	String	The name of the product	False
PointsDiscount	Double	The points to be burnt	False
ProductCode	String	The code of the product	False
Quantity	Double	Quantity	False
TotalAmount	Double	The amount paid (will be used to calculate the number of points earnt)	False
TotalAmountExclTax	Double	The total amount of the basket item witout VAT	False
UnitPrice	Double	The unit price of the product	False
BasketPayment Description
Name	Type	Description	Required
AmountPaid	Double	Amount paid	False
PaymentMethodName	String	The Payment method name	False

Response Payload

Name	Type	Description
BasketPointOutput Description
CashBalance	Double	The cash balance of the customer
CustomerID	Int32	The ID of the customer (CtcID)
Error	List<String>	The list of errors description
PointBalance	Double	The point balance of the customer
Response	Boolean	The status of the call

\n Cancel the basket\n \n

Body Payload

Name	Type	Description	Required
BasketCancellationInput Description
BasketID	String	The ID basket	False
OrderID	String	The ID of the orderbasket	False

Response Payload

Name	Type	Description
BasketCancellationOutput Description
Error	List<String>	The list of errors description
Response	Boolean	The status of the call

","urlObject":{"protocol":"https","path":["api","Basket","CancelBasket"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"9db27831-4932-442f-b52f-0453a5c92039","name":"api/Basket/CancelBasket Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"BasketID\": \"sample string 1\",\r\n \"OrderID\": \"sample string 2\"\r\n}"},"url":"https://{{Host}}/api/Basket/CancelBasket","description":"

\r\n Cancel the basket\r\n \n

Body Payload

Name	Type	Description	Required
BasketCancellationInput Description
BasketID	String	The ID basket	False
OrderID	String	The ID of the orderbasket	False

Response Payload

Name	Type	Description
BasketCancellationOutput Description
Error	List<String>	The list of errors description
Response	Boolean	The status of the call

"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"Response\": true,\r\n \"Error\": [\r\n \"sample string 1\",\r\n \"sample string 2\"\r\n ]\r\n}"}],"_postman_id":"e88cf6d2-4e98-41ea-a81b-d30e30282723"},{"name":"CancelBurnPoint","id":"4acc2cde-030f-4630-a896-0da83e243c2c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"CustomerID\": 1,\r\n \"Description\": \"sample string 2\",\r\n \"Basket\": {\r\n \"OrderID\": 1,\r\n \"LocationID\": \"sample string 2\",\r\n \"OrderDate\": \"2026-03-25T07:30:07.5579081+00:00\",\r\n \"BasketItems\": [\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"DiscountAmount\": 6.1,\r\n \"PointsDiscount\": 7.1,\r\n \"TotalAmountExclTax\": 8.1,\r\n \"TotalAmount\": 9.1,\r\n \"CustomerID\": 10,\r\n \"ModifierItems\": [\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"TotalAmountExclTax\": 6.1,\r\n \"TotalAmount\": 7.1,\r\n \"DiscountAmount\": 8.1,\r\n \"PointsDiscount\": 9.1\r\n },\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"TotalAmountExclTax\": 6.1,\r\n \"TotalAmount\": 7.1,\r\n \"DiscountAmount\": 8.1,\r\n \"PointsDiscount\": 9.1\r\n }\r\n ]\r\n },\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"DiscountAmount\": 6.1,\r\n \"PointsDiscount\": 7.1,\r\n \"TotalAmountExclTax\": 8.1,\r\n \"TotalAmount\": 9.1,\r\n \"CustomerID\": 10,\r\n \"ModifierItems\": [\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"TotalAmountExclTax\": 6.1,\r\n \"TotalAmount\": 7.1,\r\n \"DiscountAmount\": 8.1,\r\n \"PointsDiscount\": 9.1\r\n },\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"TotalAmountExclTax\": 6.1,\r\n \"TotalAmount\": 7.1,\r\n \"DiscountAmount\": 8.1,\r\n \"PointsDiscount\": 9.1\r\n }\r\n ]\r\n }\r\n ],\r\n \"TotalCostExclTax\": 3.1,\r\n \"TotalCost\": 4.1,\r\n \"SourceID\": \"sample string 5\",\r\n \"VATNumber\": \"sample string 6\"\r\n },\r\n \"Payment\": {\r\n \"PaymentMethodName\": \"sample string 1\",\r\n \"AmountPaid\": 2.1\r\n }\r\n}"},"url":"https://{{Host}}/api/Basket/CancelBurnPoint","description":"

\n Revert points\n \n

Body Payload

Name	Type	Description	Required
BasketPointInput Description
Basket	Basket	The basket	False
CustomerID	Int32	The ID of the customer (CtcID)	False
Description	String	Description of the transaction	False
Payment	BasketPayment	The payment method used to earn point	False
Basket Description
Name	Type	Description	Required
BasketItems	List<BasketItem>	The list of basket details	False
LocationID	String	the ID of the site	False
OrderDate	DateTime (nullable)	The Date of order	False
OrderID	Int32	The order ID	False
SourceID	String	The source of the basket	False
TotalCost	Double	The total amount	False
TotalCostExclTax	Double	The total amount without VAT	False
VATNumber	String	VAT ID	False
BasketItem Description
Name	Type	Description	Required
CustomerID	Int32	The ID of the customer (CtcID).It should be empty when the order is linked to one customer	False
DiscountAmount	Double	The discount amount	False
ItemID	Int32	the Unique identifier of the basket item	False
ModifierItems	List<BasketModifiersItem>	The list of modifiers	False
Name	String	The name of the product	False
PointsDiscount	Double	The points to be burnt	False
ProductCode	String	The code of the product	False
Quantity	Double	Quantity	False
TotalAmount	Double	The amount paid (will be used to calculate the number of points earnt)	False
TotalAmountExclTax	Double	The total amount of the basket item without VAT	False
UnitPrice	Double	The unit price of the product	False
BasketModifiersItem Description
Name	Type	Description	Required
DiscountAmount	Double	The discount amount	False
ItemID	Int32	the Unique identifier of the basket item	False
Name	String	The name of the product	False
PointsDiscount	Double	The points to be burnt	False
ProductCode	String	The code of the product	False
Quantity	Double	Quantity	False
TotalAmount	Double	The amount paid (will be used to calculate the number of points earnt)	False
TotalAmountExclTax	Double	The total amount of the basket item witout VAT	False
UnitPrice	Double	The unit price of the product	False
BasketPayment Description
Name	Type	Description	Required
AmountPaid	Double	Amount paid	False
PaymentMethodName	String	The Payment method name	False

Response Payload

Name	Type	Description
BasketPointOutput Description
CashBalance	Double	The cash balance of the customer
CustomerID	Int32	The ID of the customer (CtcID)
Error	List<String>	The list of errors description
PointBalance	Double	The point balance of the customer
Response	Boolean	The status of the call

","urlObject":{"protocol":"https","path":["api","Basket","CancelBurnPoint"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"d4cd6f58-c40f-423e-8e50-a5c222edf45e","name":"api/Basket/CancelBurnPoint Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"CustomerID\": 1,\r\n \"Description\": \"sample string 2\",\r\n \"Basket\": {\r\n \"OrderID\": 1,\r\n \"LocationID\": \"sample string 2\",\r\n \"OrderDate\": \"2026-03-25T07:30:07.5579081+00:00\",\r\n \"BasketItems\": [\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"DiscountAmount\": 6.1,\r\n \"PointsDiscount\": 7.1,\r\n \"TotalAmountExclTax\": 8.1,\r\n \"TotalAmount\": 9.1,\r\n \"CustomerID\": 10,\r\n \"ModifierItems\": [\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"TotalAmountExclTax\": 6.1,\r\n \"TotalAmount\": 7.1,\r\n \"DiscountAmount\": 8.1,\r\n \"PointsDiscount\": 9.1\r\n },\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"TotalAmountExclTax\": 6.1,\r\n \"TotalAmount\": 7.1,\r\n \"DiscountAmount\": 8.1,\r\n \"PointsDiscount\": 9.1\r\n }\r\n ]\r\n },\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"DiscountAmount\": 6.1,\r\n \"PointsDiscount\": 7.1,\r\n \"TotalAmountExclTax\": 8.1,\r\n \"TotalAmount\": 9.1,\r\n \"CustomerID\": 10,\r\n \"ModifierItems\": [\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"TotalAmountExclTax\": 6.1,\r\n \"TotalAmount\": 7.1,\r\n \"DiscountAmount\": 8.1,\r\n \"PointsDiscount\": 9.1\r\n },\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"TotalAmountExclTax\": 6.1,\r\n \"TotalAmount\": 7.1,\r\n \"DiscountAmount\": 8.1,\r\n \"PointsDiscount\": 9.1\r\n }\r\n ]\r\n }\r\n ],\r\n \"TotalCostExclTax\": 3.1,\r\n \"TotalCost\": 4.1,\r\n \"SourceID\": \"sample string 5\",\r\n \"VATNumber\": \"sample string 6\"\r\n },\r\n \"Payment\": {\r\n \"PaymentMethodName\": \"sample string 1\",\r\n \"AmountPaid\": 2.1\r\n }\r\n}"},"url":"https://{{Host}}/api/Basket/CancelBurnPoint","description":"

\r\n Revert points\r\n \n

Body Payload

Name	Type	Description	Required
BasketPointInput Description
Basket	Basket	The basket	False
CustomerID	Int32	The ID of the customer (CtcID)	False
Description	String	Description of the transaction	False
Payment	BasketPayment	The payment method used to earn point	False
Basket Description
Name	Type	Description	Required
BasketItems	List<BasketItem>	The list of basket details	False
LocationID	String	the ID of the site	False
OrderDate	DateTime (nullable)	The Date of order	False
OrderID	Int32	The order ID	False
SourceID	String	The source of the basket	False
TotalCost	Double	The total amount	False
TotalCostExclTax	Double	The total amount without VAT	False
VATNumber	String	VAT ID	False
BasketItem Description
Name	Type	Description	Required
CustomerID	Int32	The ID of the customer (CtcID).It should be empty when the order is linked to one customer	False
DiscountAmount	Double	The discount amount	False
ItemID	Int32	the Unique identifier of the basket item	False
ModifierItems	List<BasketModifiersItem>	The list of modifiers	False
Name	String	The name of the product	False
PointsDiscount	Double	The points to be burnt	False
ProductCode	String	The code of the product	False
Quantity	Double	Quantity	False
TotalAmount	Double	The amount paid (will be used to calculate the number of points earnt)	False
TotalAmountExclTax	Double	The total amount of the basket item without VAT	False
UnitPrice	Double	The unit price of the product	False
BasketModifiersItem Description
Name	Type	Description	Required
DiscountAmount	Double	The discount amount	False
ItemID	Int32	the Unique identifier of the basket item	False
Name	String	The name of the product	False
PointsDiscount	Double	The points to be burnt	False
ProductCode	String	The code of the product	False
Quantity	Double	Quantity	False
TotalAmount	Double	The amount paid (will be used to calculate the number of points earnt)	False
TotalAmountExclTax	Double	The total amount of the basket item witout VAT	False
UnitPrice	Double	The unit price of the product	False
BasketPayment Description
Name	Type	Description	Required
AmountPaid	Double	Amount paid	False
PaymentMethodName	String	The Payment method name	False

Response Payload

Name	Type	Description
BasketPointOutput Description
CashBalance	Double	The cash balance of the customer
CustomerID	Int32	The ID of the customer (CtcID)
Error	List<String>	The list of errors description
PointBalance	Double	The point balance of the customer
Response	Boolean	The status of the call

"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"CustomerID\": 1,\r\n \"PointBalance\": 2.1,\r\n \"CashBalance\": 3.1,\r\n \"Response\": true,\r\n \"Error\": [\r\n \"sample string 1\",\r\n \"sample string 2\"\r\n ]\r\n}"}],"_postman_id":"4acc2cde-030f-4630-a896-0da83e243c2c"},{"name":"CancelEarnPoint","id":"3773f38f-c530-4160-8ebf-8e884a0d00c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"CustomerID\": 1,\r\n \"Description\": \"sample string 2\",\r\n \"Basket\": {\r\n \"OrderID\": 1,\r\n \"LocationID\": \"sample string 2\",\r\n \"OrderDate\": \"2026-03-25T07:30:07.5579081+00:00\",\r\n \"BasketItems\": [\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"DiscountAmount\": 6.1,\r\n \"PointsDiscount\": 7.1,\r\n \"TotalAmountExclTax\": 8.1,\r\n \"TotalAmount\": 9.1,\r\n \"CustomerID\": 10,\r\n \"ModifierItems\": [\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"TotalAmountExclTax\": 6.1,\r\n \"TotalAmount\": 7.1,\r\n \"DiscountAmount\": 8.1,\r\n \"PointsDiscount\": 9.1\r\n },\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"TotalAmountExclTax\": 6.1,\r\n \"TotalAmount\": 7.1,\r\n \"DiscountAmount\": 8.1,\r\n \"PointsDiscount\": 9.1\r\n }\r\n ]\r\n },\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"DiscountAmount\": 6.1,\r\n \"PointsDiscount\": 7.1,\r\n \"TotalAmountExclTax\": 8.1,\r\n \"TotalAmount\": 9.1,\r\n \"CustomerID\": 10,\r\n \"ModifierItems\": [\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"TotalAmountExclTax\": 6.1,\r\n \"TotalAmount\": 7.1,\r\n \"DiscountAmount\": 8.1,\r\n \"PointsDiscount\": 9.1\r\n },\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"TotalAmountExclTax\": 6.1,\r\n \"TotalAmount\": 7.1,\r\n \"DiscountAmount\": 8.1,\r\n \"PointsDiscount\": 9.1\r\n }\r\n ]\r\n }\r\n ],\r\n \"TotalCostExclTax\": 3.1,\r\n \"TotalCost\": 4.1,\r\n \"SourceID\": \"sample string 5\",\r\n \"VATNumber\": \"sample string 6\"\r\n },\r\n \"Payment\": {\r\n \"PaymentMethodName\": \"sample string 1\",\r\n \"AmountPaid\": 2.1\r\n }\r\n}"},"url":"https://{{Host}}/api/Basket/CancelEarnPoint","description":"

\n Revert points\n \n

Body Payload

Name	Type	Description	Required
BasketPointInput Description
Basket	Basket	The basket	False
CustomerID	Int32	The ID of the customer (CtcID)	False
Description	String	Description of the transaction	False
Payment	BasketPayment	The payment method used to earn point	False
Basket Description
Name	Type	Description	Required
BasketItems	List<BasketItem>	The list of basket details	False
LocationID	String	the ID of the site	False
OrderDate	DateTime (nullable)	The Date of order	False
OrderID	Int32	The order ID	False
SourceID	String	The source of the basket	False
TotalCost	Double	The total amount	False
TotalCostExclTax	Double	The total amount without VAT	False
VATNumber	String	VAT ID	False
BasketItem Description
Name	Type	Description	Required
CustomerID	Int32	The ID of the customer (CtcID).It should be empty when the order is linked to one customer	False
DiscountAmount	Double	The discount amount	False
ItemID	Int32	the Unique identifier of the basket item	False
ModifierItems	List<BasketModifiersItem>	The list of modifiers	False
Name	String	The name of the product	False
PointsDiscount	Double	The points to be burnt	False
ProductCode	String	The code of the product	False
Quantity	Double	Quantity	False
TotalAmount	Double	The amount paid (will be used to calculate the number of points earnt)	False
TotalAmountExclTax	Double	The total amount of the basket item without VAT	False
UnitPrice	Double	The unit price of the product	False
BasketModifiersItem Description
Name	Type	Description	Required
DiscountAmount	Double	The discount amount	False
ItemID	Int32	the Unique identifier of the basket item	False
Name	String	The name of the product	False
PointsDiscount	Double	The points to be burnt	False
ProductCode	String	The code of the product	False
Quantity	Double	Quantity	False
TotalAmount	Double	The amount paid (will be used to calculate the number of points earnt)	False
TotalAmountExclTax	Double	The total amount of the basket item witout VAT	False
UnitPrice	Double	The unit price of the product	False
BasketPayment Description
Name	Type	Description	Required
AmountPaid	Double	Amount paid	False
PaymentMethodName	String	The Payment method name	False

Response Payload

Name	Type	Description
BasketPointOutput Description
CashBalance	Double	The cash balance of the customer
CustomerID	Int32	The ID of the customer (CtcID)
Error	List<String>	The list of errors description
PointBalance	Double	The point balance of the customer
Response	Boolean	The status of the call

","urlObject":{"protocol":"https","path":["api","Basket","CancelEarnPoint"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"340886aa-7954-45e7-a6eb-d78549f82947","name":"api/Basket/CancelEarnPoint Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"CustomerID\": 1,\r\n \"Description\": \"sample string 2\",\r\n \"Basket\": {\r\n \"OrderID\": 1,\r\n \"LocationID\": \"sample string 2\",\r\n \"OrderDate\": \"2026-03-25T07:30:07.5579081+00:00\",\r\n \"BasketItems\": [\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"DiscountAmount\": 6.1,\r\n \"PointsDiscount\": 7.1,\r\n \"TotalAmountExclTax\": 8.1,\r\n \"TotalAmount\": 9.1,\r\n \"CustomerID\": 10,\r\n \"ModifierItems\": [\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"TotalAmountExclTax\": 6.1,\r\n \"TotalAmount\": 7.1,\r\n \"DiscountAmount\": 8.1,\r\n \"PointsDiscount\": 9.1\r\n },\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"TotalAmountExclTax\": 6.1,\r\n \"TotalAmount\": 7.1,\r\n \"DiscountAmount\": 8.1,\r\n \"PointsDiscount\": 9.1\r\n }\r\n ]\r\n },\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"DiscountAmount\": 6.1,\r\n \"PointsDiscount\": 7.1,\r\n \"TotalAmountExclTax\": 8.1,\r\n \"TotalAmount\": 9.1,\r\n \"CustomerID\": 10,\r\n \"ModifierItems\": [\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"TotalAmountExclTax\": 6.1,\r\n \"TotalAmount\": 7.1,\r\n \"DiscountAmount\": 8.1,\r\n \"PointsDiscount\": 9.1\r\n },\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"TotalAmountExclTax\": 6.1,\r\n \"TotalAmount\": 7.1,\r\n \"DiscountAmount\": 8.1,\r\n \"PointsDiscount\": 9.1\r\n }\r\n ]\r\n }\r\n ],\r\n \"TotalCostExclTax\": 3.1,\r\n \"TotalCost\": 4.1,\r\n \"SourceID\": \"sample string 5\",\r\n \"VATNumber\": \"sample string 6\"\r\n },\r\n \"Payment\": {\r\n \"PaymentMethodName\": \"sample string 1\",\r\n \"AmountPaid\": 2.1\r\n }\r\n}"},"url":"https://{{Host}}/api/Basket/CancelEarnPoint","description":"

\r\n Revert points\r\n \n

Body Payload

Name	Type	Description	Required
BasketPointInput Description
Basket	Basket	The basket	False
CustomerID	Int32	The ID of the customer (CtcID)	False
Description	String	Description of the transaction	False
Payment	BasketPayment	The payment method used to earn point	False
Basket Description
Name	Type	Description	Required
BasketItems	List<BasketItem>	The list of basket details	False
LocationID	String	the ID of the site	False
OrderDate	DateTime (nullable)	The Date of order	False
OrderID	Int32	The order ID	False
SourceID	String	The source of the basket	False
TotalCost	Double	The total amount	False
TotalCostExclTax	Double	The total amount without VAT	False
VATNumber	String	VAT ID	False
BasketItem Description
Name	Type	Description	Required
CustomerID	Int32	The ID of the customer (CtcID).It should be empty when the order is linked to one customer	False
DiscountAmount	Double	The discount amount	False
ItemID	Int32	the Unique identifier of the basket item	False
ModifierItems	List<BasketModifiersItem>	The list of modifiers	False
Name	String	The name of the product	False
PointsDiscount	Double	The points to be burnt	False
ProductCode	String	The code of the product	False
Quantity	Double	Quantity	False
TotalAmount	Double	The amount paid (will be used to calculate the number of points earnt)	False
TotalAmountExclTax	Double	The total amount of the basket item without VAT	False
UnitPrice	Double	The unit price of the product	False
BasketModifiersItem Description
Name	Type	Description	Required
DiscountAmount	Double	The discount amount	False
ItemID	Int32	the Unique identifier of the basket item	False
Name	String	The name of the product	False
PointsDiscount	Double	The points to be burnt	False
ProductCode	String	The code of the product	False
Quantity	Double	Quantity	False
TotalAmount	Double	The amount paid (will be used to calculate the number of points earnt)	False
TotalAmountExclTax	Double	The total amount of the basket item witout VAT	False
UnitPrice	Double	The unit price of the product	False
BasketPayment Description
Name	Type	Description	Required
AmountPaid	Double	Amount paid	False
PaymentMethodName	String	The Payment method name	False

Response Payload

Name	Type	Description
BasketPointOutput Description
CashBalance	Double	The cash balance of the customer
CustomerID	Int32	The ID of the customer (CtcID)
Error	List<String>	The list of errors description
PointBalance	Double	The point balance of the customer
Response	Boolean	The status of the call

\n confirm the redemtion of a voucher\n \n

Body Payload

Name	Type	Description	Required
BenefitRedemptionInput Description
CustomerID	Int32 (nullable)	The ID of the customer (CtcID)	False
RedemptionID	String	The ID of the redemption to confirm	False

Response Payload

Name	Type	Description
BenefitRedemptionOutput Description
Error	List<String>	The list of errors description
Response	Boolean	The status of the call

","urlObject":{"protocol":"https","path":["api","Basket","ConfirmRedeemBenefit"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"c4c236c1-ddb0-4554-8539-cafedcb1824a","name":"api/Basket/ConfirmRedeemBenefit Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"RedemptionID\": \"sample string 1\",\r\n \"CustomerID\": 1\r\n}"},"url":"https://{{Host}}/api/Basket/ConfirmRedeemBenefit","description":"

\r\n confirm the redemtion of a voucher\r\n \n

Body Payload

Name	Type	Description	Required
BenefitRedemptionInput Description
CustomerID	Int32 (nullable)	The ID of the customer (CtcID)	False
RedemptionID	String	The ID of the redemption to confirm	False

Response Payload

Name	Type	Description
BenefitRedemptionOutput Description
Error	List<String>	The list of errors description
Response	Boolean	The status of the call

"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"Response\": true,\r\n \"Error\": [\r\n \"sample string 1\",\r\n \"sample string 2\"\r\n ]\r\n}"}],"_postman_id":"49dddb1a-0bc1-4d25-8ecb-d08965bf0767"},{"name":"Earn","id":"a4064195-3a95-4630-a531-7db6d2fcea51","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"CustomerID\": 1,\r\n \"Description\": \"sample string 2\",\r\n \"Basket\": {\r\n \"OrderID\": 1,\r\n \"LocationID\": \"sample string 2\",\r\n \"OrderDate\": \"2026-03-25T07:30:07.5735376+00:00\",\r\n \"BasketItems\": [\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"DiscountAmount\": 6.1,\r\n \"PointsDiscount\": 7.1,\r\n \"TotalAmountExclTax\": 8.1,\r\n \"TotalAmount\": 9.1,\r\n \"CustomerID\": 10,\r\n \"ModifierItems\": [\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"TotalAmountExclTax\": 6.1,\r\n \"TotalAmount\": 7.1,\r\n \"DiscountAmount\": 8.1,\r\n \"PointsDiscount\": 9.1\r\n },\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"TotalAmountExclTax\": 6.1,\r\n \"TotalAmount\": 7.1,\r\n \"DiscountAmount\": 8.1,\r\n \"PointsDiscount\": 9.1\r\n }\r\n ]\r\n },\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"DiscountAmount\": 6.1,\r\n \"PointsDiscount\": 7.1,\r\n \"TotalAmountExclTax\": 8.1,\r\n \"TotalAmount\": 9.1,\r\n \"CustomerID\": 10,\r\n \"ModifierItems\": [\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"TotalAmountExclTax\": 6.1,\r\n \"TotalAmount\": 7.1,\r\n \"DiscountAmount\": 8.1,\r\n \"PointsDiscount\": 9.1\r\n },\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"TotalAmountExclTax\": 6.1,\r\n \"TotalAmount\": 7.1,\r\n \"DiscountAmount\": 8.1,\r\n \"PointsDiscount\": 9.1\r\n }\r\n ]\r\n }\r\n ],\r\n \"TotalCostExclTax\": 3.1,\r\n \"TotalCost\": 4.1,\r\n \"SourceID\": \"sample string 5\",\r\n \"VATNumber\": \"sample string 6\"\r\n },\r\n \"Payment\": {\r\n \"PaymentMethodName\": \"sample string 1\",\r\n \"AmountPaid\": 2.1\r\n }\r\n}"},"url":"https://{{Host}}/api/Basket/Earn","description":"

\n Earn points\n \n

Body Payload

Name	Type	Description	Required
BasketPointInput Description
Basket	Basket	The basket	False
CustomerID	Int32	The ID of the customer (CtcID)	False
Description	String	Description of the transaction	False
Payment	BasketPayment	The payment method used to earn point	False
Basket Description
Name	Type	Description	Required
BasketItems	List<BasketItem>	The list of basket details	False
LocationID	String	the ID of the site	False
OrderDate	DateTime (nullable)	The Date of order	False
OrderID	Int32	The order ID	False
SourceID	String	The source of the basket	False
TotalCost	Double	The total amount	False
TotalCostExclTax	Double	The total amount without VAT	False
VATNumber	String	VAT ID	False
BasketItem Description
Name	Type	Description	Required
CustomerID	Int32	The ID of the customer (CtcID).It should be empty when the order is linked to one customer	False
DiscountAmount	Double	The discount amount	False
ItemID	Int32	the Unique identifier of the basket item	False
ModifierItems	List<BasketModifiersItem>	The list of modifiers	False
Name	String	The name of the product	False
PointsDiscount	Double	The points to be burnt	False
ProductCode	String	The code of the product	False
Quantity	Double	Quantity	False
TotalAmount	Double	The amount paid (will be used to calculate the number of points earnt)	False
TotalAmountExclTax	Double	The total amount of the basket item without VAT	False
UnitPrice	Double	The unit price of the product	False
BasketModifiersItem Description
Name	Type	Description	Required
DiscountAmount	Double	The discount amount	False
ItemID	Int32	the Unique identifier of the basket item	False
Name	String	The name of the product	False
PointsDiscount	Double	The points to be burnt	False
ProductCode	String	The code of the product	False
Quantity	Double	Quantity	False
TotalAmount	Double	The amount paid (will be used to calculate the number of points earnt)	False
TotalAmountExclTax	Double	The total amount of the basket item witout VAT	False
UnitPrice	Double	The unit price of the product	False
BasketPayment Description
Name	Type	Description	Required
AmountPaid	Double	Amount paid	False
PaymentMethodName	String	The Payment method name	False

Response Payload

Name	Type	Description
BasketPointOutput Description
CashBalance	Double	The cash balance of the customer
CustomerID	Int32	The ID of the customer (CtcID)
Error	List<String>	The list of errors description
PointBalance	Double	The point balance of the customer
Response	Boolean	The status of the call

","urlObject":{"protocol":"https","path":["api","Basket","Earn"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"f9d51dbc-4424-43a9-b367-63a84591bce8","name":"api/Basket/Earn Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"CustomerID\": 1,\r\n \"Description\": \"sample string 2\",\r\n \"Basket\": {\r\n \"OrderID\": 1,\r\n \"LocationID\": \"sample string 2\",\r\n \"OrderDate\": \"2026-03-25T07:30:07.5735376+00:00\",\r\n \"BasketItems\": [\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"DiscountAmount\": 6.1,\r\n \"PointsDiscount\": 7.1,\r\n \"TotalAmountExclTax\": 8.1,\r\n \"TotalAmount\": 9.1,\r\n \"CustomerID\": 10,\r\n \"ModifierItems\": [\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"TotalAmountExclTax\": 6.1,\r\n \"TotalAmount\": 7.1,\r\n \"DiscountAmount\": 8.1,\r\n \"PointsDiscount\": 9.1\r\n },\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"TotalAmountExclTax\": 6.1,\r\n \"TotalAmount\": 7.1,\r\n \"DiscountAmount\": 8.1,\r\n \"PointsDiscount\": 9.1\r\n }\r\n ]\r\n },\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"DiscountAmount\": 6.1,\r\n \"PointsDiscount\": 7.1,\r\n \"TotalAmountExclTax\": 8.1,\r\n \"TotalAmount\": 9.1,\r\n \"CustomerID\": 10,\r\n \"ModifierItems\": [\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"TotalAmountExclTax\": 6.1,\r\n \"TotalAmount\": 7.1,\r\n \"DiscountAmount\": 8.1,\r\n \"PointsDiscount\": 9.1\r\n },\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"TotalAmountExclTax\": 6.1,\r\n \"TotalAmount\": 7.1,\r\n \"DiscountAmount\": 8.1,\r\n \"PointsDiscount\": 9.1\r\n }\r\n ]\r\n }\r\n ],\r\n \"TotalCostExclTax\": 3.1,\r\n \"TotalCost\": 4.1,\r\n \"SourceID\": \"sample string 5\",\r\n \"VATNumber\": \"sample string 6\"\r\n },\r\n \"Payment\": {\r\n \"PaymentMethodName\": \"sample string 1\",\r\n \"AmountPaid\": 2.1\r\n }\r\n}"},"url":"https://{{Host}}/api/Basket/Earn","description":"

\r\n Earn points\r\n \n

Body Payload

Name	Type	Description	Required
BasketPointInput Description
Basket	Basket	The basket	False
CustomerID	Int32	The ID of the customer (CtcID)	False
Description	String	Description of the transaction	False
Payment	BasketPayment	The payment method used to earn point	False
Basket Description
Name	Type	Description	Required
BasketItems	List<BasketItem>	The list of basket details	False
LocationID	String	the ID of the site	False
OrderDate	DateTime (nullable)	The Date of order	False
OrderID	Int32	The order ID	False
SourceID	String	The source of the basket	False
TotalCost	Double	The total amount	False
TotalCostExclTax	Double	The total amount without VAT	False
VATNumber	String	VAT ID	False
BasketItem Description
Name	Type	Description	Required
CustomerID	Int32	The ID of the customer (CtcID).It should be empty when the order is linked to one customer	False
DiscountAmount	Double	The discount amount	False
ItemID	Int32	the Unique identifier of the basket item	False
ModifierItems	List<BasketModifiersItem>	The list of modifiers	False
Name	String	The name of the product	False
PointsDiscount	Double	The points to be burnt	False
ProductCode	String	The code of the product	False
Quantity	Double	Quantity	False
TotalAmount	Double	The amount paid (will be used to calculate the number of points earnt)	False
TotalAmountExclTax	Double	The total amount of the basket item without VAT	False
UnitPrice	Double	The unit price of the product	False
BasketModifiersItem Description
Name	Type	Description	Required
DiscountAmount	Double	The discount amount	False
ItemID	Int32	the Unique identifier of the basket item	False
Name	String	The name of the product	False
PointsDiscount	Double	The points to be burnt	False
ProductCode	String	The code of the product	False
Quantity	Double	Quantity	False
TotalAmount	Double	The amount paid (will be used to calculate the number of points earnt)	False
TotalAmountExclTax	Double	The total amount of the basket item witout VAT	False
UnitPrice	Double	The unit price of the product	False
BasketPayment Description
Name	Type	Description	Required
AmountPaid	Double	Amount paid	False
PaymentMethodName	String	The Payment method name	False

Response Payload

Name	Type	Description
BasketPointOutput Description
CashBalance	Double	The cash balance of the customer
CustomerID	Int32	The ID of the customer (CtcID)
Error	List<String>	The list of errors description
PointBalance	Double	The point balance of the customer
Response	Boolean	The status of the call

"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"CustomerID\": 1,\r\n \"PointBalance\": 2.1,\r\n \"CashBalance\": 3.1,\r\n \"Response\": true,\r\n \"Error\": [\r\n \"sample string 1\",\r\n \"sample string 2\"\r\n ]\r\n}"}],"_postman_id":"a4064195-3a95-4630-a531-7db6d2fcea51"},{"name":"RedeemBenefit","id":"0a10c22d-0ca5-494e-83a5-8a9cb0d5fc07","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"CustomerID\": 1,\r\n \"Basket\": {\r\n \"OrderID\": 1,\r\n \"LocationID\": \"sample string 2\",\r\n \"OrderDate\": \"2026-03-25T07:30:07.5735376+00:00\",\r\n \"BasketItems\": [\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"DiscountAmount\": 6.1,\r\n \"PointsDiscount\": 7.1,\r\n \"TotalAmountExclTax\": 8.1,\r\n \"TotalAmount\": 9.1,\r\n \"CustomerID\": 10,\r\n \"ModifierItems\": [\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"TotalAmountExclTax\": 6.1,\r\n \"TotalAmount\": 7.1,\r\n \"DiscountAmount\": 8.1,\r\n \"PointsDiscount\": 9.1\r\n },\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"TotalAmountExclTax\": 6.1,\r\n \"TotalAmount\": 7.1,\r\n \"DiscountAmount\": 8.1,\r\n \"PointsDiscount\": 9.1\r\n }\r\n ]\r\n },\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"DiscountAmount\": 6.1,\r\n \"PointsDiscount\": 7.1,\r\n \"TotalAmountExclTax\": 8.1,\r\n \"TotalAmount\": 9.1,\r\n \"CustomerID\": 10,\r\n \"ModifierItems\": [\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"TotalAmountExclTax\": 6.1,\r\n \"TotalAmount\": 7.1,\r\n \"DiscountAmount\": 8.1,\r\n \"PointsDiscount\": 9.1\r\n },\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"TotalAmountExclTax\": 6.1,\r\n \"TotalAmount\": 7.1,\r\n \"DiscountAmount\": 8.1,\r\n \"PointsDiscount\": 9.1\r\n }\r\n ]\r\n }\r\n ],\r\n \"TotalCostExclTax\": 3.1,\r\n \"TotalCost\": 4.1,\r\n \"SourceID\": \"sample string 5\",\r\n \"VATNumber\": \"sample string 6\"\r\n },\r\n \"VoucherCode\": \"sample string 2\",\r\n \"redemptionType\": 1\r\n}"},"url":"https://{{Host}}/api/Basket/RedeemBenefit","description":"

\n This method allows to retrieve discount amount if the voucher is eligible to be redeemed in this basket.\n \n

Body Payload

Name	Type	Description	Required
RedemptionValidationInput Description
Basket	Basket	The basket	False
CustomerID	Int32	The ID of the customer (CtcID)	False
redemptionType	RedemptionType (nullable)	The redemption type of the voucher	False
VoucherCode	String	The voucher code to be redeemed	False
Basket Description
Name	Type	Description	Required
BasketItems	List<BasketItem>	The list of basket details	False
LocationID	String	the ID of the site	False
OrderDate	DateTime (nullable)	The Date of order	False
OrderID	Int32	The order ID	False
SourceID	String	The source of the basket	False
TotalCost	Double	The total amount	False
TotalCostExclTax	Double	The total amount without VAT	False
VATNumber	String	VAT ID	False
BasketItem Description
Name	Type	Description	Required
CustomerID	Int32	The ID of the customer (CtcID).It should be empty when the order is linked to one customer	False
DiscountAmount	Double	The discount amount	False
ItemID	Int32	the Unique identifier of the basket item	False
ModifierItems	List<BasketModifiersItem>	The list of modifiers	False
Name	String	The name of the product	False
PointsDiscount	Double	The points to be burnt	False
ProductCode	String	The code of the product	False
Quantity	Double	Quantity	False
TotalAmount	Double	The amount paid (will be used to calculate the number of points earnt)	False
TotalAmountExclTax	Double	The total amount of the basket item without VAT	False
UnitPrice	Double	The unit price of the product	False
BasketModifiersItem Description
Name	Type	Description	Required
DiscountAmount	Double	The discount amount	False
ItemID	Int32	the Unique identifier of the basket item	False
Name	String	The name of the product	False
PointsDiscount	Double	The points to be burnt	False
ProductCode	String	The code of the product	False
Quantity	Double	Quantity	False
TotalAmount	Double	The amount paid (will be used to calculate the number of points earnt)	False
TotalAmountExclTax	Double	The total amount of the basket item witout VAT	False
UnitPrice	Double	The unit price of the product	False

Response Payload

Name	Type	Description
RedemptionValidationOutput Description
DiscountItem	BasketDiscountItem	The discount details
Error	List<String>	The list of errors description
Response	Boolean	The status of the call
BasketDiscountItem Description
Name	Type	Description
DiscountAmount	Double	The amount of the discount related to this item
RedemptionID	String	The unique identifier of the redemption
VoucherCode	String	The benefit code used for this discount

","urlObject":{"protocol":"https","path":["api","Basket","RedeemBenefit"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"693b559d-d490-431f-9504-4af867cc841d","name":"api/Basket/RedeemBenefit Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"CustomerID\": 1,\r\n \"Basket\": {\r\n \"OrderID\": 1,\r\n \"LocationID\": \"sample string 2\",\r\n \"OrderDate\": \"2026-03-25T07:30:07.5735376+00:00\",\r\n \"BasketItems\": [\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"DiscountAmount\": 6.1,\r\n \"PointsDiscount\": 7.1,\r\n \"TotalAmountExclTax\": 8.1,\r\n \"TotalAmount\": 9.1,\r\n \"CustomerID\": 10,\r\n \"ModifierItems\": [\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"TotalAmountExclTax\": 6.1,\r\n \"TotalAmount\": 7.1,\r\n \"DiscountAmount\": 8.1,\r\n \"PointsDiscount\": 9.1\r\n },\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"TotalAmountExclTax\": 6.1,\r\n \"TotalAmount\": 7.1,\r\n \"DiscountAmount\": 8.1,\r\n \"PointsDiscount\": 9.1\r\n }\r\n ]\r\n },\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"DiscountAmount\": 6.1,\r\n \"PointsDiscount\": 7.1,\r\n \"TotalAmountExclTax\": 8.1,\r\n \"TotalAmount\": 9.1,\r\n \"CustomerID\": 10,\r\n \"ModifierItems\": [\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"TotalAmountExclTax\": 6.1,\r\n \"TotalAmount\": 7.1,\r\n \"DiscountAmount\": 8.1,\r\n \"PointsDiscount\": 9.1\r\n },\r\n {\r\n \"ItemID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"ProductCode\": \"sample string 3\",\r\n \"Quantity\": 4.1,\r\n \"UnitPrice\": 5.1,\r\n \"TotalAmountExclTax\": 6.1,\r\n \"TotalAmount\": 7.1,\r\n \"DiscountAmount\": 8.1,\r\n \"PointsDiscount\": 9.1\r\n }\r\n ]\r\n }\r\n ],\r\n \"TotalCostExclTax\": 3.1,\r\n \"TotalCost\": 4.1,\r\n \"SourceID\": \"sample string 5\",\r\n \"VATNumber\": \"sample string 6\"\r\n },\r\n \"VoucherCode\": \"sample string 2\",\r\n \"redemptionType\": 1\r\n}"},"url":"https://{{Host}}/api/Basket/RedeemBenefit","description":"

\r\n This method allows to retrieve discount amount if the voucher is eligible to be redeemed in this basket.\r\n \n

Body Payload

Name	Type	Description	Required
RedemptionValidationInput Description
Basket	Basket	The basket	False
CustomerID	Int32	The ID of the customer (CtcID)	False
redemptionType	RedemptionType (nullable)	The redemption type of the voucher	False
VoucherCode	String	The voucher code to be redeemed	False
Basket Description
Name	Type	Description	Required
BasketItems	List<BasketItem>	The list of basket details	False
LocationID	String	the ID of the site	False
OrderDate	DateTime (nullable)	The Date of order	False
OrderID	Int32	The order ID	False
SourceID	String	The source of the basket	False
TotalCost	Double	The total amount	False
TotalCostExclTax	Double	The total amount without VAT	False
VATNumber	String	VAT ID	False
BasketItem Description
Name	Type	Description	Required
CustomerID	Int32	The ID of the customer (CtcID).It should be empty when the order is linked to one customer	False
DiscountAmount	Double	The discount amount	False
ItemID	Int32	the Unique identifier of the basket item	False
ModifierItems	List<BasketModifiersItem>	The list of modifiers	False
Name	String	The name of the product	False
PointsDiscount	Double	The points to be burnt	False
ProductCode	String	The code of the product	False
Quantity	Double	Quantity	False
TotalAmount	Double	The amount paid (will be used to calculate the number of points earnt)	False
TotalAmountExclTax	Double	The total amount of the basket item without VAT	False
UnitPrice	Double	The unit price of the product	False
BasketModifiersItem Description
Name	Type	Description	Required
DiscountAmount	Double	The discount amount	False
ItemID	Int32	the Unique identifier of the basket item	False
Name	String	The name of the product	False
PointsDiscount	Double	The points to be burnt	False
ProductCode	String	The code of the product	False
Quantity	Double	Quantity	False
TotalAmount	Double	The amount paid (will be used to calculate the number of points earnt)	False
TotalAmountExclTax	Double	The total amount of the basket item witout VAT	False
UnitPrice	Double	The unit price of the product	False

Response Payload

Name	Type	Description
RedemptionValidationOutput Description
DiscountItem	BasketDiscountItem	The discount details
Error	List<String>	The list of errors description
Response	Boolean	The status of the call
BasketDiscountItem Description
Name	Type	Description
DiscountAmount	Double	The amount of the discount related to this item
RedemptionID	String	The unique identifier of the redemption
VoucherCode	String	The benefit code used for this discount

\n Cancel the redemption of a voucher\n \n

Body Payload

Name	Type	Description	Required
BenefitRedemptionInput Description
CustomerID	Int32 (nullable)	The ID of the customer (CtcID)	False
RedemptionID	String	The ID of the redemption to confirm	False

Response Payload

Name	Type	Description
BenefitRedemptionOutput Description
Error	List<String>	The list of errors description
Response	Boolean	The status of the call

","urlObject":{"protocol":"https","path":["api","Basket","RevertBenefitRedemption"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"a28d2d53-ee58-43db-9094-d3377f17cb34","name":"api/Basket/RevertBenefitRedemption Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"RedemptionID\": \"sample string 1\",\r\n \"CustomerID\": 1\r\n}"},"url":"https://{{Host}}/api/Basket/RevertBenefitRedemption","description":"

\r\n Cancel the redemption of a voucher\r\n \n

Body Payload

Name	Type	Description	Required
BenefitRedemptionInput Description
CustomerID	Int32 (nullable)	The ID of the customer (CtcID)	False
RedemptionID	String	The ID of the redemption to confirm	False

Response Payload

Name	Type	Description
BenefitRedemptionOutput Description
Error	List<String>	The list of errors description
Response	Boolean	The status of the call

Api Methods for Basket

\n","_postman_id":"175e26bc-b502-40d7-abbe-8567bef5be20"},{"name":"BIDWHouse","item":[{"name":"GetBookingsFact","id":"9d869517-68b7-45f2-9fd3-507aa376fde8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"https://{{Host}}/api/BIDWHouse/GetBookingsFact?PageSize=PageSize-value&resetStartProcessDate=resetStartProcessDate-value","description":"

\n Getting records from BookingsFact table.\n \n

Response Payload

Name	Type	Description
BookingsFactOutput Description
BookingsFact	List<BookingsFact>	List of objects indicating a booking details.
Errors	List<String>	The List of errors if exist.
Response	Boolean	The call success status.
BookingsFact Description
Name	Type	Description
BookingDateTime	DateTime (nullable)	The date of the Booking.
BookingID	String	The unique ID for the booking in Atreemo and used to join the various tables.
BookingsFactID	Int32	Incremental unique ID.
BrandName	String	The brand name (multibrand instances).
Covers	Int32	The booking's covers number.
CtcID	Int32	The unique ID for the contact in Atreemo and used to join the various tables.
EstimatedValue	Decimal	The booking's estimated value .
ModifiedDate	DateTime	The last modification date for the booking.
SiteID	Int32	The location ID where the booking is made .
SiteName	String	The location name where the booking is made .
Source	String	The booking's source.
Status	String	The bookings' Atreemo status
StatusID	Int32	The bookings' Atreemo status ID
VistDateTime	DateTime (nullable)	The visit date of the booking.

","urlObject":{"protocol":"https","path":["api","BIDWHouse","GetBookingsFact"],"host":["{{Host}}"],"query":[{"key":"PageSize","value":"PageSize-value"},{"key":"resetStartProcessDate","value":"resetStartProcessDate-value"}],"variable":[]}},"response":[{"id":"be7575e4-9347-4f15-b3f7-a90a53d8a0df","name":"api/BIDWHouse/GetBookingsFact?PageSize={PageSize}&resetStartProcessDate={resetStartProcessDate} Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":{"raw":"https://{{Host}}/api/BIDWHouse/GetBookingsFact?PageSize=PageSize-value&resetStartProcessDate=resetStartProcessDate-value","protocol":"https","host":["{{Host}}"],"path":["api","BIDWHouse","GetBookingsFact"],"query":[{"key":"PageSize","value":"PageSize-value"},{"key":"resetStartProcessDate","value":"resetStartProcessDate-value"}]},"description":"

\r\n Getting records from BookingsFact table.\r\n \n

Response Payload

Name	Type	Description
BookingsFactOutput Description
BookingsFact	List<BookingsFact>	List of objects indicating a booking details.
Errors	List<String>	The List of errors if exist.
Response	Boolean	The call success status.
BookingsFact Description
Name	Type	Description
BookingDateTime	DateTime (nullable)	The date of the Booking.
BookingID	String	The unique ID for the booking in Atreemo and used to join the various tables.
BookingsFactID	Int32	Incremental unique ID.
BrandName	String	The brand name (multibrand instances).
Covers	Int32	The booking's covers number.
CtcID	Int32	The unique ID for the contact in Atreemo and used to join the various tables.
EstimatedValue	Decimal	The booking's estimated value .
ModifiedDate	DateTime	The last modification date for the booking.
SiteID	Int32	The location ID where the booking is made .
SiteName	String	The location name where the booking is made .
Source	String	The booking's source.
Status	String	The bookings' Atreemo status
StatusID	Int32	The bookings' Atreemo status ID
VistDateTime	DateTime (nullable)	The visit date of the booking.

"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"Response\": true,\r\n \"BookingsFact\": [\r\n {\r\n \"BookingsFactID\": 1,\r\n \"BookingID\": \"sample string 2\",\r\n \"CtcID\": 3,\r\n \"BookingDateTime\": \"2026-03-25T07:30:07.5891689+00:00\",\r\n \"VistDateTime\": \"2026-03-25T07:30:07.5891689+00:00\",\r\n \"StatusID\": 4,\r\n \"Status\": \"sample string 5\",\r\n \"Source\": \"sample string 6\",\r\n \"EstimatedValue\": 7.0,\r\n \"SiteID\": 8,\r\n \"SiteName\": \"sample string 9\",\r\n \"Covers\": 10,\r\n \"ModifiedDate\": \"2026-03-25T07:30:07.5891689+00:00\",\r\n \"BrandName\": \"sample string 12\"\r\n },\r\n {\r\n \"BookingsFactID\": 1,\r\n \"BookingID\": \"sample string 2\",\r\n \"CtcID\": 3,\r\n \"BookingDateTime\": \"2026-03-25T07:30:07.5891689+00:00\",\r\n \"VistDateTime\": \"2026-03-25T07:30:07.5891689+00:00\",\r\n \"StatusID\": 4,\r\n \"Status\": \"sample string 5\",\r\n \"Source\": \"sample string 6\",\r\n \"EstimatedValue\": 7.0,\r\n \"SiteID\": 8,\r\n \"SiteName\": \"sample string 9\",\r\n \"Covers\": 10,\r\n \"ModifiedDate\": \"2026-03-25T07:30:07.5891689+00:00\",\r\n \"BrandName\": \"sample string 12\"\r\n }\r\n ],\r\n \"Errors\": [\r\n \"sample string 1\",\r\n \"sample string 2\"\r\n ]\r\n}"}],"_postman_id":"9d869517-68b7-45f2-9fd3-507aa376fde8"},{"name":"GetContactDetailsFact","id":"bc55d6fe-bc70-49cf-b1e2-b36e2c43ce85","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"https://{{Host}}/api/BIDWHouse/GetContactDetailsFact?PageSize=PageSize-value&resetStartProcessDate=resetStartProcessDate-value","description":"

\n Getting records from ContactDetailsFact table.\n \n

Response Payload

Name	Type	Description
ContactDetailsFactOutput Description
ContactDetailsFacts	List<ContactDetailsFact>	List of objects indicating a contact details.
Errors	List<String>	The List of errors if exist.
Response	Boolean	The call success status.
ContactDetailsFact Description
Name	Type	Description
BirthdateMonth	Int32	The month of birth for the contact.
BirthDateYear	Int32	The year of birth for the contact.
ContactDetailsFactID	Int32	Incremental unique ID.
CorporateName	String	The company name linked or assigned to the contact based on the configuration in Atreemo.
CreateDate	DateTime	The date the contact was created. Where this was not known as part \n of the initial data import the date of the import is used.
CtcID	Int32	The unique ID for the contact in Atreemo and used to join the various tables.
Deleted	Boolean	True if the contact is deleted.
FavouriteSite	String	The contact favourite location name.
FavouriteSiteID	Int64	The date the contact was created. Where this was not known as part of the initial data import the date of the import is used.
Frequency	Int32	Visit Frequency of the contact.
Gender	String	The contacts assigned gender.
IsStaff	Boolean	True if the contact is a staff.
ModifiedDate	DateTime	The last modification date for the contact.
Monetary	Int32	The Monetary of the contact.
ParentCtcID	Int32	Parent CtcID if the contact is merged
PointBalance	Single	The contact point balance.
PostCodeSector	String	The postcode sector for the contact.
Recency	Int32	The Recency of the contact.
Segment	String	The Segment of the contact.
SourceID	String	The original source for the contact, for example wifi.
TiersName	String	The tier name linked or assigned to the contact based on the configuration in Atreemo.

","urlObject":{"protocol":"https","path":["api","BIDWHouse","GetContactDetailsFact"],"host":["{{Host}}"],"query":[{"key":"PageSize","value":"PageSize-value"},{"key":"resetStartProcessDate","value":"resetStartProcessDate-value"}],"variable":[]}},"response":[{"id":"92b84e5a-0a74-4775-b41c-3b714a332095","name":"api/BIDWHouse/GetContactDetailsFact?PageSize={PageSize}&resetStartProcessDate={resetStartProcessDate} Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":{"raw":"https://{{Host}}/api/BIDWHouse/GetContactDetailsFact?PageSize=PageSize-value&resetStartProcessDate=resetStartProcessDate-value","protocol":"https","host":["{{Host}}"],"path":["api","BIDWHouse","GetContactDetailsFact"],"query":[{"key":"PageSize","value":"PageSize-value"},{"key":"resetStartProcessDate","value":"resetStartProcessDate-value"}]},"description":"

\r\n Getting records from ContactDetailsFact table.\r\n \n

Response Payload

Name	Type	Description
ContactDetailsFactOutput Description
ContactDetailsFacts	List<ContactDetailsFact>	List of objects indicating a contact details.
Errors	List<String>	The List of errors if exist.
Response	Boolean	The call success status.
ContactDetailsFact Description
Name	Type	Description
BirthdateMonth	Int32	The month of birth for the contact.
BirthDateYear	Int32	The year of birth for the contact.
ContactDetailsFactID	Int32	Incremental unique ID.
CorporateName	String	The company name linked or assigned to the contact based on the configuration in Atreemo.
CreateDate	DateTime	The date the contact was created. Where this was not known as part \n of the initial data import the date of the import is used.
CtcID	Int32	The unique ID for the contact in Atreemo and used to join the various tables.
Deleted	Boolean	True if the contact is deleted.
FavouriteSite	String	The contact favourite location name.
FavouriteSiteID	Int64	The date the contact was created. Where this was not known as part of the initial data import the date of the import is used.
Frequency	Int32	Visit Frequency of the contact.
Gender	String	The contacts assigned gender.
IsStaff	Boolean	True if the contact is a staff.
ModifiedDate	DateTime	The last modification date for the contact.
Monetary	Int32	The Monetary of the contact.
ParentCtcID	Int32	Parent CtcID if the contact is merged
PointBalance	Single	The contact point balance.
PostCodeSector	String	The postcode sector for the contact.
Recency	Int32	The Recency of the contact.
Segment	String	The Segment of the contact.
SourceID	String	The original source for the contact, for example wifi.
TiersName	String	The tier name linked or assigned to the contact based on the configuration in Atreemo.

"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"Response\": true,\r\n \"ContactDetailsFacts\": [\r\n {\r\n \"ContactDetailsFactID\": 1,\r\n \"CtcID\": 2,\r\n \"Gender\": \"sample string 3\",\r\n \"BirthDateYear\": 4,\r\n \"BirthdateMonth\": 5,\r\n \"PostCodeSector\": \"sample string 6\",\r\n \"FavouriteSiteID\": 7,\r\n \"FavouriteSite\": \"sample string 8\",\r\n \"CreateDate\": \"2026-03-25T07:30:07.6204061+00:00\",\r\n \"SourceID\": \"sample string 10\",\r\n \"PointBalance\": 11.1,\r\n \"CorporateName\": \"sample string 12\",\r\n \"TiersName\": \"sample string 13\",\r\n \"Deleted\": true,\r\n \"ModifiedDate\": \"2026-03-25T07:30:07.6204061+00:00\",\r\n \"IsStaff\": true,\r\n \"ParentCtcID\": 17,\r\n \"Recency\": 18,\r\n \"Frequency\": 19,\r\n \"Monetary\": 20,\r\n \"Segment\": \"sample string 21\"\r\n },\r\n {\r\n \"ContactDetailsFactID\": 1,\r\n \"CtcID\": 2,\r\n \"Gender\": \"sample string 3\",\r\n \"BirthDateYear\": 4,\r\n \"BirthdateMonth\": 5,\r\n \"PostCodeSector\": \"sample string 6\",\r\n \"FavouriteSiteID\": 7,\r\n \"FavouriteSite\": \"sample string 8\",\r\n \"CreateDate\": \"2026-03-25T07:30:07.6204061+00:00\",\r\n \"SourceID\": \"sample string 10\",\r\n \"PointBalance\": 11.1,\r\n \"CorporateName\": \"sample string 12\",\r\n \"TiersName\": \"sample string 13\",\r\n \"Deleted\": true,\r\n \"ModifiedDate\": \"2026-03-25T07:30:07.6204061+00:00\",\r\n \"IsStaff\": true,\r\n \"ParentCtcID\": 17,\r\n \"Recency\": 18,\r\n \"Frequency\": 19,\r\n \"Monetary\": 20,\r\n \"Segment\": \"sample string 21\"\r\n }\r\n ],\r\n \"Errors\": [\r\n \"sample string 1\",\r\n \"sample string 2\"\r\n ]\r\n}"}],"_postman_id":"bc55d6fe-bc70-49cf-b1e2-b36e2c43ce85"},{"name":"GetContactPreferencesFact","id":"23a79078-b89b-4df7-bbf4-cd92c7a0ef95","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"https://{{Host}}/api/BIDWHouse/GetContactPreferencesFact?PageSize=PageSize-value&resetStartProcessDate=resetStartProcessDate-value","description":"

\n Getting records from ContactPreferencesFact table.\n \n

Response Payload

Name	Type	Description
ContactPreferencesFactOutput Description
ContactPreferencesFacts	List<ContactPreferencesFact>	List of objects indicating a contacts opt in status and preferences.
Errors	List<String>	The List of errors if exist.
Response	Boolean	The call success status.
ContactPreferencesFact Description
Name	Type	Description
BrandName	String	The brand name (multibrand instances)
ContactPreferencesFactID	Int32	Incremental unique ID.
CtcID	Int32	The unique ID for the contact in Atreemo and used to join the various tables.
EmailOptin	Boolean	True if the contact is opted in for email.
MailOptin	Boolean	True if the contact is opted in for direct mail.
ModifiedDate	DateTime	The last modification date.
PhoneOptin	Boolean	True if the contacts is opted in for phone.
Preferences	String	Preferences the contact has selected will be shown with a semi column\n as a separator.
PushOptin	Boolean	True if the contact is opted in for push notification.
SMSOptin	Boolean	True if the contact is opted in for SMS.
WebPushOptin	Boolean	True if the contacts is opted in for web push notification.

","urlObject":{"protocol":"https","path":["api","BIDWHouse","GetContactPreferencesFact"],"host":["{{Host}}"],"query":[{"key":"PageSize","value":"PageSize-value"},{"key":"resetStartProcessDate","value":"resetStartProcessDate-value"}],"variable":[]}},"response":[{"id":"0a581554-bd29-4827-b1f6-98b5bc214bdf","name":"api/BIDWHouse/GetContactPreferencesFact?PageSize={PageSize}&resetStartProcessDate={resetStartProcessDate} Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":{"raw":"https://{{Host}}/api/BIDWHouse/GetContactPreferencesFact?PageSize=PageSize-value&resetStartProcessDate=resetStartProcessDate-value","protocol":"https","host":["{{Host}}"],"path":["api","BIDWHouse","GetContactPreferencesFact"],"query":[{"key":"PageSize","value":"PageSize-value"},{"key":"resetStartProcessDate","value":"resetStartProcessDate-value"}]},"description":"

\r\n Getting records from ContactPreferencesFact table.\r\n \n

Response Payload

Name	Type	Description
ContactPreferencesFactOutput Description
ContactPreferencesFacts	List<ContactPreferencesFact>	List of objects indicating a contacts opt in status and preferences.
Errors	List<String>	The List of errors if exist.
Response	Boolean	The call success status.
ContactPreferencesFact Description
Name	Type	Description
BrandName	String	The brand name (multibrand instances)
ContactPreferencesFactID	Int32	Incremental unique ID.
CtcID	Int32	The unique ID for the contact in Atreemo and used to join the various tables.
EmailOptin	Boolean	True if the contact is opted in for email.
MailOptin	Boolean	True if the contact is opted in for direct mail.
ModifiedDate	DateTime	The last modification date.
PhoneOptin	Boolean	True if the contacts is opted in for phone.
Preferences	String	Preferences the contact has selected will be shown with a semi column\n as a separator.
PushOptin	Boolean	True if the contact is opted in for push notification.
SMSOptin	Boolean	True if the contact is opted in for SMS.
WebPushOptin	Boolean	True if the contacts is opted in for web push notification.

\n Getting records from FactContactsAvailability table.\n \n

Response Payload

Name	Type	Description
ContactAvailabilityFactOutput Description
ContactAvailabilityFacts	List<ContactAvailabilityFact>	List of objects indicating a contact availability.
Errors	List<String>	The List of errors if exist.
Response	Boolean	The call success status.
ContactAvailabilityFact Description
Name	Type	Description
AppAvailable	Boolean	True if the contact can receive app notifications.
ContactAvailabilityFactID	Int32	Incremental unique ID.
CtcID	Int32	The unique ID for the contact in Atreemo and used to join the various tables.
EmailAvailable	Boolean	True if the contact is available by email.
MailAvailable	Boolean	True if the contact can receive mails.
MobileAvailable	Boolean	True if the contact is available by mobile.
ModifiedDate	DateTime	The last modification date for the contact.
PhoneAvailable	Boolean	True if the contact is available by phone.
WebPushAvailable	Boolean	True if the contact can receive web push notifications.

","urlObject":{"protocol":"https","path":["api","BIDWHouse","GetContactsAvailabilityFact"],"host":["{{Host}}"],"query":[{"key":"PageSize","value":"PageSize-value"},{"key":"resetStartProcessDate","value":"resetStartProcessDate-value"}],"variable":[]}},"response":[{"id":"23084137-6a41-4033-8f44-4736225d9c80","name":"api/BIDWHouse/GetContactsAvailabilityFact?PageSize={PageSize}&resetStartProcessDate={resetStartProcessDate} Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":{"raw":"https://{{Host}}/api/BIDWHouse/GetContactsAvailabilityFact?PageSize=PageSize-value&resetStartProcessDate=resetStartProcessDate-value","protocol":"https","host":["{{Host}}"],"path":["api","BIDWHouse","GetContactsAvailabilityFact"],"query":[{"key":"PageSize","value":"PageSize-value"},{"key":"resetStartProcessDate","value":"resetStartProcessDate-value"}]},"description":"

\r\n Getting records from FactContactsAvailability table.\r\n \n

Response Payload

Name	Type	Description
ContactAvailabilityFactOutput Description
ContactAvailabilityFacts	List<ContactAvailabilityFact>	List of objects indicating a contact availability.
Errors	List<String>	The List of errors if exist.
Response	Boolean	The call success status.
ContactAvailabilityFact Description
Name	Type	Description
AppAvailable	Boolean	True if the contact can receive app notifications.
ContactAvailabilityFactID	Int32	Incremental unique ID.
CtcID	Int32	The unique ID for the contact in Atreemo and used to join the various tables.
EmailAvailable	Boolean	True if the contact is available by email.
MailAvailable	Boolean	True if the contact can receive mails.
MobileAvailable	Boolean	True if the contact is available by mobile.
ModifiedDate	DateTime	The last modification date for the contact.
PhoneAvailable	Boolean	True if the contact is available by phone.
WebPushAvailable	Boolean	True if the contact can receive web push notifications.

\n Getting records from ContactsMemberNumbersFact table.\n \n

Response Payload

Name	Type	Description
ContactsMemberNumbersFactOutput Description
ContactsMemberNumbersFacts	List<ContactsMemberNumbersFact>	The list of objects associated to Contacts Member Numbers.
Errors	List<String>	The list of errors if exist.
Response	Boolean	The call success status.
ContactsMemberNumbersFact Description
Name	Type	Description
CtcID	Int32	The unique contact ID .
FactContactsMemberNumberSK	Int32	Incremental unique ID.
HashedMemberNumber	String	The unique Hashed Member Number of the contact.
MemberNumber	String	The unique Member Number of the contact.
ModifiedDate	DateTime	The last modification date applied to this contact.

","urlObject":{"protocol":"https","path":["api","BIDWHouse","GetContactsMemberNumbersFact"],"host":["{{Host}}"],"query":[{"key":"PageSize","value":"PageSize-value"},{"key":"resetStartProcessDate","value":"resetStartProcessDate-value"}],"variable":[]}},"response":[{"id":"67cd0716-3916-4d62-bcf9-eba23803337b","name":"api/BIDWHouse/GetContactsMemberNumbersFact?PageSize={PageSize}&resetStartProcessDate={resetStartProcessDate} Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":{"raw":"https://{{Host}}/api/BIDWHouse/GetContactsMemberNumbersFact?PageSize=PageSize-value&resetStartProcessDate=resetStartProcessDate-value","protocol":"https","host":["{{Host}}"],"path":["api","BIDWHouse","GetContactsMemberNumbersFact"],"query":[{"key":"PageSize","value":"PageSize-value"},{"key":"resetStartProcessDate","value":"resetStartProcessDate-value"}]},"description":"

\r\n Getting records from ContactsMemberNumbersFact table.\r\n \n

Response Payload

Name	Type	Description
ContactsMemberNumbersFactOutput Description
ContactsMemberNumbersFacts	List<ContactsMemberNumbersFact>	The list of objects associated to Contacts Member Numbers.
Errors	List<String>	The list of errors if exist.
Response	Boolean	The call success status.
ContactsMemberNumbersFact Description
Name	Type	Description
CtcID	Int32	The unique contact ID .
FactContactsMemberNumberSK	Int32	Incremental unique ID.
HashedMemberNumber	String	The unique Hashed Member Number of the contact.
MemberNumber	String	The unique Member Number of the contact.
ModifiedDate	DateTime	The last modification date applied to this contact.

\n Getting records from ContactsSourcesFact table.\n \n

Response Payload

Name	Type	Description
ContactsSourcesFactOutput Description
ContactsSourcesFacts	List<ContactsSourcesFact>	List of objects indicating a contact source details.
Errors	List<String>	The List of errors if exist.
Response	Boolean	The call success status .
ContactsSourcesFact Description
Name	Type	Description
BrandName	String	The brand name (multibrand instances)
ContactsSourcesFactID	Int32	Incremental unique ID.
CtcID	Int32	The unique ID for the contact in Atreemo and used to join the various tables .
ModifiedDate	DateTime	The last modification date for the contact.
OriginID	String	The origin of the source.
SourceID	String	The source name.

","urlObject":{"protocol":"https","path":["api","BIDWHouse","GetContactSourcesFact"],"host":["{{Host}}"],"query":[{"key":"PageSize","value":"PageSize-value"},{"key":"resetStartProcessDate","value":"resetStartProcessDate-value"}],"variable":[]}},"response":[{"id":"97398ec6-308d-4999-8b16-f2967f1b7c23","name":"api/BIDWHouse/GetContactSourcesFact?PageSize={PageSize}&resetStartProcessDate={resetStartProcessDate} Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":{"raw":"https://{{Host}}/api/BIDWHouse/GetContactSourcesFact?PageSize=PageSize-value&resetStartProcessDate=resetStartProcessDate-value","protocol":"https","host":["{{Host}}"],"path":["api","BIDWHouse","GetContactSourcesFact"],"query":[{"key":"PageSize","value":"PageSize-value"},{"key":"resetStartProcessDate","value":"resetStartProcessDate-value"}]},"description":"

\r\n Getting records from ContactsSourcesFact table.\r\n \n

Response Payload

Name	Type	Description
ContactsSourcesFactOutput Description
ContactsSourcesFacts	List<ContactsSourcesFact>	List of objects indicating a contact source details.
Errors	List<String>	The List of errors if exist.
Response	Boolean	The call success status .
ContactsSourcesFact Description
Name	Type	Description
BrandName	String	The brand name (multibrand instances)
ContactsSourcesFactID	Int32	Incremental unique ID.
CtcID	Int32	The unique ID for the contact in Atreemo and used to join the various tables .
ModifiedDate	DateTime	The last modification date for the contact.
OriginID	String	The origin of the source.
SourceID	String	The source name.

\n Getting records from EmailTrendFact table.\n \n

Response Payload

Name	Type	Description
EmailTrendOutput Description
EmailTrendFacts	List<EmailTrendFact>	The list of objects indicating emails results for a contact.
Errors	List<String>	The List of errors if exist.
Response	Boolean	The call success status.
EmailTrendFact Description
Name	Type	Description
BookingsMadeIn14Days	Int32
BrandName	String	The brand name (multibrand instances).
Category	String	The campaign category name.
CategoryID	Int32	The campaign category unique ID.
CostPerItem	Single	The unit cost per item (if paid for per item).
CtcID	Int32	The unique ID for the contact in Atreemo \n and used to join the various tables.
DayOfWeekEmailOpened	Int32	The day of the week the email was opened.
DirectSpentWithoutOverlap	Single	The amount of direct spent without overlap
DomainName	String	The domain name linked to the customer.
EcastItemID	Int32	The Ecast ID
EmailTrendFactID	Int32	Incremental unique ID.
Error	Int16	The error if the email could not be delivered.
FirstTrial	DateTime (nullable)	The first date/time the email was sent.
IndirectSpentWithoutOverlap	Single	The amount of indirect spent without overlap
IsComplaint	Boolean	If a complaint was received from this email via the email service provider the response will be True.
IsFollowUp	Boolean	If the email was an automated follow up the response will be True.
LastTrial	DateTime (nullable)	The last date / time the email tried to send to the contact.
ModifiedDate	DateTime	The last modification date.
NbClicks	Int32	The total number of clicks the contact made for the email.
NbDeliv	Int32	The number of emails delivered
NbDispatched	Int32	The number of emails dispatched
NbSent	Int32	The number of emails sent
NbTrial	Int16	The number of times Atreemo tried to send the email.
NbViews	Int32	The total number of views made by the contact for the email.
OpCode	Int32	The unique ID for the email campaign.
OpenDate	DateTime (nullable)	The date / time the email was opened.
PrjMkgTitle	String	The internal name given to the campaign in Atreemo.
SendDate	DateTime	The date / time the email was scheduled to send.
SenderProfile	String	The Atreemo sender profile used for the email.
SenderProfileID	Int32	The Atreemo sender profile ID used for the email.
Status	Int16	The send status.Possible values : = 5\n Sent if value is greater than 5 the status is error.
Subject	String	The Email Subject.
SubmittedBy	String	The Atreemo user who submitted the campaign.
TimeOfDayEmailOpened	Int32	The time of day the email is opened.
UniqueClicks	Int32	The number of clicks
UniqueViews	Int32	The number of views
Unsubscribe	Int32	If response is 1 the contact unsubscribed.

","urlObject":{"protocol":"https","path":["api","BIDWHouse","GetEmailTrendFact"],"host":["{{Host}}"],"query":[{"key":"PageSize","value":"PageSize-value"},{"key":"resetStartProcessDate","value":"resetStartProcessDate-value"}],"variable":[]}},"response":[{"id":"6ec1029c-1c5f-45c8-9cc0-25f20712dc4a","name":"api/BIDWHouse/GetEmailTrendFact?PageSize={PageSize}&resetStartProcessDate={resetStartProcessDate} Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":{"raw":"https://{{Host}}/api/BIDWHouse/GetEmailTrendFact?PageSize=PageSize-value&resetStartProcessDate=resetStartProcessDate-value","protocol":"https","host":["{{Host}}"],"path":["api","BIDWHouse","GetEmailTrendFact"],"query":[{"key":"PageSize","value":"PageSize-value"},{"key":"resetStartProcessDate","value":"resetStartProcessDate-value"}]},"description":"

\r\n Getting records from EmailTrendFact table.\r\n \n

Response Payload

Name	Type	Description
EmailTrendOutput Description
EmailTrendFacts	List<EmailTrendFact>	The list of objects indicating emails results for a contact.
Errors	List<String>	The List of errors if exist.
Response	Boolean	The call success status.
EmailTrendFact Description
Name	Type	Description
BookingsMadeIn14Days	Int32
BrandName	String	The brand name (multibrand instances).
Category	String	The campaign category name.
CategoryID	Int32	The campaign category unique ID.
CostPerItem	Single	The unit cost per item (if paid for per item).
CtcID	Int32	The unique ID for the contact in Atreemo \n and used to join the various tables.
DayOfWeekEmailOpened	Int32	The day of the week the email was opened.
DirectSpentWithoutOverlap	Single	The amount of direct spent without overlap
DomainName	String	The domain name linked to the customer.
EcastItemID	Int32	The Ecast ID
EmailTrendFactID	Int32	Incremental unique ID.
Error	Int16	The error if the email could not be delivered.
FirstTrial	DateTime (nullable)	The first date/time the email was sent.
IndirectSpentWithoutOverlap	Single	The amount of indirect spent without overlap
IsComplaint	Boolean	If a complaint was received from this email via the email service provider the response will be True.
IsFollowUp	Boolean	If the email was an automated follow up the response will be True.
LastTrial	DateTime (nullable)	The last date / time the email tried to send to the contact.
ModifiedDate	DateTime	The last modification date.
NbClicks	Int32	The total number of clicks the contact made for the email.
NbDeliv	Int32	The number of emails delivered
NbDispatched	Int32	The number of emails dispatched
NbSent	Int32	The number of emails sent
NbTrial	Int16	The number of times Atreemo tried to send the email.
NbViews	Int32	The total number of views made by the contact for the email.
OpCode	Int32	The unique ID for the email campaign.
OpenDate	DateTime (nullable)	The date / time the email was opened.
PrjMkgTitle	String	The internal name given to the campaign in Atreemo.
SendDate	DateTime	The date / time the email was scheduled to send.
SenderProfile	String	The Atreemo sender profile used for the email.
SenderProfileID	Int32	The Atreemo sender profile ID used for the email.
Status	Int16	The send status.Possible values : = 5\n Sent if value is greater than 5 the status is error.
Subject	String	The Email Subject.
SubmittedBy	String	The Atreemo user who submitted the campaign.
TimeOfDayEmailOpened	Int32	The time of day the email is opened.
UniqueClicks	Int32	The number of clicks
UniqueViews	Int32	The number of views
Unsubscribe	Int32	If response is 1 the contact unsubscribed.

"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"Response\": true,\r\n \"EmailTrendFacts\": [\r\n {\r\n \"EmailTrendFactID\": 1,\r\n \"CtcID\": 2,\r\n \"OpCode\": 3,\r\n \"PrjMkgTitle\": \"sample string 4\",\r\n \"Subject\": \"sample string 5\",\r\n \"CategoryID\": 6,\r\n \"Category\": \"sample string 7\",\r\n \"SendDate\": \"2026-03-25T07:30:07.6836172+00:00\",\r\n \"OpenDate\": \"2026-03-25T07:30:07.6836172+00:00\",\r\n \"TimeOfDayEmailOpened\": 9,\r\n \"DayOfWeekEmailOpened\": 10,\r\n \"SubmittedBy\": \"sample string 11\",\r\n \"SenderProfileID\": 12,\r\n \"SenderProfile\": \"sample string 13\",\r\n \"BrandName\": \"sample string 14\",\r\n \"DomainName\": \"sample string 15\",\r\n \"IsFollowUp\": true,\r\n \"IsComplaint\": true,\r\n \"Status\": 18,\r\n \"Error\": 19,\r\n \"FirstTrial\": \"2026-03-25T07:30:07.6836172+00:00\",\r\n \"LastTrial\": \"2026-03-25T07:30:07.6836172+00:00\",\r\n \"NbTrial\": 20,\r\n \"NbClicks\": 21,\r\n \"NbViews\": 22,\r\n \"Unsubscribe\": 23,\r\n \"CostPerItem\": 24.1,\r\n \"ModifiedDate\": \"2026-03-25T07:30:07.6992273+00:00\",\r\n \"DirectSpentWithoutOverlap\": 26.1,\r\n \"IndirectSpentWithoutOverlap\": 27.1,\r\n \"NbSent\": 28,\r\n \"NbDeliv\": 29,\r\n \"NbDispatched\": 30,\r\n \"UniqueViews\": 31,\r\n \"UniqueClicks\": 32,\r\n \"EcastItemID\": 33,\r\n \"BookingsMadeIn14Days\": 34\r\n },\r\n {\r\n \"EmailTrendFactID\": 1,\r\n \"CtcID\": 2,\r\n \"OpCode\": 3,\r\n \"PrjMkgTitle\": \"sample string 4\",\r\n \"Subject\": \"sample string 5\",\r\n \"CategoryID\": 6,\r\n \"Category\": \"sample string 7\",\r\n \"SendDate\": \"2026-03-25T07:30:07.6836172+00:00\",\r\n \"OpenDate\": \"2026-03-25T07:30:07.6836172+00:00\",\r\n \"TimeOfDayEmailOpened\": 9,\r\n \"DayOfWeekEmailOpened\": 10,\r\n \"SubmittedBy\": \"sample string 11\",\r\n \"SenderProfileID\": 12,\r\n \"SenderProfile\": \"sample string 13\",\r\n \"BrandName\": \"sample string 14\",\r\n \"DomainName\": \"sample string 15\",\r\n \"IsFollowUp\": true,\r\n \"IsComplaint\": true,\r\n \"Status\": 18,\r\n \"Error\": 19,\r\n \"FirstTrial\": \"2026-03-25T07:30:07.6836172+00:00\",\r\n \"LastTrial\": \"2026-03-25T07:30:07.6836172+00:00\",\r\n \"NbTrial\": 20,\r\n \"NbClicks\": 21,\r\n \"NbViews\": 22,\r\n \"Unsubscribe\": 23,\r\n \"CostPerItem\": 24.1,\r\n \"ModifiedDate\": \"2026-03-25T07:30:07.6992273+00:00\",\r\n \"DirectSpentWithoutOverlap\": 26.1,\r\n \"IndirectSpentWithoutOverlap\": 27.1,\r\n \"NbSent\": 28,\r\n \"NbDeliv\": 29,\r\n \"NbDispatched\": 30,\r\n \"UniqueViews\": 31,\r\n \"UniqueClicks\": 32,\r\n \"EcastItemID\": 33,\r\n \"BookingsMadeIn14Days\": 34\r\n }\r\n ],\r\n \"Errors\": [\r\n \"sample string 1\",\r\n \"sample string 2\"\r\n ]\r\n}"}],"_postman_id":"8624a4f0-13dc-4fb1-91b7-9b6c31b05d2d"},{"name":"GetHotelBookingsFact","id":"cbb4bb5f-b0f7-4932-866b-5f3735898ae0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"https://{{Host}}/api/BIDWHouse/GetHotelBookingsFact?PageSize=PageSize-value&resetStartProcessDate=resetStartProcessDate-value","description":"

\n Getting records from FactHotelBooking table.\n \n

Response Payload

Name	Type	Description
HotelBookingsFactOutput Description
Errors	List<String>	The List of errors if exist.
HotelBookingsFact	List<HotelBookingsFact>	List of objects indicating a booking details.
Response	Boolean	The call success status.
HotelBookingsFact Description
Name	Type	Description
HotelBookingBookerCtcID	Int32	The unique ID for the contact in Atreemo and used to join the various tables.
HotelBookingCheckInDate	DateTime (nullable)	The Start date of the visit.
HotelBookingCheckOutDate	DateTime (nullable)	The end visit date of the visit.
HotelBookingDateTime	DateTime (nullable)	The date of the Booking.
HotelBookingExternalID	String	The external unique ID for the booking.
HotelBookingID	Int32	The unique ID for the booking in Atreemo and used to join the various tables.
HotelBookingIsOTA	Boolean	Is OTA
HotelBookingMarketSegment	String	The market segment .
HotelBookingModifyURL	String	The URL to modify the booking .
HotelBookingNightsNumber	Int32	The number of nights
HotelBookingsFactID	Int32	Incremental unique ID.
HotelBookingSiteID	Int32	The location ID where the booking is made .
HotelBookingSiteName	String	The location name where the booking is made .
HotelBookingSpend	Decimal	The booking's spend value .
HotelBookingStatus	String	The bookings' Atreemo status
ModifiedDate	DateTime	The last modification date for the booking.

","urlObject":{"protocol":"https","path":["api","BIDWHouse","GetHotelBookingsFact"],"host":["{{Host}}"],"query":[{"key":"PageSize","value":"PageSize-value"},{"key":"resetStartProcessDate","value":"resetStartProcessDate-value"}],"variable":[]}},"response":[{"id":"0afe2cb3-3a12-4686-8c6e-c878fbe6135d","name":"api/BIDWHouse/GetHotelBookingsFact?PageSize={PageSize}&resetStartProcessDate={resetStartProcessDate} Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":{"raw":"https://{{Host}}/api/BIDWHouse/GetHotelBookingsFact?PageSize=PageSize-value&resetStartProcessDate=resetStartProcessDate-value","protocol":"https","host":["{{Host}}"],"path":["api","BIDWHouse","GetHotelBookingsFact"],"query":[{"key":"PageSize","value":"PageSize-value"},{"key":"resetStartProcessDate","value":"resetStartProcessDate-value"}]},"description":"

\r\n Getting records from FactHotelBooking table.\r\n \n

Response Payload

Name	Type	Description
HotelBookingsFactOutput Description
Errors	List<String>	The List of errors if exist.
HotelBookingsFact	List<HotelBookingsFact>	List of objects indicating a booking details.
Response	Boolean	The call success status.
HotelBookingsFact Description
Name	Type	Description
HotelBookingBookerCtcID	Int32	The unique ID for the contact in Atreemo and used to join the various tables.
HotelBookingCheckInDate	DateTime (nullable)	The Start date of the visit.
HotelBookingCheckOutDate	DateTime (nullable)	The end visit date of the visit.
HotelBookingDateTime	DateTime (nullable)	The date of the Booking.
HotelBookingExternalID	String	The external unique ID for the booking.
HotelBookingID	Int32	The unique ID for the booking in Atreemo and used to join the various tables.
HotelBookingIsOTA	Boolean	Is OTA
HotelBookingMarketSegment	String	The market segment .
HotelBookingModifyURL	String	The URL to modify the booking .
HotelBookingNightsNumber	Int32	The number of nights
HotelBookingsFactID	Int32	Incremental unique ID.
HotelBookingSiteID	Int32	The location ID where the booking is made .
HotelBookingSiteName	String	The location name where the booking is made .
HotelBookingSpend	Decimal	The booking's spend value .
HotelBookingStatus	String	The bookings' Atreemo status
ModifiedDate	DateTime	The last modification date for the booking.

"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"Response\": true,\r\n \"HotelBookingsFact\": [\r\n {\r\n \"HotelBookingsFactID\": 1,\r\n \"HotelBookingID\": 2,\r\n \"HotelBookingBookerCtcID\": 3,\r\n \"HotelBookingExternalID\": \"sample string 4\",\r\n \"HotelBookingDateTime\": \"2026-03-25T07:30:07.7148752+00:00\",\r\n \"HotelBookingCheckInDate\": \"2026-03-25T07:30:07.7148752+00:00\",\r\n \"HotelBookingCheckOutDate\": \"2026-03-25T07:30:07.7148752+00:00\",\r\n \"HotelBookingStatus\": \"sample string 5\",\r\n \"HotelBookingIsOTA\": true,\r\n \"HotelBookingSpend\": 7.0,\r\n \"HotelBookingSiteID\": 8,\r\n \"HotelBookingSiteName\": \"sample string 9\",\r\n \"HotelBookingNightsNumber\": 10,\r\n \"HotelBookingMarketSegment\": \"sample string 11\",\r\n \"HotelBookingModifyURL\": \"sample string 12\",\r\n \"ModifiedDate\": \"2026-03-25T07:30:07.7148752+00:00\"\r\n },\r\n {\r\n \"HotelBookingsFactID\": 1,\r\n \"HotelBookingID\": 2,\r\n \"HotelBookingBookerCtcID\": 3,\r\n \"HotelBookingExternalID\": \"sample string 4\",\r\n \"HotelBookingDateTime\": \"2026-03-25T07:30:07.7148752+00:00\",\r\n \"HotelBookingCheckInDate\": \"2026-03-25T07:30:07.7148752+00:00\",\r\n \"HotelBookingCheckOutDate\": \"2026-03-25T07:30:07.7148752+00:00\",\r\n \"HotelBookingStatus\": \"sample string 5\",\r\n \"HotelBookingIsOTA\": true,\r\n \"HotelBookingSpend\": 7.0,\r\n \"HotelBookingSiteID\": 8,\r\n \"HotelBookingSiteName\": \"sample string 9\",\r\n \"HotelBookingNightsNumber\": 10,\r\n \"HotelBookingMarketSegment\": \"sample string 11\",\r\n \"HotelBookingModifyURL\": \"sample string 12\",\r\n \"ModifiedDate\": \"2026-03-25T07:30:07.7148752+00:00\"\r\n }\r\n ],\r\n \"Errors\": [\r\n \"sample string 1\",\r\n \"sample string 2\"\r\n ]\r\n}"}],"_postman_id":"cbb4bb5f-b0f7-4932-866b-5f3735898ae0"},{"name":"GetLoyaltyPointsFact","id":"a9eb5e25-2ba6-4320-b1f0-dd884251ce00","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"https://{{Host}}/api/BIDWHouse/GetLoyaltyPointsFact?PageSize=PageSize-value&resetStartProcessDate=resetStartProcessDate-value","description":"

\n Getting records from LoyaltyPointsFact table.\n \n

Response Payload

Name	Type	Description
LoyaltyPointsOutput Description
Errors	List<String>	The List of errors if exist.
LoyaltyPointsFacts	List<LoyaltyPointsFact>	The List of object for Loyalty.
Response	Boolean	The call success status.
LoyaltyPointsFact Description
Name	Type	Description
ActionDate	DateTime (nullable)	The date when this record was added/updated.
CtcID	Int32	The unique ID for the contact in Atreemo and used to join the various tables.
LoyaltyPointsFactID	Int32	Incremental unique ID.
ModifiedDate	DateTime	The last modification date.
OrderUniqueID	Int64	Atreemo Order Unique ID. Can be joined with transaction\n fact table to get the transaction details.
Points	Single	The number of Points/Stamps the customer earned or burnt based \n on the ActionDate and Location.
SiteID	Int32	The location ID the customer used their Loyalty Account.
SiteName	String	The location name the customer used their Loyalty Account.
Source	String	The Source of the ActionDate.

","urlObject":{"protocol":"https","path":["api","BIDWHouse","GetLoyaltyPointsFact"],"host":["{{Host}}"],"query":[{"key":"PageSize","value":"PageSize-value"},{"key":"resetStartProcessDate","value":"resetStartProcessDate-value"}],"variable":[]}},"response":[{"id":"c062eeb7-1de8-4035-97ee-7cd3ac87f0d6","name":"api/BIDWHouse/GetLoyaltyPointsFact?PageSize={PageSize}&resetStartProcessDate={resetStartProcessDate} Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":{"raw":"https://{{Host}}/api/BIDWHouse/GetLoyaltyPointsFact?PageSize=PageSize-value&resetStartProcessDate=resetStartProcessDate-value","protocol":"https","host":["{{Host}}"],"path":["api","BIDWHouse","GetLoyaltyPointsFact"],"query":[{"key":"PageSize","value":"PageSize-value"},{"key":"resetStartProcessDate","value":"resetStartProcessDate-value"}]},"description":"

\r\n Getting records from LoyaltyPointsFact table.\r\n \n

Response Payload

Name	Type	Description
LoyaltyPointsOutput Description
Errors	List<String>	The List of errors if exist.
LoyaltyPointsFacts	List<LoyaltyPointsFact>	The List of object for Loyalty.
Response	Boolean	The call success status.
LoyaltyPointsFact Description
Name	Type	Description
ActionDate	DateTime (nullable)	The date when this record was added/updated.
CtcID	Int32	The unique ID for the contact in Atreemo and used to join the various tables.
LoyaltyPointsFactID	Int32	Incremental unique ID.
ModifiedDate	DateTime	The last modification date.
OrderUniqueID	Int64	Atreemo Order Unique ID. Can be joined with transaction\n fact table to get the transaction details.
Points	Single	The number of Points/Stamps the customer earned or burnt based \n on the ActionDate and Location.
SiteID	Int32	The location ID the customer used their Loyalty Account.
SiteName	String	The location name the customer used their Loyalty Account.
Source	String	The Source of the ActionDate.

"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"Response\": true,\r\n \"LoyaltyPointsFacts\": [\r\n {\r\n \"LoyaltyPointsFactID\": 1,\r\n \"CtcID\": 2,\r\n \"OrderUniqueID\": 3,\r\n \"SiteID\": 4,\r\n \"SiteName\": \"sample string 5\",\r\n \"ActionDate\": \"2026-03-25T07:30:07.7304986+00:00\",\r\n \"Points\": 6.1,\r\n \"Source\": \"sample string 7\",\r\n \"ModifiedDate\": \"2026-03-25T07:30:07.7304986+00:00\"\r\n },\r\n {\r\n \"LoyaltyPointsFactID\": 1,\r\n \"CtcID\": 2,\r\n \"OrderUniqueID\": 3,\r\n \"SiteID\": 4,\r\n \"SiteName\": \"sample string 5\",\r\n \"ActionDate\": \"2026-03-25T07:30:07.7304986+00:00\",\r\n \"Points\": 6.1,\r\n \"Source\": \"sample string 7\",\r\n \"ModifiedDate\": \"2026-03-25T07:30:07.7304986+00:00\"\r\n }\r\n ],\r\n \"Errors\": [\r\n \"sample string 1\",\r\n \"sample string 2\"\r\n ]\r\n}"}],"_postman_id":"a9eb5e25-2ba6-4320-b1f0-dd884251ce00"},{"name":"GetPushNotificationTrendFact","id":"e4cd216f-8875-4dd5-abdf-17c4e4fa8844","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"https://{{Host}}/api/BIDWHouse/GetPushNotificationTrendFact?PageSize=PageSize-value&resetStartProcessDate=resetStartProcessDate-value","description":"

\n Getting records from PushNotificationTrendFact table.\n \n

Response Payload

Name	Type	Description
PushNotificationTrendOutput Description
Errors	List<String>	The List of errors if exist.
PushNotificationTrendFacts	List<PushNotificationTrendFact>	List of objects linked to a Push Notification.
Response	Boolean	The call success status.
PushNotificationTrendFact Description
Name	Type	Description
BrandName	String	The brand name ( multibrand instances).
Category	String	The campaign category name.
CategoryID	Int32	The campaign category unique ID.
CostPerItem	Single	The cost per item (if paid for on a per send basis).
CtcID	Int32	The unique ID for the contact in Atreemo and used to join the various tables.
DirectSpentWithoutOverlap	Single	The amount of direct spent without overlap
IndirectSpentWithoutOverlap	Single	The amount of indirect spent without overlap
ItemID	Int32	Push notification ID.
ModifiedDate	DateTime	The last modification date.
NbDeliv	Int32	The number of emails delivered
NbDispatched	Int32	The number of emails dispatched
NbSent	Int32	The number of emails sent
PrjMkgTitle	String	The marketing project title given the the campaign in Atreemo.
PushNotificationTrendFactID	Int32	Incremental unique ID.
SendDate	DateTime	The date of send.
SenderProfile	String	The Atreemo users sender profile name used for the campaign.
SenderProfileID	Int32	The Atreemo users sender profile unique ID used for the campaign.
SubmittedBy	String	The Atreemo user who submitted the push notification campaign.
UniqueClicks	Int32	The number of clicks
UniqueViews	Int32	The number of views

","urlObject":{"protocol":"https","path":["api","BIDWHouse","GetPushNotificationTrendFact"],"host":["{{Host}}"],"query":[{"key":"PageSize","value":"PageSize-value"},{"key":"resetStartProcessDate","value":"resetStartProcessDate-value"}],"variable":[]}},"response":[{"id":"75a9e34d-29c2-4e1d-9397-461a13faaa91","name":"api/BIDWHouse/GetPushNotificationTrendFact?PageSize={PageSize}&resetStartProcessDate={resetStartProcessDate} Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":{"raw":"https://{{Host}}/api/BIDWHouse/GetPushNotificationTrendFact?PageSize=PageSize-value&resetStartProcessDate=resetStartProcessDate-value","protocol":"https","host":["{{Host}}"],"path":["api","BIDWHouse","GetPushNotificationTrendFact"],"query":[{"key":"PageSize","value":"PageSize-value"},{"key":"resetStartProcessDate","value":"resetStartProcessDate-value"}]},"description":"

\r\n Getting records from PushNotificationTrendFact table.\r\n \n

Response Payload

Name	Type	Description
PushNotificationTrendOutput Description
Errors	List<String>	The List of errors if exist.
PushNotificationTrendFacts	List<PushNotificationTrendFact>	List of objects linked to a Push Notification.
Response	Boolean	The call success status.
PushNotificationTrendFact Description
Name	Type	Description
BrandName	String	The brand name ( multibrand instances).
Category	String	The campaign category name.
CategoryID	Int32	The campaign category unique ID.
CostPerItem	Single	The cost per item (if paid for on a per send basis).
CtcID	Int32	The unique ID for the contact in Atreemo and used to join the various tables.
DirectSpentWithoutOverlap	Single	The amount of direct spent without overlap
IndirectSpentWithoutOverlap	Single	The amount of indirect spent without overlap
ItemID	Int32	Push notification ID.
ModifiedDate	DateTime	The last modification date.
NbDeliv	Int32	The number of emails delivered
NbDispatched	Int32	The number of emails dispatched
NbSent	Int32	The number of emails sent
PrjMkgTitle	String	The marketing project title given the the campaign in Atreemo.
PushNotificationTrendFactID	Int32	Incremental unique ID.
SendDate	DateTime	The date of send.
SenderProfile	String	The Atreemo users sender profile name used for the campaign.
SenderProfileID	Int32	The Atreemo users sender profile unique ID used for the campaign.
SubmittedBy	String	The Atreemo user who submitted the push notification campaign.
UniqueClicks	Int32	The number of clicks
UniqueViews	Int32	The number of views

"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"Response\": true,\r\n \"PushNotificationTrendFacts\": [\r\n {\r\n \"PushNotificationTrendFactID\": 1,\r\n \"CtcID\": 2,\r\n \"PrjMkgTitle\": \"sample string 3\",\r\n \"CategoryID\": 4,\r\n \"Category\": \"sample string 5\",\r\n \"SendDate\": \"2026-03-25T07:30:07.7461097+00:00\",\r\n \"SubmittedBy\": \"sample string 7\",\r\n \"SenderProfileID\": 8,\r\n \"SenderProfile\": \"sample string 9\",\r\n \"BrandName\": \"sample string 10\",\r\n \"CostPerItem\": 11.1,\r\n \"ModifiedDate\": \"2026-03-25T07:30:07.7461097+00:00\",\r\n \"DirectSpentWithoutOverlap\": 13.1,\r\n \"IndirectSpentWithoutOverlap\": 14.1,\r\n \"NbSent\": 15,\r\n \"NbDeliv\": 16,\r\n \"NbDispatched\": 17,\r\n \"UniqueViews\": 18,\r\n \"UniqueClicks\": 19,\r\n \"ItemID\": 20\r\n },\r\n {\r\n \"PushNotificationTrendFactID\": 1,\r\n \"CtcID\": 2,\r\n \"PrjMkgTitle\": \"sample string 3\",\r\n \"CategoryID\": 4,\r\n \"Category\": \"sample string 5\",\r\n \"SendDate\": \"2026-03-25T07:30:07.7461097+00:00\",\r\n \"SubmittedBy\": \"sample string 7\",\r\n \"SenderProfileID\": 8,\r\n \"SenderProfile\": \"sample string 9\",\r\n \"BrandName\": \"sample string 10\",\r\n \"CostPerItem\": 11.1,\r\n \"ModifiedDate\": \"2026-03-25T07:30:07.7461097+00:00\",\r\n \"DirectSpentWithoutOverlap\": 13.1,\r\n \"IndirectSpentWithoutOverlap\": 14.1,\r\n \"NbSent\": 15,\r\n \"NbDeliv\": 16,\r\n \"NbDispatched\": 17,\r\n \"UniqueViews\": 18,\r\n \"UniqueClicks\": 19,\r\n \"ItemID\": 20\r\n }\r\n ],\r\n \"Errors\": [\r\n \"sample string 1\",\r\n \"sample string 2\"\r\n ]\r\n}"}],"_postman_id":"e4cd216f-8875-4dd5-abdf-17c4e4fa8844"},{"name":"GetRewardJourneysProgressFact","id":"136f8e99-5ba7-44c3-9b9a-f404503f2ea8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"https://{{Host}}/api/BIDWHouse/GetRewardJourneysProgressFact?PageSize=PageSize-value&resetStartProcessDate=resetStartProcessDate-value","description":"

\n Getting records from FactRewardJourneysProgress table.\n \n

Response Payload

Name	Type	Description
RewardJourneysProgressFactOutput Description
Errors	List<String>	The List of errors if exist.
Response	Boolean	The call success status.
RewardJourneysProgressFact	List<RewardJourneysProgressFact>	List of objects indicating a booking details.
RewardJourneysProgressFact Description
Name	Type	Description
BookingDate	DateTime (nullable)	The date of the Booking.
BookingID	Int32 (nullable)	The unique ID for the booking in Atreemo and used to join the various tables.
BookingStatus	String	The bookings' Atreemo status
CtcID	Int32	The unique ID for the contact in Atreemo and used to join the various tables.
GoalToAchieve	Double	The Goal To Achieve the RewardJourney.
Location	String	The location name
ModifiedDate	DateTime (nullable)	Modified Date of the RewardJourney
OrderDate	DateTime (nullable)	The date / time of the transaction.
OrderUniqueID	Int64	Atreemo’s Unique Order ID.
Product	String	The product name
RewardJourneyCompleted	Boolean (nullable)	If true,the RewardJourney is completed.
RewardJourneyCompletionDate	DateTime (nullable)	Completion Date of the RewardJourney, empty if the RewardJourney still in progress
RewardJourneyCreateDate	DateTime	The Create Date for the RewardJourney.
RewardJourneyFactID	Int32	Incremental unique ID.
RewardJourneyID	Int32	The unique ID for the RewardJourney in Atreemo and used to join the various tables.
RewardJourneyProgress	Double	The Progress of the RewardJourney.
RewardJourneyRewardType	String	The Reward Type of the RewardJourney.
RewardJourneySignUpDate	DateTime	The SignUp Date for the RewardJourney.
RewardJourneyType	String	The type of the RewardJourney.
SpendProgress	Double	The Spend Progress of the RewardJourney.
VisitDateTime	DateTime (nullable)	The visit date time.

","urlObject":{"protocol":"https","path":["api","BIDWHouse","GetRewardJourneysProgressFact"],"host":["{{Host}}"],"query":[{"key":"PageSize","value":"PageSize-value"},{"key":"resetStartProcessDate","value":"resetStartProcessDate-value"}],"variable":[]}},"response":[{"id":"93b72bdb-8f2f-4973-9e0d-27a7aa12c79a","name":"api/BIDWHouse/GetRewardJourneysProgressFact?PageSize={PageSize}&resetStartProcessDate={resetStartProcessDate} Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":{"raw":"https://{{Host}}/api/BIDWHouse/GetRewardJourneysProgressFact?PageSize=PageSize-value&resetStartProcessDate=resetStartProcessDate-value","protocol":"https","host":["{{Host}}"],"path":["api","BIDWHouse","GetRewardJourneysProgressFact"],"query":[{"key":"PageSize","value":"PageSize-value"},{"key":"resetStartProcessDate","value":"resetStartProcessDate-value"}]},"description":"

\r\n Getting records from FactRewardJourneysProgress table.\r\n \n

Response Payload

Name	Type	Description
RewardJourneysProgressFactOutput Description
Errors	List<String>	The List of errors if exist.
Response	Boolean	The call success status.
RewardJourneysProgressFact	List<RewardJourneysProgressFact>	List of objects indicating a booking details.
RewardJourneysProgressFact Description
Name	Type	Description
BookingDate	DateTime (nullable)	The date of the Booking.
BookingID	Int32 (nullable)	The unique ID for the booking in Atreemo and used to join the various tables.
BookingStatus	String	The bookings' Atreemo status
CtcID	Int32	The unique ID for the contact in Atreemo and used to join the various tables.
GoalToAchieve	Double	The Goal To Achieve the RewardJourney.
Location	String	The location name
ModifiedDate	DateTime (nullable)	Modified Date of the RewardJourney
OrderDate	DateTime (nullable)	The date / time of the transaction.
OrderUniqueID	Int64	Atreemo’s Unique Order ID.
Product	String	The product name
RewardJourneyCompleted	Boolean (nullable)	If true,the RewardJourney is completed.
RewardJourneyCompletionDate	DateTime (nullable)	Completion Date of the RewardJourney, empty if the RewardJourney still in progress
RewardJourneyCreateDate	DateTime	The Create Date for the RewardJourney.
RewardJourneyFactID	Int32	Incremental unique ID.
RewardJourneyID	Int32	The unique ID for the RewardJourney in Atreemo and used to join the various tables.
RewardJourneyProgress	Double	The Progress of the RewardJourney.
RewardJourneyRewardType	String	The Reward Type of the RewardJourney.
RewardJourneySignUpDate	DateTime	The SignUp Date for the RewardJourney.
RewardJourneyType	String	The type of the RewardJourney.
SpendProgress	Double	The Spend Progress of the RewardJourney.
VisitDateTime	DateTime (nullable)	The visit date time.

"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"Response\": true,\r\n \"RewardJourneysProgressFact\": [\r\n {\r\n \"RewardJourneyFactID\": 1,\r\n \"RewardJourneyID\": 2,\r\n \"CtcID\": 3,\r\n \"RewardJourneyCreateDate\": \"2026-03-25T07:30:07.7773719+00:00\",\r\n \"RewardJourneyType\": \"sample string 5\",\r\n \"GoalToAchieve\": 6.1,\r\n \"RewardJourneyRewardType\": \"sample string 7\",\r\n \"RewardJourneySignUpDate\": \"2026-03-25T07:30:07.7773719+00:00\",\r\n \"RewardJourneyCompletionDate\": \"2026-03-25T07:30:07.7773719+00:00\",\r\n \"RewardJourneyProgress\": 9.1,\r\n \"RewardJourneyCompleted\": true,\r\n \"ModifiedDate\": \"2026-03-25T07:30:07.7773719+00:00\",\r\n \"BookingID\": 1,\r\n \"BookingDate\": \"2026-03-25T07:30:07.7773719+00:00\",\r\n \"BookingStatus\": \"sample string 10\",\r\n \"OrderDate\": \"2026-03-25T07:30:07.7773719+00:00\",\r\n \"OrderUniqueID\": 11,\r\n \"SpendProgress\": 12.1,\r\n \"VisitDateTime\": \"2026-03-25T07:30:07.7773719+00:00\",\r\n \"Product\": \"sample string 13\",\r\n \"Location\": \"sample string 14\"\r\n },\r\n {\r\n \"RewardJourneyFactID\": 1,\r\n \"RewardJourneyID\": 2,\r\n \"CtcID\": 3,\r\n \"RewardJourneyCreateDate\": \"2026-03-25T07:30:07.7773719+00:00\",\r\n \"RewardJourneyType\": \"sample string 5\",\r\n \"GoalToAchieve\": 6.1,\r\n \"RewardJourneyRewardType\": \"sample string 7\",\r\n \"RewardJourneySignUpDate\": \"2026-03-25T07:30:07.7773719+00:00\",\r\n \"RewardJourneyCompletionDate\": \"2026-03-25T07:30:07.7773719+00:00\",\r\n \"RewardJourneyProgress\": 9.1,\r\n \"RewardJourneyCompleted\": true,\r\n \"ModifiedDate\": \"2026-03-25T07:30:07.7773719+00:00\",\r\n \"BookingID\": 1,\r\n \"BookingDate\": \"2026-03-25T07:30:07.7773719+00:00\",\r\n \"BookingStatus\": \"sample string 10\",\r\n \"OrderDate\": \"2026-03-25T07:30:07.7773719+00:00\",\r\n \"OrderUniqueID\": 11,\r\n \"SpendProgress\": 12.1,\r\n \"VisitDateTime\": \"2026-03-25T07:30:07.7773719+00:00\",\r\n \"Product\": \"sample string 13\",\r\n \"Location\": \"sample string 14\"\r\n }\r\n ],\r\n \"Errors\": [\r\n \"sample string 1\",\r\n \"sample string 2\"\r\n ]\r\n}"}],"_postman_id":"136f8e99-5ba7-44c3-9b9a-f404503f2ea8"},{"name":"GetSLPFact","id":"9b37bb06-e7ee-4307-9d69-cbf4e1542e85","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"https://{{Host}}/api/BIDWHouse/GetSLPFact?PageSize=PageSize-value&resetStartProcessDate=resetStartProcessDate-value","description":"

\n Getting records from LeadsFact table.\n \n

Response Payload

Name	Type	Description
LeadsFactOutput Description
Errors	List<String>	The List of errors if exist.
LeadsFacts	List<LeadsFact>	List of objects indicating a sales lead details.
Response	Boolean	The call success status.
LeadsFact Description
Name	Type	Description
AppointmentDate	DateTime (nullable)	If the sales lead appointment date.
Brand	String	If the sales lead brand.
CallMade	Boolean	If a call made with a contact this valus is true.
CategoryName	String	The sales leads category name.
ClaimedBy	String	The Atreemo user who claimed the sales lead.
ClaimedDate	DateTime (nullable)	The date of claiming a lead.
CreateDate	DateTime	The creation date of the sales lead.
CreatedBy	String	The Atreemo user who created the sales lead.
CtcID	Int32	The unique ID for the contact in Atreemo and used to join the various tables.
Deleted	Boolean	If the sales lead is deleted in Atreemo Deleted is True.
EstimatedRevenue	Single	The sales lead estimated revenue value .
EventDate	DateTime (nullable)	The sales lead event date.
EventEndDate	DateTime (nullable)	The sales lead event end date.
FirstCallDate	DateTime (nullable)	The date of the first call made.
FirstCallMadeBy	String	The user who made the first call.
FirstCallType	String	The type of the first call.
FollowUpDate	DateTime (nullable)	The sales lead follow up date.
IsMaster	Boolean	If the sales lead is Merged to another lead IsMaster is True.
IsWalkin	Boolean	If the sales lead contact made is walk in this variable will be True.
LastCallDate	DateTime (nullable)	The date of the last call made.
LastCallMadeBy	String	The user who made the last call.
LastCallType	String	The type of the last call.
LastCommunicationDate	DateTime (nullable)	The last date of the most recent communication with the lead
LastModifiedOn	DateTime (nullable)	The sales lead last Modification Date in Atreemo.
LastSuccessfulCallMadeBy	String	The user who made the last successful call to the lead.
LastSuccessfulCallMadeOn	DateTime (nullable)	The last successful call date was made to the lead.
LastUnsuccessfulCallMadeBy	String	The user who made the last unsuccessful call to the lead.
LastUnsuccessfulCallMadeOn	DateTime (nullable)	The last unsuccessful call date was made to the lead.
LeadID	Int32	The unique ID for the sales Lead in Atreemo and used to join the various tables.
LeadsFactID	Int32	Incremental unique ID.
LeadSource	String	If the sales lead source.
MasterID	Int32	If the sales lead is Merged to another lead the MasterID is not null.
ModifiedDate	DateTime	The last modification date for the lead.
PostSaesCallDate	DateTime (nullable)	If the sales lead post sale call date.
Priority	String	The sales lead priority in Atreemo.
ProvisionalEventDate	DateTime (nullable)	The sales lead Provisional event date.
ProvisionalEventEndDate	DateTime (nullable)	The sales lead Provisional event end date.
Region	String	The region name where the transaction was made.
Revenue	Single	If the sales lead revenue.
SaleType	String	The sales lead sale type in Atreemo.
SiteID	Int32	The location ID where the transaction was made.
SiteName	String	The location name where the transaction was made.
SourceName	String	The sales lead source Name in Atreemo.
Status	String	The sales leads Atreemo status
SubCategoryName	String	The sales leads subcategory name.
TotalEmails	Int32 (nullable)	The total number of emails sent to the lead.
TotalSuccessfulCalls	Int32 (nullable)	The Total number of successful calls made to leads.
TotalUnsuccessfulCalls	Int32 (nullable)	The Total number of unsuccessful calls made to leads.

","urlObject":{"protocol":"https","path":["api","BIDWHouse","GetSLPFact"],"host":["{{Host}}"],"query":[{"key":"PageSize","value":"PageSize-value"},{"key":"resetStartProcessDate","value":"resetStartProcessDate-value"}],"variable":[]}},"response":[{"id":"e94afb6b-3368-423e-98be-a7e525bd2f5d","name":"api/BIDWHouse/GetSLPFact?PageSize={PageSize}&resetStartProcessDate={resetStartProcessDate} Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":{"raw":"https://{{Host}}/api/BIDWHouse/GetSLPFact?PageSize=PageSize-value&resetStartProcessDate=resetStartProcessDate-value","protocol":"https","host":["{{Host}}"],"path":["api","BIDWHouse","GetSLPFact"],"query":[{"key":"PageSize","value":"PageSize-value"},{"key":"resetStartProcessDate","value":"resetStartProcessDate-value"}]},"description":"

\r\n Getting records from LeadsFact table.\r\n \n

Response Payload

Name	Type	Description
LeadsFactOutput Description
Errors	List<String>	The List of errors if exist.
LeadsFacts	List<LeadsFact>	List of objects indicating a sales lead details.
Response	Boolean	The call success status.
LeadsFact Description
Name	Type	Description
AppointmentDate	DateTime (nullable)	If the sales lead appointment date.
Brand	String	If the sales lead brand.
CallMade	Boolean	If a call made with a contact this valus is true.
CategoryName	String	The sales leads category name.
ClaimedBy	String	The Atreemo user who claimed the sales lead.
ClaimedDate	DateTime (nullable)	The date of claiming a lead.
CreateDate	DateTime	The creation date of the sales lead.
CreatedBy	String	The Atreemo user who created the sales lead.
CtcID	Int32	The unique ID for the contact in Atreemo and used to join the various tables.
Deleted	Boolean	If the sales lead is deleted in Atreemo Deleted is True.
EstimatedRevenue	Single	The sales lead estimated revenue value .
EventDate	DateTime (nullable)	The sales lead event date.
EventEndDate	DateTime (nullable)	The sales lead event end date.
FirstCallDate	DateTime (nullable)	The date of the first call made.
FirstCallMadeBy	String	The user who made the first call.
FirstCallType	String	The type of the first call.
FollowUpDate	DateTime (nullable)	The sales lead follow up date.
IsMaster	Boolean	If the sales lead is Merged to another lead IsMaster is True.
IsWalkin	Boolean	If the sales lead contact made is walk in this variable will be True.
LastCallDate	DateTime (nullable)	The date of the last call made.
LastCallMadeBy	String	The user who made the last call.
LastCallType	String	The type of the last call.
LastCommunicationDate	DateTime (nullable)	The last date of the most recent communication with the lead
LastModifiedOn	DateTime (nullable)	The sales lead last Modification Date in Atreemo.
LastSuccessfulCallMadeBy	String	The user who made the last successful call to the lead.
LastSuccessfulCallMadeOn	DateTime (nullable)	The last successful call date was made to the lead.
LastUnsuccessfulCallMadeBy	String	The user who made the last unsuccessful call to the lead.
LastUnsuccessfulCallMadeOn	DateTime (nullable)	The last unsuccessful call date was made to the lead.
LeadID	Int32	The unique ID for the sales Lead in Atreemo and used to join the various tables.
LeadsFactID	Int32	Incremental unique ID.
LeadSource	String	If the sales lead source.
MasterID	Int32	If the sales lead is Merged to another lead the MasterID is not null.
ModifiedDate	DateTime	The last modification date for the lead.
PostSaesCallDate	DateTime (nullable)	If the sales lead post sale call date.
Priority	String	The sales lead priority in Atreemo.
ProvisionalEventDate	DateTime (nullable)	The sales lead Provisional event date.
ProvisionalEventEndDate	DateTime (nullable)	The sales lead Provisional event end date.
Region	String	The region name where the transaction was made.
Revenue	Single	If the sales lead revenue.
SaleType	String	The sales lead sale type in Atreemo.
SiteID	Int32	The location ID where the transaction was made.
SiteName	String	The location name where the transaction was made.
SourceName	String	The sales lead source Name in Atreemo.
Status	String	The sales leads Atreemo status
SubCategoryName	String	The sales leads subcategory name.
TotalEmails	Int32 (nullable)	The total number of emails sent to the lead.
TotalSuccessfulCalls	Int32 (nullable)	The Total number of successful calls made to leads.
TotalUnsuccessfulCalls	Int32 (nullable)	The Total number of unsuccessful calls made to leads.

"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"Response\": true,\r\n \"LeadsFacts\": [\r\n {\r\n \"LeadsFactID\": 1,\r\n \"LeadID\": 2,\r\n \"CtcID\": 3,\r\n \"CreateDate\": \"2026-03-25T07:30:07.7930023+00:00\",\r\n \"CreatedBy\": \"sample string 5\",\r\n \"ClaimedBy\": \"sample string 6\",\r\n \"CategoryName\": \"sample string 7\",\r\n \"SubCategoryName\": \"sample string 8\",\r\n \"Status\": \"sample string 9\",\r\n \"IsWalkin\": true,\r\n \"LeadSource\": \"sample string 11\",\r\n \"Revenue\": 12.1,\r\n \"PostSaesCallDate\": \"2026-03-25T07:30:07.7930023+00:00\",\r\n \"SiteID\": 13,\r\n \"SiteName\": \"sample string 14\",\r\n \"Region\": \"sample string 15\",\r\n \"FollowUpDate\": \"2026-03-25T07:30:07.7930023+00:00\",\r\n \"SourceName\": \"sample string 16\",\r\n \"Priority\": \"sample string 17\",\r\n \"EventDate\": \"2026-03-25T07:30:07.7930023+00:00\",\r\n \"EventEndDate\": \"2026-03-25T07:30:07.7930023+00:00\",\r\n \"ProvisionalEventDate\": \"2026-03-25T07:30:07.7930023+00:00\",\r\n \"ProvisionalEventEndDate\": \"2026-03-25T07:30:07.7930023+00:00\",\r\n \"SaleType\": \"sample string 18\",\r\n \"EstimatedRevenue\": 19.1,\r\n \"CallMade\": true,\r\n \"ClaimedDate\": \"2026-03-25T07:30:07.7930023+00:00\",\r\n \"FirstCallDate\": \"2026-03-25T07:30:07.7930023+00:00\",\r\n \"FirstCallMadeBy\": \"sample string 21\",\r\n \"FirstCallType\": \"sample string 22\",\r\n \"LastCallDate\": \"2026-03-25T07:30:07.7930023+00:00\",\r\n \"LastCallMadeBy\": \"sample string 23\",\r\n \"LastCallType\": \"sample string 24\",\r\n \"AppointmentDate\": \"2026-03-25T07:30:07.7930023+00:00\",\r\n \"Brand\": \"sample string 25\",\r\n \"MasterID\": 26,\r\n \"IsMaster\": true,\r\n \"LastModifiedOn\": \"2026-03-25T07:30:07.7930023+00:00\",\r\n \"Deleted\": true,\r\n \"ModifiedDate\": \"2026-03-25T07:30:07.7930023+00:00\",\r\n \"TotalSuccessfulCalls\": 1,\r\n \"LastSuccessfulCallMadeOn\": \"2026-03-25T07:30:07.7930023+00:00\",\r\n \"LastSuccessfulCallMadeBy\": \"sample string 30\",\r\n \"TotalUnsuccessfulCalls\": 1,\r\n \"LastUnsuccessfulCallMadeOn\": \"2026-03-25T07:30:07.7930023+00:00\",\r\n \"LastUnsuccessfulCallMadeBy\": \"sample string 31\",\r\n \"TotalEmails\": 1,\r\n \"LastCommunicationDate\": \"2026-03-25T07:30:07.7930023+00:00\"\r\n },\r\n {\r\n \"LeadsFactID\": 1,\r\n \"LeadID\": 2,\r\n \"CtcID\": 3,\r\n \"CreateDate\": \"2026-03-25T07:30:07.7930023+00:00\",\r\n \"CreatedBy\": \"sample string 5\",\r\n \"ClaimedBy\": \"sample string 6\",\r\n \"CategoryName\": \"sample string 7\",\r\n \"SubCategoryName\": \"sample string 8\",\r\n \"Status\": \"sample string 9\",\r\n \"IsWalkin\": true,\r\n \"LeadSource\": \"sample string 11\",\r\n \"Revenue\": 12.1,\r\n \"PostSaesCallDate\": \"2026-03-25T07:30:07.7930023+00:00\",\r\n \"SiteID\": 13,\r\n \"SiteName\": \"sample string 14\",\r\n \"Region\": \"sample string 15\",\r\n \"FollowUpDate\": \"2026-03-25T07:30:07.7930023+00:00\",\r\n \"SourceName\": \"sample string 16\",\r\n \"Priority\": \"sample string 17\",\r\n \"EventDate\": \"2026-03-25T07:30:07.7930023+00:00\",\r\n \"EventEndDate\": \"2026-03-25T07:30:07.7930023+00:00\",\r\n \"ProvisionalEventDate\": \"2026-03-25T07:30:07.7930023+00:00\",\r\n \"ProvisionalEventEndDate\": \"2026-03-25T07:30:07.7930023+00:00\",\r\n \"SaleType\": \"sample string 18\",\r\n \"EstimatedRevenue\": 19.1,\r\n \"CallMade\": true,\r\n \"ClaimedDate\": \"2026-03-25T07:30:07.7930023+00:00\",\r\n \"FirstCallDate\": \"2026-03-25T07:30:07.7930023+00:00\",\r\n \"FirstCallMadeBy\": \"sample string 21\",\r\n \"FirstCallType\": \"sample string 22\",\r\n \"LastCallDate\": \"2026-03-25T07:30:07.7930023+00:00\",\r\n \"LastCallMadeBy\": \"sample string 23\",\r\n \"LastCallType\": \"sample string 24\",\r\n \"AppointmentDate\": \"2026-03-25T07:30:07.7930023+00:00\",\r\n \"Brand\": \"sample string 25\",\r\n \"MasterID\": 26,\r\n \"IsMaster\": true,\r\n \"LastModifiedOn\": \"2026-03-25T07:30:07.7930023+00:00\",\r\n \"Deleted\": true,\r\n \"ModifiedDate\": \"2026-03-25T07:30:07.7930023+00:00\",\r\n \"TotalSuccessfulCalls\": 1,\r\n \"LastSuccessfulCallMadeOn\": \"2026-03-25T07:30:07.7930023+00:00\",\r\n \"LastSuccessfulCallMadeBy\": \"sample string 30\",\r\n \"TotalUnsuccessfulCalls\": 1,\r\n \"LastUnsuccessfulCallMadeOn\": \"2026-03-25T07:30:07.7930023+00:00\",\r\n \"LastUnsuccessfulCallMadeBy\": \"sample string 31\",\r\n \"TotalEmails\": 1,\r\n \"LastCommunicationDate\": \"2026-03-25T07:30:07.7930023+00:00\"\r\n }\r\n ],\r\n \"Errors\": [\r\n \"sample string 1\",\r\n \"sample string 2\"\r\n ]\r\n}"}],"_postman_id":"9b37bb06-e7ee-4307-9d69-cbf4e1542e85"},{"name":"GetSMSTrendFact","id":"7b649c56-d638-4e85-81ac-898a0d8b12b5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"https://{{Host}}/api/BIDWHouse/GetSMSTrendFact?PageSize=PageSize-value&resetStartProcessDate=resetStartProcessDate-value","description":"

\n Getting records from SMSTrendFact table.\n \n

Response Payload

Name	Type	Description
SMSTrendOutput Description
Errors	List<String>	The List of errors if exist.
Response	Boolean	The call success status .
SMSTrendFacts	List<SMSTrendFact>	List of objects linked to sms campaigns.
SMSTrendFact Description
Name	Type	Description
BookingsMadeIn14Days	Int32
BrandName	String	The brand name ( multibrand instances).
Category	String	The campaign category name.
CategoryID	Int32	The campaign category unique ID.
CostPerItem	Single	The cost per item.
CtcID	Int32	The unique ID for the contact in Atreemo and used to join the various tables.
ModifiedDate	DateTime	The last modification date.
NbUnits	Int32	The number of unit SMS sent, for example if the message was 204 characters the number of units would be 2.
PrjMkgTitle	String	The marketing project title assigned in Atreemo.
SendDate	DateTime	The date time the SMS was scheduled to send.
SenderProfile	String	The Atreemo users sender profile name.
SenderProfileID	Int32	The Atreemo users sender profile unique ID.
SMSItemID	Int32	The unique ID of the SMS Item.
SMSTrendFactID	Int32	Incremental unique ID.
SubmittedBy	String	The Atreemo user who submitted the campaign.

","urlObject":{"protocol":"https","path":["api","BIDWHouse","GetSMSTrendFact"],"host":["{{Host}}"],"query":[{"key":"PageSize","value":"PageSize-value"},{"key":"resetStartProcessDate","value":"resetStartProcessDate-value"}],"variable":[]}},"response":[{"id":"38efa136-9c02-488f-aee4-02c6f1367b93","name":"api/BIDWHouse/GetSMSTrendFact?PageSize={PageSize}&resetStartProcessDate={resetStartProcessDate} Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":{"raw":"https://{{Host}}/api/BIDWHouse/GetSMSTrendFact?PageSize=PageSize-value&resetStartProcessDate=resetStartProcessDate-value","protocol":"https","host":["{{Host}}"],"path":["api","BIDWHouse","GetSMSTrendFact"],"query":[{"key":"PageSize","value":"PageSize-value"},{"key":"resetStartProcessDate","value":"resetStartProcessDate-value"}]},"description":"

\r\n Getting records from SMSTrendFact table.\r\n \n

Response Payload

Name	Type	Description
SMSTrendOutput Description
Errors	List<String>	The List of errors if exist.
Response	Boolean	The call success status .
SMSTrendFacts	List<SMSTrendFact>	List of objects linked to sms campaigns.
SMSTrendFact Description
Name	Type	Description
BookingsMadeIn14Days	Int32
BrandName	String	The brand name ( multibrand instances).
Category	String	The campaign category name.
CategoryID	Int32	The campaign category unique ID.
CostPerItem	Single	The cost per item.
CtcID	Int32	The unique ID for the contact in Atreemo and used to join the various tables.
ModifiedDate	DateTime	The last modification date.
NbUnits	Int32	The number of unit SMS sent, for example if the message was 204 characters the number of units would be 2.
PrjMkgTitle	String	The marketing project title assigned in Atreemo.
SendDate	DateTime	The date time the SMS was scheduled to send.
SenderProfile	String	The Atreemo users sender profile name.
SenderProfileID	Int32	The Atreemo users sender profile unique ID.
SMSItemID	Int32	The unique ID of the SMS Item.
SMSTrendFactID	Int32	Incremental unique ID.
SubmittedBy	String	The Atreemo user who submitted the campaign.

"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"Response\": true,\r\n \"SMSTrendFacts\": [\r\n {\r\n \"SMSTrendFactID\": 1,\r\n \"CtcID\": 2,\r\n \"PrjMkgTitle\": \"sample string 3\",\r\n \"CategoryID\": 4,\r\n \"Category\": \"sample string 5\",\r\n \"SendDate\": \"2026-03-25T07:30:07.8398714+00:00\",\r\n \"SubmittedBy\": \"sample string 7\",\r\n \"SenderProfileID\": 8,\r\n \"SenderProfile\": \"sample string 9\",\r\n \"BrandName\": \"sample string 10\",\r\n \"NbUnits\": 11,\r\n \"CostPerItem\": 12.1,\r\n \"ModifiedDate\": \"2026-03-25T07:30:07.8398714+00:00\",\r\n \"SMSItemID\": 14,\r\n \"BookingsMadeIn14Days\": 15\r\n },\r\n {\r\n \"SMSTrendFactID\": 1,\r\n \"CtcID\": 2,\r\n \"PrjMkgTitle\": \"sample string 3\",\r\n \"CategoryID\": 4,\r\n \"Category\": \"sample string 5\",\r\n \"SendDate\": \"2026-03-25T07:30:07.8398714+00:00\",\r\n \"SubmittedBy\": \"sample string 7\",\r\n \"SenderProfileID\": 8,\r\n \"SenderProfile\": \"sample string 9\",\r\n \"BrandName\": \"sample string 10\",\r\n \"NbUnits\": 11,\r\n \"CostPerItem\": 12.1,\r\n \"ModifiedDate\": \"2026-03-25T07:30:07.8398714+00:00\",\r\n \"SMSItemID\": 14,\r\n \"BookingsMadeIn14Days\": 15\r\n }\r\n ],\r\n \"Errors\": [\r\n \"sample string 1\",\r\n \"sample string 2\"\r\n ]\r\n}"}],"_postman_id":"7b649c56-d638-4e85-81ac-898a0d8b12b5"},{"name":"GetTransactionsFact","id":"60c5c372-25ea-47fd-b69b-7cdb28df1f84","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"https://{{Host}}/api/BIDWHouse/GetTransactionsFact?PageSize=PageSize-value&resetStartProcessDate=resetStartProcessDate-value","description":"

\n Getting records from TransactionsFact table.\n \n

Response Payload

Name	Type	Description
TransactionsFactOutput Description
Errors	List<String>	The list of errors if exist.
Response	Boolean	The call success status.
TransactionsFacts	List<TransactionsFact>	The list of objects associated to transactions linked to a contact.
TransactionsFact Description
Name	Type	Description
AmountPaid	Single	The Amount Paid in this transaction.
CtcID	Int32	The unique contact ID linked to this transaction.
DiscountAmount	Single	The Discount Amount in this transaction.
ModifiedDate	DateTime	The last modification date applied to this transaction.
OrderChannel	String	The transaction Order Channel.Possible Values : InStore OnlineWeb OnlineApp.
OrderDate	DateTime	The date / time of the transaction.
OrderID	String	The transaction OrderID received from the EPOS.
OrderStatus	String	The order status of the transaction. Possible Values: Paid, Cancelled,\n Invoiced, Incomplete, Refunded, PartiallyPaid,
OrderType	String	The order type of the transaction. Possible Values: InStore,\n Collection, Delivery, Shop, PayAtTable, PreOrder.
OrderUniqueID	Int64	Atreemo’s Unique Order ID.
PaidWithPoints	Boolean	If the transaction is paid with points will be true.
SaleType	String	The transaction sale type. Possible Values: Sale, Refund, No Sale, Cancelled Sale,\n Zero Value Sale, Other Actions, Void, Online, Discounted Sale.
SiteID	Int32	The location ID where the transaction was made.
SiteName	String	The location name where the transaction was made.
Source	String	The source name given to the transaction.
TotalSpend	Single	The Total Spend for the transaction.
TransactionsFactID	Int32	Incremental unique ID.
VoucherCode	String	The Voucher Code linked to the transaction (if applicable).

","urlObject":{"protocol":"https","path":["api","BIDWHouse","GetTransactionsFact"],"host":["{{Host}}"],"query":[{"key":"PageSize","value":"PageSize-value"},{"key":"resetStartProcessDate","value":"resetStartProcessDate-value"}],"variable":[]}},"response":[{"id":"a5081bb0-aa23-4872-adaf-ca80b024b611","name":"api/BIDWHouse/GetTransactionsFact?PageSize={PageSize}&resetStartProcessDate={resetStartProcessDate} Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":{"raw":"https://{{Host}}/api/BIDWHouse/GetTransactionsFact?PageSize=PageSize-value&resetStartProcessDate=resetStartProcessDate-value","protocol":"https","host":["{{Host}}"],"path":["api","BIDWHouse","GetTransactionsFact"],"query":[{"key":"PageSize","value":"PageSize-value"},{"key":"resetStartProcessDate","value":"resetStartProcessDate-value"}]},"description":"

\r\n Getting records from TransactionsFact table.\r\n \n

Response Payload

Name	Type	Description
TransactionsFactOutput Description
Errors	List<String>	The list of errors if exist.
Response	Boolean	The call success status.
TransactionsFacts	List<TransactionsFact>	The list of objects associated to transactions linked to a contact.
TransactionsFact Description
Name	Type	Description
AmountPaid	Single	The Amount Paid in this transaction.
CtcID	Int32	The unique contact ID linked to this transaction.
DiscountAmount	Single	The Discount Amount in this transaction.
ModifiedDate	DateTime	The last modification date applied to this transaction.
OrderChannel	String	The transaction Order Channel.Possible Values : InStore OnlineWeb OnlineApp.
OrderDate	DateTime	The date / time of the transaction.
OrderID	String	The transaction OrderID received from the EPOS.
OrderStatus	String	The order status of the transaction. Possible Values: Paid, Cancelled,\n Invoiced, Incomplete, Refunded, PartiallyPaid,
OrderType	String	The order type of the transaction. Possible Values: InStore,\n Collection, Delivery, Shop, PayAtTable, PreOrder.
OrderUniqueID	Int64	Atreemo’s Unique Order ID.
PaidWithPoints	Boolean	If the transaction is paid with points will be true.
SaleType	String	The transaction sale type. Possible Values: Sale, Refund, No Sale, Cancelled Sale,\n Zero Value Sale, Other Actions, Void, Online, Discounted Sale.
SiteID	Int32	The location ID where the transaction was made.
SiteName	String	The location name where the transaction was made.
Source	String	The source name given to the transaction.
TotalSpend	Single	The Total Spend for the transaction.
TransactionsFactID	Int32	Incremental unique ID.
VoucherCode	String	The Voucher Code linked to the transaction (if applicable).

"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"Response\": true,\r\n \"TransactionsFacts\": [\r\n {\r\n \"TransactionsFactID\": 1,\r\n \"CtcID\": 2,\r\n \"VoucherCode\": \"sample string 3\",\r\n \"SiteID\": 4,\r\n \"SiteName\": \"sample string 5\",\r\n \"OrderDate\": \"2026-03-25T07:30:07.8711107+00:00\",\r\n \"TotalSpend\": 7.1,\r\n \"OrderType\": \"sample string 8\",\r\n \"OrderStatus\": \"sample string 9\",\r\n \"AmountPaid\": 10.1,\r\n \"DiscountAmount\": 11.1,\r\n \"SaleType\": \"sample string 12\",\r\n \"OrderID\": \"sample string 13\",\r\n \"OrderChannel\": \"sample string 14\",\r\n \"Source\": \"sample string 15\",\r\n \"PaidWithPoints\": true,\r\n \"ModifiedDate\": \"2026-03-25T07:30:07.8711107+00:00\",\r\n \"OrderUniqueID\": 18\r\n },\r\n {\r\n \"TransactionsFactID\": 1,\r\n \"CtcID\": 2,\r\n \"VoucherCode\": \"sample string 3\",\r\n \"SiteID\": 4,\r\n \"SiteName\": \"sample string 5\",\r\n \"OrderDate\": \"2026-03-25T07:30:07.8711107+00:00\",\r\n \"TotalSpend\": 7.1,\r\n \"OrderType\": \"sample string 8\",\r\n \"OrderStatus\": \"sample string 9\",\r\n \"AmountPaid\": 10.1,\r\n \"DiscountAmount\": 11.1,\r\n \"SaleType\": \"sample string 12\",\r\n \"OrderID\": \"sample string 13\",\r\n \"OrderChannel\": \"sample string 14\",\r\n \"Source\": \"sample string 15\",\r\n \"PaidWithPoints\": true,\r\n \"ModifiedDate\": \"2026-03-25T07:30:07.8711107+00:00\",\r\n \"OrderUniqueID\": 18\r\n }\r\n ],\r\n \"Errors\": [\r\n \"sample string 1\",\r\n \"sample string 2\"\r\n ]\r\n}"}],"_postman_id":"60c5c372-25ea-47fd-b69b-7cdb28df1f84"},{"name":"GetVisitsFact","id":"d658512a-2e21-4e22-902d-324ea1275631","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"https://{{Host}}/api/BIDWHouse/GetVisitsFact?PageSize=PageSize-value&resetStartProcessDate=resetStartProcessDate-value","description":"

\n Getting records from VisitsFact table.\n \n

Response Payload

Name	Type	Description
VisitsFactOutput Description
Errors	List<String>	The List of errors if exist.
Response	Boolean	The call success status.
VisitsFacts	List<VisitsFact>	List of objects linked to visits for a contact.
VisitsFact Description
Name	Type	Description
BrandName	String	The brand name (multibrand instances).
CtcID	Int32	The unique ID for the contact in Atreemo and used to join the various tables.
DirectSpent	Single	The amount direct spent in the visit.
IndirectSpent	Single	The amount of indirect spent in the visit.
ModifiedDate	DateTime	Returns the last modification date.
SiteID	Int32	The visit location ID where the visit was recorded.
SiteName	String	The visit location name where the visit was recorded.
Source	String	The visit source, for example Wifi.
VisitDateTime	DateTime	The visit date time.
VisitsFactID	Int32	Incremental unique ID.

","urlObject":{"protocol":"https","path":["api","BIDWHouse","GetVisitsFact"],"host":["{{Host}}"],"query":[{"key":"PageSize","value":"PageSize-value"},{"key":"resetStartProcessDate","value":"resetStartProcessDate-value"}],"variable":[]}},"response":[{"id":"933f3a24-3fc7-4097-97f7-81bc1a83d437","name":"api/BIDWHouse/GetVisitsFact?PageSize={PageSize}&resetStartProcessDate={resetStartProcessDate} Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":{"raw":"https://{{Host}}/api/BIDWHouse/GetVisitsFact?PageSize=PageSize-value&resetStartProcessDate=resetStartProcessDate-value","protocol":"https","host":["{{Host}}"],"path":["api","BIDWHouse","GetVisitsFact"],"query":[{"key":"PageSize","value":"PageSize-value"},{"key":"resetStartProcessDate","value":"resetStartProcessDate-value"}]},"description":"

\r\n Getting records from VisitsFact table.\r\n \n

Response Payload

Name	Type	Description
VisitsFactOutput Description
Errors	List<String>	The List of errors if exist.
Response	Boolean	The call success status.
VisitsFacts	List<VisitsFact>	List of objects linked to visits for a contact.
VisitsFact Description
Name	Type	Description
BrandName	String	The brand name (multibrand instances).
CtcID	Int32	The unique ID for the contact in Atreemo and used to join the various tables.
DirectSpent	Single	The amount direct spent in the visit.
IndirectSpent	Single	The amount of indirect spent in the visit.
ModifiedDate	DateTime	Returns the last modification date.
SiteID	Int32	The visit location ID where the visit was recorded.
SiteName	String	The visit location name where the visit was recorded.
Source	String	The visit source, for example Wifi.
VisitDateTime	DateTime	The visit date time.
VisitsFactID	Int32	Incremental unique ID.

"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"Response\": true,\r\n \"VisitsFacts\": [\r\n {\r\n \"VisitsFactID\": 1,\r\n \"CtcID\": 2,\r\n \"VisitDateTime\": \"2026-03-25T07:30:07.8867405+00:00\",\r\n \"SiteID\": 4,\r\n \"SiteName\": \"sample string 5\",\r\n \"DirectSpent\": 6.1,\r\n \"IndirectSpent\": 7.1,\r\n \"Source\": \"sample string 8\",\r\n \"ModifiedDate\": \"2026-03-25T07:30:07.8867405+00:00\",\r\n \"BrandName\": \"sample string 10\"\r\n },\r\n {\r\n \"VisitsFactID\": 1,\r\n \"CtcID\": 2,\r\n \"VisitDateTime\": \"2026-03-25T07:30:07.8867405+00:00\",\r\n \"SiteID\": 4,\r\n \"SiteName\": \"sample string 5\",\r\n \"DirectSpent\": 6.1,\r\n \"IndirectSpent\": 7.1,\r\n \"Source\": \"sample string 8\",\r\n \"ModifiedDate\": \"2026-03-25T07:30:07.8867405+00:00\",\r\n \"BrandName\": \"sample string 10\"\r\n }\r\n ],\r\n \"Errors\": [\r\n \"sample string 1\",\r\n \"sample string 2\"\r\n ]\r\n}"}],"_postman_id":"d658512a-2e21-4e22-902d-324ea1275631"},{"name":"GetVouchersFact","id":"06532846-2b72-4c5a-892f-59ef37743b38","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"https://{{Host}}/api/BIDWHouse/GetVouchersFact?PageSize=PageSize-value&resetStartProcessDate=resetStartProcessDate-value","description":"

\n Getting records from VouchersFact table.\n \n

Response Payload

Name	Type	Description
VouchersFactOutput Description
Errors	List<String>	The List of errors if exist.
Response	Boolean	The call success status.
VouchersFacts	List<VouchersFact>	List of objects linked to voucher and contacts.
VouchersFact Description
Name	Type	Description
Category	String	The voucher category name.
CategoryID	Int32	The voucher category ID.
CtcID	Int32	The unique ID for the contact in Atreemo and used to join the various tables.
Disabled	Boolean	If True the voucher code has been disabled.
IssuedDate	DateTime (nullable)	The voucher issued date.
ModifiedDate	DateTime	The last modification date for the voucher.
OfferCode	String	The voucher offer code sent to the customer.
OfferID	Int32	The Atreemo voucher offer ID.
OrderAmount	Single	The voucher order amount.
Redeemed	Boolean	If True the code has been redeemed.
RedemptionAmount	Single	The voucher redemption amount (if redeemed = True).
RedemptionDate	DateTime (nullable)	The voucher redemption date / time (if redeemed = True).
RedemptionLocation	String	The voucher redemption location name (if redeemed = True).
RedemptionLocationID	Int64	The voucher redemption location ID (if redeemed = True).
SubCategory	String	The subcategory linked to the issued voucher.
SubCategoryID	Int32	The Subcategory ID linked to the issued voucher.
Title	String	The name given to the voucher in Atreemo.
VoucherCode	String	The Voucher code issued to the contact.
VoucherCreatedDate	DateTime	The date the voucher was set up in Atreemo.
VoucherExpiryDate	DateTime (nullable)	The voucher expiration date.
VouchersFactID	Int32	Incremental unique ID.

","urlObject":{"protocol":"https","path":["api","BIDWHouse","GetVouchersFact"],"host":["{{Host}}"],"query":[{"key":"PageSize","value":"PageSize-value"},{"key":"resetStartProcessDate","value":"resetStartProcessDate-value"}],"variable":[]}},"response":[{"id":"b2b65b2b-0904-40df-9632-c4aa3c62abd6","name":"api/BIDWHouse/GetVouchersFact?PageSize={PageSize}&resetStartProcessDate={resetStartProcessDate} Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":{"raw":"https://{{Host}}/api/BIDWHouse/GetVouchersFact?PageSize=PageSize-value&resetStartProcessDate=resetStartProcessDate-value","protocol":"https","host":["{{Host}}"],"path":["api","BIDWHouse","GetVouchersFact"],"query":[{"key":"PageSize","value":"PageSize-value"},{"key":"resetStartProcessDate","value":"resetStartProcessDate-value"}]},"description":"

\r\n Getting records from VouchersFact table.\r\n \n

Response Payload

Name	Type	Description
VouchersFactOutput Description
Errors	List<String>	The List of errors if exist.
Response	Boolean	The call success status.
VouchersFacts	List<VouchersFact>	List of objects linked to voucher and contacts.
VouchersFact Description
Name	Type	Description
Category	String	The voucher category name.
CategoryID	Int32	The voucher category ID.
CtcID	Int32	The unique ID for the contact in Atreemo and used to join the various tables.
Disabled	Boolean	If True the voucher code has been disabled.
IssuedDate	DateTime (nullable)	The voucher issued date.
ModifiedDate	DateTime	The last modification date for the voucher.
OfferCode	String	The voucher offer code sent to the customer.
OfferID	Int32	The Atreemo voucher offer ID.
OrderAmount	Single	The voucher order amount.
Redeemed	Boolean	If True the code has been redeemed.
RedemptionAmount	Single	The voucher redemption amount (if redeemed = True).
RedemptionDate	DateTime (nullable)	The voucher redemption date / time (if redeemed = True).
RedemptionLocation	String	The voucher redemption location name (if redeemed = True).
RedemptionLocationID	Int64	The voucher redemption location ID (if redeemed = True).
SubCategory	String	The subcategory linked to the issued voucher.
SubCategoryID	Int32	The Subcategory ID linked to the issued voucher.
Title	String	The name given to the voucher in Atreemo.
VoucherCode	String	The Voucher code issued to the contact.
VoucherCreatedDate	DateTime	The date the voucher was set up in Atreemo.
VoucherExpiryDate	DateTime (nullable)	The voucher expiration date.
VouchersFactID	Int32	Incremental unique ID.

"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"Response\": true,\r\n \"VouchersFacts\": [\r\n {\r\n \"VouchersFactID\": 1,\r\n \"CtcID\": 2,\r\n \"Title\": \"sample string 3\",\r\n \"VoucherCode\": \"sample string 4\",\r\n \"OfferID\": 5,\r\n \"OfferCode\": \"sample string 6\",\r\n \"Disabled\": true,\r\n \"Redeemed\": true,\r\n \"VoucherCreatedDate\": \"2026-03-25T07:30:07.9023618+00:00\",\r\n \"VoucherExpiryDate\": \"2026-03-25T07:30:07.9023618+00:00\",\r\n \"RedemptionDate\": \"2026-03-25T07:30:07.9023618+00:00\",\r\n \"RedemptionLocationID\": 10,\r\n \"RedemptionLocation\": \"sample string 11\",\r\n \"RedemptionAmount\": 12.1,\r\n \"CategoryID\": 13,\r\n \"Category\": \"sample string 14\",\r\n \"SubCategoryID\": 15,\r\n \"SubCategory\": \"sample string 16\",\r\n \"OrderAmount\": 17.1,\r\n \"IssuedDate\": \"2026-03-25T07:30:07.9023618+00:00\",\r\n \"ModifiedDate\": \"2026-03-25T07:30:07.9023618+00:00\"\r\n },\r\n {\r\n \"VouchersFactID\": 1,\r\n \"CtcID\": 2,\r\n \"Title\": \"sample string 3\",\r\n \"VoucherCode\": \"sample string 4\",\r\n \"OfferID\": 5,\r\n \"OfferCode\": \"sample string 6\",\r\n \"Disabled\": true,\r\n \"Redeemed\": true,\r\n \"VoucherCreatedDate\": \"2026-03-25T07:30:07.9023618+00:00\",\r\n \"VoucherExpiryDate\": \"2026-03-25T07:30:07.9023618+00:00\",\r\n \"RedemptionDate\": \"2026-03-25T07:30:07.9023618+00:00\",\r\n \"RedemptionLocationID\": 10,\r\n \"RedemptionLocation\": \"sample string 11\",\r\n \"RedemptionAmount\": 12.1,\r\n \"CategoryID\": 13,\r\n \"Category\": \"sample string 14\",\r\n \"SubCategoryID\": 15,\r\n \"SubCategory\": \"sample string 16\",\r\n \"OrderAmount\": 17.1,\r\n \"IssuedDate\": \"2026-03-25T07:30:07.9023618+00:00\",\r\n \"ModifiedDate\": \"2026-03-25T07:30:07.9023618+00:00\"\r\n }\r\n ],\r\n \"Errors\": [\r\n \"sample string 1\",\r\n \"sample string 2\"\r\n ]\r\n}"}],"_postman_id":"06532846-2b72-4c5a-892f-59ef37743b38"},{"name":"Post","id":"510bcfa4-2a78-4d17-99a8-3e7cea6a4928","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"TableName\": \"sample string 1\",\r\n \"StartDate\": \"2026-03-25T07:30:07.9336281+00:00\"\r\n}"},"url":"https://{{Host}}/api/BIDWHouse/Post","description":"

\n Set the initial date for when data from each fact table will be retrieved.\n \n

Body Payload

Name	Type	Description	Required
BIDWHouseInput Description
StartDate	DateTime	The Date from which to get records.	True
TableName	String	Below the name of the fact tables :\n ContactDetailsFact\n ContactPreferencesFact\n EmailTrendFact\n LoyaltyPointsFact\n PushNotificationsTrendFact\n SMSTrendFact\n TransactionsFact\n VisitsFact\n VouchersFact\n ContactsSourcesFact\n LeadsFact\n BookingsFact\n HotelBookingsFact	True

Response Payload

Name	Type	Description
BIDWHouseOutput Description
errors	List<String>	The list of errors if exist.
response	Boolean	The call success status.

","urlObject":{"protocol":"https","path":["api","BIDWHouse","Post"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"4468f671-c04f-467e-8e3c-9a9982eeec87","name":"api/BIDWHouse/Post Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"TableName\": \"sample string 1\",\r\n \"StartDate\": \"2026-03-25T07:30:07.9336281+00:00\"\r\n}"},"url":"https://{{Host}}/api/BIDWHouse/Post","description":"

\r\n Set the initial date for when data from each fact table will be retrieved.\r\n \n

Body Payload

Name	Type	Description	Required
BIDWHouseInput Description
StartDate	DateTime	The Date from which to get records.	True
TableName	String	Below the name of the fact tables :\n ContactDetailsFact\n ContactPreferencesFact\n EmailTrendFact\n LoyaltyPointsFact\n PushNotificationsTrendFact\n SMSTrendFact\n TransactionsFact\n VisitsFact\n VouchersFact\n ContactsSourcesFact\n LeadsFact\n BookingsFact\n HotelBookingsFact	True

Response Payload

Name	Type	Description
BIDWHouseOutput Description
errors	List<String>	The list of errors if exist.
response	Boolean	The call success status.

"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"response\": true,\r\n \"errors\": [\r\n \"sample string 1\",\r\n \"sample string 2\"\r\n ]\r\n}"}],"_postman_id":"510bcfa4-2a78-4d17-99a8-3e7cea6a4928"}],"id":"29b4076c-670f-4ad0-bbe2-4e34017a5829","description":"

Api Methods for BIDWHouse
Please follow the steps below to retrieve the BI data:
Below are the names of the fact tables you will be able to access.The data in each table is updated once a day. Please note some data feeds may be sent to Atreemo every 24 hours so there could be a 24-48 delay in some records being updated:

ContactDetailsFact – Details for all the contacts in the database

ContactPreferencesFact – The marketing opt in preferences for the contacts, i.e.email opt in

EmailTrendFact – Details for any emails the contacts have received

LoyaltyPointsFact – Details the loyalty transactions linked to a contact

PushNotificationsTrendFact – Details for any push notifications the contacts have received

SMSTrendFact – Details for any text messages the contacts have received

TransactionsFact – Details transactions that are linked to a contact

VisitsFact – Summarises all the visits linked to a contact

VouchersFact – Details vouchers issued and redeemed for contacts

ContactsSourcesFact – Includes all the data sources linked to a contact.The main ContactDetailsFact table will always return the original source, whereas this table will include all the data sources.

You are able to make successive calls to each table, when you get an empty list, you will have the full data set.
The data will start from the date you defined in the original set call (Post).If you don’t include the date in the first post call, the date will start from first row in the table (the oldest record).
You do not need to recall the Set method in subsequent calls, the batch ID is auto-incremented for each call.
The batch size is defaulted to 5,000 but can be extended to 100,000 by using the PageSize parameter in the Get method.The response time will be defined by the size of the batch requested.

\n","_postman_id":"29b4076c-670f-4ad0-bbe2-4e34017a5829"},{"name":"CampaignApi","item":[{"name":"DispatchCampaignElements","id":"658be7f9-b63d-4a4c-a419-34ba0c159b70","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"CampaignID\": 1,\r\n \"ListOfRecipients\": [\r\n {\r\n \"ChannelID\": 1,\r\n \"SendDate\": \"2026-03-25T07:30:07.9492317+00:00\",\r\n \"ChannelFieldValue\": \"sample string 3\",\r\n \"CtcID\": 4,\r\n \"MemberID\": 1,\r\n \"PersonalizedFields\": [\r\n {\r\n \"FieldName\": \"sample string 1\",\r\n \"FieldValue\": \"sample string 2\"\r\n },\r\n {\r\n \"FieldName\": \"sample string 1\",\r\n \"FieldValue\": \"sample string 2\"\r\n }\r\n ]\r\n },\r\n {\r\n \"ChannelID\": 1,\r\n \"SendDate\": \"2026-03-25T07:30:07.9492317+00:00\",\r\n \"ChannelFieldValue\": \"sample string 3\",\r\n \"CtcID\": 4,\r\n \"MemberID\": 1,\r\n \"PersonalizedFields\": [\r\n {\r\n \"FieldName\": \"sample string 1\",\r\n \"FieldValue\": \"sample string 2\"\r\n },\r\n {\r\n \"FieldName\": \"sample string 1\",\r\n \"FieldValue\": \"sample string 2\"\r\n }\r\n ]\r\n }\r\n ]\r\n}"},"url":"https://{{Host}}/api/CampaignApi/DispatchCampaignElements","description":"

\n Send Campaign Elements\n \n

Body Payload

Name	Type	Description	Required
DispatchCampainElementInput Description
CampaignID	Int32		True
ListOfRecipients	List<Recipient>		True
Recipient Description
Name	Type	Description	Required
ChannelFieldValue	String		True
ChannelID	Int32		True
CtcID	Int32	The ID of the contact\n Mandatory when the channel type is custom list	False
MemberID	Int32 (nullable)	The MemberID of the contact	False
PersonalizedFields	List<PersonalizedField>	Collection of the personalized fields	False
SendDate	DateTime	Send date(When empty the email should be sent immediately)	False
PersonalizedField Description
Name	Type	Description	Required
FieldName	String	Field name	False
FieldValue	String	Field Value	False

","urlObject":{"protocol":"https","path":["api","CampaignApi","DispatchCampaignElements"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"19e89599-49b7-487f-9267-915a0376b886","name":"api/CampaignApi/DispatchCampaignElements Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"CampaignID\": 1,\r\n \"ListOfRecipients\": [\r\n {\r\n \"ChannelID\": 1,\r\n \"SendDate\": \"2026-03-25T07:30:07.9492317+00:00\",\r\n \"ChannelFieldValue\": \"sample string 3\",\r\n \"CtcID\": 4,\r\n \"MemberID\": 1,\r\n \"PersonalizedFields\": [\r\n {\r\n \"FieldName\": \"sample string 1\",\r\n \"FieldValue\": \"sample string 2\"\r\n },\r\n {\r\n \"FieldName\": \"sample string 1\",\r\n \"FieldValue\": \"sample string 2\"\r\n }\r\n ]\r\n },\r\n {\r\n \"ChannelID\": 1,\r\n \"SendDate\": \"2026-03-25T07:30:07.9492317+00:00\",\r\n \"ChannelFieldValue\": \"sample string 3\",\r\n \"CtcID\": 4,\r\n \"MemberID\": 1,\r\n \"PersonalizedFields\": [\r\n {\r\n \"FieldName\": \"sample string 1\",\r\n \"FieldValue\": \"sample string 2\"\r\n },\r\n {\r\n \"FieldName\": \"sample string 1\",\r\n \"FieldValue\": \"sample string 2\"\r\n }\r\n ]\r\n }\r\n ]\r\n}"},"url":"https://{{Host}}/api/CampaignApi/DispatchCampaignElements","description":"

\r\n Send Campaign Elements\r\n \n

Body Payload

Name	Type	Description	Required
DispatchCampainElementInput Description
CampaignID	Int32		True
ListOfRecipients	List<Recipient>		True
Recipient Description
Name	Type	Description	Required
ChannelFieldValue	String		True
ChannelID	Int32		True
CtcID	Int32	The ID of the contact\n Mandatory when the channel type is custom list	False
MemberID	Int32 (nullable)	The MemberID of the contact	False
PersonalizedFields	List<PersonalizedField>	Collection of the personalized fields	False
SendDate	DateTime	Send date(When empty the email should be sent immediately)	False
PersonalizedField Description
Name	Type	Description	Required
FieldName	String	Field name	False
FieldValue	String	Field Value	False

"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"658be7f9-b63d-4a4c-a419-34ba0c159b70"}],"id":"72463196-f435-45e5-8ba4-cdce11ea0ce9","description":"

Api Methods for CampaignApi

\n","_postman_id":"72463196-f435-45e5-8ba4-cdce11ea0ce9"},{"name":"CommunicationPreference","item":[{"name":"Get","id":"8a81e4d6-5f0c-4dc0-a0bc-3e3e89292bd0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"https://{{Host}}/api/CommunicationPreference/Get?customerid=customerid-value","description":"

\n Get the communication preferences of the requested customer\n \n

Response Payload

Name	Type	Description
CommsPreferenceOutput Description
EmailOptin	Boolean (nullable)	True if would receive an Email
MailOptin	Boolean (nullable)	True if would receive a mail
PhoneOptin	Boolean (nullable)	True if would receive a call
PushNotificationOptin	Boolean (nullable)
SmsOptin	Boolean (nullable)	True if would receive an Sms
WebPushNotificationOptin	Boolean (nullable)	True if would receive a Web notification
WhatsAppOptin	Boolean (nullable)

","urlObject":{"protocol":"https","path":["api","CommunicationPreference","Get"],"host":["{{Host}}"],"query":[{"key":"customerid","value":"customerid-value"}],"variable":[]}},"response":[{"id":"47d2cccb-38e9-4e5f-9cf6-6eb72a929a5a","name":"api/CommunicationPreference/Get?customerid={customerid} Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":{"raw":"https://{{Host}}/api/CommunicationPreference/Get?customerid=customerid-value","protocol":"https","host":["{{Host}}"],"path":["api","CommunicationPreference","Get"],"query":[{"key":"customerid","value":"customerid-value"}]},"description":"

\r\n Get the communication preferences of the requested customer\r\n \n

Response Payload

Name	Type	Description
CommsPreferenceOutput Description
EmailOptin	Boolean (nullable)	True if would receive an Email
MailOptin	Boolean (nullable)	True if would receive a mail
PhoneOptin	Boolean (nullable)	True if would receive a call
PushNotificationOptin	Boolean (nullable)
SmsOptin	Boolean (nullable)	True if would receive an Sms
WebPushNotificationOptin	Boolean (nullable)	True if would receive a Web notification
WhatsAppOptin	Boolean (nullable)

\n Get the communication preferences of the requested customer\n \n

Response Payload

Name	Type	Description
CommsPreferenceOutput Description
EmailOptin	Boolean (nullable)	True if would receive an Email
MailOptin	Boolean (nullable)	True if would receive a mail
PhoneOptin	Boolean (nullable)	True if would receive a call
PushNotificationOptin	Boolean (nullable)
SmsOptin	Boolean (nullable)	True if would receive an Sms
WebPushNotificationOptin	Boolean (nullable)	True if would receive a Web notification
WhatsAppOptin	Boolean (nullable)

","urlObject":{"protocol":"https","path":["api","CommunicationPreference","Get"],"host":["{{Host}}"],"query":[{"key":"customerid","value":"customerid-value"},{"key":"BrandID","value":"BrandID-value"}],"variable":[]}},"response":[{"id":"531b56f0-716d-4c87-9053-6a18976a3700","name":"api/CommunicationPreference/Get?customerid={customerid}&BrandID={BrandID} Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":{"raw":"https://{{Host}}/api/CommunicationPreference/Get?customerid=customerid-value&BrandID=BrandID-value","protocol":"https","host":["{{Host}}"],"path":["api","CommunicationPreference","Get"],"query":[{"key":"customerid","value":"customerid-value"},{"key":"BrandID","value":"BrandID-value"}]},"description":"

\r\n Get the communication preferences of the requested customer\r\n \n

Response Payload

Name	Type	Description
CommsPreferenceOutput Description
EmailOptin	Boolean (nullable)	True if would receive an Email
MailOptin	Boolean (nullable)	True if would receive a mail
PhoneOptin	Boolean (nullable)	True if would receive a call
PushNotificationOptin	Boolean (nullable)
SmsOptin	Boolean (nullable)	True if would receive an Sms
WebPushNotificationOptin	Boolean (nullable)	True if would receive a Web notification
WhatsAppOptin	Boolean (nullable)

"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"EmailOptin\": true,\r\n \"SmsOptin\": true,\r\n \"MailOptin\": true,\r\n \"PhoneOptin\": true,\r\n \"PushNotificationOptin\": true,\r\n \"WhatsAppOptin\": true,\r\n \"WebPushNotificationOptin\": true\r\n}"}],"_postman_id":"e820823b-f197-4c5a-8001-24706ff883f8"},{"name":"Post","id":"3cde5184-6d41-4c06-950a-4c4e98545d96","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"CustomerID\": 1,\r\n \"EmailOptin\": true,\r\n \"SmsOptin\": true,\r\n \"MailOptin\": true,\r\n \"PhoneOptin\": true,\r\n \"ChangeDate\": \"2026-03-25T07:30:07.9648287+00:00\",\r\n \"SourceID\": \"sample string 2\",\r\n \"BrandID\": 1,\r\n \"SupInfo\": [\r\n {\r\n \"FieldName\": \"sample string 1\",\r\n \"FieldContent\": \"sample string 4\"\r\n },\r\n {\r\n \"FieldName\": \"sample string 1\",\r\n \"FieldContent\": \"sample string 4\"\r\n }\r\n ],\r\n \"PushNotificationOptin\": true,\r\n \"WebPushNotificationOptin\": true\r\n}"},"url":"https://{{Host}}/api/CommunicationPreference/Post","description":"

\n Set the communication preferences of the requested customer\n \n

Body Payload

Name	Type	Description	Required
CommsPreferenceInput Description
BrandID	Int32 (nullable)	The brand ID where the change should be applied	False
ChangeDate	DateTime (nullable)	Change date (current date if empty)	False
CustomerID	Int32	The unique identifier of the customer in CRM side (CtcID).	True
EmailOptin	Boolean (nullable)	True if would receive an email	False
MailOptin	Boolean (nullable)	True if would receive a mail	False
PhoneOptin	Boolean (nullable)	True if would receive a call	False
PushNotificationOptin	Boolean (nullable)	True if would receive a mobile app push notification	False
SmsOptin	Boolean (nullable)	True if would receive an Sms	False
SourceID	String		True
SupInfo	List<SupInfo>	Collection of contact supplementary information	False
WebPushNotificationOptin	Boolean (nullable)	True if would receive a mobile app push notification	False
SupInfo Description
Name	Type	Description	Required
FieldContent	String	Field value	False
FieldName	String	Field name	False

Response Payload

Name	Type	Description
ApiOutput Description
Error	String	Error description
Response	Boolean	The status call

","urlObject":{"protocol":"https","path":["api","CommunicationPreference","Post"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"7b1f21cf-7dca-40bb-9db3-2e3b3fe1d40c","name":"api/CommunicationPreference/Post Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"CustomerID\": 1,\r\n \"EmailOptin\": true,\r\n \"SmsOptin\": true,\r\n \"MailOptin\": true,\r\n \"PhoneOptin\": true,\r\n \"ChangeDate\": \"2026-03-25T07:30:07.9648287+00:00\",\r\n \"SourceID\": \"sample string 2\",\r\n \"BrandID\": 1,\r\n \"SupInfo\": [\r\n {\r\n \"FieldName\": \"sample string 1\",\r\n \"FieldContent\": \"sample string 4\"\r\n },\r\n {\r\n \"FieldName\": \"sample string 1\",\r\n \"FieldContent\": \"sample string 4\"\r\n }\r\n ],\r\n \"PushNotificationOptin\": true,\r\n \"WebPushNotificationOptin\": true\r\n}"},"url":"https://{{Host}}/api/CommunicationPreference/Post","description":"

\r\n Set the communication preferences of the requested customer\r\n \n

Body Payload

Name	Type	Description	Required
CommsPreferenceInput Description
BrandID	Int32 (nullable)	The brand ID where the change should be applied	False
ChangeDate	DateTime (nullable)	Change date (current date if empty)	False
CustomerID	Int32	The unique identifier of the customer in CRM side (CtcID).	True
EmailOptin	Boolean (nullable)	True if would receive an email	False
MailOptin	Boolean (nullable)	True if would receive a mail	False
PhoneOptin	Boolean (nullable)	True if would receive a call	False
PushNotificationOptin	Boolean (nullable)	True if would receive a mobile app push notification	False
SmsOptin	Boolean (nullable)	True if would receive an Sms	False
SourceID	String		True
SupInfo	List<SupInfo>	Collection of contact supplementary information	False
WebPushNotificationOptin	Boolean (nullable)	True if would receive a mobile app push notification	False
SupInfo Description
Name	Type	Description	Required
FieldContent	String	Field value	False
FieldName	String	Field name	False

Response Payload

Name	Type	Description
ApiOutput Description
Error	String	Error description
Response	Boolean	The status call

"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"Response\": true,\r\n \"Error\": \"sample string 2\"\r\n}"}],"_postman_id":"3cde5184-6d41-4c06-950a-4c4e98545d96"},{"name":"PostEmailOptin","id":"7dcbf3b5-b1e7-40d2-8122-f700c68035f6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"Email\": \"sample string 1\",\r\n \"EmailOptin\": true,\r\n \"ChangeDate\": \"2026-03-25T07:30:07.9804872+00:00\",\r\n \"SourceID\": \"sample string 2\",\r\n \"Brand\": \"sample string 3\",\r\n \"IsHardBounce\": true\r\n}"},"url":"https://{{Host}}/api/CommunicationPreference/PostEmailOptin","description":"

\n Post preferences of know contact\n \n

Body Payload

Name	Type	Description	Required
PostEmailOptinInput Description
Brand	String	Brand name	False
ChangeDate	DateTime (nullable)	Change date (current date if empty)	False
Email	String	The unique identifier of the customer in CRM side.	True
EmailOptin	Boolean (nullable)	True if would receive an email	False
IsHardBounce	Boolean	if the value is true the EmailOptin field will be ignored.	False
SourceID	String	The source of the change	False

Response Payload

Name	Type	Description
ApiOutput Description
Error	String	Error description
Response	Boolean	The status call

","urlObject":{"protocol":"https","path":["api","CommunicationPreference","PostEmailOptin"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"fcba5589-3173-4c77-bb23-690fe85edd44","name":"api/CommunicationPreference/PostEmailOptin Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"Email\": \"sample string 1\",\r\n \"EmailOptin\": true,\r\n \"ChangeDate\": \"2026-03-25T07:30:07.9804872+00:00\",\r\n \"SourceID\": \"sample string 2\",\r\n \"Brand\": \"sample string 3\",\r\n \"IsHardBounce\": true\r\n}"},"url":"https://{{Host}}/api/CommunicationPreference/PostEmailOptin","description":"

\r\n Post preferences of know contact\r\n \n

Body Payload

Name	Type	Description	Required
PostEmailOptinInput Description
Brand	String	Brand name	False
ChangeDate	DateTime (nullable)	Change date (current date if empty)	False
Email	String	The unique identifier of the customer in CRM side.	True
EmailOptin	Boolean (nullable)	True if would receive an email	False
IsHardBounce	Boolean	if the value is true the EmailOptin field will be ignored.	False
SourceID	String	The source of the change	False

Response Payload

Name	Type	Description
ApiOutput Description
Error	String	Error description
Response	Boolean	The status call

"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"Response\": true,\r\n \"Error\": \"sample string 2\"\r\n}"}],"_postman_id":"7dcbf3b5-b1e7-40d2-8122-f700c68035f6"},{"name":"PostSmsOptin","id":"cdbabc15-ad3f-439a-89f1-6c95af1ee43a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"MobileNumber\": \"sample string 1\",\r\n \"SmsOptin\": true,\r\n \"ChangeDate\": \"2026-03-25T07:30:07.9804872+00:00\",\r\n \"SourceID\": \"sample string 2\",\r\n \"Brand\": \"sample string 3\"\r\n}"},"url":"https://{{Host}}/api/CommunicationPreference/PostSmsOptin","description":"

Body Payload

Name	Type	Description	Required
PostSmsOptinInput Description
Brand	String	Brand ID	False
ChangeDate	DateTime (nullable)	Change date (current date if empty)	False
MobileNumber	String	The unique identifier of the customer in CRM side.	True
SmsOptin	Boolean (nullable)	True if would receive an SMS	False
SourceID	String	The source of the change	False

Response Payload

Name	Type	Description
ApiOutput Description
Error	String	Error description
Response	Boolean	The status call

","urlObject":{"protocol":"https","path":["api","CommunicationPreference","PostSmsOptin"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"3a9ca6f5-7929-467a-a287-6f361d639861","name":"api/CommunicationPreference/PostSmsOptin Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"MobileNumber\": \"sample string 1\",\r\n \"SmsOptin\": true,\r\n \"ChangeDate\": \"2026-03-25T07:30:07.9804872+00:00\",\r\n \"SourceID\": \"sample string 2\",\r\n \"Brand\": \"sample string 3\"\r\n}"},"url":"https://{{Host}}/api/CommunicationPreference/PostSmsOptin","description":"

Body Payload

Name	Type	Description	Required
PostSmsOptinInput Description
Brand	String	Brand ID	False
ChangeDate	DateTime (nullable)	Change date (current date if empty)	False
MobileNumber	String	The unique identifier of the customer in CRM side.	True
SmsOptin	Boolean (nullable)	True if would receive an SMS	False
SourceID	String	The source of the change	False

Response Payload

Name	Type	Description
ApiOutput Description
Error	String	Error description
Response	Boolean	The status call

"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"Response\": true,\r\n \"Error\": \"sample string 2\"\r\n}"}],"_postman_id":"cdbabc15-ad3f-439a-89f1-6c95af1ee43a"}],"id":"38d873ac-3971-4f00-bd9b-25295b7b578b","description":"

Api Methods for CommunicationPreference

\n","_postman_id":"38d873ac-3971-4f00-bd9b-25295b7b578b"},{"name":"Company","item":[{"name":"AddComment","id":"c8871763-df91-49f6-8db6-aed1bd6658e5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"CtcCpyID\": 1,\r\n \"NoteUserID\": 2,\r\n \"SourceNote\": 3,\r\n \"Comment\": \"sample string 4\",\r\n \"LastModifiedBy\": \"sample string 5\",\r\n \"LastModifiedOn\": \"2026-03-25T07:30:08.0429929+00:00\",\r\n \"AttachmentFilesList\": [\r\n {\r\n \"k__BackingField\": \"sample string 1\",\r\n \"k__BackingField\": \"sample string 2\",\r\n \"k__BackingField\": \"sample string 3\",\r\n \"k__BackingField\": \"sample string 4\",\r\n \"k__BackingField\": \"sample string 5\",\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": true\r\n },\r\n {\r\n \"k__BackingField\": \"sample string 1\",\r\n \"k__BackingField\": \"sample string 2\",\r\n \"k__BackingField\": \"sample string 3\",\r\n \"k__BackingField\": \"sample string 4\",\r\n \"k__BackingField\": \"sample string 5\",\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": true\r\n }\r\n ],\r\n \"AttachmentFilesListString\": [\r\n \"sample string 1\",\r\n \"sample string 2\"\r\n ]\r\n}"},"url":"https://{{Host}}/api/Company/AddComment","description":"

Body Payload

Name	Type	Description	Required
CtcCpyNotes Description
AttachmentFilesList	List<Attachment>		False
AttachmentFilesListString	List<String>		False
Comment	String	Comment Text	False
CtcCpyID	Int32	Contact ID	False
LastModifiedBy	String		False
LastModifiedOn	DateTime		False
NoteUserID	Int32		False
SourceNote	Int32		False
Attachment Description
Name	Type	Description	Required
AttachmentID	String		False
AttachmentName	String		False
ContentType	String		False
FileContent	String		False
FileName	String		False
FileSize	Int32 (nullable)		False
HasContent	Boolean		False
ID	Int32 (nullable)		False

","urlObject":{"protocol":"https","path":["api","Company","AddComment"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"69bedc7f-2457-442d-899c-37bc854fa394","name":"api/Company/AddComment Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"CtcCpyID\": 1,\r\n \"NoteUserID\": 2,\r\n \"SourceNote\": 3,\r\n \"Comment\": \"sample string 4\",\r\n \"LastModifiedBy\": \"sample string 5\",\r\n \"LastModifiedOn\": \"2026-03-25T07:30:08.0429929+00:00\",\r\n \"AttachmentFilesList\": [\r\n {\r\n \"k__BackingField\": \"sample string 1\",\r\n \"k__BackingField\": \"sample string 2\",\r\n \"k__BackingField\": \"sample string 3\",\r\n \"k__BackingField\": \"sample string 4\",\r\n \"k__BackingField\": \"sample string 5\",\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": true\r\n },\r\n {\r\n \"k__BackingField\": \"sample string 1\",\r\n \"k__BackingField\": \"sample string 2\",\r\n \"k__BackingField\": \"sample string 3\",\r\n \"k__BackingField\": \"sample string 4\",\r\n \"k__BackingField\": \"sample string 5\",\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": true\r\n }\r\n ],\r\n \"AttachmentFilesListString\": [\r\n \"sample string 1\",\r\n \"sample string 2\"\r\n ]\r\n}"},"url":"https://{{Host}}/api/Company/AddComment","description":"

Body Payload

Name	Type	Description	Required
CtcCpyNotes Description
AttachmentFilesList	List<Attachment>		False
AttachmentFilesListString	List<String>		False
Comment	String	Comment Text	False
CtcCpyID	Int32	Contact ID	False
LastModifiedBy	String		False
LastModifiedOn	DateTime		False
NoteUserID	Int32		False
SourceNote	Int32		False
Attachment Description
Name	Type	Description	Required
AttachmentID	String		False
AttachmentName	String		False
ContentType	String		False
FileContent	String		False
FileName	String		False
FileSize	Int32 (nullable)		False
HasContent	Boolean		False
ID	Int32 (nullable)		False

"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"c8871763-df91-49f6-8db6-aed1bd6658e5"},{"name":"DeleteCompany","id":"3811d0f5-6cb2-447a-ab31-abb578661f0b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{Host}}/api/Company/DeleteCompany/:id","description":"

\n Delete an existing Household/Company by its CpyID\n \n

Body Payload

Response Payload

Name	Type	Description
Company Description
Building	String	Address 1
City	String	City
CountryCode	String
CountryName	String
CpyID	Int32	Houshold ID in B2C intance\n Company ID in B2B intance
CpyNotes	CtcCpyNotes
CreateDate	DateTime (nullable)
Email	String
Fax	String
LastModifDate	DateTime (nullable)
ModifiedBy	Int32 (nullable)
Name	String	Houshold name in B2C intance\n Company name in B2B intance
NationalID	String
OriginID	String
Phone	String
PostCode	String	Postcode
SourceID	String
StateCode	String	StateCode
StateName	String	County
Street	String	Address 2
SupInfo	List<SupInfo>
Web	String
Zone	String	Address 3
CtcCpyNotes Description
Name	Type	Description
AttachmentFilesList	List<Attachment>
AttachmentFilesListString	List<String>
Comment	String	Comment Text
CtcCpyID	Int32	Contact ID
LastModifiedBy	String
LastModifiedOn	DateTime
NoteUserID	Int32
SourceNote	Int32
Attachment Description
Name	Type	Description
AttachmentID	String
AttachmentName	String
ContentType	String
FileContent	String
FileName	String
FileSize	Int32 (nullable)
HasContent	Boolean
ID	Int32 (nullable)
SupInfo Description
Name	Type	Description
FieldContent	String	Field value
FieldName	String	Field name

","urlObject":{"protocol":"https","path":["api","Company","DeleteCompany",":id"],"host":["{{Host}}"],"query":[],"variable":[{"id":"2f42f56f-f2b1-43dc-b3a1-b3faf10db81d","type":"any","key":"id"}]}},"response":[{"id":"2f0cc9ea-7f27-4a0a-8cf5-a8f69ae978bc","name":"api/Company/DeleteCompany/{id} Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://{{Host}}/api/Company/DeleteCompany/:id","protocol":"https","host":["{{Host}}"],"path":["api","Company","DeleteCompany",":id"],"variable":[{"key":"id"}]},"description":"

\r\n Delete an existing Household/Company by its CpyID\r\n \n

Body Payload

Response Payload

Name	Type	Description
Company Description
Building	String	Address 1
City	String	City
CountryCode	String
CountryName	String
CpyID	Int32	Houshold ID in B2C intance\n Company ID in B2B intance
CpyNotes	CtcCpyNotes
CreateDate	DateTime (nullable)
Email	String
Fax	String
LastModifDate	DateTime (nullable)
ModifiedBy	Int32 (nullable)
Name	String	Houshold name in B2C intance\n Company name in B2B intance
NationalID	String
OriginID	String
Phone	String
PostCode	String	Postcode
SourceID	String
StateCode	String	StateCode
StateName	String	County
Street	String	Address 2
SupInfo	List<SupInfo>
Web	String
Zone	String	Address 3
CtcCpyNotes Description
Name	Type	Description
AttachmentFilesList	List<Attachment>
AttachmentFilesListString	List<String>
Comment	String	Comment Text
CtcCpyID	Int32	Contact ID
LastModifiedBy	String
LastModifiedOn	DateTime
NoteUserID	Int32
SourceNote	Int32
Attachment Description
Name	Type	Description
AttachmentID	String
AttachmentName	String
ContentType	String
FileContent	String
FileName	String
FileSize	Int32 (nullable)
HasContent	Boolean
ID	Int32 (nullable)
SupInfo Description
Name	Type	Description
FieldContent	String	Field value
FieldName	String	Field name

\n Search the database for one Household/Company using its CpyID \n \n

Response Payload

Name	Type	Description
Company Description
Building	String	Address 1
City	String	City
CountryCode	String
CountryName	String
CpyID	Int32	Houshold ID in B2C intance\n Company ID in B2B intance
CpyNotes	CtcCpyNotes
CreateDate	DateTime (nullable)
Email	String
Fax	String
LastModifDate	DateTime (nullable)
ModifiedBy	Int32 (nullable)
Name	String	Houshold name in B2C intance\n Company name in B2B intance
NationalID	String
OriginID	String
Phone	String
PostCode	String	Postcode
SourceID	String
StateCode	String	StateCode
StateName	String	County
Street	String	Address 2
SupInfo	List<SupInfo>
Web	String
Zone	String	Address 3
CtcCpyNotes Description
Name	Type	Description
AttachmentFilesList	List<Attachment>
AttachmentFilesListString	List<String>
Comment	String	Comment Text
CtcCpyID	Int32	Contact ID
LastModifiedBy	String
LastModifiedOn	DateTime
NoteUserID	Int32
SourceNote	Int32
Attachment Description
Name	Type	Description
AttachmentID	String
AttachmentName	String
ContentType	String
FileContent	String
FileName	String
FileSize	Int32 (nullable)
HasContent	Boolean
ID	Int32 (nullable)
SupInfo Description
Name	Type	Description
FieldContent	String	Field value
FieldName	String	Field name

","urlObject":{"protocol":"https","path":["api","Company","Get",":id"],"host":["{{Host}}"],"query":[],"variable":[{"id":"9bc98480-e6c0-4e0f-8489-02d39289e32b","type":"any","key":"id"}]}},"response":[{"id":"6deb10b9-e5e9-4183-9bbd-b5a2d9421c27","name":"api/Company/Get/{id} Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":{"raw":"https://{{Host}}/api/Company/Get/:id","protocol":"https","host":["{{Host}}"],"path":["api","Company","Get",":id"],"variable":[{"key":"id"}]},"description":"

\r\n Search the database for one Household/Company using its CpyID \r\n \n

Response Payload

Name	Type	Description
Company Description
Building	String	Address 1
City	String	City
CountryCode	String
CountryName	String
CpyID	Int32	Houshold ID in B2C intance\n Company ID in B2B intance
CpyNotes	CtcCpyNotes
CreateDate	DateTime (nullable)
Email	String
Fax	String
LastModifDate	DateTime (nullable)
ModifiedBy	Int32 (nullable)
Name	String	Houshold name in B2C intance\n Company name in B2B intance
NationalID	String
OriginID	String
Phone	String
PostCode	String	Postcode
SourceID	String
StateCode	String	StateCode
StateName	String	County
Street	String	Address 2
SupInfo	List<SupInfo>
Web	String
Zone	String	Address 3
CtcCpyNotes Description
Name	Type	Description
AttachmentFilesList	List<Attachment>
AttachmentFilesListString	List<String>
Comment	String	Comment Text
CtcCpyID	Int32	Contact ID
LastModifiedBy	String
LastModifiedOn	DateTime
NoteUserID	Int32
SourceNote	Int32
Attachment Description
Name	Type	Description
AttachmentID	String
AttachmentName	String
ContentType	String
FileContent	String
FileName	String
FileSize	Int32 (nullable)
HasContent	Boolean
ID	Int32 (nullable)
SupInfo Description
Name	Type	Description
FieldContent	String	Field value
FieldName	String	Field name

\n Search the database for Households/Companies using the Full Text Search engine \n \n

","urlObject":{"protocol":"https","path":["api","Company","GetCompanies"],"host":["{{Host}}"],"query":[{"key":"criteria","value":"criteria-value"}],"variable":[]}},"response":[{"id":"a67a1531-5900-4326-acf9-a98c3ed654a8","name":"api/Company/GetCompanies?criteria={criteria} Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":{"raw":"https://{{Host}}/api/Company/GetCompanies?criteria=criteria-value","protocol":"https","host":["{{Host}}"],"path":["api","Company","GetCompanies"],"query":[{"key":"criteria","value":"criteria-value"}]},"description":"

\r\n Search the database for Households/Companies using the Full Text Search engine \r\n \n

"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"CpyID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"Building\": \"sample string 4\",\r\n \"Street\": \"sample string 5\",\r\n \"Zone\": \"sample string 6\",\r\n \"City\": \"sample string 7\",\r\n \"PostCode\": \"sample string 8\",\r\n \"StateCode\": \"sample string 9\",\r\n \"StateName\": \"sample string 10\",\r\n \"CountryCode\": \"sample string 13\",\r\n \"CountryName\": \"sample string 14\",\r\n \"Phone\": \"sample string 15\",\r\n \"Fax\": \"sample string 16\",\r\n \"Web\": \"sample string 17\",\r\n \"Email\": \"sample string 18\",\r\n \"NationalID\": \"sample string 20\",\r\n \"SourceID\": \"sample string 21\",\r\n \"OriginID\": \"sample string 22\",\r\n \"CreateDate\": \"2026-03-25T07:30:08.0273653+00:00\",\r\n \"LastModifDate\": \"2026-03-25T07:30:08.0273653+00:00\",\r\n \"ModifiedBy\": 1,\r\n \"CpyNotes\": {\r\n \"CtcCpyID\": 1,\r\n \"NoteUserID\": 2,\r\n \"SourceNote\": 3,\r\n \"Comment\": \"sample string 4\",\r\n \"LastModifiedBy\": \"sample string 5\",\r\n \"LastModifiedOn\": \"2026-03-25T07:30:08.0273653+00:00\",\r\n \"AttachmentFilesList\": [\r\n {\r\n \"k__BackingField\": \"sample string 1\",\r\n \"k__BackingField\": \"sample string 2\",\r\n \"k__BackingField\": \"sample string 3\",\r\n \"k__BackingField\": \"sample string 4\",\r\n \"k__BackingField\": \"sample string 5\",\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": true\r\n },\r\n {\r\n \"k__BackingField\": \"sample string 1\",\r\n \"k__BackingField\": \"sample string 2\",\r\n \"k__BackingField\": \"sample string 3\",\r\n \"k__BackingField\": \"sample string 4\",\r\n \"k__BackingField\": \"sample string 5\",\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": true\r\n }\r\n ],\r\n \"AttachmentFilesListString\": [\r\n \"sample string 1\",\r\n \"sample string 2\"\r\n ]\r\n },\r\n \"SupInfo\": [\r\n {\r\n \"FieldName\": \"sample string 1\",\r\n \"FieldContent\": \"sample string 4\"\r\n },\r\n {\r\n \"FieldName\": \"sample string 1\",\r\n \"FieldContent\": \"sample string 4\"\r\n }\r\n ]\r\n },\r\n {\r\n \"CpyID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"Building\": \"sample string 4\",\r\n \"Street\": \"sample string 5\",\r\n \"Zone\": \"sample string 6\",\r\n \"City\": \"sample string 7\",\r\n \"PostCode\": \"sample string 8\",\r\n \"StateCode\": \"sample string 9\",\r\n \"StateName\": \"sample string 10\",\r\n \"CountryCode\": \"sample string 13\",\r\n \"CountryName\": \"sample string 14\",\r\n \"Phone\": \"sample string 15\",\r\n \"Fax\": \"sample string 16\",\r\n \"Web\": \"sample string 17\",\r\n \"Email\": \"sample string 18\",\r\n \"NationalID\": \"sample string 20\",\r\n \"SourceID\": \"sample string 21\",\r\n \"OriginID\": \"sample string 22\",\r\n \"CreateDate\": \"2026-03-25T07:30:08.0273653+00:00\",\r\n \"LastModifDate\": \"2026-03-25T07:30:08.0273653+00:00\",\r\n \"ModifiedBy\": 1,\r\n \"CpyNotes\": {\r\n \"CtcCpyID\": 1,\r\n \"NoteUserID\": 2,\r\n \"SourceNote\": 3,\r\n \"Comment\": \"sample string 4\",\r\n \"LastModifiedBy\": \"sample string 5\",\r\n \"LastModifiedOn\": \"2026-03-25T07:30:08.0273653+00:00\",\r\n \"AttachmentFilesList\": [\r\n {\r\n \"k__BackingField\": \"sample string 1\",\r\n \"k__BackingField\": \"sample string 2\",\r\n \"k__BackingField\": \"sample string 3\",\r\n \"k__BackingField\": \"sample string 4\",\r\n \"k__BackingField\": \"sample string 5\",\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": true\r\n },\r\n {\r\n \"k__BackingField\": \"sample string 1\",\r\n \"k__BackingField\": \"sample string 2\",\r\n \"k__BackingField\": \"sample string 3\",\r\n \"k__BackingField\": \"sample string 4\",\r\n \"k__BackingField\": \"sample string 5\",\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": true\r\n }\r\n ],\r\n \"AttachmentFilesListString\": [\r\n \"sample string 1\",\r\n \"sample string 2\"\r\n ]\r\n },\r\n \"SupInfo\": [\r\n {\r\n \"FieldName\": \"sample string 1\",\r\n \"FieldContent\": \"sample string 4\"\r\n },\r\n {\r\n \"FieldName\": \"sample string 1\",\r\n \"FieldContent\": \"sample string 4\"\r\n }\r\n ]\r\n }\r\n]"}],"_postman_id":"d60dc872-e642-47d1-99e1-c2fb8ef71d46"},{"name":"PostCompany","id":"4e8ec395-c066-4940-8833-11568b78ad68","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"CpyID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"Building\": \"sample string 4\",\r\n \"Street\": \"sample string 5\",\r\n \"Zone\": \"sample string 6\",\r\n \"City\": \"sample string 7\",\r\n \"PostCode\": \"sample string 8\",\r\n \"StateCode\": \"sample string 9\",\r\n \"StateName\": \"sample string 10\",\r\n \"CountryCode\": \"sample string 13\",\r\n \"CountryName\": \"sample string 14\",\r\n \"Phone\": \"sample string 15\",\r\n \"Fax\": \"sample string 16\",\r\n \"Web\": \"sample string 17\",\r\n \"Email\": \"sample string 18\",\r\n \"NationalID\": \"sample string 20\",\r\n \"SourceID\": \"sample string 21\",\r\n \"OriginID\": \"sample string 22\",\r\n \"CreateDate\": \"2026-03-25T07:30:08.0429929+00:00\",\r\n \"LastModifDate\": \"2026-03-25T07:30:08.0429929+00:00\",\r\n \"ModifiedBy\": 1,\r\n \"CpyNotes\": {\r\n \"CtcCpyID\": 1,\r\n \"NoteUserID\": 2,\r\n \"SourceNote\": 3,\r\n \"Comment\": \"sample string 4\",\r\n \"LastModifiedBy\": \"sample string 5\",\r\n \"LastModifiedOn\": \"2026-03-25T07:30:08.0429929+00:00\",\r\n \"AttachmentFilesList\": [\r\n {\r\n \"k__BackingField\": \"sample string 1\",\r\n \"k__BackingField\": \"sample string 2\",\r\n \"k__BackingField\": \"sample string 3\",\r\n \"k__BackingField\": \"sample string 4\",\r\n \"k__BackingField\": \"sample string 5\",\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": true\r\n },\r\n {\r\n \"k__BackingField\": \"sample string 1\",\r\n \"k__BackingField\": \"sample string 2\",\r\n \"k__BackingField\": \"sample string 3\",\r\n \"k__BackingField\": \"sample string 4\",\r\n \"k__BackingField\": \"sample string 5\",\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": true\r\n }\r\n ],\r\n \"AttachmentFilesListString\": [\r\n \"sample string 1\",\r\n \"sample string 2\"\r\n ]\r\n },\r\n \"SupInfo\": [\r\n {\r\n \"FieldName\": \"sample string 1\",\r\n \"FieldContent\": \"sample string 4\"\r\n },\r\n {\r\n \"FieldName\": \"sample string 1\",\r\n \"FieldContent\": \"sample string 4\"\r\n }\r\n ]\r\n}"},"url":"https://{{Host}}/api/Company/PostCompany","description":"

\n Add a new Household/Company\n The Household/Company will not be added if it matches an existing one.\n \n

Body Payload

Name	Type	Description	Required
Company Description
Building	String	Address 1	False
City	String	City	False
CountryCode	String		False
CountryName	String		False
CpyID	Int32	Houshold ID in B2C intance\n Company ID in B2B intance	False
CpyNotes	CtcCpyNotes		False
CreateDate	DateTime (nullable)		False
Email	String		False
Fax	String		False
LastModifDate	DateTime (nullable)		False
ModifiedBy	Int32 (nullable)		False
Name	String	Houshold name in B2C intance\n Company name in B2B intance	False
NationalID	String		False
OriginID	String		False
Phone	String		False
PostCode	String	Postcode	False
SourceID	String		False
StateCode	String	StateCode	False
StateName	String	County	False
Street	String	Address 2	False
SupInfo	List<SupInfo>		False
Web	String		False
Zone	String	Address 3	False
CtcCpyNotes Description
Name	Type	Description	Required
AttachmentFilesList	List<Attachment>		False
AttachmentFilesListString	List<String>		False
Comment	String	Comment Text	False
CtcCpyID	Int32	Contact ID	False
LastModifiedBy	String		False
LastModifiedOn	DateTime		False
NoteUserID	Int32		False
SourceNote	Int32		False
Attachment Description
Name	Type	Description	Required
AttachmentID	String		False
AttachmentName	String		False
ContentType	String		False
FileContent	String		False
FileName	String		False
FileSize	Int32 (nullable)		False
HasContent	Boolean		False
ID	Int32 (nullable)		False
SupInfo Description
Name	Type	Description	Required
FieldContent	String	Field value	False
FieldName	String	Field name	False

Response Payload

Name	Type	Description
Company Description
Building	String	Address 1
City	String	City
CountryCode	String
CountryName	String
CpyID	Int32	Houshold ID in B2C intance\n Company ID in B2B intance
CpyNotes	CtcCpyNotes
CreateDate	DateTime (nullable)
Email	String
Fax	String
LastModifDate	DateTime (nullable)
ModifiedBy	Int32 (nullable)
Name	String	Houshold name in B2C intance\n Company name in B2B intance
NationalID	String
OriginID	String
Phone	String
PostCode	String	Postcode
SourceID	String
StateCode	String	StateCode
StateName	String	County
Street	String	Address 2
SupInfo	List<SupInfo>
Web	String
Zone	String	Address 3
CtcCpyNotes Description
Name	Type	Description
AttachmentFilesList	List<Attachment>
AttachmentFilesListString	List<String>
Comment	String	Comment Text
CtcCpyID	Int32	Contact ID
LastModifiedBy	String
LastModifiedOn	DateTime
NoteUserID	Int32
SourceNote	Int32
Attachment Description
Name	Type	Description
AttachmentID	String
AttachmentName	String
ContentType	String
FileContent	String
FileName	String
FileSize	Int32 (nullable)
HasContent	Boolean
ID	Int32 (nullable)
SupInfo Description
Name	Type	Description
FieldContent	String	Field value
FieldName	String	Field name

","urlObject":{"protocol":"https","path":["api","Company","PostCompany"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"c4e0dd6b-0cd0-4eb8-9da5-e76d45319a3b","name":"api/Company/PostCompany Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"CpyID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"Building\": \"sample string 4\",\r\n \"Street\": \"sample string 5\",\r\n \"Zone\": \"sample string 6\",\r\n \"City\": \"sample string 7\",\r\n \"PostCode\": \"sample string 8\",\r\n \"StateCode\": \"sample string 9\",\r\n \"StateName\": \"sample string 10\",\r\n \"CountryCode\": \"sample string 13\",\r\n \"CountryName\": \"sample string 14\",\r\n \"Phone\": \"sample string 15\",\r\n \"Fax\": \"sample string 16\",\r\n \"Web\": \"sample string 17\",\r\n \"Email\": \"sample string 18\",\r\n \"NationalID\": \"sample string 20\",\r\n \"SourceID\": \"sample string 21\",\r\n \"OriginID\": \"sample string 22\",\r\n \"CreateDate\": \"2026-03-25T07:30:08.0429929+00:00\",\r\n \"LastModifDate\": \"2026-03-25T07:30:08.0429929+00:00\",\r\n \"ModifiedBy\": 1,\r\n \"CpyNotes\": {\r\n \"CtcCpyID\": 1,\r\n \"NoteUserID\": 2,\r\n \"SourceNote\": 3,\r\n \"Comment\": \"sample string 4\",\r\n \"LastModifiedBy\": \"sample string 5\",\r\n \"LastModifiedOn\": \"2026-03-25T07:30:08.0429929+00:00\",\r\n \"AttachmentFilesList\": [\r\n {\r\n \"k__BackingField\": \"sample string 1\",\r\n \"k__BackingField\": \"sample string 2\",\r\n \"k__BackingField\": \"sample string 3\",\r\n \"k__BackingField\": \"sample string 4\",\r\n \"k__BackingField\": \"sample string 5\",\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": true\r\n },\r\n {\r\n \"k__BackingField\": \"sample string 1\",\r\n \"k__BackingField\": \"sample string 2\",\r\n \"k__BackingField\": \"sample string 3\",\r\n \"k__BackingField\": \"sample string 4\",\r\n \"k__BackingField\": \"sample string 5\",\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": true\r\n }\r\n ],\r\n \"AttachmentFilesListString\": [\r\n \"sample string 1\",\r\n \"sample string 2\"\r\n ]\r\n },\r\n \"SupInfo\": [\r\n {\r\n \"FieldName\": \"sample string 1\",\r\n \"FieldContent\": \"sample string 4\"\r\n },\r\n {\r\n \"FieldName\": \"sample string 1\",\r\n \"FieldContent\": \"sample string 4\"\r\n }\r\n ]\r\n}"},"url":"https://{{Host}}/api/Company/PostCompany","description":"

\r\n Add a new Household/Company\r\n The Household/Company will not be added if it matches an existing one.\r\n \n

Body Payload

Name	Type	Description	Required
Company Description
Building	String	Address 1	False
City	String	City	False
CountryCode	String		False
CountryName	String		False
CpyID	Int32	Houshold ID in B2C intance\n Company ID in B2B intance	False
CpyNotes	CtcCpyNotes		False
CreateDate	DateTime (nullable)		False
Email	String		False
Fax	String		False
LastModifDate	DateTime (nullable)		False
ModifiedBy	Int32 (nullable)		False
Name	String	Houshold name in B2C intance\n Company name in B2B intance	False
NationalID	String		False
OriginID	String		False
Phone	String		False
PostCode	String	Postcode	False
SourceID	String		False
StateCode	String	StateCode	False
StateName	String	County	False
Street	String	Address 2	False
SupInfo	List<SupInfo>		False
Web	String		False
Zone	String	Address 3	False
CtcCpyNotes Description
Name	Type	Description	Required
AttachmentFilesList	List<Attachment>		False
AttachmentFilesListString	List<String>		False
Comment	String	Comment Text	False
CtcCpyID	Int32	Contact ID	False
LastModifiedBy	String		False
LastModifiedOn	DateTime		False
NoteUserID	Int32		False
SourceNote	Int32		False
Attachment Description
Name	Type	Description	Required
AttachmentID	String		False
AttachmentName	String		False
ContentType	String		False
FileContent	String		False
FileName	String		False
FileSize	Int32 (nullable)		False
HasContent	Boolean		False
ID	Int32 (nullable)		False
SupInfo Description
Name	Type	Description	Required
FieldContent	String	Field value	False
FieldName	String	Field name	False

Response Payload

Name	Type	Description
Company Description
Building	String	Address 1
City	String	City
CountryCode	String
CountryName	String
CpyID	Int32	Houshold ID in B2C intance\n Company ID in B2B intance
CpyNotes	CtcCpyNotes
CreateDate	DateTime (nullable)
Email	String
Fax	String
LastModifDate	DateTime (nullable)
ModifiedBy	Int32 (nullable)
Name	String	Houshold name in B2C intance\n Company name in B2B intance
NationalID	String
OriginID	String
Phone	String
PostCode	String	Postcode
SourceID	String
StateCode	String	StateCode
StateName	String	County
Street	String	Address 2
SupInfo	List<SupInfo>
Web	String
Zone	String	Address 3
CtcCpyNotes Description
Name	Type	Description
AttachmentFilesList	List<Attachment>
AttachmentFilesListString	List<String>
Comment	String	Comment Text
CtcCpyID	Int32	Contact ID
LastModifiedBy	String
LastModifiedOn	DateTime
NoteUserID	Int32
SourceNote	Int32
Attachment Description
Name	Type	Description
AttachmentID	String
AttachmentName	String
ContentType	String
FileContent	String
FileName	String
FileSize	Int32 (nullable)
HasContent	Boolean
ID	Int32 (nullable)
SupInfo Description
Name	Type	Description
FieldContent	String	Field value
FieldName	String	Field name

"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"CpyID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"Building\": \"sample string 4\",\r\n \"Street\": \"sample string 5\",\r\n \"Zone\": \"sample string 6\",\r\n \"City\": \"sample string 7\",\r\n \"PostCode\": \"sample string 8\",\r\n \"StateCode\": \"sample string 9\",\r\n \"StateName\": \"sample string 10\",\r\n \"CountryCode\": \"sample string 13\",\r\n \"CountryName\": \"sample string 14\",\r\n \"Phone\": \"sample string 15\",\r\n \"Fax\": \"sample string 16\",\r\n \"Web\": \"sample string 17\",\r\n \"Email\": \"sample string 18\",\r\n \"NationalID\": \"sample string 20\",\r\n \"SourceID\": \"sample string 21\",\r\n \"OriginID\": \"sample string 22\",\r\n \"CreateDate\": \"2026-03-25T07:30:08.0429929+00:00\",\r\n \"LastModifDate\": \"2026-03-25T07:30:08.0429929+00:00\",\r\n \"ModifiedBy\": 1,\r\n \"CpyNotes\": {\r\n \"CtcCpyID\": 1,\r\n \"NoteUserID\": 2,\r\n \"SourceNote\": 3,\r\n \"Comment\": \"sample string 4\",\r\n \"LastModifiedBy\": \"sample string 5\",\r\n \"LastModifiedOn\": \"2026-03-25T07:30:08.0429929+00:00\",\r\n \"AttachmentFilesList\": [\r\n {\r\n \"k__BackingField\": \"sample string 1\",\r\n \"k__BackingField\": \"sample string 2\",\r\n \"k__BackingField\": \"sample string 3\",\r\n \"k__BackingField\": \"sample string 4\",\r\n \"k__BackingField\": \"sample string 5\",\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": true\r\n },\r\n {\r\n \"k__BackingField\": \"sample string 1\",\r\n \"k__BackingField\": \"sample string 2\",\r\n \"k__BackingField\": \"sample string 3\",\r\n \"k__BackingField\": \"sample string 4\",\r\n \"k__BackingField\": \"sample string 5\",\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": true\r\n }\r\n ],\r\n \"AttachmentFilesListString\": [\r\n \"sample string 1\",\r\n \"sample string 2\"\r\n ]\r\n },\r\n \"SupInfo\": [\r\n {\r\n \"FieldName\": \"sample string 1\",\r\n \"FieldContent\": \"sample string 4\"\r\n },\r\n {\r\n \"FieldName\": \"sample string 1\",\r\n \"FieldContent\": \"sample string 4\"\r\n }\r\n ]\r\n}"}],"_postman_id":"4e8ec395-c066-4940-8833-11568b78ad68"},{"name":"PutCompany","id":"1adb3b78-557c-4491-83a1-305aeca44614","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"CpyID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"Building\": \"sample string 4\",\r\n \"Street\": \"sample string 5\",\r\n \"Zone\": \"sample string 6\",\r\n \"City\": \"sample string 7\",\r\n \"PostCode\": \"sample string 8\",\r\n \"StateCode\": \"sample string 9\",\r\n \"StateName\": \"sample string 10\",\r\n \"CountryCode\": \"sample string 13\",\r\n \"CountryName\": \"sample string 14\",\r\n \"Phone\": \"sample string 15\",\r\n \"Fax\": \"sample string 16\",\r\n \"Web\": \"sample string 17\",\r\n \"Email\": \"sample string 18\",\r\n \"NationalID\": \"sample string 20\",\r\n \"SourceID\": \"sample string 21\",\r\n \"OriginID\": \"sample string 22\",\r\n \"CreateDate\": \"2026-03-25T07:30:08.0586097+00:00\",\r\n \"LastModifDate\": \"2026-03-25T07:30:08.0586097+00:00\",\r\n \"ModifiedBy\": 1,\r\n \"CpyNotes\": {\r\n \"CtcCpyID\": 1,\r\n \"NoteUserID\": 2,\r\n \"SourceNote\": 3,\r\n \"Comment\": \"sample string 4\",\r\n \"LastModifiedBy\": \"sample string 5\",\r\n \"LastModifiedOn\": \"2026-03-25T07:30:08.0586097+00:00\",\r\n \"AttachmentFilesList\": [\r\n {\r\n \"k__BackingField\": \"sample string 1\",\r\n \"k__BackingField\": \"sample string 2\",\r\n \"k__BackingField\": \"sample string 3\",\r\n \"k__BackingField\": \"sample string 4\",\r\n \"k__BackingField\": \"sample string 5\",\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": true\r\n },\r\n {\r\n \"k__BackingField\": \"sample string 1\",\r\n \"k__BackingField\": \"sample string 2\",\r\n \"k__BackingField\": \"sample string 3\",\r\n \"k__BackingField\": \"sample string 4\",\r\n \"k__BackingField\": \"sample string 5\",\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": true\r\n }\r\n ],\r\n \"AttachmentFilesListString\": [\r\n \"sample string 1\",\r\n \"sample string 2\"\r\n ]\r\n },\r\n \"SupInfo\": [\r\n {\r\n \"FieldName\": \"sample string 1\",\r\n \"FieldContent\": \"sample string 4\"\r\n },\r\n {\r\n \"FieldName\": \"sample string 1\",\r\n \"FieldContent\": \"sample string 4\"\r\n }\r\n ]\r\n}"},"url":"https://{{Host}}/api/Company/PutCompany","description":"

\n Update an existing Household/Company\n \n

Body Payload

Name	Type	Description	Required
Company Description
Building	String	Address 1	False
City	String	City	False
CountryCode	String		False
CountryName	String		False
CpyID	Int32	Houshold ID in B2C intance\n Company ID in B2B intance	False
CpyNotes	CtcCpyNotes		False
CreateDate	DateTime (nullable)		False
Email	String		False
Fax	String		False
LastModifDate	DateTime (nullable)		False
ModifiedBy	Int32 (nullable)		False
Name	String	Houshold name in B2C intance\n Company name in B2B intance	False
NationalID	String		False
OriginID	String		False
Phone	String		False
PostCode	String	Postcode	False
SourceID	String		False
StateCode	String	StateCode	False
StateName	String	County	False
Street	String	Address 2	False
SupInfo	List<SupInfo>		False
Web	String		False
Zone	String	Address 3	False
CtcCpyNotes Description
Name	Type	Description	Required
AttachmentFilesList	List<Attachment>		False
AttachmentFilesListString	List<String>		False
Comment	String	Comment Text	False
CtcCpyID	Int32	Contact ID	False
LastModifiedBy	String		False
LastModifiedOn	DateTime		False
NoteUserID	Int32		False
SourceNote	Int32		False
Attachment Description
Name	Type	Description	Required
AttachmentID	String		False
AttachmentName	String		False
ContentType	String		False
FileContent	String		False
FileName	String		False
FileSize	Int32 (nullable)		False
HasContent	Boolean		False
ID	Int32 (nullable)		False
SupInfo Description
Name	Type	Description	Required
FieldContent	String	Field value	False
FieldName	String	Field name	False

Response Payload

Name	Type	Description
Company Description
Building	String	Address 1
City	String	City
CountryCode	String
CountryName	String
CpyID	Int32	Houshold ID in B2C intance\n Company ID in B2B intance
CpyNotes	CtcCpyNotes
CreateDate	DateTime (nullable)
Email	String
Fax	String
LastModifDate	DateTime (nullable)
ModifiedBy	Int32 (nullable)
Name	String	Houshold name in B2C intance\n Company name in B2B intance
NationalID	String
OriginID	String
Phone	String
PostCode	String	Postcode
SourceID	String
StateCode	String	StateCode
StateName	String	County
Street	String	Address 2
SupInfo	List<SupInfo>
Web	String
Zone	String	Address 3
CtcCpyNotes Description
Name	Type	Description
AttachmentFilesList	List<Attachment>
AttachmentFilesListString	List<String>
Comment	String	Comment Text
CtcCpyID	Int32	Contact ID
LastModifiedBy	String
LastModifiedOn	DateTime
NoteUserID	Int32
SourceNote	Int32
Attachment Description
Name	Type	Description
AttachmentID	String
AttachmentName	String
ContentType	String
FileContent	String
FileName	String
FileSize	Int32 (nullable)
HasContent	Boolean
ID	Int32 (nullable)
SupInfo Description
Name	Type	Description
FieldContent	String	Field value
FieldName	String	Field name

","urlObject":{"protocol":"https","path":["api","Company","PutCompany"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"169491d2-6d9b-4d36-8652-4153ae5f551d","name":"api/Company/PutCompany Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"CpyID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"Building\": \"sample string 4\",\r\n \"Street\": \"sample string 5\",\r\n \"Zone\": \"sample string 6\",\r\n \"City\": \"sample string 7\",\r\n \"PostCode\": \"sample string 8\",\r\n \"StateCode\": \"sample string 9\",\r\n \"StateName\": \"sample string 10\",\r\n \"CountryCode\": \"sample string 13\",\r\n \"CountryName\": \"sample string 14\",\r\n \"Phone\": \"sample string 15\",\r\n \"Fax\": \"sample string 16\",\r\n \"Web\": \"sample string 17\",\r\n \"Email\": \"sample string 18\",\r\n \"NationalID\": \"sample string 20\",\r\n \"SourceID\": \"sample string 21\",\r\n \"OriginID\": \"sample string 22\",\r\n \"CreateDate\": \"2026-03-25T07:30:08.0586097+00:00\",\r\n \"LastModifDate\": \"2026-03-25T07:30:08.0586097+00:00\",\r\n \"ModifiedBy\": 1,\r\n \"CpyNotes\": {\r\n \"CtcCpyID\": 1,\r\n \"NoteUserID\": 2,\r\n \"SourceNote\": 3,\r\n \"Comment\": \"sample string 4\",\r\n \"LastModifiedBy\": \"sample string 5\",\r\n \"LastModifiedOn\": \"2026-03-25T07:30:08.0586097+00:00\",\r\n \"AttachmentFilesList\": [\r\n {\r\n \"k__BackingField\": \"sample string 1\",\r\n \"k__BackingField\": \"sample string 2\",\r\n \"k__BackingField\": \"sample string 3\",\r\n \"k__BackingField\": \"sample string 4\",\r\n \"k__BackingField\": \"sample string 5\",\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": true\r\n },\r\n {\r\n \"k__BackingField\": \"sample string 1\",\r\n \"k__BackingField\": \"sample string 2\",\r\n \"k__BackingField\": \"sample string 3\",\r\n \"k__BackingField\": \"sample string 4\",\r\n \"k__BackingField\": \"sample string 5\",\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": true\r\n }\r\n ],\r\n \"AttachmentFilesListString\": [\r\n \"sample string 1\",\r\n \"sample string 2\"\r\n ]\r\n },\r\n \"SupInfo\": [\r\n {\r\n \"FieldName\": \"sample string 1\",\r\n \"FieldContent\": \"sample string 4\"\r\n },\r\n {\r\n \"FieldName\": \"sample string 1\",\r\n \"FieldContent\": \"sample string 4\"\r\n }\r\n ]\r\n}"},"url":"https://{{Host}}/api/Company/PutCompany","description":"

\r\n Update an existing Household/Company\r\n \n

Body Payload

Name	Type	Description	Required
Company Description
Building	String	Address 1	False
City	String	City	False
CountryCode	String		False
CountryName	String		False
CpyID	Int32	Houshold ID in B2C intance\n Company ID in B2B intance	False
CpyNotes	CtcCpyNotes		False
CreateDate	DateTime (nullable)		False
Email	String		False
Fax	String		False
LastModifDate	DateTime (nullable)		False
ModifiedBy	Int32 (nullable)		False
Name	String	Houshold name in B2C intance\n Company name in B2B intance	False
NationalID	String		False
OriginID	String		False
Phone	String		False
PostCode	String	Postcode	False
SourceID	String		False
StateCode	String	StateCode	False
StateName	String	County	False
Street	String	Address 2	False
SupInfo	List<SupInfo>		False
Web	String		False
Zone	String	Address 3	False
CtcCpyNotes Description
Name	Type	Description	Required
AttachmentFilesList	List<Attachment>		False
AttachmentFilesListString	List<String>		False
Comment	String	Comment Text	False
CtcCpyID	Int32	Contact ID	False
LastModifiedBy	String		False
LastModifiedOn	DateTime		False
NoteUserID	Int32		False
SourceNote	Int32		False
Attachment Description
Name	Type	Description	Required
AttachmentID	String		False
AttachmentName	String		False
ContentType	String		False
FileContent	String		False
FileName	String		False
FileSize	Int32 (nullable)		False
HasContent	Boolean		False
ID	Int32 (nullable)		False
SupInfo Description
Name	Type	Description	Required
FieldContent	String	Field value	False
FieldName	String	Field name	False

Response Payload

Name	Type	Description
Company Description
Building	String	Address 1
City	String	City
CountryCode	String
CountryName	String
CpyID	Int32	Houshold ID in B2C intance\n Company ID in B2B intance
CpyNotes	CtcCpyNotes
CreateDate	DateTime (nullable)
Email	String
Fax	String
LastModifDate	DateTime (nullable)
ModifiedBy	Int32 (nullable)
Name	String	Houshold name in B2C intance\n Company name in B2B intance
NationalID	String
OriginID	String
Phone	String
PostCode	String	Postcode
SourceID	String
StateCode	String	StateCode
StateName	String	County
Street	String	Address 2
SupInfo	List<SupInfo>
Web	String
Zone	String	Address 3
CtcCpyNotes Description
Name	Type	Description
AttachmentFilesList	List<Attachment>
AttachmentFilesListString	List<String>
Comment	String	Comment Text
CtcCpyID	Int32	Contact ID
LastModifiedBy	String
LastModifiedOn	DateTime
NoteUserID	Int32
SourceNote	Int32
Attachment Description
Name	Type	Description
AttachmentID	String
AttachmentName	String
ContentType	String
FileContent	String
FileName	String
FileSize	Int32 (nullable)
HasContent	Boolean
ID	Int32 (nullable)
SupInfo Description
Name	Type	Description
FieldContent	String	Field value
FieldName	String	Field name

Api Methods for Company

\n","_postman_id":"86416d2a-114a-482a-a0fc-07d8cb500222"},{"name":"Contact(Deprecated)","item":[{"name":"AddCardToken","id":"6e40f9ea-a0f8-4211-a0a8-cb807b378cff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"CtcID\": 1,\r\n \"CardToken\": \"sample string 1\"\r\n}"},"url":"https://{{Host}}/api/Contact/AddCardToken","description":"

\n Add Card Token for a contact\n \n

Body Payload

Name	Type	Required
CustomerCardTokenInput Description
CardToken	String	False
CtcID	Int32 (nullable)	False

Response Payload

Name	Type	Description
CustomerCardTokenOutput Description
Error	String
IsValid	Boolean
Response	Boolean
ValidationMsg	String

","urlObject":{"protocol":"https","path":["api","Contact","AddCardToken"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"f5eac432-87ab-4070-beea-c86a000961c2","name":"api/Contact/AddCardToken Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"CtcID\": 1,\r\n \"CardToken\": \"sample string 1\"\r\n}"},"url":"https://{{Host}}/api/Contact/AddCardToken","description":"

\r\n Add Card Token for a contact\r\n \n

Body Payload

Name	Type	Required
CustomerCardTokenInput Description
CardToken	String	False
CtcID	Int32 (nullable)	False

Response Payload

Name	Type	Description
CustomerCardTokenOutput Description
Error	String
IsValid	Boolean
Response	Boolean
ValidationMsg	String

"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"IsValid\": true,\r\n \"ValidationMsg\": \"sample string 2\",\r\n \"Response\": true,\r\n \"Error\": \"sample string 4\"\r\n}"}],"_postman_id":"6e40f9ea-a0f8-4211-a0a8-cb807b378cff"},{"name":"AddComment","id":"7ae42f76-ba0e-459a-81ff-2920b75e9b41","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"CtcCpyID\": 1,\r\n \"NoteUserID\": 2,\r\n \"SourceNote\": 3,\r\n \"Comment\": \"sample string 4\",\r\n \"LastModifiedBy\": \"sample string 5\",\r\n \"LastModifiedOn\": \"2026-03-25T07:30:08.2158377+00:00\",\r\n \"AttachmentFilesList\": [\r\n {\r\n \"k__BackingField\": \"sample string 1\",\r\n \"k__BackingField\": \"sample string 2\",\r\n \"k__BackingField\": \"sample string 3\",\r\n \"k__BackingField\": \"sample string 4\",\r\n \"k__BackingField\": \"sample string 5\",\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": true\r\n },\r\n {\r\n \"k__BackingField\": \"sample string 1\",\r\n \"k__BackingField\": \"sample string 2\",\r\n \"k__BackingField\": \"sample string 3\",\r\n \"k__BackingField\": \"sample string 4\",\r\n \"k__BackingField\": \"sample string 5\",\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": true\r\n }\r\n ],\r\n \"AttachmentFilesListString\": [\r\n \"sample string 1\",\r\n \"sample string 2\"\r\n ]\r\n}"},"url":"https://{{Host}}/api/Contact/AddComment","description":"

\n Add comment to the requested customer\n \n

Body Payload

Name	Type	Description	Required
CtcCpyNotes Description
AttachmentFilesList	List<Attachment>		False
AttachmentFilesListString	List<String>		False
Comment	String	Comment Text	False
CtcCpyID	Int32	Contact ID	False
LastModifiedBy	String		False
LastModifiedOn	DateTime		False
NoteUserID	Int32		False
SourceNote	Int32		False
Attachment Description
Name	Type	Description	Required
AttachmentID	String		False
AttachmentName	String		False
ContentType	String		False
FileContent	String		False
FileName	String		False
FileSize	Int32 (nullable)		False
HasContent	Boolean		False
ID	Int32 (nullable)		False

","urlObject":{"protocol":"https","path":["api","Contact","AddComment"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"6fffd83d-49f3-4343-b691-949e6295f797","name":"api/Contact/AddComment Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"CtcCpyID\": 1,\r\n \"NoteUserID\": 2,\r\n \"SourceNote\": 3,\r\n \"Comment\": \"sample string 4\",\r\n \"LastModifiedBy\": \"sample string 5\",\r\n \"LastModifiedOn\": \"2026-03-25T07:30:08.2158377+00:00\",\r\n \"AttachmentFilesList\": [\r\n {\r\n \"k__BackingField\": \"sample string 1\",\r\n \"k__BackingField\": \"sample string 2\",\r\n \"k__BackingField\": \"sample string 3\",\r\n \"k__BackingField\": \"sample string 4\",\r\n \"k__BackingField\": \"sample string 5\",\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": true\r\n },\r\n {\r\n \"k__BackingField\": \"sample string 1\",\r\n \"k__BackingField\": \"sample string 2\",\r\n \"k__BackingField\": \"sample string 3\",\r\n \"k__BackingField\": \"sample string 4\",\r\n \"k__BackingField\": \"sample string 5\",\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": true\r\n }\r\n ],\r\n \"AttachmentFilesListString\": [\r\n \"sample string 1\",\r\n \"sample string 2\"\r\n ]\r\n}"},"url":"https://{{Host}}/api/Contact/AddComment","description":"

\r\n Add comment to the requested customer\r\n \n

Body Payload

Name	Type	Description	Required
CtcCpyNotes Description
AttachmentFilesList	List<Attachment>		False
AttachmentFilesListString	List<String>		False
Comment	String	Comment Text	False
CtcCpyID	Int32	Contact ID	False
LastModifiedBy	String		False
LastModifiedOn	DateTime		False
NoteUserID	Int32		False
SourceNote	Int32		False
Attachment Description
Name	Type	Description	Required
AttachmentID	String		False
AttachmentName	String		False
ContentType	String		False
FileContent	String		False
FileName	String		False
FileSize	Int32 (nullable)		False
HasContent	Boolean		False
ID	Int32 (nullable)		False

"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"7ae42f76-ba0e-459a-81ff-2920b75e9b41"},{"name":"AddMemberNumber","id":"073eb19d-aaec-4611-b13c-892913071441","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"https://{{Host}}/api/Contact/AddMemberNumber?CtcID=CtcID-value","description":"

\n Add member number for a contact\n \n

Response Payload

Name	Type	Description
AddMemberNumberOutput Description
Error	String
MemberNumber	String
Response	Boolean

","urlObject":{"protocol":"https","path":["api","Contact","AddMemberNumber"],"host":["{{Host}}"],"query":[{"key":"CtcID","value":"CtcID-value"}],"variable":[]}},"response":[{"id":"1ce5cd2a-6df6-44d9-becf-e871418dcaa8","name":"api/Contact/AddMemberNumber?CtcID={CtcID} Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":{"raw":"https://{{Host}}/api/Contact/AddMemberNumber?CtcID=CtcID-value","protocol":"https","host":["{{Host}}"],"path":["api","Contact","AddMemberNumber"],"query":[{"key":"CtcID","value":"CtcID-value"}]},"description":"

\r\n Add member number for a contact\r\n \n

Response Payload

Name	Type	Description
AddMemberNumberOutput Description
Error	String
MemberNumber	String
Response	Boolean

"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"Response\": true,\r\n \"MemberNumber\": \"sample string 2\",\r\n \"Error\": \"sample string 3\"\r\n}"}],"_postman_id":"073eb19d-aaec-4611-b13c-892913071441"},{"name":"AuthenticateCustomer","id":"f720234a-dc0c-470e-98be-9683befa88e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"Email\": \"sample string 1\",\r\n \"Password\": \"sample string 2\"\r\n}"},"url":"https://{{Host}}/api/Contact/AuthenticateCustomer","description":"

\n Authenticate customer\n \n

Body Payload

Name	Type	Description	Required
ContactAuthenticationInput Description
Email	String	Customer Email	False
Password	String	Customer Password	False

Response Payload

Name	Type	Description
AuthenticatedCustomerOutput Description
Error	String	The error description
IsAuthenticated	Boolean	The status of the authentication
Response	Boolean	The status of the call

","urlObject":{"protocol":"https","path":["api","Contact","AuthenticateCustomer"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"7d66601f-defd-421f-9b8b-92e28d8deea8","name":"api/Contact/AuthenticateCustomer Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"Email\": \"sample string 1\",\r\n \"Password\": \"sample string 2\"\r\n}"},"url":"https://{{Host}}/api/Contact/AuthenticateCustomer","description":"

\r\n Authenticate customer\r\n \n

Body Payload

Name	Type	Description	Required
ContactAuthenticationInput Description
Email	String	Customer Email	False
Password	String	Customer Password	False

Response Payload

Name	Type	Description
AuthenticatedCustomerOutput Description
Error	String	The error description
IsAuthenticated	Boolean	The status of the authentication
Response	Boolean	The status of the call

"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"Response\": true,\r\n \"IsAuthenticated\": true,\r\n \"Error\": \"sample string 3\"\r\n}"}],"_postman_id":"f720234a-dc0c-470e-98be-9683befa88e6"},{"name":"DeleteContact","id":"58156d67-1b7d-4ceb-a681-e5fb5ddce3a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{Host}}/api/Contact/DeleteContact/:id","description":"

\n Delete an existing contact by its CtcID\n \n

Body Payload

Response Payload

Name	Type	Description
Contact Description
_Title	String	Person title
BirthDate	DateTime (nullable)	Date of birth
BrandID	Int32 (nullable)	The ID of the Brand the customer should belongs to
CardToken	String
CardTokensList	List<String>	return the list of card tokens linked to this contact
Company	Company	Collection of company information
ContactSpendInLast12Months	String
CorporateJobTitle	Int32
CorporateName	String
CpyID	Int32	Houshold ID in B2C intance\n Company ID in B2B intance
CreateDate	DateTime (nullable)	Creation Date (used only in PostContact)
CtcID	Int32	The ID of the customer (CtcID)
CtcNotes	CtcCpyNotes	Collection of complementary notes
CurrentMemberNumber	String	return the last member number linked to this contact
CurrentReferrerCode	String	Get the referrer code of the contact
DeleteMyData	Boolean (nullable)	Confirmation to delete the personal data of this contact (USED ONLY in PUTCONTACT)
DoNotExport	Boolean	Shows if contact can be exported
Email	String	Email address
FirstName	String	First Name
HomeSiteID	String	The Site ID added will be used to flag the customer against a Selected Site
IsFinanceCtc	Boolean
IsFinanceCtcTemplate	String
IsLeadCtc	Boolean
IsLeadCtcCtcTemplate	String
LastName	String	Last Name
MemberNumbersList	List<String>	return the list of member numbers linked to this contact
MobilPhone	String	Mobile number
ModifDate	DateTime (nullable)	Last modification date (used only in PostContact)
ModifiedBy	Int32 (nullable)	CtcID of the user who applied the last modification
OriginID	String	OriginID
ParentEmailAddress	String	Parent Email Address (To be used when the contact age under 16)
Phone	String	Landline number
Picture	Byte[]	The Image of the contact
PositionFreeText	String	Job Free Text
PredefinedGender	GenderEnum	Gender :\n Unknown,\n Male,\n Female,\n PreferNotToSay,
ProcessMydata	Boolean (nullable)	Confirmation to process the data of this contact (USED ONLY in PUTCONTACT)
ReferredByCode	String	Get or Update the referred by code of the contact
ReferrerCode	String	Update the referrer code of the contact
ReferrerCodeList	List<String>	return the list of referre codes linked to this contact
SourceID	String	Source ID
SupInfo	List<SupInfo>	Collection of contact supplementary information
UpdateIfPopulated	Boolean	Used only in PutContact method (Default = false).\n This will allow the user to update just a specifc contact field(s)\n IF false : the request will be considered as PUT HTTP request (updates the entire resource)\n IF true : the request will be considered as PATCH HTTP request (partial update). Only populated fields will be updated.
Company Description
Name	Type	Description
Building	String	Address 1
City	String	City
CountryCode	String
CountryName	String
CpyID	Int32	Houshold ID in B2C intance\n Company ID in B2B intance
CpyNotes	CtcCpyNotes
CreateDate	DateTime (nullable)
Email	String
Fax	String
LastModifDate	DateTime (nullable)
ModifiedBy	Int32 (nullable)
Name	String	Houshold name in B2C intance\n Company name in B2B intance
NationalID	String
OriginID	String
Phone	String
PostCode	String	Postcode
SourceID	String
StateCode	String	StateCode
StateName	String	County
Street	String	Address 2
SupInfo	List<SupInfo>
Web	String
Zone	String	Address 3
CtcCpyNotes Description
Name	Type	Description
AttachmentFilesList	List<Attachment>
AttachmentFilesListString	List<String>
Comment	String	Comment Text
CtcCpyID	Int32	Contact ID
LastModifiedBy	String
LastModifiedOn	DateTime
NoteUserID	Int32
SourceNote	Int32
Attachment Description
Name	Type	Description
AttachmentID	String
AttachmentName	String
ContentType	String
FileContent	String
FileName	String
FileSize	Int32 (nullable)
HasContent	Boolean
ID	Int32 (nullable)
SupInfo Description
Name	Type	Description
FieldContent	String	Field value
FieldName	String	Field name
CtcCpyNotes Description
Name	Type	Description
AttachmentFilesList	List<Attachment>
AttachmentFilesListString	List<String>
Comment	String	Comment Text
CtcCpyID	Int32	Contact ID
LastModifiedBy	String
LastModifiedOn	DateTime
NoteUserID	Int32
SourceNote	Int32
Attachment Description
Name	Type	Description
AttachmentID	String
AttachmentName	String
ContentType	String
FileContent	String
FileName	String
FileSize	Int32 (nullable)
HasContent	Boolean
ID	Int32 (nullable)
SupInfo Description
Name	Type	Description
FieldContent	String	Field value
FieldName	String	Field name

","urlObject":{"protocol":"https","path":["api","Contact","DeleteContact",":id"],"host":["{{Host}}"],"query":[],"variable":[{"id":"74fb08fc-5aa4-42f5-b7d5-56ac9cc8da82","type":"any","key":"id"}]}},"response":[{"id":"677ab2e2-ae99-4556-98f1-b1626d31896b","name":"api/Contact/DeleteContact/{id} Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://{{Host}}/api/Contact/DeleteContact/:id","protocol":"https","host":["{{Host}}"],"path":["api","Contact","DeleteContact",":id"],"variable":[{"key":"id"}]},"description":"

\r\n Delete an existing contact by its CtcID\r\n \n

Body Payload

Response Payload

Name	Type	Description
Contact Description
_Title	String	Person title
BirthDate	DateTime (nullable)	Date of birth
BrandID	Int32 (nullable)	The ID of the Brand the customer should belongs to
CardToken	String
CardTokensList	List<String>	return the list of card tokens linked to this contact
Company	Company	Collection of company information
ContactSpendInLast12Months	String
CorporateJobTitle	Int32
CorporateName	String
CpyID	Int32	Houshold ID in B2C intance\n Company ID in B2B intance
CreateDate	DateTime (nullable)	Creation Date (used only in PostContact)
CtcID	Int32	The ID of the customer (CtcID)
CtcNotes	CtcCpyNotes	Collection of complementary notes
CurrentMemberNumber	String	return the last member number linked to this contact
CurrentReferrerCode	String	Get the referrer code of the contact
DeleteMyData	Boolean (nullable)	Confirmation to delete the personal data of this contact (USED ONLY in PUTCONTACT)
DoNotExport	Boolean	Shows if contact can be exported
Email	String	Email address
FirstName	String	First Name
HomeSiteID	String	The Site ID added will be used to flag the customer against a Selected Site
IsFinanceCtc	Boolean
IsFinanceCtcTemplate	String
IsLeadCtc	Boolean
IsLeadCtcCtcTemplate	String
LastName	String	Last Name
MemberNumbersList	List<String>	return the list of member numbers linked to this contact
MobilPhone	String	Mobile number
ModifDate	DateTime (nullable)	Last modification date (used only in PostContact)
ModifiedBy	Int32 (nullable)	CtcID of the user who applied the last modification
OriginID	String	OriginID
ParentEmailAddress	String	Parent Email Address (To be used when the contact age under 16)
Phone	String	Landline number
Picture	Byte[]	The Image of the contact
PositionFreeText	String	Job Free Text
PredefinedGender	GenderEnum	Gender :\n Unknown,\n Male,\n Female,\n PreferNotToSay,
ProcessMydata	Boolean (nullable)	Confirmation to process the data of this contact (USED ONLY in PUTCONTACT)
ReferredByCode	String	Get or Update the referred by code of the contact
ReferrerCode	String	Update the referrer code of the contact
ReferrerCodeList	List<String>	return the list of referre codes linked to this contact
SourceID	String	Source ID
SupInfo	List<SupInfo>	Collection of contact supplementary information
UpdateIfPopulated	Boolean	Used only in PutContact method (Default = false).\n This will allow the user to update just a specifc contact field(s)\n IF false : the request will be considered as PUT HTTP request (updates the entire resource)\n IF true : the request will be considered as PATCH HTTP request (partial update). Only populated fields will be updated.
Company Description
Name	Type	Description
Building	String	Address 1
City	String	City
CountryCode	String
CountryName	String
CpyID	Int32	Houshold ID in B2C intance\n Company ID in B2B intance
CpyNotes	CtcCpyNotes
CreateDate	DateTime (nullable)
Email	String
Fax	String
LastModifDate	DateTime (nullable)
ModifiedBy	Int32 (nullable)
Name	String	Houshold name in B2C intance\n Company name in B2B intance
NationalID	String
OriginID	String
Phone	String
PostCode	String	Postcode
SourceID	String
StateCode	String	StateCode
StateName	String	County
Street	String	Address 2
SupInfo	List<SupInfo>
Web	String
Zone	String	Address 3
CtcCpyNotes Description
Name	Type	Description
AttachmentFilesList	List<Attachment>
AttachmentFilesListString	List<String>
Comment	String	Comment Text
CtcCpyID	Int32	Contact ID
LastModifiedBy	String
LastModifiedOn	DateTime
NoteUserID	Int32
SourceNote	Int32
Attachment Description
Name	Type	Description
AttachmentID	String
AttachmentName	String
ContentType	String
FileContent	String
FileName	String
FileSize	Int32 (nullable)
HasContent	Boolean
ID	Int32 (nullable)
SupInfo Description
Name	Type	Description
FieldContent	String	Field value
FieldName	String	Field name
CtcCpyNotes Description
Name	Type	Description
AttachmentFilesList	List<Attachment>
AttachmentFilesListString	List<String>
Comment	String	Comment Text
CtcCpyID	Int32	Contact ID
LastModifiedBy	String
LastModifiedOn	DateTime
NoteUserID	Int32
SourceNote	Int32
Attachment Description
Name	Type	Description
AttachmentID	String
AttachmentName	String
ContentType	String
FileContent	String
FileName	String
FileSize	Int32 (nullable)
HasContent	Boolean
ID	Int32 (nullable)
SupInfo Description
Name	Type	Description
FieldContent	String	Field value
FieldName	String	Field name

"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"CtcID\": 1,\r\n \"LastName\": \"sample string 2\",\r\n \"CpyID\": 3,\r\n \"PositionFreeText\": \"sample string 7\",\r\n \"CreateDate\": \"2026-03-25T07:30:08.3095921+00:00\",\r\n \"ModifDate\": \"2026-03-25T07:30:08.3095921+00:00\",\r\n \"ModifiedBy\": 1,\r\n \"SourceID\": \"sample string 10\",\r\n \"OriginID\": \"sample string 11\",\r\n \"DoNotExport\": true,\r\n \"ParentEmailAddress\": \"sample string 14\",\r\n \"SupInfo\": [\r\n {\r\n \"FieldName\": \"sample string 1\",\r\n \"FieldContent\": \"sample string 4\"\r\n },\r\n {\r\n \"FieldName\": \"sample string 1\",\r\n \"FieldContent\": \"sample string 4\"\r\n }\r\n ],\r\n \"Company\": {\r\n \"CpyID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"Building\": \"sample string 4\",\r\n \"Street\": \"sample string 5\",\r\n \"Zone\": \"sample string 6\",\r\n \"City\": \"sample string 7\",\r\n \"PostCode\": \"sample string 8\",\r\n \"StateCode\": \"sample string 9\",\r\n \"StateName\": \"sample string 10\",\r\n \"CountryCode\": \"sample string 13\",\r\n \"CountryName\": \"sample string 14\",\r\n \"Phone\": \"sample string 15\",\r\n \"Fax\": \"sample string 16\",\r\n \"Web\": \"sample string 17\",\r\n \"Email\": \"sample string 18\",\r\n \"NationalID\": \"sample string 20\",\r\n \"SourceID\": \"sample string 21\",\r\n \"OriginID\": \"sample string 22\",\r\n \"CreateDate\": \"2026-03-25T07:30:08.3095921+00:00\",\r\n \"LastModifDate\": \"2026-03-25T07:30:08.3095921+00:00\",\r\n \"ModifiedBy\": 1,\r\n \"CpyNotes\": {\r\n \"CtcCpyID\": 1,\r\n \"NoteUserID\": 2,\r\n \"SourceNote\": 3,\r\n \"Comment\": \"sample string 4\",\r\n \"LastModifiedBy\": \"sample string 5\",\r\n \"LastModifiedOn\": \"2026-03-25T07:30:08.3095921+00:00\",\r\n \"AttachmentFilesList\": [\r\n {\r\n \"k__BackingField\": \"sample string 1\",\r\n \"k__BackingField\": \"sample string 2\",\r\n \"k__BackingField\": \"sample string 3\",\r\n \"k__BackingField\": \"sample string 4\",\r\n \"k__BackingField\": \"sample string 5\",\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": true\r\n },\r\n {\r\n \"k__BackingField\": \"sample string 1\",\r\n \"k__BackingField\": \"sample string 2\",\r\n \"k__BackingField\": \"sample string 3\",\r\n \"k__BackingField\": \"sample string 4\",\r\n \"k__BackingField\": \"sample string 5\",\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": true\r\n }\r\n ],\r\n \"AttachmentFilesListString\": [\r\n \"sample string 1\",\r\n \"sample string 2\"\r\n ]\r\n },\r\n \"SupInfo\": [\r\n {\r\n \"FieldName\": \"sample string 1\",\r\n \"FieldContent\": \"sample string 4\"\r\n },\r\n {\r\n \"FieldName\": \"sample string 1\",\r\n \"FieldContent\": \"sample string 4\"\r\n }\r\n ]\r\n },\r\n \"CtcNotes\": {\r\n \"CtcCpyID\": 1,\r\n \"NoteUserID\": 2,\r\n \"SourceNote\": 3,\r\n \"Comment\": \"sample string 4\",\r\n \"LastModifiedBy\": \"sample string 5\",\r\n \"LastModifiedOn\": \"2026-03-25T07:30:08.3095921+00:00\",\r\n \"AttachmentFilesList\": [\r\n {\r\n \"k__BackingField\": \"sample string 1\",\r\n \"k__BackingField\": \"sample string 2\",\r\n \"k__BackingField\": \"sample string 3\",\r\n \"k__BackingField\": \"sample string 4\",\r\n \"k__BackingField\": \"sample string 5\",\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": true\r\n },\r\n {\r\n \"k__BackingField\": \"sample string 1\",\r\n \"k__BackingField\": \"sample string 2\",\r\n \"k__BackingField\": \"sample string 3\",\r\n \"k__BackingField\": \"sample string 4\",\r\n \"k__BackingField\": \"sample string 5\",\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": true\r\n }\r\n ],\r\n \"AttachmentFilesListString\": [\r\n \"sample string 1\",\r\n \"sample string 2\"\r\n ]\r\n },\r\n \"Gender\": null,\r\n \"PredefinedGender\": 0,\r\n \"ProcessMydata\": true,\r\n \"DeleteMyData\": true,\r\n \"HomeSiteID\": \"sample string 20\",\r\n \"BrandID\": 1,\r\n \"MemberNumbersList\": [\r\n \"sample string 1\",\r\n \"sample string 2\"\r\n ],\r\n \"CurrentMemberNumber\": \"sample string 21\",\r\n \"CardTokensList\": [\r\n \"sample string 1\",\r\n \"sample string 2\"\r\n ],\r\n \"CardToken\": \"sample string 22\",\r\n \"CurrentReferrerCode\": \"sample string 23\",\r\n \"ReferrerCodeList\": [\r\n \"sample string 1\",\r\n \"sample string 2\"\r\n ],\r\n \"ReferredByCode\": \"sample string 24\",\r\n \"ReferrerCode\": \"sample string 25\",\r\n \"UpdateIfPopulated\": true,\r\n \"IsLeadCtc\": true,\r\n \"IsFinanceCtc\": true,\r\n \"CorporateName\": \"sample string 29\",\r\n \"CorporateJobTitle\": 30,\r\n \"Picture\": \"QEA=\",\r\n \"IsFinanceCtcTemplate\": \"

\",\r\n \"IsLeadCtcCtcTemplate\": \"

\n Search customer by origin ID\n \n

Response Payload

Name	Type	Description
FindByOriginIDOutput Description
CtcID	Int32
MD5	String
SourceID	String

","urlObject":{"protocol":"https","path":["api","Contact","FindByOriginID"],"host":["{{Host}}"],"query":[{"key":"OriginID","value":"OriginID-value"}],"variable":[]}},"response":[{"id":"c1cfc7d9-1a7b-4ef9-aee0-d0932ada9978","name":"api/Contact/FindByOriginID?OriginID={OriginID} Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":{"raw":"https://{{Host}}/api/Contact/FindByOriginID?OriginID=OriginID-value","protocol":"https","host":["{{Host}}"],"path":["api","Contact","FindByOriginID"],"query":[{"key":"OriginID","value":"OriginID-value"}]},"description":"

\r\n Search customer by origin ID\r\n \n

Response Payload

Name	Type	Description
FindByOriginIDOutput Description
CtcID	Int32
MD5	String
SourceID	String

"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"CtcID\": 1,\r\n \"MD5\": \"sample string 2\",\r\n \"SourceID\": \"sample string 3\"\r\n },\r\n {\r\n \"CtcID\": 1,\r\n \"MD5\": \"sample string 2\",\r\n \"SourceID\": \"sample string 3\"\r\n }\r\n]"}],"_postman_id":"f37474c4-9c59-44d5-a453-4e2fd08ac3ee"},{"name":"FindByOriginIDAndSourceID","id":"f40256de-fdc3-49ef-9927-b1b063c6ce11","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"OriginID\": \"sample string 1\",\r\n \"SourceID\": \"sample string 2\"\r\n}"},"url":"https://{{Host}}/api/Contact/FindByOriginIDAndSourceID","description":"

\n Search customer by origin ID\n \n

Body Payload

Name	Type	Required
SourceOriginID Description
OriginID	String	False
SourceID	String	False

Response Payload

Name	Type	Description
ContactExtendedOutput Description
CtcID	Int32
Error	List<String>
Md5	String
Response	Boolean

","urlObject":{"protocol":"https","path":["api","Contact","FindByOriginIDAndSourceID"],"host":["{{Host}}"],"query":[],"variable":[]}},"response":[{"id":"4b6b90a1-2245-4c63-b7a0-2bcb862de9f1","name":"api/Contact/FindByOriginIDAndSourceID Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"OriginID\": \"sample string 1\",\r\n \"SourceID\": \"sample string 2\"\r\n}"},"url":"https://{{Host}}/api/Contact/FindByOriginIDAndSourceID","description":"

\r\n Search customer by origin ID\r\n \n

Body Payload

Name	Type	Required
SourceOriginID Description
OriginID	String	False
SourceID	String	False

Response Payload

Name	Type	Description
ContactExtendedOutput Description
CtcID	Int32
Error	List<String>
Md5	String
Response	Boolean

"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"Response\": true,\r\n \"CtcID\": 2,\r\n \"Md5\": \"sample string 3\",\r\n \"Error\": [\r\n \"sample string 1\",\r\n \"sample string 2\"\r\n ]\r\n}"}],"_postman_id":"f40256de-fdc3-49ef-9927-b1b063c6ce11"},{"name":"FindByVoucherCode","id":"64b7981d-b993-432a-8f6b-be1b719619d9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"https://{{Host}}/api/Contact/FindByVoucherCode?VoucherCode=VoucherCode-value","description":"

\n Search customer by voucher code\n \n

Response Payload

Name	Type	Description
ContactExtendedOutput Description
CtcID	Int32
Error	List<String>
Md5	String
Response	Boolean

","urlObject":{"protocol":"https","path":["api","Contact","FindByVoucherCode"],"host":["{{Host}}"],"query":[{"key":"VoucherCode","value":"VoucherCode-value"}],"variable":[]}},"response":[{"id":"0ea84695-f3ee-4cb7-9375-dc8d2a6a8eb2","name":"api/Contact/FindByVoucherCode?VoucherCode={VoucherCode} Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":{"raw":"https://{{Host}}/api/Contact/FindByVoucherCode?VoucherCode=VoucherCode-value","protocol":"https","host":["{{Host}}"],"path":["api","Contact","FindByVoucherCode"],"query":[{"key":"VoucherCode","value":"VoucherCode-value"}]},"description":"

\r\n Search customer by voucher code\r\n \n

Response Payload

Name	Type	Description
ContactExtendedOutput Description
CtcID	Int32
Error	List<String>
Md5	String
Response	Boolean

"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"Response\": true,\r\n \"CtcID\": 2,\r\n \"Md5\": \"sample string 3\",\r\n \"Error\": [\r\n \"sample string 1\",\r\n \"sample string 2\"\r\n ]\r\n}"}],"_postman_id":"64b7981d-b993-432a-8f6b-be1b719619d9"},{"name":"FindContactByMemberNumber","id":"3e96e69a-09fe-4c31-916c-8638f17b71c8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"https://{{Host}}/api/Contact/FindContactByMemberNumber?MemberNumber=MemberNumber-value","description":"

Response Payload

Name	Type	Description
FindContactByMemberNumberOutput Description
CtcID	Int32
Error	String
Response	Boolean

","urlObject":{"protocol":"https","path":["api","Contact","FindContactByMemberNumber"],"host":["{{Host}}"],"query":[{"key":"MemberNumber","value":"MemberNumber-value"}],"variable":[]}},"response":[{"id":"aeb12432-e5da-49ca-9d59-0aa9454ce8cb","name":"api/Contact/FindContactByMemberNumber?MemberNumber={MemberNumber} Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":{"raw":"https://{{Host}}/api/Contact/FindContactByMemberNumber?MemberNumber=MemberNumber-value","protocol":"https","host":["{{Host}}"],"path":["api","Contact","FindContactByMemberNumber"],"query":[{"key":"MemberNumber","value":"MemberNumber-value"}]},"description":"

Response Payload

Name	Type	Description
FindContactByMemberNumberOutput Description
CtcID	Int32
Error	String
Response	Boolean

"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"Response\": true,\r\n \"CtcID\": 2,\r\n \"Error\": \"sample string 3\"\r\n}"}],"_postman_id":"3e96e69a-09fe-4c31-916c-8638f17b71c8"},{"name":"Get","id":"d191c9fd-3367-4fa7-a45c-a4410c9b5cde","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"https://{{Host}}/api/Contact/Get/:id","description":"

\n Search the database for one Contact using its CtcID \n \n

Response Payload

Name	Type	Description
Contact Description
_Title	String	Person title
BirthDate	DateTime (nullable)	Date of birth
BrandID	Int32 (nullable)	The ID of the Brand the customer should belongs to
CardToken	String
CardTokensList	List<String>	return the list of card tokens linked to this contact
Company	Company	Collection of company information
ContactSpendInLast12Months	String
CorporateJobTitle	Int32
CorporateName	String
CpyID	Int32	Houshold ID in B2C intance\n Company ID in B2B intance
CreateDate	DateTime (nullable)	Creation Date (used only in PostContact)
CtcID	Int32	The ID of the customer (CtcID)
CtcNotes	CtcCpyNotes	Collection of complementary notes
CurrentMemberNumber	String	return the last member number linked to this contact
CurrentReferrerCode	String	Get the referrer code of the contact
DeleteMyData	Boolean (nullable)	Confirmation to delete the personal data of this contact (USED ONLY in PUTCONTACT)
DoNotExport	Boolean	Shows if contact can be exported
Email	String	Email address
FirstName	String	First Name
HomeSiteID	String	The Site ID added will be used to flag the customer against a Selected Site
IsFinanceCtc	Boolean
IsFinanceCtcTemplate	String
IsLeadCtc	Boolean
IsLeadCtcCtcTemplate	String
LastName	String	Last Name
MemberNumbersList	List<String>	return the list of member numbers linked to this contact
MobilPhone	String	Mobile number
ModifDate	DateTime (nullable)	Last modification date (used only in PostContact)
ModifiedBy	Int32 (nullable)	CtcID of the user who applied the last modification
OriginID	String	OriginID
ParentEmailAddress	String	Parent Email Address (To be used when the contact age under 16)
Phone	String	Landline number
Picture	Byte[]	The Image of the contact
PositionFreeText	String	Job Free Text
PredefinedGender	GenderEnum	Gender :\n Unknown,\n Male,\n Female,\n PreferNotToSay,
ProcessMydata	Boolean (nullable)	Confirmation to process the data of this contact (USED ONLY in PUTCONTACT)
ReferredByCode	String	Get or Update the referred by code of the contact
ReferrerCode	String	Update the referrer code of the contact
ReferrerCodeList	List<String>	return the list of referre codes linked to this contact
SourceID	String	Source ID
SupInfo	List<SupInfo>	Collection of contact supplementary information
UpdateIfPopulated	Boolean	Used only in PutContact method (Default = false).\n This will allow the user to update just a specifc contact field(s)\n IF false : the request will be considered as PUT HTTP request (updates the entire resource)\n IF true : the request will be considered as PATCH HTTP request (partial update). Only populated fields will be updated.
Company Description
Name	Type	Description
Building	String	Address 1
City	String	City
CountryCode	String
CountryName	String
CpyID	Int32	Houshold ID in B2C intance\n Company ID in B2B intance
CpyNotes	CtcCpyNotes
CreateDate	DateTime (nullable)
Email	String
Fax	String
LastModifDate	DateTime (nullable)
ModifiedBy	Int32 (nullable)
Name	String	Houshold name in B2C intance\n Company name in B2B intance
NationalID	String
OriginID	String
Phone	String
PostCode	String	Postcode
SourceID	String
StateCode	String	StateCode
StateName	String	County
Street	String	Address 2
SupInfo	List<SupInfo>
Web	String
Zone	String	Address 3
CtcCpyNotes Description
Name	Type	Description
AttachmentFilesList	List<Attachment>
AttachmentFilesListString	List<String>
Comment	String	Comment Text
CtcCpyID	Int32	Contact ID
LastModifiedBy	String
LastModifiedOn	DateTime
NoteUserID	Int32
SourceNote	Int32
Attachment Description
Name	Type	Description
AttachmentID	String
AttachmentName	String
ContentType	String
FileContent	String
FileName	String
FileSize	Int32 (nullable)
HasContent	Boolean
ID	Int32 (nullable)
SupInfo Description
Name	Type	Description
FieldContent	String	Field value
FieldName	String	Field name
CtcCpyNotes Description
Name	Type	Description
AttachmentFilesList	List<Attachment>
AttachmentFilesListString	List<String>
Comment	String	Comment Text
CtcCpyID	Int32	Contact ID
LastModifiedBy	String
LastModifiedOn	DateTime
NoteUserID	Int32
SourceNote	Int32
Attachment Description
Name	Type	Description
AttachmentID	String
AttachmentName	String
ContentType	String
FileContent	String
FileName	String
FileSize	Int32 (nullable)
HasContent	Boolean
ID	Int32 (nullable)
SupInfo Description
Name	Type	Description
FieldContent	String	Field value
FieldName	String	Field name

","urlObject":{"protocol":"https","path":["api","Contact","Get",":id"],"host":["{{Host}}"],"query":[],"variable":[{"id":"acb3b514-e18c-41c2-b7d8-77040475accf","type":"any","key":"id"}]}},"response":[{"id":"5d2489ab-3367-4ed3-b9fb-acec2f7eba79","name":"api/Contact/Get/{id} Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":{"raw":"https://{{Host}}/api/Contact/Get/:id","protocol":"https","host":["{{Host}}"],"path":["api","Contact","Get",":id"],"variable":[{"key":"id"}]},"description":"

\r\n Search the database for one Contact using its CtcID \r\n \n

Response Payload

Name	Type	Description
Contact Description
_Title	String	Person title
BirthDate	DateTime (nullable)	Date of birth
BrandID	Int32 (nullable)	The ID of the Brand the customer should belongs to
CardToken	String
CardTokensList	List<String>	return the list of card tokens linked to this contact
Company	Company	Collection of company information
ContactSpendInLast12Months	String
CorporateJobTitle	Int32
CorporateName	String
CpyID	Int32	Houshold ID in B2C intance\n Company ID in B2B intance
CreateDate	DateTime (nullable)	Creation Date (used only in PostContact)
CtcID	Int32	The ID of the customer (CtcID)
CtcNotes	CtcCpyNotes	Collection of complementary notes
CurrentMemberNumber	String	return the last member number linked to this contact
CurrentReferrerCode	String	Get the referrer code of the contact
DeleteMyData	Boolean (nullable)	Confirmation to delete the personal data of this contact (USED ONLY in PUTCONTACT)
DoNotExport	Boolean	Shows if contact can be exported
Email	String	Email address
FirstName	String	First Name
HomeSiteID	String	The Site ID added will be used to flag the customer against a Selected Site
IsFinanceCtc	Boolean
IsFinanceCtcTemplate	String
IsLeadCtc	Boolean
IsLeadCtcCtcTemplate	String
LastName	String	Last Name
MemberNumbersList	List<String>	return the list of member numbers linked to this contact
MobilPhone	String	Mobile number
ModifDate	DateTime (nullable)	Last modification date (used only in PostContact)
ModifiedBy	Int32 (nullable)	CtcID of the user who applied the last modification
OriginID	String	OriginID
ParentEmailAddress	String	Parent Email Address (To be used when the contact age under 16)
Phone	String	Landline number
Picture	Byte[]	The Image of the contact
PositionFreeText	String	Job Free Text
PredefinedGender	GenderEnum	Gender :\n Unknown,\n Male,\n Female,\n PreferNotToSay,
ProcessMydata	Boolean (nullable)	Confirmation to process the data of this contact (USED ONLY in PUTCONTACT)
ReferredByCode	String	Get or Update the referred by code of the contact
ReferrerCode	String	Update the referrer code of the contact
ReferrerCodeList	List<String>	return the list of referre codes linked to this contact
SourceID	String	Source ID
SupInfo	List<SupInfo>	Collection of contact supplementary information
UpdateIfPopulated	Boolean	Used only in PutContact method (Default = false).\n This will allow the user to update just a specifc contact field(s)\n IF false : the request will be considered as PUT HTTP request (updates the entire resource)\n IF true : the request will be considered as PATCH HTTP request (partial update). Only populated fields will be updated.
Company Description
Name	Type	Description
Building	String	Address 1
City	String	City
CountryCode	String
CountryName	String
CpyID	Int32	Houshold ID in B2C intance\n Company ID in B2B intance
CpyNotes	CtcCpyNotes
CreateDate	DateTime (nullable)
Email	String
Fax	String
LastModifDate	DateTime (nullable)
ModifiedBy	Int32 (nullable)
Name	String	Houshold name in B2C intance\n Company name in B2B intance
NationalID	String
OriginID	String
Phone	String
PostCode	String	Postcode
SourceID	String
StateCode	String	StateCode
StateName	String	County
Street	String	Address 2
SupInfo	List<SupInfo>
Web	String
Zone	String	Address 3
CtcCpyNotes Description
Name	Type	Description
AttachmentFilesList	List<Attachment>
AttachmentFilesListString	List<String>
Comment	String	Comment Text
CtcCpyID	Int32	Contact ID
LastModifiedBy	String
LastModifiedOn	DateTime
NoteUserID	Int32
SourceNote	Int32
Attachment Description
Name	Type	Description
AttachmentID	String
AttachmentName	String
ContentType	String
FileContent	String
FileName	String
FileSize	Int32 (nullable)
HasContent	Boolean
ID	Int32 (nullable)
SupInfo Description
Name	Type	Description
FieldContent	String	Field value
FieldName	String	Field name
CtcCpyNotes Description
Name	Type	Description
AttachmentFilesList	List<Attachment>
AttachmentFilesListString	List<String>
Comment	String	Comment Text
CtcCpyID	Int32	Contact ID
LastModifiedBy	String
LastModifiedOn	DateTime
NoteUserID	Int32
SourceNote	Int32
Attachment Description
Name	Type	Description
AttachmentID	String
AttachmentName	String
ContentType	String
FileContent	String
FileName	String
FileSize	Int32 (nullable)
HasContent	Boolean
ID	Int32 (nullable)
SupInfo Description
Name	Type	Description
FieldContent	String	Field value
FieldName	String	Field name

"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"CtcID\": 1,\r\n \"LastName\": \"sample string 2\",\r\n \"CpyID\": 3,\r\n \"PositionFreeText\": \"sample string 7\",\r\n \"CreateDate\": \"2026-03-25T07:30:08.089856+00:00\",\r\n \"ModifDate\": \"2026-03-25T07:30:08.089856+00:00\",\r\n \"ModifiedBy\": 1,\r\n \"SourceID\": \"sample string 10\",\r\n \"OriginID\": \"sample string 11\",\r\n \"DoNotExport\": true,\r\n \"ParentEmailAddress\": \"sample string 14\",\r\n \"SupInfo\": [\r\n {\r\n \"FieldName\": \"sample string 1\",\r\n \"FieldContent\": \"sample string 4\"\r\n },\r\n {\r\n \"FieldName\": \"sample string 1\",\r\n \"FieldContent\": \"sample string 4\"\r\n }\r\n ],\r\n \"Company\": {\r\n \"CpyID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"Building\": \"sample string 4\",\r\n \"Street\": \"sample string 5\",\r\n \"Zone\": \"sample string 6\",\r\n \"City\": \"sample string 7\",\r\n \"PostCode\": \"sample string 8\",\r\n \"StateCode\": \"sample string 9\",\r\n \"StateName\": \"sample string 10\",\r\n \"CountryCode\": \"sample string 13\",\r\n \"CountryName\": \"sample string 14\",\r\n \"Phone\": \"sample string 15\",\r\n \"Fax\": \"sample string 16\",\r\n \"Web\": \"sample string 17\",\r\n \"Email\": \"sample string 18\",\r\n \"NationalID\": \"sample string 20\",\r\n \"SourceID\": \"sample string 21\",\r\n \"OriginID\": \"sample string 22\",\r\n \"CreateDate\": \"2026-03-25T07:30:08.1054828+00:00\",\r\n \"LastModifDate\": \"2026-03-25T07:30:08.1054828+00:00\",\r\n \"ModifiedBy\": 1,\r\n \"CpyNotes\": {\r\n \"CtcCpyID\": 1,\r\n \"NoteUserID\": 2,\r\n \"SourceNote\": 3,\r\n \"Comment\": \"sample string 4\",\r\n \"LastModifiedBy\": \"sample string 5\",\r\n \"LastModifiedOn\": \"2026-03-25T07:30:08.1054828+00:00\",\r\n \"AttachmentFilesList\": [\r\n {\r\n \"k__BackingField\": \"sample string 1\",\r\n \"k__BackingField\": \"sample string 2\",\r\n \"k__BackingField\": \"sample string 3\",\r\n \"k__BackingField\": \"sample string 4\",\r\n \"k__BackingField\": \"sample string 5\",\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": true\r\n },\r\n {\r\n \"k__BackingField\": \"sample string 1\",\r\n \"k__BackingField\": \"sample string 2\",\r\n \"k__BackingField\": \"sample string 3\",\r\n \"k__BackingField\": \"sample string 4\",\r\n \"k__BackingField\": \"sample string 5\",\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": true\r\n }\r\n ],\r\n \"AttachmentFilesListString\": [\r\n \"sample string 1\",\r\n \"sample string 2\"\r\n ]\r\n },\r\n \"SupInfo\": [\r\n {\r\n \"FieldName\": \"sample string 1\",\r\n \"FieldContent\": \"sample string 4\"\r\n },\r\n {\r\n \"FieldName\": \"sample string 1\",\r\n \"FieldContent\": \"sample string 4\"\r\n }\r\n ]\r\n },\r\n \"CtcNotes\": {\r\n \"CtcCpyID\": 1,\r\n \"NoteUserID\": 2,\r\n \"SourceNote\": 3,\r\n \"Comment\": \"sample string 4\",\r\n \"LastModifiedBy\": \"sample string 5\",\r\n \"LastModifiedOn\": \"2026-03-25T07:30:08.1054828+00:00\",\r\n \"AttachmentFilesList\": [\r\n {\r\n \"k__BackingField\": \"sample string 1\",\r\n \"k__BackingField\": \"sample string 2\",\r\n \"k__BackingField\": \"sample string 3\",\r\n \"k__BackingField\": \"sample string 4\",\r\n \"k__BackingField\": \"sample string 5\",\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": true\r\n },\r\n {\r\n \"k__BackingField\": \"sample string 1\",\r\n \"k__BackingField\": \"sample string 2\",\r\n \"k__BackingField\": \"sample string 3\",\r\n \"k__BackingField\": \"sample string 4\",\r\n \"k__BackingField\": \"sample string 5\",\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": true\r\n }\r\n ],\r\n \"AttachmentFilesListString\": [\r\n \"sample string 1\",\r\n \"sample string 2\"\r\n ]\r\n },\r\n \"Gender\": null,\r\n \"PredefinedGender\": 0,\r\n \"ProcessMydata\": true,\r\n \"DeleteMyData\": true,\r\n \"HomeSiteID\": \"sample string 20\",\r\n \"BrandID\": 1,\r\n \"MemberNumbersList\": [\r\n \"sample string 1\",\r\n \"sample string 2\"\r\n ],\r\n \"CurrentMemberNumber\": \"sample string 21\",\r\n \"CardTokensList\": [\r\n \"sample string 1\",\r\n \"sample string 2\"\r\n ],\r\n \"CardToken\": \"sample string 22\",\r\n \"CurrentReferrerCode\": \"sample string 23\",\r\n \"ReferrerCodeList\": [\r\n \"sample string 1\",\r\n \"sample string 2\"\r\n ],\r\n \"ReferredByCode\": \"sample string 24\",\r\n \"ReferrerCode\": \"sample string 25\",\r\n \"UpdateIfPopulated\": true,\r\n \"IsLeadCtc\": true,\r\n \"IsFinanceCtc\": true,\r\n \"CorporateName\": \"sample string 29\",\r\n \"CorporateJobTitle\": 30,\r\n \"Picture\": \"QEA=\",\r\n \"IsFinanceCtcTemplate\": \"

\",\r\n \"IsLeadCtcCtcTemplate\": \"

\n Get customer ID(CtcID) and MD5 by Email\n \n

Response Payload

Name	Type	Description
ContactIDsOutput Description
CtcIDs	List<ContactIDs>	List of contact IDS
Error	String	The error description
Response	Boolean	The status of the call
ContactIDs Description
Name	Type	Description
CtcID	Int32	The CtcID
MD5	String	The MD5

","urlObject":{"protocol":"https","path":["api","Contact","GetContactIDsByEmail"],"host":["{{Host}}"],"query":[{"key":"Email","value":"Email-value"}],"variable":[]}},"response":[{"id":"c792b5bb-0d9b-4ef8-bd2e-260a0ca9afe9","name":"api/Contact/GetContactIDsByEmail?Email={Email} Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":{"raw":"https://{{Host}}/api/Contact/GetContactIDsByEmail?Email=Email-value","protocol":"https","host":["{{Host}}"],"path":["api","Contact","GetContactIDsByEmail"],"query":[{"key":"Email","value":"Email-value"}]},"description":"

\r\n Get customer ID(CtcID) and MD5 by Email\r\n \n

Response Payload

Name	Type	Description
ContactIDsOutput Description
CtcIDs	List<ContactIDs>	List of contact IDS
Error	String	The error description
Response	Boolean	The status of the call
ContactIDs Description
Name	Type	Description
CtcID	Int32	The CtcID
MD5	String	The MD5

"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"Response\": true,\r\n \"CtcIDs\": [\r\n {\r\n \"CtcID\": 1,\r\n \"MD5\": \"sample string 2\"\r\n },\r\n {\r\n \"CtcID\": 1,\r\n \"MD5\": \"sample string 2\"\r\n }\r\n ],\r\n \"Error\": \"sample string 2\"\r\n}"}],"_postman_id":"6a217d83-4c27-4a49-8095-a02d3d7c5316"},{"name":"GetContactIDsByMobilePhone","id":"008c91e0-df6f-4cf5-b9f2-8036404b5b44","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"https://{{Host}}/api/Contact/GetContactIDsByMobilePhone?MobilePhone=MobilePhone-value","description":"

\n Get list of customers (CtcID and MD5) sharing the same Mobile Phone\n \n

Response Payload

Name	Type	Description
ContactIDsOutput Description
CtcIDs	List<ContactIDs>	List of contact IDS
Error	String	The error description
Response	Boolean	The status of the call
ContactIDs Description
Name	Type	Description
CtcID	Int32	The CtcID
MD5	String	The MD5

","urlObject":{"protocol":"https","path":["api","Contact","GetContactIDsByMobilePhone"],"host":["{{Host}}"],"query":[{"key":"MobilePhone","value":"MobilePhone-value"}],"variable":[]}},"response":[{"id":"10dbc0e7-bc24-4ad0-9d69-7a55a730c6d5","name":"api/Contact/GetContactIDsByMobilePhone?MobilePhone={MobilePhone} Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":{"raw":"https://{{Host}}/api/Contact/GetContactIDsByMobilePhone?MobilePhone=MobilePhone-value","protocol":"https","host":["{{Host}}"],"path":["api","Contact","GetContactIDsByMobilePhone"],"query":[{"key":"MobilePhone","value":"MobilePhone-value"}]},"description":"

\r\n Get list of customers (CtcID and MD5) sharing the same Mobile Phone\r\n \n

Response Payload

Name	Type	Description
ContactIDsOutput Description
CtcIDs	List<ContactIDs>	List of contact IDS
Error	String	The error description
Response	Boolean	The status of the call
ContactIDs Description
Name	Type	Description
CtcID	Int32	The CtcID
MD5	String	The MD5

"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"Response\": true,\r\n \"CtcIDs\": [\r\n {\r\n \"CtcID\": 1,\r\n \"MD5\": \"sample string 2\"\r\n },\r\n {\r\n \"CtcID\": 1,\r\n \"MD5\": \"sample string 2\"\r\n }\r\n ],\r\n \"Error\": \"sample string 2\"\r\n}"}],"_postman_id":"008c91e0-df6f-4cf5-b9f2-8036404b5b44"},{"name":"GetContactIDsBySupInfo","id":"637a9e92-df39-4bc0-b329-649b7756c1ff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"https://{{Host}}/api/Contact/GetContactIDsBySupInfo?SupInfoField=SupInfoField-value&SupInfoValue=SupInfoValue-value","description":"

\n Get list of customers (CtcID and MD5) sharing the same Sup Info field\n \n

Response Payload

Name	Type	Description
ContactIDsOutput Description
CtcIDs	List<ContactIDs>	List of contact IDS
Error	String	The error description
Response	Boolean	The status of the call
ContactIDs Description
Name	Type	Description
CtcID	Int32	The CtcID
MD5	String	The MD5

","urlObject":{"protocol":"https","path":["api","Contact","GetContactIDsBySupInfo"],"host":["{{Host}}"],"query":[{"key":"SupInfoField","value":"SupInfoField-value"},{"key":"SupInfoValue","value":"SupInfoValue-value"}],"variable":[]}},"response":[{"id":"30489550-834b-49ac-b270-1c20b10594b3","name":"api/Contact/GetContactIDsBySupInfo?SupInfoField={SupInfoField}&SupInfoValue={SupInfoValue} Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":{"raw":"https://{{Host}}/api/Contact/GetContactIDsBySupInfo?SupInfoField=SupInfoField-value&SupInfoValue=SupInfoValue-value","protocol":"https","host":["{{Host}}"],"path":["api","Contact","GetContactIDsBySupInfo"],"query":[{"key":"SupInfoField","value":"SupInfoField-value"},{"key":"SupInfoValue","value":"SupInfoValue-value"}]},"description":"

\r\n Get list of customers (CtcID and MD5) sharing the same Sup Info field\r\n \n

Response Payload

Name	Type	Description
ContactIDsOutput Description
CtcIDs	List<ContactIDs>	List of contact IDS
Error	String	The error description
Response	Boolean	The status of the call
ContactIDs Description
Name	Type	Description
CtcID	Int32	The CtcID
MD5	String	The MD5

"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"Response\": true,\r\n \"CtcIDs\": [\r\n {\r\n \"CtcID\": 1,\r\n \"MD5\": \"sample string 2\"\r\n },\r\n {\r\n \"CtcID\": 1,\r\n \"MD5\": \"sample string 2\"\r\n }\r\n ],\r\n \"Error\": \"sample string 2\"\r\n}"}],"_postman_id":"637a9e92-df39-4bc0-b329-649b7756c1ff"},{"name":"GetContactNodes","id":"f8bd439b-9638-410b-8ec6-f47d103faeff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"https://{{Host}}/api/Contact/GetContactNodes/:ID?ParentNodeCode=ParentNodeCode-value","description":"

\n Retrieves a contact’s nodes status for a specific parent node in the tree \n \n

Response Payload

Name	Type	Description
ContactPreference Description
Name	String	Description of the node
NodeCode	Int32	The ID of the node
Status	Boolean	True if it's flagged ; False if not

","urlObject":{"protocol":"https","path":["api","Contact","GetContactNodes",":ID"],"host":["{{Host}}"],"query":[{"key":"ParentNodeCode","value":"ParentNodeCode-value"}],"variable":[{"id":"a42f95b9-a12d-4ca9-98cb-7702e9ca521f","type":"any","key":"ID"}]}},"response":[{"id":"7667802c-458a-4870-b0ab-1b677a560b9f","name":"api/Contact/GetContactNodes/{ID}?ParentNodeCode={ParentNodeCode} Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":{"raw":"https://{{Host}}/api/Contact/GetContactNodes/:ID?ParentNodeCode=ParentNodeCode-value","protocol":"https","host":["{{Host}}"],"path":["api","Contact","GetContactNodes",":ID"],"query":[{"key":"ParentNodeCode","value":"ParentNodeCode-value"}],"variable":[{"key":"ID"}]},"description":"

\r\n Retrieves a contact’s nodes status for a specific parent node in the tree \r\n \n

Response Payload

Name	Type	Description
ContactPreference Description
Name	String	Description of the node
NodeCode	Int32	The ID of the node
Status	Boolean	True if it's flagged ; False if not

"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"NodeCode\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"Status\": true\r\n },\r\n {\r\n \"NodeCode\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"Status\": true\r\n }\r\n]"}],"_postman_id":"f8bd439b-9638-410b-8ec6-f47d103faeff"},{"name":"GetContactNodesHiddenExcluded","id":"95f36831-058b-4c5e-9352-7cbbfed4d9fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"https://{{Host}}/api/Contact/GetContactNodesHiddenExcluded/:ID?ParentNodeCode=ParentNodeCode-value","description":"

\n Retrieves a contact's nodes status for a specific parent node in the tree \n \n

Response Payload

Name	Type	Description
ContactPreferenceHiddenExcluded Description
IsHiddenInAPI	Boolean	True if it's flagged as Hidden in API
Name	String	Description of the node
NodeCode	Int32	The ID of the node
Status	Boolean	True if it's flagged ; False if not

","urlObject":{"protocol":"https","path":["api","Contact","GetContactNodesHiddenExcluded",":ID"],"host":["{{Host}}"],"query":[{"key":"ParentNodeCode","value":"ParentNodeCode-value"}],"variable":[{"id":"b935b169-b6c2-4934-9e22-0a5088274828","type":"any","key":"ID"}]}},"response":[{"id":"f512eb0a-3e64-4f6f-a7c6-64cdb4cf709a","name":"api/Contact/GetContactNodesHiddenExcluded/{ID}?ParentNodeCode={ParentNodeCode} Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":{"raw":"https://{{Host}}/api/Contact/GetContactNodesHiddenExcluded/:ID?ParentNodeCode=ParentNodeCode-value","protocol":"https","host":["{{Host}}"],"path":["api","Contact","GetContactNodesHiddenExcluded",":ID"],"query":[{"key":"ParentNodeCode","value":"ParentNodeCode-value"}],"variable":[{"key":"ID"}]},"description":"

\r\n Retrieves a contact's nodes status for a specific parent node in the tree \r\n \n

Response Payload

Name	Type	Description
ContactPreferenceHiddenExcluded Description
IsHiddenInAPI	Boolean	True if it's flagged as Hidden in API
Name	String	Description of the node
NodeCode	Int32	The ID of the node
Status	Boolean	True if it's flagged ; False if not

"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"IsHiddenInAPI\": true,\r\n \"NodeCode\": 2,\r\n \"Name\": \"sample string 3\",\r\n \"Status\": true\r\n },\r\n {\r\n \"IsHiddenInAPI\": true,\r\n \"NodeCode\": 2,\r\n \"Name\": \"sample string 3\",\r\n \"Status\": true\r\n }\r\n]"}],"_postman_id":"95f36831-058b-4c5e-9352-7cbbfed4d9fe"},{"name":"GetContactPreferredSiteDetails","id":"3ae93f3f-a053-4bb8-976f-71ff7cae2786","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"https://{{Host}}/api/Contact/GetContactPreferredSiteDetails?CtcID=CtcID-value","description":"

\n Get Preferred site details by customer\n \n

Response Payload

Name	Type	Description
Contact_PreferredSiteDetailsOutput Description
Address	String	The Preferred Site Address
CtcID	Int32	The CtcID
Error	String	The error description
ImageURL	String	The Preferred Site Image URL
Response	Boolean	The status of the call
SiteID	Int32 (nullable)	The Preferred SiteID
SiteName	String	The Preferred Site Name
Telephone	String	The Preferred Site Telephone

","urlObject":{"protocol":"https","path":["api","Contact","GetContactPreferredSiteDetails"],"host":["{{Host}}"],"query":[{"key":"CtcID","value":"CtcID-value"}],"variable":[]}},"response":[{"id":"839791b1-68aa-462c-90bd-e7effa171127","name":"api/Contact/GetContactPreferredSiteDetails?CtcID={CtcID} Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":{"raw":"https://{{Host}}/api/Contact/GetContactPreferredSiteDetails?CtcID=CtcID-value","protocol":"https","host":["{{Host}}"],"path":["api","Contact","GetContactPreferredSiteDetails"],"query":[{"key":"CtcID","value":"CtcID-value"}]},"description":"

\r\n Get Preferred site details by customer\r\n \n

Response Payload

Name	Type	Description
Contact_PreferredSiteDetailsOutput Description
Address	String	The Preferred Site Address
CtcID	Int32	The CtcID
Error	String	The error description
ImageURL	String	The Preferred Site Image URL
Response	Boolean	The status of the call
SiteID	Int32 (nullable)	The Preferred SiteID
SiteName	String	The Preferred Site Name
Telephone	String	The Preferred Site Telephone

"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"Response\": true,\r\n \"Error\": \"sample string 2\",\r\n \"CtcID\": 3,\r\n \"SiteID\": 1,\r\n \"SiteName\": \"sample string 4\",\r\n \"ImageURL\": \"sample string 5\",\r\n \"Address\": \"sample string 6\",\r\n \"Telephone\": \"sample string 7\"\r\n}"}],"_postman_id":"3ae93f3f-a053-4bb8-976f-71ff7cae2786"},{"name":"GetContacts","id":"83ab09fd-bc9e-4bfa-a0e8-d1cd7f6b49eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"https://{{Host}}/api/Contact/GetContacts?criteria=criteria-value","description":"

\n Search the database for Contacts using the Full Text Search engine \n \n

","urlObject":{"protocol":"https","path":["api","Contact","GetContacts"],"host":["{{Host}}"],"query":[{"key":"criteria","value":"criteria-value"}],"variable":[]}},"response":[{"id":"ea7ec6ba-054b-421b-887b-f9cbc80d9449","name":"api/Contact/GetContacts?criteria={criteria} Sample","originalRequest":{"auth":{"type":"bearer","bearer":{"token":null}},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":{"raw":"https://{{Host}}/api/Contact/GetContacts?criteria=criteria-value","protocol":"https","host":["{{Host}}"],"path":["api","Contact","GetContacts"],"query":[{"key":"criteria","value":"criteria-value"}]},"description":"

\r\n Search the database for Contacts using the Full Text Search engine \r\n \n

"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"CtcID\": 1,\r\n \"LastName\": \"sample string 2\",\r\n \"CpyID\": 3,\r\n \"PositionFreeText\": \"sample string 7\",\r\n \"CreateDate\": \"2026-03-25T07:30:08.1689688+00:00\",\r\n \"ModifDate\": \"2026-03-25T07:30:08.1689688+00:00\",\r\n \"ModifiedBy\": 1,\r\n \"SourceID\": \"sample string 10\",\r\n \"OriginID\": \"sample string 11\",\r\n \"DoNotExport\": true,\r\n \"ParentEmailAddress\": \"sample string 14\",\r\n \"SupInfo\": [\r\n {\r\n \"FieldName\": \"sample string 1\",\r\n \"FieldContent\": \"sample string 4\"\r\n },\r\n {\r\n \"FieldName\": \"sample string 1\",\r\n \"FieldContent\": \"sample string 4\"\r\n }\r\n ],\r\n \"Company\": {\r\n \"CpyID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"Building\": \"sample string 4\",\r\n \"Street\": \"sample string 5\",\r\n \"Zone\": \"sample string 6\",\r\n \"City\": \"sample string 7\",\r\n \"PostCode\": \"sample string 8\",\r\n \"StateCode\": \"sample string 9\",\r\n \"StateName\": \"sample string 10\",\r\n \"CountryCode\": \"sample string 13\",\r\n \"CountryName\": \"sample string 14\",\r\n \"Phone\": \"sample string 15\",\r\n \"Fax\": \"sample string 16\",\r\n \"Web\": \"sample string 17\",\r\n \"Email\": \"sample string 18\",\r\n \"NationalID\": \"sample string 20\",\r\n \"SourceID\": \"sample string 21\",\r\n \"OriginID\": \"sample string 22\",\r\n \"CreateDate\": \"2026-03-25T07:30:08.1689688+00:00\",\r\n \"LastModifDate\": \"2026-03-25T07:30:08.1689688+00:00\",\r\n \"ModifiedBy\": 1,\r\n \"CpyNotes\": {\r\n \"CtcCpyID\": 1,\r\n \"NoteUserID\": 2,\r\n \"SourceNote\": 3,\r\n \"Comment\": \"sample string 4\",\r\n \"LastModifiedBy\": \"sample string 5\",\r\n \"LastModifiedOn\": \"2026-03-25T07:30:08.1689688+00:00\",\r\n \"AttachmentFilesList\": [\r\n {\r\n \"k__BackingField\": \"sample string 1\",\r\n \"k__BackingField\": \"sample string 2\",\r\n \"k__BackingField\": \"sample string 3\",\r\n \"k__BackingField\": \"sample string 4\",\r\n \"k__BackingField\": \"sample string 5\",\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": true\r\n },\r\n {\r\n \"k__BackingField\": \"sample string 1\",\r\n \"k__BackingField\": \"sample string 2\",\r\n \"k__BackingField\": \"sample string 3\",\r\n \"k__BackingField\": \"sample string 4\",\r\n \"k__BackingField\": \"sample string 5\",\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": true\r\n }\r\n ],\r\n \"AttachmentFilesListString\": [\r\n \"sample string 1\",\r\n \"sample string 2\"\r\n ]\r\n },\r\n \"SupInfo\": [\r\n {\r\n \"FieldName\": \"sample string 1\",\r\n \"FieldContent\": \"sample string 4\"\r\n },\r\n {\r\n \"FieldName\": \"sample string 1\",\r\n \"FieldContent\": \"sample string 4\"\r\n }\r\n ]\r\n },\r\n \"CtcNotes\": {\r\n \"CtcCpyID\": 1,\r\n \"NoteUserID\": 2,\r\n \"SourceNote\": 3,\r\n \"Comment\": \"sample string 4\",\r\n \"LastModifiedBy\": \"sample string 5\",\r\n \"LastModifiedOn\": \"2026-03-25T07:30:08.1689688+00:00\",\r\n \"AttachmentFilesList\": [\r\n {\r\n \"k__BackingField\": \"sample string 1\",\r\n \"k__BackingField\": \"sample string 2\",\r\n \"k__BackingField\": \"sample string 3\",\r\n \"k__BackingField\": \"sample string 4\",\r\n \"k__BackingField\": \"sample string 5\",\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": true\r\n },\r\n {\r\n \"k__BackingField\": \"sample string 1\",\r\n \"k__BackingField\": \"sample string 2\",\r\n \"k__BackingField\": \"sample string 3\",\r\n \"k__BackingField\": \"sample string 4\",\r\n \"k__BackingField\": \"sample string 5\",\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": true\r\n }\r\n ],\r\n \"AttachmentFilesListString\": [\r\n \"sample string 1\",\r\n \"sample string 2\"\r\n ]\r\n },\r\n \"Gender\": null,\r\n \"PredefinedGender\": 0,\r\n \"ProcessMydata\": true,\r\n \"DeleteMyData\": true,\r\n \"HomeSiteID\": \"sample string 20\",\r\n \"BrandID\": 1,\r\n \"MemberNumbersList\": [\r\n \"sample string 1\",\r\n \"sample string 2\"\r\n ],\r\n \"CurrentMemberNumber\": \"sample string 21\",\r\n \"CardTokensList\": [\r\n \"sample string 1\",\r\n \"sample string 2\"\r\n ],\r\n \"CardToken\": \"sample string 22\",\r\n \"CurrentReferrerCode\": \"sample string 23\",\r\n \"ReferrerCodeList\": [\r\n \"sample string 1\",\r\n \"sample string 2\"\r\n ],\r\n \"ReferredByCode\": \"sample string 24\",\r\n \"ReferrerCode\": \"sample string 25\",\r\n \"UpdateIfPopulated\": true,\r\n \"IsLeadCtc\": true,\r\n \"IsFinanceCtc\": true,\r\n \"CorporateName\": \"sample string 29\",\r\n \"CorporateJobTitle\": 30,\r\n \"Picture\": \"QEA=\",\r\n \"IsFinanceCtcTemplate\": \"

\",\r\n \"IsLeadCtcCtcTemplate\": \"

\",\r\n \"ContactSpendInLast12Months\": \"sample string 31\",\r\n \"_Title\": \"sample string 33\",\r\n \"FirstName\": \"sample string 34\",\r\n \"Phone\": \"sample string 35\",\r\n \"MobilPhone\": \"sample string 36\",\r\n \"Email\": \"sample string 37\",\r\n \"BirthDate\": \"2026-03-25T07:30:08.1689688+00:00\"\r\n },\r\n {\r\n \"CtcID\": 1,\r\n \"LastName\": \"sample string 2\",\r\n \"CpyID\": 3,\r\n \"PositionFreeText\": \"sample string 7\",\r\n \"CreateDate\": \"2026-03-25T07:30:08.1689688+00:00\",\r\n \"ModifDate\": \"2026-03-25T07:30:08.1689688+00:00\",\r\n \"ModifiedBy\": 1,\r\n \"SourceID\": \"sample string 10\",\r\n \"OriginID\": \"sample string 11\",\r\n \"DoNotExport\": true,\r\n \"ParentEmailAddress\": \"sample string 14\",\r\n \"SupInfo\": [\r\n {\r\n \"FieldName\": \"sample string 1\",\r\n \"FieldContent\": \"sample string 4\"\r\n },\r\n {\r\n \"FieldName\": \"sample string 1\",\r\n \"FieldContent\": \"sample string 4\"\r\n }\r\n ],\r\n \"Company\": {\r\n \"CpyID\": 1,\r\n \"Name\": \"sample string 2\",\r\n \"Building\": \"sample string 4\",\r\n \"Street\": \"sample string 5\",\r\n \"Zone\": \"sample string 6\",\r\n \"City\": \"sample string 7\",\r\n \"PostCode\": \"sample string 8\",\r\n \"StateCode\": \"sample string 9\",\r\n \"StateName\": \"sample string 10\",\r\n \"CountryCode\": \"sample string 13\",\r\n \"CountryName\": \"sample string 14\",\r\n \"Phone\": \"sample string 15\",\r\n \"Fax\": \"sample string 16\",\r\n \"Web\": \"sample string 17\",\r\n \"Email\": \"sample string 18\",\r\n \"NationalID\": \"sample string 20\",\r\n \"SourceID\": \"sample string 21\",\r\n \"OriginID\": \"sample string 22\",\r\n \"CreateDate\": \"2026-03-25T07:30:08.1689688+00:00\",\r\n \"LastModifDate\": \"2026-03-25T07:30:08.1689688+00:00\",\r\n \"ModifiedBy\": 1,\r\n \"CpyNotes\": {\r\n \"CtcCpyID\": 1,\r\n \"NoteUserID\": 2,\r\n \"SourceNote\": 3,\r\n \"Comment\": \"sample string 4\",\r\n \"LastModifiedBy\": \"sample string 5\",\r\n \"LastModifiedOn\": \"2026-03-25T07:30:08.1689688+00:00\",\r\n \"AttachmentFilesList\": [\r\n {\r\n \"k__BackingField\": \"sample string 1\",\r\n \"k__BackingField\": \"sample string 2\",\r\n \"k__BackingField\": \"sample string 3\",\r\n \"k__BackingField\": \"sample string 4\",\r\n \"k__BackingField\": \"sample string 5\",\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": 1,\r\n \"k__BackingField\": true\r\n },\r\n {\r\n \"k__BackingField\": \"sample string 1\",\r\n \"k__BackingField\": \"sample string 2\",\r\n \"k__BackingField\": \"sample string 3\",\r\n \"k__BackingField\": \"sample string 4\",\r\n \"k__BackingField\": \"sample string 5\",\r\n \"

Name	Type	Description
CtcIDMd5Output Description
CtcID	Int32	The CtcID
Error	String	The error description
MD5	String	The MD5
Response	Boolean	The status of the call

Name	Type	Description
ErasedContacts Description
ErasedCustomers	List<ErasedContact>	List of contact IDS
Error	String	The error description
Response	Boolean	The status of the call
ErasedContact Description
Name	Type	Description
CtcID	Int32	The CtcID
HashedEmail	String	Hashed Email Address
HashedMobile	String	Hashed Mobile Phone
OriginID	String	Origin ID

Name	Type	Description
ExtendedErasedContacts Description
BatchCount	Int32	The remaining contacts
BatchID	Int32	The BatchID
BatchSize	Int32	The total number of batches
ErasedCustomers	List<ErasedContact>	List of contact IDS
Error	String	The error description
Response	Boolean	The status of the call
ErasedContact Description
Name	Type	Description
CtcID	Int32	The CtcID
HashedEmail	String	Hashed Email Address
HashedMobile	String	Hashed Mobile Phone
OriginID	String	Origin ID

Name	Type	Description	Required
FacebookDetails Description
ContactFacebookID	String	Contact Facebook ID	False
CtcID	Int32	SCV unique identifier	False
FacebookPageID	String	Facebook ID of the page liked by the contact	False
OriginID	String	External ID	False
SourceID	String	Source ID	False

Name	Type	Description
FacebookDetailsOutput Description
Error	String	The error description
Response	Boolean	The status of the call

Name	Type	Description	Required
PostContactPreference Description
BrandName	String	Brand Name	False
ChangeDate	DateTime (nullable)	Change Date	False
ContactPreferences	List<ContactPreference>	List Of preferences: it contains all preferences with status of each one.	False
ID	Int32	Contact ID	False
SourceID	String	SourceID	False
ContactPreference Description
Name	Type	Description	Required
Name	String	Description of the node	False
NodeCode	Int32	The ID of the node	False
Status	Boolean	True if it's flagged ; False if not	False

Name	Type	Description	Required
PreferredSiteInput Description
CtcID	Int32	the contact ID	False
SiteID	Int32	Atreemo site ID	False

Name	Type	Description	Required
SetContactNodesInput Description
ActiveNodeCode	Int32[]	Collection of the active node IDs (nodes not specified in this collection will be deleted for this CtcID)	False
CtcID	Int32	ContactID	False
ParentNodeCode	Int32	Parent node id in the tree	False
SourceID	String	Source of the update	False

Name	Type	Description
SetContactNodesOutput Description
Error	List<String>
Success	Boolean

Name	Type	Required
ValidateContactSupInfoInput Description
Email	String	False
Mobile	String	False
SupInfoField	String	False
SupInfoValue	String	False

Name	Type	Description
ValidateContactSupInfoOutput Description
ContactFullName	String
CtcID	Int32 (nullable)
Error	String
IsValid	Boolean
Response	Boolean
ValidationMsg	String

Name	Type	Required
ContactMemberNumberInput Description
Email	String	False
MemberNumber	String	False

Name	Type	Description
ValidateContactMemberNumberOutput Description
ContactFullName	String
CtcID	Int32 (nullable)
Error	String
IsValid	Boolean
Response	Boolean
ValidationMsg	String

Name	Type	Description
PostCorporateData Description
AccountManager	Int32	Account Manager
AnnualBudget	String	Annual Budget
AnnualValue	String	Annual Value
CommissionType	String	Commission type
CommissionTypeID	Int32
CommissionValue	String	Commission Value
CompanyAnniversaryDate	DateTime (nullable)
CompanyType	String	Company Type
ContractRenewalDate	DateTime (nullable)	Contract renewal date
CorporateName	String	CorporateName
CtcIDs	List<Int32>
Domains	List<CorporateDomains>
Email	String	Corporate Email
FinanceCtc	Contact	Finance contact
FormCompleted	Boolean	FormCompleted
ID	Int32 (nullable)	Corporate ID
IndustryID	Int32	IndustryID
IsActive	Boolean	IsActive
IsInvoiceInAdvance	Boolean	IsInvoiceInAdvance
Last12monthsvalue	Single
LeadCtc	Contact	Lead contact
LifetimeValue	Single
LoyalteScheme	String	Loyalty Scheme
LoyalteSchemeID	Int32
Notes	String	Notes
NumberEmployee	Int32	Number of employee
Phone	String	Corporate Phone
TypeID	Int32
Website	String	Corporate Website
CorporateDomains Description
Name	Type	Description
CorporateID	Int32
Domain	String
ID	Int32
Contact Description
Name	Type	Description
_Title	String	Person title
BirthDate	DateTime (nullable)	Date of birth
BrandID	Int32 (nullable)	The ID of the Brand the customer should belongs to
CardToken	String
CardTokensList	List<String>	return the list of card tokens linked to this contact
Company	Company	Collection of company information
ContactSpendInLast12Months	String
CorporateJobTitle	Int32
CorporateName	String
CpyID	Int32	Houshold ID in B2C intance\n Company ID in B2B intance
CreateDate	DateTime (nullable)	Creation Date (used only in PostContact)
CtcID	Int32	The ID of the customer (CtcID)
CtcNotes	CtcCpyNotes	Collection of complementary notes
CurrentMemberNumber	String	return the last member number linked to this contact
CurrentReferrerCode	String	Get the referrer code of the contact
DeleteMyData	Boolean (nullable)	Confirmation to delete the personal data of this contact (USED ONLY in PUTCONTACT)
DoNotExport	Boolean	Shows if contact can be exported
Email	String	Email address
FirstName	String	First Name
HomeSiteID	String	The Site ID added will be used to flag the customer against a Selected Site
IsFinanceCtc	Boolean
IsFinanceCtcTemplate	String
IsLeadCtc	Boolean
IsLeadCtcCtcTemplate	String
LastName	String	Last Name
MemberNumbersList	List<String>	return the list of member numbers linked to this contact
MobilPhone	String	Mobile number
ModifDate	DateTime (nullable)	Last modification date (used only in PostContact)
ModifiedBy	Int32 (nullable)	CtcID of the user who applied the last modification
OriginID	String	OriginID
ParentEmailAddress	String	Parent Email Address (To be used when the contact age under 16)
Phone	String	Landline number
Picture	Byte[]	The Image of the contact
PositionFreeText	String	Job Free Text
PredefinedGender	GenderEnum	Gender :\n Unknown,\n Male,\n Female,\n PreferNotToSay,
ProcessMydata	Boolean (nullable)	Confirmation to process the data of this contact (USED ONLY in PUTCONTACT)
ReferredByCode	String	Get or Update the referred by code of the contact
ReferrerCode	String	Update the referrer code of the contact
ReferrerCodeList	List<String>	return the list of referre codes linked to this contact
SourceID	String	Source ID
SupInfo	List<SupInfo>	Collection of contact supplementary information
UpdateIfPopulated	Boolean	Used only in PutContact method (Default = false).\n This will allow the user to update just a specifc contact field(s)\n IF false : the request will be considered as PUT HTTP request (updates the entire resource)\n IF true : the request will be considered as PATCH HTTP request (partial update). Only populated fields will be updated.
Company Description
Name	Type	Description
Building	String	Address 1
City	String	City
CountryCode	String
CountryName	String
CpyID	Int32	Houshold ID in B2C intance\n Company ID in B2B intance
CpyNotes	CtcCpyNotes
CreateDate	DateTime (nullable)
Email	String
Fax	String
LastModifDate	DateTime (nullable)
ModifiedBy	Int32 (nullable)
Name	String	Houshold name in B2C intance\n Company name in B2B intance
NationalID	String
OriginID	String
Phone	String
PostCode	String	Postcode
SourceID	String
StateCode	String	StateCode
StateName	String	County
Street	String	Address 2
SupInfo	List<SupInfo>
Web	String
Zone	String	Address 3
CtcCpyNotes Description
Name	Type	Description
AttachmentFilesList	List<Attachment>
AttachmentFilesListString	List<String>
Comment	String	Comment Text
CtcCpyID	Int32	Contact ID
LastModifiedBy	String
LastModifiedOn	DateTime
NoteUserID	Int32
SourceNote	Int32
Attachment Description
Name	Type	Description
AttachmentID	String
AttachmentName	String
ContentType	String
FileContent	String
FileName	String
FileSize	Int32 (nullable)
HasContent	Boolean
ID	Int32 (nullable)
SupInfo Description
Name	Type	Description
FieldContent	String	Field value
FieldName	String	Field name
CtcCpyNotes Description
Name	Type	Description
AttachmentFilesList	List<Attachment>
AttachmentFilesListString	List<String>
Comment	String	Comment Text
CtcCpyID	Int32	Contact ID
LastModifiedBy	String
LastModifiedOn	DateTime
NoteUserID	Int32
SourceNote	Int32
Attachment Description
Name	Type	Description
AttachmentID	String
AttachmentName	String
ContentType	String
FileContent	String
FileName	String
FileSize	Int32 (nullable)
HasContent	Boolean
ID	Int32 (nullable)
SupInfo Description
Name	Type	Description
FieldContent	String	Field value
FieldName	String	Field name
Contact Description
Name	Type	Description
_Title	String	Person title
BirthDate	DateTime (nullable)	Date of birth
BrandID	Int32 (nullable)	The ID of the Brand the customer should belongs to
CardToken	String
CardTokensList	List<String>	return the list of card tokens linked to this contact
Company	Company	Collection of company information
ContactSpendInLast12Months	String
CorporateJobTitle	Int32
CorporateName	String
CpyID	Int32	Houshold ID in B2C intance\n Company ID in B2B intance
CreateDate	DateTime (nullable)	Creation Date (used only in PostContact)
CtcID	Int32	The ID of the customer (CtcID)
CtcNotes	CtcCpyNotes	Collection of complementary notes
CurrentMemberNumber	String	return the last member number linked to this contact
CurrentReferrerCode	String	Get the referrer code of the contact
DeleteMyData	Boolean (nullable)	Confirmation to delete the personal data of this contact (USED ONLY in PUTCONTACT)
DoNotExport	Boolean	Shows if contact can be exported
Email	String	Email address
FirstName	String	First Name
HomeSiteID	String	The Site ID added will be used to flag the customer against a Selected Site
IsFinanceCtc	Boolean
IsFinanceCtcTemplate	String
IsLeadCtc	Boolean
IsLeadCtcCtcTemplate	String
LastName	String	Last Name
MemberNumbersList	List<String>	return the list of member numbers linked to this contact
MobilPhone	String	Mobile number
ModifDate	DateTime (nullable)	Last modification date (used only in PostContact)
ModifiedBy	Int32 (nullable)	CtcID of the user who applied the last modification
OriginID	String	OriginID
ParentEmailAddress	String	Parent Email Address (To be used when the contact age under 16)
Phone	String	Landline number
Picture	Byte[]	The Image of the contact
PositionFreeText	String	Job Free Text
PredefinedGender	GenderEnum	Gender :\n Unknown,\n Male,\n Female,\n PreferNotToSay,
ProcessMydata	Boolean (nullable)	Confirmation to process the data of this contact (USED ONLY in PUTCONTACT)
ReferredByCode	String	Get or Update the referred by code of the contact
ReferrerCode	String	Update the referrer code of the contact
ReferrerCodeList	List<String>	return the list of referre codes linked to this contact
SourceID	String	Source ID
SupInfo	List<SupInfo>	Collection of contact supplementary information
UpdateIfPopulated	Boolean	Used only in PutContact method (Default = false).\n This will allow the user to update just a specifc contact field(s)\n IF false : the request will be considered as PUT HTTP request (updates the entire resource)\n IF true : the request will be considered as PATCH HTTP request (partial update). Only populated fields will be updated.
Company Description
Name	Type	Description
Building	String	Address 1
City	String	City
CountryCode	String
CountryName	String
CpyID	Int32	Houshold ID in B2C intance\n Company ID in B2B intance
CpyNotes	CtcCpyNotes
CreateDate	DateTime (nullable)
Email	String
Fax	String
LastModifDate	DateTime (nullable)
ModifiedBy	Int32 (nullable)
Name	String	Houshold name in B2C intance\n Company name in B2B intance
NationalID	String
OriginID	String
Phone	String
PostCode	String	Postcode
SourceID	String
StateCode	String	StateCode
StateName	String	County
Street	String	Address 2
SupInfo	List<SupInfo>
Web	String
Zone	String	Address 3
CtcCpyNotes Description
Name	Type	Description
AttachmentFilesList	List<Attachment>
AttachmentFilesListString	List<String>
Comment	String	Comment Text
CtcCpyID	Int32	Contact ID
LastModifiedBy	String
LastModifiedOn	DateTime
NoteUserID	Int32
SourceNote	Int32
Attachment Description
Name	Type	Description
AttachmentID	String
AttachmentName	String
ContentType	String
FileContent	String
FileName	String
FileSize	Int32 (nullable)
HasContent	Boolean
ID	Int32 (nullable)
SupInfo Description
Name	Type	Description
FieldContent	String	Field value
FieldName	String	Field name
CtcCpyNotes Description
Name	Type	Description
AttachmentFilesList	List<Attachment>
AttachmentFilesListString	List<String>
Comment	String	Comment Text
CtcCpyID	Int32	Contact ID
LastModifiedBy	String
LastModifiedOn	DateTime
NoteUserID	Int32
SourceNote	Int32
Attachment Description
Name	Type	Description
AttachmentID	String
AttachmentName	String
ContentType	String
FileContent	String
FileName	String
FileSize	Int32 (nullable)
HasContent	Boolean
ID	Int32 (nullable)
SupInfo Description
Name	Type	Description
FieldContent	String	Field value
FieldName	String	Field name

Name	Type	Description
PostCorporateOutput Description
CorporateResponseData	PostCorporateResponseData
DomainResponseData	List<PostDomainResponseData>
Errors	List<APICallError>	Collection of errors if exist
ResponseStatus	Boolean	True: if the action was succsessfully treated \n False: if there is an error
PostCorporateResponseData Description
Name	Type	Description
CorporateID	Int32	Unique identifier of company
Message	String
PostDomainResponseData Description
Name	Type	Description
Domain	String	Unique identifier of company
Message	String
APICallError Description
Name	Type	Description
ErrorCode	Int32	The error code
ErrorDescription	String	The error description

Name	Type	Description	Required
RemoveContactFromCorporateInput Description
CorporateID	Int32 (nullable)	Unique identifier of company\n from which the contact will be removed.	False
CorporateName	String	The name of the corporate associated with the contact.	False
CtcID	Int32	The CtcID of the contact to be removed	False

Name	Type	Description
RemoveContactFromCorporateOutput Description
Errors	List<APICallError>	Collection of errors if exist
ResponseStatus	Boolean	True: if the action was succsessfully treated \n False: if there is an error
APICallError Description
Name	Type	Description
ErrorCode	Int32	The error code
ErrorDescription	String	The error description

Name	Type	Description
ApiCallResponse Description
Errors	List<APICallError>	Collection of errors if exist
ResponseStatus	Boolean	True: if the action was succsessfully treated \n False: if there is an error
APICallError Description
Name	Type	Description
ErrorCode	Int32	The error code
ErrorDescription	String	The error description

Name	Type	Description	Required
FindCtcIDPayLoad Description
BrandID	Int32 (nullable)	It's applicable only for the multibrand instances and it's mandatory if the connected user belongs to master brand or higher level\n You can find the brand(s) id(s) and name(s) by calling the method api/user/GetAllowedBrands	False
SearchFilters	FindCustomerSearchFilters	Filters to be used to search for customers	True
FindCustomerSearchFilters Description
Name	Type	Description	Required
BirthDate	DateTime (nullable)	Date of birth	False
CardToken	String	The card token of the customer	False
CtcID	Int32 (nullable)	Ctcid of the Customer : this id shouldn't been saved as it can be merged with another customer	False
CustomerAuthentication	CustomerAuthentication	Customer Authentication	False
DeviceToken	String	Push notification device token	False
Email	String	Email address	False
ExternalIdentifier	CustomerExtenalIdentifier	The combination of the external id and External Source should be unique in the database. These values can be used to find contact details	False
FirstName	String	First Name	False
GiftCardCode	String	A gift card code	False
LastName	String	Last Name	False
MD5	String	Token linked to the customer	False
MemberNumber	String	The member number of the customer	False
MobilePhone	String	Mobile number	False
Phone	String	Landline number	False
ReferredByCode	String	The referrer code of the friend who invited this customer	False
ReferrerCode	String	The referrer code of the customer	False
ReservationReference	BookingReference	A reservation details	False
Staff	Staff	A staff details	False
SupInfo	SupInfo	Customer supplementary information	False
VoucherCode	String	A voucher code	False
CustomerAuthentication Description
Name	Type	Description	Required
ApplicationName	String		False
HashedPassword	String		False
Username	String		False
CustomerExtenalIdentifier Description
Name	Type	Description	Required
ExternalID	String	External unique ID	False
ExternalSource	String	External Source	False
BookingReference Description
Name	Type	Description	Required
BookingSector	BookingSectorEnum (nullable)	Restaurant=1,\n Hotel=2,\n Other=3	False
ReservationReference	String	Reservation Reference	False
SupplierCode	Int32 (nullable)	Reservation Supplier Code : Call Api/Reservation/GetSuppliers to get full list\n Mandatory with ReservationReference field	False
Staff Description
Name	Type	Description	Required
Location	ApiLocation	A Staff Location	False
StaffID	String	A Staff ID	False
ApiLocation Description
Name	Type	Description	Required
ActeolSiteID	Int32	the ID of the site visited (Acteol id)	False
ExternalLocationID	String	the ID of the site visited (supplier site id if the user in mapped with a supplier)\n this field will be ignored if ActeolSiteID is populated	False
SupInfo Description
Name	Type	Description	Required
FieldContent	String	Field value	False
FieldName	String	Field name	False

Name	Type	Description
FindCustomerCtcIDOutput Description
Errors	List<APICallError>	Collection of errors if exist
ResponseData	List<FindCustomerCtcIDResponse>	search result
ResponseStatus	Boolean	True: if the action was succsessfully treated \n False: if there is an error
APICallError Description
Name	Type	Description
ErrorCode	Int32	The error code
ErrorDescription	String	The error description
FindCustomerCtcIDResponse Description
Name	Type	Description
CtcID	Int32	Ctcid of the Customer : this id shouldn't been saved as it can be merged with another customer
MD5	String	Token linked to the customer

Welcome to the Atreemo API Guide by Acteol (an Access company)

Getting Started

Basic Authentication

Making it easier for you:

Body Payload

CalendarEvent Description

Response Payload

CalendarEventOutput Description

CalendarEvent Description

Body Payload

CalendarEvent Description

Response Payload

CalendarEventOutput Description

CalendarEvent Description

Body Payload

CalendarEvent Description

Response Payload

CalendarEventOutput Description

CalendarEvent Description

Body Payload

CalendarEvent Description

Response Payload

CalendarEventOutput Description

CalendarEvent Description

Body Payload

ChatCompletionRequest Description

Messages Description

Body Payload

ChatCompletionRequest Description

Messages Description

Body Payload

ChatCompletionRequest Description

Messages Description

Body Payload

ChatCompletionRequest Description

Messages Description

Body Payload

ChatCompletionRequest Description

Messages Description

Body Payload

ChatCompletionRequest Description

Messages Description

Response Payload

CtcIDOutPut Description

Response Payload

CtcIDOutPut Description

Response Payload

TokensOutPut Description

Response Payload

TokensOutPut Description

Body Payload

LinkToInput Description

Response Payload

ApiOutput Description

Body Payload

LinkToInput Description

Response Payload

ApiOutput Description

Body Payload

Response Payload

Body Payload

Response Payload

Body Payload

LinkToInput Description

Body Payload

LinkToInput Description

Body Payload

TranslationRequest Description

Body Payload

TranslationRequest Description

Body Payload

AutoRedemptionValidationInput Description

Basket Description

BasketItem Description

BasketModifiersItem Description

Response Payload

RedemptionValidationOutput Description

BasketDiscountItem Description

Body Payload

AutoRedemptionValidationInput Description

Name	Type	Description	Required
FindCustomerPayLoad Description
BrandID	Int32 (nullable)	It's applicable only for the multibrand instances and it's mandatory if the connected user belongs to master brand or higher level \n You can find the brand(s) id(s) and name(s) by calling the method api/user/GetAllowedBrands	False
ResponseFilters	FindCustomerResponseFilters	Filters to be used to refine the call response . \n By default only personal details and atreemo IDs are included, if you need any other infomation, you should specify it here	False
SearchFilters	FindCustomerSearchFilters	Filters to be used to search for customers	True
FindCustomerResponseFilters Description
Name	Type	Description	Required
CorporateDetails	Boolean	Include corporate details (Acteol corporate ID and name) to the response	False
CustomerAuthentication	Boolean	Include customer Authentication to the response	False
CustomerNotes	Boolean	Include customer notes to the response	False
CustomerPicture	Boolean	Include customer picture to the response	False
InteractionsInfo	Boolean	Include customer interactions info (Favourite location, first visit, last visit, preferred location, selected location) to the response	False
Interests	Boolean	Include customer Interests (Acteol interest ID , Name, status, change date) to the response	False
LoyaltyDetails	Boolean	Include the loyalty details (CardTokens, Tier ,Balance ,MemberNumbers) to the response	False
MarketingOptin	Boolean	Include marketing optin (Email, sms, mail, phone, push, webpush, watsapp) to the response	False
Preferences	Boolean	Include customer preferences (Acteol preference ID , Name, status, change date) to the response	False
ReferrerDetails	Boolean	Include referrer details (ReferredByCode, ReferrerCode) to the response	False
StaffDetails	Boolean	Include customer staff details to the response	False
SupInfo	Boolean	Include SupInfo to the response	False
Tags	Boolean	Include tags details (tag name , image tag url) to the response	False
FindCustomerSearchFilters Description
Name	Type	Description	Required
BirthDate	DateTime (nullable)	Date of birth	False
CardToken	String	The card token of the customer	False
CtcID	Int32 (nullable)	Ctcid of the Customer : this id shouldn't been saved as it can be merged with another customer	False
CustomerAuthentication	CustomerAuthentication	Customer Authentication	False
DeviceToken	String	Push notification device token	False
Email	String	Email address	False
ExternalIdentifier	CustomerExtenalIdentifier	The combination of the external id and External Source should be unique in the database. These values can be used to find contact details	False
FirstName	String	First Name	False
GiftCardCode	String	A gift card code	False
LastName	String	Last Name	False
MD5	String	Token linked to the customer	False
MemberNumber	String	The member number of the customer	False
MobilePhone	String	Mobile number	False
Phone	String	Landline number	False
ReferredByCode	String	The referrer code of the friend who invited this customer	False
ReferrerCode	String	The referrer code of the customer	False
ReservationReference	BookingReference	A reservation details	False
Staff	Staff	A staff details	False
SupInfo	SupInfo	Customer supplementary information	False
VoucherCode	String	A voucher code	False
CustomerAuthentication Description
Name	Type	Description	Required
ApplicationName	String		False
HashedPassword	String		False
Username	String		False
CustomerExtenalIdentifier Description
Name	Type	Description	Required
ExternalID	String	External unique ID	False
ExternalSource	String	External Source	False
BookingReference Description
Name	Type	Description	Required
BookingSector	BookingSectorEnum (nullable)	Restaurant=1,\n Hotel=2,\n Other=3	False
ReservationReference	String	Reservation Reference	False
SupplierCode	Int32 (nullable)	Reservation Supplier Code : Call Api/Reservation/GetSuppliers to get full list\n Mandatory with ReservationReference field	False
Staff Description
Name	Type	Description	Required
Location	ApiLocation	A Staff Location	False
StaffID	String	A Staff ID	False
ApiLocation Description
Name	Type	Description	Required
ActeolSiteID	Int32	the ID of the site visited (Acteol id)	False
ExternalLocationID	String	the ID of the site visited (supplier site id if the user in mapped with a supplier)\n this field will be ignored if ActeolSiteID is populated	False
SupInfo Description
Name	Type	Description	Required
FieldContent	String	Field value	False
FieldName	String	Field name	False

Name	Type	Description
FindCustomerDetailsOutput Description
Errors	List<APICallError>	Collection of errors if exist
ResponseData	List<GetCustomerResponse>	search result
ResponseStatus	Boolean	True: if the action was succsessfully treated \n False: if there is an error
APICallError Description
Name	Type	Description
ErrorCode	Int32	The error code
ErrorDescription	String	The error description
GetCustomerResponse Description
Name	Type	Description
BrandID	Int32 (nullable)	Brand ID
CorporateDetails	ContactCorporateDetails	the name and the acteol ID of the customer company
CpyID	Int32	Household id of the customer
CreateDate	DateTime (nullable)	Creation Date
CtcID	Int32	Ctcid of the Customer : this id shouldn't been saved as it can be merged with another customer
CustomerAuthenticationDetails	List<CustomerAuthentication>	the Authentication details of the customer
CustomerNotes	List<CustomerNote>	collection Notes linked to this customer
CustomerPicture	CustomerPicture	the picture of the customer
DeleteMyData	Boolean (nullable)	If true Delete all info of Customer
DoNotExport	Boolean (nullable)	Default False , If true customer will be suspended from all communications
ExternalIdentifier	CustomerExtenalIdentifier	The combination of the external id and External Source should be unique in the database. These values can be used to find contact details
InteractionsInfo	SitesAndInteractions	customer interaction info contains all information about sites and visits
Interests	List<CustomerInterest>	Customer Interests
IsSuspended	Boolean	Customer Suspended (Info Read only )
LastModifiedSource	String	Last Modified Source
LoyaltyDetails	GetCustomerLoyalty	Loyalty details
MarketingOptin	GetMarketingOptin	Marketing optin preferences
MD5	String	Token linked to the customer used for my preference site SSO
ModifiedBy	Int32 (nullable)	Last modified by user ID
ModifiedByName	String	Last modified by user name
ModifiedDate	DateTime (nullable)	Last modification date
PersonalDetails	CustomerPD	Personal details of the customer
Preferences	List<CustomerPreference>	Customer preferences
ProcessMydata	Boolean (nullable)
PushNotificationDetails	List<PushNotificationDetails>	Details that will be used to send the push notification
ReferrerDetails	GetCustomerReferrer	Referrer details
Source	String	Source
StaffDetails	List<StaffDetails>	the staff details of the customer
SupInfo	List<SupInfo>	Collection of customer supplementary information
Tags	List<CustomerTag>	Customer tags
ContactCorporateDetails Description
Name	Type	Description
CorporateID	Int32 (nullable)	Corporate ID supplied by Acteol (you can GET/POSt corporate from the API Corporate/GET or Corporate/POST)
CorporateName	String	Company name
Domains	List<CorporateDomains>
CorporateDomains Description
Name	Type	Description
CorporateID	Int32
Domain	String
ID	Int32
CustomerAuthentication Description
Name	Type	Description
ApplicationName	String
HashedPassword	String
Username	String
CustomerNote Description
Name	Type	Description
CreateDate	DateTime	Creation Date :if empty ,we will use the current datetime
Note	String	copy text of the note
CustomerPicture Description
Name	Type	Description
PictureData	String	The data of the customer picture
PictureExtension	String	The extension of the customer picture
PictureName	String	The name of the customer picture
CustomerExtenalIdentifier Description
Name	Type	Description
ExternalID	String	External unique ID
ExternalSource	String	External Source
SitesAndInteractions Description
Name	Type	Description
FavouriteLocation	CustomerLocation	the customer favourite location details
FirstVisit	DateTime (nullable)	the date time of the first tracked visit
LastVisit	DateTime (nullable)	the date time of the last tracked visit
PreferredLocation	CustomerLocation	the customer preferred location details
SelectedLocation	List<CustomerLocation>	the customer selected locations details
CustomerLocation Description
Name	Type	Description
Latitude	Double
LocationAddress	String	The location address
LocationID	Int32	The ID of the Location
LocationImageURL	String	The location image URL
LocationName	String	The location name
LocationPhone	String	The location telephone
Longitude	Double
CustomerLocation Description
Name	Type	Description
Latitude	Double
LocationAddress	String	The location address
LocationID	Int32	The ID of the Location
LocationImageURL	String	The location image URL
LocationName	String	The location name
LocationPhone	String	The location telephone
Longitude	Double
CustomerLocation Description
Name	Type	Description
Latitude	Double
LocationAddress	String	The location address
LocationID	Int32	The ID of the Location
LocationImageURL	String	The location image URL
LocationName	String	The location name
LocationPhone	String	The location telephone
Longitude	Double
CustomerInterest Description
Name	Type	Description
ChangeDate	DateTime (nullable)	Change date (we use customer ModifiedDate if empty)
InterestID	Int32	The ID of the Preference
Name	String	Name of the Preference
Status	Boolean	True if it's flagged ; False if not
GetCustomerLoyalty Description
Name	Type	Description
CardsToken	List<String>	Collection of cards token linked to this customer
CurrentTiersName	String	the loyalty tiers name where the customer belongs to
CurrentYearPoints	Double
CyclePointsBalance	Double	The points/stamps balance of current cycle (this will used only if the loyalty program will contains multiple thresholds)
LifeTimePoints	Double	The sum of points/stamps earned all time (from the first day of being a loyal cutomer)
LoyaltyCashBalance	Double	Cash balance of the requested customer
LoyaltyPointsBalance	Double	Points/Stamps balance of the requested customer
MemberNumbers	List<String>	Collection of member numbers linked to this customer
NextTiersName	String	the loyalty tiers name that the customer can achieve
PARTokens	List<String>	Collection of PAR token linked to this customer
PointsNeededForNextRewards	Double	The number of points/stamps to be earned to get the next reward (this will used only if the loyalty program will contains a threshold)
TierLastUpdatedDate	DateTime (nullable)	The last update date of tier change
TiersExpirationDate	DateTime (nullable)	the date when the customer will be downgraded
GetMarketingOptin Description
Name	Type	Description
AppOptin	Boolean (nullable)	True if contact opted into receiving Atreemo app messages . If no clear opt out was made then value should be null
EmailOptin	Boolean (nullable)	True if contact opted into receiving emails. If no clear opt out was made then value should be null
MailOptin	Boolean (nullable)	True if contact opted into receiving post. If no clear opt out was made then value should be null
PhoneOptin	Boolean (nullable)	True if contact opted into receiving phone calls. If no clear opt out was made then value should be null
PushNotificationOptin	Boolean (nullable)	True if contact opted into receiving app push notifications. If no clear opt out was made then value should be null
SmsOptin	Boolean (nullable)	True if contact opted into receiving text messages. If no clear opt out was made then value should be null
WebPushNotificationOptin	Boolean (nullable)	True if contact opted into receiving web push notifications. If no clear opt out was made then value should be null
WhatsAppOptin	Boolean (nullable)	True if contact opted into receiving app Whatsapp messages . If no clear opt out was made then value should be null
CustomerPD Description
Name	Type	Description
BirthDate	DateTime (nullable)	Date of birth
CustomerAddress	CustomerAddress	The postal address of the customer
DoNotExport	Boolean (nullable)
Email	String	Email address
FirstName	String	First Name
Gender	GenderCollection (nullable)	Gender :\n 0 : Unknown,\n 1 : Male,\n 2 : Female,\n 3 : PreferNotToSay,
JobTitle	String	Job title
LastName	String	Last Name
MobilePhone	String	Mobile number (start with 00[international code]).\n Example : UK 0044 xxx xxx xxxx
ParentEmailAddress	String	Parent Email Address
Phone	String	Landline number (start with 00[international code]).\n Example : UK 0044 xxx xxx xxxx
Title	String	Person title
CustomerAddress Description
Name	Type	Description
Address1	String	Address 1
Address2	String	Address 2
Address3	String	Address 3
City	String	City
CountryCode	String	this should contain the ISO country code with two characters (UK,TN,...)
Phone	String
PostCode	String	Postcode
StateName	String	County
CustomerPreference Description
Name	Type	Description
ChangeDate	DateTime (nullable)	Change date (we use customer ModifiedDate if empty)
Name	String	Name of the Preference
PreferenceID	Int32	The ID of the Preference
Status	Boolean	True if it's flagged ; False if not
PushNotificationDetails Description
Name	Type	Description
AppID	Int32	Clients having more thant one Applications will need to add an App ID which will be supplied by Acteol
AppName	String	App Name which will be supplied by Acteol
DeviceToken	String	Device token that will be used to send the message. If multiple tokens are sent Acteol will use the latest token sent
GetCustomerReferrer Description
Name	Type	Description
ReferredByCode	String	The referrer code of the friend who invited this customer
ReferrerCode	List<String>	Collection of referrer codes linked to this customer
StaffDetails Description
Name	Type	Description
CompanyName	String
ContinuousServiceDate	DateTime (nullable)
Contract	String
ContractCode	String
CreateDate	DateTime
CustomField1	String
CustomField2	String
CustomField3	String
CustomField4	String
CustomField5	String
EndDate	DateTime (nullable)
EndReason	String
JobTitle	String
Location	ApiLocation
Paybasis	String
StaffID	String
StartDate	DateTime
WorkEmail	String
ApiLocation Description
Name	Type	Description
ActeolSiteID	Int32	the ID of the site visited (Acteol id)
ExternalLocationID	String	the ID of the site visited (supplier site id if the user in mapped with a supplier)\n this field will be ignored if ActeolSiteID is populated
SupInfo Description
Name	Type	Description
FieldContent	String	Field value
FieldName	String	Field name
CustomerTag Description
Name	Type	Description
TagImageURL	String	The tag image URL
TagName	String	The tag Name

Name	Type	Description	Required
CustomerUpdatePayLoad Description
BrandID	Int32 (nullable)	The ID of the Brand the customer should belongs to (should be used only for multi brands instance)	False
CardsToken	List<String>	Collection of card tokens used to identify customers returning with the same token sent to us in xxxxxxxxxxxxxx (Use this field when you want to update token linked to this customer)	False
CardToken	String	The Card token used to identify customers returning with the same token sent to us in xxxxxxxxxxxxxx (Use this field when you want to Add one token)	False
CorporateDetails	ContactCorporateDetails		False
CtcID	Int32	Ctcid of the Customer : this id shouldn't been saved as it can be merged with another customer	True
CustomerAuthentication	CustomerAuthentication	The Authentication of the customer	False
CustomerNotes	List<CustomerNote>	collection Notes linked to this customer	False
CustomerPicture	CustomerPicture	The picture of the customer	False
DataProcess	DataProcess	Manage the processing of the customer Data. \n Setting value to false will trigger the hashing of the customer record	False
ExternalIdentifier	CustomerExtenalIdentifier	The combination of the external id and External Source should be unique in the database. These values can be used for future Get calls to pull back the contacts data.	True
MarketingOptin	MarketingOptin	Marketing optin preferences	False
MemberNumber	CustomerMemberNumber	Member number to be generated/saved with the customer account	False
ModifiedDate	DateTime (nullable)	Last modification date	False
PARTokens	List<String>	Collection of PAR tokens used to identify customers returning with the same token sent to us in xxxxxxxxxxxxxx (PAR token allows us to link all versions of a linked card (physical card, digital card on phone, digital card on watch etc) and record all card transactions by any of these, whereas with the current \"Card Token\" only field each of these would have to be linked individually)	False
PersonalInfo	CustomerPD	Customer personal details	False
PreferredLocationID	String	The Location ID added will be used to flag the customer against a preferred Site. The Location IDs can be retrieved from the Location end point	False
PushNotificationDetails	PushNotificationDetails	Details that will be used to send the push notification	False
Referrer	CustomerReferrer	The Referrer ID entered when the customer signed up	False
SelectedLocationID	String	The Location ID added will be used to flag the customer against a selected Site. The Location IDs can be retrieved from the Location end point	False
StaffDetails	StaffDetails	Details of the Staff	False
SupInfo	List<SupInfo>	Collection of customer supplementary information	False
ContactCorporateDetails Description
Name	Type	Description	Required
CorporateID	Int32 (nullable)	Corporate ID supplied by Acteol (you can GET/POSt corporate from the API Corporate/GET or Corporate/POST)	False
CorporateName	String	Company name	False
Domains	List<CorporateDomains>		False
CorporateDomains Description
Name	Type	Description	Required
CorporateID	Int32		False
Domain	String		False
ID	Int32		False
CustomerAuthentication Description
Name	Type	Description	Required
ApplicationName	String		False
HashedPassword	String		False
Username	String		False
CustomerNote Description
Name	Type	Description	Required
CreateDate	DateTime	Creation Date :if empty ,we will use the current datetime	False
Note	String	copy text of the note	False
CustomerPicture Description
Name	Type	Description	Required
PictureData	String	The data of the customer picture	False
PictureExtension	String	The extension of the customer picture	False
PictureName	String	The name of the customer picture	False
DataProcess Description
Name	Type	Description	Required
DeleteMyData	Boolean (nullable)	Confirmation to delete the personal data of this contact	False
ProcessMydata	Boolean (nullable)	Confirmation to process the data of this contact	False
CustomerExtenalIdentifier Description
Name	Type	Description	Required
ExternalID	String	External unique ID	False
ExternalSource	String	External Source	False
MarketingOptin Description
Name	Type	Description	Required
AppOptin	Boolean (nullable)	True if contact opted into receiving Atreemo app messages . If no clear opt out was made then value should be null	False
ChangeDate	DateTime (nullable)	Change date (we use customer ModifiedDate if empty)	False
EmailOptin	Boolean (nullable)	True if contact opted into receiving emails. If no clear opt out was made then value should be null	False
MailOptin	Boolean (nullable)	True if contact opted into receiving post. If no clear opt out was made then value should be null	False
PhoneOptin	Boolean (nullable)	True if contact opted into receiving phone calls. If no clear opt out was made then value should be null	False
PushNotificationOptin	Boolean (nullable)	True if contact opted into receiving app push notifications. If no clear opt out was made then value should be null	False
SmsOptin	Boolean (nullable)	True if contact opted into receiving text messages. If no clear opt out was made then value should be null	False
WebPushNotificationOptin	Boolean (nullable)	True if contact opted into receiving web push notifications. If no clear opt out was made then value should be null	False
WhatsAppOptin	Boolean (nullable)	True if contact opted into receiving app Whatsapp messages . If no clear opt out was made then value should be null	False
CustomerMemberNumber Description
Name	Type	Description	Required
GenerateMemberNumber	Boolean	The default value is false. \n Setting the value to True will generate a member number for the contact	False
MemberNumber	String	Member number of the customer ( if GenerateMemberNumber is true and MemberNumber is empty , we will auto-generate a random number for this customer	False
CustomerPD Description
Name	Type	Description	Required
BirthDate	DateTime (nullable)	Date of birth	False
CustomerAddress	CustomerAddress	The postal address of the customer	False
DoNotExport	Boolean (nullable)		False
Email	String	Email address	False
FirstName	String	First Name	False
Gender	GenderCollection (nullable)	Gender :\n 0 : Unknown,\n 1 : Male,\n 2 : Female,\n 3 : PreferNotToSay,	False
JobTitle	String	Job title	False
LastName	String	Last Name	False
MobilePhone	String	Mobile number (start with 00[international code]).\n Example : UK 0044 xxx xxx xxxx	False
ParentEmailAddress	String	Parent Email Address	False
Phone	String	Landline number (start with 00[international code]).\n Example : UK 0044 xxx xxx xxxx	False
Title	String	Person title	False
CustomerAddress Description
Name	Type	Description	Required
Address1	String	Address 1	False
Address2	String	Address 2	False
Address3	String	Address 3	False
City	String	City	False
CountryCode	String	this should contain the ISO country code with two characters (UK,TN,...)	False
Phone	String		False
PostCode	String	Postcode	False
StateName	String	County	False
PushNotificationDetails Description
Name	Type	Description	Required
AppID	Int32	Clients having more thant one Applications will need to add an App ID which will be supplied by Acteol	False
AppName	String	App Name which will be supplied by Acteol	False
DeviceToken	String	Device token that will be used to send the message. If multiple tokens are sent Acteol will use the latest token sent	False
CustomerReferrer Description
Name	Type	Description	Required
ReferredByCode	String	The referrer code of the friend who invited this customer	False
ReferrerCode	String	The referrer code of the customer (if empty we will auto generate a code for this customer)	False
StaffDetails Description
Name	Type	Description	Required
CompanyName	String		False
ContinuousServiceDate	DateTime (nullable)		False
Contract	String		False
ContractCode	String		False
CreateDate	DateTime		False
CustomField1	String		False
CustomField2	String		False
CustomField3	String		False
CustomField4	String		False
CustomField5	String		False
EndDate	DateTime (nullable)		False
EndReason	String		False
JobTitle	String		False
Location	ApiLocation		False
Paybasis	String		False
StaffID	String		False
StartDate	DateTime		False
WorkEmail	String		False
ApiLocation Description
Name	Type	Description	Required
ActeolSiteID	Int32	the ID of the site visited (Acteol id)	False
ExternalLocationID	String	the ID of the site visited (supplier site id if the user in mapped with a supplier)\n this field will be ignored if ActeolSiteID is populated	False
SupInfo Description
Name	Type	Description	Required
FieldContent	String	Field value	False
FieldName	String	Field name	False

Name	Type	Description
UpdateCustomerOutput Description
Errors	List<APICallError>	Collection of errors if exist
ResponseData	CustomerResponse
ResponseStatus	Boolean	True: if the action was succsessfully treated \n False: if there is an error
APICallError Description
Name	Type	Description
ErrorCode	Int32	The error code
ErrorDescription	String	The error description
CustomerResponse Description
Name	Type	Description
CpyID	Int32	Household id of the customer
CtcID	Int32	Ctcid of the Customer : this id can be merged with another customer so you must not save it in your system.
MD5	String	Token linked to the customer used for my preference site SSO
MemberNumber	String	Member Number generated for this customer
ReferrerCode	String	Referrer code for this customer

Name	Type	Description	Required
PostCustomerPayLoad Description
BrandID	Int32 (nullable)	The ID of the Brand the customer should belongs to (should be used only for multi brands instance)	False
CardsToken	List<String>	Collection of card tokens used to identify customers returning with the same token sent to us in xxxxxxxxxxxxxx (Use this field when you want to update token linked to this customer)	False
CardToken	String	The Card token used to identify customers returning with the same token sent to us in xxxxxxxxxxxxxx (Use this field when you want to Add one token)	False
CorporateDetails	ContactCorporateDetails		False
CreateDate	DateTime (nullable)	Creation Date :if empty ,we will use the current datetime (Acceptance of privacy policy date)	False
CustomerAuthentication	CustomerAuthentication	The Authentication of the customer	False
CustomerNotes	List<CustomerNote>	collection Notes linked to this customer	False
CustomerPicture	CustomerPicture	The picture of the customer	False
ExternalIdentifier	CustomerExtenalIdentifier	The combination of the external id and External Source should be unique in the database. These values can be used for future Get calls to pull back the contacts data.	True
MarketingOptin	MarketingOptin	Marketing optin preferences	False
MemberNumber	CustomerMemberNumber	Member number to be generated/saved with the customer account	False
ModifiedDate	DateTime (nullable)	Last modification date	False
PARTokens	List<String>	Collection of PAR tokens used to identify customers returning with the same token sent to us in xxxxxxxxxxxxxx (PAR token allows us to link all versions of a linked card (physical card, digital card on phone, digital card on watch etc) and record all card transactions by any of these, whereas with the current \"Card Token\" only field each of these would have to be linked individually)	False
PersonalInfo	CustomerPD	Customer personal details	False
PreferredLocationID	String	The Location ID added will be used to flag the customer against a preferred Site. The Location IDs can be retrieved from the Location end point	False
PushNotificationDetails	PushNotificationDetails	Details that will be used to send the push notification	False
Referrer	CustomerReferrer	The Referrer ID entered when the customer signed up	False
SelectedLocationID	String	The Location ID added will be used to flag the customer against a selected Site. The Location IDs can be retrieved from the Location end point	False
StaffDetails	StaffDetails	Details of the Staff	False
SupInfo	List<SupInfo>	Collection of customer supplementary information	False
ContactCorporateDetails Description
Name	Type	Description	Required
CorporateID	Int32 (nullable)	Corporate ID supplied by Acteol (you can GET/POSt corporate from the API Corporate/GET or Corporate/POST)	False
CorporateName	String	Company name	False
Domains	List<CorporateDomains>		False
CorporateDomains Description
Name	Type	Description	Required
CorporateID	Int32		False
Domain	String		False
ID	Int32		False
CustomerAuthentication Description
Name	Type	Description	Required
ApplicationName	String		False
HashedPassword	String		False
Username	String		False
CustomerNote Description
Name	Type	Description	Required
CreateDate	DateTime	Creation Date :if empty ,we will use the current datetime	False
Note	String	copy text of the note	False
CustomerPicture Description
Name	Type	Description	Required
PictureData	String	The data of the customer picture	False
PictureExtension	String	The extension of the customer picture	False
PictureName	String	The name of the customer picture	False
CustomerExtenalIdentifier Description
Name	Type	Description	Required
ExternalID	String	External unique ID	False
ExternalSource	String	External Source	False
MarketingOptin Description
Name	Type	Description	Required
AppOptin	Boolean (nullable)	True if contact opted into receiving Atreemo app messages . If no clear opt out was made then value should be null	False
ChangeDate	DateTime (nullable)	Change date (we use customer ModifiedDate if empty)	False
EmailOptin	Boolean (nullable)	True if contact opted into receiving emails. If no clear opt out was made then value should be null	False
MailOptin	Boolean (nullable)	True if contact opted into receiving post. If no clear opt out was made then value should be null	False
PhoneOptin	Boolean (nullable)	True if contact opted into receiving phone calls. If no clear opt out was made then value should be null	False
PushNotificationOptin	Boolean (nullable)	True if contact opted into receiving app push notifications. If no clear opt out was made then value should be null	False
SmsOptin	Boolean (nullable)	True if contact opted into receiving text messages. If no clear opt out was made then value should be null	False
WebPushNotificationOptin	Boolean (nullable)	True if contact opted into receiving web push notifications. If no clear opt out was made then value should be null	False
WhatsAppOptin	Boolean (nullable)	True if contact opted into receiving app Whatsapp messages . If no clear opt out was made then value should be null	False
CustomerMemberNumber Description
Name	Type	Description	Required
GenerateMemberNumber	Boolean	The default value is false. \n Setting the value to True will generate a member number for the contact	False
MemberNumber	String	Member number of the customer ( if GenerateMemberNumber is true and MemberNumber is empty , we will auto-generate a random number for this customer	False
CustomerPD Description
Name	Type	Description	Required
BirthDate	DateTime (nullable)	Date of birth	False
CustomerAddress	CustomerAddress	The postal address of the customer	False
DoNotExport	Boolean (nullable)		False
Email	String	Email address	False
FirstName	String	First Name	False
Gender	GenderCollection (nullable)	Gender :\n 0 : Unknown,\n 1 : Male,\n 2 : Female,\n 3 : PreferNotToSay,	False
JobTitle	String	Job title	False
LastName	String	Last Name	False
MobilePhone	String	Mobile number (start with 00[international code]).\n Example : UK 0044 xxx xxx xxxx	False
ParentEmailAddress	String	Parent Email Address	False
Phone	String	Landline number (start with 00[international code]).\n Example : UK 0044 xxx xxx xxxx	False
Title	String	Person title	False
CustomerAddress Description
Name	Type	Description	Required
Address1	String	Address 1	False
Address2	String	Address 2	False
Address3	String	Address 3	False
City	String	City	False
CountryCode	String	this should contain the ISO country code with two characters (UK,TN,...)	False
Phone	String		False
PostCode	String	Postcode	False
StateName	String	County	False
PushNotificationDetails Description
Name	Type	Description	Required
AppID	Int32	Clients having more thant one Applications will need to add an App ID which will be supplied by Acteol	False
AppName	String	App Name which will be supplied by Acteol	False
DeviceToken	String	Device token that will be used to send the message. If multiple tokens are sent Acteol will use the latest token sent	False
CustomerReferrer Description
Name	Type	Description	Required
ReferredByCode	String	The referrer code of the friend who invited this customer	False
ReferrerCode	String	The referrer code of the customer (if empty we will auto generate a code for this customer)	False
StaffDetails Description
Name	Type	Description	Required
CompanyName	String		False
ContinuousServiceDate	DateTime (nullable)		False
Contract	String		False
ContractCode	String		False
CreateDate	DateTime		False
CustomField1	String		False
CustomField2	String		False
CustomField3	String		False
CustomField4	String		False
CustomField5	String		False
EndDate	DateTime (nullable)		False
EndReason	String		False
JobTitle	String		False
Location	ApiLocation		False
Paybasis	String		False
StaffID	String		False
StartDate	DateTime		False
WorkEmail	String		False
ApiLocation Description
Name	Type	Description	Required
ActeolSiteID	Int32	the ID of the site visited (Acteol id)	False
ExternalLocationID	String	the ID of the site visited (supplier site id if the user in mapped with a supplier)\n this field will be ignored if ActeolSiteID is populated	False
SupInfo Description
Name	Type	Description	Required
FieldContent	String	Field value	False
FieldName	String	Field name	False

Name	Type	Description
PostCustomerOutput Description
Errors	List<APICallError>	Collection of errors if exist
ResponseData	PostCustomerResponse
ResponseStatus	Boolean	True: if the action was succsessfully treated \n False: if there is an error
APICallError Description
Name	Type	Description
ErrorCode	Int32	The error code
ErrorDescription	String	The error description
PostCustomerResponse Description
Name	Type	Description
CpyID	Int32	Household id of the customer
CtcID	Int32	Ctcid of the Customer : this id can be merged with another customer so you must not save it in your system.
Duplicated	Boolean	Show if the customer already exist or not
MD5	String	Token linked to the customer used for my preference site SSO
MemberNumber	String	Member Number generated for this customer
ReferrerCode	String	Referrer code for this customer

Name	Type	Description	Required
CustomerAppNamePayLoad Description
ApplicationName	String	Application Name of the Customer	False

Name	Type	Description	Required
CustomerAsset Description
AssetDetails	List<Key>	the list details of the Object	False
CreatedBy	String	Object Created by	False
CreatedOn	DateTime (nullable)	Object created on	False
CtcID	Int32	The Contact ID linked to the Asset	False
CustomerAssetID	Int32	The Unique ID of the object	False
ExternalID	String	The ID of the object	False
ModifiedBy	String	Object ModifiedBy	False
ModifiedOn	DateTime (nullable)	Object Modified on	False
Name	String	The Name of the object	False
Key Description
Name	Type	Description	Required
KeyName	String	the field name	False
KeyType	String	The possible values for this field are: SmallString (max length 50 characters), MediumString (max length 250 characters), BigString (text), Integer, Decimal, DateTime, Date	False
KeyValue	String	the field value	False

Name	Type	Description
CustomerAssetOutput Description
CustomerAssetID	Int32	The Customer Asset Unique ID
Error	List<String>	The list of errors description
Response	Boolean	The status of the call

Name	Type	Description
ApiCustomerAsset Description
BatchID	Int32	Should be used in the next call when Remaining is true
CustomerAssets	List<CustomerAsset>	List of customerassets results
Remaining	Boolean	false : all records are returned
CustomerAsset Description
Name	Type	Description
AssetDetails	List<Key>	the list details of the Object
CreatedBy	String	Object Created by
CreatedOn	DateTime (nullable)	Object created on
CtcID	Int32	The Contact ID linked to the Asset
CustomerAssetID	Int32	The Unique ID of the object
ExternalID	String	The ID of the object
ModifiedBy	String	Object ModifiedBy
ModifiedOn	DateTime (nullable)	Object Modified on
Name	String	The Name of the object
Key Description
Name	Type	Description
KeyName	String	the field name
KeyType	String	The possible values for this field are: SmallString (max length 50 characters), MediumString (max length 250 characters), BigString (text), Integer, Decimal, DateTime, Date
KeyValue	String	the field value