Mews Customers Getall Example is an example object payload from Mews, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.
Top-level fields
operationIdmethodpathsummaryrequestExamplesresponseExamples
Example Payload
{
"operationId": "customers_getAll",
"method": "POST",
"path": "/api/connector/v1/customers/getAll",
"summary": "Get all customers",
"requestExamples": [
{
"contentType": "application/json",
"example": {
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
"Client": "Sample Client 1.0.0",
"ChainIds": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"5fcd1933-22f2-40b9-84da-7db04cbecec2"
],
"CreatedUtc": {
"StartUtc": "2018-01-01T00:00:00Z",
"EndUtc": "2018-01-30T00:00:00Z"
},
"UpdatedUtc": {
"StartUtc": "2018-01-02T00:00:00Z",
"EndUtc": "2018-01-30T00:00:00Z"
},
"Extent": {
"Customers": true,
"Documents": false,
"Addresses": false
},
"ActivityStates": [
"Active"
],
"CustomerIds": [
"fadd5bb6-b428-45d5-94f8-fd0d89fece6d"
],
"CompanyIds": [
"c6f5c82d-621a-4c8a-903b-1b0a9a23b71f"
],
"Emails": [
"j.smith@example.com"
],
"FirstNames": [
"John",
"Jane"
],
"LastNames": [
"Doe",
"Smith"
],
"LoyaltyCodes": [
"LL810213"
],
"Limitation": {
"Count": 10
}
}
}
],
"responseExamples": [
{
"status": "200",
"contentType": "application/json",
"example": {
"Customers": [
{
"Id": "fadd5bb6-b428-45d5-94f8-fd0d89fece6d",
"ChainId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"Number": "12345",
"Title": "Mister",
"Sex": "Male",
"FirstName": "John",
"LastName": "Smith",
"SecondLastName": "Williams",
"NationalityCode": "US",
"PreferredLanguageCode": "en-GB",
"LanguageCode": "en-US",
"BirthDate": "1983-12-31",
"BirthCountryCode": null,
"BirthCountrySubdivisionCode": null,
"BirthPlace": "New York City, NY",
"Occupation": "Carpenter",
"Email": "j.smith@example.com",
"HasOtaEmail": false,
"Phone": "00420123456789",
"TaxIdentificationNumber": "123456789",
"LoyaltyCode": "LL810213",
"AccountingCode": "AC123",
"BillingCode": null,
"Notes": "",
"CarRegistrationNumber": "1A2 3456",
"DietaryRequirements": null,
"CreatedUtc": "2018-01-01T00:00:00Z",
"UpdatedUtc": "2018-01-02T00:00:00Z",
"Passport": null,
"IdentityCard": null,
"Visa": null,
"DriversLicense": null,
"Address": {
"Id": "f8495413-bf49-45dd-843c-44be7f365569",
"Line1": "Somerford Road Hello House/135",
"Line2": null,
"City": "Christchurch",
"PostalCode": "BH23 3PY",
"CountryCode": "GB",
"CountrySubdivisionCode": "GB-ENG",
"Latitude": null,
"Longitude": null
},
"AddressId": "f8495413-bf49-45dd-843c-44be7f365569",
"Classifications": [
"Returning"
],
"Options": [
"SendMarketingEmails"
],
"ItalianDestinationCode": null,
"ItalianFiscalCode": null,
"ItalianLotteryCode": null,
"CompanyId": "c6f5c82d-621a-4c8a-903b-1b0a9a23b71f",
"MergeTargetId": null,
"ActivityState": "Active",
"IsActive": true,
"PreferredSpaceFeatures": [
"OceanView"
],
"CreatorProfileId": "3cd637ef-4728-47f9-8fb1-afb900c9cdcf",
"UpdaterProfileId": "122fc063-ec6e-4198-b8db-6b168a59ffae"
}
],
"Documents": null,
"Cursor": "fadd5bb6-b428-45d5-94f8-fd0d89fece6d"
}
}
]
}