Metadata-Version: 2.4
Name: walmart-apimatic-sdk
Version: 0.0.1
Summary: SDK for Walmart
Author-email: Muhammad Rafay <muhammad.rafay@apimatic.io>
Project-URL: Documentation, https://developer.walmart.com/
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: apimatic-core>=0.2.24,~=0.2.0
Requires-Dist: apimatic-core-interfaces>=0.1.8,~=0.1.0
Requires-Dist: apimatic-requests-client-adapter>=0.1.10,~=0.1.0
Requires-Dist: python-dotenv<2.0,>=0.21
Provides-Extra: testutils
Requires-Dist: pytest>=7.2.2; extra == "testutils"
Dynamic: license-file


# Getting Started with Walmart APIs

## Introduction

The price is a fundamental building block for your listing on Walmart.com. You can use the price management APIs to set up and manage the price for a given item, The Walmart Marketplace APIs use OAuth for token-based authentication and authorization.  
We also introduced OAuth 2.0 for solution providers to enable new authorizations using authorization code grant type. Sellers can now connect with solution provider apps seamlessly through this new Walmart's OAuth 2.0 user experience. Refer to the [Guide section](https:///doc/us/mp/us-mp-auth2/#606) for comprehensive instructions. Existing seller connections using the previous authorization method will remain operational.

## Install the Package

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

```bash
pip install walmart-apimatic-sdk==0.0.1
```

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

## Initialize the API Client

**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sdks-io/walmart-apimatic-python-sdk/tree/0.0.1/doc/client.md)

The following parameters are configurable for the API Client:

| Parameter | Type | Description |
|  --- | --- | --- |
| environment | [`Environment`](https://www.github.com/sdks-io/walmart-apimatic-python-sdk/tree/0.0.1/README.md#environments) | The API environment. <br> **Default: `Environment.PRODUCTION`** |
| 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. <br> **Default: 30** |
| max_retries | `int` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |
| backoff_factor | `float` | A backoff factor to apply between attempts after the second try. <br> **Default: 2** |
| retry_statuses | `Array of int` | The http statuses on which retry is to be done. <br> **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. <br> **Default: ["GET", "PUT"]** |
| proxy_settings | [`ProxySettings`](https://www.github.com/sdks-io/walmart-apimatic-python-sdk/tree/0.0.1/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
| logging_configuration | [`LoggingConfiguration`](https://www.github.com/sdks-io/walmart-apimatic-python-sdk/tree/0.0.1/doc/logging-configuration.md) | The SDK logging configuration for API calls |
| basic_auth_credentials | [`BasicAuthCredentials`](https://www.github.com/sdks-io/walmart-apimatic-python-sdk/tree/0.0.1/doc/auth/basic-authentication.md) | The credential object for Basic Authentication |

The API client can be initialized as follows:

### Code-Based Client Initialization

```python
import logging

from walmartapis.configuration import Environment
from walmartapis.http.auth.basic_auth import BasicAuthCredentials
from walmartapis.logging.configuration.api_logging_configuration import LoggingConfiguration
from walmartapis.logging.configuration.api_logging_configuration import RequestLoggingConfiguration
from walmartapis.logging.configuration.api_logging_configuration import ResponseLoggingConfiguration
from walmartapis.walmartapis_client import WalmartapisClient

client = WalmartapisClient(
    basic_auth_credentials=BasicAuthCredentials(
        username='username',
        password='password'
    ),
    environment=Environment.PRODUCTION,
    logging_configuration=LoggingConfiguration(
        log_level=logging.INFO,
        request_logging_config=RequestLoggingConfiguration(
            log_body=True
        ),
        response_logging_config=ResponseLoggingConfiguration(
            log_headers=True
        )
    )
)
```

### Environment-Based Client Initialization

```python
from walmartapis.walmartapis_client import WalmartapisClient

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

See the [Environment-Based Client Initialization](https://www.github.com/sdks-io/walmart-apimatic-python-sdk/tree/0.0.1/doc/environment-based-client-initialization.md) section for details.

## Environments

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

### Fields

| Name | Description |
|  --- | --- |
| PRODUCTION | **Default** |

## Authorization

This API uses the following authentication schemes.

* [`basic (Basic Authentication)`](https://www.github.com/sdks-io/walmart-apimatic-python-sdk/tree/0.0.1/doc/auth/basic-authentication.md)

## List of APIs

* [Strategy Collection Id](https://www.github.com/sdks-io/walmart-apimatic-python-sdk/tree/0.0.1/doc/controllers/strategy-collection-id.md)
* [Strategy](https://www.github.com/sdks-io/walmart-apimatic-python-sdk/tree/0.0.1/doc/controllers/strategy.md)
* [Strategies](https://www.github.com/sdks-io/walmart-apimatic-python-sdk/tree/0.0.1/doc/controllers/strategies.md)
* [Wfpreference](https://www.github.com/sdks-io/walmart-apimatic-python-sdk/tree/0.0.1/doc/controllers/wfpreference.md)
* [Incentives](https://www.github.com/sdks-io/walmart-apimatic-python-sdk/tree/0.0.1/doc/controllers/incentives.md)
* [Get Pricing Insights](https://www.github.com/sdks-io/walmart-apimatic-python-sdk/tree/0.0.1/doc/controllers/get-pricing-insights.md)
* [Price](https://www.github.com/sdks-io/walmart-apimatic-python-sdk/tree/0.0.1/doc/controllers/price.md)
* [Repricer Feeds](https://www.github.com/sdks-io/walmart-apimatic-python-sdk/tree/0.0.1/doc/controllers/repricer-feeds.md)
* [Feeds](https://www.github.com/sdks-io/walmart-apimatic-python-sdk/tree/0.0.1/doc/controllers/feeds.md)
* [Feeds ? Feed Type PRICE and PROMOTION](https://www.github.com/sdks-io/walmart-apimatic-python-sdk/tree/0.0.1/doc/controllers/feeds-feed-type-price-and-promotion.md)
* [Feeds ? Feed Type WALMART FUNDED INCENTIVES ENROLLMENT](https://www.github.com/sdks-io/walmart-apimatic-python-sdk/tree/0.0.1/doc/controllers/feeds-feed-type-walmart-funded-incentives-enrollment.md)
* [Feeds ? Feed Type INCENTIVE ENROLLMENT](https://www.github.com/sdks-io/walmart-apimatic-python-sdk/tree/0.0.1/doc/controllers/feeds-feed-type-incentive-enrollment.md)
* [Cppreference](https://www.github.com/sdks-io/walmart-apimatic-python-sdk/tree/0.0.1/doc/controllers/cppreference.md)
* [Detail](https://www.github.com/sdks-io/walmart-apimatic-python-sdk/tree/0.0.1/doc/controllers/detail.md)
* [Token](https://www.github.com/sdks-io/walmart-apimatic-python-sdk/tree/0.0.1/doc/controllers/token.md)
* [Misc](https://www.github.com/sdks-io/walmart-apimatic-python-sdk/tree/0.0.1/doc/controllers/misc.md)

## SDK Infrastructure

### Configuration

* [ProxySettings](https://www.github.com/sdks-io/walmart-apimatic-python-sdk/tree/0.0.1/doc/proxy-settings.md)
* [Environment-Based Client Initialization](https://www.github.com/sdks-io/walmart-apimatic-python-sdk/tree/0.0.1/doc/environment-based-client-initialization.md)
* [AbstractLogger](https://www.github.com/sdks-io/walmart-apimatic-python-sdk/tree/0.0.1/doc/abstract-logger.md)
* [LoggingConfiguration](https://www.github.com/sdks-io/walmart-apimatic-python-sdk/tree/0.0.1/doc/logging-configuration.md)
* [RequestLoggingConfiguration](https://www.github.com/sdks-io/walmart-apimatic-python-sdk/tree/0.0.1/doc/request-logging-configuration.md)
* [ResponseLoggingConfiguration](https://www.github.com/sdks-io/walmart-apimatic-python-sdk/tree/0.0.1/doc/response-logging-configuration.md)

### HTTP

* [HttpResponse](https://www.github.com/sdks-io/walmart-apimatic-python-sdk/tree/0.0.1/doc/http-response.md)
* [HttpRequest](https://www.github.com/sdks-io/walmart-apimatic-python-sdk/tree/0.0.1/doc/http-request.md)

### Utilities

* [ApiResponse](https://www.github.com/sdks-io/walmart-apimatic-python-sdk/tree/0.0.1/doc/api-response.md)
* [ApiHelper](https://www.github.com/sdks-io/walmart-apimatic-python-sdk/tree/0.0.1/doc/api-helper.md)
* [HttpDateTime](https://www.github.com/sdks-io/walmart-apimatic-python-sdk/tree/0.0.1/doc/http-date-time.md)
* [RFC3339DateTime](https://www.github.com/sdks-io/walmart-apimatic-python-sdk/tree/0.0.1/doc/rfc3339-date-time.md)
* [UnixDateTime](https://www.github.com/sdks-io/walmart-apimatic-python-sdk/tree/0.0.1/doc/unix-date-time.md)

