Codat Get Commerce Order Example is an example object payload from Codat, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.
Top-level fields
operationIdmethodpathsummaryrequestExamplesresponseExamples
Example Payload
{
"operationId": "get-commerce-order",
"method": "GET",
"path": "/companies/{companyId}/connections/{connectionId}/data/commerce-orders/{orderId}",
"summary": "Get order",
"requestExamples": [],
"responseExamples": [
{
"status": "200",
"contentType": "application/json",
"name": "Amazon Seller Central",
"example": {
"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"
}
},
{
"status": "200",
"contentType": "application/json",
"name": "BigCommerce",
"example": {
"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"
}
},
{
"status": "200",
"contentType": "application/json",
"name": "Clover",
"example": {
"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"
}
},
{
"status": "200",
"contentType": "application/json",
"name": "Lightspeed K Trial",
"example": {
"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"
}
},
{
"status": "200",
"contentType": "application/json",
"name": "Mollie",
"example": {
"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"
}
},
{
"status": "200",
"contentType": "application/json",
"name": "Mollie Test",
"example": {
"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"
}
},
{
"status": "200",
"contentType": "application/json",
"name": "Partner Commerce",
"example": {
"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"
}
},
{
"status": "200",
"contentType": "application/json",
"name": "PrestaShop",
"example": {
"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"
}
},
{
"status": "200",
"contentType": "application/json",
"name": "Shopify",
"example": {
"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"
}
},
{
"status": "200",
"contentType": "application/json",
"name": "Square",
"example": {
"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"
}
},
{
"status": "200",
"contentType": "application/json",
"name": "SumUp",
"example": {
"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"
}
},
{
"status": "200",
"contentType": "application/json",
"name": "WooCommerce",
"example": {
"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"
}
},
{
"status": "200",
"contentType": "application/json",
"name": "Zettle",
"example": {
"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"
}
}
]
}