Push merchants' data from your ecommerce or point-of-sale (POS) platform into your merchants' accounting platform.
Project description
Sync for Commerce
Embedded accounting integrations for POS and eCommerce platforms.
SDK Installation
pip install codat-sync-for-commerce
Example Usage
SDK Example Usage
Example
import codatsynccommerce
from codatsynccommerce.models import operations, shared
s = codatsynccommerce.CodatSyncCommerce(
security=shared.Security(
auth_header="Basic BASE_64_ENCODED(API_KEY)",
),
)
req = operations.GetConfigTextSyncFlowRequest(
locale=shared.Locale.EN_US,
)
res = s.sync_flow_settings.get_config_text_sync_flow(req)
if res.localization_info is not None:
# handle response
pass
Available Resources and Operations
sync_flow_settings
- get_config_text_sync_flow - Get preferences for text fields
- get_visible_accounts - List visible accounts
- update_config_text_sync_flow - Update preferences for text fields
- update_visible_accounts_sync_flow - Update visible accounts
advanced_controls
- create_company - Create company
- get_configuration - Get company configuration
- list_companies - List companies
- set_configuration - Set configuration
connections
- create - Create connection
- get_sync_flow_url - Start new sync flow
- list - List connections
- update_authorization - Update authorization
- update_connection - Update connection
sync
- get - Get sync status
- get_last_successful_sync - Last successful sync
- get_latest_sync - Latest sync status
- get_status - Get sync status
- list - List sync statuses
- request - Initiate new sync
- request_for_date_range - Initiate sync for specific range
integrations
- get_branding - Get branding for an integration
- list - List integrations
Retries
Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
To change the default retry strategy for a single API call, simply provide a RetryConfig
object to the call:
import codatsynccommerce
from codatsynccommerce.models import operations, shared
from codatsynccommerce.utils import BackoffStrategy, RetryConfig
s = codatsynccommerce.CodatSyncCommerce(
security=shared.Security(
auth_header="Basic BASE_64_ENCODED(API_KEY)",
),
)
req = operations.GetConfigTextSyncFlowRequest(
locale=shared.Locale.EN_US,
)
res = s.sync_flow_settings.get_config_text_sync_flow(req,
RetryConfig('backoff', BackoffStrategy(1, 50, 1.1, 100), False))
if res.localization_info is not None:
# handle response
pass
If you'd like to override the default retry strategy for all operations that support retries, you can use the retry_config
optional parameter when initializing the SDK:
import codatsynccommerce
from codatsynccommerce.models import operations, shared
from codatsynccommerce.utils import BackoffStrategy, RetryConfig
s = codatsynccommerce.CodatSyncCommerce(
retry_config=RetryConfig('backoff', BackoffStrategy(1, 50, 1.1, 100), False)
security=shared.Security(
auth_header="Basic BASE_64_ENCODED(API_KEY)",
),
)
req = operations.GetConfigTextSyncFlowRequest(
locale=shared.Locale.EN_US,
)
res = s.sync_flow_settings.get_config_text_sync_flow(req)
if res.localization_info is not None:
# handle response
pass
Error Handling
Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an error. If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate Error type.
Error Object | Status Code | Content Type |
---|---|---|
errors.ErrorMessage | 401,402,403,429,500,503 | application/json |
errors.SDKError | 4x-5xx | / |
Example
import codatsynccommerce
from codatsynccommerce.models import errors, operations, shared
s = codatsynccommerce.CodatSyncCommerce(
security=shared.Security(
auth_header="Basic BASE_64_ENCODED(API_KEY)",
),
)
req = operations.GetConfigTextSyncFlowRequest(
locale=shared.Locale.EN_US,
)
res = None
try:
res = s.sync_flow_settings.get_config_text_sync_flow(req)
except errors.ErrorMessage as e:
# handle exception
raise(e)
except errors.SDKError as e:
# handle exception
raise(e)
if res.localization_info is not None:
# handle response
pass
Server Selection
Select Server by Index
You can override the default server globally by passing a server index to the server_idx: int
optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
# | Server | Variables |
---|---|---|
0 | https://api.codat.io |
None |
Example
import codatsynccommerce
from codatsynccommerce.models import operations, shared
s = codatsynccommerce.CodatSyncCommerce(
server_idx=0,
security=shared.Security(
auth_header="Basic BASE_64_ENCODED(API_KEY)",
),
)
req = operations.GetConfigTextSyncFlowRequest(
locale=shared.Locale.EN_US,
)
res = s.sync_flow_settings.get_config_text_sync_flow(req)
if res.localization_info is not None:
# handle response
pass
Override Server URL Per-Client
The default server can also be overridden globally by passing a URL to the server_url: str
optional parameter when initializing the SDK client instance. For example:
import codatsynccommerce
from codatsynccommerce.models import operations, shared
s = codatsynccommerce.CodatSyncCommerce(
server_url="https://api.codat.io",
security=shared.Security(
auth_header="Basic BASE_64_ENCODED(API_KEY)",
),
)
req = operations.GetConfigTextSyncFlowRequest(
locale=shared.Locale.EN_US,
)
res = s.sync_flow_settings.get_config_text_sync_flow(req)
if res.localization_info is not None:
# handle response
pass
Custom HTTP Client
The Python SDK makes API calls using the requests HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom requests.Session
object.
For example, you could specify a header for every request that this sdk makes as follows:
import codatsynccommerce
import requests
http_client = requests.Session()
http_client.headers.update({'x-custom-header': 'someValue'})
s = codatsynccommerce.CodatSyncCommerce(client: http_client)
Authentication
Per-Client Security Schemes
This SDK supports the following security scheme globally:
Name | Type | Scheme |
---|---|---|
auth_header |
apiKey | API key |
You can set the security parameters through the security
optional parameter when initializing the SDK client instance. For example:
import codatsynccommerce
from codatsynccommerce.models import operations, shared
s = codatsynccommerce.CodatSyncCommerce(
security=shared.Security(
auth_header="Basic BASE_64_ENCODED(API_KEY)",
),
)
req = operations.GetConfigTextSyncFlowRequest(
locale=shared.Locale.EN_US,
)
res = s.sync_flow_settings.get_config_text_sync_flow(req)
if res.localization_info is not None:
# handle response
pass
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for codat-sync-for-commerce-4.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 65fddd771ebabd19a43cd2a0c0ecabac1a871dd8b35e7da624d4708f1ef011aa |
|
MD5 | 34ef9586952d55268c8f50c2a93aefed |
|
BLAKE2b-256 | c4dfd1a8554522d4846dd2da207b9f27622d9d525fc3ee8ae9ee9874904bbcae |
Hashes for codat_sync_for_commerce-4.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6b2032471b3a1824a6caa1142f977ff29f8899a42fb527f8fcafb6035d18e9c4 |
|
MD5 | 07e27af6469ddd558e163aa6d7d20cf6 |
|
BLAKE2b-256 | 344f15f63d8d9d4660c9a17ab39d427a9ad304c6f0194ac06cb45d1e7e8cb21c |