{
"openapi": "3.1.0",
"servers": [
{
"description": "Production",
"url": "https://api.codat.io"
}
],
"info": {
"title": "Commerce API",
"version": "3.0.0",
"contact": {
"name": "Codat",
"email": "support@codat.io"
},
"summary": "Codat's standardized API for accessing commerce data ",
"description": "> ### New to Codat?\n>\n> Our Commerce API reference is relevant only to our existing clients.\n> Please reach out to your Codat contact so that we can find the right product for you.\n\nCodat's Commerce API allows you to access standardised data from over 11 commerce and POS systems.\n\nStandardize how you connect to your customers’ payment, PoS, and eCommerce systems. Retrieve orders, payouts, payments, and product data in the same way for all the leading commerce software.\n\n\n## Endpoints\n\n| Endpoints | Description |\n| :- |:- |\n| Customers | Retrieve standardized data from linked commerce software. |\n| Disputes | Retrieve standardized data from linked commerce software. |\n| Company info | Retrieve standardized data from linked commerce software. |\n| Locations | Retrieve standardized data from linked commerce software. |\n| Orders | Retrieve standardized data from linked commerce software. |\n| Payments | Retrieve standardized data from linked commerce software. |\n| Products | Retrieve standardized data from linked commerce software. |\n| Tax components | Retrieve standardized data from linked commerce software. |\n| Transactions | Retrieve standardized data from linked commerce software. |\n\n\n[Read more...](https://docs.codat.io/commerce-api/overview)\n\n[See our OpenAPI spec](https://github.com/codatio/oas) ",
"termsOfService": "https://www.codat.io/legals/"
},
"security": [
{
"auth_header": []
}
],
"x-speakeasy-retries": {
"strategy": "backoff",
"backoff": {
"initialInterval": 500,
"maxInterval": 60000,
"maxElapsedTime": 3600000,
"exponent": 1.5
},
"statusCodes": [
408,
429,
"5XX"
],
"retryConnectionErrors": true
},
"x-speakeasy-name-override": [
{
"operationId": "^list*",
"methodNameOverride": "list"
},
{
"operationId": "^get*",
"methodNameOverride": "get"
}
],
"x-codat-speakeasy-pagination": {
"type": "offsetLimit",
"inputs": [
{
"name": "page",
"in": "parameters",
"type": "page"
}
],
"outputs": {
"results": "$.results"
}
},
"x-codat-docs-path": "codat-api",
"tags": [
{
"name": "Customers",
"description": "Retrieve standardized data from linked commerce software."
},
{
"name": "Disputes",
"description": "Retrieve standardized data from linked commerce software."
},
{
"name": "Company info",
"description": "Retrieve standardized data from linked commerce software."
},
{
"name": "Locations",
"description": "Retrieve standardized data from linked commerce software."
},
{
"name": "Orders",
"description": "Retrieve standardized data from linked commerce software."
},
{
"name": "Payments",
"description": "Retrieve standardized data from linked commerce software."
},
{
"name": "Products",
"description": "Retrieve standardized data from linked commerce software."
},
{
"name": "Tax components",
"description": "Retrieve standardized data from linked commerce software."
},
{
"name": "Transactions",
"description": "Retrieve standardized data from linked commerce software."
}
],
"paths": {
"/companies/{companyId}/connections/{connectionId}/data/commerce-customers": {
"parameters": [
{
"$ref": "#/components/parameters/companyId"
},
{
"$ref": "#/components/parameters/connectionId"
}
],
"get": {
"tags": [
"Customers"
],
"summary": "List customers",
"operationId": "list-customers",
"description": "The *List customers* endpoint returns a list of [customers](https://docs.codat.io/commerce-api#/schemas/Customer) for a given company's connection.\n\n[Customers](https://docs.codat.io/commerce-api#/schemas/Customer) are people or organizations that place orders, make payments and recieve goods and/or services from the SMB.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n ",
"parameters": [
{
"$ref": "#/components/parameters/page"
},
{
"$ref": "#/components/parameters/pageSize"
},
{
"$ref": "#/components/parameters/query"
},
{
"$ref": "#/components/parameters/orderBy"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Customers"
},
"examples": {
"BigCommerce": {
"value": {
"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"
}
}
}
},
"Clover": {
"value": {
"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"
}
}
}
},
"Mollie": {
"value": {
"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"
}
}
}
},
"Mollie Test": {
"value": {
"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"
}
}
}
},
"PrestaShop": {
"value": {
"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"
}
}
}
},
"Shopify": {
"value": {
"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"
}
}
}
},
"Square": {
"value": {
"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"
}
}
}
},
"Stripe Test": {
"value": {
"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"
}
}
}
},
"WooCommerce": {
"value": {
"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"
}
}
}
},
"Zettle": {
"value": {
"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"
}
}
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/Malformed-Query"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/Payment-Required"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/Not-Found"
},
"409": {
"$ref": "#/components/responses/Conflict"
},
"429": {
"$ref": "#/components/responses/Too-Many-Requests"
},
"500": {
"$ref": "#/components/responses/Internal-Server-Error"
},
"503": {
"$ref": "#/components/responses/Service-Unavailable"
}
}
}
},
"/companies/{companyId}/connections/{connectionId}/data/commerce-customers/{customerId}": {
"parameters": [
{
"$ref": "#/components/parameters/companyId"
},
{
"$ref": "#/components/parameters/connectionId"
},
{
"name": "customerId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"examples": {
"$ref": "#/components/schemas/Order/allOf/0/properties/id/examples"
}
},
"description": "Unique identifier for a customer."
}
],
"get": {
"tags": [
"Customers"
],
"summary": "Get customer",
"operationId": "get-customer",
"description": "The *Get customer* endpoint returns a single customer for a given customerId.\n\n[Customers](https://docs.codat.io/commerce-api#/schemas/Customer) are people or organizations that place orders, make payments and receive goods and/or services from the SMB.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-customers) for integrations that support getting a specific customer.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Customer"
},
"examples": {
"BigCommerce": {
"value": {
"id": "1",
"customerName": "Amy Jones",
"emailAddress": "a.durbanjackson+amy@codat.io",
"defaultCurrency": "XXX",
"phone": "07770666777",
"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"
}
},
"Clover": {
"value": {
"id": "2CBJ8R898ZJAR",
"customerName": "",
"addresses": [],
"createdDate": "2021-09-22T13:10:12Z",
"modifiedDate": "2023-01-09T11:01:03Z",
"sourceModifiedDate": "0001-01-01T00:00:00"
}
},
"Mollie": {
"value": {
"id": "cst_NUkBHQmekz",
"customerName": "Frod Baggins",
"emailAddress": "frodo.baggings@theshire.com",
"addresses": [],
"createdDate": "2022-01-18T11:41:54",
"modifiedDate": "2022-03-17T15:47:28Z"
}
},
"Mollie Test": {
"value": {
"id": "cst_NUkBHQmekz",
"customerName": "Frod Baggins",
"emailAddress": "frodo.baggings@theshire.com",
"addresses": [],
"createdDate": "2022-01-18T11:41:54",
"modifiedDate": "2022-08-17T11:33:19Z"
}
},
"PrestaShop": {
"value": {
"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"
}
},
"Shopify": {
"value": {
"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"
}
},
"Square": {
"value": {
"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"
}
},
"Stripe Test": {
"value": {
"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"
}
},
"WooCommerce": {
"value": {
"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"
}
},
"Zettle": {
"value": {
"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"
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/Payment-Required"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/Not-Found"
},
"409": {
"$ref": "#/components/responses/Conflict"
},
"429": {
"$ref": "#/components/responses/Too-Many-Requests"
},
"500": {
"$ref": "#/components/responses/Internal-Server-Error"
},
"503": {
"$ref": "#/components/responses/Service-Unavailable"
}
}
}
},
"/companies/{companyId}/connections/{connectionId}/data/commerce-disputes": {
"parameters": [
{
"$ref": "#/components/parameters/companyId"
},
{
"$ref": "#/components/parameters/connectionId"
}
],
"get": {
"summary": "List disputes",
"tags": [
"Disputes"
],
"operationId": "list-disputes",
"parameters": [
{
"$ref": "#/components/parameters/page"
},
{
"$ref": "#/components/parameters/pageSize"
},
{
"$ref": "#/components/parameters/query"
},
{
"$ref": "#/components/parameters/orderBy"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Disputes"
},
"examples": {
"Shopify": {
"value": {
"results": [
{
"id": "8502411422",
"disputedTransactions": [
{
"id": "3684116791454",
"type": "Order"
}
],
"totalAmount": 175,
"currency": "GBP",
"status": "Processing",
"reason": "fraudulent",
"dueDate": "2021-03-28T00:00:00",
"createdDate": "2021-03-19T13:16:27",
"modifiedDate": "2023-02-10T15:18:22Z",
"sourceModifiedDate": "2021-03-28T11:00:17"
},
{
"id": "8502444190",
"disputedTransactions": [
{
"id": "3684119445662",
"type": "Order"
}
],
"totalAmount": 600,
"currency": "GBP",
"status": "Processing",
"reason": "fraudulent",
"dueDate": "2021-03-28T00:00:00",
"createdDate": "2021-03-19T13:18:31",
"modifiedDate": "2023-02-10T15:18:22Z",
"sourceModifiedDate": "2021-03-28T11:00:18"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 2,
"_links": {
"current": {
"href": "/companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-disputes?page=1&pageSize=2"
},
"self": {
"href": "/companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-disputes"
}
}
}
},
"Stripe Test": {
"value": {
"results": [
{
"id": "dp_1Hqhl8A8m8S1Gh7OJrvF3gsK",
"disputedTransactions": [
{
"id": "txn_1Hqhl8A8m8S1Gh7OtmAPNr9e",
"type": "Payment"
}
],
"totalAmount": 25,
"currency": "GBP",
"status": "Processing",
"reason": "fraudulent",
"dueDate": "2020-12-02T23:59:59Z",
"createdDate": "2020-11-23T16:19:22Z",
"modifiedDate": "2022-09-30T11:18:27Z"
},
{
"id": "dp_1HqiwVA8m8S1Gh7OpS3ozlcd",
"disputedTransactions": [
{
"id": "txn_1HqiwVA8m8S1Gh7O0IVelTQ5",
"type": "Payment"
}
],
"totalAmount": 55,
"currency": "GBP",
"status": "Lost",
"reason": "product_not_received",
"dueDate": "2020-12-02T23:59:59Z",
"createdDate": "2020-11-23T17:35:11Z",
"modifiedDate": "2022-09-30T11:18:27Z"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 5,
"_links": {
"current": {
"href": "/companies/8206e78e-e340-411e-b315-473c4ab73b48/connections/43e58373-0a1d-44a0-97f0-9fa9993a14fa/data/commerce-disputes?page=1&pageSize=2"
},
"self": {
"href": "/companies/8206e78e-e340-411e-b315-473c4ab73b48/connections/43e58373-0a1d-44a0-97f0-9fa9993a14fa/data/commerce-disputes"
},
"next": {
"href": "/companies/8206e78e-e340-411e-b315-473c4ab73b48/connections/43e58373-0a1d-44a0-97f0-9fa9993a14fa/data/commerce-disputes?page=2&pageSize=2"
}
}
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/Malformed-Query"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/Payment-Required"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/Not-Found"
},
"409": {
"$ref": "#/components/responses/Conflict"
},
"429": {
"$ref": "#/components/responses/Too-Many-Requests"
},
"500": {
"$ref": "#/components/responses/Internal-Server-Error"
},
"503": {
"$ref": "#/components/responses/Service-Unavailable"
}
},
"description": "The *List disputes* endpoint returns a list of [disputes](https://docs.codat.io/commerce-api#/schemas/Dispute) for a given company's connection.\n\n[Disputes](https://docs.codat.io/commerce-api#/schemas/Dispute) are created when a customer is unsatisfied with their purchase or believe they have been charged incorrectly.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n "
}
},
"/companies/{companyId}/connections/{connectionId}/data/commerce-disputes/{disputeId}": {
"parameters": [
{
"$ref": "#/components/parameters/companyId"
},
{
"$ref": "#/components/parameters/connectionId"
},
{
"name": "disputeId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"examples": {
"$ref": "#/components/schemas/Order/allOf/0/properties/id/examples"
}
},
"description": "Unique identifier for a dispute."
}
],
"get": {
"summary": "Get dispute",
"tags": [
"Disputes"
],
"operationId": "get-dispute",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Dispute"
},
"examples": {
"Shopify": {
"value": {
"id": "8502411422",
"disputedTransactions": [
{
"id": "3684116791454",
"type": "Order"
}
],
"totalAmount": 175,
"currency": "GBP",
"status": "Processing",
"reason": "fraudulent",
"dueDate": "2021-03-28T00:00:00",
"createdDate": "2021-03-19T13:16:27",
"modifiedDate": "2023-02-10T15:18:22Z",
"sourceModifiedDate": "2021-03-28T11:00:17"
}
},
"Stripe Test": {
"value": {
"id": "dp_1Hqhl8A8m8S1Gh7OJrvF3gsK",
"disputedTransactions": [
{
"id": "txn_1Hqhl8A8m8S1Gh7OtmAPNr9e",
"type": "Payment"
}
],
"totalAmount": 25,
"currency": "GBP",
"status": "Processing",
"reason": "fraudulent",
"dueDate": "2020-12-02T23:59:59Z",
"createdDate": "2020-11-23T16:19:22Z",
"modifiedDate": "2022-09-30T11:18:27Z"
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/Payment-Required"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/Not-Found"
},
"409": {
"$ref": "#/components/responses/Conflict"
},
"429": {
"$ref": "#/components/responses/Too-Many-Requests"
},
"500": {
"$ref": "#/components/responses/Internal-Server-Error"
},
"503": {
"$ref": "#/components/responses/Service-Unavailable"
}
},
"description": "The *Get dispute* endpoint returns a single dispute for a given disputeId.\n\n[Disputes](https://docs.codat.io/commerce-api#/schemas/Dispute) are created when a customer is unsatisfied with their purchase or believe they have been charged incorrectly.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-disputes) for integrations that support getting a specific dispute.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n"
}
},
"/companies/{companyId}/connections/{connectionId}/data/commerce-info": {
"parameters": [
{
"$ref": "#/components/parameters/companyId"
},
{
"$ref": "#/components/parameters/connectionId"
}
],
"get": {
"summary": "Get company info",
"tags": [
"Company info"
],
"operationId": "get-company-info",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CompanyInfo"
},
"examples": {
"Example 1": {
"value": {
"companyName": "Codat",
"companyLegalName": "Codat Ltd",
"addresses": [
{
"type": "Billing",
"line1": "301 Ink Rooms",
"line2": "28 Easton Street",
"city": "London",
"region": "England",
"country": "United Kingdom",
"postalCode": "WC1X 0BE"
},
{
"type": "Delivery",
"line1": "28 Easton Street",
"city": "London",
"country": "UK",
"postalCode": "WC1X 0BE"
}
],
"phoneNumbers": [
{
"number": "02012 345678",
"type": "Landline"
},
{
"number": "07123 456789",
"type": "Mobile"
},
{
"number": "02012 345678",
"type": "Fax"
}
],
"webLinks": [
{
"type": "Website",
"url": "https://www.codat.io/"
},
{
"type": "Social",
"url": "https://www.linkedin.com/company/codat-limited/"
}
],
"registrationNumber": "5590111724",
"baseCurrency": "GBP",
"accountBalances": [
{
"available": 20053.23,
"pending": 2034.23,
"reserved": 517.23,
"currency": "GBP"
}
],
"sourceUrls": {
"Api": "https://api.codat.io"
},
"createdDate": "2019-03-07T16:50:49",
"modifiedDate": "2022-03-10T15:42:13",
"sourceModifiedDate": "2021-06-10T01:48:49"
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/Payment-Required"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/Not-Found"
},
"409": {
"$ref": "#/components/responses/Conflict"
},
"429": {
"$ref": "#/components/responses/Too-Many-Requests"
},
"500": {
"$ref": "#/components/responses/Internal-Server-Error"
},
"503": {
"$ref": "#/components/responses/Service-Unavailable"
}
},
"description": "Retrieve information about the company, as seen in the commerce software.\n\nThis may include information like addresses, tax registration details and social media or website information."
}
},
"/companies/{companyId}/connections/{connectionId}/data/commerce-locations": {
"parameters": [
{
"$ref": "#/components/parameters/companyId"
},
{
"$ref": "#/components/parameters/connectionId"
}
],
"get": {
"summary": "List locations",
"tags": [
"Locations"
],
"operationId": "list-locations",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Locations"
},
"examples": {
"Clover": {
"value": {
"results": [
{
"id": "GA3WP1ZC3ZFK1",
"name": "Codat",
"address": {
"type": "Inventory",
"line1": "301 Ink Rooms, 28 Easton Street",
"city": "London",
"region": "London",
"country": "GB",
"postalCode": "WC1X 0BE"
},
"modifiedDate": "2023-01-09T11:01:03Z"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 1,
"_links": {
"current": {
"href": "/companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-locations?page=1&pageSize=2"
},
"self": {
"href": "/companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-locations"
}
}
}
},
"Lightspeed K Trial": {
"value": {
"results": [
{
"id": "647208621834538",
"name": "QA Shared - New Test Site",
"address": {
"type": "Unknown",
"country": "AU"
},
"modifiedDate": "2023-03-02T09:48:48Z"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 1,
"_links": {
"current": {
"href": "/companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-locations?page=1&pageSize=2"
},
"self": {
"href": "/companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-locations"
}
}
}
},
"Shopify": {
"value": {
"results": [
{
"id": "61375348894",
"name": "301 Ink Rooms, 28 Easton St",
"address": {
"type": "Inventory",
"line1": "301 Ink Rooms, 28 Easton St",
"city": "London",
"region": "London",
"country": "GB",
"postalCode": "WC1X 0BE"
},
"modifiedDate": "2023-02-10T15:18:25Z",
"sourceModifiedDate": "2021-03-19T10:06:06"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 1,
"_links": {
"current": {
"href": "/companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-locations?page=1&pageSize=2"
},
"self": {
"href": "/companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-locations"
}
}
}
},
"Square": {
"value": {
"results": [
{
"id": "D8DVHD1G6NT2J",
"name": "Codat Limited",
"address": {
"type": "Inventory",
"line1": "301 Ink Rooms",
"line2": "28 Easton Street",
"city": "London",
"country": "GB",
"postalCode": "WC1X0BE"
},
"modifiedDate": "2022-08-02T10:27:32Z",
"sourceModifiedDate": "2020-01-17T14:07:30Z"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 1,
"_links": {
"current": {
"href": "/companies/d779fc82-a098-4107-a9fc-c2a1dda3d522/connections/9b098b74-3770-4dad-9001-4c283a39f1e5/data/commerce-locations?page=1&pageSize=2"
},
"self": {
"href": "/companies/d779fc82-a098-4107-a9fc-c2a1dda3d522/connections/9b098b74-3770-4dad-9001-4c283a39f1e5/data/commerce-locations"
}
}
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/Payment-Required"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/Not-Found"
},
"409": {
"$ref": "#/components/responses/Conflict"
},
"429": {
"$ref": "#/components/responses/Too-Many-Requests"
},
"500": {
"$ref": "#/components/responses/Internal-Server-Error"
},
"503": {
"$ref": "#/components/responses/Service-Unavailable"
}
},
"description": "The *List locations* endpoint returns a list of [locations](https://docs.codat.io/commerce-api#/schemas/Location) for a given company's connection.\n\n[Locations](https://docs.codat.io/commerce-api#/schemas/Location) hold information on the geographic location at which stocks of [products](https://docs.codat.io/commerce-api#/schemas/Product) may be held or where [orders](https://docs.codat.io/commerce-api#/schemas/Order) were placed.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n "
}
},
"/companies/{companyId}/connections/{connectionId}/data/commerce-locations/{locationId}": {
"parameters": [
{
"$ref": "#/components/parameters/companyId"
},
{
"$ref": "#/components/parameters/connectionId"
},
{
"name": "locationId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"examples": {
"$ref": "#/components/schemas/Order/allOf/0/properties/id/examples"
}
},
"description": "Unique identifier for a location."
}
],
"get": {
"summary": "Get location",
"tags": [
"Locations"
],
"operationId": "get-location",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Location"
},
"examples": {
"Clover": {
"value": {
"id": "GA3WP1ZC3ZFK1",
"name": "Codat",
"address": {
"type": "Inventory",
"line1": "301 Ink Rooms, 28 Easton Street",
"city": "London",
"region": "London",
"country": "GB",
"postalCode": "WC1X 0BE"
},
"modifiedDate": "2023-01-09T11:01:03Z"
}
},
"Lightspeed K Trial": {
"value": {
"id": "647208621834538",
"name": "QA Shared - New Test Site",
"address": {
"type": "Unknown",
"country": "AU"
},
"modifiedDate": "2023-03-02T09:48:48Z"
}
},
"Shopify": {
"value": {
"id": "61375348894",
"name": "301 Ink Rooms, 28 Easton St",
"address": {
"type": "Inventory",
"line1": "301 Ink Rooms, 28 Easton St",
"city": "London",
"region": "London",
"country": "GB",
"postalCode": "WC1X 0BE"
},
"modifiedDate": "2023-02-10T15:18:25Z",
"sourceModifiedDate": "2021-03-19T10:06:06"
}
},
"Square": {
"value": {
"id": "D8DVHD1G6NT2J",
"name": "Codat Limited",
"address": {
"type": "Inventory",
"line1": "301 Ink Rooms",
"line2": "28 Easton Street",
"city": "London",
"country": "GB",
"postalCode": "WC1X0BE"
},
"modifiedDate": "2022-08-02T10:27:32Z",
"sourceModifiedDate": "2020-01-17T14:07:30Z"
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/Payment-Required"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/Not-Found"
},
"409": {
"$ref": "#/components/responses/Conflict"
},
"429": {
"$ref": "#/components/responses/Too-Many-Requests"
},
"500": {
"$ref": "#/components/responses/Internal-Server-Error"
},
"503": {
"$ref": "#/components/responses/Service-Unavailable"
}
},
"description": "The *Get location* endpoint returns a single location for a given locationId.\n\n[Locations](https://docs.codat.io/commerce-api#/schemas/Location) hold information on the geographic location at which stocks of [products](https://docs.codat.io/commerce-api#/schemas/Product) may be held or where [orders](https://docs.codat.io/commerce-api#/schemas/Order) were placed.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-locations) for integrations that support getting a specific location.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n"
}
},
"/companies/{companyId}/connections/{connectionId}/data/commerce-orders": {
"parameters": [
{
"$ref": "#/components/parameters/companyId"
},
{
"$ref": "#/components/parameters/connectionId"
}
],
"get": {
"summary": "List orders",
"tags": [
"Orders"
],
"operationId": "list-orders",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"x-speakeasy-usage-example": true,
"schema": {
"$ref": "#/components/schemas/Orders"
},
"examples": {
"Amazon Seller Central": {
"value": {
"results": [
{
"id": "902-1845936-5435065",
"orderNumber": "902-1845936-5435065",
"country": "US ",
"currency": "USD",
"createdDate": "1970-01-19T03:58:30Z",
"totalAmount": 10,
"totalRefund": 0,
"totalTaxAmount": 1.01,
"totalDiscount": 0,
"totalGratuity": 0,
"orderLineItems": [
{
"id": "O05015851154158",
"quantity": 1,
"taxPercentage": 11.23,
"totalAmount": 10,
"totalTaxAmount": 1.01,
"unitPrice": 8.99,
"taxes": [],
"productVariantRef": {
"id": "NABetaASINB00551Q3CS"
},
"discountAllocations": []
}
],
"payments": [],
"serviceCharges": [],
"modifiedDate": "2023-01-09T09:12:12Z",
"sourceModifiedDate": "1970-01-19T03:58:32Z"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 1,
"_links": {
"current": {
"href": "/companies/6a59da96-e6d2-4c5c-ace7-65ba8be6a472/connections/58be1638-2c74-4ad4-8ff3-8c5b98b5f0fe/data/commerce-orders?page=1&pageSize=2"
},
"self": {
"href": "/companies/6a59da96-e6d2-4c5c-ace7-65ba8be6a472/connections/58be1638-2c74-4ad4-8ff3-8c5b98b5f0fe/data/commerce-orders"
}
}
}
},
"BigCommerce": {
"value": {
"results": [
{
"id": "100",
"orderNumber": "100",
"country": "GBR",
"currency": "GBP",
"createdDate": "2022-06-15T15:48:18Z",
"totalAmount": 675,
"totalRefund": 0,
"totalTaxAmount": 112.5,
"totalDiscount": 10,
"totalGratuity": 0,
"orderLineItems": [
{
"id": "1",
"quantity": 1,
"taxPercentage": 20,
"totalAmount": 221.64,
"totalTaxAmount": 36.94,
"unitPrice": 187.5,
"taxes": [],
"productRef": {
"id": "86",
"name": "[Sample] Able Brewing System"
},
"productVariantRef": {
"id": "66",
"name": "[Sample] Able Brewing System"
},
"discountAllocations": [
{
"name": "Manual Discount",
"totalAmount": 3.36
}
]
},
{
"id": "2",
"quantity": 5,
"taxPercentage": 19.9999,
"totalAmount": 438.36,
"totalTaxAmount": 73.06,
"unitPrice": 74.1667,
"taxes": [],
"productRef": {
"id": "81",
"name": "[Sample] Orbit Terrarium - Small"
},
"productVariantRef": {
"id": "65",
"name": "[Sample] Orbit Terrarium - Small"
},
"discountAllocations": [
{
"name": "Manual Discount",
"totalAmount": 6.64
}
]
}
],
"payments": [],
"serviceCharges": [
{
"description": "Shipping Charge",
"totalAmount": 15,
"taxPercentage": 20,
"taxAmount": 2.5,
"taxes": [],
"quantity": 1,
"type": "Shipping"
}
],
"customerRef": {
"id": "0"
},
"modifiedDate": "2023-04-11T10:33:56Z",
"sourceModifiedDate": "2022-06-15T15:48:18Z"
},
{
"id": "101",
"orderNumber": "101",
"country": "GBR",
"currency": "GBP",
"createdDate": "2022-06-15T15:49:02Z",
"totalAmount": 675,
"totalRefund": 0,
"totalTaxAmount": 112.5,
"totalDiscount": 10,
"totalGratuity": 0,
"orderLineItems": [
{
"id": "3",
"quantity": 1,
"taxPercentage": 20,
"totalAmount": 221.64,
"totalTaxAmount": 36.94,
"unitPrice": 187.5,
"taxes": [],
"productRef": {
"id": "86",
"name": "[Sample] Able Brewing System"
},
"productVariantRef": {
"id": "66",
"name": "[Sample] Able Brewing System"
},
"discountAllocations": [
{
"name": "Manual Discount",
"totalAmount": 3.36
}
]
},
{
"id": "4",
"quantity": 5,
"taxPercentage": 19.9999,
"totalAmount": 438.36,
"totalTaxAmount": 73.06,
"unitPrice": 74.1667,
"taxes": [],
"productRef": {
"id": "81",
"name": "[Sample] Orbit Terrarium - Small"
},
"productVariantRef": {
"id": "65",
"name": "[Sample] Orbit Terrarium - Small"
},
"discountAllocations": [
{
"name": "Manual Discount",
"totalAmount": 6.64
}
]
}
],
"payments": [],
"serviceCharges": [
{
"description": "Shipping Charge",
"totalAmount": 15,
"taxPercentage": 20,
"taxAmount": 2.5,
"taxes": [],
"quantity": 1,
"type": "Shipping"
}
],
"customerRef": {
"id": "0"
},
"modifiedDate": "2023-04-11T10:33:56Z",
"sourceModifiedDate": "2022-06-15T15:49:02Z"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 14,
"_links": {
"current": {
"href": "/companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-orders?page=1&pageSize=2"
},
"self": {
"href": "/companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-orders"
},
"next": {
"href": "/companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-orders?page=2&pageSize=2"
}
}
}
},
"Clover": {
"value": {
"results": [
{
"id": "0BCZPWGFC3M16",
"orderNumber": "0BCZPWGFC3M16",
"country": "GB ",
"currency": "GBP",
"createdDate": "2021-05-24T10:33:41Z",
"totalAmount": 1200,
"totalRefund": 0,
"totalTaxAmount": 200,
"totalDiscount": 0,
"totalGratuity": 0,
"orderLineItems": [
{
"id": "985WY5J4H12XY",
"quantity": 1,
"taxPercentage": 20,
"totalAmount": 1200,
"totalTaxAmount": 200,
"unitPrice": 1000,
"taxes": [
{
"taxComponentRef": {
"id": "KAWQTPZP3R9VT",
"name": "VAT 20%"
},
"taxAmount": 200
}
],
"productRef": {
"id": "NMZHKK6FKF6ZJ",
"name": "Laptop"
},
"discountAllocations": []
}
],
"payments": [
{
"id": "S2D924NX13T2G"
}
],
"serviceCharges": [],
"locationRef": {
"id": "GA3WP1ZC3ZFK1",
"name": "Codat"
},
"modifiedDate": "2022-09-08T15:47:43Z",
"sourceModifiedDate": "2021-05-24T10:33:45Z"
},
{
"id": "0G22TXMYQQE54",
"orderNumber": "0G22TXMYQQE54",
"country": "GB ",
"currency": "GBP",
"createdDate": "2021-05-24T11:24:48Z",
"totalAmount": 1340,
"totalRefund": 0,
"totalTaxAmount": 240,
"totalDiscount": 100,
"totalGratuity": 0,
"orderLineItems": [
{
"id": "GZ73TPFAV6NTP",
"quantity": 1,
"taxPercentage": 20,
"totalAmount": 1440,
"totalTaxAmount": 240,
"unitPrice": 1200,
"taxes": [
{
"taxComponentRef": {
"id": "KAWQTPZP3R9VT",
"name": "VAT 20%"
},
"taxAmount": 240
}
],
"productRef": {
"id": "QVAV6KM1457B0",
"name": "Desktop"
},
"discountAllocations": []
},
{
"id": "Discount: �10 off",
"quantity": 1,
"taxPercentage": 0,
"totalAmount": -100,
"totalTaxAmount": 0,
"unitPrice": 0,
"taxes": [],
"discountAllocations": [
{
"name": "�10 off",
"totalAmount": 100
}
]
}
],
"payments": [
{
"id": "H726AAJQYE3SP"
}
],
"serviceCharges": [],
"locationRef": {
"id": "GA3WP1ZC3ZFK1",
"name": "Codat"
},
"modifiedDate": "2022-09-08T15:47:43Z",
"sourceModifiedDate": "2021-05-24T11:24:52Z"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 76,
"_links": {
"current": {
"href": "/companies/1535235d-5efb-4d17-9d94-491c1f35ff92/connections/ed802898-f920-486b-b553-d7b4c1ac6c8d/data/commerce-orders?page=1&pageSize=2"
},
"self": {
"href": "/companies/1535235d-5efb-4d17-9d94-491c1f35ff92/connections/ed802898-f920-486b-b553-d7b4c1ac6c8d/data/commerce-orders"
},
"next": {
"href": "/companies/1535235d-5efb-4d17-9d94-491c1f35ff92/connections/ed802898-f920-486b-b553-d7b4c1ac6c8d/data/commerce-orders?page=2&pageSize=2"
}
}
}
},
"Lightspeed K Trial": {
"value": {
"results": [
{
"id": "A61465.1",
"orderNumber": "A61465.1",
"country": "AU ",
"currency": "AUD",
"createdDate": "2022-12-09T02:27:14Z",
"closedDate": "2022-12-09T02:27:46Z",
"totalAmount": 5,
"totalRefund": 0,
"totalTaxAmount": 0.45,
"totalDiscount": 0,
"totalGratuity": 0,
"orderLineItems": [
{
"id": "S61465.1",
"quantity": 1,
"taxPercentage": 10,
"totalAmount": 5,
"totalTaxAmount": 0.45,
"unitPrice": 4.5455,
"taxes": [
{
"taxComponentRef": {
"id": "GST10",
"name": "10% GST"
},
"taxAmount": 0.45
}
],
"productRef": {
"id": "647208621834617",
"name": "Hot Chocolate"
},
"discountAllocations": []
}
],
"payments": [
{
"id": "R61465.1_1_A61465.1_2022-12-09T02:27:46.273Z",
"amount": 5,
"currency": "AUD",
"type": "Unknown",
"status": "Paid",
"dueDate": "0001-01-01T00:00:00",
"createdDate": "2022-12-09T02:27:46",
"modifiedDate": "2023-03-02T09:50:43"
}
],
"serviceCharges": [],
"locationRef": {
"id": "647208621834538",
"name": "QA Shared - New Test Site"
},
"modifiedDate": "2023-03-08T13:49:34Z"
},
{
"id": "A61465.2",
"orderNumber": "A61465.2",
"country": "AU ",
"currency": "AUD",
"createdDate": "2022-12-12T23:20:12Z",
"closedDate": "2022-12-12T23:21:29Z",
"totalAmount": 10,
"totalRefund": 0,
"totalTaxAmount": 0.91,
"totalDiscount": 0,
"totalGratuity": 0,
"orderLineItems": [
{
"id": "S61465.2",
"quantity": 1,
"taxPercentage": 10,
"totalAmount": 5,
"totalTaxAmount": 0.46,
"unitPrice": 4.5455,
"taxes": [
{
"taxComponentRef": {
"id": "GST10",
"name": "10% GST"
},
"taxAmount": 0.46
}
],
"productRef": {
"id": "647208621834663",
"name": "Royal"
},
"discountAllocations": []
},
{
"id": "S61465.3",
"quantity": 1,
"taxPercentage": 10,
"totalAmount": 5,
"totalTaxAmount": 0.45,
"unitPrice": 4.5455,
"taxes": [
{
"taxComponentRef": {
"id": "GST10",
"name": "10% GST"
},
"taxAmount": 0.45
}
],
"productRef": {
"id": "647208621834623",
"name": "Mocha"
},
"discountAllocations": []
}
],
"payments": [
{
"id": "R61465.2_1_A61465.2_2022-12-12T23:21:29.006Z",
"amount": 10,
"currency": "AUD",
"type": "Unknown",
"status": "Paid",
"dueDate": "0001-01-01T00:00:00",
"createdDate": "2022-12-12T23:21:29",
"modifiedDate": "2023-03-02T09:50:43"
}
],
"serviceCharges": [],
"locationRef": {
"id": "647208621834538",
"name": "QA Shared - New Test Site"
},
"modifiedDate": "2023-03-08T13:49:34Z"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 24,
"_links": {
"current": {
"href": "/companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-orders?page=1&pageSize=2"
},
"self": {
"href": "/companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-orders"
},
"next": {
"href": "/companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-orders?page=2&pageSize=2"
}
}
}
},
"Mollie": {
"value": {
"results": [
{
"id": "ord_2at3ck",
"orderNumber": "1337",
"country": "NLD",
"currency": "EUR",
"createdDate": "2022-01-20T09:28:32",
"totalAmount": 1027.99,
"totalRefund": 0,
"totalTaxAmount": 178.41,
"totalDiscount": 100,
"totalGratuity": 0,
"orderLineItems": [
{
"id": "odl_1.3tvc32",
"quantity": 1,
"taxPercentage": 21,
"totalAmount": 329.99,
"totalTaxAmount": 57.27,
"unitPrice": 329.99,
"taxes": [],
"discountAllocations": []
},
{
"id": "odl_1.x95vuk",
"quantity": 2,
"taxPercentage": 21,
"totalAmount": 698,
"totalTaxAmount": 121.14,
"unitPrice": 399,
"taxes": [],
"discountAllocations": [
{
"name": "Discount",
"totalAmount": 100
}
]
}
],
"payments": [
{
"id": "tr_GpHuaqHrca",
"amount": 1027.99,
"currency": "EUR",
"type": "OnlineCard",
"status": "Failed",
"dueDate": "0001-01-01T00:00:00",
"createdDate": "2022-02-08T15:44:22",
"modifiedDate": "2022-03-17T15:47:28",
"sourceModifiedDate": "2022-02-08T16:02:02"
},
{
"id": "tr_w7RGQc3k3V",
"amount": 1027.99,
"currency": "EUR",
"type": "OnlineCard",
"status": "Failed",
"dueDate": "0001-01-01T00:00:00",
"createdDate": "2022-01-20T09:28:32",
"modifiedDate": "2022-03-17T15:47:28",
"sourceModifiedDate": "2022-01-20T09:46:02"
}
],
"serviceCharges": [],
"modifiedDate": "2022-03-17T15:47:28Z"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 1,
"_links": {
"current": {
"href": "/companies/a68cb447-182d-4bbe-be1a-f526d11d69d5/connections/dfbf847b-cde8-4b00-b2f9-af51dec0d337/data/commerce-orders?page=1&pageSize=2"
},
"self": {
"href": "/companies/a68cb447-182d-4bbe-be1a-f526d11d69d5/connections/dfbf847b-cde8-4b00-b2f9-af51dec0d337/data/commerce-orders"
}
}
}
},
"Mollie Test": {
"value": {
"results": [
{
"id": "ord_2at3ck",
"orderNumber": "1337",
"country": "NLD",
"currency": "EUR",
"createdDate": "2022-01-20T09:28:32",
"totalAmount": 1027.99,
"totalRefund": 0,
"totalTaxAmount": 178.41,
"totalDiscount": 100,
"totalGratuity": 0,
"orderLineItems": [
{
"id": "odl_1.x95vuk",
"quantity": 2,
"taxPercentage": 21,
"totalAmount": 698,
"totalTaxAmount": 121.14,
"unitPrice": 338.43,
"taxes": [],
"discountAllocations": [
{
"name": "Discount",
"totalAmount": 100
}
]
},
{
"id": "odl_1.3tvc32",
"quantity": 1,
"taxPercentage": 21,
"totalAmount": 329.99,
"totalTaxAmount": 57.27,
"unitPrice": 272.72,
"taxes": [],
"discountAllocations": []
}
],
"payments": [
{
"id": "tr_GpHuaqHrca"
},
{
"id": "tr_w7RGQc3k3V"
}
],
"serviceCharges": [],
"modifiedDate": "2022-08-17T11:33:19Z"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 1,
"_links": {
"current": {
"href": "/companies/b978f9fe-8d63-4cfc-b2c2-b61b72e22785/connections/d564f8fd-0766-4ab8-a427-7c893f9b9ff6/data/commerce-orders?page=1&pageSize=2"
},
"self": {
"href": "/companies/b978f9fe-8d63-4cfc-b2c2-b61b72e22785/connections/d564f8fd-0766-4ab8-a427-7c893f9b9ff6/data/commerce-orders"
}
}
}
},
"Partner Commerce": {
"value": {
"results": [
{
"id": "6d135134-2f77-45f7-af3d-ee873e42da45",
"orderNumber": "93128704",
"country": "GM ",
"currency": "CAD",
"createdDate": "2021-02-10T01:37:23",
"totalAmount": 203.82,
"totalRefund": 0,
"totalTaxAmount": 40.77,
"totalDiscount": 25.63,
"totalGratuity": 80.81,
"orderLineItems": [
{
"id": "89f5e83a-c87d-4b60-a009-0ea9065867aa",
"quantity": 3,
"taxPercentage": 20,
"totalAmount": 85.44,
"totalTaxAmount": 17.09,
"unitPrice": 28.48,
"taxes": [],
"productRef": {
"id": "98ef828e-33e1-4c23-9383-a029f1d6a3a6"
},
"productVariantRef": {
"id": "dffcd99e-13bb-4b89-89ef-719b3b0777e6"
},
"discountAllocations": [
{
"name": "Discount",
"totalAmount": 8.54
},
{
"name": "Discount",
"totalAmount": 17.09
}
]
},
{
"id": "4c65f0d9-05c8-48eb-9c4a-1774f5073e66",
"quantity": 3,
"taxPercentage": 20,
"totalAmount": 118.38,
"totalTaxAmount": 23.68,
"unitPrice": 39.46,
"taxes": [],
"productRef": {
"id": "561f8efb-3429-4c1f-a014-1fa595f9b3c6"
},
"productVariantRef": {
"id": "e0715a7a-0179-4a2e-b40d-800fd2f36764"
},
"discountAllocations": []
}
],
"payments": [
{
"id": "3ec3d4c4-8003-4f77-a44e-08b3e17057bf"
}
],
"serviceCharges": [],
"locationRef": {
"id": "d84a8ce0-d7e4-400a-b07a-d4bddd9c1873"
},
"customerRef": {
"id": "0dc0206d-f22f-48c9-a4e5-79f8383c3426"
},
"modifiedDate": "2022-05-12T07:22:02Z",
"sourceModifiedDate": "2021-02-10T01:37:23"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 1,
"_links": {
"current": {
"href": "/companies/4342cb7d-d7b1-492f-851e-4aa5084933c1/connections/9e5422fa-f03f-4d58-bcf4-161b574ab350/data/commerce-orders?page=1&pageSize=2"
},
"self": {
"href": "/companies/4342cb7d-d7b1-492f-851e-4aa5084933c1/connections/9e5422fa-f03f-4d58-bcf4-161b574ab350/data/commerce-orders"
}
}
}
},
"PrestaShop": {
"value": {
"results": [
{
"id": "1",
"orderNumber": "XKBKNABJK",
"country": "US ",
"currency": "USD",
"createdDate": "2021-09-02T06:00:54",
"totalAmount": 61.8,
"totalRefund": 0,
"totalTaxAmount": 0,
"totalDiscount": 0,
"totalGratuity": 0,
"orderLineItems": [
{
"id": "1",
"quantity": 1,
"taxPercentage": 0,
"totalAmount": 23.9,
"totalTaxAmount": 0,
"unitPrice": 23.9,
"taxes": [],
"productRef": {
"id": "1",
"name": "Hummingbird printed t-shirt"
},
"discountAllocations": []
},
{
"id": "2",
"quantity": 1,
"taxPercentage": 0,
"totalAmount": 35.9,
"totalTaxAmount": 0,
"unitPrice": 35.9,
"taxes": [],
"productRef": {
"id": "2",
"name": "Hummingbird printed sweater"
},
"discountAllocations": []
}
],
"payments": [],
"serviceCharges": [
{
"description": "Shipping",
"totalAmount": 2,
"taxPercentage": 0,
"taxAmount": 0,
"taxes": [],
"quantity": 1,
"type": "Shipping"
}
],
"customerRef": {
"id": "1",
"name": "John DOE"
},
"modifiedDate": "2022-01-26T15:09:42Z",
"sourceModifiedDate": "2021-09-02T06:00:54"
},
{
"id": "10",
"orderNumber": "UFQZXPGQU",
"country": "US ",
"currency": "USD",
"createdDate": "2021-09-28T08:09:46",
"totalAmount": 19.12,
"totalRefund": 0,
"totalTaxAmount": 0,
"totalDiscount": 4.78,
"totalGratuity": 0,
"orderLineItems": [
{
"id": "14",
"quantity": 1,
"taxPercentage": 0,
"totalAmount": 19.12,
"totalTaxAmount": 0,
"unitPrice": 23.9,
"taxes": [],
"productRef": {
"id": "1",
"name": "Hummingbird printed t-shirt"
},
"discountAllocations": [
{
"name": "20% Discount",
"totalAmount": 4.78
}
]
}
],
"payments": [],
"serviceCharges": [],
"customerRef": {
"id": "5",
"name": "Tobi Yinusa"
},
"modifiedDate": "2022-01-26T15:09:42Z",
"sourceModifiedDate": "2021-09-28T08:09:46"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 10,
"_links": {
"current": {
"href": "/companies/2bf78e61-58ca-421a-a430-5dfa59cf15b0/connections/30774c1f-fdcd-491e-9e60-47e316b3ab9b/data/commerce-orders?page=1&pageSize=2"
},
"self": {
"href": "/companies/2bf78e61-58ca-421a-a430-5dfa59cf15b0/connections/30774c1f-fdcd-491e-9e60-47e316b3ab9b/data/commerce-orders"
},
"next": {
"href": "/companies/2bf78e61-58ca-421a-a430-5dfa59cf15b0/connections/30774c1f-fdcd-491e-9e60-47e316b3ab9b/data/commerce-orders?page=2&pageSize=2"
}
}
}
},
"Shopify": {
"value": {
"results": [
{
"id": "3684119445662",
"orderNumber": "1007",
"country": "XXX",
"currency": "GBP",
"createdDate": "2021-03-19T13:18:33",
"totalAmount": 600,
"totalRefund": 0,
"totalTaxAmount": 0,
"totalDiscount": 0,
"totalGratuity": 0,
"orderLineItems": [
{
"id": "9670458146974",
"quantity": 4,
"taxPercentage": 0,
"totalAmount": 600,
"totalTaxAmount": 0,
"unitPrice": 150,
"taxes": [],
"productRef": {
"id": "6595494117534",
"name": "Monitor"
},
"productVariantRef": {
"id": "39444526694558",
"name": "Monitor"
},
"discountAllocations": []
}
],
"payments": [
{
"id": "4630233579678",
"amount": 600,
"currency": "GBP",
"type": "OnlineCard",
"status": "Failed",
"paymentProvider": "Shopify Payments",
"dueDate": "0001-01-01T00:00:00",
"createdDate": "2021-03-19T13:17:49",
"modifiedDate": "2023-02-10T15:18:24",
"sourceModifiedDate": "2021-03-19T13:17:49"
},
{
"id": "4630234497182",
"amount": 600,
"currency": "GBP",
"type": "OnlineCard",
"status": "Paid",
"paymentProvider": "Shopify Payments",
"dueDate": "0001-01-01T00:00:00",
"createdDate": "2021-03-19T13:18:29",
"modifiedDate": "2023-02-10T15:18:24",
"sourceModifiedDate": "2021-03-19T13:18:29"
}
],
"serviceCharges": [],
"customerRef": {
"id": "5097398534302",
"name": "Qa Test"
},
"modifiedDate": "2023-02-10T15:18:24Z",
"sourceModifiedDate": "2022-08-01T13:12:35"
},
{
"id": "3684180361374",
"orderNumber": "1011",
"country": "XXX",
"currency": "GBP",
"createdDate": "2021-03-19T13:57:30",
"totalAmount": 105,
"totalRefund": 0,
"totalTaxAmount": 0,
"totalDiscount": 0,
"totalGratuity": 0,
"orderLineItems": [
{
"id": "9670570901662",
"quantity": 3,
"taxPercentage": 0,
"totalAmount": 105,
"totalTaxAmount": 0,
"unitPrice": 35,
"taxes": [],
"productRef": {
"id": "6595497787550",
"name": "Keyboard"
},
"productVariantRef": {
"id": "39444537213086",
"name": "Keyboard"
},
"discountAllocations": []
}
],
"payments": [
{
"id": "4630311108766",
"amount": 105,
"currency": "GBP",
"type": "Unknown",
"status": "Paid",
"paymentProvider": "Manual",
"dueDate": "0001-01-01T00:00:00",
"createdDate": "2021-03-19T13:57:30",
"modifiedDate": "2023-02-10T15:18:24",
"sourceModifiedDate": "2021-03-19T13:57:30"
}
],
"serviceCharges": [],
"customerRef": {
"id": "5097398534302",
"name": "Qa Test"
},
"modifiedDate": "2023-02-10T15:18:24Z",
"sourceModifiedDate": "2022-08-01T13:12:35"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 30,
"_links": {
"current": {
"href": "/companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-orders?page=1&pageSize=2"
},
"self": {
"href": "/companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-orders"
},
"next": {
"href": "/companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-orders?page=2&pageSize=2"
}
}
}
},
"Square": {
"value": {
"results": [
{
"id": "BDYNvtIYyWClkTjnh99CFR3fPwKZY",
"orderNumber": "BDYNvtIYyWClkTjnh99CFR3fPwKZY",
"country": "GB ",
"currency": "GBP",
"createdDate": "2021-02-14T19:38:28Z",
"closedDate": "0001-01-01T00:00:00",
"totalAmount": 50,
"totalRefund": 0,
"totalTaxAmount": 0,
"totalDiscount": 0,
"totalGratuity": 0,
"orderLineItems": [
{
"id": "lLJpgArKQbBEn9nTvLRHP",
"quantity": 1,
"taxPercentage": 0,
"totalAmount": 50,
"totalTaxAmount": 0,
"unitPrice": 50,
"taxes": [],
"discountAllocations": []
}
],
"payments": [],
"serviceCharges": [],
"locationRef": {
"id": "D8DVHD1G6NT2J",
"name": "Codat Limited"
},
"modifiedDate": "2022-08-02T10:27:33Z",
"sourceModifiedDate": "2021-02-14T19:38:28Z"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 1,
"_links": {
"current": {
"href": "/companies/d779fc82-a098-4107-a9fc-c2a1dda3d522/connections/9b098b74-3770-4dad-9001-4c283a39f1e5/data/commerce-orders?page=1&pageSize=2"
},
"self": {
"href": "/companies/d779fc82-a098-4107-a9fc-c2a1dda3d522/connections/9b098b74-3770-4dad-9001-4c283a39f1e5/data/commerce-orders"
}
}
}
},
"SumUp": {
"value": {
"results": [
{
"id": "07efcdd0-7f61-4d82-957f-52e8f0bd3f89",
"orderNumber": "TECXTU2KT6",
"country": "XXX",
"currency": "GBP",
"createdDate": "2021-03-30T12:20:40Z",
"totalAmount": 200,
"totalRefund": 0,
"totalTaxAmount": 0,
"totalDiscount": 0,
"totalGratuity": 0,
"orderLineItems": [
{
"id": "Product undefined by SumUp",
"quantity": 1,
"taxPercentage": 0,
"totalAmount": 200,
"totalTaxAmount": 0,
"unitPrice": 200,
"taxes": [],
"discountAllocations": []
}
],
"payments": [
{
"id": "07efcdd0-7f61-4d82-957f-52e8f0bd3f89"
}
],
"serviceCharges": [],
"modifiedDate": "2022-09-14T10:58:04Z"
},
{
"id": "46d36a64-ea48-4e37-9340-3548cbf3ca2f",
"orderNumber": "TNEU7333HZ",
"country": "XXX",
"currency": "GBP",
"createdDate": "2021-03-26T21:09:59Z",
"totalAmount": 15,
"totalRefund": 0,
"totalTaxAmount": 0,
"totalDiscount": 0,
"totalGratuity": 0,
"orderLineItems": [
{
"id": "Sale of some product",
"quantity": 1,
"taxPercentage": 0,
"totalAmount": 15,
"totalTaxAmount": 0,
"unitPrice": 15,
"taxes": [],
"discountAllocations": []
}
],
"payments": [
{
"id": "46d36a64-ea48-4e37-9340-3548cbf3ca2f"
}
],
"serviceCharges": [],
"modifiedDate": "2022-09-14T10:58:04Z"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 6,
"_links": {
"current": {
"href": "/companies/e170dbe2-be50-474f-b449-82add37108de/connections/1e631dd5-a30b-4bad-ad5c-315c9743535b/data/commerce-orders?page=1&pageSize=2"
},
"self": {
"href": "/companies/e170dbe2-be50-474f-b449-82add37108de/connections/1e631dd5-a30b-4bad-ad5c-315c9743535b/data/commerce-orders"
},
"next": {
"href": "/companies/e170dbe2-be50-474f-b449-82add37108de/connections/1e631dd5-a30b-4bad-ad5c-315c9743535b/data/commerce-orders?page=2&pageSize=2"
}
}
}
},
"WooCommerce": {
"value": {
"results": [
{
"id": "111",
"orderNumber": "111",
"country": "GB ",
"currency": "GBP",
"createdDate": "2021-03-27T23:29:38Z",
"totalAmount": 39.5,
"totalRefund": 0,
"totalTaxAmount": 6,
"totalDiscount": 0,
"totalGratuity": 0,
"orderLineItems": [
{
"id": "53",
"quantity": 2,
"taxPercentage": 20,
"totalAmount": 12,
"totalTaxAmount": 2,
"unitPrice": 5,
"taxes": [],
"productRef": {
"id": "82"
},
"discountAllocations": []
},
{
"id": "54",
"quantity": 2,
"taxPercentage": 20,
"totalAmount": 24,
"totalTaxAmount": 4,
"unitPrice": 10,
"taxes": [],
"productRef": {
"id": "81"
},
"discountAllocations": []
}
],
"payments": [],
"serviceCharges": [
{
"description": "Royal Mail",
"totalAmount": 3.5,
"taxPercentage": 0,
"taxAmount": 0,
"taxes": [],
"quantity": 1,
"type": "Shipping"
}
],
"customerRef": {
"id": "200585744"
},
"modifiedDate": "2022-07-11T15:35:48Z",
"sourceModifiedDate": "2021-04-01T13:34:59Z"
},
{
"id": "145",
"orderNumber": "145",
"country": "GB ",
"currency": "GBP",
"createdDate": "2021-09-24T12:15:29Z",
"totalAmount": 27.5,
"totalRefund": 0,
"totalTaxAmount": 5.5,
"totalDiscount": 0,
"totalGratuity": 0,
"orderLineItems": [
{
"id": "59",
"quantity": 2,
"taxPercentage": 25,
"totalAmount": 27.5,
"totalTaxAmount": 5.5,
"unitPrice": 11,
"taxes": [],
"productRef": {
"id": "87"
},
"discountAllocations": []
}
],
"payments": [],
"serviceCharges": [],
"modifiedDate": "2022-07-11T15:35:48Z",
"sourceModifiedDate": "2022-03-24T16:01:23Z"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 25,
"_links": {
"current": {
"href": "/companies/00396b78-7113-4b1f-996f-4c561b00573a/connections/b39ed7d6-5eda-44c5-85bb-647d03edd649/data/commerce-orders?page=1&pageSize=2"
},
"self": {
"href": "/companies/00396b78-7113-4b1f-996f-4c561b00573a/connections/b39ed7d6-5eda-44c5-85bb-647d03edd649/data/commerce-orders"
},
"next": {
"href": "/companies/00396b78-7113-4b1f-996f-4c561b00573a/connections/b39ed7d6-5eda-44c5-85bb-647d03edd649/data/commerce-orders?page=2&pageSize=2"
}
}
}
},
"Zettle": {
"value": {
"results": [
{
"id": "7TunRi2XEeueVK3fSQEQIw",
"orderNumber": "3",
"country": "GB ",
"currency": "GBP",
"createdDate": "2020-11-23T14:27:20Z",
"totalAmount": 45,
"totalRefund": 0,
"totalTaxAmount": 0,
"totalDiscount": 0,
"totalGratuity": 0,
"orderLineItems": [
{
"id": "0",
"quantity": 1,
"taxPercentage": 0,
"totalAmount": 45,
"totalTaxAmount": 0,
"unitPrice": 45,
"taxes": [],
"productRef": {
"id": "7f9f31e4-2d97-11eb-9f55-acde48001122"
},
"productVariantRef": {
"id": "7f9f35ea-2d97-11eb-9f55-acde48001122"
},
"discountAllocations": []
}
],
"payments": [
{
"id": "ed97bcde-2d97-11eb-a42e-25130f2dd258",
"amount": 45,
"currency": "GBP",
"type": "Paypal",
"status": "Unknown",
"dueDate": "0001-01-01T00:00:00",
"createdDate": "2020-11-23T14:27:19",
"modifiedDate": "2021-10-27T15:22:37"
}
],
"serviceCharges": [],
"modifiedDate": "2021-10-27T15:22:37Z",
"sourceModifiedDate": "2020-11-23T14:27:20Z"
},
{
"id": "CV5TJC2YEeueVK3fSQEQIw",
"orderNumber": "4",
"country": "GB ",
"currency": "GBP",
"createdDate": "2020-11-23T14:28:05Z",
"totalAmount": 25,
"totalRefund": 0,
"totalTaxAmount": 1.19,
"totalDiscount": 0,
"totalGratuity": 0,
"orderLineItems": [
{
"id": "0",
"quantity": 1,
"taxPercentage": 5,
"totalAmount": 25,
"totalTaxAmount": 1.19,
"unitPrice": 23.81,
"taxes": [],
"productRef": {
"id": "89570bee-2d97-11eb-9f55-acde48001122"
},
"productVariantRef": {
"id": "89570c52-2d97-11eb-9f55-acde48001122"
},
"discountAllocations": []
}
],
"payments": [
{
"id": "09b94cfc-2d98-11eb-8021-0e1b9dcbeca1",
"amount": 25,
"currency": "GBP",
"type": "Paypal",
"status": "Unknown",
"dueDate": "0001-01-01T00:00:00",
"createdDate": "2020-11-23T14:28:04",
"modifiedDate": "2021-10-27T15:22:37"
}
],
"serviceCharges": [],
"modifiedDate": "2021-10-27T15:22:37Z",
"sourceModifiedDate": "2020-11-23T14:28:05Z"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 6,
"_links": {
"current": {
"href": "/companies/9d448ad0-4508-47fc-bd3b-6950493151f1/connections/c7baa8da-3302-464b-8aa1-edcd4c900902/data/commerce-orders?page=1&pageSize=2"
},
"self": {
"href": "/companies/9d448ad0-4508-47fc-bd3b-6950493151f1/connections/c7baa8da-3302-464b-8aa1-edcd4c900902/data/commerce-orders"
},
"next": {
"href": "/companies/9d448ad0-4508-47fc-bd3b-6950493151f1/connections/c7baa8da-3302-464b-8aa1-edcd4c900902/data/commerce-orders?page=2&pageSize=2"
}
}
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/Malformed-Query"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/Payment-Required"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/Not-Found"
},
"409": {
"$ref": "#/components/responses/Conflict"
},
"429": {
"$ref": "#/components/responses/Too-Many-Requests"
},
"500": {
"$ref": "#/components/responses/Internal-Server-Error"
},
"503": {
"$ref": "#/components/responses/Service-Unavailable"
}
},
"description": "The *List orders* endpoint returns a list of [orders](https://docs.codat.io/commerce-api#/schemas/Order) for a given company's connection.\n\n[Orders](https://docs.codat.io/commerce-api#/schemas/Order) contain the transaction details for all products sold by the company.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n ",
"parameters": [
{
"$ref": "#/components/parameters/page"
},
{
"$ref": "#/components/parameters/pageSize"
},
{
"$ref": "#/components/parameters/query"
},
{
"$ref": "#/components/parameters/orderBy"
}
]
}
},
"/companies/{companyId}/connections/{connectionId}/data/commerce-orders/{orderId}": {
"parameters": [
{
"$ref": "#/components/parameters/companyId"
},
{
"$ref": "#/components/parameters/connectionId"
},
{
"name": "orderId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"examples": {
"$ref": "#/components/schemas/Order/allOf/0/properties/id/examples"
}
},
"description": "Unique identifier for an order."
}
],
"get": {
"summary": "Get order",
"tags": [
"Orders"
],
"operationId": "get-order",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"x-speakeasy-usage-example": true,
"schema": {
"$ref": "#/components/schemas/Order"
},
"examples": {
"Amazon Seller Central": {
"value": {
"id": "902-1845936-5435065",
"orderNumber": "902-1845936-5435065",
"country": "US ",
"currency": "USD",
"createdDate": "1970-01-19T03:58:30Z",
"totalAmount": 10,
"totalRefund": 0,
"totalTaxAmount": 1.01,
"totalDiscount": 0,
"totalGratuity": 0,
"orderLineItems": [
{
"id": "O05015851154158",
"quantity": 1,
"taxPercentage": 11.23,
"totalAmount": 10,
"totalTaxAmount": 1.01,
"unitPrice": 8.99,
"taxes": [],
"productVariantRef": {
"id": "NABetaASINB00551Q3CS"
},
"discountAllocations": []
}
],
"payments": [],
"serviceCharges": [],
"modifiedDate": "2023-01-09T09:12:12Z",
"sourceModifiedDate": "1970-01-19T03:58:32Z"
}
},
"BigCommerce": {
"value": {
"id": "100",
"orderNumber": "100",
"country": "GBR",
"currency": "GBP",
"createdDate": "2022-06-15T15:48:18Z",
"totalAmount": 675,
"totalRefund": 0,
"totalTaxAmount": 112.5,
"totalDiscount": 10,
"totalGratuity": 0,
"orderLineItems": [
{
"id": "1",
"quantity": 1,
"taxPercentage": 20,
"totalAmount": 221.64,
"totalTaxAmount": 36.94,
"unitPrice": 187.5,
"taxes": [],
"productRef": {
"id": "86",
"name": "[Sample] Able Brewing System"
},
"productVariantRef": {
"id": "66",
"name": "[Sample] Able Brewing System"
},
"discountAllocations": [
{
"name": "Manual Discount",
"totalAmount": 3.36
}
]
},
{
"id": "2",
"quantity": 5,
"taxPercentage": 19.9999,
"totalAmount": 438.36,
"totalTaxAmount": 73.06,
"unitPrice": 74.1667,
"taxes": [],
"productRef": {
"id": "81",
"name": "[Sample] Orbit Terrarium - Small"
},
"productVariantRef": {
"id": "65",
"name": "[Sample] Orbit Terrarium - Small"
},
"discountAllocations": [
{
"name": "Manual Discount",
"totalAmount": 6.64
}
]
}
],
"payments": [],
"serviceCharges": [
{
"description": "Shipping Charge",
"totalAmount": 15,
"taxPercentage": 20,
"taxAmount": 2.5,
"taxes": [],
"quantity": 1,
"type": "Shipping"
}
],
"customerRef": {
"id": "0"
},
"modifiedDate": "2023-04-11T10:33:56Z",
"sourceModifiedDate": "2022-06-15T15:48:18Z"
}
},
"Clover": {
"value": {
"id": "0BCZPWGFC3M16",
"orderNumber": "0BCZPWGFC3M16",
"country": "GB ",
"currency": "GBP",
"createdDate": "2021-05-24T10:33:41Z",
"totalAmount": 1200,
"totalRefund": 0,
"totalTaxAmount": 200,
"totalDiscount": 0,
"totalGratuity": 0,
"orderLineItems": [
{
"id": "985WY5J4H12XY",
"quantity": 1,
"taxPercentage": 20,
"totalAmount": 1200,
"totalTaxAmount": 200,
"unitPrice": 1000,
"taxes": [
{
"taxComponentRef": {
"id": "KAWQTPZP3R9VT",
"name": "VAT 20%"
},
"taxAmount": 200
}
],
"productRef": {
"id": "NMZHKK6FKF6ZJ",
"name": "Laptop"
},
"discountAllocations": []
}
],
"payments": [
{
"id": "S2D924NX13T2G"
}
],
"serviceCharges": [],
"locationRef": {
"id": "GA3WP1ZC3ZFK1",
"name": "Codat"
},
"modifiedDate": "2022-09-08T15:47:43Z",
"sourceModifiedDate": "2021-05-24T10:33:45Z"
}
},
"Lightspeed K Trial": {
"value": {
"id": "A61465.1",
"orderNumber": "A61465.1",
"country": "AU ",
"currency": "AUD",
"createdDate": "2022-12-09T02:27:14Z",
"closedDate": "2022-12-09T02:27:46Z",
"totalAmount": 5,
"totalRefund": 0,
"totalTaxAmount": 0.45,
"totalDiscount": 0,
"totalGratuity": 0,
"orderLineItems": [
{
"id": "S61465.1",
"quantity": 1,
"taxPercentage": 10,
"totalAmount": 5,
"totalTaxAmount": 0.45,
"unitPrice": 4.5455,
"taxes": [
{
"taxComponentRef": {
"id": "GST10",
"name": "10% GST"
},
"taxAmount": 0.45
}
],
"productRef": {
"id": "647208621834617",
"name": "Hot Chocolate"
},
"discountAllocations": []
}
],
"payments": [
{
"id": "R61465.1_1_A61465.1_2022-12-09T02:27:46.273Z",
"amount": 5,
"currency": "AUD",
"type": "Unknown",
"status": "Paid",
"dueDate": "0001-01-01T00:00:00",
"createdDate": "2022-12-09T02:27:46",
"modifiedDate": "2023-03-02T09:50:43"
}
],
"serviceCharges": [],
"locationRef": {
"id": "647208621834538",
"name": "QA Shared - New Test Site"
},
"modifiedDate": "2023-03-08T13:49:34Z"
}
},
"Mollie": {
"value": {
"id": "ord_2at3ck",
"orderNumber": "1337",
"country": "NLD",
"currency": "EUR",
"createdDate": "2022-01-20T09:28:32",
"totalAmount": 1027.99,
"totalRefund": 0,
"totalTaxAmount": 178.41,
"totalDiscount": 100,
"totalGratuity": 0,
"orderLineItems": [
{
"id": "odl_1.3tvc32",
"quantity": 1,
"taxPercentage": 21,
"totalAmount": 329.99,
"totalTaxAmount": 57.27,
"unitPrice": 329.99,
"taxes": [],
"discountAllocations": []
},
{
"id": "odl_1.x95vuk",
"quantity": 2,
"taxPercentage": 21,
"totalAmount": 698,
"totalTaxAmount": 121.14,
"unitPrice": 399,
"taxes": [],
"discountAllocations": [
{
"name": "Discount",
"totalAmount": 100
}
]
}
],
"payments": [
{
"id": "tr_GpHuaqHrca",
"amount": 1027.99,
"currency": "EUR",
"type": "OnlineCard",
"status": "Failed",
"dueDate": "0001-01-01T00:00:00",
"createdDate": "2022-02-08T15:44:22",
"modifiedDate": "2022-03-17T15:47:28",
"sourceModifiedDate": "2022-02-08T16:02:02"
},
{
"id": "tr_w7RGQc3k3V",
"amount": 1027.99,
"currency": "EUR",
"type": "OnlineCard",
"status": "Failed",
"dueDate": "0001-01-01T00:00:00",
"createdDate": "2022-01-20T09:28:32",
"modifiedDate": "2022-03-17T15:47:28",
"sourceModifiedDate": "2022-01-20T09:46:02"
}
],
"serviceCharges": [],
"modifiedDate": "2022-03-17T15:47:28Z"
}
},
"Mollie Test": {
"value": {
"id": "ord_2at3ck",
"orderNumber": "1337",
"country": "NLD",
"currency": "EUR",
"createdDate": "2022-01-20T09:28:32",
"totalAmount": 1027.99,
"totalRefund": 0,
"totalTaxAmount": 178.41,
"totalDiscount": 100,
"totalGratuity": 0,
"orderLineItems": [
{
"id": "odl_1.x95vuk",
"quantity": 2,
"taxPercentage": 21,
"totalAmount": 698,
"totalTaxAmount": 121.14,
"unitPrice": 338.43,
"taxes": [],
"discountAllocations": [
{
"name": "Discount",
"totalAmount": 100
}
]
},
{
"id": "odl_1.3tvc32",
"quantity": 1,
"taxPercentage": 21,
"totalAmount": 329.99,
"totalTaxAmount": 57.27,
"unitPrice": 272.72,
"taxes": [],
"discountAllocations": []
}
],
"payments": [
{
"id": "tr_GpHuaqHrca"
},
{
"id": "tr_w7RGQc3k3V"
}
],
"serviceCharges": [],
"modifiedDate": "2022-08-17T11:33:19Z"
}
},
"Partner Commerce": {
"value": {
"id": "6d135134-2f77-45f7-af3d-ee873e42da45",
"orderNumber": "93128704",
"country": "GM ",
"currency": "CAD",
"createdDate": "2021-02-10T01:37:23",
"totalAmount": 203.82,
"totalRefund": 0,
"totalTaxAmount": 40.77,
"totalDiscount": 25.63,
"totalGratuity": 80.81,
"orderLineItems": [
{
"id": "89f5e83a-c87d-4b60-a009-0ea9065867aa",
"quantity": 3,
"taxPercentage": 20,
"totalAmount": 85.44,
"totalTaxAmount": 17.09,
"unitPrice": 28.48,
"taxes": [],
"productRef": {
"id": "98ef828e-33e1-4c23-9383-a029f1d6a3a6"
},
"productVariantRef": {
"id": "dffcd99e-13bb-4b89-89ef-719b3b0777e6"
},
"discountAllocations": [
{
"name": "Discount",
"totalAmount": 8.54
},
{
"name": "Discount",
"totalAmount": 17.09
}
]
},
{
"id": "4c65f0d9-05c8-48eb-9c4a-1774f5073e66",
"quantity": 3,
"taxPercentage": 20,
"totalAmount": 118.38,
"totalTaxAmount": 23.68,
"unitPrice": 39.46,
"taxes": [],
"productRef": {
"id": "561f8efb-3429-4c1f-a014-1fa595f9b3c6"
},
"productVariantRef": {
"id": "e0715a7a-0179-4a2e-b40d-800fd2f36764"
},
"discountAllocations": []
}
],
"payments": [
{
"id": "3ec3d4c4-8003-4f77-a44e-08b3e17057bf"
}
],
"serviceCharges": [],
"locationRef": {
"id": "d84a8ce0-d7e4-400a-b07a-d4bddd9c1873"
},
"customerRef": {
"id": "0dc0206d-f22f-48c9-a4e5-79f8383c3426"
},
"modifiedDate": "2022-05-12T07:22:02Z",
"sourceModifiedDate": "2021-02-10T01:37:23"
}
},
"PrestaShop": {
"value": {
"id": "1",
"orderNumber": "XKBKNABJK",
"country": "US ",
"currency": "USD",
"createdDate": "2021-09-02T06:00:54",
"totalAmount": 61.8,
"totalRefund": 0,
"totalTaxAmount": 0,
"totalDiscount": 0,
"totalGratuity": 0,
"orderLineItems": [
{
"id": "1",
"quantity": 1,
"taxPercentage": 0,
"totalAmount": 23.9,
"totalTaxAmount": 0,
"unitPrice": 23.9,
"taxes": [],
"productRef": {
"id": "1",
"name": "Hummingbird printed t-shirt"
},
"discountAllocations": []
},
{
"id": "2",
"quantity": 1,
"taxPercentage": 0,
"totalAmount": 35.9,
"totalTaxAmount": 0,
"unitPrice": 35.9,
"taxes": [],
"productRef": {
"id": "2",
"name": "Hummingbird printed sweater"
},
"discountAllocations": []
}
],
"payments": [],
"serviceCharges": [
{
"description": "Shipping",
"totalAmount": 2,
"taxPercentage": 0,
"taxAmount": 0,
"taxes": [],
"quantity": 1,
"type": "Shipping"
}
],
"customerRef": {
"id": "1",
"name": "John DOE"
},
"modifiedDate": "2022-01-26T15:09:42Z",
"sourceModifiedDate": "2021-09-02T06:00:54"
}
},
"Shopify": {
"value": {
"id": "3684119445662",
"orderNumber": "1007",
"country": "XXX",
"currency": "GBP",
"createdDate": "2021-03-19T13:18:33",
"totalAmount": 600,
"totalRefund": 0,
"totalTaxAmount": 0,
"totalDiscount": 0,
"totalGratuity": 0,
"orderLineItems": [
{
"id": "9670458146974",
"quantity": 4,
"taxPercentage": 0,
"totalAmount": 600,
"totalTaxAmount": 0,
"unitPrice": 150,
"taxes": [],
"productRef": {
"id": "6595494117534",
"name": "Monitor"
},
"productVariantRef": {
"id": "39444526694558",
"name": "Monitor"
},
"discountAllocations": []
}
],
"payments": [
{
"id": "4630233579678",
"amount": 600,
"currency": "GBP",
"type": "OnlineCard",
"status": "Failed",
"paymentProvider": "Shopify Payments",
"dueDate": "0001-01-01T00:00:00",
"createdDate": "2021-03-19T13:17:49",
"modifiedDate": "2023-02-10T15:18:24",
"sourceModifiedDate": "2021-03-19T13:17:49"
},
{
"id": "4630234497182",
"amount": 600,
"currency": "GBP",
"type": "OnlineCard",
"status": "Paid",
"paymentProvider": "Shopify Payments",
"dueDate": "0001-01-01T00:00:00",
"createdDate": "2021-03-19T13:18:29",
"modifiedDate": "2023-02-10T15:18:24",
"sourceModifiedDate": "2021-03-19T13:18:29"
}
],
"serviceCharges": [],
"customerRef": {
"id": "5097398534302",
"name": "Qa Test"
},
"modifiedDate": "2023-02-10T15:18:24Z",
"sourceModifiedDate": "2022-08-01T13:12:35"
}
},
"Square": {
"value": {
"id": "BDYNvtIYyWClkTjnh99CFR3fPwKZY",
"orderNumber": "BDYNvtIYyWClkTjnh99CFR3fPwKZY",
"country": "GB ",
"currency": "GBP",
"createdDate": "2021-02-14T19:38:28Z",
"closedDate": "0001-01-01T00:00:00",
"totalAmount": 50,
"totalRefund": 0,
"totalTaxAmount": 0,
"totalDiscount": 0,
"totalGratuity": 0,
"orderLineItems": [
{
"id": "lLJpgArKQbBEn9nTvLRHP",
"quantity": 1,
"taxPercentage": 0,
"totalAmount": 50,
"totalTaxAmount": 0,
"unitPrice": 50,
"taxes": [],
"discountAllocations": []
}
],
"payments": [],
"serviceCharges": [],
"locationRef": {
"id": "D8DVHD1G6NT2J",
"name": "Codat Limited"
},
"modifiedDate": "2022-08-02T10:27:33Z",
"sourceModifiedDate": "2021-02-14T19:38:28Z"
}
},
"SumUp": {
"value": {
"id": "07efcdd0-7f61-4d82-957f-52e8f0bd3f89",
"orderNumber": "TECXTU2KT6",
"country": "XXX",
"currency": "GBP",
"createdDate": "2021-03-30T12:20:40Z",
"totalAmount": 200,
"totalRefund": 0,
"totalTaxAmount": 0,
"totalDiscount": 0,
"totalGratuity": 0,
"orderLineItems": [
{
"id": "Product undefined by SumUp",
"quantity": 1,
"taxPercentage": 0,
"totalAmount": 200,
"totalTaxAmount": 0,
"unitPrice": 200,
"taxes": [],
"discountAllocations": []
}
],
"payments": [
{
"id": "07efcdd0-7f61-4d82-957f-52e8f0bd3f89"
}
],
"serviceCharges": [],
"modifiedDate": "2022-09-14T10:58:04Z"
}
},
"WooCommerce": {
"value": {
"id": "111",
"orderNumber": "111",
"country": "GB ",
"currency": "GBP",
"createdDate": "2021-03-27T23:29:38Z",
"totalAmount": 39.5,
"totalRefund": 0,
"totalTaxAmount": 6,
"totalDiscount": 0,
"totalGratuity": 0,
"orderLineItems": [
{
"id": "53",
"quantity": 2,
"taxPercentage": 20,
"totalAmount": 12,
"totalTaxAmount": 2,
"unitPrice": 5,
"taxes": [],
"productRef": {
"id": "82"
},
"discountAllocations": []
},
{
"id": "54",
"quantity": 2,
"taxPercentage": 20,
"totalAmount": 24,
"totalTaxAmount": 4,
"unitPrice": 10,
"taxes": [],
"productRef": {
"id": "81"
},
"discountAllocations": []
}
],
"payments": [],
"serviceCharges": [
{
"description": "Royal Mail",
"totalAmount": 3.5,
"taxPercentage": 0,
"taxAmount": 0,
"taxes": [],
"quantity": 1,
"type": "Shipping"
}
],
"customerRef": {
"id": "200585744"
},
"modifiedDate": "2022-07-11T15:35:48Z",
"sourceModifiedDate": "2021-04-01T13:34:59Z"
}
},
"Zettle": {
"value": {
"id": "7TunRi2XEeueVK3fSQEQIw",
"orderNumber": "3",
"country": "GB ",
"currency": "GBP",
"createdDate": "2020-11-23T14:27:20Z",
"totalAmount": 45,
"totalRefund": 0,
"totalTaxAmount": 0,
"totalDiscount": 0,
"totalGratuity": 0,
"orderLineItems": [
{
"id": "0",
"quantity": 1,
"taxPercentage": 0,
"totalAmount": 45,
"totalTaxAmount": 0,
"unitPrice": 45,
"taxes": [],
"productRef": {
"id": "7f9f31e4-2d97-11eb-9f55-acde48001122"
},
"productVariantRef": {
"id": "7f9f35ea-2d97-11eb-9f55-acde48001122"
},
"discountAllocations": []
}
],
"payments": [
{
"id": "ed97bcde-2d97-11eb-a42e-25130f2dd258",
"amount": 45,
"currency": "GBP",
"type": "Paypal",
"status": "Unknown",
"dueDate": "0001-01-01T00:00:00",
"createdDate": "2020-11-23T14:27:19",
"modifiedDate": "2021-10-27T15:22:37"
}
],
"serviceCharges": [],
"modifiedDate": "2021-10-27T15:22:37Z",
"sourceModifiedDate": "2020-11-23T14:27:20Z"
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/Payment-Required"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/Not-Found"
},
"409": {
"$ref": "#/components/responses/Conflict"
},
"429": {
"$ref": "#/components/responses/Too-Many-Requests"
},
"500": {
"$ref": "#/components/responses/Internal-Server-Error"
},
"503": {
"$ref": "#/components/responses/Service-Unavailable"
}
},
"description": "The *Get order* endpoint returns a single order for a given orderId.\n\n[Orders](https://docs.codat.io/commerce-api#/schemas/Order) contain the transaction details for all products sold by the company.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-orders) for integrations that support getting a specific order.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n"
}
},
"/companies/{companyId}/connections/{connectionId}/data/commerce-payments": {
"parameters": [
{
"$ref": "#/components/parameters/companyId"
},
{
"$ref": "#/components/parameters/connectionId"
}
],
"get": {
"summary": "List payments",
"tags": [
"Payments"
],
"operationId": "list-payments",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Payments"
},
"examples": {
"BigCommerce": {
"value": {
"results": [
{
"id": "103_1_1_refund",
"amount": -64,
"currency": "GBP",
"type": "Unknown",
"status": "Paid",
"paymentProvider": "bigpaypay",
"dueDate": "0001-01-01T00:00:00",
"createdDate": "2022-06-15T17:13:13Z",
"modifiedDate": "2023-04-11T10:33:52Z"
},
{
"id": "105_2_2_refund",
"amount": -33.95,
"currency": "GBP",
"type": "Unknown",
"status": "Paid",
"paymentProvider": "bigpaypay",
"dueDate": "0001-01-01T00:00:00",
"createdDate": "2022-06-24T13:57:01Z",
"modifiedDate": "2023-04-11T10:33:52Z"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 20,
"_links": {
"current": {
"href": "/companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-payments?page=1&pageSize=2"
},
"self": {
"href": "/companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-payments"
},
"next": {
"href": "/companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-payments?page=2&pageSize=2"
}
}
}
},
"Clover": {
"value": {
"results": [
{
"id": "01J7HV88GT6B8",
"amount": 1000,
"currency": "USD",
"paymentMethodRef": {
"id": "BR5M17TG091SP",
"name": "Credit Card"
},
"type": "Card",
"status": "Paid",
"paymentProvider": "clover",
"dueDate": "0001-01-01T00:00:00",
"createdDate": "2021-05-24T10:35:08Z",
"modifiedDate": "2023-01-09T11:01:02Z",
"sourceModifiedDate": "2021-05-24T10:35:08Z"
},
{
"id": "0A8ZMPG40Q9AM",
"amount": 1000,
"currency": "USD",
"paymentMethodRef": {
"id": "BR5M17TG091SP",
"name": "Credit Card"
},
"type": "Card",
"status": "Paid",
"paymentProvider": "clover",
"dueDate": "0001-01-01T00:00:00",
"createdDate": "2021-05-24T10:35:31Z",
"modifiedDate": "2023-01-09T11:01:02Z",
"sourceModifiedDate": "2021-05-24T10:35:31Z"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 77,
"_links": {
"current": {
"href": "/companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-payments?page=1&pageSize=2"
},
"self": {
"href": "/companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-payments"
},
"next": {
"href": "/companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-payments?page=2&pageSize=2"
}
}
}
},
"Lightspeed K Trial": {
"value": {
"results": [
{
"id": "1_A62084.1_2023-01-05T03:34:50.296Z",
"amount": 0,
"currency": "AUD",
"paymentMethodRef": {
"id": "0"
},
"type": "Unknown",
"status": "Paid",
"dueDate": "0001-01-01T00:00:00",
"createdDate": "2023-01-05T03:34:50Z",
"modifiedDate": "2023-03-02T09:50:43Z"
},
{
"id": "R61465.1_1_A61465.1_2022-12-09T02:27:46.273Z",
"amount": 5,
"currency": "AUD",
"paymentMethodRef": {
"id": "647208621834714",
"name": "LSPay - Mary"
},
"type": "Unknown",
"status": "Paid",
"dueDate": "0001-01-01T00:00:00",
"createdDate": "2022-12-09T02:27:46Z",
"modifiedDate": "2023-03-02T09:50:43Z"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 26,
"_links": {
"current": {
"href": "/companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-payments?page=1&pageSize=2"
},
"self": {
"href": "/companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-payments"
},
"next": {
"href": "/companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-payments?page=2&pageSize=2"
}
}
}
},
"Mollie": {
"value": {
"results": [
{
"id": "re_Azhe8TzfUK",
"amount": -20,
"currency": "EUR",
"type": "OnlineCard",
"status": "Paid",
"paymentProvider": "mollie",
"dueDate": "0001-01-01T00:00:00",
"createdDate": "2022-01-17T16:00:46",
"modifiedDate": "2022-03-17T16:15:23Z"
},
{
"id": "re_NPKEJhQveu",
"amount": -60,
"currency": "EUR",
"type": "OnlineCard",
"status": "Paid",
"paymentProvider": "mollie",
"dueDate": "0001-01-01T00:00:00",
"createdDate": "2022-01-17T16:00:05",
"modifiedDate": "2022-03-17T16:15:23Z"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 16,
"_links": {
"current": {
"href": "/companies/65fe5864-16d7-41f4-8823-87ae1cf3a283/connections/1dbbf0ab-a27a-45b0-982a-ae0d8985affc/data/commerce-payments?page=1&pageSize=2"
},
"self": {
"href": "/companies/65fe5864-16d7-41f4-8823-87ae1cf3a283/connections/1dbbf0ab-a27a-45b0-982a-ae0d8985affc/data/commerce-payments"
},
"next": {
"href": "/companies/65fe5864-16d7-41f4-8823-87ae1cf3a283/connections/1dbbf0ab-a27a-45b0-982a-ae0d8985affc/data/commerce-payments?page=2&pageSize=2"
}
}
}
},
"PrestaShop": {
"value": {
"results": [
{
"id": "1",
"amount": 20.9,
"currency": "USD",
"type": "Unknown",
"status": "Paid",
"dueDate": "0001-01-01T00:00:00",
"createdDate": "2021-09-08T01:52:55",
"modifiedDate": "2022-01-26T15:09:42Z"
},
{
"id": "2",
"amount": 20.9,
"currency": "USD",
"type": "Unknown",
"status": "Paid",
"dueDate": "0001-01-01T00:00:00",
"createdDate": "2021-09-08T01:53:28",
"modifiedDate": "2022-01-26T15:09:42Z"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 5,
"_links": {
"current": {
"href": "/companies/2bf78e61-58ca-421a-a430-5dfa59cf15b0/connections/30774c1f-fdcd-491e-9e60-47e316b3ab9b/data/commerce-payments?page=1&pageSize=2"
},
"self": {
"href": "/companies/2bf78e61-58ca-421a-a430-5dfa59cf15b0/connections/30774c1f-fdcd-491e-9e60-47e316b3ab9b/data/commerce-payments"
},
"next": {
"href": "/companies/2bf78e61-58ca-421a-a430-5dfa59cf15b0/connections/30774c1f-fdcd-491e-9e60-47e316b3ab9b/data/commerce-payments?page=2&pageSize=2"
}
}
}
},
"Shopify": {
"value": {
"results": [
{
"id": "4630233579678",
"amount": 600,
"currency": "GBP",
"type": "OnlineCard",
"status": "Failed",
"paymentProvider": "Shopify Payments",
"dueDate": "0001-01-01T00:00:00",
"createdDate": "2021-03-19T13:17:49Z",
"modifiedDate": "2023-02-10T15:18:24Z",
"sourceModifiedDate": "2021-03-19T13:17:49Z"
},
{
"id": "4630234497182",
"amount": 600,
"currency": "GBP",
"type": "OnlineCard",
"status": "Paid",
"paymentProvider": "Shopify Payments",
"dueDate": "0001-01-01T00:00:00",
"createdDate": "2021-03-19T13:18:29Z",
"modifiedDate": "2023-02-10T15:18:24Z",
"sourceModifiedDate": "2021-03-19T13:18:29Z"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 46,
"_links": {
"current": {
"href": "/companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-payments?page=1&pageSize=2"
},
"self": {
"href": "/companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-payments"
},
"next": {
"href": "/companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-payments?page=2&pageSize=2"
}
}
}
},
"SumUp": {
"value": {
"results": [
{
"id": "07efcdd0-7f61-4d82-957f-52e8f0bd3f89",
"amount": 200,
"currency": "GBP",
"type": "OnlineCard",
"status": "Cancelled",
"paymentProvider": "sumup",
"dueDate": "0001-01-01T00:00:00",
"createdDate": "2021-03-30T12:20:40Z",
"modifiedDate": "2022-03-17T16:13:46Z"
},
{
"id": "46d36a64-ea48-4e37-9340-3548cbf3ca2f",
"amount": 15,
"currency": "GBP",
"type": "Cash",
"status": "Paid",
"paymentProvider": "sumup",
"dueDate": "0001-01-01T00:00:00",
"createdDate": "2021-03-26T21:09:59Z",
"modifiedDate": "2022-03-17T16:13:46Z"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 6,
"_links": {
"current": {
"href": "/companies/d9e78460-7ee5-4a34-a3f4-9652a5946b1f/connections/60959ebe-8491-4368-bf0a-f715c3ce2e53/data/commerce-payments?page=1&pageSize=2"
},
"self": {
"href": "/companies/d9e78460-7ee5-4a34-a3f4-9652a5946b1f/connections/60959ebe-8491-4368-bf0a-f715c3ce2e53/data/commerce-payments"
},
"next": {
"href": "/companies/d9e78460-7ee5-4a34-a3f4-9652a5946b1f/connections/60959ebe-8491-4368-bf0a-f715c3ce2e53/data/commerce-payments?page=2&pageSize=2"
}
}
}
},
"WooCommerce": {
"value": {
"results": [
{
"id": "33",
"amount": 0,
"currency": "GBP",
"type": "Unknown",
"status": "Paid",
"dueDate": "0001-01-01T00:00:00",
"createdDate": "2021-03-11T09:07:00Z",
"modifiedDate": "2021-07-13T16:19:00Z"
},
{
"id": "35",
"amount": 30,
"currency": "GBP",
"type": "Unknown",
"status": "Paid",
"dueDate": "0001-01-01T00:00:00",
"createdDate": "2021-03-11T09:08:56Z",
"modifiedDate": "2021-07-13T16:19:00Z"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 5,
"_links": {
"current": {
"href": "/companies/010c6f53-8fc8-40ab-9ed5-41191cf9c6b5/connections/7545ca2e-5f58-4f98-8af2-3b2c38bb8074/data/commerce-payments?page=1&pageSize=2"
},
"self": {
"href": "/companies/010c6f53-8fc8-40ab-9ed5-41191cf9c6b5/connections/7545ca2e-5f58-4f98-8af2-3b2c38bb8074/data/commerce-payments"
},
"next": {
"href": "/companies/010c6f53-8fc8-40ab-9ed5-41191cf9c6b5/connections/7545ca2e-5f58-4f98-8af2-3b2c38bb8074/data/commerce-payments?page=2&pageSize=2"
}
}
}
},
"Zettle": {
"value": {
"results": [
{
"id": "09b94cfc-2d98-11eb-8021-0e1b9dcbeca1",
"amount": 25,
"currency": "GBP",
"type": "Paypal",
"status": "Unknown",
"dueDate": "0001-01-01T00:00:00",
"createdDate": "2020-11-23T14:28:04Z",
"modifiedDate": "2021-10-27T15:22:37Z"
},
{
"id": "226580d6-2d98-11eb-a35c-fed5e63de507",
"amount": 58.5,
"currency": "GBP",
"type": "Paypal",
"status": "Unknown",
"dueDate": "0001-01-01T00:00:00",
"createdDate": "2020-11-23T14:28:47Z",
"modifiedDate": "2021-10-27T15:22:37Z"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 8,
"_links": {
"current": {
"href": "/companies/9d448ad0-4508-47fc-bd3b-6950493151f1/connections/c7baa8da-3302-464b-8aa1-edcd4c900902/data/commerce-payments?page=1&pageSize=2"
},
"self": {
"href": "/companies/9d448ad0-4508-47fc-bd3b-6950493151f1/connections/c7baa8da-3302-464b-8aa1-edcd4c900902/data/commerce-payments"
},
"next": {
"href": "/companies/9d448ad0-4508-47fc-bd3b-6950493151f1/connections/c7baa8da-3302-464b-8aa1-edcd4c900902/data/commerce-payments?page=2&pageSize=2"
}
}
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/Malformed-Query"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/Payment-Required"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/Not-Found"
},
"409": {
"$ref": "#/components/responses/Conflict"
},
"429": {
"$ref": "#/components/responses/Too-Many-Requests"
},
"500": {
"$ref": "#/components/responses/Internal-Server-Error"
},
"503": {
"$ref": "#/components/responses/Service-Unavailable"
}
},
"description": "The *List payments* endpoint returns a list of [payments](https://docs.codat.io/commerce-api#/schemas/Payment) for a given company's connection.\n\n[Payments](https://docs.codat.io/commerce-api#/schemas/Payment) contain details of all payments made by customers to the company.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n ",
"parameters": [
{
"$ref": "#/components/parameters/page"
},
{
"$ref": "#/components/parameters/pageSize"
},
{
"$ref": "#/components/parameters/query"
},
{
"$ref": "#/components/parameters/orderBy"
}
]
}
},
"/companies/{companyId}/connections/{connectionId}/data/commerce-payments/{paymentId}": {
"parameters": [
{
"$ref": "#/components/parameters/companyId"
},
{
"$ref": "#/components/parameters/connectionId"
},
{
"name": "paymentId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"examples": {
"$ref": "#/components/schemas/Order/allOf/0/properties/id/examples"
}
},
"description": "Unique identifier for a payment."
}
],
"get": {
"summary": "Get payment",
"tags": [
"Payments"
],
"operationId": "get-payment",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Payment"
},
"examples": {
"BigCommerce": {
"value": {
"id": "103_1_1_refund",
"amount": -64,
"currency": "GBP",
"type": "Unknown",
"status": "Paid",
"paymentProvider": "bigpaypay",
"dueDate": "0001-01-01T00:00:00",
"createdDate": "2022-06-15T17:13:13Z",
"modifiedDate": "2023-04-11T10:33:52Z"
}
},
"Clover": {
"value": {
"id": "01J7HV88GT6B8",
"amount": 1000,
"currency": "USD",
"paymentMethodRef": {
"id": "BR5M17TG091SP",
"name": "Credit Card"
},
"type": "Card",
"status": "Paid",
"paymentProvider": "clover",
"dueDate": "0001-01-01T00:00:00",
"createdDate": "2021-05-24T10:35:08Z",
"modifiedDate": "2023-01-09T11:01:02Z",
"sourceModifiedDate": "2021-05-24T10:35:08Z"
}
},
"Lightspeed K Trial": {
"value": {
"id": "1_A62084.1_2023-01-05T03:34:50.296Z",
"amount": 0,
"currency": "AUD",
"paymentMethodRef": {
"id": "0"
},
"type": "Unknown",
"status": "Paid",
"dueDate": "0001-01-01T00:00:00",
"createdDate": "2023-01-05T03:34:50Z",
"modifiedDate": "2023-03-02T09:50:43Z"
}
},
"Mollie": {
"value": {
"id": "re_Azhe8TzfUK",
"amount": -20,
"currency": "EUR",
"type": "OnlineCard",
"status": "Paid",
"paymentProvider": "mollie",
"dueDate": "0001-01-01T00:00:00",
"createdDate": "2022-01-17T16:00:46",
"modifiedDate": "2022-03-17T16:15:23Z"
}
},
"PrestaShop": {
"value": {
"id": "1",
"amount": 20.9,
"currency": "USD",
"type": "Unknown",
"status": "Paid",
"dueDate": "0001-01-01T00:00:00",
"createdDate": "2021-09-08T01:52:55",
"modifiedDate": "2022-01-26T15:09:42Z"
}
},
"Shopify": {
"value": {
"id": "4630233579678",
"amount": 600,
"currency": "GBP",
"type": "OnlineCard",
"status": "Failed",
"paymentProvider": "Shopify Payments",
"dueDate": "0001-01-01T00:00:00",
"createdDate": "2021-03-19T13:17:49Z",
"modifiedDate": "2023-02-10T15:18:24Z",
"sourceModifiedDate": "2021-03-19T13:17:49Z"
}
},
"SumUp": {
"value": {
"id": "07efcdd0-7f61-4d82-957f-52e8f0bd3f89",
"amount": 200,
"currency": "GBP",
"type": "OnlineCard",
"status": "Cancelled",
"paymentProvider": "sumup",
"dueDate": "0001-01-01T00:00:00",
"createdDate": "2021-03-30T12:20:40Z",
"modifiedDate": "2022-03-17T16:13:46Z"
}
},
"WooCommerce": {
"value": {
"id": "33",
"amount": 0,
"currency": "GBP",
"type": "Unknown",
"status": "Paid",
"dueDate": "0001-01-01T00:00:00",
"createdDate": "2021-03-11T09:07:00Z",
"modifiedDate": "2021-07-13T16:19:00Z"
}
},
"Zettle": {
"value": {
"id": "09b94cfc-2d98-11eb-8021-0e1b9dcbeca1",
"amount": 25,
"currency": "GBP",
"type": "Paypal",
"status": "Unknown",
"dueDate": "0001-01-01T00:00:00",
"createdDate": "2020-11-23T14:28:04Z",
"modifiedDate": "2021-10-27T15:22:37Z"
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/Payment-Required"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/Not-Found"
},
"409": {
"$ref": "#/components/responses/Conflict"
},
"429": {
"$ref": "#/components/responses/Too-Many-Requests"
},
"500": {
"$ref": "#/components/responses/Internal-Server-Error"
},
"503": {
"$ref": "#/components/responses/Service-Unavailable"
}
},
"description": "The *Get payment* endpoint returns a single payment for a given paymentId.\n\n[Payments](https://docs.codat.io/commerce-api#/schemas/Payment) contain details of all payments made by customers to the company.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-payments) for integrations that support getting a specific payment.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n"
}
},
"/companies/{companyId}/connections/{connectionId}/data/commerce-paymentMethods": {
"parameters": [
{
"$ref": "#/components/parameters/companyId"
},
{
"$ref": "#/components/parameters/connectionId"
}
],
"get": {
"summary": "List payment methods",
"tags": [
"Payments"
],
"operationId": "list-payment-methods",
"x-speakeasy-name-override": "list-methods",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaymentMethods"
},
"examples": {
"Amazon Seller Central": {
"value": {
"results": [
{
"id": "COD",
"name": "Cash On Delivery",
"status": "Active",
"modifiedDate": "2023-01-09T09:12:03Z"
},
{
"id": "GC",
"name": "Gift Card",
"status": "Active",
"modifiedDate": "2023-01-09T09:12:03Z"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 3,
"_links": {
"current": {
"href": "/companies/6a59da96-e6d2-4c5c-ace7-65ba8be6a472/connections/58be1638-2c74-4ad4-8ff3-8c5b98b5f0fe/data/commerce-paymentMethods?page=1&pageSize=2"
},
"self": {
"href": "/companies/6a59da96-e6d2-4c5c-ace7-65ba8be6a472/connections/58be1638-2c74-4ad4-8ff3-8c5b98b5f0fe/data/commerce-paymentMethods"
},
"next": {
"href": "/companies/6a59da96-e6d2-4c5c-ace7-65ba8be6a472/connections/58be1638-2c74-4ad4-8ff3-8c5b98b5f0fe/data/commerce-paymentMethods?page=2&pageSize=2"
}
}
}
},
"BigCommerce": {
"value": {
"results": [
{
"id": "bigcommerce_gift_certificate",
"name": "Gift Certificate",
"status": "Active",
"modifiedDate": "2023-04-11T10:33:48Z"
},
{
"id": "bigcommerce_store_credit",
"name": "Store Credit",
"status": "Active",
"modifiedDate": "2023-04-11T10:33:48Z"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 2,
"_links": {
"current": {
"href": "/companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-paymentMethods?page=1&pageSize=2"
},
"self": {
"href": "/companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-paymentMethods"
}
}
}
},
"Clover": {
"value": {
"results": [
{
"id": "0DPQ6QP48YYHW",
"name": "TapMango Wallet",
"status": "Active",
"modifiedDate": "2023-01-09T11:01:04Z"
},
{
"id": "24H1ANYP1BNXG",
"name": "MyTab",
"status": "Active",
"modifiedDate": "2023-01-09T11:01:04Z"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 13,
"_links": {
"current": {
"href": "/companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-paymentMethods?page=1&pageSize=2"
},
"self": {
"href": "/companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-paymentMethods"
},
"next": {
"href": "/companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-paymentMethods?page=2&pageSize=2"
}
}
}
},
"Lightspeed K Trial": {
"value": {
"results": [
{
"id": "647208621834260",
"name": "Cash",
"status": "Active",
"modifiedDate": "2023-03-02T09:48:56Z"
},
{
"id": "647208621834261",
"name": "Credit Card",
"status": "Active",
"modifiedDate": "2023-03-02T09:48:56Z"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 11,
"_links": {
"current": {
"href": "/companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-paymentMethods?page=1&pageSize=2"
},
"self": {
"href": "/companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-paymentMethods"
},
"next": {
"href": "/companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-paymentMethods?page=2&pageSize=2"
}
}
}
},
"Mollie": {
"value": {
"results": [
{
"id": "applepay",
"name": "Apple Pay",
"status": "Unknown",
"modifiedDate": "2022-08-09T15:08:19Z"
},
{
"id": "bancontact",
"name": "Bancontact",
"status": "Unknown",
"modifiedDate": "2022-08-09T15:08:19Z"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 19,
"_links": {
"current": {
"href": "/companies/a2503b54-143c-4705-8bec-9ef84f51ca86/connections/4c8df852-f1b3-4642-939b-c33d6f34a312/data/commerce-paymentMethods?page=1&pageSize=2"
},
"self": {
"href": "/companies/a2503b54-143c-4705-8bec-9ef84f51ca86/connections/4c8df852-f1b3-4642-939b-c33d6f34a312/data/commerce-paymentMethods"
},
"next": {
"href": "/companies/a2503b54-143c-4705-8bec-9ef84f51ca86/connections/4c8df852-f1b3-4642-939b-c33d6f34a312/data/commerce-paymentMethods?page=2&pageSize=2"
}
}
}
},
"Mollie Test": {
"value": {
"results": [
{
"id": "applepay",
"name": "Apple Pay",
"status": "Unknown",
"modifiedDate": "2022-08-17T11:33:19Z"
},
{
"id": "bancontact",
"name": "Bancontact",
"status": "Unknown",
"modifiedDate": "2022-08-17T11:33:19Z"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 19,
"_links": {
"current": {
"href": "/companies/b978f9fe-8d63-4cfc-b2c2-b61b72e22785/connections/d564f8fd-0766-4ab8-a427-7c893f9b9ff6/data/commerce-paymentMethods?page=1&pageSize=2"
},
"self": {
"href": "/companies/b978f9fe-8d63-4cfc-b2c2-b61b72e22785/connections/d564f8fd-0766-4ab8-a427-7c893f9b9ff6/data/commerce-paymentMethods"
},
"next": {
"href": "/companies/b978f9fe-8d63-4cfc-b2c2-b61b72e22785/connections/d564f8fd-0766-4ab8-a427-7c893f9b9ff6/data/commerce-paymentMethods?page=2&pageSize=2"
}
}
}
},
"Square": {
"value": {
"results": [
{
"id": "BANK_ACCOUNT",
"name": "Bank Account",
"status": "Unknown",
"modifiedDate": "2022-08-02T10:27:32Z"
},
{
"id": "BUY_NOW_PAY_LATER",
"name": "Buy Now Pay Later",
"status": "Unknown",
"modifiedDate": "2022-08-02T10:27:32Z"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 20,
"_links": {
"current": {
"href": "/companies/d779fc82-a098-4107-a9fc-c2a1dda3d522/connections/9b098b74-3770-4dad-9001-4c283a39f1e5/data/commerce-paymentMethods?page=1&pageSize=2"
},
"self": {
"href": "/companies/d779fc82-a098-4107-a9fc-c2a1dda3d522/connections/9b098b74-3770-4dad-9001-4c283a39f1e5/data/commerce-paymentMethods"
},
"next": {
"href": "/companies/d779fc82-a098-4107-a9fc-c2a1dda3d522/connections/9b098b74-3770-4dad-9001-4c283a39f1e5/data/commerce-paymentMethods?page=2&pageSize=2"
}
}
}
},
"SumUp": {
"value": {
"results": [
{
"id": "CASH",
"name": "Cash",
"status": "Active",
"modifiedDate": "2022-09-14T10:58:03Z"
},
{
"id": "CC_CUSTOMER_ENTERED",
"name": "Credit Card",
"status": "Active",
"modifiedDate": "2022-09-14T10:58:03Z"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 8,
"_links": {
"current": {
"href": "/companies/e170dbe2-be50-474f-b449-82add37108de/connections/1e631dd5-a30b-4bad-ad5c-315c9743535b/data/commerce-paymentMethods?page=1&pageSize=2"
},
"self": {
"href": "/companies/e170dbe2-be50-474f-b449-82add37108de/connections/1e631dd5-a30b-4bad-ad5c-315c9743535b/data/commerce-paymentMethods"
},
"next": {
"href": "/companies/e170dbe2-be50-474f-b449-82add37108de/connections/1e631dd5-a30b-4bad-ad5c-315c9743535b/data/commerce-paymentMethods?page=2&pageSize=2"
}
}
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/Malformed-Query"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/Payment-Required"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/Not-Found"
},
"409": {
"$ref": "#/components/responses/Conflict"
},
"429": {
"$ref": "#/components/responses/Too-Many-Requests"
},
"500": {
"$ref": "#/components/responses/Internal-Server-Error"
},
"503": {
"$ref": "#/components/responses/Service-Unavailable"
}
},
"description": "The *List payment methods* endpoint returns a list of [payment methods](https://docs.codat.io/commerce-api#/schemas/PaymentMethod) for a given company's connection.\n\n[Payment methods](https://docs.codat.io/commerce-api#/schemas/PaymentMethod) represent the payment method(s) used to make payments.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n ",
"parameters": [
{
"$ref": "#/components/parameters/page"
},
{
"$ref": "#/components/parameters/pageSize"
},
{
"$ref": "#/components/parameters/query"
},
{
"$ref": "#/components/parameters/orderBy"
}
]
}
},
"/companies/{companyId}/connections/{connectionId}/data/commerce-paymentMethods/{paymentMethodId}": {
"parameters": [
{
"$ref": "#/components/parameters/companyId"
},
{
"$ref": "#/components/parameters/connectionId"
},
{
"name": "paymentMethodId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"examples": {
"$ref": "#/components/schemas/Order/allOf/0/properties/id/examples"
}
},
"description": "Unique identifier for a payment method."
}
],
"get": {
"summary": "Get payment method",
"tags": [
"Payments"
],
"operationId": "get-payment-method",
"x-speakeasy-name-override": "get-method",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaymentMethod"
},
"examples": {
"Amazon Seller Central": {
"value": {
"id": "COD",
"name": "Cash On Delivery",
"status": "Active",
"modifiedDate": "2023-01-09T09:12:03Z"
}
},
"BigCommerce": {
"value": {
"id": "bigcommerce_gift_certificate",
"name": "Gift Certificate",
"status": "Active",
"modifiedDate": "2023-04-11T10:33:48Z"
}
},
"Clover": {
"value": {
"id": "0DPQ6QP48YYHW",
"name": "TapMango Wallet",
"status": "Active",
"modifiedDate": "2023-01-09T11:01:04Z"
}
},
"Lightspeed K Trial": {
"value": {
"id": "647208621834260",
"name": "Cash",
"status": "Active",
"modifiedDate": "2023-03-02T09:48:56Z"
}
},
"Mollie": {
"value": {
"id": "applepay",
"name": "Apple Pay",
"status": "Unknown",
"modifiedDate": "2022-08-09T15:08:19Z"
}
},
"Mollie Test": {
"value": {
"id": "applepay",
"name": "Apple Pay",
"status": "Unknown",
"modifiedDate": "2022-08-17T11:33:19Z"
}
},
"Square": {
"value": {
"id": "BANK_ACCOUNT",
"name": "Bank Account",
"status": "Unknown",
"modifiedDate": "2022-08-02T10:27:32Z"
}
},
"SumUp": {
"value": {
"id": "CASH",
"name": "Cash",
"status": "Active",
"modifiedDate": "2022-09-14T10:58:03Z"
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/Payment-Required"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/Not-Found"
},
"409": {
"$ref": "#/components/responses/Conflict"
},
"429": {
"$ref": "#/components/responses/Too-Many-Requests"
},
"500": {
"$ref": "#/components/responses/Internal-Server-Error"
},
"503": {
"$ref": "#/components/responses/Service-Unavailable"
}
},
"description": "The *Get payment method* endpoint returns a single payment method for a given paymentMethodId.\n\n[Payment methods](https://docs.codat.io/commerce-api#/schemas/PaymentMethod) represent the payment method(s) used to make payments.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-paymentMethods) for integrations that support getting a specific payment method.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n"
}
},
"/companies/{companyId}/connections/{connectionId}/data/commerce-products": {
"parameters": [
{
"$ref": "#/components/parameters/companyId"
},
{
"$ref": "#/components/parameters/connectionId"
}
],
"get": {
"summary": "List products",
"tags": [
"Products"
],
"operationId": "list-products",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Products"
},
"examples": {
"Amazon Seller Central": {
"value": {
"results": [
{
"id": "Chromecast",
"categorization": "DEVICE",
"name": "Chromecast",
"description": "Cast from your phone to your TV with this all new chromecast.",
"productCategoryRefs": [],
"isGiftCard": false,
"variants": [
{
"id": "packaging_asin_gating",
"name": "Chromecast in a cardboard box",
"quantity": 0,
"isTaxEnabled": false,
"sku": "packaging_asin_gating",
"vatPercentage": 0,
"prices": [
{
"currency": "GBP",
"unitPrice": 50
}
],
"inventory": {
"totalQuantity": 0,
"locations": []
},
"shippingRequired": false,
"createdDate": "2021-02-07T12:30:01Z"
}
],
"createdDate": "2021-02-07T12:30:01Z",
"modifiedDate": "2023-01-09T09:12:11Z",
"sourceModifiedDate": "2022-08-17T09:07:07Z",
"status": "Published"
},
{
"id": "vb554a-bl1915",
"categorization": "COAT",
"name": "Waterproof Jacket",
"description": "Wind and rainproof, keeping you dry all year round.",
"productCategoryRefs": [],
"isGiftCard": false,
"variants": [
{
"id": "ARRIS,SB6141",
"name": "Waterproof Jacket (Black)",
"quantity": 0,
"isTaxEnabled": false,
"sku": "ARRIS,SB6141",
"vatPercentage": 0,
"prices": [
{
"currency": "GBP",
"unitPrice": 200
}
],
"inventory": {
"totalQuantity": 0,
"locations": []
},
"shippingRequired": false,
"createdDate": "2021-02-07T12:30:01Z"
},
{
"id": "RTN66U-N9000",
"name": "Waterproof Jacket (Blue)",
"quantity": 0,
"isTaxEnabled": false,
"sku": "RTN66U-N9000",
"vatPercentage": 0,
"prices": [
{
"currency": "GBP",
"unitPrice": 200
}
],
"inventory": {
"totalQuantity": 0,
"locations": []
},
"shippingRequired": false,
"createdDate": "2021-02-07T12:30:01Z"
},
{
"id": "TLWR841N",
"name": "Waterproof Jacket (Red)",
"quantity": 0,
"isTaxEnabled": false,
"sku": "TLWR841N",
"vatPercentage": 0,
"prices": [
{
"currency": "GBP",
"unitPrice": 200
}
],
"inventory": {
"totalQuantity": 0,
"locations": []
},
"shippingRequired": false,
"createdDate": "2021-02-07T12:30:01Z"
}
],
"createdDate": "2021-02-07T12:30:01Z",
"modifiedDate": "2023-01-09T09:12:11Z",
"sourceModifiedDate": "2022-08-17T09:07:07Z",
"status": "Published"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 3,
"_links": {
"current": {
"href": "/companies/6a59da96-e6d2-4c5c-ace7-65ba8be6a472/connections/58be1638-2c74-4ad4-8ff3-8c5b98b5f0fe/data/commerce-products?page=1&pageSize=2"
},
"self": {
"href": "/companies/6a59da96-e6d2-4c5c-ace7-65ba8be6a472/connections/58be1638-2c74-4ad4-8ff3-8c5b98b5f0fe/data/commerce-products"
},
"next": {
"href": "/companies/6a59da96-e6d2-4c5c-ace7-65ba8be6a472/connections/58be1638-2c74-4ad4-8ff3-8c5b98b5f0fe/data/commerce-products?page=2&pageSize=2"
}
}
}
},
"BigCommerce": {
"value": {
"results": [
{
"id": "103",
"categorization": "Shop All, Utility",
"name": "[Sample] Canvas Laundry Cart",
"description": "The last laundry cart you'll ever buy. This industrial non-collapsable cart is constructed with a steel framed body using heavyweight canvas capped with a soft leather rim sitting on four smooth rolling casters. Keeps the grubby garments off the floor and almost makes laundry enjoyable. Can also be used as the ideal storage solution: many people find it ideal for children's toys or a load of chopped firewood. Load it up and wheel it away. Natural Heavyweight Canvas with Vegetable Tanned Leather Rim Measure�",
"productCategoryRefs": [],
"isGiftCard": false,
"variants": [
{
"id": "71",
"name": "[Sample] Canvas Laundry Cart",
"quantity": 0,
"isTaxEnabled": false,
"sku": "CLC",
"barcode": "",
"vatPercentage": 0,
"prices": [
{
"currency": "GBP",
"unitPrice": 200
}
],
"inventory": {
"totalQuantity": 0,
"locations": []
},
"shippingRequired": true,
"createdDate": "0001-01-01T00:00:00"
}
],
"createdDate": "2015-07-03T18:48:07Z",
"modifiedDate": "2023-04-11T10:33:49Z",
"sourceModifiedDate": "2022-06-16T07:59:46Z",
"status": "Published"
},
{
"id": "104",
"categorization": "Shop All, Utility",
"name": "[Sample] Utility Caddy",
"description": "This powder coated steel utility caddy ensures your cleaning essentials are stowed away in one spot ready for your household chores. Brushes, cloths, liquid soaps can all easily be stashed away. Also ideal to be used as a garden caddy to easily grab from the shed for a days work. Works well as a mop bucket too. The wood carrying handle ensures a comfortable grip when toting it from room to room. Measures 19 h x 36 w x 20 dia cm/7.5 h x 14.1 w x 7.8 dia in",
"productCategoryRefs": [],
"isGiftCard": false,
"variants": [
{
"id": "72",
"name": "[Sample] Utility Caddy",
"quantity": 0,
"isTaxEnabled": false,
"sku": "OFSUC",
"barcode": "",
"vatPercentage": 0,
"prices": [
{
"currency": "GBP",
"unitPrice": 45.95
}
],
"inventory": {
"totalQuantity": 0,
"locations": []
},
"shippingRequired": true,
"createdDate": "0001-01-01T00:00:00"
}
],
"createdDate": "2015-07-03T18:49:26Z",
"modifiedDate": "2023-04-11T10:33:49Z",
"sourceModifiedDate": "2015-07-03T20:45:54Z",
"status": "Published"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 18,
"_links": {
"current": {
"href": "/companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-products?page=1&pageSize=2"
},
"self": {
"href": "/companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-products"
},
"next": {
"href": "/companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-products?page=2&pageSize=2"
}
}
}
},
"Clover": {
"value": {
"results": [
{
"id": "DJANHKK2AVEYY",
"name": "Coffee",
"description": "Coffee",
"productCategoryRefs": [],
"isGiftCard": false,
"variants": [
{
"id": "DJANHKK2AVEYY",
"name": "Coffee",
"quantity": 0,
"isTaxEnabled": true,
"sku": "12222",
"barcode": "1234",
"vatPercentage": 20,
"prices": [
{
"currency": "GBP",
"unitPrice": 3
}
],
"inventory": {
"totalQuantity": 0,
"locations": []
},
"shippingRequired": false,
"createdDate": "0001-01-01T00:00:00"
}
],
"createdDate": "0001-01-01T00:00:00",
"modifiedDate": "2023-01-09T11:01:03Z",
"sourceModifiedDate": "2021-05-24T15:50:55Z",
"status": "Published"
},
{
"id": "NMZHKK6FKF6ZJ",
"name": "Laptop",
"description": "Cool Laptop",
"productCategoryRefs": [],
"isGiftCard": false,
"variants": [
{
"id": "NMZHKK6FKF6ZJ",
"name": "Laptop",
"quantity": 0,
"isTaxEnabled": true,
"sku": "111",
"barcode": "123",
"vatPercentage": 20,
"prices": [
{
"currency": "GBP",
"unitPrice": 1000
}
],
"inventory": {
"totalQuantity": 0,
"locations": []
},
"shippingRequired": false,
"createdDate": "0001-01-01T00:00:00"
}
],
"createdDate": "0001-01-01T00:00:00",
"modifiedDate": "2023-01-09T11:01:03Z",
"sourceModifiedDate": "2021-05-24T08:19:14Z",
"status": "Published"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 3,
"_links": {
"current": {
"href": "/companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-products?page=1&pageSize=2"
},
"self": {
"href": "/companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-products"
},
"next": {
"href": "/companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-products?page=2&pageSize=2"
}
}
}
},
"Lightspeed K Trial": {
"value": {
"results": [
{
"id": "647208621834539",
"categorization": "Alcoholic beverages",
"name": "Alcoholic beverages",
"description": "Alcoholic beverages",
"productCategoryRefs": [
{
"id": "647208621834281",
"name": "Alcoholic beverages"
}
],
"isGiftCard": false,
"variants": [],
"createdDate": "0001-01-01T00:00:00",
"modifiedDate": "2023-03-02T09:50:32Z",
"status": "Published"
},
{
"id": "647208621834542",
"categorization": "NA beverages",
"name": "NA beverages",
"description": "NA beverages",
"productCategoryRefs": [
{
"id": "647208621834282",
"name": "NA beverages"
}
],
"isGiftCard": false,
"variants": [],
"createdDate": "0001-01-01T00:00:00",
"modifiedDate": "2023-03-02T09:50:32Z",
"status": "Published"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 39,
"_links": {
"current": {
"href": "/companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-products?page=1&pageSize=2"
},
"self": {
"href": "/companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-products"
},
"next": {
"href": "/companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-products?page=2&pageSize=2"
}
}
}
},
"PrestaShop": {
"value": {
"results": [
{
"id": "1",
"categorization": "Home - Clothes - Men",
"name": "Hummingbird printed t-shirt",
"description": "Symbol of lightness and delicacy, the hummingbird evokes curiosity and joy. Studio Design' PolyFaune collection features classic products with colorful patterns, inspired by the traditional japanese origamis. To wear with a chino or jeans. The sublimation textile printing process provides an exceptional color rendering and a color, guaranteed overtime.",
"productCategoryRefs": [],
"isGiftCard": false,
"variants": [
{
"id": "8",
"name": "Hummingbird printed t-shirt (Size = XL, Color = Black)",
"quantity": 0,
"isTaxEnabled": true,
"sku": "demo_1",
"vatPercentage": 6,
"prices": [
{
"currency": "USD",
"unitPrice": 23.9
}
],
"inventory": {
"totalQuantity": 300,
"locations": []
},
"shippingRequired": true,
"createdDate": "0001-01-01T00:00:00"
},
{
"id": "4",
"name": "Hummingbird printed t-shirt (Size = M, Color = Black)",
"quantity": 0,
"isTaxEnabled": true,
"sku": "demo_1",
"vatPercentage": 6,
"prices": [
{
"currency": "USD",
"unitPrice": 23.9
}
],
"inventory": {
"totalQuantity": 300,
"locations": []
},
"shippingRequired": true,
"createdDate": "0001-01-01T00:00:00"
},
{
"id": "5",
"name": "Hummingbird printed t-shirt (Size = L, Color = White)",
"quantity": 0,
"isTaxEnabled": true,
"sku": "demo_1",
"vatPercentage": 6,
"prices": [
{
"currency": "USD",
"unitPrice": 23.9
}
],
"inventory": {
"totalQuantity": 300,
"locations": []
},
"shippingRequired": true,
"createdDate": "0001-01-01T00:00:00"
},
{
"id": "3",
"name": "Hummingbird printed t-shirt (Size = M, Color = White)",
"quantity": 0,
"isTaxEnabled": true,
"sku": "demo_1",
"vatPercentage": 6,
"prices": [
{
"currency": "USD",
"unitPrice": 23.9
}
],
"inventory": {
"totalQuantity": 300,
"locations": []
},
"shippingRequired": true,
"createdDate": "0001-01-01T00:00:00"
},
{
"id": "6",
"name": "Hummingbird printed t-shirt (Size = L, Color = Black)",
"quantity": 0,
"isTaxEnabled": true,
"sku": "demo_1",
"vatPercentage": 6,
"prices": [
{
"currency": "USD",
"unitPrice": 23.9
}
],
"inventory": {
"totalQuantity": 300,
"locations": []
},
"shippingRequired": true,
"createdDate": "0001-01-01T00:00:00"
},
{
"id": "1",
"name": "Hummingbird printed t-shirt (Size = S, Color = White)",
"quantity": 0,
"isTaxEnabled": true,
"sku": "demo_1",
"vatPercentage": 6,
"prices": [
{
"currency": "USD",
"unitPrice": 23.9
}
],
"inventory": {
"totalQuantity": 300,
"locations": []
},
"shippingRequired": true,
"createdDate": "0001-01-01T00:00:00"
},
{
"id": "2",
"name": "Hummingbird printed t-shirt (Size = S, Color = Black)",
"quantity": 0,
"isTaxEnabled": true,
"sku": "demo_1",
"vatPercentage": 6,
"prices": [
{
"currency": "USD",
"unitPrice": 23.9
}
],
"inventory": {
"totalQuantity": 300,
"locations": []
},
"shippingRequired": true,
"createdDate": "0001-01-01T00:00:00"
},
{
"id": "7",
"name": "Hummingbird printed t-shirt (Size = XL, Color = White)",
"quantity": 0,
"isTaxEnabled": true,
"sku": "demo_1",
"vatPercentage": 6,
"prices": [
{
"currency": "USD",
"unitPrice": 23.9
}
],
"inventory": {
"totalQuantity": 300,
"locations": []
},
"shippingRequired": true,
"createdDate": "0001-01-01T00:00:00"
}
],
"createdDate": "2021-09-02T06:00:49",
"modifiedDate": "2022-01-26T15:09:42Z",
"sourceModifiedDate": "2021-09-02T06:00:49",
"status": "Published"
},
{
"id": "10",
"categorization": "Home - Accessories - Home Accessories",
"name": "Brown bear cushion",
"description": "The brown bear cushion will add a graphic and colorful touch to your sofa, armchair or bed. Create a modern and zen atmosphere that inspires relaxation. Cover 100% cotton, machine washable at 60� / Filling 100% hypoallergenic polyester.",
"productCategoryRefs": [],
"isGiftCard": false,
"variants": [
{
"id": "24",
"name": "Brown bear cushion (Color = White)",
"quantity": 0,
"isTaxEnabled": true,
"sku": "demo_16",
"vatPercentage": 6,
"prices": [
{
"currency": "USD",
"unitPrice": 18.9
}
],
"inventory": {
"totalQuantity": 300,
"locations": []
},
"shippingRequired": true,
"createdDate": "0001-01-01T00:00:00"
},
{
"id": "25",
"name": "Brown bear cushion (Color = Black)",
"quantity": 0,
"isTaxEnabled": true,
"sku": "demo_16",
"vatPercentage": 6,
"prices": [
{
"currency": "USD",
"unitPrice": 18.9
}
],
"inventory": {
"totalQuantity": 300,
"locations": []
},
"shippingRequired": true,
"createdDate": "0001-01-01T00:00:00"
}
],
"createdDate": "2021-09-02T06:00:49",
"modifiedDate": "2022-01-26T15:09:42Z",
"sourceModifiedDate": "2021-09-02T06:00:49",
"status": "Published"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 22,
"_links": {
"current": {
"href": "/companies/2bf78e61-58ca-421a-a430-5dfa59cf15b0/connections/30774c1f-fdcd-491e-9e60-47e316b3ab9b/data/commerce-products?page=1&pageSize=2"
},
"self": {
"href": "/companies/2bf78e61-58ca-421a-a430-5dfa59cf15b0/connections/30774c1f-fdcd-491e-9e60-47e316b3ab9b/data/commerce-products"
},
"next": {
"href": "/companies/2bf78e61-58ca-421a-a430-5dfa59cf15b0/connections/30774c1f-fdcd-491e-9e60-47e316b3ab9b/data/commerce-products?page=2&pageSize=2"
}
}
}
},
"Shopify": {
"value": {
"results": [
{
"id": "6595494117534",
"categorization": "Asus",
"name": "Monitor",
"description": "",
"productCategoryRefs": [],
"isGiftCard": false,
"variants": [
{
"id": "39444526694558",
"name": "Monitor",
"quantity": 0,
"isTaxEnabled": true,
"sku": "",
"barcode": "",
"vatPercentage": 0,
"prices": [
{
"currency": "GBP",
"unitPrice": 150
}
],
"inventory": {
"totalQuantity": 91,
"locations": []
},
"shippingRequired": true,
"createdDate": "2021-03-19T10:13:22Z"
}
],
"createdDate": "2021-03-19T10:13:22Z",
"modifiedDate": "2023-02-10T15:18:25Z",
"sourceModifiedDate": "2022-08-01T13:05:22Z",
"status": "Published"
},
{
"id": "6595497066654",
"categorization": "Logitech",
"name": "Mouse",
"description": "",
"productCategoryRefs": [],
"isGiftCard": false,
"variants": [
{
"id": "39444533706910",
"name": "Mouse",
"quantity": 0,
"isTaxEnabled": false,
"sku": "",
"barcode": "",
"vatPercentage": 0,
"prices": [
{
"currency": "GBP",
"unitPrice": 25
}
],
"inventory": {
"totalQuantity": 71,
"locations": []
},
"shippingRequired": true,
"createdDate": "2021-03-19T10:14:01Z"
}
],
"createdDate": "2021-03-19T10:14:01Z",
"modifiedDate": "2023-02-10T15:18:25Z",
"sourceModifiedDate": "2022-08-01T13:05:22Z",
"status": "Published"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 4,
"_links": {
"current": {
"href": "/companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-products?page=1&pageSize=2"
},
"self": {
"href": "/companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-products"
},
"next": {
"href": "/companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-products?page=2&pageSize=2"
}
}
}
},
"Square": {
"value": {
"results": [
{
"id": "AX54KZQ3UAVCVPUMNEGFEU35",
"categorization": "Hardware",
"name": "Monitor",
"productCategoryRefs": [],
"isGiftCard": false,
"variants": [
{
"id": "A5BUT6SYUNYRSQ2R7GZ6UKN6",
"name": "Regular",
"quantity": 0,
"isTaxEnabled": true,
"vatPercentage": 10,
"prices": [
{
"currency": "GBP",
"unitPrice": 200
}
],
"inventory": {
"totalQuantity": 0,
"locations": []
},
"shippingRequired": false,
"createdDate": "2021-02-18T15:47:31Z"
}
],
"createdDate": "2021-02-18T15:47:31Z",
"modifiedDate": "2021-06-17T14:23:02Z",
"sourceModifiedDate": "2021-02-18T15:47:31Z",
"status": "Unknown"
},
{
"id": "FYRIQNFTFRGQNQZGZG66MJWI",
"categorization": "Furniture",
"name": "Desk",
"productCategoryRefs": [],
"isGiftCard": false,
"variants": [
{
"id": "VMKSQEABA3WIYGXNAV63JOTZ",
"name": "Regular",
"quantity": 0,
"isTaxEnabled": true,
"vatPercentage": 10,
"prices": [
{
"currency": "GBP",
"unitPrice": 70
}
],
"inventory": {
"totalQuantity": 0,
"locations": []
},
"shippingRequired": false,
"createdDate": "2021-02-18T15:47:45Z"
}
],
"createdDate": "2021-02-18T15:47:45Z",
"modifiedDate": "2021-06-17T14:23:02Z",
"sourceModifiedDate": "2021-02-18T15:47:45Z",
"status": "Unknown"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 4,
"_links": {
"current": {
"href": "/companies/25debd39-e024-41a1-a86c-4fd47f29c853/connections/d5071fdf-a769-48f3-b39e-e588d515bb83/data/commerce-products?page=1&pageSize=2"
},
"self": {
"href": "/companies/25debd39-e024-41a1-a86c-4fd47f29c853/connections/d5071fdf-a769-48f3-b39e-e588d515bb83/data/commerce-products"
},
"next": {
"href": "/companies/25debd39-e024-41a1-a86c-4fd47f29c853/connections/d5071fdf-a769-48f3-b39e-e588d515bb83/data/commerce-products?page=2&pageSize=2"
}
}
}
},
"Stripe Test": {
"value": {
"results": [
{
"id": "prod_IaSbzLnxOHmC0i",
"name": "Blue T Shirt",
"description": "Nice cozy cotton t shirt",
"productCategoryRefs": [],
"isGiftCard": false,
"variants": [
{
"id": "price_1ICJVEA8m8S1Gh7OIOCDOG8j",
"name": "Blue T Shirt - Standard Price",
"quantity": 0,
"isTaxEnabled": false,
"vatPercentage": 0,
"prices": [
{
"currency": "GBP",
"unitPrice": 15
}
],
"inventory": {
"totalQuantity": 0,
"locations": []
},
"shippingRequired": true,
"createdDate": "2021-01-22T06:52:16Z"
},
{
"id": "price_1ICJQgA8m8S1Gh7OfErQdx5R",
"name": "Blue T Shirt - Standard Price",
"quantity": 0,
"isTaxEnabled": false,
"vatPercentage": 0,
"prices": [
{
"currency": "USD",
"unitPrice": 30
}
],
"inventory": {
"totalQuantity": 0,
"locations": []
},
"shippingRequired": true,
"createdDate": "2021-01-22T06:47:34Z"
},
{
"id": "price_1HzHiCA8m8S1Gh7OXZVa6r3F",
"name": "Blue T Shirt - Standard Price",
"quantity": 0,
"isTaxEnabled": false,
"vatPercentage": 0,
"prices": [
{
"currency": "GBP",
"unitPrice": 15
}
],
"inventory": {
"totalQuantity": 0,
"locations": []
},
"shippingRequired": true,
"createdDate": "2020-12-17T08:19:48Z"
}
],
"createdDate": "2020-12-17T08:17:48Z",
"modifiedDate": "2022-09-30T11:18:27Z",
"sourceModifiedDate": "2021-01-22T06:52:17Z",
"status": "Published"
},
{
"id": "prod_IQ6G1MDsvUb87Y",
"name": "Laptop",
"productCategoryRefs": [],
"isGiftCard": false,
"variants": [
{
"id": "price_1HpG3tA8m8S1Gh7Oa6bGLvVD",
"name": "Laptop - Standard Price",
"quantity": 0,
"isTaxEnabled": false,
"vatPercentage": 0,
"prices": [
{
"currency": "GBP",
"unitPrice": 100
}
],
"inventory": {
"totalQuantity": 0,
"locations": []
},
"shippingRequired": false,
"createdDate": "2020-11-19T16:32:45Z"
}
],
"createdDate": "2020-11-19T16:32:45Z",
"modifiedDate": "2022-09-30T11:18:27Z",
"sourceModifiedDate": "2022-05-12T23:31:33Z",
"status": "Published"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 4,
"_links": {
"current": {
"href": "/companies/8206e78e-e340-411e-b315-473c4ab73b48/connections/43e58373-0a1d-44a0-97f0-9fa9993a14fa/data/commerce-products?page=1&pageSize=2"
},
"self": {
"href": "/companies/8206e78e-e340-411e-b315-473c4ab73b48/connections/43e58373-0a1d-44a0-97f0-9fa9993a14fa/data/commerce-products"
},
"next": {
"href": "/companies/8206e78e-e340-411e-b315-473c4ab73b48/connections/43e58373-0a1d-44a0-97f0-9fa9993a14fa/data/commerce-products?page=2&pageSize=2"
}
}
}
},
"WooCommerce": {
"value": {
"results": [
{
"id": "27",
"categorization": "Hardware",
"name": "Monitor",
"description": "",
"productCategoryRefs": [],
"isGiftCard": false,
"variants": [
{
"id": "27",
"name": "Monitor",
"quantity": 0,
"isTaxEnabled": true,
"vatPercentage": 0,
"prices": [
{
"currency": "GBP",
"unitPrice": 150
}
],
"inventory": {
"totalQuantity": 0,
"locations": []
},
"shippingRequired": true,
"createdDate": "2021-03-11T08:55:22"
}
],
"createdDate": "2021-03-11T08:55:22",
"modifiedDate": "2021-07-13T16:19:00Z",
"sourceModifiedDate": "2021-03-11T09:03:15",
"status": "Published"
},
{
"id": "28",
"categorization": "Hardware",
"name": "Keyboard",
"description": "",
"productCategoryRefs": [],
"isGiftCard": false,
"variants": [
{
"id": "28",
"name": "Keyboard",
"quantity": 0,
"isTaxEnabled": true,
"vatPercentage": 0,
"prices": [
{
"currency": "GBP",
"unitPrice": 30
}
],
"inventory": {
"totalQuantity": 0,
"locations": []
},
"shippingRequired": true,
"createdDate": "2021-03-11T09:02:58"
}
],
"createdDate": "2021-03-11T09:02:58",
"modifiedDate": "2021-07-13T16:19:00Z",
"sourceModifiedDate": "2021-03-11T09:02:58",
"status": "Published"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 3,
"_links": {
"current": {
"href": "/companies/010c6f53-8fc8-40ab-9ed5-41191cf9c6b5/connections/7545ca2e-5f58-4f98-8af2-3b2c38bb8074/data/commerce-products?page=1&pageSize=2"
},
"self": {
"href": "/companies/010c6f53-8fc8-40ab-9ed5-41191cf9c6b5/connections/7545ca2e-5f58-4f98-8af2-3b2c38bb8074/data/commerce-products"
},
"next": {
"href": "/companies/010c6f53-8fc8-40ab-9ed5-41191cf9c6b5/connections/7545ca2e-5f58-4f98-8af2-3b2c38bb8074/data/commerce-products?page=2&pageSize=2"
}
}
}
},
"Zettle": {
"value": {
"results": [
{
"id": "9d21fd90-a34a-11eb-b574-ad6abe469b61",
"categorization": "Clothing",
"name": "T-Shirt",
"productCategoryRefs": [],
"isGiftCard": false,
"variants": [
{
"id": "bb9bcf30-a34a-11eb-b574-ad6abe469b61",
"name": "Medium",
"quantity": 0,
"isTaxEnabled": true,
"vatPercentage": 20,
"prices": [
{
"currency": "GBP",
"unitPrice": 10
}
],
"inventory": {
"totalQuantity": 0,
"locations": []
},
"shippingRequired": false,
"createdDate": "0001-01-01T00:00:00"
},
{
"id": "b919df40-a34a-11eb-b574-ad6abe469b61",
"name": "Large",
"quantity": 0,
"isTaxEnabled": true,
"vatPercentage": 20,
"prices": [
{
"currency": "GBP",
"unitPrice": 10
}
],
"inventory": {
"totalQuantity": 0,
"locations": []
},
"shippingRequired": false,
"createdDate": "0001-01-01T00:00:00"
},
{
"id": "bcb5cab0-a34a-11eb-b574-ad6abe469b61",
"name": "Small",
"quantity": 0,
"isTaxEnabled": true,
"vatPercentage": 20,
"prices": [
{
"currency": "GBP",
"unitPrice": 10
}
],
"inventory": {
"totalQuantity": 0,
"locations": []
},
"shippingRequired": false,
"createdDate": "0001-01-01T00:00:00"
}
],
"createdDate": "2021-04-22T09:12:09Z",
"modifiedDate": "2021-10-27T15:22:37Z",
"sourceModifiedDate": "2021-08-04T14:32:20Z",
"status": "Published"
},
{
"id": "e02c2930-a34a-11eb-b9db-8f5efc0924aa",
"categorization": "Clothing",
"name": "Hoodie",
"productCategoryRefs": [],
"isGiftCard": false,
"variants": [
{
"id": "fa180e40-a34a-11eb-b9db-8f5efc0924aa",
"name": "Medium",
"quantity": 0,
"isTaxEnabled": true,
"vatPercentage": 20,
"prices": [
{
"currency": "GBP",
"unitPrice": 30
}
],
"inventory": {
"totalQuantity": 0,
"locations": []
},
"shippingRequired": false,
"createdDate": "0001-01-01T00:00:00"
},
{
"id": "fc412fd0-a34a-11eb-b9db-8f5efc0924aa",
"name": "Extra Large",
"quantity": 0,
"isTaxEnabled": true,
"vatPercentage": 20,
"prices": [
{
"currency": "GBP",
"unitPrice": 30
}
],
"inventory": {
"totalQuantity": 0,
"locations": []
},
"shippingRequired": false,
"createdDate": "0001-01-01T00:00:00"
},
{
"id": "f8a03b50-a34a-11eb-b9db-8f5efc0924aa",
"name": "Small",
"quantity": 0,
"isTaxEnabled": true,
"vatPercentage": 20,
"prices": [
{
"currency": "GBP",
"unitPrice": 30
}
],
"inventory": {
"totalQuantity": 0,
"locations": []
},
"shippingRequired": false,
"createdDate": "0001-01-01T00:00:00"
},
{
"id": "fac1bbc0-a34a-11eb-b9db-8f5efc0924aa",
"name": "Large",
"quantity": 0,
"isTaxEnabled": true,
"vatPercentage": 20,
"prices": [
{
"currency": "GBP",
"unitPrice": 30
}
],
"inventory": {
"totalQuantity": 0,
"locations": []
},
"shippingRequired": false,
"createdDate": "0001-01-01T00:00:00"
}
],
"createdDate": "2021-04-22T09:13:26Z",
"modifiedDate": "2021-10-27T15:22:37Z",
"sourceModifiedDate": "2021-08-04T14:31:58Z",
"status": "Published"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 2,
"_links": {
"current": {
"href": "/companies/9d448ad0-4508-47fc-bd3b-6950493151f1/connections/c7baa8da-3302-464b-8aa1-edcd4c900902/data/commerce-products?page=1&pageSize=2"
},
"self": {
"href": "/companies/9d448ad0-4508-47fc-bd3b-6950493151f1/connections/c7baa8da-3302-464b-8aa1-edcd4c900902/data/commerce-products"
}
}
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/Malformed-Query"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/Payment-Required"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/Not-Found"
},
"409": {
"$ref": "#/components/responses/Conflict"
},
"429": {
"$ref": "#/components/responses/Too-Many-Requests"
},
"500": {
"$ref": "#/components/responses/Internal-Server-Error"
},
"503": {
"$ref": "#/components/responses/Service-Unavailable"
}
},
"parameters": [
{
"$ref": "#/components/parameters/page"
},
{
"$ref": "#/components/parameters/pageSize"
},
{
"$ref": "#/components/parameters/query"
},
{
"$ref": "#/components/parameters/orderBy"
}
],
"description": "The *List products* endpoint returns a list of [products](https://docs.codat.io/commerce-api#/schemas/Product) for a given company's connection.\n\n[Products](https://docs.codat.io/commerce-api#/schemas/Product) are items in the company's inventory that are available for sale.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n "
}
},
"/companies/{companyId}/connections/{connectionId}/data/commerce-products/{productId}": {
"parameters": [
{
"$ref": "#/components/parameters/companyId"
},
{
"$ref": "#/components/parameters/connectionId"
},
{
"$ref": "#/components/parameters/productId"
}
],
"get": {
"summary": "Get product",
"tags": [
"Products"
],
"operationId": "get-product",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Product"
},
"examples": {
"Amazon Seller Central": {
"value": {
"id": "Chromecast",
"categorization": "DEVICE",
"name": "Chromecast",
"description": "Cast from your phone to your TV with this all new chromecast.",
"productCategoryRefs": [],
"isGiftCard": false,
"variants": [
{
"id": "packaging_asin_gating",
"name": "Chromecast in a cardboard box",
"quantity": 0,
"isTaxEnabled": false,
"sku": "packaging_asin_gating",
"vatPercentage": 0,
"prices": [
{
"currency": "GBP",
"unitPrice": 50
}
],
"inventory": {
"totalQuantity": 0,
"locations": []
},
"shippingRequired": false,
"createdDate": "2021-02-07T12:30:01Z"
}
],
"createdDate": "2021-02-07T12:30:01Z",
"modifiedDate": "2023-01-09T09:12:11Z",
"sourceModifiedDate": "2022-08-17T09:07:07Z",
"status": "Published"
}
},
"BigCommerce": {
"value": {
"id": "103",
"categorization": "Shop All, Utility",
"name": "[Sample] Canvas Laundry Cart",
"description": "The last laundry cart you'll ever buy. This industrial non-collapsable cart is constructed with a steel framed body using heavyweight canvas capped with a soft leather rim sitting on four smooth rolling casters. Keeps the grubby garments off the floor and almost makes laundry enjoyable. Can also be used as the ideal storage solution: many people find it ideal for children's toys or a load of chopped firewood. Load it up and wheel it away. Natural Heavyweight Canvas with Vegetable Tanned Leather Rim Measure�",
"productCategoryRefs": [],
"isGiftCard": false,
"variants": [
{
"id": "71",
"name": "[Sample] Canvas Laundry Cart",
"quantity": 0,
"isTaxEnabled": false,
"sku": "CLC",
"barcode": "",
"vatPercentage": 0,
"prices": [
{
"currency": "GBP",
"unitPrice": 200
}
],
"inventory": {
"totalQuantity": 0,
"locations": []
},
"shippingRequired": true,
"createdDate": "0001-01-01T00:00:00"
}
],
"createdDate": "2015-07-03T18:48:07Z",
"modifiedDate": "2023-04-11T10:33:49Z",
"sourceModifiedDate": "2022-06-16T07:59:46Z",
"status": "Published"
}
},
"Clover": {
"value": {
"id": "DJANHKK2AVEYY",
"name": "Coffee",
"description": "Coffee",
"productCategoryRefs": [],
"isGiftCard": false,
"variants": [
{
"id": "DJANHKK2AVEYY",
"name": "Coffee",
"quantity": 0,
"isTaxEnabled": true,
"sku": "12222",
"barcode": "1234",
"vatPercentage": 20,
"prices": [
{
"currency": "GBP",
"unitPrice": 3
}
],
"inventory": {
"totalQuantity": 0,
"locations": []
},
"shippingRequired": false,
"createdDate": "0001-01-01T00:00:00"
}
],
"createdDate": "0001-01-01T00:00:00",
"modifiedDate": "2023-01-09T11:01:03Z",
"sourceModifiedDate": "2021-05-24T15:50:55Z",
"status": "Published"
}
},
"Lightspeed K Trial": {
"value": {
"id": "647208621834539",
"categorization": "Alcoholic beverages",
"name": "Alcoholic beverages",
"description": "Alcoholic beverages",
"productCategoryRefs": [
{
"id": "647208621834281",
"name": "Alcoholic beverages"
}
],
"isGiftCard": false,
"variants": [],
"createdDate": "0001-01-01T00:00:00",
"modifiedDate": "2023-03-02T09:50:32Z",
"status": "Published"
}
},
"PrestaShop": {
"value": {
"id": "1",
"categorization": "Home - Clothes - Men",
"name": "Hummingbird printed t-shirt",
"description": "Symbol of lightness and delicacy, the hummingbird evokes curiosity and joy. Studio Design' PolyFaune collection features classic products with colorful patterns, inspired by the traditional japanese origamis. To wear with a chino or jeans. The sublimation textile printing process provides an exceptional color rendering and a color, guaranteed overtime.",
"productCategoryRefs": [],
"isGiftCard": false,
"variants": [
{
"id": "8",
"name": "Hummingbird printed t-shirt (Size = XL, Color = Black)",
"quantity": 0,
"isTaxEnabled": true,
"sku": "demo_1",
"vatPercentage": 6,
"prices": [
{
"currency": "USD",
"unitPrice": 23.9
}
],
"inventory": {
"totalQuantity": 300,
"locations": []
},
"shippingRequired": true,
"createdDate": "0001-01-01T00:00:00"
},
{
"id": "4",
"name": "Hummingbird printed t-shirt (Size = M, Color = Black)",
"quantity": 0,
"isTaxEnabled": true,
"sku": "demo_1",
"vatPercentage": 6,
"prices": [
{
"currency": "USD",
"unitPrice": 23.9
}
],
"inventory": {
"totalQuantity": 300,
"locations": []
},
"shippingRequired": true,
"createdDate": "0001-01-01T00:00:00"
},
{
"id": "5",
"name": "Hummingbird printed t-shirt (Size = L, Color = White)",
"quantity": 0,
"isTaxEnabled": true,
"sku": "demo_1",
"vatPercentage": 6,
"prices": [
{
"currency": "USD",
"unitPrice": 23.9
}
],
"inventory": {
"totalQuantity": 300,
"locations": []
},
"shippingRequired": true,
"createdDate": "0001-01-01T00:00:00"
},
{
"id": "3",
"name": "Hummingbird printed t-shirt (Size = M, Color = White)",
"quantity": 0,
"isTaxEnabled": true,
"sku": "demo_1",
"vatPercentage": 6,
"prices": [
{
"currency": "USD",
"unitPrice": 23.9
}
],
"inventory": {
"totalQuantity": 300,
"locations": []
},
"shippingRequired": true,
"createdDate": "0001-01-01T00:00:00"
},
{
"id": "6",
"name": "Hummingbird printed t-shirt (Size = L, Color = Black)",
"quantity": 0,
"isTaxEnabled": true,
"sku": "demo_1",
"vatPercentage": 6,
"prices": [
{
"currency": "USD",
"unitPrice": 23.9
}
],
"inventory": {
"totalQuantity": 300,
"locations": []
},
"shippingRequired": true,
"createdDate": "0001-01-01T00:00:00"
},
{
"id": "1",
"name": "Hummingbird printed t-shirt (Size = S, Color = White)",
"quantity": 0,
"isTaxEnabled": true,
"sku": "demo_1",
"vatPercentage": 6,
"prices": [
{
"currency": "USD",
"unitPrice": 23.9
}
],
"inventory": {
"totalQuantity": 300,
"locations": []
},
"shippingRequired": true,
"createdDate": "0001-01-01T00:00:00"
},
{
"id": "2",
"name": "Hummingbird printed t-shirt (Size = S, Color = Black)",
"quantity": 0,
"isTaxEnabled": true,
"sku": "demo_1",
"vatPercentage": 6,
"prices": [
{
"currency": "USD",
"unitPrice": 23.9
}
],
"inventory": {
"totalQuantity": 300,
"locations": []
},
"shippingRequired": true,
"createdDate": "0001-01-01T00:00:00"
},
{
"id": "7",
"name": "Hummingbird printed t-shirt (Size = XL, Color = White)",
"quantity": 0,
"isTaxEnabled": true,
"sku": "demo_1",
"vatPercentage": 6,
"prices": [
{
"currency": "USD",
"unitPrice": 23.9
}
],
"inventory": {
"totalQuantity": 300,
"locations": []
},
"shippingRequired": true,
"createdDate": "0001-01-01T00:00:00"
}
],
"createdDate": "2021-09-02T06:00:49",
"modifiedDate": "2022-01-26T15:09:42Z",
"sourceModifiedDate": "2021-09-02T06:00:49",
"status": "Published"
}
},
"Shopify": {
"value": {
"id": "6595494117534",
"categorization": "Asus",
"name": "Monitor",
"description": "",
"productCategoryRefs": [],
"isGiftCard": false,
"variants": [
{
"id": "39444526694558",
"name": "Monitor",
"quantity": 0,
"isTaxEnabled": true,
"sku": "",
"barcode": "",
"vatPercentage": 0,
"prices": [
{
"currency": "GBP",
"unitPrice": 150
}
],
"inventory": {
"totalQuantity": 91,
"locations": []
},
"shippingRequired": true,
"createdDate": "2021-03-19T10:13:22Z"
}
],
"createdDate": "2021-03-19T10:13:22Z",
"modifiedDate": "2023-02-10T15:18:25Z",
"sourceModifiedDate": "2022-08-01T13:05:22Z",
"status": "Published"
}
},
"Square": {
"value": {
"id": "AX54KZQ3UAVCVPUMNEGFEU35",
"categorization": "Hardware",
"name": "Monitor",
"productCategoryRefs": [],
"isGiftCard": false,
"variants": [
{
"id": "A5BUT6SYUNYRSQ2R7GZ6UKN6",
"name": "Regular",
"quantity": 0,
"isTaxEnabled": true,
"vatPercentage": 10,
"prices": [
{
"currency": "GBP",
"unitPrice": 200
}
],
"inventory": {
"totalQuantity": 0,
"locations": []
},
"shippingRequired": false,
"createdDate": "2021-02-18T15:47:31Z"
}
],
"createdDate": "2021-02-18T15:47:31Z",
"modifiedDate": "2021-06-17T14:23:02Z",
"sourceModifiedDate": "2021-02-18T15:47:31Z",
"status": "Unknown"
}
},
"Stripe Test": {
"value": {
"id": "prod_IaSbzLnxOHmC0i",
"name": "Blue T Shirt",
"description": "Nice cozy cotton t shirt",
"productCategoryRefs": [],
"isGiftCard": false,
"variants": [
{
"id": "price_1ICJVEA8m8S1Gh7OIOCDOG8j",
"name": "Blue T Shirt - Standard Price",
"quantity": 0,
"isTaxEnabled": false,
"vatPercentage": 0,
"prices": [
{
"currency": "GBP",
"unitPrice": 15
}
],
"inventory": {
"totalQuantity": 0,
"locations": []
},
"shippingRequired": true,
"createdDate": "2021-01-22T06:52:16Z"
},
{
"id": "price_1ICJQgA8m8S1Gh7OfErQdx5R",
"name": "Blue T Shirt - Standard Price",
"quantity": 0,
"isTaxEnabled": false,
"vatPercentage": 0,
"prices": [
{
"currency": "USD",
"unitPrice": 30
}
],
"inventory": {
"totalQuantity": 0,
"locations": []
},
"shippingRequired": true,
"createdDate": "2021-01-22T06:47:34Z"
},
{
"id": "price_1HzHiCA8m8S1Gh7OXZVa6r3F",
"name": "Blue T Shirt - Standard Price",
"quantity": 0,
"isTaxEnabled": false,
"vatPercentage": 0,
"prices": [
{
"currency": "GBP",
"unitPrice": 15
}
],
"inventory": {
"totalQuantity": 0,
"locations": []
},
"shippingRequired": true,
"createdDate": "2020-12-17T08:19:48Z"
}
],
"createdDate": "2020-12-17T08:17:48Z",
"modifiedDate": "2022-09-30T11:18:27Z",
"sourceModifiedDate": "2021-01-22T06:52:17Z",
"status": "Published"
}
},
"WooCommerce": {
"value": {
"id": "27",
"categorization": "Hardware",
"name": "Monitor",
"description": "",
"productCategoryRefs": [],
"isGiftCard": false,
"variants": [
{
"id": "27",
"name": "Monitor",
"quantity": 0,
"isTaxEnabled": true,
"vatPercentage": 0,
"prices": [
{
"currency": "GBP",
"unitPrice": 150
}
],
"inventory": {
"totalQuantity": 0,
"locations": []
},
"shippingRequired": true,
"createdDate": "2021-03-11T08:55:22"
}
],
"createdDate": "2021-03-11T08:55:22",
"modifiedDate": "2021-07-13T16:19:00Z",
"sourceModifiedDate": "2021-03-11T09:03:15",
"status": "Published"
}
},
"Zettle": {
"value": {
"id": "9d21fd90-a34a-11eb-b574-ad6abe469b61",
"categorization": "Clothing",
"name": "T-Shirt",
"productCategoryRefs": [],
"isGiftCard": false,
"variants": [
{
"id": "bb9bcf30-a34a-11eb-b574-ad6abe469b61",
"name": "Medium",
"quantity": 0,
"isTaxEnabled": true,
"vatPercentage": 20,
"prices": [
{
"currency": "GBP",
"unitPrice": 10
}
],
"inventory": {
"totalQuantity": 0,
"locations": []
},
"shippingRequired": false,
"createdDate": "0001-01-01T00:00:00"
},
{
"id": "b919df40-a34a-11eb-b574-ad6abe469b61",
"name": "Large",
"quantity": 0,
"isTaxEnabled": true,
"vatPercentage": 20,
"prices": [
{
"currency": "GBP",
"unitPrice": 10
}
],
"inventory": {
"totalQuantity": 0,
"locations": []
},
"shippingRequired": false,
"createdDate": "0001-01-01T00:00:00"
},
{
"id": "bcb5cab0-a34a-11eb-b574-ad6abe469b61",
"name": "Small",
"quantity": 0,
"isTaxEnabled": true,
"vatPercentage": 20,
"prices": [
{
"currency": "GBP",
"unitPrice": 10
}
],
"inventory": {
"totalQuantity": 0,
"locations": []
},
"shippingRequired": false,
"createdDate": "0001-01-01T00:00:00"
}
],
"createdDate": "2021-04-22T09:12:09Z",
"modifiedDate": "2021-10-27T15:22:37Z",
"sourceModifiedDate": "2021-08-04T14:32:20Z",
"status": "Published"
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/Payment-Required"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/Not-Found"
},
"409": {
"$ref": "#/components/responses/Conflict"
},
"429": {
"$ref": "#/components/responses/Too-Many-Requests"
},
"500": {
"$ref": "#/components/responses/Internal-Server-Error"
},
"503": {
"$ref": "#/components/responses/Service-Unavailable"
}
}
}
},
"/companies/{companyId}/connections/{connectionId}/data/commerce-transactions": {
"parameters": [
{
"$ref": "#/components/parameters/companyId"
},
{
"$ref": "#/components/parameters/connectionId"
}
],
"get": {
"summary": "List transactions",
"tags": [
"Transactions"
],
"operationId": "list-transactions",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Transactions"
},
"examples": {
"Mollie": {
"value": {
"results": [
{
"id": "re_Azhe8TzfUK",
"totalAmount": -20,
"currency": "EUR",
"type": "Refund",
"createdDate": "2022-01-17T16:00:46",
"modifiedDate": "2022-03-17T15:47:28Z"
},
{
"id": "re_NPKEJhQveu",
"totalAmount": -60,
"currency": "EUR",
"type": "Refund",
"createdDate": "2022-01-17T16:00:05",
"modifiedDate": "2022-03-17T15:47:28Z"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 7,
"_links": {
"current": {
"href": "/companies/a68cb447-182d-4bbe-be1a-f526d11d69d5/connections/dfbf847b-cde8-4b00-b2f9-af51dec0d337/data/commerce-transactions?page=1&pageSize=2"
},
"self": {
"href": "/companies/a68cb447-182d-4bbe-be1a-f526d11d69d5/connections/dfbf847b-cde8-4b00-b2f9-af51dec0d337/data/commerce-transactions"
},
"next": {
"href": "/companies/a68cb447-182d-4bbe-be1a-f526d11d69d5/connections/dfbf847b-cde8-4b00-b2f9-af51dec0d337/data/commerce-transactions?page=2&pageSize=2"
}
}
}
},
"Mollie Test": {
"value": {
"results": [
{
"id": "re_Azhe8TzfUK",
"totalAmount": -20,
"currency": "EUR",
"type": "Refund",
"subType": "PaymentRefund",
"createdDate": "2022-01-17T16:00:46",
"modifiedDate": "2022-08-17T11:33:19Z"
},
{
"id": "re_NPKEJhQveu",
"totalAmount": -60,
"currency": "EUR",
"type": "Refund",
"subType": "PaymentRefund",
"createdDate": "2022-01-17T16:00:05",
"modifiedDate": "2022-08-17T11:33:19Z"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 7,
"_links": {
"current": {
"href": "/companies/b978f9fe-8d63-4cfc-b2c2-b61b72e22785/connections/d564f8fd-0766-4ab8-a427-7c893f9b9ff6/data/commerce-transactions?page=1&pageSize=2"
},
"self": {
"href": "/companies/b978f9fe-8d63-4cfc-b2c2-b61b72e22785/connections/d564f8fd-0766-4ab8-a427-7c893f9b9ff6/data/commerce-transactions"
},
"next": {
"href": "/companies/b978f9fe-8d63-4cfc-b2c2-b61b72e22785/connections/d564f8fd-0766-4ab8-a427-7c893f9b9ff6/data/commerce-transactions?page=2&pageSize=2"
}
}
}
},
"Shopify": {
"value": {
"results": [
{
"id": "ShopifyPayment-1633176289438",
"totalAmount": 175,
"currency": "GBP",
"type": "Payment",
"subType": "charge",
"transactionSourceRef": {
"id": "3684116791454",
"type": "Order"
},
"createdDate": "2021-03-19T13:16:26",
"modifiedDate": "2023-02-10T15:18:23Z",
"sourceModifiedDate": "2021-03-19T13:16:26"
},
{
"id": "ShopifyPayment-1633176289438:Fee",
"totalAmount": -4.05,
"currency": "GBP",
"type": "PaymentFee",
"subType": "charge",
"transactionSourceRef": {
"id": "3684116791454",
"type": "Order"
},
"createdDate": "2021-03-19T13:16:26",
"modifiedDate": "2023-02-10T15:18:23Z",
"sourceModifiedDate": "2021-03-19T13:16:26"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 64,
"_links": {
"current": {
"href": "/companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-transactions?page=1&pageSize=2"
},
"self": {
"href": "/companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-transactions"
},
"next": {
"href": "/companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-transactions?page=2&pageSize=2"
}
}
}
},
"Stripe Test": {
"value": {
"results": [
{
"id": "txn_1HpGQUA8m8S1Gh7OR21pB0Yj",
"totalAmount": 50,
"currency": "GBP",
"type": "Payment",
"subType": "charge",
"transactionSourceRef": {
"id": "ch_1HpGQUA8m8S1Gh7Ot4WDTus5",
"type": "Payment"
},
"createdDate": "2020-11-19T16:56:06Z",
"modifiedDate": "2022-09-30T11:18:28Z"
},
{
"id": "txn_1HpGQUA8m8S1Gh7OR21pB0Yj:Stripe processing fees",
"totalAmount": -0.9,
"currency": "GBP",
"type": "PaymentFee",
"subType": "stripe_fee",
"transactionSourceRef": {
"id": "ch_1HpGQUA8m8S1Gh7Ot4WDTus5",
"type": "Payment"
},
"createdDate": "2020-11-19T16:56:06Z",
"modifiedDate": "2022-09-30T11:18:28Z"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 70,
"_links": {
"current": {
"href": "/companies/8206e78e-e340-411e-b315-473c4ab73b48/connections/43e58373-0a1d-44a0-97f0-9fa9993a14fa/data/commerce-transactions?page=1&pageSize=2"
},
"self": {
"href": "/companies/8206e78e-e340-411e-b315-473c4ab73b48/connections/43e58373-0a1d-44a0-97f0-9fa9993a14fa/data/commerce-transactions"
},
"next": {
"href": "/companies/8206e78e-e340-411e-b315-473c4ab73b48/connections/43e58373-0a1d-44a0-97f0-9fa9993a14fa/data/commerce-transactions?page=2&pageSize=2"
}
}
}
},
"SumUp": {
"value": {
"results": [
{
"id": "46d36a64-ea48-4e37-9340-3548cbf3ca2f",
"totalAmount": 15,
"currency": "GBP",
"type": "Payment",
"subType": "PAYMENT",
"createdDate": "2021-03-26T21:09:59Z",
"modifiedDate": "2022-09-14T10:58:03Z"
},
{
"id": "471914a4-a82f-4fc4-b39b-9986fd706d26",
"totalAmount": 215,
"currency": "GBP",
"type": "Payment",
"subType": "PAYMENT",
"createdDate": "2021-03-30T12:22:14Z",
"modifiedDate": "2022-09-14T10:58:03Z"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 3,
"_links": {
"current": {
"href": "/companies/e170dbe2-be50-474f-b449-82add37108de/connections/1e631dd5-a30b-4bad-ad5c-315c9743535b/data/commerce-transactions?page=1&pageSize=2"
},
"self": {
"href": "/companies/e170dbe2-be50-474f-b449-82add37108de/connections/1e631dd5-a30b-4bad-ad5c-315c9743535b/data/commerce-transactions"
},
"next": {
"href": "/companies/e170dbe2-be50-474f-b449-82add37108de/connections/1e631dd5-a30b-4bad-ad5c-315c9743535b/data/commerce-transactions?page=2&pageSize=2"
}
}
}
},
"Zettle": {
"value": {
"results": [
{
"id": "PAYMENT:09b94cfc-2d98-11eb-8021-0e1b9dcbeca1",
"totalAmount": 25,
"currency": "GBP",
"type": "Payment",
"transactionSourceRef": {
"id": "09b94cfc-2d98-11eb-8021-0e1b9dcbeca1",
"type": "Unknown"
},
"createdDate": "2020-11-23T14:27:38Z",
"modifiedDate": "2021-10-27T15:23:04Z",
"sourceModifiedDate": "2020-11-25T23:10:01Z"
},
{
"id": "PAYMENT:226580d6-2d98-11eb-a35c-fed5e63de507",
"totalAmount": 58.5,
"currency": "GBP",
"type": "Payment",
"transactionSourceRef": {
"id": "226580d6-2d98-11eb-a35c-fed5e63de507",
"type": "Unknown"
},
"createdDate": "2020-11-23T14:28:20Z",
"modifiedDate": "2021-10-27T15:23:04Z",
"sourceModifiedDate": "2020-11-25T23:10:02Z"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 16,
"_links": {
"current": {
"href": "/companies/9d448ad0-4508-47fc-bd3b-6950493151f1/connections/c7baa8da-3302-464b-8aa1-edcd4c900902/data/commerce-transactions?page=1&pageSize=2"
},
"self": {
"href": "/companies/9d448ad0-4508-47fc-bd3b-6950493151f1/connections/c7baa8da-3302-464b-8aa1-edcd4c900902/data/commerce-transactions"
},
"next": {
"href": "/companies/9d448ad0-4508-47fc-bd3b-6950493151f1/connections/c7baa8da-3302-464b-8aa1-edcd4c900902/data/commerce-transactions?page=2&pageSize=2"
}
}
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/Malformed-Query"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/Payment-Required"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/Not-Found"
},
"409": {
"$ref": "#/components/responses/Conflict"
},
"429": {
"$ref": "#/components/responses/Too-Many-Requests"
},
"500": {
"$ref": "#/components/responses/Internal-Server-Error"
},
"503": {
"$ref": "#/components/responses/Service-Unavailable"
}
},
"description": "The *List transactions* endpoint returns a list of [transactions](https://docs.codat.io/commerce-api#/schemas/Transaction) for a given company's connection.\n\n[Transactions](https://docs.codat.io/commerce-api#/schemas/Transaction) detail all financial affairs recorded in the commerce or point of sale system.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n ",
"parameters": [
{
"$ref": "#/components/parameters/page"
},
{
"$ref": "#/components/parameters/pageSize"
},
{
"$ref": "#/components/parameters/query"
},
{
"$ref": "#/components/parameters/orderBy"
}
]
}
},
"/companies/{companyId}/connections/{connectionId}/data/commerce-transactions/{transactionId}": {
"parameters": [
{
"$ref": "#/components/parameters/companyId"
},
{
"$ref": "#/components/parameters/connectionId"
},
{
"name": "transactionId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"examples": {
"$ref": "#/components/schemas/Order/allOf/0/properties/id/examples"
}
},
"description": "Unique identifier for a transaction."
}
],
"get": {
"summary": "Get transaction",
"tags": [
"Transactions"
],
"operationId": "get-transaction",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Transaction"
},
"examples": {
"Mollie": {
"value": {
"id": "re_Azhe8TzfUK",
"totalAmount": -20,
"currency": "EUR",
"type": "Refund",
"createdDate": "2022-01-17T16:00:46",
"modifiedDate": "2022-03-17T15:47:28Z"
}
},
"Mollie Test": {
"value": {
"id": "re_Azhe8TzfUK",
"totalAmount": -20,
"currency": "EUR",
"type": "Refund",
"subType": "PaymentRefund",
"createdDate": "2022-01-17T16:00:46",
"modifiedDate": "2022-08-17T11:33:19Z"
}
},
"Shopify": {
"value": {
"id": "ShopifyPayment-1633176289438",
"totalAmount": 175,
"currency": "GBP",
"type": "Payment",
"subType": "charge",
"transactionSourceRef": {
"id": "3684116791454",
"type": "Order"
},
"createdDate": "2021-03-19T13:16:26",
"modifiedDate": "2023-02-10T15:18:23Z",
"sourceModifiedDate": "2021-03-19T13:16:26"
}
},
"Stripe Test": {
"value": {
"id": "txn_1HpGQUA8m8S1Gh7OR21pB0Yj",
"totalAmount": 50,
"currency": "GBP",
"type": "Payment",
"subType": "charge",
"transactionSourceRef": {
"id": "ch_1HpGQUA8m8S1Gh7Ot4WDTus5",
"type": "Payment"
},
"createdDate": "2020-11-19T16:56:06Z",
"modifiedDate": "2022-09-30T11:18:28Z"
}
},
"SumUp": {
"value": {
"id": "46d36a64-ea48-4e37-9340-3548cbf3ca2f",
"totalAmount": 15,
"currency": "GBP",
"type": "Payment",
"subType": "PAYMENT",
"createdDate": "2021-03-26T21:09:59Z",
"modifiedDate": "2022-09-14T10:58:03Z"
}
},
"Zettle": {
"value": {
"id": "PAYMENT:09b94cfc-2d98-11eb-8021-0e1b9dcbeca1",
"totalAmount": 25,
"currency": "GBP",
"type": "Payment",
"transactionSourceRef": {
"id": "09b94cfc-2d98-11eb-8021-0e1b9dcbeca1",
"type": "Unknown"
},
"createdDate": "2020-11-23T14:27:38Z",
"modifiedDate": "2021-10-27T15:23:04Z",
"sourceModifiedDate": "2020-11-25T23:10:01Z"
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/Payment-Required"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/Not-Found"
},
"409": {
"$ref": "#/components/responses/Conflict"
},
"429": {
"$ref": "#/components/responses/Too-Many-Requests"
},
"500": {
"$ref": "#/components/responses/Internal-Server-Error"
},
"503": {
"$ref": "#/components/responses/Service-Unavailable"
}
},
"description": "The *Get transaction* endpoint returns a single transaction for a given transactionId.\n\n[Transactions](https://docs.codat.io/commerce-api#/schemas/Transaction) detail all financial affairs recorded in the commerce or point of sale system.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-transactions) for integrations that support getting a specific transaction.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n"
}
},
"/companies/{companyId}/connections/{connectionId}/data/commerce-productCategories": {
"parameters": [
{
"$ref": "#/components/parameters/companyId"
},
{
"$ref": "#/components/parameters/connectionId"
}
],
"get": {
"summary": "List product categories",
"tags": [
"Products"
],
"operationId": "list-product-categories",
"x-speakeasy-name-override": "list-categories",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductCategories"
},
"examples": {
"Lightspeed K Trial": {
"value": {
"results": [
{
"id": "647208621834281",
"name": "Alcoholic beverages",
"ancestorRefs": [],
"hasChildren": false,
"modifiedDate": "2023-03-02T09:49:11Z"
},
{
"id": "647208621834282",
"name": "NA beverages",
"ancestorRefs": [],
"hasChildren": false,
"modifiedDate": "2023-03-02T09:49:11Z"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 8,
"_links": {
"current": {
"href": "/companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-productCategories?page=1&pageSize=2"
},
"self": {
"href": "/companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-productCategories"
},
"next": {
"href": "/companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-productCategories?page=2&pageSize=2"
}
}
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/Malformed-Query"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/Payment-Required"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/Not-Found"
},
"409": {
"$ref": "#/components/responses/Conflict"
},
"429": {
"$ref": "#/components/responses/Too-Many-Requests"
},
"500": {
"$ref": "#/components/responses/Internal-Server-Error"
},
"503": {
"$ref": "#/components/responses/Service-Unavailable"
}
},
"parameters": [
{
"$ref": "#/components/parameters/page"
},
{
"$ref": "#/components/parameters/pageSize"
},
{
"$ref": "#/components/parameters/query"
},
{
"$ref": "#/components/parameters/orderBy"
}
],
"description": "The *List product categories* endpoint returns a list of [product categories](https://docs.codat.io/commerce-api#/schemas/ProductCategory) for a given company's connection.\n\n[Product categories](https://docs.codat.io/commerce-api#/schemas/ProductCategory) are used to classify a group of products together, either by type (e.g. \"Furniture\"), or sometimes by tax profile.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n "
}
},
"/companies/{companyId}/connections/{connectionId}/data/commerce-productCategories/{productId}": {
"parameters": [
{
"$ref": "#/components/parameters/companyId"
},
{
"$ref": "#/components/parameters/connectionId"
},
{
"$ref": "#/components/parameters/productId"
}
],
"get": {
"summary": "Get product category",
"tags": [
"Products"
],
"operationId": "get-product-category",
"x-speakeasy-name-override": "get-category",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductCategory"
},
"examples": {
"Lightspeed K Trial": {
"value": {
"id": "647208621834281",
"name": "Alcoholic beverages",
"ancestorRefs": [],
"hasChildren": false,
"modifiedDate": "2023-03-02T09:49:11Z"
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/Payment-Required"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/Not-Found"
},
"409": {
"$ref": "#/components/responses/Conflict"
},
"429": {
"$ref": "#/components/responses/Too-Many-Requests"
},
"500": {
"$ref": "#/components/responses/Internal-Server-Error"
},
"503": {
"$ref": "#/components/responses/Service-Unavailable"
}
},
"description": "The *Get product* endpoint returns a single product for a given productId.\n\n[Product categories](https://docs.codat.io/commerce-api#/schemas/ProductCategory) are used to classify a group of products together, either by type (e.g. \"Furniture\"), or sometimes by tax profile.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-productCategories) for integrations that support getting a specific product.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n"
}
},
"/companies/{companyId}/connections/{connectionId}/data/commerce-taxComponents": {
"parameters": [
{
"$ref": "#/components/parameters/companyId"
},
{
"$ref": "#/components/parameters/connectionId"
}
],
"get": {
"summary": "List tax components",
"tags": [
"Tax components"
],
"operationId": "list-tax-components",
"parameters": [
{
"$ref": "#/components/parameters/page"
},
{
"$ref": "#/components/parameters/pageSize"
},
{
"$ref": "#/components/parameters/query"
},
{
"$ref": "#/components/parameters/orderBy"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaxComponents"
},
"examples": {
"Clover": {
"value": {
"results": [
{
"id": "16BCCTTGKEX4R",
"name": "Flat and Percentage Rate",
"rate": 0.000001,
"isCompound": false,
"modifiedDate": "2023-01-09T11:01:02Z"
},
{
"id": "9BP3FGH3F0Q58",
"name": "Flat and Percentage Rate",
"rate": 5e-7,
"isCompound": false,
"modifiedDate": "2023-01-09T11:01:02Z"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 6,
"_links": {
"current": {
"href": "/companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-taxComponents?page=1&pageSize=2"
},
"self": {
"href": "/companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-taxComponents"
},
"next": {
"href": "/companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-taxComponents?page=2&pageSize=2"
}
}
}
},
"Lightspeed K Trial": {
"value": {
"results": [
{
"id": "GST0",
"name": "Tax Exempt",
"rate": 0,
"isCompound": false,
"modifiedDate": "2023-03-08T13:49:25Z"
},
{
"id": "GST10",
"name": "10% GST",
"rate": 0.1,
"isCompound": false,
"modifiedDate": "2023-03-08T13:49:25Z"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 4,
"_links": {
"current": {
"href": "/companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-taxComponents?page=1&pageSize=2"
},
"self": {
"href": "/companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-taxComponents"
},
"next": {
"href": "/companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-taxComponents?page=2&pageSize=2"
}
}
}
},
"Shopify": {
"value": {
"results": [
{
"id": "GB VAT:0.2",
"name": "GB VAT",
"rate": 0.2,
"isCompound": false,
"modifiedDate": "2023-01-17T14:05:55Z"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 1,
"_links": {
"current": {
"href": "/companies/b6611c58-270d-4061-8c88-d4887a52418e/connections/16f95935-aa5f-4184-bfd4-f9526e37658d/data/commerce-taxComponents?page=1&pageSize=2"
},
"self": {
"href": "/companies/b6611c58-270d-4061-8c88-d4887a52418e/connections/16f95935-aa5f-4184-bfd4-f9526e37658d/data/commerce-taxComponents"
}
}
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/Malformed-Query"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/Payment-Required"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/Not-Found"
},
"409": {
"$ref": "#/components/responses/Conflict"
},
"429": {
"$ref": "#/components/responses/Too-Many-Requests"
},
"500": {
"$ref": "#/components/responses/Internal-Server-Error"
},
"503": {
"$ref": "#/components/responses/Service-Unavailable"
}
},
"description": "The *List tax components* endpoint returns a list of [tax components](https://docs.codat.io/commerce-api#/schemas/TaxComponent) for a given company's connection.\n\n[Tax components](https://docs.codat.io/commerce-api#/schemas/TaxComponent) are tax rates from the commerce software, including tax rate's name and value.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n "
}
},
"/companies/{companyId}/connections/{connectionId}/data/commerce-taxComponents/{taxId}": {
"parameters": [
{
"$ref": "#/components/parameters/companyId"
},
{
"$ref": "#/components/parameters/connectionId"
},
{
"name": "taxId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"examples": {
"$ref": "#/components/schemas/Order/allOf/0/properties/id/examples"
}
},
"description": "Unique identifier for a tax component."
}
],
"get": {
"summary": "Get tax component",
"tags": [
"Tax components"
],
"operationId": "get-tax-component",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaxComponent"
},
"examples": {
"Clover": {
"value": {
"id": "16BCCTTGKEX4R",
"name": "Flat and Percentage Rate",
"rate": 0.000001,
"isCompound": false,
"modifiedDate": "2023-01-09T11:01:02Z"
}
},
"Lightspeed K Trial": {
"value": {
"id": "GST0",
"name": "Tax Exempt",
"rate": 0,
"isCompound": false,
"modifiedDate": "2023-03-08T13:49:25Z"
}
},
"Shopify": {
"value": {
"id": "GB VAT:0.2",
"name": "GB VAT",
"rate": 0.2,
"isCompound": false,
"modifiedDate": "2023-01-17T14:05:55Z"
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/Payment-Required"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/Not-Found"
},
"409": {
"$ref": "#/components/responses/Conflict"
},
"429": {
"$ref": "#/components/responses/Too-Many-Requests"
},
"500": {
"$ref": "#/components/responses/Internal-Server-Error"
},
"503": {
"$ref": "#/components/responses/Service-Unavailable"
}
},
"description": "The *Get tax* endpoint returns a single tax for a given taxId.\n\n[Tax components](https://docs.codat.io/commerce-api#/schemas/TaxComponent) are tax rates from the commerce software, including tax rate's name and value.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-taxComponents) for integrations that support getting a specific tax.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n"
}
}
},
"components": {
"schemas": {
"Address": {
"title": "Commerce: Address",
"x-internal": true,
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/Address/definitions/commerceAddressType"
},
"line1": {
"description": "The first line of the address",
"type": "string"
},
"line2": {
"description": "The second line of the address",
"type": "string"
},
"city": {
"description": "The third line of the address, or city",
"type": "string"
},
"region": {
"description": "The fourth line of the address, or region",
"type": "string"
},
"country": {
"description": "The country for the address",
"type": "string"
},
"postalCode": {
"description": "The postal (or zip) code for the address",
"type": "string"
}
},
"definitions": {
"commerceAddressType": {
"description": "The type of the address",
"type": "string",
"enum": [
"Billing",
"Delivery",
"Order",
"Inventory",
"Unknown"
]
}
}
},
"CompanyInfo": {
"title": "Commerce: Company profile",
"description": "In the Codat system, company profile includes standard commercial details about \na linked company, such as their address, phone number, and company registration.\n\nExplore our [data coverage](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=companyInfo) for this data type.\n",
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"companyName": {
"type": "string",
"description": "The name of the company",
"example": "Codat"
},
"commercePlatformRef": {
"type": "string",
"description": "Identifier or reference for the company in the commerce software"
},
"companyLegalName": {
"type": "string",
"description": "The full legal name of the company",
"example": "Codat Limited"
},
"addresses": {
"type": "array",
"description": "Addresses associated with the company",
"items": {
"$ref": "#/components/schemas/Address"
}
},
"phoneNumbers": {
"type": "array",
"description": "Phone numbers associated with the company",
"items": {
"$ref": "#/components/schemas/PhoneNumber"
}
},
"webLinks": {
"description": "Weblinks associated with the company",
"type": "array",
"items": {
"title": "Weblink",
"description": "Weblink associated with the company.",
"type": "object",
"properties": {
"type": {
"description": "The type of the weblink.",
"type": "string",
"enum": [
"Website",
"Social",
"Unknown"
]
},
"url": {
"description": "The full URL for the weblink.",
"type": "string",
"format": "url"
}
},
"example": {
"type": "Website",
"url": "https://codat.io"
}
}
},
"registrationNumber": {
"description": "The registration number of the company",
"type": "string",
"examples": [
10480375
]
},
"baseCurrency": {
"$ref": "#/components/schemas/Transaction/allOf/1/properties/currency"
},
"accountBalances": {
"description": "The available and current cash balances for the company's accounts",
"type": "array",
"items": {
"$ref": "#/components/schemas/CompanyInfo/definitions/accountBalance"
}
},
"sourceUrls": {
"description": "URL addresses for the originating system. For example, potential use cases include 'deeplinking' to the originating system",
"type": "object",
"additionalProperties": {
"type": "string"
},
"example": {
"url1": "https://connect.sandbox.com/v2/customers",
"url2": "https://connect.sandbox.com/v2/disputes"
}
}
}
},
{
"$ref": "#/components/schemas/CreatedDate"
},
{
"$ref": "#/components/schemas/ModifiedDates"
}
],
"definitions": {
"accountBalance": {
"title": "Account Balance",
"type": "object",
"x-internal": true,
"properties": {
"available": {
"description": "The account's current balance",
"type": "number",
"format": "decimal"
},
"pending": {
"description": "Funds that are not yet available in the balance",
"type": "number",
"format": "decimal"
},
"reserved": {
"description": "Funds reserved as holdings",
"format": "decimal"
},
"currency": {
"description": "The currency of the account",
"allOf": [
{
"$ref": "#/components/schemas/Transaction/allOf/1/properties/currency"
}
]
}
}
}
}
},
"CreatedDate": {
"title": "Created date",
"type": "object",
"x-internal": true,
"properties": {
"createdDate": {
"$ref": "#/components/schemas/DateTime",
"description": "The date the entity was created."
}
}
},
"Customer": {
"title": "Commerce: Customer",
"description": "When a customer places an order with the connected commerce store their details are added to the Customers dataset. You can use the data from the Customers endpoints to calculate key metrics, such as customer churn.\n\nExplore our [data coverage](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-customers) for this data type.",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Order/allOf/0"
},
{
"type": "object",
"properties": {
"customerName": {
"type": "string",
"description": "Name of the customer",
"example": "Fred Smith"
},
"emailAddress": {
"type": "string",
"description": "Email address of the customer",
"example": "fred.smith@myCompany.com"
},
"phone": {
"$ref": "#/components/schemas/PhoneNumber/properties/number"
},
"defaultCurrency": {
"allOf": [
{
"description": "Default currency of any transactional data for the customer, \nfor example, orders or payments\n"
},
{
"$ref": "#/components/schemas/Transaction/allOf/1/properties/currency"
}
]
},
"addresses": {
"type": "array",
"description": "Addresses of the customer",
"items": {
"$ref": "#/components/schemas/Address"
}
},
"note": {
"type": "string",
"description": "Any additional information about the customer"
}
}
},
{
"$ref": "#/components/schemas/CreatedDate"
},
{
"$ref": "#/components/schemas/ModifiedDates"
}
],
"definitions": {
"commerceCustomerRef": {
"type": "object",
"description": "Reference to the customer that placed the order.",
"properties": {
"id": {
"description": "The unique identitifer of the customer being referenced",
"type": "string",
"examples": [
"13d946f0-c5d5-42bc-b092-97ece17923ab",
"9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2",
7110701885,
"EILBDVJVNUAGVKRQ"
]
},
"name": {
"description": "Name of the customer being referenced.",
"type": "string"
}
},
"required": [
"id"
]
}
},
"examples": [
{
"customers": [
{
"id": "15",
"customerName": "Daffy Duck",
"emailAddress": "d.duck@warnerbros.com",
"defaultCurrency": "GBP",
"phone": "(877) 492-8687",
"addresses": [
{
"type": "billing",
"line1": "301 Duck Pond",
"line2": "28 Green Street",
"city": "London",
"region": "England",
"country": "United Kingdom",
"postalCode": "WX1X 0BE"
},
{
"type": "delivery",
"line1": "Bread Street",
"line2": "Bird Avenue",
"city": "Paris",
"region": "France",
"country": "France",
"postalCode": "WDF 123"
}
],
"note": "Regular customer",
"createdDate": "0001-01-01T00:00:00",
"modifiedDate": null,
"sourceModifiedDate": "2020-09-15T23:52:28"
},
{
"id": "18",
"customerName": "Tasmanian Devil",
"emailAddress": "t.devil@warnerbros.com",
"defaultCurrency": "GBP",
"phone": "+1-202-555-0181",
"addresses": [
{
"type": "billing",
"line1": "101 Fire Rooms",
"line2": "Engine Street",
"city": "London",
"region": "England",
"country": "United Kingdom",
"postalCode": "WC1X 0BE"
}
],
"note": "Handle with care",
"createdDate": "0001-01-01T00:00:00",
"modifiedDate": null,
"sourceModifiedDate": "2020-04-16T02:41:52"
},
{
"id": "a99f5e0c-a4db-452f-8d2c-8fd15482b384",
"customerName": "Bugs Bunny",
"emailAddress": "b.bunny@warnerbros.com",
"defaultCurrency": "GBP",
"phone": "",
"addresses": [
{
"type": "billing",
"line1": "301 Carrot Street",
"line2": "Orange Town",
"city": "Yorkshire",
"region": "England",
"country": "United Kingdom",
"postalCode": "WF1X 0BE"
},
{
"type": "delivery",
"line1": "424 Field Street",
"line2": "The Meadow",
"city": "Paris",
"region": "France",
"country": "France",
"postalCode": "WDF 123"
}
],
"note": "Regular customer",
"createdDate": "0001-01-01T00:00:00",
"modifiedDate": null,
"sourceModifiedDate": "2020-08-12T14:37:37"
}
]
}
]
},
"Customers": {
"title": "Commerce: Customers",
"x-internal": true,
"allOf": [
{
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Customer"
}
}
}
},
{
"$ref": "#/components/schemas/PagingInfo"
}
]
},
"DateTime": {
"title": "Date time",
"type": "string",
"examples": [
"2022-10-23T00:00:00.000Z",
"2022-10-23T00:00:00.000Z"
],
"description": "In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:\n\n```\n2020-10-08T22:40:50Z\n2021-01-01T00:00:00\n```\n\n\n\nWhen syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:\n\n- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`\n- Unqualified local time: `2021-11-15T01:00:00`\n- UTC time offsets: `2021-11-15T01:00:00-05:00`\n\n> Time zones\n> \n> Not all dates from Codat will contain information about time zones. \n> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced."
},
"Dispute": {
"title": "Commerce: Dispute",
"description": "A customer may file a payment dispute with their bank or other card issuer when they're unsatisfied with their purchase or believe they have been charged incorrectly. For example: \n- They didn't receive an order. \n- The product they received was different to the commerce store's description. \n- They've been the victim of online fraud. \n\nYou can use data from the Disputes endpoints to calculate key metrics, such as the number of chargebacks.\n\nExplore our [data coverage](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-disputes) for this data type.",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Order/allOf/0"
},
{
"type": "object",
"required": [
"currency"
],
"properties": {
"disputedTransactions": {
"description": "Link to the source event(s) which triggered this transaction.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Transaction/definitions/transactionSourceRef"
}
},
"totalAmount": {
"description": "Total transaction amount that is under dispute.",
"format": "decimal",
"examples": [
194.12,
-283.56,
0
]
},
"currency": {
"description": "Currency of the disputed transaction.",
"$ref": "#/components/schemas/Transaction/allOf/1/properties/currency"
},
"status": {
"$ref": "#/components/schemas/Dispute/definitions/disputeStatus"
},
"reason": {
"description": "Reason for the dispute",
"type": "string",
"examples": [
"Unhappy with product"
]
},
"dueDate": {
"description": "Date when the next action in the dispute resolution is due",
"$ref": "#/components/schemas/DateTime"
}
}
},
{
"$ref": "#/components/schemas/CreatedDate"
},
{
"$ref": "#/components/schemas/ModifiedDates"
}
],
"definitions": {
"disputeStatus": {
"description": "Current status of the dispute",
"x-internal": true,
"type": "string",
"enum": [
"Won",
"Lost",
"Accepted",
"Processing",
"ChargeRefunded",
"EvidenceRequired",
"InquiryEvidenceRequired",
"InquiryProcessing",
"InquiryClosed",
"WaitingThirdParty",
"Unknown"
],
"example": "EvidenceRequired"
}
},
"examples": [
{
"id": "03e608e3-bd1c-454f-8c2b-fb0133e43b95",
"disputedTransactions": [
{
"id": "e63ad857-7e12-4e64-9185-cdfd7c45d09d",
"type": "Order"
}
],
"totalAmount": -47.66,
"currency": "GBP",
"status": "InquiryEvidenceRequired",
"reason": "Unhappy with product",
"dueDate": "2021-03-29T14:39:55",
"createdDate": "2021-03-22T14:39:55",
"modifiedDate": "2022-02-02T11:02:45Z",
"sourceModifiedDate": "2021-03-22T14:39:55"
}
]
},
"Disputes": {
"title": "Commerce: Disputes",
"x-internal": true,
"allOf": [
{
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Dispute"
}
}
}
},
{
"$ref": "#/components/schemas/PagingInfo"
}
]
},
"ErrorMessage": {
"title": "Error message",
"type": "object",
"x-internal": true,
"properties": {
"statusCode": {
"type": "integer",
"description": "The HTTP status code returned by the error."
},
"service": {
"type": "string",
"description": "Codat's service the returned the error."
},
"error": {
"type": "string",
"description": "A brief description of the error."
},
"correlationId": {
"type": "string",
"description": "Unique identifier used to propagate to all downstream services and determine the source of the error."
},
"validation": {
"$ref": "#/components/schemas/ErrorMessage/definitions/errorValidation"
},
"canBeRetried": {
"type": "string",
"description": "`True` if the error occurred transiently and can be retried."
},
"detailedErrorCode": {
"type": "integer",
"description": "Machine readable error code used to automate processes based on the code returned."
}
},
"definitions": {
"errorValidation": {
"title": "Validation error",
"type": "object",
"nullable": true,
"description": "A human-readable object describing validation decisions Codat has made. If an operation has failed because of validation errors, they will be detailed here.",
"properties": {
"errors": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/ErrorMessage/definitions/errorValidationItem"
}
},
"warnings": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/ErrorMessage/definitions/errorValidationItem"
}
}
}
},
"errorValidationItem": {
"title": "Validation error item",
"type": "object",
"properties": {
"itemId": {
"type": "string",
"nullable": true,
"description": "Unique identifier for a validation item."
},
"message": {
"type": "string",
"nullable": true,
"description": "A message outlining validation item's issue."
},
"validatorName": {
"type": "string",
"nullable": true,
"description": "Name of validator."
}
}
}
}
},
"Location": {
"title": "Commerce: Location",
"type": "object",
"description": "The Location datatype holds information on the geographic location at which stocks of products may be held, as referenced in the Products data type.\n\nA Location also holds information on geographic locations where orders were placed, as referenced in the Orders data type.\n\nExplore our [data coverage](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-locations) for this data type.",
"allOf": [
{
"$ref": "#/components/schemas/Order/allOf/0"
},
{
"type": "object",
"properties": {
"name": {
"description": "Name of this location",
"type": "string"
},
"address": {
"description": "Address associated with the location",
"$ref": "#/components/schemas/Address"
}
}
},
{
"$ref": "#/components/schemas/ModifiedDates"
}
],
"definitions": {
"locationRef": {
"type": "object",
"description": "Reference to the geographic location where the order was placed.",
"properties": {
"id": {
"description": "The unique identitifer of the location being referenced.",
"type": "string",
"examples": [
"13d946f0-c5d5-42bc-b092-97ece17923ab",
"9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2",
7110701885,
"EILBDVJVNUAGVKRQ"
]
},
"name": {
"description": "Name of the location being referenced.",
"type": "string"
}
},
"required": [
"id"
]
}
},
"examples": [
{
"id": "15",
"name": "London Warehouse",
"address": {
"type": "Inventory",
"line1": "Warner House",
"line2": "98 Theobald's Road",
"city": "London",
"region": "",
"country": "United Kingdom",
"postalCode": "WC1X 8WB"
},
"modifiedDate": "2020-08-12T14:37:37",
"sourceModifiedDate": "2020-08-12T14:37:37"
}
]
},
"Locations": {
"title": "Commerce: Locations",
"x-internal": true,
"allOf": [
{
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Location"
}
}
}
},
{
"$ref": "#/components/schemas/PagingInfo"
}
]
},
"ModifiedDates": {
"title": "Modified dates",
"x-internal": true,
"allOf": [
{
"title": "ModifiedDate",
"x-internal": true,
"type": "object",
"properties": {
"modifiedDate": {
"allOf": [
{
"$ref": "#/components/schemas/DateTime"
},
{
"description": "The date when the record was last fetched from the data source and updated in Codat’s data cache. \n\nUse it to identify and retrieve records that have changed since your last fetch. For example, filtering `modifiedDate` to today will provide new records updated in Codat today.\n\nThis date is populated for all data types except for attachments, balance sheets, company information, and profit & loss reports ([read more](https://docs.codat.io/using-the-api/modified-dates#modified-date)).\n\nIn Codat's data model, dates and times are represented using the ISO 8601 standard."
}
]
}
}
},
{
"title": "Source Modified Date",
"x-internal": true,
"type": "object",
"nullable": true,
"properties": {
"sourceModifiedDate": {
"allOf": [
{
"$ref": "#/components/schemas/DateTime"
},
{
"description": "The date when a record was last modified in the source platform, usually by the business or a business process. For example, when payments are made against an invoice. \n\nIt is not populated ([read more](https://docs.codat.io/using-the-api/modified-dates#source-modified-date)) when:\n - Pulling attachments\n - The integration platform does not provide modification dates for a data type\n - A record has been deleted from the source platform and Codat doesn't have a record of when the deletion occurred\n - A record has been voided. For certain platforms that soft delete records, `isDeleted` metadata is used to identify void records\n\nIn Codat's data model, dates and times are represented using the ISO 8601 standard."
}
]
}
}
}
]
},
"Order": {
"title": "Commerce: Order",
"description": "Orders contain the transaction details for all products sold by the company, and include details of any payments, service charges, or refunds related to each order. You can use data from the Orders endpoints to calculate key metrics, such as gross sales values and monthly recurring revenue (MRR).\n\nExplore our [data coverage](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-orders) for this data type.\n",
"allOf": [
{
"type": "object",
"x-stoplight": {
"id": "516bf0ecc4907"
},
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "A unique, persistent identifier for this record",
"examples": [
"13d946f0-c5d5-42bc-b092-97ece17923ab",
"9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2",
7110701885,
"EILBDVJVNUAGVKRQ"
],
"x-codat-validation": [
{
"validator": "UniqueWithinConnection"
}
]
}
}
},
{
"properties": {
"orderNumber": {
"type": "string",
"description": "Friendly reference for the order in the commerce or point of sale platform."
},
"country": {
"description": "The Codat country property is returned as it was provided in the underlying platform by the company without any formatting on our part.\n\nDepending on the platform the value of this property will either be an ISO 3166 code (2-alpha or 3-alpha) or free-form text returned as a string name in our model. \n\nFor POST operations against platforms that demand a specific format for the country code, we have documented accepted values in the [options](https://docs.codat.io/codat-api#/operations/get-companies-companyId-connections-connectionId-push) endpoint.",
"type": "string",
"format": "ISO3166 Alpha-3",
"examples": [
"GBR",
"USA",
"ABW"
]
},
"currency": {
"allOf": [
{
"$ref": "#/components/schemas/Transaction/allOf/1/properties/currency"
},
{
"description": "Currency in which the order was placed."
}
]
},
"closedDate": {
"$ref": "#/components/schemas/DateTime",
"description": "Date on which order was closed after the product was shipped, paid for, and any refund period had elapsed."
},
"totalAmount": {
"description": "Total amount of the order, including discounts, refunds, and tax, but excluding gratuities.",
"type": "number",
"format": "decimal"
},
"totalRefund": {
"description": "Total amount of any refunds issued on the order, including discounts and tax, but excluding gratuities. This is always negative.",
"type": "number",
"format": "decimal"
},
"totalTaxAmount": {
"description": "Total amount of tax applied to the order.",
"type": "number",
"format": "decimal"
},
"totalDiscount": {
"description": "Total amount of any discounts applied to the order, excluding tax. This is typically positive (for discounts which decrease the amount of the order), but can also be negative (for discounts which increase the amount of the order).",
"type": "number",
"format": "decimal"
},
"totalGratuity": {
"description": "Extra amount added to the order.",
"type": "number",
"format": "decimal"
},
"orderLineItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Order/definitions/orderLineItem"
}
},
"payments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Payment/definitions/paymentRef"
}
},
"serviceCharges": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Order/definitions/serviceCharge"
}
},
"locationRef": {
"$ref": "#/components/schemas/Location/definitions/locationRef"
},
"customerRef": {
"$ref": "#/components/schemas/Customer/definitions/commerceCustomerRef"
},
"supplementalData": {
"$ref": "#/components/schemas/SupplementalData"
}
}
},
{
"$ref": "#/components/schemas/CreatedDate"
},
{
"$ref": "#/components/schemas/ModifiedDates"
}
],
"definitions": {
"orderLineItem": {
"allOf": [
{
"$ref": "#/components/schemas/Order/allOf/0"
},
{
"type": "object",
"properties": {
"quantity": {
"type": "number",
"format": "decimal",
"description": "Number of units of the product sold.\nFor refunds, quantity is negative.\n"
},
"taxPercentage": {
"type": "number",
"format": "decimal",
"description": "Percentage rate (from 0 to 100) of any sales tax applied to the unit price.",
"examples": [
0,
12.5,
"45.00"
]
},
"totalAmount": {
"type": "number",
"format": "decimal",
"description": "Total amount of the line item, including discounts and tax."
},
"totalTaxAmount": {
"type": "number",
"format": "decimal",
"description": "Total amount of tax applied to the line item, factoring in any discounts."
},
"unitPrice": {
"type": "number",
"format": "decimal",
"description": "Price per unit of goods or services, excluding discounts and tax."
},
"taxes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaxComponent/definitions/taxComponentAllocation"
},
"description": "Taxes breakdown as applied to order lines."
},
"productRef": {
"$ref": "#/components/schemas/Product/definitions/productRef"
},
"productVariantRef": {
"$ref": "#/components/schemas/Product/definitions/productVariantRef"
},
"discountAllocations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Order/definitions/orderDiscountAllocation"
}
}
}
}
]
},
"serviceCharge": {
"type": "object",
"properties": {
"description": {
"description": "Service charges for this order.",
"type": "string",
"example": "A service charge"
},
"totalAmount": {
"description": "Total amount of the service charge, including tax.",
"type": "number",
"format": "decimal",
"examples": [
0,
12.5,
45
]
},
"taxPercentage": {
"description": "Percentage rate (from 0 to 100) of any tax applied to the service charge.",
"type": "number",
"format": "decimal",
"examples": [
0,
12.5,
45
]
},
"taxAmount": {
"description": "Amount of the service charge that is tax.",
"type": "number",
"format": "decimal",
"examples": [
0,
12.5,
45
]
},
"taxes": {
"description": "Taxes breakdown as applied to service charges.",
"type": "array",
"items": {
"$ref": "#/components/schemas/TaxComponent/definitions/taxComponentAllocation"
}
},
"quantity": {
"description": "The number of times the charge is charged.",
"type": "integer",
"examples": [
1,
12,
45
]
},
"type": {
"$ref": "#/components/schemas/Order/definitions/serviceChargeType"
}
}
},
"serviceChargeType": {
"description": "The type of the service charge.",
"type": "string",
"enum": [
"Generic",
"Shipping",
"Overpayment",
"Unknown"
],
"example": "Overpayment"
},
"orderDiscountAllocation": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the discount in the commerce or point of sale platform.",
"example": "Promotional Discount"
},
"totalAmount": {
"type": "number",
"format": "decimal",
"description": "Total amount of discount applied, excluding tax. This is typically positive (for discounts which decrease the amount of the order line), but can also be negative (for discounts which increase the amount of the order line).",
"example": 15.25
}
}
}
},
"examples": [
{
"id": "01e63721-1205-478e-8503-9d8bf8a93f44",
"orderNumber": "99123956",
"country": "CAN",
"currency": "CAD",
"createdDate": "2021-03-28T03:00:14",
"totalAmount": 12,
"totalRefund": 0,
"totalTaxAmount": 2,
"totalDiscount": 0,
"totalGratuity": 1,
"orderLineItems": [
{
"id": "116113a6-54d3-4624-ba73-26a77a5ffd51",
"quantity": 1,
"taxPercentage": 20,
"totalAmount": 12,
"totalTaxAmount": 2,
"unitPrice": 10,
"taxes": [
{
"taxComponentRef": {
"id": "72",
"name": "Sales Tax"
},
"taxAmount": ""
},
{
"taxComponentRef": {
"id": "72",
"name": "City Tax"
},
"taxAmount": ""
}
],
"productRef": {
"id": "ac186646-41f2-4280-afea-1012c59459ab",
"name": "Intelligent Concrete Salad"
},
"productVariantRef": {
"id": "f9ca9de5-9e31-460d-ac81-368f4e7c8fc0",
"name": "Small Incredible Wooden Soap"
},
"discountAllocations": []
}
],
"payments": [
{
"id": "defdceb6-83a3-4b7d-a74e-e9ef947d5f48",
"amount": 12,
"currency": "CAD",
"type": "Paypal",
"status": "Unknown",
"dueDate": "2021-04-04T03:00:14",
"createdDate": "2021-03-28T03:00:14",
"modifiedDate": "2022-02-02T11:02:45"
}
],
"serviceCharges": [
{
"description": "Service Charge",
"totalAmount": 1.2,
"taxPercentage": 20,
"taxAmount": 0.2,
"taxes": [
{
"taxComponentRef": {
"id": "72",
"name": "Service Tax"
},
"taxAmount": ""
}
],
"quantity": 1,
"type": "Generic"
}
],
"locationRef": {
"id": "47bbffc7-c045-4b0f-a3bb-ecf1f669edfa"
},
"customerRef": {
"id": "2634d180-7205-43f0-a73d-84af6443a005",
"name": "Emmy Roberts"
},
"modifiedDate": "2022-02-02T11:02:45Z",
"sourceModifiedDate": "2021-03-28T03:00:14"
}
],
"type": "object"
},
"Orders": {
"title": "Commerce: Orders",
"x-internal": true,
"allOf": [
{
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Order"
}
}
}
},
{
"$ref": "#/components/schemas/PagingInfo"
}
]
},
"PagingInfo": {
"type": "object",
"title": "Pagination information",
"x-internal": true,
"properties": {
"pageNumber": {
"type": "integer",
"description": "Current page number."
},
"pageSize": {
"type": "integer",
"description": "Number of items to return in results array.",
"maximum": 2000
},
"totalResults": {
"type": "integer",
"description": "Total number of items."
},
"_links": {
"$ref": "#/components/schemas/PagingInfo/definitions/links"
}
},
"definitions": {
"links": {
"title": "Hal Links",
"type": "object",
"required": [
"self",
"current"
],
"properties": {
"self": {
"$ref": "#/components/schemas/PagingInfo/definitions/halRef"
},
"current": {
"$ref": "#/components/schemas/PagingInfo/definitions/halRef"
},
"next": {
"$ref": "#/components/schemas/PagingInfo/definitions/halRef"
},
"previous": {
"$ref": "#/components/schemas/PagingInfo/definitions/halRef"
}
},
"examples": [
{
"self": {
"href": "/companies"
},
"current": {
"href": "/companies?page=1&pageSize=10"
}
}
]
},
"halRef": {
"title": "Hypertext reference",
"type": "object",
"properties": {
"href": {
"type": "string",
"format": "uri-reference",
"description": "Uri hypertext reference."
}
}
}
},
"required": [
"pageNumber",
"pageSize",
"totalResults",
"_links"
],
"examples": [
{
"pageNumber": 1,
"pageSize": 10,
"totalResults": 1,
"_links": {
"self": {
"href": "/companies/{id}/data/{dataType}"
},
"current": {
"href": "/companies/{id}/data/{dataType}?page=1&pageSize=10"
}
}
}
]
},
"Payment": {
"title": "Commerce: Payment",
"description": "Payments contain details of all payments made by customers to a company, including: amounts, currency used, payment method, payment provider, and payment status.\n\nRefunds are recorded as separate, negative payments. Note that a refund can only occur in relation to a payment that has been completed (i.e. has a status of `Paid`). When a customer cancels an order _before_ a payment has been completed, the payment shows as `Cancelled`.\n\nYou can use data from the Payments endpoints to calculate key metrics, such as gross sales and monthly recurring revenue (MRR).\n\nExplore our [data coverage](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-payments) for this data type.",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Order/allOf/0"
},
{
"type": "object",
"properties": {
"amount": {
"type": "number",
"format": "decimal",
"description": "Payment Amount (including gratuity)",
"examples": [
194.12,
-283.56,
0
]
},
"currency": {
"$ref": "#/components/schemas/Transaction/allOf/1/properties/currency",
"description": "Currency in which the payment was made"
},
"paymentMethodRef": {
"$ref": "#/components/schemas/PaymentMethodRef"
},
"status": {
"$ref": "#/components/schemas/Payment/definitions/paymentStatus"
},
"paymentProvider": {
"type": "string",
"description": "Service provider of the payment, if applicable.",
"examples": [
"Amazon Pay",
"Checkout.com",
"SagePay"
]
},
"dueDate": {
"description": "Date by which payment must be made",
"$ref": "#/components/schemas/DateTime"
},
"supplementalData": {
"$ref": "#/components/schemas/SupplementalData"
}
}
},
{
"$ref": "#/components/schemas/CreatedDate"
},
{
"$ref": "#/components/schemas/ModifiedDates"
}
],
"definitions": {
"paymentStatus": {
"type": "string",
"x-internal": true,
"description": "Status of the payment.",
"enum": [
"Pending",
"Authorized",
"Paid",
"Failed",
"Cancelled",
"Unknown"
]
},
"paymentType": {
"type": "string",
"x-internal": true,
"nullable": true,
"description": "Type of payment.",
"enum": [
"Cash",
"Card",
"Invoice",
"OnlineCard",
"Swish",
"Vipps",
"Mobile",
"StoreCredit",
"Paypal",
"Custom",
"Prepaid",
"Unknown"
],
"example": "Cash"
},
"paymentRef": {
"x-internal": true,
"allOf": [
{
"$ref": "#/components/schemas/Order/allOf/0"
},
{
"type": "object",
"properties": {
"amount": {
"type": "number",
"format": "decimal",
"nullable": true,
"description": "Payment Amount (including gratuity).",
"examples": [
194.12,
-283.56,
0
]
},
"currency": {
"$ref": "#/components/schemas/Transaction/allOf/1/properties/currency",
"description": "Currency in which the payment was made."
},
"type": {
"$ref": "#/components/schemas/Payment/definitions/paymentType"
},
"status": {
"$ref": "#/components/schemas/Payment/definitions/paymentStatus"
},
"paymentProvider": {
"type": "string",
"description": "Service provider of the payment, if applicable.",
"examples": [
"Amazon Pay",
"Checkout.com",
"SagePay"
]
},
"dueDate": {
"description": "Date by which payment must be made",
"$ref": "#/components/schemas/DateTime"
}
}
},
{
"$ref": "#/components/schemas/CreatedDate"
},
{
"$ref": "#/components/schemas/ModifiedDates"
}
]
}
}
},
"PaymentMethod": {
"title": "Commerce: Payment method",
"description": "A Payment Method represents the payment method(s) used to make payments.\n\nExplore our [data coverage](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-paymentMethods) for this data type.",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Order/allOf/0"
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the PaymentMethod",
"example": "Alipay"
},
"status": {
"description": "Status of the Payment Method.",
"x-internal": true,
"type": "string",
"enum": [
"Unknown",
"Active",
"Archived"
]
}
}
},
{
"$ref": "#/components/schemas/ModifiedDates"
}
]
},
"PaymentMethodRef": {
"type": "object",
"title": "Payment method reference",
"description": "The payment method the record is linked to in the accounting or commerce software.",
"properties": {
"id": {
"description": "The unique identifier of the location being referenced.",
"type": "string"
},
"name": {
"description": "Name of the location being referenced.",
"type": "string"
}
},
"required": [
"id"
],
"example": {
"id": "EILBDVJVNUAGVKRQ",
"name": "AliPay"
}
},
"PaymentMethods": {
"title": "Commerce: Payment methods",
"x-internal": true,
"allOf": [
{
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentMethod"
}
}
}
},
{
"$ref": "#/components/schemas/PagingInfo"
}
]
},
"Payments": {
"title": "Commerce: Payments",
"x-internal": true,
"allOf": [
{
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Payment"
}
}
}
},
{
"$ref": "#/components/schemas/PagingInfo"
}
]
},
"PhoneNumber": {
"title": "Phone",
"type": "object",
"x-internal": true,
"properties": {
"number": {
"type": "string",
"nullable": true,
"examples": [
"+44 25691 154789",
"(877) 492-8687",
"01224 658 999"
],
"description": "A phone number."
},
"type": {
"$ref": "#/components/schemas/PhoneNumber/definitions/phoneNumberType"
}
},
"required": [
"type"
],
"definitions": {
"phoneNumberType": {
"description": "The type of phone number",
"type": "string",
"enum": [
"Primary",
"Landline",
"Mobile",
"Fax",
"Unknown"
]
}
}
},
"Product": {
"title": "Commerce: Product",
"description": "A Product is an item in the company's inventory, and includes information about the price and quantity of all products, and variants thereof, available for sale.\n\nExplore our [data coverage](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-products) for this data type.\n",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Order/allOf/0"
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the product in the commerce or POS system",
"examples": [
"Hard Drive",
"Windows Installation",
"Software Support (Hourly)"
]
},
"description": {
"type": "string",
"description": "Description of the product recorded in the commerce or point of sale platform.",
"examples": [
"1tb Western Digital Hard Drive",
"Install of Windows 11 (Professional Edition)",
"1 hour of support from an agent (phone or remote)"
]
},
"categorization": {
"type": "string",
"description": "Retail category that the product is assigned to e.g. `Hardware`.",
"examples": [
"Hardware",
"Software",
"Support Services"
]
},
"isGiftCard": {
"type": "boolean",
"description": "Whether the product represents a gift card or voucher that\ncan be redeemed in the commerce or POS platform.\n"
},
"variants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Product/definitions/productVariant"
}
},
"supplementalData": {
"$ref": "#/components/schemas/SupplementalData"
}
}
}
],
"definitions": {
"productRef": {
"type": "object",
"description": "Reference that links the line item to the correct product details.",
"properties": {
"id": {
"description": "The unique identifier of the product being referenced.",
"type": "string",
"examples": [
"13d946f0-c5d5-42bc-b092-97ece17923ab",
"9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2",
7110701885,
"EILBDVJVNUAGVKRQ"
]
},
"name": {
"description": "Name of the product being referenced.",
"type": "string"
}
},
"required": [
"id"
]
},
"productVariant": {
"title": "Product Variant",
"description": "Represents a variation of a product available for sale, for example an item of clothing that may be available for sale in multiple sizes and colors.\n",
"allOf": [
{
"$ref": "#/components/schemas/Order/allOf/0",
"description": "Identifier of the product variant, unique to the company."
},
{
"properties": {
"name": {
"type": "string",
"examples": [
"Red Coat",
"Black Coat",
"Large Brown Hat"
],
"description": "Name of the product recorded in the commerce or point of sale platform."
},
"isTaxEnabled": {
"type": "boolean",
"description": "Whether sales taxes are enabled for this product variant."
},
"sku": {
"type": "string",
"examples": [
"Coat-Red-Lrg",
"Coat-Black-Md",
"LargeBrownHat",
"A725BA2"
],
"description": "SKU (stock keeping unit) of the variant, as defined by the merchant."
},
"barcode": {
"type": "string",
"examples": [
"564158468416486458646886484",
"CSE370"
],
"description": "Unique product number of the variant. This might be a barcode, UPC, ISBN, etc."
},
"unitOfMeasure": {
"type": "string",
"examples": [
"kg",
"m",
"meters"
],
"description": "Unit of measure for the variant, such as `kg` or `meters`."
},
"vatPercentage": {
"type": "number",
"format": "decimal",
"examples": [
12.5,
0,
20
],
"description": "VAT rate for the product variant if sales taxes are enabled."
},
"prices": {
"type": "array",
"description": "Prices for the product variants in different currencies.",
"items": {
"$ref": "#/components/schemas/Product/definitions/productPrice"
}
},
"inventory": {
"$ref": "#/components/schemas/Product/definitions/productInventory"
},
"shippingRequired": {
"type": "boolean",
"description": "Indicates whether or not the product requires physical delivery."
},
"status": {
"$ref": "#/components/schemas/Product/definitions/productVariantStatus"
}
}
},
{
"$ref": "#/components/schemas/CreatedDate"
},
{
"$ref": "#/components/schemas/ModifiedDates"
}
]
},
"productVariantRef": {
"title": "Product variant reference",
"type": "object",
"description": "Reference that links the line item to the specific version of product that has been ordered.",
"properties": {
"id": {
"description": "The unique identifier of the product variant being referenced.",
"type": "string",
"examples": [
"13d946f0-c5d5-42bc-b092-97ece17923ab",
"9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2",
7110701885,
"EILBDVJVNUAGVKRQ"
]
},
"name": {
"description": "Name of the product variant being referenced.",
"type": "string"
}
},
"required": [
"id"
]
},
"productPrice": {
"title": "Product Price Variant",
"x-internal": true,
"type": "object",
"properties": {
"currency": {
"$ref": "#/components/schemas/Transaction/allOf/1/properties/currency",
"nullable": true
},
"unitPrice": {
"type": "number",
"format": "decimal",
"description": "The product variant's unit price."
}
}
},
"productInventory": {
"title": "Product Inventory",
"description": "Information about the total inventory as well as the locations inventory is in.",
"x-internal": true,
"type": "object",
"properties": {
"totalQuantity": {
"type": "number",
"format": "decimal",
"nullable": true,
"description": "The total quantity of stock remaining across locations."
},
"locations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Product/definitions/productInventoryLocation"
}
}
}
},
"productInventoryLocation": {
"title": "Product Inventory Location",
"x-internal": true,
"type": "object",
"properties": {
"quantity": {
"type": "number",
"format": "decimal",
"description": "The quantity of stock remaining at location."
},
"locationRef": {
"$ref": "#/components/schemas/Location/definitions/locationRef"
}
}
},
"productVariantStatus": {
"x-internal": true,
"type": "string",
"description": "The status of the product variant.",
"enum": [
"Unknown",
"Published",
"Unpublished"
]
}
}
},
"ProductCategories": {
"title": "Commerce: Product categories",
"x-internal": true,
"allOf": [
{
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductCategory"
}
}
}
},
{
"$ref": "#/components/schemas/PagingInfo"
}
]
},
"ProductCategory": {
"title": "Commerce: Product category",
"description": "Product categories are used to classify a group of products together, either by type (e.g. \"Furniture\"), or sometimes by tax profile.\n\nExplore our [data coverage](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-productCategories) for this data type.",
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "\"102\"",
"description": "The unique identifier of the product category"
},
"name": {
"type": "string",
"example": "Entertainment",
"description": "The name of the product category"
},
"ancestorRefs": {
"type": "array",
"description": "A collection of parent product categories implicitly ordered with the immediate parent last in the list.",
"items": {
"$ref": "#/components/schemas/RecordRef"
}
},
"hasChildren": {
"type": "boolean",
"description": "A boolean indicating whether there are other product categories beneath this one in the hierarchy."
}
}
},
{
"$ref": "#/components/schemas/ModifiedDates"
}
],
"examples": [
{
"productCategories": [
{
"id": "100",
"name": "Entertainment",
"ancestorRefs": [],
"hasChildren": true,
"modifiedDate": "2022-01-01T12:00:00Z",
"sourceModifiedDate": "2021-10-01T12:53:21Z"
},
{
"id": "101",
"name": "Cinema",
"ancestorRefs": [
{
"id": "100",
"name": "Entertainment"
}
],
"hasChildren": true,
"modifiedDate": "2022-01-01T12:00:00Z",
"sourceModifiedDate": "2021-10-01T12:55:02Z"
},
{
"id": "102",
"name": "Movie",
"ancestorRefs": [
{
"id": "100",
"name": "Entertainment"
},
{
"id": "101",
"name": "Cinema"
}
],
"hasChildren": false,
"modifiedDate": "2022-01-01T12:00:00Z",
"sourceModifiedDate": "2021-12-25T12:00:00Z"
}
]
}
]
},
"Products": {
"title": "Commerce: Products",
"x-internal": true,
"allOf": [
{
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Product"
}
}
}
},
{
"$ref": "#/components/schemas/PagingInfo"
}
]
},
"RecordRef": {
"title": "Record Ref",
"x-internal": true,
"type": "object",
"properties": {
"id": {
"description": "The unique identitifer of the record being referenced",
"type": "string",
"examples": [
"13d946f0-c5d5-42bc-b092-97ece17923ab",
"9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2",
7110701885,
"EILBDVJVNUAGVKRQ"
]
},
"type": {
"description": "The type of record being referenced.",
"type": "string"
}
},
"required": [
"id",
"type"
],
"description": ""
},
"SupplementalData": {
"title": "Supplemental data",
"type": "object",
"x-internal": true,
"description": "Supplemental data is additional data you can include in our standard data types. \n\nIt is referenced as a configured dynamic key value pair that is unique to the accounting software. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data.",
"properties": {
"content": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": true
},
"nullable": true
}
}
},
"TaxComponent": {
"title": "Commerce: Tax component",
"description": "The Tax Components endpoints return tax rates data from the commerce software, including tax rate names and values. This is to support the mapping of tax rates from the commerce software to those in the accounting software.\n\nExplore our [data coverage](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-disputes) for this data type.",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Order/allOf/0"
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the Tax Rate Component in the source commerce software.",
"example": "Sales Tax"
},
"rate": {
"description": "Rate of taxation represented as a fraction of the net price (typically in the range 0.00 - 1.00).",
"type": "number",
"format": "decimal",
"examples": [
0.15,
0.2
]
},
"isCompound": {
"description": "The Boolean flag to indicate when a Tax Rate Component compounds on a sale.",
"type": "boolean",
"examples": [
true,
false
]
}
}
},
{
"$ref": "#/components/schemas/ModifiedDates",
"required": [
"name"
]
}
],
"definitions": {
"taxComponentAllocation": {
"title": "Tax Component Allocation",
"type": "object",
"properties": {
"taxComponentRef": {
"$ref": "#/components/schemas/TaxComponent/definitions/taxComponentRef"
},
"rate": {
"description": "Tax amount on order line sale as available from source commerce software.",
"type": "number",
"format": "decimal",
"nullable": true
}
}
},
"taxComponentRef": {
"type": "object",
"description": "Taxes rates reference object depending on the rates being available on source commerce software.",
"properties": {
"id": {
"description": "The unique identitifer of the tax component being referenced.",
"type": "string",
"examples": [
"13d946f0-c5d5-42bc-b092-97ece17923ab",
"9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2",
7110701885,
"EILBDVJVNUAGVKRQ"
]
},
"name": {
"description": "Name of the tax component being referenced.",
"type": "string"
}
},
"required": [
"id",
"name"
]
}
},
"examples": [
{
"id": "13d946f0-c5d5-42bc-b092-97ece17923ab",
"name": "Sales Tax (15%)",
"rate": 0.15,
"isCompound": true,
"modifiedDate": "2022-10-23T00:00:00Z",
"sourceModifiedDate": "2022-10-23T00:00:00Z"
}
]
},
"TaxComponents": {
"title": "Commerce: Tax components",
"x-internal": true,
"allOf": [
{
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaxComponent"
}
}
}
},
{
"$ref": "#/components/schemas/PagingInfo"
}
]
},
"Transaction": {
"title": "Commerce: Transaction",
"description": "Details of all financial transactions recorded in the commerce or point of sale system are added to the Transactions data type. For example, payments, service charges, and fees.\n\nYou can use data from the Transactions endpoints to calculate key metrics, such as: \n- Transaction volumes \n- Average transaction volume \n- Average transaction value \n- Returns \n- Payouts\n\nExplore our [data coverage](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-transactions) for this data type.",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Order/allOf/0"
},
{
"type": "object",
"properties": {
"totalAmount": {
"description": "The total transaction amount",
"type": "number",
"format": "decimal",
"examples": [
194.12,
-283.56,
0
]
},
"currency": {
"title": "Currency",
"x-internal": true,
"type": "string",
"description": "The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_.\n\n## Unknown currencies\n\nIn line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction. \n\nThere are only a very small number of edge cases where this currency code is returned by the Codat system.",
"format": "ISO4217",
"examples": [
"GBP",
"USD",
"EUR"
]
},
"type": {
"$ref": "#/components/schemas/Transaction/definitions/transactionType"
},
"subType": {
"description": "Non-standardised transaction type data from the commerce software",
"type": "string",
"examples": [
"CardPayment",
"Invoice payment"
]
},
"transactionSourceRef": {
"description": "Link to the source event which triggered this transaction",
"allOf": [
{
"$ref": "#/components/schemas/Transaction/definitions/transactionSourceRef"
}
]
},
"supplementalData": {
"$ref": "#/components/schemas/SupplementalData"
}
}
},
{
"allOf": [
{
"type": "object",
"x-stoplight": {
"id": "c590b4405180f"
},
"allOf": [
{
"$ref": "#/components/schemas/CreatedDate"
},
{
"type": "object",
"x-stoplight": {
"id": "gdyjg7bg783br"
},
"properties": {
"sourceCreatedDate": {
"$ref": "#/components/schemas/DateTime",
"description": "The date on which this record was created in the originating system"
}
}
}
]
},
{
"$ref": "#/components/schemas/ModifiedDates"
}
],
"x-stoplight": {
"id": "9e815c1766554"
}
}
],
"definitions": {
"transactionSourceRef": {
"title": "Transaction Source Reference",
"x-internal": true,
"allOf": [
{
"$ref": "#/components/schemas/RecordRef"
},
{
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/Transaction/definitions/transactionSourceType"
}
}
}
]
},
"transactionSourceType": {
"x-internal": true,
"type": "string",
"description": "The type of source the transaction arose.",
"enum": [
"Fee",
"Order",
"Payment",
"ServiceCharge",
"Unknown"
]
},
"transactionType": {
"x-internal": true,
"description": "The type of the platform transaction: \n- `Unknown` \n- `FailedPayout` — Failed transfer of funds from the seller's merchant account to their bank account. \n- `Payment` — Credit and debit card payments. \n- `PaymentFee` — Payment provider's fee on each card payment. \n- `PaymentFeeRefund` — Payment provider's fee that has been refunded to the seller. \n- `Payout` — Transfer of funds from the seller's merchant account to their bank account. \n- `Refund` — Refunds to a customer's credit or debit card. \n- `Transfer` — Secure transfer of funds to the seller's bank account. ",
"type": "string",
"enum": [
"Payment",
"Refund",
"Payout",
"FailedPayout",
"Transfer",
"PaymentFee",
"PaymentFeeRefund",
"Unknown"
]
}
},
"examples": []
},
"Transactions": {
"title": "Commerce: Transactions",
"x-internal": true,
"allOf": [
{
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Transaction"
}
}
}
},
{
"$ref": "#/components/schemas/PagingInfo"
}
]
}
},
"parameters": {
"companyId": {
"name": "companyId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "8a210b68-6988-11ed-a1eb-0242ac120002",
"description": "Unique identifier for your SMB in Codat."
},
"description": "Unique identifier for a company."
},
"connectionId": {
"name": "connectionId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "2e9d2c44-f675-40ba-8049-353bfcb5e171",
"description": "Unique identifier for a company's data connection."
},
"description": "Unique identifier for a connection."
},
"page": {
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"minimum": 1,
"example": 1,
"default": 1
},
"description": "Page number. [Read more](https://docs.codat.io/using-the-api/paging)."
},
"pageSize": {
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100,
"example": 100,
"minimum": 1,
"maximum": 5000
},
"description": "Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging)."
},
"productId": {
"name": "productId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"examples": {
"$ref": "#/components/schemas/Order/allOf/0/properties/id/examples"
}
},
"description": "Unique identifier for a product."
},
"query": {
"name": "query",
"in": "query",
"required": false,
"schema": {
"type": "string"
},
"example": "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
"description": "Codat query string. [Read more](https://docs.codat.io/using-the-api/querying)."
},
"orderBy": {
"name": "orderBy",
"in": "query",
"required": false,
"schema": {
"type": "string",
"example": "-modifiedDate"
},
"description": "Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results)."
}
},
"responses": {
"Malformed-Query": {
"description": "Your `query` parameter was not correctly formed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
},
"examples": {
"Malformed query": {
"value": {
"statusCode": 400,
"service": "ClientsApi",
"error": "Error parsing query - Malformed query.",
"correlationId": "bc997528a9d7abb9161ef45f05d38599",
"canBeRetried": "Unknown",
"detailedErrorCode": 0
}
},
"Unresolved property": {
"value": {
"statusCode": 400,
"service": "PullApi",
"error": "Error parsing query - Could not resolve property isCompleted on Dataset",
"correlationId": "98457fb9956b7f9b4b2fd4f6e23bb5c8",
"canBeRetried": "Unknown",
"detailedErrorCode": 0
}
}
}
}
}
},
"Unauthorized": {
"description": "Your API request was not properly authorized.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
},
"examples": {
"Unauthorized": {
"value": {
"statusCode": 401,
"service": "PublicApi",
"error": "Unauthorized",
"correlationId": "7eb40d6b415d7bcd99ce658268284056",
"canBeRetried": "Unknown",
"detailedErrorCode": 0
}
}
}
}
}
},
"Payment-Required": {
"description": "An account limit has been exceeded. The type of limit is described in the error property:\n\n- You have exceeded the 50-company limit that applies to a Free plan. Delete any companies you no longer need and retry the request.\n- The requested sync schedule is not allowed. You requested an hourly sync schedule but this functionality is not included in the Free plan.\n- Your Free account is older than 365 days and has expired. Contact support@codat.io.\n",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
},
"examples": {
"Conflict": {
"value": {
"statusCode": 429,
"service": "PublicApi",
"error": "You have exceeded the 50-company limit that applies to a Free plan. We recommend that you delete any companies you no longer need and retry the request.",
"correlationId": "bc997528a9d7abb9161ef45f05d38599",
"canBeRetried": "Unknown",
"detailedErrorCode": 0
}
}
}
}
}
},
"Forbidden": {
"description": "You are using an outdated API key or a key not associated with that resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
},
"examples": {
"Conflict": {
"value": {
"statusCode": 403,
"service": "PublicApi",
"error": "You are using an outdated API key or a key not associated with that resource.",
"correlationId": "bc997528a9d7abb9161ef45f05d38599",
"canBeRetried": "Unknown",
"detailedErrorCode": 0
}
}
}
}
}
},
"Not-Found": {
"description": "One or more of the resources you referenced could not be found.\nThis might be because your company or data connection id is wrong, or was already deleted.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
},
"examples": {
"Data connection not found": {
"value": {
"statusCode": 404,
"service": "PublicApi",
"error": "Data connection a22dd66b-564a-4832-9b37-7b3ce4aeb7de not found",
"correlationId": "8fa2b5f4794970a4ee73758f612e8df0",
"canBeRetried": "Unknown",
"detailedErrorCode": 0
}
},
"Company not found": {
"value": {
"statusCode": 404,
"service": "ClientsApi",
"error": "No company was found with ID 846ed55c-974b-4392-a1f1-87b6fdbf3c5e",
"correlationId": "0a40c2f31fc8f992fb88b0853e4166f3",
"canBeRetried": "Unknown",
"detailedErrorCode": 0
}
},
"No data available": {
"value": {
"statusCode": 404,
"service": "PublicApi",
"error": "No data available for accounts for ID e5889b459f544926ac5b8e6756df2s",
"correlationId": "0a40c2f31fc8f992fb88b0853e4166f3",
"canBeRetried": "Unknown",
"detailedErrorCode": 0
}
}
}
}
}
},
"Conflict": {
"description": "The data type's dataset has not been requested or is still syncing.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
},
"examples": {
"Conflict": {
"value": {
"statusCode": 409,
"service": "PublicApi",
"error": "The data set has not been requested.",
"correlationId": "bc997528a9d7abb9161ef45f05d38599",
"canBeRetried": "Unknown",
"detailedErrorCode": 0
}
}
}
}
}
},
"Too-Many-Requests": {
"description": "Too many requests were made in a given amount of time. Wait a short period and then try again.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
},
"examples": {
"Conflict": {
"value": {
"statusCode": 429,
"service": "PublicApi",
"error": "You have made too many requests in a given amount of time; please retry later.",
"correlationId": "bc997528a9d7abb9161ef45f05d38599",
"canBeRetried": "Unknown",
"detailedErrorCode": 0
}
}
}
}
}
},
"Internal-Server-Error": {
"description": "There is a problem with our server. Please try again later.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
},
"examples": {
"Conflict": {
"value": {
"statusCode": 500,
"service": "PublicApi",
"error": "There is a problem with our server. Please try again later.",
"correlationId": "bc997528a9d7abb9161ef45f05d38599",
"canBeRetried": "Unknown",
"detailedErrorCode": 0
}
}
}
}
}
},
"Service-Unavailable": {
"description": "The Codat API is temporarily offline for maintenance. Please try again later.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
},
"examples": {
"Conflict": {
"value": {
"statusCode": 500,
"service": "PublicApi",
"error": "The Codat API is temporarily offline for maintenance. Please try again later.",
"correlationId": "bc997528a9d7abb9161ef45f05d38599",
"canBeRetried": "Unknown",
"detailedErrorCode": 0
}
}
}
}
}
}
},
"securitySchemes": {
"auth_header": {
"name": "Authorization",
"description": "The word \"Basic\" followed by a space and your API key. [API keys](https://docs.codat.io/accounting-api#/schemas/apiKeys) are tokens used to control access to the API. You can get an API key via [the Codat Portal](https://app.codat.io/developers/api-keys), via [the API](https://docs.codat.io/codat-api#/api-keys/api-keys-list), or [read more](https://docs.codat.io/using-the-api/authentication) about authentication at Codat.",
"type": "apiKey",
"in": "header",
"x-speakeasy-example": "Basic BASE_64_ENCODED(API_KEY)"
}
}
}
}