newstore-apimatic-sdk 0.0.1

Sample SDKs for Newstore By APIMatic

Getting Started with NewStore API

Introduction

NewStore public APIs

Install the Package

The package is compatible with Python versions 3.7+. Install the package from PyPi using the following pip command:

pip install newstore-apimatic-sdk==0.0.1

You can also view the package at: https://pypi.python.org/pypi/newstore-apimatic-sdk/0.0.1

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

Parameter	Type	Description
tenant	str	Default: "dodici"
environment	Environment	The API environment. Default: Environment.STAGING
http_client_instance	Union[Session, HttpClientProvider]	The Http Client passed from the sdk user for making requests
override_http_client_configuration	bool	The value which determines to override properties of the passed Http Client from the sdk user
http_call_back	HttpCallBack	The callback value that is invoked before and after an HTTP call is made to an endpoint
timeout	float	The value to use for connection timeout. Default: 60
max_retries	int	The number of times to retry an endpoint call if it fails. Default: 0
backoff_factor	float	A backoff factor to apply between attempts after the second try. Default: 2
retry_statuses	Array of int	The http statuses on which retry is to be done. Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
retry_methods	Array of string	The http methods on which retry is to be done. Default: ["GET", "PUT"]
proxy_settings	ProxySettings	Optional proxy configuration to route HTTP requests through a proxy server.
client_credentials_auth_credentials	ClientCredentialsAuthCredentials	The credential object for OAuth 2 Client Credentials Grant

The API client can be initialized as follows:

Code-Based Client Initialization

from newstoreapi.configuration import Environment
from newstoreapi.http.auth.o_auth_2 import ClientCredentialsAuthCredentials
from newstoreapi.models.o_auth_scope_enum import OAuthScopeEnum
from newstoreapi.newstoreapi_client import NewstoreapiClient

client = NewstoreapiClient(
    client_credentials_auth_credentials=ClientCredentialsAuthCredentials(
        o_auth_client_id='OAuthClientId',
        o_auth_client_secret='OAuthClientSecret',
        o_auth_scopes=[
            OAuthScopeEnum.CATALOGIMPORT_SCHEMASREAD,
            OAuthScopeEnum.CATALOGIMPORT_SCHEMASWRITE
        ]
    ),
    environment=Environment.STAGING,
    tenant='dodici'
)

Environment-Based Client Initialization

from newstoreapi.newstoreapi_client import NewstoreapiClient

# Specify the path to your .env file if it’s located outside the project’s root directory.
client = NewstoreapiClient.from_environment(dotenv_path='/path/to/.env')

See the Environment-Based Client Initialization section for details.

Environments

The SDK can be configured to use a different environment for making API calls. Available environments are:

Fields

Name	Description
STAGING	Default

Authorization

This API uses the following authentication schemes.

• oauth (OAuth 2 Client Credentials Grant)

List of APIs

• Import Schemas
• Pricebookexport
• Productexport
• Financial Document
• Sales Goals Management
• Store Reporting Config
• Inventory Configuration
• Reason Codes
• Addresscompletion
• Devicenotifications
• Deviceregistrations
• Devicesubscriptions
• Associate Appexperimentsconfiguration
• Platformeventcallbacks
• Cart
• Notifications
• Profiles
• Customer Profile
• Data
• Token-Operations
• Address
• Customer-Configuration
• Segmentation
• Datasets
• Jobs
• Events
• Extensions
• Installations
• Stores
• Cashboxes
• Orders
• Fiscal-Providers
• Tenant-Config
• Easypost Adapter Config
• Shipment-Configurations
• Provider-Rates
• Shipping-Options
• Shipping-Option-Audits
• Shipping-Labels
• Manifests
• Bookings
• Fulfillment-Requests
• Fulfillment-Tasks
• Shortings
• Package-Types
• Clients
• Identity-Providers
• Users
• Support-Users
• Roles
• Insights
• Counting
• Transferring
• Reservations
• Phavda-Notifications
• Sales-Orders
• Stock
• Order-Placement
• Adyen-Adapter
• Payment-Definitions
• Stripe-Webhook-Notifications
• Providers
• Payment-Links
• Payment-Account
• Discounts
• Tppe
• Settings
• Platform-Status
• Simulation
• Routing-Ruleset
• Routing-Config
• Routing
• Order-Injection-Config
• Order-Injection
• Audit-Events
• Tax-Definitions
• Store-Tax-Configuration
• Tax-Transactions
• Tax-Quotations
• Tenant-Tax-Configuration

SDK Infrastructure

Configuration

• ProxySettings
• Environment-Based Client Initialization

HTTP

• HttpResponse
• HttpRequest

Utilities

• ApiHelper
• HttpDateTime
• RFC3339DateTime
• UnixDateTime