Sign in
Customers

Get a customer

Changed on

Customers are looked up by customer code by default. A database can be configured to look up this value as an email address instead.

get/naCustomers/{CustomerCode}

Request

  • Base URL: https://api.myposconnect.com/api/v2
  • URL: https://api.myposconnect.com/api/v2/naCustomers/{CustomerCode}
  • Auth: HTTP bearer

Path parameters

CustomerCodestring required

Customer code, or email address when database lookup is configured that way.

Response

Customer returned.

customerIdstring uuid
customerCodestring

Assigned by MyPOS Connect; it cannot be supplied when creating a customer.

customerNamestring
addressstring
citystring
regionstring
postalCodestring
countrystring
phoneNumberstring
faxNumberstring
emailAddressstring email
webSitestring
creditLimitnumber double
notesstring
activeboolean
customerTypestring
rewardsCollectorboolean
rewardsNumberstring
rewardsValuenumber double

Total customer reward-points value returned by the API.

firstSaledateunknown
lastSaledateunknown
allowMailingboolean
allowDataShareboolean
firstNamestring
lastNamestring
bankSortCodeunknown
bankAccountunknown
bankAccountNameunknown
correspondenceEmailboolean
correspondencePaperboolean
discountPercentnumber double
priceBandinteger
balancenumber double
cC_001string nullable
cC_002string nullable
cC_003string nullable
cC_004string nullable
cC_005string nullable
cC_006string nullable
cC_007string nullable
cC_008string nullable
cC_009string nullable
cC_010string nullable
lastEditUserstring
creationUserstring
lastEditDevicestring
creationDevicestring
lastEditDatestring

Timestamp returned without a UTC offset in the supplied samples.

creationDatestring

Timestamp returned without a UTC offset in the supplied samples.

Example response

{
  "customerId": "00000000-0000-4000-8000-000000000003",
  "customerCode": "CUSTOMER-EXAMPLE-001",
  "customerName": "",
  "address": "123 Example Street",
  "city": "Example City",
  "region": "Example Province",
  "postalCode": "A1A 1A1",
  "country": "Canada",
  "phoneNumber": "+1-555-0100",
  "faxNumber": "+1-555-0101",
  "emailAddress": "ada.lovelace@example.com",
  "webSite": "",
  "creditLimit": 0,
  "notes": "",
  "active": true,
  "customerType": "Adult",
  "rewardsCollector": false,
  "rewardsNumber": "",
  "rewardsValue": 65,
  "firstSaledate": null,
  "lastSaledate": null,
  "allowMailing": true,
  "allowDataShare": false,
  "firstName": "Ada",
  "lastName": "Lovelace",
  "correspondenceEmail": false,
  "correspondencePaper": false,
  "discountPercent": 0,
  "priceBand": 1,
  "balance": 0,
  "lastEditDate": "2020-08-21T12:47:18.177",
  "creationDate": "2020-07-28T12:31:47.417"
}

Changes

  • 3f7cebe5efd8Revision changes
    • breaking

      the response's body type changed from object to no type for status

    • breaking

      the response's body type changed from object to no type for status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 6bf304ac4f2cRevision changes
    • info

      api operation id customersRetrieve was added