POST api/Loyalty/CreateCustomer?companyKey={companyKey}

Creates a customer with the specified parameters.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
companyKey

string

Default value is

Body Parameters

The parameter object containing the new customer's details.

CreateCustomerParameter
NameDescriptionTypeAdditional information
Customer

NewCustomer

N/A


Request Formats

application/json, text/json

Sample:
{
  "Customer": {
    "Code": "sample string 8",
    "Name": "sample string 9",
    "Address1": "sample string 10",
    "Address2": "sample string 11",
    "Address3": "sample string 12",
    "Town": "sample string 13",
    "Country": "sample string 14",
    "Phone": "sample string 15",
    "Fax": "sample string 16",
    "Mobile": "sample string 17",
    "IdNo": "sample string 18",
    "Email": "sample string 19",
    "ContTitle": "sample string 20",
    "ContName": "sample string 21",
    "ContSurn": "sample string 22",
    "Group": "sample string 23",
    "MaxDisc": 25.0,
    "Discount": 26.0,
    "EuCountry": "sample string 27",
    "VatReg": "sample string 28",
    "OnHold": true,
    "Remark": "sample string 30",
    "Active": true,
    "Cancelled": true,
    "BirthDate": "2024-11-23T17:38:37.2364245",
    "Interest1": "sample string 35",
    "Interest2": "sample string 36",
    "Locality": "sample string 37",
    "PostalCode": "sample string 38",
    "CardMngr": "sample string 39",
    "CardNo": "sample string 40",
    "Rounding": "sample string 43"
  }
}

Response Information

Resource Description

The result containing the created customer.

CreateCustomerResult
NameDescriptionTypeAdditional information
Customer

Customer

N/A

Response Formats

application/json, text/json

Sample:
{
  "Customer": {
    "CustRef": "sample string 1",
    "Code": "sample string 2",
    "Name": "sample string 3",
    "Address1": "sample string 4",
    "Address2": "sample string 5",
    "Address3": "sample string 6",
    "Town": "sample string 7",
    "Country": "sample string 8",
    "Phone": "sample string 9",
    "Fax": "sample string 10",
    "Mobile": "sample string 11",
    "IdNo": "sample string 12",
    "Email": "sample string 13",
    "ContTitle": "sample string 14",
    "ContName": "sample string 15",
    "ContSurn": "sample string 16",
    "Group": "sample string 17",
    "MaxDisc": 19.0,
    "Discount": 20.0,
    "LastSale": "2024-11-23T17:38:37.3301103",
    "LastRDmp": "2024-11-23T17:38:37.3301103",
    "EuCountry": "sample string 21",
    "VatReg": "sample string 22",
    "OnHold": true,
    "Remark": "sample string 24",
    "Created": "2024-11-23T17:38:37.3301103",
    "Points": 26,
    "CreatedBy": "sample string 27",
    "AmendedBy": "sample string 28",
    "LastAmend": "2024-11-23T17:38:37.3301103",
    "Uid": "sample string 31",
    "Active": true,
    "Cancelled": true,
    "BirthDate": "2024-11-23T17:38:37.3301103",
    "Interest1": "sample string 35",
    "Interest2": "sample string 36",
    "Locality": "sample string 37",
    "PostalCode": "sample string 38",
    "CardMngr": "sample string 39",
    "CardNo": "sample string 40",
    "Rounding": "sample string 43"
  }
}