Skip to content

Latest commit

 

History

History

README.md

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

  • get - Get company info
  • get - Get customer
  • list - List customers
  • get - Get dispute
  • list - List disputes
  • get - Get location
  • list - List locations
  • get - Get order
  • list - List orders
  • get - Get tax component
  • list - List tax components
  • get - Get transaction
  • list - List transactions

Support

If you encounter any challenges while utilizing our SDKs, please don't hesitate to reach out for assistance. You can raise any issues by contacting your dedicated Codat representative or reaching out to our support team. We're here to help ensure a smooth experience for you.

Library generated by Speakeasy