Customers in and out of Imagine
To get Customers in and out of Imagine you would use the Customer Resource.
What you can do with Customers
The Imagine API lets you do the following with the Customer resource. More detailed versions of these general actions may be available here https://postman.k3imagine.com
Retrieves a single customer
Retrieves a list of customers
Creates a new Customer
Updates a customer
Updates a Customer by the external unique id
Deletes a customer
Customer Properties
|
id READ-ONLY |
"id": 38 A unique numeric identifier for the Customer. Each id is unique across the Imagine system |
|
dateCreated |
"dateCreated": "2019-07-09T10:34:03.688279" The date the customer was created |
|
totalSpend |
"totalSpend": 0.00 The customers total spend in Imagine |
|
averageSpend |
"averageSpend": 0.00 The customers average spend in Imagine |
|
externalUniqueId |
"externalUniqueId": "1234567890" An external identifier. |
|
title |
"title": "Mr" The customers title |
|
firstName |
"firstName": "John" The customers first name. |
|
lastName |
"lastName": "Smith" The customers last name. |
|
primaryBillingAddressid |
"primaryBillingAddressId": 1 The id of a linked Address used as the customers default billing address. |
|
primaryShippingAddressId |
"primaryShippingAddressId": 1 The id of a linked Address used as the customers default shipping address. |
|
companyId |
"companyId": 2 The date the Master Item was created |
|
taxNumber |
"taxNumber": "GB1245623" The customers tax number. |
|
creditLimit |
"creditLimit": 0.00 The customer credit limit |
|
lastVisit |
"lastVisit": "0001-01-01T00:00:00" The date of the customers last purchase |
|
numberOfVisits |
"numberOfVisits": 0 The number of transactions the customer has made |
|
standardDiscount |
"standardDiscount": 0.00 The default discount applied to the customer |
|
emailAddress |
"emailAddress": "[email protected]" The customers email address |
|
mobilePhone |
"mobilePhone": "07700900989" The customer mobile number |
|
phone |
"phone": "02079460346" The customers phone number |
|
picture |
"picture": "https://k3imagine.com/customer/picture.png" An image URL for the customers picture. Only .bmp, .gif, .jpg and .svg type images are supported |
|
taxExcempt |
"taxExcempt": null A flag to indicate if the customer is tax excempt |
|
isActive |
"isActive": true Whether the customer is active |
Endpoints
Retreive a single customer
GET https://publicapi.k3imagine.com/api/v1.0/Customer/38
Response: 200
Retreive a list of customers
POST https://publicapi.k3imagine.com/api/v1.0/Customer/paged?includeInactive=true
Request Body:
{
"pageNumber": 0,
"pageSize": 25
}
Response: 200
Create a new customer
POST https://publicapi.k3imagine.com/api/v1.0/Customer
Response: 200
Update a customer
PUT https://publicapi.k3imagine.com/api/v1.0/Customer
Response: 200
Update a customer by their unique external id
PUT https://publicapi.k3imagine.com/api/v1.0/Customer/customersByExternalUniqueId
Response: 200
Delete a customer
POST https://publicapi.k3imagine.com/api/v1.0/Customer/38
Response: 200