Codat List Commerce Customers Example is an example object payload from Codat, 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": "list-commerce-customers",
"method": "GET",
"path": "/companies/{companyId}/connections/{connectionId}/data/commerce-customers",
"summary": "List customers",
"requestExamples": [],
"responseExamples": [
{
"status": "200",
"contentType": "application/json",
"name": "BigCommerce",
"example": {
"results": [
{
"id": "1",
"customerName": "Amy Jones",
"emailAddress": "a.jackson@email.me",
"defaultCurrency": "XXX",
"phone": "07770 666777",
"addresses": [
{
"type": "Unknown",
"line1": "My Billing Address ./*drop table",
"city": "Portsmouth",
"region": "",
"country": "United Kingdom",
"postalCode": "PS13HJ"
},
{
"type": "Unknown",
"line1": "This is my address, I cant hit enter.",
"city": "Portsmouth",
"region": "",
"country": "United Kingdom",
"postalCode": "PS13HJ"
}
],
"createdDate": "2022-06-15T15:54:15Z",
"modifiedDate": "2023-04-11T10:33:49Z",
"sourceModifiedDate": "2022-06-15T15:54:15Z"
},
{
"id": "2",
"customerName": "Cust001 Cust001",
"emailAddress": "Cust001@example.com",
"defaultCurrency": "XXX",
"phone": "05442 203941",
"addresses": [],
"createdDate": "2023-04-11T15:49:25Z",
"modifiedDate": "2023-04-17T15:42:55Z",
"sourceModifiedDate": "2023-04-11T15:49:25Z"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 201,
"_links": {
"current": {
"href": "/companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-customers?page=1&pageSize=2"
},
"self": {
"href": "/companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-customers"
},
"next": {
"href": "/companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-customers?page=2&pageSize=2"
}
}
}
},
{
"status": "200",
"contentType": "application/json",
"name": "Clover",
"example": {
"results": [
{
"id": "2CBJ8R898ZJAR",
"customerName": "",
"addresses": [],
"createdDate": "2021-09-22T13:10:12Z",
"modifiedDate": "2023-01-09T11:01:03Z",
"sourceModifiedDate": "0001-01-01T00:00:00"
},
{
"id": "511JV0FRN2QYC",
"customerName": "",
"addresses": [],
"createdDate": "2021-09-21T14:54:38Z",
"modifiedDate": "2023-01-09T11:01:03Z",
"sourceModifiedDate": "0001-01-01T00:00:00"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 9,
"_links": {
"current": {
"href": "/companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-customers?page=1&pageSize=2"
},
"self": {
"href": "/companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-customers"
},
"next": {
"href": "/companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-customers?page=2&pageSize=2"
}
}
}
},
{
"status": "200",
"contentType": "application/json",
"name": "Mollie",
"example": {
"results": [
{
"id": "cst_NUkBHQmekz",
"customerName": "Frod Baggins",
"emailAddress": "frodo.baggings@theshire.com",
"addresses": [],
"createdDate": "2022-01-18T11:41:54",
"modifiedDate": "2022-03-17T15:47:28Z"
},
{
"id": "cst_BvBxwuwfvH",
"customerName": "Frodo Baggins",
"emailAddress": "frodo.baggings@theshire.com",
"addresses": [],
"createdDate": "2022-01-18T11:42:05",
"modifiedDate": "2022-03-17T15:47:28Z"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 3,
"_links": {
"current": {
"href": "/companies/a68cb447-182d-4bbe-be1a-f526d11d69d5/connections/dfbf847b-cde8-4b00-b2f9-af51dec0d337/data/commerce-customers?page=1&pageSize=2"
},
"self": {
"href": "/companies/a68cb447-182d-4bbe-be1a-f526d11d69d5/connections/dfbf847b-cde8-4b00-b2f9-af51dec0d337/data/commerce-customers"
},
"next": {
"href": "/companies/a68cb447-182d-4bbe-be1a-f526d11d69d5/connections/dfbf847b-cde8-4b00-b2f9-af51dec0d337/data/commerce-customers?page=2&pageSize=2"
}
}
}
},
{
"status": "200",
"contentType": "application/json",
"name": "Mollie Test",
"example": {
"results": [
{
"id": "cst_NUkBHQmekz",
"customerName": "Frod Baggins",
"emailAddress": "frodo.baggings@theshire.com",
"addresses": [],
"createdDate": "2022-01-18T11:41:54",
"modifiedDate": "2022-08-17T11:33:19Z"
},
{
"id": "cst_BvBxwuwfvH",
"customerName": "Frodo Baggins",
"emailAddress": "frodo.baggings@theshire.com",
"addresses": [],
"createdDate": "2022-01-18T11:42:05",
"modifiedDate": "2022-08-17T11:33:19Z"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 3,
"_links": {
"current": {
"href": "/companies/b978f9fe-8d63-4cfc-b2c2-b61b72e22785/connections/d564f8fd-0766-4ab8-a427-7c893f9b9ff6/data/commerce-customers?page=1&pageSize=2"
},
"self": {
"href": "/companies/b978f9fe-8d63-4cfc-b2c2-b61b72e22785/connections/d564f8fd-0766-4ab8-a427-7c893f9b9ff6/data/commerce-customers"
},
"next": {
"href": "/companies/b978f9fe-8d63-4cfc-b2c2-b61b72e22785/connections/d564f8fd-0766-4ab8-a427-7c893f9b9ff6/data/commerce-customers?page=2&pageSize=2"
}
}
}
},
{
"status": "200",
"contentType": "application/json",
"name": "PrestaShop",
"example": {
"results": [
{
"id": "2",
"customerName": "Bob Smith",
"emailAddress": "bob.smith@example.com",
"addresses": [
{
"type": "Unknown",
"line1": "1 test street",
"city": "City Test",
"region": "Virginia",
"country": "US",
"postalCode": "55678"
}
],
"createdDate": "2021-09-02T07:54:26",
"modifiedDate": "2022-01-26T15:09:42Z",
"sourceModifiedDate": "2021-09-02T07:54:26"
},
{
"id": "3",
"customerName": "Fake Name",
"emailAddress": "bob@bob.com",
"addresses": [],
"createdDate": "2021-09-03T01:55:13",
"modifiedDate": "2022-01-26T15:09:42Z",
"sourceModifiedDate": "2021-09-03T01:55:13"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 5,
"_links": {
"current": {
"href": "/companies/2bf78e61-58ca-421a-a430-5dfa59cf15b0/connections/30774c1f-fdcd-491e-9e60-47e316b3ab9b/data/commerce-customers?page=1&pageSize=2"
},
"self": {
"href": "/companies/2bf78e61-58ca-421a-a430-5dfa59cf15b0/connections/30774c1f-fdcd-491e-9e60-47e316b3ab9b/data/commerce-customers"
},
"next": {
"href": "/companies/2bf78e61-58ca-421a-a430-5dfa59cf15b0/connections/30774c1f-fdcd-491e-9e60-47e316b3ab9b/data/commerce-customers?page=2&pageSize=2"
}
}
}
},
{
"status": "200",
"contentType": "application/json",
"name": "Shopify",
"example": {
"results": [
{
"id": "5839032287390",
"customerName": "AL A",
"emailAddress": "a.macra@codat.io",
"addresses": [
{
"type": "Unknown",
"line1": "301 Ink Rooms, 28 Easton St, Farringdon",
"line2": "28 Easton St, Farringdon",
"city": "London",
"region": "England",
"country": "United Kingdom",
"postalCode": "WC1X 0BE"
}
],
"createdDate": "2021-11-18T15:24:03",
"modifiedDate": "2023-02-10T15:18:25Z",
"sourceModifiedDate": "2021-11-18T15:24:03"
},
{
"id": "5097398534302",
"customerName": "Qa Test",
"phone": "+445593368390",
"addresses": [
{
"type": "Unknown",
"line1": "Look Street",
"city": "London",
"postalCode": "PO16 7GZ"
},
{
"type": "Unknown",
"line1": "Look Street",
"city": "London",
"region": "England",
"country": "United Kingdom",
"postalCode": "PO16 7GZ"
}
],
"note": "",
"createdDate": "2021-03-19T10:12:37",
"modifiedDate": "2023-02-10T15:18:25Z",
"sourceModifiedDate": "2022-08-01T13:07:59"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 6,
"_links": {
"current": {
"href": "/companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-customers?page=1&pageSize=2"
},
"self": {
"href": "/companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-customers"
},
"next": {
"href": "/companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-customers?page=2&pageSize=2"
}
}
}
},
{
"status": "200",
"contentType": "application/json",
"name": "Square",
"example": {
"results": [
{
"id": "FT9948H3VD6GF8MPDD5438KY1M",
"emailAddress": "fake@name.com",
"phone": "+441234567890",
"addresses": [
{
"type": "Unknown",
"line1": "1 Main Street",
"line2": "Flat 20",
"city": "London",
"region": "London",
"postalCode": "W1A 1AA"
}
],
"createdDate": "2021-03-08T11:21:11Z",
"modifiedDate": "2022-08-02T10:27:32Z",
"sourceModifiedDate": "2021-03-08T11:21:11Z"
},
{
"id": "GXQDPSZSMN6C58270SZN4YJZ8R",
"emailAddress": "s.shandil+square@codat.io",
"phone": "+447729946295",
"addresses": [],
"createdDate": "2020-11-19T14:56:00Z",
"modifiedDate": "2022-08-02T10:27:32Z",
"sourceModifiedDate": "2020-11-19T14:56:00Z"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 2,
"_links": {
"current": {
"href": "/companies/d779fc82-a098-4107-a9fc-c2a1dda3d522/connections/9b098b74-3770-4dad-9001-4c283a39f1e5/data/commerce-customers?page=1&pageSize=2"
},
"self": {
"href": "/companies/d779fc82-a098-4107-a9fc-c2a1dda3d522/connections/9b098b74-3770-4dad-9001-4c283a39f1e5/data/commerce-customers"
}
}
}
},
{
"status": "200",
"contentType": "application/json",
"name": "Stripe Test",
"example": {
"results": [
{
"id": "cus_LXdjls7KY5ZHaz",
"customerName": "Barry Smith",
"emailAddress": "barry@example.com",
"defaultCurrency": "gbp",
"addresses": [],
"note": "Test Subscription",
"createdDate": "2022-04-20T07:59:52Z",
"modifiedDate": "2022-09-30T11:18:27Z"
},
{
"id": "cus_LXdFFgHqqVURIv",
"customerName": "David Dunlow",
"emailAddress": "david@example.com",
"defaultCurrency": "gbp",
"phone": "+447545309714",
"addresses": [
{
"type": "Billing",
"line1": "301 Ink Rooms",
"line2": "28 Easton Street",
"city": "London",
"country": "GB",
"postalCode": "WC1X 0BE"
},
{
"type": "Delivery",
"line1": "301 Ink Rooms",
"line2": "28 Easton Street",
"city": "London",
"country": "GB",
"postalCode": "WC1X 0BE"
}
],
"note": "Test Subscriptions",
"createdDate": "2022-04-20T07:30:01Z",
"modifiedDate": "2022-09-30T11:18:27Z"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 14,
"_links": {
"current": {
"href": "/companies/8206e78e-e340-411e-b315-473c4ab73b48/connections/43e58373-0a1d-44a0-97f0-9fa9993a14fa/data/commerce-customers?page=1&pageSize=2"
},
"self": {
"href": "/companies/8206e78e-e340-411e-b315-473c4ab73b48/connections/43e58373-0a1d-44a0-97f0-9fa9993a14fa/data/commerce-customers"
},
"next": {
"href": "/companies/8206e78e-e340-411e-b315-473c4ab73b48/connections/43e58373-0a1d-44a0-97f0-9fa9993a14fa/data/commerce-customers?page=2&pageSize=2"
}
}
}
},
{
"status": "200",
"contentType": "application/json",
"name": "WooCommerce",
"example": {
"results": [
{
"id": "201694267",
"customerName": "Qa Test",
"emailAddress": "a.macra@codat.io",
"phone": "",
"addresses": [
{
"type": "Billing",
"line1": "",
"line2": "",
"city": "",
"region": "",
"country": "",
"postalCode": ""
}
],
"createdDate": "2021-03-11T09:04:27",
"modifiedDate": "2021-07-13T16:19:00Z",
"sourceModifiedDate": "2021-03-11T09:07:00"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 1,
"_links": {
"current": {
"href": "/companies/010c6f53-8fc8-40ab-9ed5-41191cf9c6b5/connections/7545ca2e-5f58-4f98-8af2-3b2c38bb8074/data/commerce-customers?page=1&pageSize=2"
},
"self": {
"href": "/companies/010c6f53-8fc8-40ab-9ed5-41191cf9c6b5/connections/7545ca2e-5f58-4f98-8af2-3b2c38bb8074/data/commerce-customers"
}
}
}
},
{
"status": "200",
"contentType": "application/json",
"name": "Zettle",
"example": {
"results": [
{
"id": "firstname.lastname@example.com",
"customerName": "Firstname Lastname",
"emailAddress": "firstname.lastname@example.com",
"addresses": [
{
"type": "Unknown",
"line1": "Line1",
"city": "City",
"country": "GB",
"postalCode": "TT1 1TT"
}
],
"createdDate": "2021-01-07T16:17:34",
"modifiedDate": "2021-01-27T13:08:51Z",
"sourceModifiedDate": "2021-01-08T09:57:56"
},
{
"id": "joe@bloggs.com",
"customerName": "Joe Bloggs",
"emailAddress": "joe@bloggs.com",
"phone": "02012 345678",
"addresses": [
{
"type": "Unknown",
"line1": "Flat 1",
"line2": "1 High Street",
"city": "London",
"region": "London",
"country": "GB"
},
{
"type": "Unknown",
"line1": "Flat 2",
"line2": "2 High Street",
"city": "London",
"region": "London",
"country": "GB"
}
],
"createdDate": "2020-12-21T14:52:15",
"modifiedDate": "2021-01-27T13:08:51Z",
"sourceModifiedDate": "2020-12-21T14:52:15"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 2,
"_links": {
"current": {
"href": "/companies/fe8e3158-47e6-4367-9537-7d5001295500/connections/d60b15e7-7db9-459b-92a0-9557f7ebdeea/data/commerce-customers?page=1&pageSize=2"
},
"self": {
"href": "/companies/fe8e3158-47e6-4367-9537-7d5001295500/connections/d60b15e7-7db9-459b-92a0-9557f7ebdeea/data/commerce-customers"
}
}
}
}
]
}