REST API Reference
CMS – Customer Management
| CreateCustomerProfile | |
|---|---|
| RequestUri | https://api.cipcert.goevo.com/2.1.28/REST/DataServices/CMS.svc/Customers/ |
| Method | POST |
| Accept | application/json |
Request
{
"CustomerProfile": {
"Name": {
"Title": null,
"First": "FirstName",
"Middle": null,
"Last": "LastName",
"Suffix": null
},
"Addresses": [
{
"Street1": "street 1",
"Street2": "street 2",
"City": "city",
"StateProvince": "CO",
"PostalCode": "postal code",
"CountryCode": "USA",
"AddressType": "Billing",
"HouseNumber": "house number"
}
],
"InternationalAddresses": null,
"TelephoneNumber": "telephone number",
"Birthdate": "1986-09-29T00:00:00-06:00",
"PaymentData": [
{
"PaymentType": "NotSet",
"CardType": "Visa",
"BankAccountType": "NotSet",
"PaymentAccountNumber": "4111111111122589",
"PaymentRoutingNumber": null,
"PaymentAccountName": "FirstName LastName",
"PaymentAccountExpiration": "0122"
}
],
"IsActive": false,
"MerchantReferenceId": "7713E0",
"EmailAddress": "test@test.com",
"Memberships": null,
"Gender": "Female",
"Interests": [
"HomeImprovement"
],
"MaritalStatus": "NotSet",
"DateMembershipsVerified": "2016-09-29T00:00:00-06:00",
"EmailNotifications": false,
"SMSNotifcations": false,
"OAuthToken": null
},
"ConsentType": "PromotionsFullProfile",
"Scope": "MerchantProfileId",
"UniqueConstraint": {
"MerchantReferenceId": false,
"EmailAddress": true,
"TelephoneNumber": false
},
"MerchantProfileId": "Dev_Test_28"
}
Response
2587C1AFA3BA4FEAA9DAB631F88CCE2A
| GetCustomer | |
|---|---|
| RequestUri | https://api.cipcert.goevo.com/2.1.28/REST/DataServices/CMS.svc/Customers/[customerReferenceId]?merchantProfileId=[merchantProfileId]&scope=MerchantProfileId |
| Method | GET |
| Accept | application/json |
Request
null
Response
{
"CustomerProfile": {
"Name": {
"Title": null,
"First": "FirstName",
"Middle": null,
"Last": "LastName",
"Suffix": null
},
"Addresses": [
{
"Street1": "street 1",
"Street2": "street 2",
"City": "city",
"StateProvince": "CO",
"PostalCode": "postal code",
"CountryCode": "USA",
"AddressType": "Billing",
"HouseNumber": "house number"
}
],
"InternationalAddresses": null,
"TelephoneNumber": "telephone number",
"Birthdate": "1986-09-29T06:00:00+00:00",
"PaymentData": [
{
"PaymentType": "NotSet",
"CardType": "Visa",
"BankAccountType": "NotSet",
"PaymentAccountNumber": "411111XXXXXX2589",
"PaymentRoutingNumber": null,
"PaymentAccountName": null,
"PaymentAccountExpiration": "0122"
}
],
"IsActive": false,
"MerchantReferenceId": "7713E0",
"EmailAddress": "test@test.com",
"Memberships": null,
"Gender": "Female",
"Interests": [
"HomeImprovement"
],
"MaritalStatus": "NotSet",
"DateMembershipsVerified": "2016-09-29T06:00:00+00:00",
"EmailNotifications": false,
"SMSNotifcations": false,
"OAuthToken": null
},
"CustomerReferenceId": "2587C1AFA3BA4FEAA9DAB631F88CCE2A",
"CustomerConsent": "PromotionsFullProfile",
"LastProcessed": "0001-01-01T00:00:00",
"ReceiptLanguage": "NotSet"
} | QueryCustomerDetail - Multiple CustomerReferenceIds | ||
|---|---|---|
| RequestUri | https://api.cipcert.goevo.com/2.1.28/REST/DataServices/CMS.svc/Customers/details | |
| Method | POST | |
| Authentication | Session token set as Username on Authentication header. | |
| Accept | application/json | |
Request
{
"QueryCustomersParameters": {
"CustomerReferenceIds": [
"1356CCB04E7545959CD437865D7EB527",
"5F76F3011D964E3D82F234266DA8064E",
"FD7FFC717BBB4A52B797F646EC0E0C8A"
]
},
"Scope": "MerchantProfileId",
"PagingParameters": {
"Page": 0,
"PageSize": 5
},
"MerchantProfileId": "Dev_Test_28"
} | QueryCustomerDetail - MaskedPan | |
|---|---|
| RequestUri | https://api.cipcert.goevo.com/2.1.28/REST/DataServices/CMS.svc/Customers/details |
| Method | POST |
| Accept | application/json |
Request
{
"$type": "QueryCustomersDetail, http://schemas.evosnap.com/CWS/v2.0/DataServices/CMS/Rest",
"QueryCustomersParameters": {
"CreatedDateRange": null,
"Memberships": null,
"BirthDateRange": null,
"Gender": "NotSet",
"PostalCodes": null,
"MaritalStatus": "NotSet",
"Interests": null,
"CustomerId": {
"CustomerReferenceId": null,
"MaskedPAN": "411111XXXXXX2589",
"EmailAddress": null,
"TelephoneNumber": null,
"MerchantReferenceId": null
},
"TransactionId": null,
"LimitToCustomersWithoutTransactions": false
},
"Scope": "MerchantProfileId",
"PagingParameters": {
"Page": 0,
"PageSize": 5
},
"MerchantProfileId": "Dev_Test_28"
}
Response
{
"CustomerDetails": [
{
"CustomerProfile": {
"Name": {
"Title": null,
"First": "FirstName",
"Middle": null,
"Last": "LastName",
"Suffix": null
},
"Addresses": [
{
"Street1": "street 1",
"Street2": "street 2",
"City": "city",
"StateProvince": "CO",
"PostalCode": "postal code",
"CountryCode": "USA",
"AddressType": "Billing",
"HouseNumber": "house number"
}
],
"InternationalAddresses": null,
"TelephoneNumber": "telephone number",
"Birthdate": "1986-09-29T06:00:00+00:00",
"PaymentData": [
{
"PaymentType": "NotSet",
"CardType": "Visa",
"BankAccountType": "NotSet",
"PaymentAccountNumber": "411111XXXXXX2589",
"PaymentRoutingNumber": null,
"PaymentAccountName": null,
"PaymentAccountExpiration": "0122"
}
],
"IsActive": false,
"MerchantReferenceId": "7713E0",
"EmailAddress": "test@test.com",
"Memberships": null,
"Gender": "Female",
"Interests": [
"HomeImprovement"
],
"MaritalStatus": "NotSet",
"DateMembershipsVerified": "2016-09-29T06:00:00+00:00",
"EmailNotifications": false,
"SMSNotifcations": false,
"OAuthToken": null
},
"CustomerReferenceId": "2587C1AFA3BA4FEAA9DAB631F88CCE2A",
"CustomerConsent": "PromotionsFullProfile",
"LastProcessed": "0001-01-01T00:00:00",
"ReceiptLanguage": "NotSet"
}
],
"PageNumber": 0,
"TotalPages": 1,
"TotalItems": 1
} | QueryCustomersSummary | |
|---|---|
| RequestUri | https://api.cipcert.goevo.com/2.1.28/REST/DataServices/CMS.svc/Customers/query |
| Method | POST |
| Accept | application/json |
Request
{
"QueryCustomersParameters": {
"CreatedDateRange": null,
"Memberships": null,
"BirthDateRange": null,
"Gender": "NotSet",
"PostalCodes": null,
"MaritalStatus": "NotSet",
"Interests": null,
"CustomerId": {
"CustomerReferenceId": "2587C1AFA3BA4FEAA9DAB631F88CCE2A",
"MaskedPAN": null,
"EmailAddress": null,
"TelephoneNumber": null,
"MerchantReferenceId": null
},
"TransactionId": null,
"LimitToCustomersWithoutTransactions": false
},
"Scope": "MerchantProfileId",
"PagingParameters": {
"Page": 0,
"PageSize": 10
},
"MerchantProfileId": "Dev_Test_28"
}
Response
{
"CustomerSummaries": [
{
"Name": {
"Title": null,
"First": "FirstName",
"Middle": null,
"Last": "LastName",
"Suffix": null
},
"CustomerReferenceId": "2587C1AFA3BA4FEAA9DAB631F88CCE2A",
"MerchantReferenceId": "7713E0",
"EmailAddress": "test@test.com",
"TelephoneNumber": "telephone number",
"LastProcessed": "0001-01-01T00:00:00",
"ReceiptLanguage": "NotSet"
}
],
"PageNumber": 0,
"TotalPages": 1,
"TotalItems": 1
} | UpdateCustomerProfile | |
|---|---|
| RequestUri | https://api.cipcert.goevo.com/2.1.28/REST/DataServices/CMS.svc/Customers/[customerReferenceId] |
| Method | PUT |
| Accept | application/json |
Request
{
"$type": "SubmitCustomerProfile, http://schemas.evosnap.com/CWS/v2.0/DataServices/CMS/Rest",
"CustomerProfile": {
"Name": {
"Title": null,
"First": "FirstName",
"Middle": null,
"Last": "LastName",
"Suffix": null
},
"Addresses": [
{
"Street1": "street 1",
"Street2": "street 2",
"City": "city updated",
"StateProvince": "CO",
"PostalCode": "postal code updated",
"CountryCode": "USA",
"AddressType": "Billing",
"HouseNumber": "house number updated"
}
],
"InternationalAddresses": null,
"TelephoneNumber": "telephone number",
"Birthdate": "1986-09-29T00:00:00-06:00",
"PaymentData": [
{
"PaymentType": "NotSet",
"CardType": "Visa",
"BankAccountType": "NotSet",
"PaymentAccountNumber": "4111111111198536",
"PaymentRoutingNumber": null,
"PaymentAccountName": "FirstName LastName",
"PaymentAccountExpiration": "0122"
}
],
"IsActive": false,
"MerchantReferenceId": "7713E0",
"EmailAddress": "updated test@test.com",
"Memberships": null,
"Gender": "Female",
"Interests": [
"HomeImprovement"
],
"MaritalStatus": "NotSet",
"DateMembershipsVerified": "2016-09-29T00:00:00-06:00",
"EmailNotifications": false,
"SMSNotifcations": false,
"OAuthToken": null
},
"ConsentType": "PromotionsFullProfile",
"Scope": "MerchantProfileId",
"UniqueConstraint": {
"MerchantReferenceId": false,
"EmailAddress": true,
"TelephoneNumber": false
},
"MerchantProfileId": "Dev_Test_28"
}
Response
| QueryCustomerTransactions | |
|---|---|
| RequestUri | https://api.cipcert.goevo.com/2.1.28/REST/DataServices/CMS.svc/Customers/transactions |
| Method | POST |
| Accept | application/json |
Request
{
"$type": "QueryCustomerTransactions, http://schemas.evosnap.com/CWS/v2.0/DataServices/CMS/Rest",
"QueryParameters": {
"TransactionDateRange": {
"EndDateTime": "2016-09-29T15:13:09.0900973-06:00",
"StartDateTime": "2015-01-31T00:00:00"
},
"CustomerReferenceId": "2587C1AFA3BA4FEAA9DAB631F88CCE2A"
},
"Scope": "MerchantProfileId",
"PagingParameters": {
"Page": 0,
"PageSize": 10
},
"MerchantProfileId": "Dev_Test_28"
}
Response
{
"TransactionIds": [],
"PageNumber": 0,
"TotalPages": 0,
"TotalItems": 0
} | DeleteCustomerProfile | ||
|---|---|---|
| RequestUri | https://api.cipcert.goevo.com/2.1.28/REST/DataServices/CMS.svc/Customers/[customerReferenceId]?merchantProfileId=[merchantProfileId]&scope=MerchantProfileId | |
| Method | DELETE | |
| Authentication | ||
| Accept | application/json | |
Request
null