@codat/commerce
v0.37.0
Published
<!-- Start Codat Library Description --> Codat's Commerce API enables you to pull up-date-date commerce data from several leading payments, point-of-sale, and eCommerce systems. You can view your SMB customers' products, orders, payments, payouts, disput
Downloads
408
Readme
Commerce
Codat's Commerce API enables you to pull up-date-date commerce data from several leading payments, point-of-sale, and eCommerce systems. You can view your SMB customers' products, orders, payments, payouts, disputes, and more - all standardized to our Commerce data model.
SDK Installation
NPM
npm add @codat/commerce
Yarn
yarn add @codat/commerce
Example Usage
import { CodatCommerce } from "@codat/commerce";
(async () => {
const sdk = new CodatCommerce({
security: {
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
},
});
const res = await sdk.companyInfo.get({
companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
});
if (res.statusCode == 200) {
// handle response
}
})();
Available Resources and Operations
companyInfo
- get - Get company info
customers
disputes
locations
orders
payments
- get - Get payment
- getMethod - Get payment method
- list - List payments
- listMethods - List payment methods
products
- get - Get product
- getCategory - Get product category
- list - List products
- listCategories - List product categories