Codat Commerce
Codat Commerce is an API for accessing standardized commerce and sales data from business platforms.
- Base URL:
https://api.codat.io - Auth:
header:Authorization(pass your key via theapiKeyinput)
Operations
list_customers— GET /companies/{companyId}/connections/{connectionId}/data/commerce-customers — List customerslist_disputes— GET /companies/{companyId}/connections/{connectionId}/data/commerce-disputes — List disputesget_company_info— GET /companies/{companyId}/connections/{connectionId}/data/commerce-info — Get company infolist_locations— GET /companies/{companyId}/connections/{connectionId}/data/commerce-locations — List locationslist_orders— GET /companies/{companyId}/connections/{connectionId}/data/commerce-orders — List orderslist_payment_methods— GET /companies/{companyId}/connections/{connectionId}/data/commerce-paymentMethods — List payment methods
Inputs
apiKey— your codat-commerce API keyoperation— one of the operations above- path parameters when an operation's path contains
{...} query— optional JSON object of query paramsbody— JSON object for create/update ops
Example
operation: list_customers
apiKey: <your key>
Publishes
The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.
erroroperationresultstatus
Input Properties
Every property this tool accepts, from its own tool.iml.
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
apiKey |
string | yes | — | DEPRECATED — bind an API Key credential to the task with credentialName instead. A key pasted here is stored in the workflow definition in clear and appears in every export of it. Still honoured for workflows built before the change. |
operation |
string | yes | — | One of: list_customers, list_disputes, get_company_info, list_locations, list_orders, list_payment_methods |
companyId |
string | no | — | Path parameter companyId (required by some operations). |
connectionId |
string | no | — | Path parameter connectionId (required by some operations). |
query |
string | no | — | Query-string parameters as a JSON object string, e.g. {"limit": 50}. Parsed and url-encoded onto the request. |