You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: commerce/docs/models/shared/location.md
+5-2Lines changed: 5 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,17 @@
1
1
# Location
2
2
3
-
Reference to a configured dynamic key value pair that is unique to the accounting platform. This feature is in private beta, contact us if you would like to learn more.
3
+
The Location datatype holds information on the geographic location at which stocks of products may be held, as referenced in the Products data type.
4
+
5
+
A Location also holds information on geographic locations where orders were placed, as referenced in the Orders data type.
6
+
7
+
Explore our [data coverage](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-locations) for this data type.
4
8
5
9
6
10
## Fields
7
11
8
12
| Field | Type | Required | Description | Example |
Supplemental data is additional data you can include in our standard data types.
4
+
5
+
It is referenced as a configured dynamic key value pair that is unique to the accounting platform. [Learn more](https://docs.codat.io/using-the-api/additional-data) about supplemental data.
Copy file name to clipboardExpand all lines: commerce/docs/sdks/customers/README.md
+14-2Lines changed: 14 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,14 @@ Retrieve standardized data from linked commerce platforms.
11
11
12
12
## get
13
13
14
-
Get a specific commerce customer for the given company and data connection.
14
+
The *Get customer* endpoint returns a single customer for a given customerId.
15
+
16
+
[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.
17
+
18
+
Check 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.
19
+
20
+
Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).
21
+
15
22
16
23
### Example Usage
17
24
@@ -52,7 +59,12 @@ if res.customer is not None:
52
59
53
60
## list
54
61
55
-
List all commerce customers for the given company and data connection
62
+
The *List customers* endpoint returns a list of [customers](https://docs.codat.io/commerce-api#/schemas/Customer) for a given company's connection.
63
+
64
+
[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.
65
+
66
+
Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).
Copy file name to clipboardExpand all lines: commerce/docs/sdks/disputes/README.md
+14-2Lines changed: 14 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,14 @@ Retrieve standardized data from linked commerce platforms.
11
11
12
12
## get
13
13
14
-
Get a specific commerce dispute.
14
+
The *Get dispute* endpoint returns a single dispute for a given disputeId.
15
+
16
+
[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.
17
+
18
+
Check 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.
19
+
20
+
Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).
21
+
15
22
16
23
### Example Usage
17
24
@@ -52,7 +59,12 @@ if res.dispute is not None:
52
59
53
60
## list
54
61
55
-
List commerce disputes
62
+
The *List disputes* endpoint returns a list of [disputes](https://docs.codat.io/commerce-api#/schemas/Dispute) for a given company's connection.
63
+
64
+
[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.
65
+
66
+
Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).
Copy file name to clipboardExpand all lines: commerce/docs/sdks/locations/README.md
+12-4Lines changed: 12 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,9 +11,14 @@ Retrieve standardized data from linked commerce platforms.
11
11
12
12
## get
13
13
14
-
Retrieve a location as seen in the commerce platform.
14
+
The *Get location* endpoint returns a single location for a given locationId.
15
+
16
+
[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.
17
+
18
+
Check 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.
19
+
20
+
Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).
15
21
16
-
A `location` is a geographic place at which stocks of products may be held, or from where orders were placed.
17
22
18
23
### Example Usage
19
24
@@ -54,9 +59,12 @@ if res.location is not None:
54
59
55
60
## list
56
61
57
-
Retrieve a list of locations as seen in the commerce platform.
62
+
The *List locations* endpoint returns a list of [locations](https://docs.codat.io/commerce-api#/schemas/Location) for a given company's connection.
63
+
64
+
[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.
58
65
59
-
A `location` is a geographic place at which stocks of products may be held, or from where orders were placed.
66
+
Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).
Copy file name to clipboardExpand all lines: commerce/docs/sdks/orders/README.md
+14-2Lines changed: 14 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,14 @@ Retrieve standardized data from linked commerce platforms.
11
11
12
12
## get
13
13
14
-
Get a specific order placed or held on the linked commerce platform.
14
+
The *Get order* endpoint returns a single order for a given orderId.
15
+
16
+
[Orders](https://docs.codat.io/commerce-api#/schemas/Order) contain the transaction details for all products sold by the company.
17
+
18
+
Check 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.
19
+
20
+
Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).
21
+
15
22
16
23
### Example Usage
17
24
@@ -52,7 +59,12 @@ if res.order is not None:
52
59
53
60
## list
54
61
55
-
Get a list of orders placed or held on the linked commerce platform
62
+
The *List orders* endpoint returns a list of [orders](https://docs.codat.io/commerce-api#/schemas/Order) for a given company's connection.
63
+
64
+
[Orders](https://docs.codat.io/commerce-api#/schemas/Order) contain the transaction details for all products sold by the company.
65
+
66
+
Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).
Copy file name to clipboardExpand all lines: commerce/docs/sdks/payments/README.md
+28-4Lines changed: 28 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,14 @@ Retrieve standardized data from linked commerce platforms.
13
13
14
14
## get
15
15
16
-
Get a specific commerce payment for the given company & data connection.
16
+
The *Get payment* endpoint returns a single payment for a given paymentId.
17
+
18
+
[Payments](https://docs.codat.io/commerce-api#/schemas/Payment) contain details of all payments made by customers to the company.
19
+
20
+
Check 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.
21
+
22
+
Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).
23
+
17
24
18
25
### Example Usage
19
26
@@ -54,7 +61,14 @@ if res.payment is not None:
54
61
55
62
## get_method
56
63
57
-
Retrieve a specific payment method, such as card, cash or other online payment methods, as held in the linked commerce platform.
64
+
The *Get payment method* endpoint returns a single payment method for a given paymentMethodId.
65
+
66
+
[Payment methods](https://docs.codat.io/commerce-api#/schemas/PaymentMethod) represent the payment method(s) used to make payments.
67
+
68
+
Check 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.
69
+
70
+
Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).
71
+
58
72
59
73
### Example Usage
60
74
@@ -95,7 +109,12 @@ if res.payment_method is not None:
95
109
96
110
## list
97
111
98
-
List commerce payments for the given company & data connection.
112
+
The *List payments* endpoint returns a list of [payments](https://docs.codat.io/commerce-api#/schemas/Payment) for a given company's connection.
113
+
114
+
[Payments](https://docs.codat.io/commerce-api#/schemas/Payment) contain details of all payments made by customers to the company.
115
+
116
+
Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).
117
+
99
118
100
119
### Example Usage
101
120
@@ -139,7 +158,12 @@ if res.payments is not None:
139
158
140
159
## list_methods
141
160
142
-
Retrieve a list of payment methods, such as card, cash or other online payment methods, as held in the linked commerce platform.
161
+
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.
162
+
163
+
[Payment methods](https://docs.codat.io/commerce-api#/schemas/PaymentMethod) represent the payment method(s) used to make payments.
164
+
165
+
Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).
0 commit comments