get config sync commerce commerceKey accountingKey start - sync-for-commerce API | Specway Docs

GET

Retrieve sync flow url

https://api.codat.io/config/sync/commerce/{commerceKey}/{accountingKey}/start

Get a URL for Sync Flow including a one time passcode.

Access Token Required: API Key

Path Parameters

commerceKeystringrequired

Commerce platform key

accountingKeystringrequired

Accounting platform key

Query Params

merchantIdentifierstring

Identifier for your merchant, can be the merchant name or Codat company id.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'https://api.codat.io/config/sync/commerce/{commerceKey}/{accountingKey}/start' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET