Use our Swagger to follow this guide
All the endpoints mentioned in this guide are available in our Sync for Commerce Swagger. You can use it to try the API requests from this guide directly in your browser. Before you use Swagger, make sure to authenticate.
Within your application, present the merchant with a list of accounting platforms they can connect to.
On select, they should be redirected to the Sync Flow URL where they will be prompted to log in in order to authorize access to their accounting data.
To get all the available integrations to present in your platform selection UI, as well as the associated metadata, make this request:
Note that you can use queries to filter the result.
Codat uses unique four-letter codes, or platform
keys, to denote integration names. We recommend retaining the
keys for all relevant integrations. You may need them at different Sync for Commerce build stages.
To get them, follow the instructions here.
We recommend that you populate your UI with branded logos of the selected accounting platform. To retrieve them, make the following request using the relevant platform key:
Incorrect platform selection
If your merchant accidentally selects the wrong accounting package, you can resolve this by deleting the dataConnection for the incorrectly selected accounting software and returning them to the accounting platform selection stage.
Updated 4 days ago