Commerce API
Codat's Commerce API allows you to access standardised data from over 11 commerce and POS systems. Standardize how you connect to your customers’ payment,…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Codat's Commerce API allows you to access standardised data from over 11 commerce and POS systems.
Standardize 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 platforms.
Endpoints 11
Customers
- GETList customers
/companies/:companyId/connections/:connectionId/data/commerce-customers?page=1&pageSize=100&query=string&orderBy=-modifiedDateList all commerce customers for the given company and data connection
Disputes
- GETList disputes
/companies/:companyId/connections/:connectionId/data/commerce-disputes?page=1&pageSize=100&query=string&orderBy=-modifiedDateList commerce disputes
Company info
- GETGet company info
/companies/:companyId/connections/:connectionId/data/commerce-infoRetrieve information about the company, as seen in the commerce platform. This may include information like addresses, tax registration details and social…
Locations
- GETList locations
/companies/:companyId/connections/:connectionId/data/commerce-locationsRetrieve a list of locations as seen in the commerce platform. A location is a geographic place at which stocks of products may be held, or from where orders…
Orders
- GETList orders
/companies/:companyId/connections/:connectionId/data/commerce-orders?page=1&pageSize=100&query=string&orderBy=-modifiedDateGet a list of orders placed or held on the linked commerce platform
Payments
- GETList payment methods
/companies/:companyId/connections/:connectionId/data/commerce-paymentMethods?page=1&pageSize=100&query=string&orderBy=-modifiedDateRetrieve a list of payment methods, such as card, cash or other online payment methods, as held in the linked commerce platform. - GETList payments
/companies/:companyId/connections/:connectionId/data/commerce-payments?page=1&pageSize=100&query=string&orderBy=-modifiedDateList commerce payments for the given company & data connection.
Products
- GETList product categories
/companies/:companyId/connections/:connectionId/data/commerce-productCategories?page=1&pageSize=100&query=string&orderBy=-modifiedDateProduct categories are used to classify a group of products together, either by type (eg "Furniture"), or sometimes by tax profile. - GETList products
/companies/:companyId/connections/:connectionId/data/commerce-products?page=1&pageSize=100&query=string&orderBy=-modifiedDateThe Products data type provides the company's product inventory, and includes the price and quantity of all products, and product variants, available for sale.
Tax components
- GETList tax components
/companies/:companyId/connections/:connectionId/data/commerce-taxComponentsThis endpoint returns a lits of tax rates from the commerce platform, including tax rate names and values. This supports the mapping of tax rates from the…
Transactions
- GETList transactions
/companies/:companyId/connections/:connectionId/data/commerce-transactions?page=1&pageSize=100&query=string&orderBy=-modifiedDateDetails of all financial transactions recorded in the commerce or point of sale system are added to the Transactions data type. For example, payments, service…
API details
- Base URL
https://api.codat.io- Authentication
- An API key in the Authorization header
- Operations
- 11 operations on 11 pathsGET 11
- Main resources
- Payments 2Products 2Company info 1Customers 1Disputes 1Locations 1Orders 1Tax components 1Transactions 1
- Response formats
application/json- Description format
- OpenAPI 3.1.0, API version
2.1.0 - Links
- OpenAPI document · Terms of service
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Commerce API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Commerce API collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “List customers” (GET /companies/:companyId/connections/:connectionId/data/commerce-customers?page=1&pageSize=100&query=string&orderBy=-modifiedDate), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Commerce API?
Codat's Commerce API allows you to access standardised data from over 11 commerce and POS systems. Standardize how you connect to your customers’ payment,… It is listed under E-commerce and has 11 endpoints.
Who publishes the Commerce API?
It is listed from Codat's public API description (an OpenAPI document), not published by Codat on Swastik Codes. Anyone who controls codat.io can claim the profile by adding a DNS TXT record.
What is the base URL of the Commerce API?
Requests go to https://api.codat.io. Endpoint paths are added to this base URL.
How do I authenticate with the Commerce API?
With an API key in the Authorization header.
How many endpoints does the Commerce API have?
11 operations on 11 paths (11 GET). The largest groups are Payments, Products, Company info, Customers.
Is forking the Commerce API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.