From a10042591958663ca0a0a193d9b62e0661445569 Mon Sep 17 00:00:00 2001 From: rodrigojob Date: Thu, 15 Oct 2020 17:22:31 -0300 Subject: [PATCH 01/25] Update Configuration.php remove slash, have duplication in request URL --- lib/Configuration.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/Configuration.php b/lib/Configuration.php index 9a6f7e06..051f5282 100644 --- a/lib/Configuration.php +++ b/lib/Configuration.php @@ -80,7 +80,7 @@ class Configuration * * @var string */ - protected $host = 'https://sellingpartnerapi-na.amazon.com/'; + protected $host = 'https://sellingpartnerapi-na.amazon.com'; /** * User agent of the HTTP request, set to "PHP-Swagger" by default From b55b56a32fa870f905ef0081fcb68a38f1dad84f Mon Sep 17 00:00:00 2001 From: rodrigojob Date: Sat, 21 Nov 2020 16:36:19 -0300 Subject: [PATCH 02/25] Add Signing Request Crete Class the headers signed request --- CatalogApi.md | 197 +++++++ DefaultApi.md | 255 +++++++++ FbaInboundApi.md | 1028 +++++++++++++++++++++++++++++++++++++ FbaInventoryApi.md | 76 +++ FbaOutboundApi.md | 543 ++++++++++++++++++++ FeedsApi.md | 361 +++++++++++++ FeesApi.md | 125 +++++ MerchantFulfillmentApi.md | 463 +++++++++++++++++ NotificationsApi.md | 465 +++++++++++++++++ OrdersV0Api.md | 378 ++++++++++++++ ProductPricingApi.md | 257 ++++++++++ ReportsApi.md | 532 +++++++++++++++++++ SalesApi.md | 80 +++ SellersApi.md | 60 +++ ServiceApi.md | 381 ++++++++++++++ ShippingApi.md | 522 +++++++++++++++++++ SmallAndLightApi.md | 299 +++++++++++ SolicitationsApi.md | 125 +++++ 18 files changed, 6147 insertions(+) create mode 100644 CatalogApi.md create mode 100644 DefaultApi.md create mode 100644 FbaInboundApi.md create mode 100644 FbaInventoryApi.md create mode 100644 FbaOutboundApi.md create mode 100644 FeedsApi.md create mode 100644 FeesApi.md create mode 100644 MerchantFulfillmentApi.md create mode 100644 NotificationsApi.md create mode 100644 OrdersV0Api.md create mode 100644 ProductPricingApi.md create mode 100644 ReportsApi.md create mode 100644 SalesApi.md create mode 100644 SellersApi.md create mode 100644 ServiceApi.md create mode 100644 ShippingApi.md create mode 100644 SmallAndLightApi.md create mode 100644 SolicitationsApi.md diff --git a/CatalogApi.md b/CatalogApi.md new file mode 100644 index 00000000..10fe8b6b --- /dev/null +++ b/CatalogApi.md @@ -0,0 +1,197 @@ +# Swagger\Client\CatalogApi + +All URIs are relative to *https://sellingpartnerapi-na.amazon.com/* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getCatalogItem**](CatalogApi.md#getcatalogitem) | **GET** /catalog/v0/items/{asin} | +[**listCatalogCategories**](CatalogApi.md#listcatalogcategories) | **GET** /catalog/v0/categories | +[**listCatalogItems**](CatalogApi.md#listcatalogitems) | **GET** /catalog/v0/items | + +# **getCatalogItem** +> \Swagger\Client\Models\GetCatalogItemResponse getCatalogItem($marketplace_id, $asin) + + +Returns a specified item and its attributes. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\CatalogApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$marketplace_id = "marketplace_id_example"; // string | A marketplace identifier. Specifies the marketplace for the item. +$asin = "asin_example"; // string | The Amazon Standard Identification Number (ASIN) of the item. + +try { + $result = $apiInstance->getCatalogItem($marketplace_id, $asin); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling CatalogApi->getCatalogItem: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **marketplace_id** | **string**| A marketplace identifier. Specifies the marketplace for the item. | + **asin** | **string**| The Amazon Standard Identification Number (ASIN) of the item. | + +### Return type + +[**\Swagger\Client\Models\GetCatalogItemResponse**](../Model/GetCatalogItemResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **listCatalogCategories** +> \Swagger\Client\Models\ListCatalogCategoriesResponse listCatalogCategories($marketplace_id, $asin, $seller_sku) + + + +Returns the parent categories to which an item belongs, based on the specified ASIN or SellerSKU. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\CatalogApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$marketplace_id = "marketplace_id_example"; // string | A marketplace identifier. Specifies the marketplace for the item. +$asin = "asin_example"; // string | The Amazon Standard Identification Number (ASIN) of the item. +$seller_sku = "seller_sku_example"; // string | Used to identify items in the given marketplace. SellerSKU is qualified by the seller's SellerId, which is included with every operation that you submit. + +try { + $result = $apiInstance->listCatalogCategories($marketplace_id, $asin, $seller_sku); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling CatalogApi->listCatalogCategories: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **marketplace_id** | **string**| A marketplace identifier. Specifies the marketplace for the item. | + **asin** | **string**| The Amazon Standard Identification Number (ASIN) of the item. | [optional] + **seller_sku** | **string**| Used to identify items in the given marketplace. SellerSKU is qualified by the seller's SellerId, which is included with every operation that you submit. | [optional] + +### Return type + +[**\Swagger\Client\Models\ListCatalogCategoriesResponse**](../Model/ListCatalogCategoriesResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **listCatalogItems** +> \Swagger\Client\Models\ListCatalogItemsResponse listCatalogItems($marketplace_id, $query, $query_context_id, $seller_sku, $upc, $ean, $isbn, $jan) + + + +Returns a list of items and their attributes, based on a search query or item identifiers that you specify. When based on a search query, provide the Query parameter and optionally, the QueryContextId parameter. When based on item identifiers, provide a single appropriate parameter based on the identifier type, and specify the associated item value. MarketplaceId is always required. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\CatalogApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$marketplace_id = "marketplace_id_example"; // string | A marketplace identifier. Specifies the marketplace for which items are returned. +$query = "query_example"; // string | Keyword(s) to use to search for items in the catalog. Example: 'harry potter books'. +$query_context_id = "query_context_id_example"; // string | An identifier for the context within which the given search will be performed. A marketplace might provide mechanisms for constraining a search to a subset of potential items. For example, the retail marketplace allows queries to be constrained to a specific category. The QueryContextId parameter specifies such a subset. If it is omitted, the search will be performed using the default context for the marketplace, which will typically contain the largest set of items. +$seller_sku = "seller_sku_example"; // string | Used to identify an item in the given marketplace. SellerSKU is qualified by the seller's SellerId, which is included with every operation that you submit. +$upc = "upc_example"; // string | A 12-digit bar code used for retail packaging. +$ean = "ean_example"; // string | A European article number that uniquely identifies the catalog item, manufacturer, and its attributes. +$isbn = "isbn_example"; // string | The unique commercial book identifier used to identify books internationally. +$jan = "jan_example"; // string | A Japanese article number that uniquely identifies the product, manufacturer, and its attributes. + +try { + $result = $apiInstance->listCatalogItems($marketplace_id, $query, $query_context_id, $seller_sku, $upc, $ean, $isbn, $jan); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling CatalogApi->listCatalogItems: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **marketplace_id** | **string**| A marketplace identifier. Specifies the marketplace for which items are returned. | + **query** | **string**| Keyword(s) to use to search for items in the catalog. Example: 'harry potter books'. | [optional] + **query_context_id** | **string**| An identifier for the context within which the given search will be performed. A marketplace might provide mechanisms for constraining a search to a subset of potential items. For example, the retail marketplace allows queries to be constrained to a specific category. The QueryContextId parameter specifies such a subset. If it is omitted, the search will be performed using the default context for the marketplace, which will typically contain the largest set of items. | [optional] + **seller_sku** | **string**| Used to identify an item in the given marketplace. SellerSKU is qualified by the seller's SellerId, which is included with every operation that you submit. | [optional] + **upc** | **string**| A 12-digit bar code used for retail packaging. | [optional] + **ean** | **string**| A European article number that uniquely identifies the catalog item, manufacturer, and its attributes. | [optional] + **isbn** | **string**| The unique commercial book identifier used to identify books internationally. | [optional] + **jan** | **string**| A Japanese article number that uniquely identifies the product, manufacturer, and its attributes. | [optional] + +### Return type + +[**\Swagger\Client\Models\ListCatalogItemsResponse**](../Model/ListCatalogItemsResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + diff --git a/DefaultApi.md b/DefaultApi.md new file mode 100644 index 00000000..6d33fbf3 --- /dev/null +++ b/DefaultApi.md @@ -0,0 +1,255 @@ +# Swagger\Client\DefaultApi + +All URIs are relative to *https://sellingpartnerapi-na.amazon.com/* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**listFinancialEventGroups**](DefaultApi.md#listfinancialeventgroups) | **GET** /finances/v0/financialEventGroups | +[**listFinancialEvents**](DefaultApi.md#listfinancialevents) | **GET** /finances/v0/financialEvents | +[**listFinancialEventsByGroupId**](DefaultApi.md#listfinancialeventsbygroupid) | **GET** /finances/v0/financialEventGroups/{eventGroupId}/financialEvents | +[**listFinancialEventsByOrderId**](DefaultApi.md#listfinancialeventsbyorderid) | **GET** /finances/v0/orders/{orderId}/financialEvents | + +# **listFinancialEventGroups** +> \Swagger\Client\Models\ListFinancialEventGroupsResponse listFinancialEventGroups($max_results_per_page, $financial_event_group_started_before, $financial_event_group_started_after, $next_token) + + + +Returns financial event groups for a given date range. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\DefaultApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$max_results_per_page = 100; // int | The maximum number of results to return per page. +$financial_event_group_started_before = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | A date used for selecting financial event groups that opened before (but not at) a specified date and time, in ISO 8601 format. The date-time must be later than FinancialEventGroupStartedAfter and no later than two minutes before the request was submitted. If FinancialEventGroupStartedAfter and FinancialEventGroupStartedBefore are more than 180 days apart, no financial event groups are returned. +$financial_event_group_started_after = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | A date used for selecting financial event groups that opened after (or at) a specified date and time, in ISO 8601 format. The date-time must be no later than two minutes before the request was submitted. +$next_token = "next_token_example"; // string | A string token returned in the response of your previous request. + +try { + $result = $apiInstance->listFinancialEventGroups($max_results_per_page, $financial_event_group_started_before, $financial_event_group_started_after, $next_token); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling DefaultApi->listFinancialEventGroups: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **max_results_per_page** | **int**| The maximum number of results to return per page. | [optional] [default to 100] + **financial_event_group_started_before** | **\DateTime**| A date used for selecting financial event groups that opened before (but not at) a specified date and time, in ISO 8601 format. The date-time must be later than FinancialEventGroupStartedAfter and no later than two minutes before the request was submitted. If FinancialEventGroupStartedAfter and FinancialEventGroupStartedBefore are more than 180 days apart, no financial event groups are returned. | [optional] + **financial_event_group_started_after** | **\DateTime**| A date used for selecting financial event groups that opened after (or at) a specified date and time, in ISO 8601 format. The date-time must be no later than two minutes before the request was submitted. | [optional] + **next_token** | **string**| A string token returned in the response of your previous request. | [optional] + +### Return type + +[**\Swagger\Client\Models\ListFinancialEventGroupsResponse**](../Model/ListFinancialEventGroupsResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **listFinancialEvents** +> \Swagger\Client\Models\ListFinancialEventsResponse listFinancialEvents($max_results_per_page, $posted_after, $posted_before, $next_token) + + + +Returns financial events for the specified data range. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\DefaultApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$max_results_per_page = 100; // int | The maximum number of results to return per page. +$posted_after = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | A date used for selecting financial events posted after (or at) a specified time. The date-time must be no later than two minutes before the request was submitted, in ISO 8601 date time format. +$posted_before = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | A date used for selecting financial events posted before (but not at) a specified time. The date-time must be later than PostedAfter and no later than two minutes before the request was submitted, in ISO 8601 date time format. If PostedAfter and PostedBefore are more than 180 days apart, no financial events are returned. You must specify the PostedAfter parameter if you specify the PostedBefore parameter. Default: Now minus two minutes. +$next_token = "next_token_example"; // string | A string token returned in the response of your previous request. + +try { + $result = $apiInstance->listFinancialEvents($max_results_per_page, $posted_after, $posted_before, $next_token); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling DefaultApi->listFinancialEvents: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **max_results_per_page** | **int**| The maximum number of results to return per page. | [optional] [default to 100] + **posted_after** | **\DateTime**| A date used for selecting financial events posted after (or at) a specified time. The date-time must be no later than two minutes before the request was submitted, in ISO 8601 date time format. | [optional] + **posted_before** | **\DateTime**| A date used for selecting financial events posted before (but not at) a specified time. The date-time must be later than PostedAfter and no later than two minutes before the request was submitted, in ISO 8601 date time format. If PostedAfter and PostedBefore are more than 180 days apart, no financial events are returned. You must specify the PostedAfter parameter if you specify the PostedBefore parameter. Default: Now minus two minutes. | [optional] + **next_token** | **string**| A string token returned in the response of your previous request. | [optional] + +### Return type + +[**\Swagger\Client\Models\ListFinancialEventsResponse**](../Model/ListFinancialEventsResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **listFinancialEventsByGroupId** +> \Swagger\Client\Models\ListFinancialEventsResponse listFinancialEventsByGroupId($event_group_id, $max_results_per_page, $next_token) + + + +Returns all financial events for the specified financial event group. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\DefaultApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$event_group_id = "event_group_id_example"; // string | The identifier of the financial event group to which the events belong. +$max_results_per_page = 100; // int | The maximum number of results to return per page. +$next_token = "next_token_example"; // string | A string token returned in the response of your previous request. + +try { + $result = $apiInstance->listFinancialEventsByGroupId($event_group_id, $max_results_per_page, $next_token); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling DefaultApi->listFinancialEventsByGroupId: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **event_group_id** | **string**| The identifier of the financial event group to which the events belong. | + **max_results_per_page** | **int**| The maximum number of results to return per page. | [optional] [default to 100] + **next_token** | **string**| A string token returned in the response of your previous request. | [optional] + +### Return type + +[**\Swagger\Client\Models\ListFinancialEventsResponse**](../Model/ListFinancialEventsResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **listFinancialEventsByOrderId** +> \Swagger\Client\Models\ListFinancialEventsResponse listFinancialEventsByOrderId($order_id, $max_results_per_page, $next_token) + + + +Returns all financial events for the specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\DefaultApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$order_id = "order_id_example"; // string | An Amazon-defined order identifier, in 3-7-7 format. +$max_results_per_page = 100; // int | The maximum number of results to return per page. +$next_token = "next_token_example"; // string | A string token returned in the response of your previous request. + +try { + $result = $apiInstance->listFinancialEventsByOrderId($order_id, $max_results_per_page, $next_token); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling DefaultApi->listFinancialEventsByOrderId: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **order_id** | **string**| An Amazon-defined order identifier, in 3-7-7 format. | + **max_results_per_page** | **int**| The maximum number of results to return per page. | [optional] [default to 100] + **next_token** | **string**| A string token returned in the response of your previous request. | [optional] + +### Return type + +[**\Swagger\Client\Models\ListFinancialEventsResponse**](../Model/ListFinancialEventsResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + diff --git a/FbaInboundApi.md b/FbaInboundApi.md new file mode 100644 index 00000000..bd3fe92c --- /dev/null +++ b/FbaInboundApi.md @@ -0,0 +1,1028 @@ +# Swagger\Client\FbaInboundApi + +All URIs are relative to *https://sellingpartnerapi-na.amazon.com/* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**confirmPreorder**](FbaInboundApi.md#confirmpreorder) | **PUT** /fba/inbound/v0/shipments/{shipmentId}/preorder/confirm | +[**confirmTransport**](FbaInboundApi.md#confirmtransport) | **POST** /fba/inbound/v0/shipments/{shipmentId}/transport/confirm | +[**createInboundShipment**](FbaInboundApi.md#createinboundshipment) | **POST** /fba/inbound/v0/shipments/{shipmentId} | +[**createInboundShipmentPlan**](FbaInboundApi.md#createinboundshipmentplan) | **POST** /fba/inbound/v0/plans | +[**estimateTransport**](FbaInboundApi.md#estimatetransport) | **POST** /fba/inbound/v0/shipments/{shipmentId}/transport/estimate | +[**getBillOfLading**](FbaInboundApi.md#getbilloflading) | **GET** /fba/inbound/v0/shipments/{shipmentId}/billOfLading | +[**getInboundGuidance**](FbaInboundApi.md#getinboundguidance) | **GET** /fba/inbound/v0/itemsGuidance | +[**getLabels**](FbaInboundApi.md#getlabels) | **GET** /fba/inbound/v0/shipments/{shipmentId}/labels | +[**getPreorderInfo**](FbaInboundApi.md#getpreorderinfo) | **GET** /fba/inbound/v0/shipments/{shipmentId}/preorder | +[**getPrepInstructions**](FbaInboundApi.md#getprepinstructions) | **GET** /fba/inbound/v0/prepInstructions | +[**getShipmentItems**](FbaInboundApi.md#getshipmentitems) | **GET** /fba/inbound/v0/shipmentItems | +[**getShipmentItemsByShipmentId**](FbaInboundApi.md#getshipmentitemsbyshipmentid) | **GET** /fba/inbound/v0/shipments/{shipmentId}/items | +[**getShipments**](FbaInboundApi.md#getshipments) | **GET** /fba/inbound/v0/shipments | +[**getTransportDetails**](FbaInboundApi.md#gettransportdetails) | **GET** /fba/inbound/v0/shipments/{shipmentId}/transport | +[**putTransportDetails**](FbaInboundApi.md#puttransportdetails) | **PUT** /fba/inbound/v0/shipments/{shipmentId}/transport | +[**updateInboundShipment**](FbaInboundApi.md#updateinboundshipment) | **PUT** /fba/inbound/v0/shipments/{shipmentId} | +[**voidTransport**](FbaInboundApi.md#voidtransport) | **POST** /fba/inbound/v0/shipments/{shipmentId}/transport/void | + +# **confirmPreorder** +> \Swagger\Client\Models\ConfirmPreorderResponse confirmPreorder($shipment_id, $need_by_date, $marketplace_id) + + + +Returns information needed to confirm a shipment for pre-order. Call this operation after calling the getPreorderInfo operation to get the NeedByDate value and other pre-order information about the shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\FbaInboundApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$shipment_id = "shipment_id_example"; // string | A shipment identifier originally returned by the createInboundShipmentPlan operation. +$need_by_date = new \DateTime("2013-10-20"); // \DateTime | Date that the shipment must arrive at the Amazon fulfillment center to avoid delivery promise breaks for pre-ordered items. Must be in YYYY-MM-DD format. The response to the getPreorderInfo operation returns this value. +$marketplace_id = "marketplace_id_example"; // string | A marketplace identifier. Specifies the marketplace the shipment is tied to. + +try { + $result = $apiInstance->confirmPreorder($shipment_id, $need_by_date, $marketplace_id); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling FbaInboundApi->confirmPreorder: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **shipment_id** | **string**| A shipment identifier originally returned by the createInboundShipmentPlan operation. | + **need_by_date** | **\DateTime**| Date that the shipment must arrive at the Amazon fulfillment center to avoid delivery promise breaks for pre-ordered items. Must be in YYYY-MM-DD format. The response to the getPreorderInfo operation returns this value. | + **marketplace_id** | **string**| A marketplace identifier. Specifies the marketplace the shipment is tied to. | + +### Return type + +[**\Swagger\Client\Models\ConfirmPreorderResponse**](../Model/ConfirmPreorderResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **confirmTransport** +> \Swagger\Client\Models\ConfirmTransportResponse confirmTransport($shipment_id) + + + +Confirms that the seller accepts the Amazon-partnered shipping estimate, agrees to allow Amazon to charge their account for the shipping cost, and requests that the Amazon-partnered carrier ship the inbound shipment. Prior to calling the confirmTransport operation, you should call the getTransportDetails operation to get the Amazon-partnered shipping estimate. Important: After confirming the transportation request, if the seller decides that they do not want the Amazon-partnered carrier to ship the inbound shipment, you can call the voidTransport operation to cancel the transportation request. Note that for a Small Parcel shipment, the seller has 24 hours after confirming a transportation request to void the transportation request. For a Less Than Truckload/Full Truckload (LTL/FTL) shipment, the seller has one hour after confirming a transportation request to void it. After the grace period has expired the seller's account will be charged for the shipping cost. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\FbaInboundApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$shipment_id = "shipment_id_example"; // string | A shipment identifier originally returned by the createInboundShipmentPlan operation. + +try { + $result = $apiInstance->confirmTransport($shipment_id); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling FbaInboundApi->confirmTransport: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **shipment_id** | **string**| A shipment identifier originally returned by the createInboundShipmentPlan operation. | + +### Return type + +[**\Swagger\Client\Models\ConfirmTransportResponse**](../Model/ConfirmTransportResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **createInboundShipment** +> \Swagger\Client\Models\InboundShipmentResponse createInboundShipment($body, $shipment_id) + + + +Returns a new inbound shipment based on the specified shipmentId that was returned by the createInboundShipmentPlan operation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\FbaInboundApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$body = new \Swagger\Client\Models\InboundShipmentRequest(); // \Swagger\Client\Models\InboundShipmentRequest | +$shipment_id = "shipment_id_example"; // string | A shipment identifier originally returned by the createInboundShipmentPlan operation. + +try { + $result = $apiInstance->createInboundShipment($body, $shipment_id); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling FbaInboundApi->createInboundShipment: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**\Swagger\Client\Models\InboundShipmentRequest**](../Model/InboundShipmentRequest.md)| | + **shipment_id** | **string**| A shipment identifier originally returned by the createInboundShipmentPlan operation. | + +### Return type + +[**\Swagger\Client\Models\InboundShipmentResponse**](../Model/InboundShipmentResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **createInboundShipmentPlan** +> \Swagger\Client\Models\CreateInboundShipmentPlanResponse createInboundShipmentPlan($body) + + + +Returns one or more inbound shipment plans, which provide the information you need to create one or more inbound shipments for a set of items that you specify. Multiple inbound shipment plans might be required so that items can be optimally placed in Amazon's fulfillment network—for example, positioning inventory closer to the customer. Alternatively, two inbound shipment plans might be created with the same Amazon fulfillment center destination if the two shipment plans require different processing—for example, items that require labels must be shipped separately from stickerless, commingled inventory. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\FbaInboundApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$body = new \Swagger\Client\Models\CreateInboundShipmentPlanRequest(); // \Swagger\Client\Models\CreateInboundShipmentPlanRequest | + +try { + $result = $apiInstance->createInboundShipmentPlan($body); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling FbaInboundApi->createInboundShipmentPlan: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**\Swagger\Client\Models\CreateInboundShipmentPlanRequest**](../Model/CreateInboundShipmentPlanRequest.md)| | + +### Return type + +[**\Swagger\Client\Models\CreateInboundShipmentPlanResponse**](../Model/CreateInboundShipmentPlanResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **estimateTransport** +> \Swagger\Client\Models\EstimateTransportResponse estimateTransport($shipment_id) + + + +Initiates the process of estimating the shipping cost for an inbound shipment by an Amazon-partnered carrier. Prior to calling the estimateTransport operation, you must call the putTransportDetails operation to provide Amazon with the transportation information for the inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\FbaInboundApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$shipment_id = "shipment_id_example"; // string | A shipment identifier originally returned by the createInboundShipmentPlan operation. + +try { + $result = $apiInstance->estimateTransport($shipment_id); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling FbaInboundApi->estimateTransport: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **shipment_id** | **string**| A shipment identifier originally returned by the createInboundShipmentPlan operation. | + +### Return type + +[**\Swagger\Client\Models\EstimateTransportResponse**](../Model/EstimateTransportResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **getBillOfLading** +> \Swagger\Client\Models\GetBillOfLadingResponse getBillOfLading($shipment_id) + + + +Returns a bill of lading for a Less Than Truckload/Full Truckload (LTL/FTL) shipment. The getBillOfLading operation returns PDF document data for printing a bill of lading for an Amazon-partnered Less Than Truckload/Full Truckload (LTL/FTL) inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\FbaInboundApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$shipment_id = "shipment_id_example"; // string | A shipment identifier originally returned by the createInboundShipmentPlan operation. + +try { + $result = $apiInstance->getBillOfLading($shipment_id); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling FbaInboundApi->getBillOfLading: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **shipment_id** | **string**| A shipment identifier originally returned by the createInboundShipmentPlan operation. | + +### Return type + +[**\Swagger\Client\Models\GetBillOfLadingResponse**](../Model/GetBillOfLadingResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **getInboundGuidance** +> \Swagger\Client\Models\GetInboundGuidanceResponse getInboundGuidance($marketplace_id, $seller_sku_list, $asin_list) + + + +Returns information that lets a seller know if Amazon recommends sending an item to a given marketplace. In some cases, Amazon provides guidance for why a given SellerSKU or ASIN is not recommended for shipment to Amazon's fulfillment network. Sellers may still ship items that are not recommended, at their discretion. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\FbaInboundApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$marketplace_id = "marketplace_id_example"; // string | A marketplace identifier. Specifies the marketplace where the product would be stored. +$seller_sku_list = array("seller_sku_list_example"); // string[] | A list of SellerSKU values. Used to identify items for which you want inbound guidance for shipment to Amazon's fulfillment network. Note: SellerSKU is qualified by the SellerId, which is included with every Selling Partner API operation that you submit. If you specify a SellerSKU that identifies a variation parent ASIN, this operation returns an error. A variation parent ASIN represents a generic product that cannot be sold. Variation child ASINs represent products that have specific characteristics (such as size and color) and can be sold. +$asin_list = array("asin_list_example"); // string[] | A list of ASIN values. Used to identify items for which you want inbound guidance for shipment to Amazon's fulfillment network. Note: If you specify a ASIN that identifies a variation parent ASIN, this operation returns an error. A variation parent ASIN represents a generic product that cannot be sold. Variation child ASINs represent products that have specific characteristics (such as size and color) and can be sold. + +try { + $result = $apiInstance->getInboundGuidance($marketplace_id, $seller_sku_list, $asin_list); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling FbaInboundApi->getInboundGuidance: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **marketplace_id** | **string**| A marketplace identifier. Specifies the marketplace where the product would be stored. | + **seller_sku_list** | [**string[]**](../Model/string.md)| A list of SellerSKU values. Used to identify items for which you want inbound guidance for shipment to Amazon's fulfillment network. Note: SellerSKU is qualified by the SellerId, which is included with every Selling Partner API operation that you submit. If you specify a SellerSKU that identifies a variation parent ASIN, this operation returns an error. A variation parent ASIN represents a generic product that cannot be sold. Variation child ASINs represent products that have specific characteristics (such as size and color) and can be sold. | [optional] + **asin_list** | [**string[]**](../Model/string.md)| A list of ASIN values. Used to identify items for which you want inbound guidance for shipment to Amazon's fulfillment network. Note: If you specify a ASIN that identifies a variation parent ASIN, this operation returns an error. A variation parent ASIN represents a generic product that cannot be sold. Variation child ASINs represent products that have specific characteristics (such as size and color) and can be sold. | [optional] + +### Return type + +[**\Swagger\Client\Models\GetInboundGuidanceResponse**](../Model/GetInboundGuidanceResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **getLabels** +> \Swagger\Client\Models\GetLabelsResponse getLabels($shipment_id, $page_type, $label_type, $number_of_packages, $package_labels_to_print, $number_of_pallets) + + + +Returns package/pallet labels for faster and more accurate shipment processing at the Amazon fulfillment center. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\FbaInboundApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$shipment_id = "shipment_id_example"; // string | A shipment identifier originally returned by the createInboundShipmentPlan operation. +$page_type = "page_type_example"; // string | The page type to use to print the labels. Submitting a PageType value that is not supported in your marketplace returns an error. +$label_type = "label_type_example"; // string | The type of labels requested. +$number_of_packages = 56; // int | The number of packages in the shipment. +$package_labels_to_print = array("package_labels_to_print_example"); // string[] | A list of identifiers that specify packages for which you want package labels printed. Must match CartonId values previously passed using the FBA Inbound Shipment Carton Information Feed. If not, the operation returns the IncorrectPackageIdentifier error code. +$number_of_pallets = 56; // int | The number of pallets in the shipment. This returns four identical labels for each pallet. + +try { + $result = $apiInstance->getLabels($shipment_id, $page_type, $label_type, $number_of_packages, $package_labels_to_print, $number_of_pallets); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling FbaInboundApi->getLabels: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **shipment_id** | **string**| A shipment identifier originally returned by the createInboundShipmentPlan operation. | + **page_type** | **string**| The page type to use to print the labels. Submitting a PageType value that is not supported in your marketplace returns an error. | + **label_type** | **string**| The type of labels requested. | + **number_of_packages** | **int**| The number of packages in the shipment. | [optional] + **package_labels_to_print** | [**string[]**](../Model/string.md)| A list of identifiers that specify packages for which you want package labels printed. Must match CartonId values previously passed using the FBA Inbound Shipment Carton Information Feed. If not, the operation returns the IncorrectPackageIdentifier error code. | [optional] + **number_of_pallets** | **int**| The number of pallets in the shipment. This returns four identical labels for each pallet. | [optional] + +### Return type + +[**\Swagger\Client\Models\GetLabelsResponse**](../Model/GetLabelsResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **getPreorderInfo** +> \Swagger\Client\Models\GetPreorderInfoResponse getPreorderInfo($shipment_id, $marketplace_id) + + + +Returns pre-order information, including dates, that a seller needs before confirming a shipment for pre-order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\FbaInboundApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$shipment_id = "shipment_id_example"; // string | A shipment identifier originally returned by the createInboundShipmentPlan operation. +$marketplace_id = "marketplace_id_example"; // string | A marketplace identifier. Specifies the marketplace the shipment is tied to. + +try { + $result = $apiInstance->getPreorderInfo($shipment_id, $marketplace_id); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling FbaInboundApi->getPreorderInfo: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **shipment_id** | **string**| A shipment identifier originally returned by the createInboundShipmentPlan operation. | + **marketplace_id** | **string**| A marketplace identifier. Specifies the marketplace the shipment is tied to. | + +### Return type + +[**\Swagger\Client\Models\GetPreorderInfoResponse**](../Model/GetPreorderInfoResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **getPrepInstructions** +> \Swagger\Client\Models\GetPrepInstructionsResponse getPrepInstructions($ship_to_country_code, $seller_sku_list, $asin_list) + + + +Returns labeling requirements and item preparation instructions to help prepare items for shipment to Amazon's fulfillment network. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\FbaInboundApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$ship_to_country_code = "ship_to_country_code_example"; // string | The country code of the country to which the items will be shipped. Note that labeling requirements and item preparation instructions can vary by country. +$seller_sku_list = array("seller_sku_list_example"); // string[] | A list of SellerSKU values. Used to identify items for which you want labeling requirements and item preparation instructions for shipment to Amazon's fulfillment network. The SellerSKU is qualified by the Seller ID, which is included with every call to the Seller Partner API. Note: Include seller SKUs that you have used to list items on Amazon's retail website. If you include a seller SKU that you have never used to list an item on Amazon's retail website, the seller SKU is returned in the InvalidSKUList property in the response. +$asin_list = array("asin_list_example"); // string[] | A list of ASIN values. Used to identify items for which you want item preparation instructions to help with item sourcing decisions. Note: ASINs must be included in the product catalog for at least one of the marketplaces that the seller participates in. Any ASIN that is not included in the product catalog for at least one of the marketplaces that the seller participates in is returned in the InvalidASINList property in the response. You can find out which marketplaces a seller participates in by calling the getMarketplaceParticipations operation in the Selling Partner API for Sellers. + +try { + $result = $apiInstance->getPrepInstructions($ship_to_country_code, $seller_sku_list, $asin_list); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling FbaInboundApi->getPrepInstructions: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ship_to_country_code** | **string**| The country code of the country to which the items will be shipped. Note that labeling requirements and item preparation instructions can vary by country. | + **seller_sku_list** | [**string[]**](../Model/string.md)| A list of SellerSKU values. Used to identify items for which you want labeling requirements and item preparation instructions for shipment to Amazon's fulfillment network. The SellerSKU is qualified by the Seller ID, which is included with every call to the Seller Partner API. Note: Include seller SKUs that you have used to list items on Amazon's retail website. If you include a seller SKU that you have never used to list an item on Amazon's retail website, the seller SKU is returned in the InvalidSKUList property in the response. | [optional] + **asin_list** | [**string[]**](../Model/string.md)| A list of ASIN values. Used to identify items for which you want item preparation instructions to help with item sourcing decisions. Note: ASINs must be included in the product catalog for at least one of the marketplaces that the seller participates in. Any ASIN that is not included in the product catalog for at least one of the marketplaces that the seller participates in is returned in the InvalidASINList property in the response. You can find out which marketplaces a seller participates in by calling the getMarketplaceParticipations operation in the Selling Partner API for Sellers. | [optional] + +### Return type + +[**\Swagger\Client\Models\GetPrepInstructionsResponse**](../Model/GetPrepInstructionsResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **getShipmentItems** +> \Swagger\Client\Models\GetShipmentItemsResponse getShipmentItems($query_type, $marketplace_id, $last_updated_after, $last_updated_before, $next_token) + + + +Returns a list of items in a specified inbound shipment, or a list of items that were updated within a specified time frame. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\FbaInboundApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$query_type = "query_type_example"; // string | Indicates whether items are returned using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or using NextToken, which continues returning items specified in a previous request. +$marketplace_id = "marketplace_id_example"; // string | A marketplace identifier. Specifies the marketplace where the product would be stored. +$last_updated_after = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | A date used for selecting inbound shipment items that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller. +$last_updated_before = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | A date used for selecting inbound shipment items that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller. +$next_token = "next_token_example"; // string | A string token returned in the response to your previous request. + +try { + $result = $apiInstance->getShipmentItems($query_type, $marketplace_id, $last_updated_after, $last_updated_before, $next_token); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling FbaInboundApi->getShipmentItems: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query_type** | **string**| Indicates whether items are returned using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or using NextToken, which continues returning items specified in a previous request. | + **marketplace_id** | **string**| A marketplace identifier. Specifies the marketplace where the product would be stored. | + **last_updated_after** | **\DateTime**| A date used for selecting inbound shipment items that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller. | [optional] + **last_updated_before** | **\DateTime**| A date used for selecting inbound shipment items that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller. | [optional] + **next_token** | **string**| A string token returned in the response to your previous request. | [optional] + +### Return type + +[**\Swagger\Client\Models\GetShipmentItemsResponse**](../Model/GetShipmentItemsResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **getShipmentItemsByShipmentId** +> \Swagger\Client\Models\GetShipmentItemsResponse getShipmentItemsByShipmentId($shipment_id, $marketplace_id) + + + +Returns a list of items in a specified inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\FbaInboundApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$shipment_id = "shipment_id_example"; // string | A shipment identifier used for selecting items in a specific inbound shipment. +$marketplace_id = "marketplace_id_example"; // string | A marketplace identifier. Specifies the marketplace where the product would be stored. + +try { + $result = $apiInstance->getShipmentItemsByShipmentId($shipment_id, $marketplace_id); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling FbaInboundApi->getShipmentItemsByShipmentId: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **shipment_id** | **string**| A shipment identifier used for selecting items in a specific inbound shipment. | + **marketplace_id** | **string**| A marketplace identifier. Specifies the marketplace where the product would be stored. | + +### Return type + +[**\Swagger\Client\Models\GetShipmentItemsResponse**](../Model/GetShipmentItemsResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **getShipments** +> \Swagger\Client\Models\GetShipmentsResponse getShipments($query_type, $marketplace_id, $shipment_status_list, $shipment_id_list, $last_updated_after, $last_updated_before, $next_token) + + + +Returns a list of inbound shipments based on criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\FbaInboundApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$query_type = "query_type_example"; // string | Indicates whether shipments are returned using shipment information (by providing the ShipmentStatusList or ShipmentIdList parameters), using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or by using NextToken to continue returning items specified in a previous request. +$marketplace_id = "marketplace_id_example"; // string | A marketplace identifier. Specifies the marketplace where the product would be stored. +$shipment_status_list = array("shipment_status_list_example"); // string[] | A list of ShipmentStatus values. Used to select shipments with a current status that matches the status values that you specify. +$shipment_id_list = array("shipment_id_list_example"); // string[] | A list of shipment IDs used to select the shipments that you want. If both ShipmentStatusList and ShipmentIdList are specified, only shipments that match both parameters are returned. +$last_updated_after = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | A date used for selecting inbound shipments that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller. +$last_updated_before = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | A date used for selecting inbound shipments that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller. +$next_token = "next_token_example"; // string | A string token returned in the response to your previous request. + +try { + $result = $apiInstance->getShipments($query_type, $marketplace_id, $shipment_status_list, $shipment_id_list, $last_updated_after, $last_updated_before, $next_token); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling FbaInboundApi->getShipments: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query_type** | **string**| Indicates whether shipments are returned using shipment information (by providing the ShipmentStatusList or ShipmentIdList parameters), using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or by using NextToken to continue returning items specified in a previous request. | + **marketplace_id** | **string**| A marketplace identifier. Specifies the marketplace where the product would be stored. | + **shipment_status_list** | [**string[]**](../Model/string.md)| A list of ShipmentStatus values. Used to select shipments with a current status that matches the status values that you specify. | [optional] + **shipment_id_list** | [**string[]**](../Model/string.md)| A list of shipment IDs used to select the shipments that you want. If both ShipmentStatusList and ShipmentIdList are specified, only shipments that match both parameters are returned. | [optional] + **last_updated_after** | **\DateTime**| A date used for selecting inbound shipments that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller. | [optional] + **last_updated_before** | **\DateTime**| A date used for selecting inbound shipments that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller. | [optional] + **next_token** | **string**| A string token returned in the response to your previous request. | [optional] + +### Return type + +[**\Swagger\Client\Models\GetShipmentsResponse**](../Model/GetShipmentsResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **getTransportDetails** +> \Swagger\Client\Models\GetTransportDetailsResponse getTransportDetails($shipment_id) + + + +Returns current transportation information about an inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\FbaInboundApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$shipment_id = "shipment_id_example"; // string | A shipment identifier originally returned by the createInboundShipmentPlan operation. + +try { + $result = $apiInstance->getTransportDetails($shipment_id); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling FbaInboundApi->getTransportDetails: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **shipment_id** | **string**| A shipment identifier originally returned by the createInboundShipmentPlan operation. | + +### Return type + +[**\Swagger\Client\Models\GetTransportDetailsResponse**](../Model/GetTransportDetailsResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **putTransportDetails** +> \Swagger\Client\Models\PutTransportDetailsResponse putTransportDetails($body, $shipment_id) + + + +Sends transportation information to Amazon about an inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\FbaInboundApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$body = new \Swagger\Client\Models\PutTransportDetailsRequest(); // \Swagger\Client\Models\PutTransportDetailsRequest | +$shipment_id = "shipment_id_example"; // string | A shipment identifier originally returned by the createInboundShipmentPlan operation. + +try { + $result = $apiInstance->putTransportDetails($body, $shipment_id); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling FbaInboundApi->putTransportDetails: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**\Swagger\Client\Models\PutTransportDetailsRequest**](../Model/PutTransportDetailsRequest.md)| | + **shipment_id** | **string**| A shipment identifier originally returned by the createInboundShipmentPlan operation. | + +### Return type + +[**\Swagger\Client\Models\PutTransportDetailsResponse**](../Model/PutTransportDetailsResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **updateInboundShipment** +> \Swagger\Client\Models\InboundShipmentResponse updateInboundShipment($body, $shipment_id) + + + +Adds, updates, or removes items from the inbound shipment identified by the specified shipment identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\FbaInboundApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$body = new \Swagger\Client\Models\InboundShipmentRequest(); // \Swagger\Client\Models\InboundShipmentRequest | +$shipment_id = "shipment_id_example"; // string | A shipment identifier originally returned by the createInboundShipmentPlan operation. + +try { + $result = $apiInstance->updateInboundShipment($body, $shipment_id); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling FbaInboundApi->updateInboundShipment: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**\Swagger\Client\Models\InboundShipmentRequest**](../Model/InboundShipmentRequest.md)| | + **shipment_id** | **string**| A shipment identifier originally returned by the createInboundShipmentPlan operation. | + +### Return type + +[**\Swagger\Client\Models\InboundShipmentResponse**](../Model/InboundShipmentResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **voidTransport** +> \Swagger\Client\Models\VoidTransportResponse voidTransport($shipment_id) + + + +Cancels a previously-confirmed request to ship an inbound shipment using an Amazon-partnered carrier. To be successful, you must call this operation before the VoidDeadline date that is returned by the getTransportDetails operation. Important: The VoidDeadline date is 24 hours after you confirm a Small Parcel shipment transportation request or one hour after you confirm a Less Than Truckload/Full Truckload (LTL/FTL) shipment transportation request. After the void deadline passes, your account will be charged for the shipping cost. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\FbaInboundApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$shipment_id = "shipment_id_example"; // string | A shipment identifier originally returned by the createInboundShipmentPlan operation. + +try { + $result = $apiInstance->voidTransport($shipment_id); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling FbaInboundApi->voidTransport: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **shipment_id** | **string**| A shipment identifier originally returned by the createInboundShipmentPlan operation. | + +### Return type + +[**\Swagger\Client\Models\VoidTransportResponse**](../Model/VoidTransportResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + diff --git a/FbaInventoryApi.md b/FbaInventoryApi.md new file mode 100644 index 00000000..1ffcbe70 --- /dev/null +++ b/FbaInventoryApi.md @@ -0,0 +1,76 @@ +# Swagger\Client\FbaInventoryApi + +All URIs are relative to *https://sellingpartnerapi-na.amazon.com/* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getInventorySummaries**](FbaInventoryApi.md#getinventorysummaries) | **GET** /fba/inventory/v1/summaries | + +# **getInventorySummaries** +> \Swagger\Client\Models\GetInventorySummariesResponse getInventorySummaries($granularity_type, $granularity_id, $marketplace_ids, $details, $start_date_time, $seller_skus, $next_token) + + + +Returns a list of inventory summaries. The summaries returned depend on the presence or absence of the startDateTime and sellerSkus parameters: - All inventory summaries with available details are returned when the startDateTime and sellerSkus parameters are omitted. - When startDateTime is provided, the operation returns inventory summaries that have had changes after the date and time specified. The sellerSkus parameter is ignored. - When the sellerSkus parameter is provided, the operation returns inventory summaries for only the specified sellerSkus. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 90 | 150 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\FbaInventoryApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$granularity_type = "granularity_type_example"; // string | The granularity type for the inventory aggregation level. +$granularity_id = "granularity_id_example"; // string | The granularity ID for the inventory aggregation level. +$marketplace_ids = array("marketplace_ids_example"); // string[] | The marketplace ID for the marketplace for which to return inventory summaries. +$details = false; // bool | true to return inventory summaries with additional summarized inventory details and quantities. Otherwise, returns inventory summaries only (default value). +$start_date_time = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | A start date and time in ISO8601 format. If specified, all inventory summaries that have changed since then are returned. You must specify a date and time that is no earlier than 18 months prior to the date and time when you call the API. Note: Changes in inboundWorkingQuantity, inboundShippedQuantity and inboundReceivingQuantity are not detected. +$seller_skus = array("seller_skus_example"); // string[] | A list of seller SKUs for which to return inventory summaries. You may specify up to 50 SKUs. +$next_token = "next_token_example"; // string | String token returned in the response of your previous request. + +try { + $result = $apiInstance->getInventorySummaries($granularity_type, $granularity_id, $marketplace_ids, $details, $start_date_time, $seller_skus, $next_token); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling FbaInventoryApi->getInventorySummaries: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **granularity_type** | **string**| The granularity type for the inventory aggregation level. | + **granularity_id** | **string**| The granularity ID for the inventory aggregation level. | + **marketplace_ids** | [**string[]**](../Model/string.md)| The marketplace ID for the marketplace for which to return inventory summaries. | + **details** | **bool**| true to return inventory summaries with additional summarized inventory details and quantities. Otherwise, returns inventory summaries only (default value). | [optional] [default to false] + **start_date_time** | **\DateTime**| A start date and time in ISO8601 format. If specified, all inventory summaries that have changed since then are returned. You must specify a date and time that is no earlier than 18 months prior to the date and time when you call the API. Note: Changes in inboundWorkingQuantity, inboundShippedQuantity and inboundReceivingQuantity are not detected. | [optional] + **seller_skus** | [**string[]**](../Model/string.md)| A list of seller SKUs for which to return inventory summaries. You may specify up to 50 SKUs. | [optional] + **next_token** | **string**| String token returned in the response of your previous request. | [optional] + +### Return type + +[**\Swagger\Client\Models\GetInventorySummariesResponse**](../Model/GetInventorySummariesResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + diff --git a/FbaOutboundApi.md b/FbaOutboundApi.md new file mode 100644 index 00000000..e9459e3a --- /dev/null +++ b/FbaOutboundApi.md @@ -0,0 +1,543 @@ +# Swagger\Client\FbaOutboundApi + +All URIs are relative to *https://sellingpartnerapi-na.amazon.com/* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**cancelFulfillmentOrder**](FbaOutboundApi.md#cancelfulfillmentorder) | **PUT** /fba/outbound/v0/fulfillmentOrders/{sellerFulfillmentOrderId}/cancel | +[**createFulfillmentOrder**](FbaOutboundApi.md#createfulfillmentorder) | **POST** /fba/outbound/v0/fulfillmentOrders | +[**createFulfillmentReturn**](FbaOutboundApi.md#createfulfillmentreturn) | **PUT** /fba/outbound/v0/fulfillmentOrders/{sellerFulfillmentOrderId}/return | +[**getFulfillmentOrder**](FbaOutboundApi.md#getfulfillmentorder) | **GET** /fba/outbound/v0/fulfillmentOrders/{sellerFulfillmentOrderId} | +[**getFulfillmentPreview**](FbaOutboundApi.md#getfulfillmentpreview) | **POST** /fba/outbound/v0/fulfillmentOrders/preview | +[**getPackageTrackingDetails**](FbaOutboundApi.md#getpackagetrackingdetails) | **GET** /fba/outbound/v0/tracking | +[**listAllFulfillmentOrders**](FbaOutboundApi.md#listallfulfillmentorders) | **GET** /fba/outbound/v0/fulfillmentOrders | +[**listReturnReasonCodes**](FbaOutboundApi.md#listreturnreasoncodes) | **GET** /fba/outbound/v0/returnReasonCodes | +[**updateFulfillmentOrder**](FbaOutboundApi.md#updatefulfillmentorder) | **PUT** /fba/outbound/v0/fulfillmentOrders/{sellerFulfillmentOrderId} | + +# **cancelFulfillmentOrder** +> \Swagger\Client\Models\CancelFulfillmentOrderResponse cancelFulfillmentOrder($seller_fulfillment_order_id) + + + +Requests that Amazon stop attempting to fulfill the fulfillment order indicated by the specified order identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + + +$apiInstance = new Swagger\Client\Api\FbaOutboundApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$seller_fulfillment_order_id = "seller_fulfillment_order_id_example"; // string | The identifier assigned to the item by the seller when the fulfillment order was created. + +try { + $result = $apiInstance->cancelFulfillmentOrder($seller_fulfillment_order_id); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling FbaOutboundApi->cancelFulfillmentOrder: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **seller_fulfillment_order_id** | **string**| The identifier assigned to the item by the seller when the fulfillment order was created. | + +### Return type + +[**\Swagger\Client\Models\CancelFulfillmentOrderResponse**](../Model/CancelFulfillmentOrderResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **createFulfillmentOrder** +> \Swagger\Client\Models\CreateFulfillmentOrderResponse createFulfillmentOrder($body) + + + +Requests that Amazon ship items from the seller's inventory in Amazon's fulfillment network to a destination address. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + + +$apiInstance = new Swagger\Client\Api\FbaOutboundApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$body = new \Swagger\Client\Models\CreateFulfillmentOrderRequest(); // \Swagger\Client\Models\CreateFulfillmentOrderRequest | + +try { + $result = $apiInstance->createFulfillmentOrder($body); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling FbaOutboundApi->createFulfillmentOrder: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**\Swagger\Client\Models\CreateFulfillmentOrderRequest**](../Model/CreateFulfillmentOrderRequest.md)| | + +### Return type + +[**\Swagger\Client\Models\CreateFulfillmentOrderResponse**](../Model/CreateFulfillmentOrderResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **createFulfillmentReturn** +> \Swagger\Client\Models\CreateFulfillmentReturnResponse createFulfillmentReturn($body, $seller_fulfillment_order_id) + + + +Creates a fulfillment return. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + + +$apiInstance = new Swagger\Client\Api\FbaOutboundApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$body = new \Swagger\Client\Models\CreateFulfillmentReturnRequest(); // \Swagger\Client\Models\CreateFulfillmentReturnRequest | +$seller_fulfillment_order_id = "seller_fulfillment_order_id_example"; // string | An identifier assigned by the seller to the fulfillment order at the time it was created. The seller uses their own records to find the correct SellerFulfillmentOrderId value based on the buyer's request to return items. + +try { + $result = $apiInstance->createFulfillmentReturn($body, $seller_fulfillment_order_id); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling FbaOutboundApi->createFulfillmentReturn: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**\Swagger\Client\Models\CreateFulfillmentReturnRequest**](../Model/CreateFulfillmentReturnRequest.md)| | + **seller_fulfillment_order_id** | **string**| An identifier assigned by the seller to the fulfillment order at the time it was created. The seller uses their own records to find the correct SellerFulfillmentOrderId value based on the buyer's request to return items. | + +### Return type + +[**\Swagger\Client\Models\CreateFulfillmentReturnResponse**](../Model/CreateFulfillmentReturnResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **getFulfillmentOrder** +> \Swagger\Client\Models\GetFulfillmentOrderResponse getFulfillmentOrder($seller_fulfillment_order_id) + + + +Returns the fulfillment order indicated by the specified order identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + + +$apiInstance = new Swagger\Client\Api\FbaOutboundApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$seller_fulfillment_order_id = "seller_fulfillment_order_id_example"; // string | The identifier assigned to the item by the seller when the fulfillment order was created. + +try { + $result = $apiInstance->getFulfillmentOrder($seller_fulfillment_order_id); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling FbaOutboundApi->getFulfillmentOrder: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **seller_fulfillment_order_id** | **string**| The identifier assigned to the item by the seller when the fulfillment order was created. | + +### Return type + +[**\Swagger\Client\Models\GetFulfillmentOrderResponse**](../Model/GetFulfillmentOrderResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **getFulfillmentPreview** +> \Swagger\Client\Models\GetFulfillmentPreviewResponse getFulfillmentPreview($body) + + + +Returns a list of fulfillment order previews based on shipping criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + + +$apiInstance = new Swagger\Client\Api\FbaOutboundApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$body = new \Swagger\Client\Models\GetFulfillmentPreviewRequest(); // \Swagger\Client\Models\GetFulfillmentPreviewRequest | + +try { + $result = $apiInstance->getFulfillmentPreview($body); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling FbaOutboundApi->getFulfillmentPreview: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**\Swagger\Client\Models\GetFulfillmentPreviewRequest**](../Model/GetFulfillmentPreviewRequest.md)| | + +### Return type + +[**\Swagger\Client\Models\GetFulfillmentPreviewResponse**](../Model/GetFulfillmentPreviewResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **getPackageTrackingDetails** +> \Swagger\Client\Models\GetPackageTrackingDetailsResponse getPackageTrackingDetails($package_number) + + + +Returns delivery tracking information for a package in an outbound shipment for a Multi-Channel Fulfillment order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + + +$apiInstance = new Swagger\Client\Api\FbaOutboundApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$package_number = 56; // int | The unencrypted package identifier returned by the getFulfillmentOrder operation. + +try { + $result = $apiInstance->getPackageTrackingDetails($package_number); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling FbaOutboundApi->getPackageTrackingDetails: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **package_number** | **int**| The unencrypted package identifier returned by the getFulfillmentOrder operation. | + +### Return type + +[**\Swagger\Client\Models\GetPackageTrackingDetailsResponse**](../Model/GetPackageTrackingDetailsResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **listAllFulfillmentOrders** +> \Swagger\Client\Models\ListAllFulfillmentOrdersResponse listAllFulfillmentOrders($query_start_date_time, $fulfillment_method, $next_token) + + + +Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the next token parameter. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + + +$apiInstance = new Swagger\Client\Api\FbaOutboundApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$query_start_date_time = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | A date and time used to select fulfillment orders that were last updated after (or at) a specified time. An update is defined as any change in fulfillment order status, including the creation of a new fulfillment order. +$fulfillment_method = array("fulfillment_method_example"); // string[] | Indicates the intended recipient channel for the order. +$next_token = "next_token_example"; // string | A string token returned in the response to your previous request. + +try { + $result = $apiInstance->listAllFulfillmentOrders($query_start_date_time, $fulfillment_method, $next_token); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling FbaOutboundApi->listAllFulfillmentOrders: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query_start_date_time** | **\DateTime**| A date and time used to select fulfillment orders that were last updated after (or at) a specified time. An update is defined as any change in fulfillment order status, including the creation of a new fulfillment order. | [optional] + **fulfillment_method** | [**string[]**](../Model/string.md)| Indicates the intended recipient channel for the order. | [optional] + **next_token** | **string**| A string token returned in the response to your previous request. | [optional] + +### Return type + +[**\Swagger\Client\Models\ListAllFulfillmentOrdersResponse**](../Model/ListAllFulfillmentOrdersResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **listReturnReasonCodes** +> \Swagger\Client\Models\ListReturnReasonCodesResponse listReturnReasonCodes($seller_sku, $language, $marketplace_id, $seller_fulfillment_order_id) + + + +Returns a list of return reason codes for a seller SKU in a given marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + + +$apiInstance = new Swagger\Client\Api\FbaOutboundApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$seller_sku = "seller_sku_example"; // string | The seller SKU for which return reason codes are required. +$language = "language_example"; // string | The language that the TranslatedDescription property of the ReasonCodeDetails response object should be translated into. +$marketplace_id = "marketplace_id_example"; // string | The marketplace for which the seller wants return reason codes. +$seller_fulfillment_order_id = "seller_fulfillment_order_id_example"; // string | The identifier assigned to the item by the seller when the fulfillment order was created. The service uses this value to determine the marketplace for which the seller wants return reason codes. + +try { + $result = $apiInstance->listReturnReasonCodes($seller_sku, $language, $marketplace_id, $seller_fulfillment_order_id); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling FbaOutboundApi->listReturnReasonCodes: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **seller_sku** | **string**| The seller SKU for which return reason codes are required. | + **language** | **string**| The language that the TranslatedDescription property of the ReasonCodeDetails response object should be translated into. | + **marketplace_id** | **string**| The marketplace for which the seller wants return reason codes. | [optional] + **seller_fulfillment_order_id** | **string**| The identifier assigned to the item by the seller when the fulfillment order was created. The service uses this value to determine the marketplace for which the seller wants return reason codes. | [optional] + +### Return type + +[**\Swagger\Client\Models\ListReturnReasonCodesResponse**](../Model/ListReturnReasonCodesResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **updateFulfillmentOrder** +> \Swagger\Client\Models\UpdateFulfillmentOrderResponse updateFulfillmentOrder($body, $seller_fulfillment_order_id) + + + +Updates and/or requests shipment for a fulfillment order with an order hold on it. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + + +$apiInstance = new Swagger\Client\Api\FbaOutboundApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$body = new \Swagger\Client\Models\UpdateFulfillmentOrderRequest(); // \Swagger\Client\Models\UpdateFulfillmentOrderRequest | +$seller_fulfillment_order_id = "seller_fulfillment_order_id_example"; // string | The identifier assigned to the item by the seller when the fulfillment order was created. + +try { + $result = $apiInstance->updateFulfillmentOrder($body, $seller_fulfillment_order_id); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling FbaOutboundApi->updateFulfillmentOrder: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**\Swagger\Client\Models\UpdateFulfillmentOrderRequest**](../Model/UpdateFulfillmentOrderRequest.md)| | + **seller_fulfillment_order_id** | **string**| The identifier assigned to the item by the seller when the fulfillment order was created. | + +### Return type + +[**\Swagger\Client\Models\UpdateFulfillmentOrderResponse**](../Model/UpdateFulfillmentOrderResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + diff --git a/FeedsApi.md b/FeedsApi.md new file mode 100644 index 00000000..9d6a1e73 --- /dev/null +++ b/FeedsApi.md @@ -0,0 +1,361 @@ +# Swagger\Client\FeedsApi + +All URIs are relative to *https://sellingpartnerapi-na.amazon.com/* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**cancelFeed**](FeedsApi.md#cancelfeed) | **DELETE** /feeds/2020-09-04/feeds/{feedId} | +[**createFeed**](FeedsApi.md#createfeed) | **POST** /feeds/2020-09-04/feeds | +[**createFeedDocument**](FeedsApi.md#createfeeddocument) | **POST** /feeds/2020-09-04/documents | +[**getFeed**](FeedsApi.md#getfeed) | **GET** /feeds/2020-09-04/feeds/{feedId} | +[**getFeedDocument**](FeedsApi.md#getfeeddocument) | **GET** /feeds/2020-09-04/documents/{feedDocumentId} | +[**getFeeds**](FeedsApi.md#getfeeds) | **GET** /feeds/2020-09-04/feeds | + +# **cancelFeed** +> \Swagger\Client\Models\CancelFeedResponse cancelFeed($feed_id) + + + +Cancels the feed that you specify. Only feeds with processingStatus=IN_QUEUE can be cancelled. Cancelled feeds are returned in subsequent calls to the getFeed and getFeeds operations. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\FeedsApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$feed_id = "feed_id_example"; // string | The identifier for the feed. This identifier is unique only in combination with a seller ID. + +try { + $result = $apiInstance->cancelFeed($feed_id); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling FeedsApi->cancelFeed: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **feed_id** | **string**| The identifier for the feed. This identifier is unique only in combination with a seller ID. | + +### Return type + +[**\Swagger\Client\Models\CancelFeedResponse**](../Model/CancelFeedResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **createFeed** +> \Swagger\Client\Models\CreateFeedResponse createFeed($body) + + + +Creates a feed. Encrypt and upload the contents of the feed document before calling this operation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0083 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\FeedsApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$body = new \Swagger\Client\Models\CreateFeedSpecification(); // \Swagger\Client\Models\CreateFeedSpecification | + +try { + $result = $apiInstance->createFeed($body); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling FeedsApi->createFeed: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**\Swagger\Client\Models\CreateFeedSpecification**](../Model/CreateFeedSpecification.md)| | + +### Return type + +[**\Swagger\Client\Models\CreateFeedResponse**](../Model/CreateFeedResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **createFeedDocument** +> \Swagger\Client\Models\CreateFeedDocumentResponse createFeedDocument($body) + + + +Creates a feed document for the feed type that you specify. This operation returns encryption details for encrypting the contents of the document, as well as a presigned URL for uploading the encrypted feed document contents. It also returns a feedDocumentId value that you can pass in with a subsequent call to the createFeed operation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0083 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\FeedsApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$body = new \Swagger\Client\Models\CreateFeedDocumentSpecification(); // \Swagger\Client\Models\CreateFeedDocumentSpecification | + +try { + $result = $apiInstance->createFeedDocument($body); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling FeedsApi->createFeedDocument: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**\Swagger\Client\Models\CreateFeedDocumentSpecification**](../Model/CreateFeedDocumentSpecification.md)| | + +### Return type + +[**\Swagger\Client\Models\CreateFeedDocumentResponse**](../Model/CreateFeedDocumentResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **getFeed** +> \Swagger\Client\Models\GetFeedResponse getFeed($feed_id) + + + +Returns feed details (including the resultDocumentId, if available) for the feed that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2.0 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\FeedsApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$feed_id = "feed_id_example"; // string | The identifier for the feed. This identifier is unique only in combination with a seller ID. + +try { + $result = $apiInstance->getFeed($feed_id); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling FeedsApi->getFeed: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **feed_id** | **string**| The identifier for the feed. This identifier is unique only in combination with a seller ID. | + +### Return type + +[**\Swagger\Client\Models\GetFeedResponse**](../Model/GetFeedResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **getFeedDocument** +> \Swagger\Client\Models\GetFeedDocumentResponse getFeedDocument($feed_document_id) + + + +Returns the information required for retrieving a feed document's contents. This includes a presigned URL for the feed document as well as the information required to decrypt the document's contents. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\FeedsApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$feed_document_id = "feed_document_id_example"; // string | The identifier of the feed document. + +try { + $result = $apiInstance->getFeedDocument($feed_document_id); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling FeedsApi->getFeedDocument: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **feed_document_id** | **string**| The identifier of the feed document. | + +### Return type + +[**\Swagger\Client\Models\GetFeedDocumentResponse**](../Model/GetFeedDocumentResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **getFeeds** +> \Swagger\Client\Models\GetFeedsResponse getFeeds($feed_types, $marketplace_ids, $page_size, $processing_statuses, $created_since, $created_until, $next_token) + + + +Returns feed details for the feeds that match the filters that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\FeedsApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$feed_types = array("feed_types_example"); // string[] | A list of feed types used to filter feeds. When feedTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. Either feedTypes or nextToken is required. +$marketplace_ids = array("marketplace_ids_example"); // string[] | A list of marketplace identifiers used to filter feeds. The feeds returned will match at least one of the marketplaces that you specify. +$page_size = 10; // int | The maximum number of feeds to return in a single call. +$processing_statuses = array("processing_statuses_example"); // string[] | A list of processing statuses used to filter feeds. +$created_since = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | The earliest feed creation date and time for feeds included in the response, in ISO 8601 format. The default is 90 days ago. Feeds are retained for a maximum of 90 days. +$created_until = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | The latest feed creation date and time for feeds included in the response, in ISO 8601 format. The default is now. +$next_token = "next_token_example"; // string | A string token returned in the response to your previous request. nextToken is returned when the number of results exceeds the specified pageSize value. To get the next page of results, call the getFeeds operation and include this token as the only parameter. Specifying nextToken with any other parameters will cause the request to fail. + +try { + $result = $apiInstance->getFeeds($feed_types, $marketplace_ids, $page_size, $processing_statuses, $created_since, $created_until, $next_token); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling FeedsApi->getFeeds: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **feed_types** | [**string[]**](../Model/string.md)| A list of feed types used to filter feeds. When feedTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. Either feedTypes or nextToken is required. | [optional] + **marketplace_ids** | [**string[]**](../Model/string.md)| A list of marketplace identifiers used to filter feeds. The feeds returned will match at least one of the marketplaces that you specify. | [optional] + **page_size** | **int**| The maximum number of feeds to return in a single call. | [optional] [default to 10] + **processing_statuses** | [**string[]**](../Model/string.md)| A list of processing statuses used to filter feeds. | [optional] + **created_since** | **\DateTime**| The earliest feed creation date and time for feeds included in the response, in ISO 8601 format. The default is 90 days ago. Feeds are retained for a maximum of 90 days. | [optional] + **created_until** | **\DateTime**| The latest feed creation date and time for feeds included in the response, in ISO 8601 format. The default is now. | [optional] + **next_token** | **string**| A string token returned in the response to your previous request. nextToken is returned when the number of results exceeds the specified pageSize value. To get the next page of results, call the getFeeds operation and include this token as the only parameter. Specifying nextToken with any other parameters will cause the request to fail. | [optional] + +### Return type + +[**\Swagger\Client\Models\GetFeedsResponse**](../Model/GetFeedsResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + diff --git a/FeesApi.md b/FeesApi.md new file mode 100644 index 00000000..2fc243de --- /dev/null +++ b/FeesApi.md @@ -0,0 +1,125 @@ +# Swagger\Client\FeesApi + +All URIs are relative to *https://sellingpartnerapi-na.amazon.com/* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getMyFeesEstimateForASIN**](FeesApi.md#getmyfeesestimateforasin) | **POST** /products/fees/v0/items/{Asin}/feesEstimate | +[**getMyFeesEstimateForSKU**](FeesApi.md#getmyfeesestimateforsku) | **POST** /products/fees/v0/listings/{SellerSKU}/feesEstimate | + +# **getMyFeesEstimateForASIN** +> \Swagger\Client\Models\GetMyFeesEstimateResponse getMyFeesEstimateForASIN($body, $asin) + + + +Returns the estimated fees for the item indicated by the specified Asin in the marketplace specified in the request body. You can call getMyFeesEstimateForASIN for an item on behalf of a seller before the seller sets the item's price. They can then take estimated fees into account. With each product fees request, you must include an original identifier. This identifier is included in the fees estimate so you can correlate a fees estimate with the original request. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\FeesApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$body = new \Swagger\Client\Models\GetMyFeesEstimateRequest(); // \Swagger\Client\Models\GetMyFeesEstimateRequest | +$asin = "asin_example"; // string | The Amazon Standard Identification Number (ASIN) of the item. + +try { + $result = $apiInstance->getMyFeesEstimateForASIN($body, $asin); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling FeesApi->getMyFeesEstimateForASIN: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**\Swagger\Client\Models\GetMyFeesEstimateRequest**](../Model/GetMyFeesEstimateRequest.md)| | + **asin** | **string**| The Amazon Standard Identification Number (ASIN) of the item. | + +### Return type + +[**\Swagger\Client\Models\GetMyFeesEstimateResponse**](../Model/GetMyFeesEstimateResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **getMyFeesEstimateForSKU** +> \Swagger\Client\Models\GetMyFeesEstimateResponse getMyFeesEstimateForSKU($body, $seller_sku) + + + +Returns the estimated fees for the item indicated by the specified seller SKU in the marketplace specified in the request body. You can call getMyFeesEstimateForSKU for an item on behalf of a seller before the seller sets the item's price. They can then take estimated fees into account. With each fees estimate request, you must include an original identifier. This identifier is included in the fees estimate so you can correlate a fees estimate with the original request. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\FeesApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$body = new \Swagger\Client\Models\GetMyFeesEstimateRequest(); // \Swagger\Client\Models\GetMyFeesEstimateRequest | +$seller_sku = "seller_sku_example"; // string | Used to identify an item in the given marketplace. SellerSKU is qualified by the seller's SellerId, which is included with every operation that you submit. + +try { + $result = $apiInstance->getMyFeesEstimateForSKU($body, $seller_sku); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling FeesApi->getMyFeesEstimateForSKU: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**\Swagger\Client\Models\GetMyFeesEstimateRequest**](../Model/GetMyFeesEstimateRequest.md)| | + **seller_sku** | **string**| Used to identify an item in the given marketplace. SellerSKU is qualified by the seller's SellerId, which is included with every operation that you submit. | + +### Return type + +[**\Swagger\Client\Models\GetMyFeesEstimateResponse**](../Model/GetMyFeesEstimateResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + diff --git a/MerchantFulfillmentApi.md b/MerchantFulfillmentApi.md new file mode 100644 index 00000000..1c197fa7 --- /dev/null +++ b/MerchantFulfillmentApi.md @@ -0,0 +1,463 @@ +# Swagger\Client\MerchantFulfillmentApi + +All URIs are relative to *https://sellingpartnerapi-na.amazon.com/* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**cancelShipment**](MerchantFulfillmentApi.md#cancelshipment) | **DELETE** /mfn/v0/shipments/{shipmentId} | +[**cancelShipmentOld**](MerchantFulfillmentApi.md#cancelshipmentold) | **PUT** /mfn/v0/shipments/{shipmentId}/cancel | +[**createShipment**](MerchantFulfillmentApi.md#createshipment) | **POST** /mfn/v0/shipments | +[**getAdditionalSellerInputs**](MerchantFulfillmentApi.md#getadditionalsellerinputs) | **POST** /mfn/v0/additionalSellerInputs | +[**getAdditionalSellerInputsOld**](MerchantFulfillmentApi.md#getadditionalsellerinputsold) | **POST** /mfn/v0/sellerInputs | +[**getEligibleShipmentServices**](MerchantFulfillmentApi.md#geteligibleshipmentservices) | **POST** /mfn/v0/eligibleShippingServices | +[**getEligibleShipmentServicesOld**](MerchantFulfillmentApi.md#geteligibleshipmentservicesold) | **POST** /mfn/v0/eligibleServices | +[**getShipment**](MerchantFulfillmentApi.md#getshipment) | **GET** /mfn/v0/shipments/{shipmentId} | + +# **cancelShipment** +> \Swagger\Client\Models\CancelShipmentResponse cancelShipment($shipment_id) + + + +Cancel the shipment indicated by the specified shipment identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\MerchantFulfillmentApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$shipment_id = "shipment_id_example"; // string | The Amazon-defined shipment identifier for the shipment to cancel. + +try { + $result = $apiInstance->cancelShipment($shipment_id); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling MerchantFulfillmentApi->cancelShipment: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **shipment_id** | **string**| The Amazon-defined shipment identifier for the shipment to cancel. | + +### Return type + +[**\Swagger\Client\Models\CancelShipmentResponse**](../Model/CancelShipmentResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **cancelShipmentOld** +> \Swagger\Client\Models\CancelShipmentResponse cancelShipmentOld($shipment_id) + + + +Cancel the shipment indicated by the specified shipment identifer. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\MerchantFulfillmentApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$shipment_id = "shipment_id_example"; // string | The Amazon-defined shipment identifier for the shipment to cancel. + +try { + $result = $apiInstance->cancelShipmentOld($shipment_id); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling MerchantFulfillmentApi->cancelShipmentOld: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **shipment_id** | **string**| The Amazon-defined shipment identifier for the shipment to cancel. | + +### Return type + +[**\Swagger\Client\Models\CancelShipmentResponse**](../Model/CancelShipmentResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **createShipment** +> \Swagger\Client\Models\CreateShipmentResponse createShipment($body) + + + +Create a shipment with the information provided. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\MerchantFulfillmentApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$body = new \Swagger\Client\Models\CreateShipmentRequest(); // \Swagger\Client\Models\CreateShipmentRequest | + +try { + $result = $apiInstance->createShipment($body); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling MerchantFulfillmentApi->createShipment: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**\Swagger\Client\Models\CreateShipmentRequest**](../Model/CreateShipmentRequest.md)| | + +### Return type + +[**\Swagger\Client\Models\CreateShipmentResponse**](../Model/CreateShipmentResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **getAdditionalSellerInputs** +> \Swagger\Client\Models\GetAdditionalSellerInputsResponse getAdditionalSellerInputs($body) + + + +Gets a list of additional seller inputs required for a ship method. This is generally used for international shipping. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\MerchantFulfillmentApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$body = new \Swagger\Client\Models\GetAdditionalSellerInputsRequest(); // \Swagger\Client\Models\GetAdditionalSellerInputsRequest | + +try { + $result = $apiInstance->getAdditionalSellerInputs($body); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling MerchantFulfillmentApi->getAdditionalSellerInputs: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**\Swagger\Client\Models\GetAdditionalSellerInputsRequest**](../Model/GetAdditionalSellerInputsRequest.md)| | + +### Return type + +[**\Swagger\Client\Models\GetAdditionalSellerInputsResponse**](../Model/GetAdditionalSellerInputsResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **getAdditionalSellerInputsOld** +> \Swagger\Client\Models\GetAdditionalSellerInputsResponse getAdditionalSellerInputsOld($body) + + + +Get a list of additional seller inputs required for a ship method. This is generally used for international shipping. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\MerchantFulfillmentApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$body = new \Swagger\Client\Models\GetAdditionalSellerInputsRequest(); // \Swagger\Client\Models\GetAdditionalSellerInputsRequest | + +try { + $result = $apiInstance->getAdditionalSellerInputsOld($body); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling MerchantFulfillmentApi->getAdditionalSellerInputsOld: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**\Swagger\Client\Models\GetAdditionalSellerInputsRequest**](../Model/GetAdditionalSellerInputsRequest.md)| | + +### Return type + +[**\Swagger\Client\Models\GetAdditionalSellerInputsResponse**](../Model/GetAdditionalSellerInputsResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **getEligibleShipmentServices** +> \Swagger\Client\Models\GetEligibleShipmentServicesResponse getEligibleShipmentServices($body) + + + +Returns a list of shipping service offers that satisfy the specified shipment request details. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\MerchantFulfillmentApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$body = new \Swagger\Client\Models\GetEligibleShipmentServicesRequest(); // \Swagger\Client\Models\GetEligibleShipmentServicesRequest | + +try { + $result = $apiInstance->getEligibleShipmentServices($body); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling MerchantFulfillmentApi->getEligibleShipmentServices: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**\Swagger\Client\Models\GetEligibleShipmentServicesRequest**](../Model/GetEligibleShipmentServicesRequest.md)| | + +### Return type + +[**\Swagger\Client\Models\GetEligibleShipmentServicesResponse**](../Model/GetEligibleShipmentServicesResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **getEligibleShipmentServicesOld** +> \Swagger\Client\Models\GetEligibleShipmentServicesResponse getEligibleShipmentServicesOld($body) + + + +Returns a list of shipping service offers that satisfy the specified shipment request details. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\MerchantFulfillmentApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$body = new \Swagger\Client\Models\GetEligibleShipmentServicesRequest(); // \Swagger\Client\Models\GetEligibleShipmentServicesRequest | + +try { + $result = $apiInstance->getEligibleShipmentServicesOld($body); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling MerchantFulfillmentApi->getEligibleShipmentServicesOld: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**\Swagger\Client\Models\GetEligibleShipmentServicesRequest**](../Model/GetEligibleShipmentServicesRequest.md)| | + +### Return type + +[**\Swagger\Client\Models\GetEligibleShipmentServicesResponse**](../Model/GetEligibleShipmentServicesResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **getShipment** +> \Swagger\Client\Models\GetShipmentResponse getShipment($shipment_id) + + + +Returns the shipment information for an existing shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\MerchantFulfillmentApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$shipment_id = "shipment_id_example"; // string | The Amazon-defined shipment identifier for the shipment. + +try { + $result = $apiInstance->getShipment($shipment_id); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling MerchantFulfillmentApi->getShipment: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **shipment_id** | **string**| The Amazon-defined shipment identifier for the shipment. | + +### Return type + +[**\Swagger\Client\Models\GetShipmentResponse**](../Model/GetShipmentResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + diff --git a/NotificationsApi.md b/NotificationsApi.md new file mode 100644 index 00000000..6af4a6fb --- /dev/null +++ b/NotificationsApi.md @@ -0,0 +1,465 @@ +# Swagger\Client\NotificationsApi + +All URIs are relative to *https://sellingpartnerapi-na.amazon.com/* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createDestination**](NotificationsApi.md#createdestination) | **POST** /notifications/v1/destinations | +[**createSubscription**](NotificationsApi.md#createsubscription) | **POST** /notifications/v1/subscriptions/{notificationType} | +[**deleteDestination**](NotificationsApi.md#deletedestination) | **DELETE** /notifications/v1/destinations/{destinationId} | +[**deleteSubscriptionById**](NotificationsApi.md#deletesubscriptionbyid) | **DELETE** /notifications/v1/subscriptions/{notificationType}/{subscriptionId} | +[**getDestination**](NotificationsApi.md#getdestination) | **GET** /notifications/v1/destinations/{destinationId} | +[**getDestinations**](NotificationsApi.md#getdestinations) | **GET** /notifications/v1/destinations | +[**getSubscription**](NotificationsApi.md#getsubscription) | **GET** /notifications/v1/subscriptions/{notificationType} | +[**getSubscriptionById**](NotificationsApi.md#getsubscriptionbyid) | **GET** /notifications/v1/subscriptions/{notificationType}/{subscriptionId} | + +# **createDestination** +> \Swagger\Client\Models\CreateDestinationResponse createDestination($body) + + + +Creates a destination resource to receive notifications. The createDestination API is grantless. For more information, see \"Grantless operations\" in the Selling Partner API Developer Guide. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\NotificationsApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$body = new \Swagger\Client\Models\CreateDestinationRequest(); // \Swagger\Client\Models\CreateDestinationRequest | + +try { + $result = $apiInstance->createDestination($body); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling NotificationsApi->createDestination: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**\Swagger\Client\Models\CreateDestinationRequest**](../Model/CreateDestinationRequest.md)| | + +### Return type + +[**\Swagger\Client\Models\CreateDestinationResponse**](../Model/CreateDestinationResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json, Successful Response + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **createSubscription** +> \Swagger\Client\Models\CreateSubscriptionResponse createSubscription($body, $notification_type) + + + +Creates a subscription for the specified notification type to be delivered to the specified destination. Before you can subscribe, you must first create the destination by calling the createDestination operation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\NotificationsApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$body = new \Swagger\Client\Models\CreateSubscriptionRequest(); // \Swagger\Client\Models\CreateSubscriptionRequest | +$notification_type = "notification_type_example"; // string | The type of notification to which you want to subscribe. For more information about notification types, see the Notifications API Use Case Guide. + +try { + $result = $apiInstance->createSubscription($body, $notification_type); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling NotificationsApi->createSubscription: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**\Swagger\Client\Models\CreateSubscriptionRequest**](../Model/CreateSubscriptionRequest.md)| | + **notification_type** | **string**| The type of notification to which you want to subscribe. For more information about notification types, see the Notifications API Use Case Guide. | + +### Return type + +[**\Swagger\Client\Models\CreateSubscriptionResponse**](../Model/CreateSubscriptionResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json, Successful Response + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **deleteDestination** +> \Swagger\Client\Models\DeleteDestinationResponse deleteDestination($destination_id) + + + +Deletes the destination that you specify. The deleteDestination API is grantless. For more information, see \"Grantless operations\" in the Selling Partner API Developer Guide. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\NotificationsApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$destination_id = "destination_id_example"; // string | The identifier for the destination that you want to delete. + +try { + $result = $apiInstance->deleteDestination($destination_id); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling NotificationsApi->deleteDestination: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **destination_id** | **string**| The identifier for the destination that you want to delete. | + +### Return type + +[**\Swagger\Client\Models\DeleteDestinationResponse**](../Model/DeleteDestinationResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, Successful Response + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **deleteSubscriptionById** +> \Swagger\Client\Models\DeleteSubscriptionByIdResponse deleteSubscriptionById($subscription_id, $notification_type) + + + +Deletes the subscription indicated by the subscription identifier and notification type that you specify. The subscription identifier can be for any subscription associated with your application. After you successfully call this operation, notifications will stop being sent for the associated subscription. The deleteSubscriptionById API is grantless. For more information, see \"Grantless operations\" in the Selling Partner API Developer Guide. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\NotificationsApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$subscription_id = "subscription_id_example"; // string | The identifier for the subscription that you want to delete. +$notification_type = "notification_type_example"; // string | The type of notification to which you want to subscribe. For more information about notification types, see the Notifications API Use Case Guide. + +try { + $result = $apiInstance->deleteSubscriptionById($subscription_id, $notification_type); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling NotificationsApi->deleteSubscriptionById: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **subscription_id** | **string**| The identifier for the subscription that you want to delete. | + **notification_type** | **string**| The type of notification to which you want to subscribe. For more information about notification types, see the Notifications API Use Case Guide. | + +### Return type + +[**\Swagger\Client\Models\DeleteSubscriptionByIdResponse**](../Model/DeleteSubscriptionByIdResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, Successful Operation Response + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **getDestination** +> \Swagger\Client\Models\GetDestinationResponse getDestination($destination_id) + + + +Returns information about the destination that you specify. The getDestination API is grantless. For more information, see \"Grantless operations\" in the Selling Partner API Developer Guide. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\NotificationsApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$destination_id = "destination_id_example"; // string | The identifier generated when you created the destination. + +try { + $result = $apiInstance->getDestination($destination_id); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling NotificationsApi->getDestination: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **destination_id** | **string**| The identifier generated when you created the destination. | + +### Return type + +[**\Swagger\Client\Models\GetDestinationResponse**](../Model/GetDestinationResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, Successful Response + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **getDestinations** +> \Swagger\Client\Models\GetDestinationsResponse getDestinations() + + + +Returns information about all destinations. The getDestinations API is grantless. For more information, see \"Grantless operations\" in the Selling Partner API Developer Guide. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\NotificationsApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); + +try { + $result = $apiInstance->getDestinations(); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling NotificationsApi->getDestinations: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**\Swagger\Client\Models\GetDestinationsResponse**](../Model/GetDestinationsResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, Successful Response + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **getSubscription** +> \Swagger\Client\Models\GetSubscriptionResponse getSubscription($notification_type) + + + +Returns information about subscriptions of the specified notification type. You can use this API to get subscription information when you do not have a subscription identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\NotificationsApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$notification_type = "notification_type_example"; // string | The type of notification to which you want to subscribe. For more information about notification types, see the Notifications API Use Case Guide. + +try { + $result = $apiInstance->getSubscription($notification_type); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling NotificationsApi->getSubscription: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **notification_type** | **string**| The type of notification to which you want to subscribe. For more information about notification types, see the Notifications API Use Case Guide. | + +### Return type + +[**\Swagger\Client\Models\GetSubscriptionResponse**](../Model/GetSubscriptionResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, Successful Response + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **getSubscriptionById** +> \Swagger\Client\Models\GetSubscriptionByIdResponse getSubscriptionById($subscription_id, $notification_type) + + + +Returns information about a subscription for the specified notification type. The getSubscriptionById API is grantless. For more information, see \"Grantless operations\" in the Selling Partner API Developer Guide. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\NotificationsApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$subscription_id = "subscription_id_example"; // string | The identifier for the subscription that you want to get. +$notification_type = "notification_type_example"; // string | The type of notification to which you want to subscribe. For more information about notification types, see the Notifications API Use Case Guide. + +try { + $result = $apiInstance->getSubscriptionById($subscription_id, $notification_type); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling NotificationsApi->getSubscriptionById: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **subscription_id** | **string**| The identifier for the subscription that you want to get. | + **notification_type** | **string**| The type of notification to which you want to subscribe. For more information about notification types, see the Notifications API Use Case Guide. | + +### Return type + +[**\Swagger\Client\Models\GetSubscriptionByIdResponse**](../Model/GetSubscriptionByIdResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, Successful Response + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + diff --git a/OrdersV0Api.md b/OrdersV0Api.md new file mode 100644 index 00000000..b3d9ecdd --- /dev/null +++ b/OrdersV0Api.md @@ -0,0 +1,378 @@ +# Swagger\Client\OrdersV0Api + +All URIs are relative to *https://sellingpartnerapi-na.amazon.com/* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getOrder**](OrdersV0Api.md#getorder) | **GET** /orders/v0/orders/{orderId} | +[**getOrderAddress**](OrdersV0Api.md#getorderaddress) | **GET** /orders/v0/orders/{orderId}/address | +[**getOrderBuyerInfo**](OrdersV0Api.md#getorderbuyerinfo) | **GET** /orders/v0/orders/{orderId}/buyerInfo | +[**getOrderItems**](OrdersV0Api.md#getorderitems) | **GET** /orders/v0/orders/{orderId}/orderItems | +[**getOrderItemsBuyerInfo**](OrdersV0Api.md#getorderitemsbuyerinfo) | **GET** /orders/v0/orders/{orderId}/orderItems/buyerInfo | +[**getOrders**](OrdersV0Api.md#getorders) | **GET** /orders/v0/orders | + +# **getOrder** +> \Swagger\Client\Models\GetOrderResponse getOrder($order_id) + + + +Returns the order indicated by the specified order ID. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0055 | 20 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\OrdersV0Api( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$order_id = "order_id_example"; // string | An Amazon-defined order identifier, in 3-7-7 format. + +try { + $result = $apiInstance->getOrder($order_id); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling OrdersV0Api->getOrder: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **order_id** | **string**| An Amazon-defined order identifier, in 3-7-7 format. | + +### Return type + +[**\Swagger\Client\Models\GetOrderResponse**](../Model/GetOrderResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **getOrderAddress** +> \Swagger\Client\Models\GetOrderAddressResponse getOrderAddress($order_id) + + + +Returns the shipping address for the order indicated by the specified order ID. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0055 | 20 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\OrdersV0Api( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$order_id = "order_id_example"; // string | An orderId is an Amazon-defined order identifier, in 3-7-7 format. + +try { + $result = $apiInstance->getOrderAddress($order_id); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling OrdersV0Api->getOrderAddress: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **order_id** | **string**| An orderId is an Amazon-defined order identifier, in 3-7-7 format. | + +### Return type + +[**\Swagger\Client\Models\GetOrderAddressResponse**](../Model/GetOrderAddressResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **getOrderBuyerInfo** +> \Swagger\Client\Models\GetOrderBuyerInfoResponse getOrderBuyerInfo($order_id) + + + +Returns buyer information for the order indicated by the specified order ID. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0055 | 20 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\OrdersV0Api( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$order_id = "order_id_example"; // string | An orderId is an Amazon-defined order identifier, in 3-7-7 format. + +try { + $result = $apiInstance->getOrderBuyerInfo($order_id); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling OrdersV0Api->getOrderBuyerInfo: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **order_id** | **string**| An orderId is an Amazon-defined order identifier, in 3-7-7 format. | + +### Return type + +[**\Swagger\Client\Models\GetOrderBuyerInfoResponse**](../Model/GetOrderBuyerInfoResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **getOrderItems** +> \Swagger\Client\Models\GetOrderItemsResponse getOrderItems($order_id, $next_token) + + + +Returns detailed order item information for the order indicated by the specified order ID. If NextToken is provided, it's used to retrieve the next page of order items. Note: When an order is in the Pending state (the order has been placed but payment has not been authorized), the getOrderItems operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped, Partially Shipped, or Shipped state, the getOrderItems operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0055 | 20 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\OrdersV0Api( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$order_id = "order_id_example"; // string | An Amazon-defined order identifier, in 3-7-7 format. +$next_token = "next_token_example"; // string | A string token returned in the response of your previous request. + +try { + $result = $apiInstance->getOrderItems($order_id, $next_token); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling OrdersV0Api->getOrderItems: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **order_id** | **string**| An Amazon-defined order identifier, in 3-7-7 format. | + **next_token** | **string**| A string token returned in the response of your previous request. | [optional] + +### Return type + +[**\Swagger\Client\Models\GetOrderItemsResponse**](../Model/GetOrderItemsResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **getOrderItemsBuyerInfo** +> \Swagger\Client\Models\GetOrderItemsBuyerInfoResponse getOrderItemsBuyerInfo($order_id, $next_token) + + + +Returns buyer information in the order items of the order indicated by the specified order ID. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0055 | 20 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\OrdersV0Api( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$order_id = "order_id_example"; // string | An Amazon-defined order identifier, in 3-7-7 format. +$next_token = "next_token_example"; // string | A string token returned in the response of your previous request. + +try { + $result = $apiInstance->getOrderItemsBuyerInfo($order_id, $next_token); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling OrdersV0Api->getOrderItemsBuyerInfo: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **order_id** | **string**| An Amazon-defined order identifier, in 3-7-7 format. | + **next_token** | **string**| A string token returned in the response of your previous request. | [optional] + +### Return type + +[**\Swagger\Client\Models\GetOrderItemsBuyerInfoResponse**](../Model/GetOrderItemsBuyerInfoResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **getOrders** +> \Swagger\Client\Models\GetOrdersResponse getOrders($marketplace_ids, $created_after, $created_before, $last_updated_after, $last_updated_before, $order_statuses, $fulfillment_channels, $payment_methods, $buyer_email, $seller_order_id, $max_results_per_page, $easy_ship_shipment_statuses, $next_token, $amazon_order_ids) + + + +Returns orders created or updated during the time frame indicated by the specified parameters. You can also apply a range of filtering criteria to narrow the list of orders returned. If NextToken is present, that will be used to retrieve the orders instead of other criteria. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0055 | 20 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\OrdersV0Api( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$marketplace_ids = array("marketplace_ids_example"); // string[] | A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces. +$created_after = "created_after_example"; // string | A date used for selecting orders created after (or at) a specified time. Only orders placed after the specified time are returned. Either the CreatedAfter parameter or the LastUpdatedAfter parameter is required. Both cannot be empty. The date must be in ISO 8601 format. +$created_before = "created_before_example"; // string | A date used for selecting orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in ISO 8601 format. +$last_updated_after = "last_updated_after_example"; // string | A date used for selecting orders that were last updated after (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in ISO 8601 format. +$last_updated_before = "last_updated_before_example"; // string | A date used for selecting orders that were last updated before (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in ISO 8601 format. +$order_statuses = array("order_statuses_example"); // string[] | A list of OrderStatus values used to filter the results. Possible values: PendingAvailability (This status is available for pre-orders only. The order has been placed, payment has not been authorized, and the release date of the item is in the future.); Pending (The order has been placed but payment has not been authorized); Unshipped (Payment has been authorized and the order is ready for shipment, but no items in the order have been shipped); PartiallyShipped (One or more, but not all, items in the order have been shipped); Shipped (All items in the order have been shipped); InvoiceUnconfirmed (All items in the order have been shipped. The seller has not yet given confirmation to Amazon that the invoice has been shipped to the buyer.); Canceled (The order has been canceled); and Unfulfillable (The order cannot be fulfilled. This state applies only to Multi-Channel Fulfillment orders.). +$fulfillment_channels = array("fulfillment_channels_example"); // string[] | A list that indicates how an order was fulfilled. Filters the results by fulfillment channel. Possible values: FBA (Fulfillment by Amazon); SellerFulfilled (Fulfilled by the seller). +$payment_methods = array("payment_methods_example"); // string[] | A list of payment method values. Used to select orders paid using the specified payment methods. Possible values: COD (Cash on delivery); CVS (Convenience store payment); Other (Any payment method other than COD or CVS). +$buyer_email = "buyer_email_example"; // string | The email address of a buyer. Used to select orders that contain the specified email address. +$seller_order_id = "seller_order_id_example"; // string | An order identifier that is specified by the seller. Used to select only the orders that match the order identifier. If SellerOrderId is specified, then FulfillmentChannels, OrderStatuses, PaymentMethod, LastUpdatedAfter, LastUpdatedBefore, and BuyerEmail cannot be specified. +$max_results_per_page = 56; // int | A number that indicates the maximum number of orders that can be returned per page. Value must be 1 - 100. Default 100. +$easy_ship_shipment_statuses = array("easy_ship_shipment_statuses_example"); // string[] | A list of EasyShipShipmentStatus values. Used to select Easy Ship orders with statuses that match the specified values. If EasyShipShipmentStatus is specified, only Amazon Easy Ship orders are returned.Possible values: PendingPickUp (Amazon has not yet picked up the package from the seller). LabelCanceled (The seller canceled the pickup). PickedUp (Amazon has picked up the package from the seller). AtOriginFC (The packaged is at the origin fulfillment center). AtDestinationFC (The package is at the destination fulfillment center). OutForDelivery (The package is out for delivery). Damaged (The package was damaged by the carrier). Delivered (The package has been delivered to the buyer). RejectedByBuyer (The package has been rejected by the buyer). Undeliverable (The package cannot be delivered). ReturnedToSeller (The package was not delivered to the buyer and was returned to the seller). ReturningToSeller (The package was not delivered to the buyer and is being returned to the seller). +$next_token = "next_token_example"; // string | A string token returned in the response of your previous request. +$amazon_order_ids = array("amazon_order_ids_example"); // string[] | A list of AmazonOrderId values. An AmazonOrderId is an Amazon-defined order identifier, in 3-7-7 format. + +try { + $result = $apiInstance->getOrders($marketplace_ids, $created_after, $created_before, $last_updated_after, $last_updated_before, $order_statuses, $fulfillment_channels, $payment_methods, $buyer_email, $seller_order_id, $max_results_per_page, $easy_ship_shipment_statuses, $next_token, $amazon_order_ids); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling OrdersV0Api->getOrders: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **marketplace_ids** | [**string[]**](../Model/string.md)| A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces. | + **created_after** | **string**| A date used for selecting orders created after (or at) a specified time. Only orders placed after the specified time are returned. Either the CreatedAfter parameter or the LastUpdatedAfter parameter is required. Both cannot be empty. The date must be in ISO 8601 format. | [optional] + **created_before** | **string**| A date used for selecting orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in ISO 8601 format. | [optional] + **last_updated_after** | **string**| A date used for selecting orders that were last updated after (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in ISO 8601 format. | [optional] + **last_updated_before** | **string**| A date used for selecting orders that were last updated before (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in ISO 8601 format. | [optional] + **order_statuses** | [**string[]**](../Model/string.md)| A list of OrderStatus values used to filter the results. Possible values: PendingAvailability (This status is available for pre-orders only. The order has been placed, payment has not been authorized, and the release date of the item is in the future.); Pending (The order has been placed but payment has not been authorized); Unshipped (Payment has been authorized and the order is ready for shipment, but no items in the order have been shipped); PartiallyShipped (One or more, but not all, items in the order have been shipped); Shipped (All items in the order have been shipped); InvoiceUnconfirmed (All items in the order have been shipped. The seller has not yet given confirmation to Amazon that the invoice has been shipped to the buyer.); Canceled (The order has been canceled); and Unfulfillable (The order cannot be fulfilled. This state applies only to Multi-Channel Fulfillment orders.). | [optional] + **fulfillment_channels** | [**string[]**](../Model/string.md)| A list that indicates how an order was fulfilled. Filters the results by fulfillment channel. Possible values: FBA (Fulfillment by Amazon); SellerFulfilled (Fulfilled by the seller). | [optional] + **payment_methods** | [**string[]**](../Model/string.md)| A list of payment method values. Used to select orders paid using the specified payment methods. Possible values: COD (Cash on delivery); CVS (Convenience store payment); Other (Any payment method other than COD or CVS). | [optional] + **buyer_email** | **string**| The email address of a buyer. Used to select orders that contain the specified email address. | [optional] + **seller_order_id** | **string**| An order identifier that is specified by the seller. Used to select only the orders that match the order identifier. If SellerOrderId is specified, then FulfillmentChannels, OrderStatuses, PaymentMethod, LastUpdatedAfter, LastUpdatedBefore, and BuyerEmail cannot be specified. | [optional] + **max_results_per_page** | **int**| A number that indicates the maximum number of orders that can be returned per page. Value must be 1 - 100. Default 100. | [optional] + **easy_ship_shipment_statuses** | [**string[]**](../Model/string.md)| A list of EasyShipShipmentStatus values. Used to select Easy Ship orders with statuses that match the specified values. If EasyShipShipmentStatus is specified, only Amazon Easy Ship orders are returned.Possible values: PendingPickUp (Amazon has not yet picked up the package from the seller). LabelCanceled (The seller canceled the pickup). PickedUp (Amazon has picked up the package from the seller). AtOriginFC (The packaged is at the origin fulfillment center). AtDestinationFC (The package is at the destination fulfillment center). OutForDelivery (The package is out for delivery). Damaged (The package was damaged by the carrier). Delivered (The package has been delivered to the buyer). RejectedByBuyer (The package has been rejected by the buyer). Undeliverable (The package cannot be delivered). ReturnedToSeller (The package was not delivered to the buyer and was returned to the seller). ReturningToSeller (The package was not delivered to the buyer and is being returned to the seller). | [optional] + **next_token** | **string**| A string token returned in the response of your previous request. | [optional] + **amazon_order_ids** | [**string[]**](../Model/string.md)| A list of AmazonOrderId values. An AmazonOrderId is an Amazon-defined order identifier, in 3-7-7 format. | [optional] + +### Return type + +[**\Swagger\Client\Models\GetOrdersResponse**](../Model/GetOrdersResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + diff --git a/ProductPricingApi.md b/ProductPricingApi.md new file mode 100644 index 00000000..8c7d772e --- /dev/null +++ b/ProductPricingApi.md @@ -0,0 +1,257 @@ +# Swagger\Client\ProductPricingApi + +All URIs are relative to *https://sellingpartnerapi-na.amazon.com/* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getCompetitivePricing**](ProductPricingApi.md#getcompetitivepricing) | **GET** /products/pricing/v0/competitivePrice | +[**getItemOffers**](ProductPricingApi.md#getitemoffers) | **GET** /products/pricing/v0/items/{Asin}/offers | +[**getListingOffers**](ProductPricingApi.md#getlistingoffers) | **GET** /products/pricing/v0/listings/{SellerSKU}/offers | +[**getPricing**](ProductPricingApi.md#getpricing) | **GET** /products/pricing/v0/price | + +# **getCompetitivePricing** +> \Swagger\Client\Models\GetPricingResponse getCompetitivePricing($marketplace_id, $item_type, $asins, $skus) + + + +Returns competitive pricing information for a seller's offer listings based on seller SKU or ASIN. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\ProductPricingApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$marketplace_id = "marketplace_id_example"; // string | A marketplace identifier. Specifies the marketplace for which prices are returned. +$item_type = "item_type_example"; // string | Indicates whether ASIN values or seller SKU values are used to identify items. If you specify Asin, the information in the response will be dependent on the list of Asins you provide in the Asins parameter. If you specify Sku, the information in the response will be dependent on the list of Skus you provide in the Skus parameter. Possible values: Asin, Sku. +$asins = array("asins_example"); // string[] | A list of up to twenty Amazon Standard Identification Number (ASIN) values used to identify items in the given marketplace. +$skus = array("skus_example"); // string[] | A list of up to twenty seller SKU values used to identify items in the given marketplace. + +try { + $result = $apiInstance->getCompetitivePricing($marketplace_id, $item_type, $asins, $skus); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling ProductPricingApi->getCompetitivePricing: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **marketplace_id** | **string**| A marketplace identifier. Specifies the marketplace for which prices are returned. | + **item_type** | **string**| Indicates whether ASIN values or seller SKU values are used to identify items. If you specify Asin, the information in the response will be dependent on the list of Asins you provide in the Asins parameter. If you specify Sku, the information in the response will be dependent on the list of Skus you provide in the Skus parameter. Possible values: Asin, Sku. | + **asins** | [**string[]**](../Model/string.md)| A list of up to twenty Amazon Standard Identification Number (ASIN) values used to identify items in the given marketplace. | [optional] + **skus** | [**string[]**](../Model/string.md)| A list of up to twenty seller SKU values used to identify items in the given marketplace. | [optional] + +### Return type + +[**\Swagger\Client\Models\GetPricingResponse**](../Model/GetPricingResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **getItemOffers** +> \Swagger\Client\Models\GetOffersResponse getItemOffers($marketplace_id, $item_condition, $asin) + + + +Returns the lowest priced offers for a single item based on ASIN. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\ProductPricingApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$marketplace_id = "marketplace_id_example"; // string | A marketplace identifier. Specifies the marketplace for which prices are returned. +$item_condition = "item_condition_example"; // string | Filters the offer listings to be considered based on item condition. Possible values: New, Used, Collectible, Refurbished, Club. +$asin = "asin_example"; // string | The Amazon Standard Identification Number (ASIN) of the item. + +try { + $result = $apiInstance->getItemOffers($marketplace_id, $item_condition, $asin); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling ProductPricingApi->getItemOffers: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **marketplace_id** | **string**| A marketplace identifier. Specifies the marketplace for which prices are returned. | + **item_condition** | **string**| Filters the offer listings to be considered based on item condition. Possible values: New, Used, Collectible, Refurbished, Club. | + **asin** | **string**| The Amazon Standard Identification Number (ASIN) of the item. | + +### Return type + +[**\Swagger\Client\Models\GetOffersResponse**](../Model/GetOffersResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **getListingOffers** +> \Swagger\Client\Models\GetOffersResponse getListingOffers($marketplace_id, $item_condition, $seller_sku) + + + +Returns the lowest priced offers for a single SKU listing. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\ProductPricingApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$marketplace_id = "marketplace_id_example"; // string | A marketplace identifier. Specifies the marketplace for which prices are returned. +$item_condition = "item_condition_example"; // string | Filters the offer listings based on item condition. Possible values: New, Used, Collectible, Refurbished, Club. +$seller_sku = "seller_sku_example"; // string | Identifies an item in the given marketplace. SellerSKU is qualified by the seller's SellerId, which is included with every operation that you submit. + +try { + $result = $apiInstance->getListingOffers($marketplace_id, $item_condition, $seller_sku); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling ProductPricingApi->getListingOffers: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **marketplace_id** | **string**| A marketplace identifier. Specifies the marketplace for which prices are returned. | + **item_condition** | **string**| Filters the offer listings based on item condition. Possible values: New, Used, Collectible, Refurbished, Club. | + **seller_sku** | **string**| Identifies an item in the given marketplace. SellerSKU is qualified by the seller's SellerId, which is included with every operation that you submit. | + +### Return type + +[**\Swagger\Client\Models\GetOffersResponse**](../Model/GetOffersResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **getPricing** +> \Swagger\Client\Models\GetPricingResponse getPricing($marketplace_id, $item_type, $asins, $skus, $item_condition) + + + +Returns pricing information for a seller's offer listings based on seller SKU or ASIN. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\ProductPricingApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$marketplace_id = "marketplace_id_example"; // string | A marketplace identifier. Specifies the marketplace for which prices are returned. +$item_type = "item_type_example"; // string | Indicates whether ASIN values or seller SKU values are used to identify items. If you specify Asin, the information in the response will be dependent on the list of Asins you provide in the Asins parameter. If you specify Sku, the information in the response will be dependent on the list of Skus you provide in the Skus parameter. +$asins = array("asins_example"); // string[] | A list of up to twenty Amazon Standard Identification Number (ASIN) values used to identify items in the given marketplace. +$skus = array("skus_example"); // string[] | A list of up to twenty seller SKU values used to identify items in the given marketplace. +$item_condition = "item_condition_example"; // string | Filters the offer listings based on item condition. Possible values: New, Used, Collectible, Refurbished, Club. + +try { + $result = $apiInstance->getPricing($marketplace_id, $item_type, $asins, $skus, $item_condition); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling ProductPricingApi->getPricing: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **marketplace_id** | **string**| A marketplace identifier. Specifies the marketplace for which prices are returned. | + **item_type** | **string**| Indicates whether ASIN values or seller SKU values are used to identify items. If you specify Asin, the information in the response will be dependent on the list of Asins you provide in the Asins parameter. If you specify Sku, the information in the response will be dependent on the list of Skus you provide in the Skus parameter. | + **asins** | [**string[]**](../Model/string.md)| A list of up to twenty Amazon Standard Identification Number (ASIN) values used to identify items in the given marketplace. | [optional] + **skus** | [**string[]**](../Model/string.md)| A list of up to twenty seller SKU values used to identify items in the given marketplace. | [optional] + **item_condition** | **string**| Filters the offer listings based on item condition. Possible values: New, Used, Collectible, Refurbished, Club. | [optional] + +### Return type + +[**\Swagger\Client\Models\GetPricingResponse**](../Model/GetPricingResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + diff --git a/ReportsApi.md b/ReportsApi.md new file mode 100644 index 00000000..92ea49a7 --- /dev/null +++ b/ReportsApi.md @@ -0,0 +1,532 @@ +# Swagger\Client\ReportsApi + +All URIs are relative to *https://sellingpartnerapi-na.amazon.com/* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**cancelReport**](ReportsApi.md#cancelreport) | **DELETE** /reports/2020-09-04/reports/{reportId} | +[**cancelReportSchedule**](ReportsApi.md#cancelreportschedule) | **DELETE** /reports/2020-09-04/schedules/{reportScheduleId} | +[**createReport**](ReportsApi.md#createreport) | **POST** /reports/2020-09-04/reports | +[**createReportSchedule**](ReportsApi.md#createreportschedule) | **POST** /reports/2020-09-04/schedules | +[**getReport**](ReportsApi.md#getreport) | **GET** /reports/2020-09-04/reports/{reportId} | +[**getReportDocument**](ReportsApi.md#getreportdocument) | **GET** /reports/2020-09-04/documents/{reportDocumentId} | +[**getReportSchedule**](ReportsApi.md#getreportschedule) | **GET** /reports/2020-09-04/schedules/{reportScheduleId} | +[**getReportSchedules**](ReportsApi.md#getreportschedules) | **GET** /reports/2020-09-04/schedules | +[**getReports**](ReportsApi.md#getreports) | **GET** /reports/2020-09-04/reports | + +# **cancelReport** +> \Swagger\Client\Models\CancelReportResponse cancelReport($report_id) + + + +Cancels the report that you specify. Only reports with processingStatus=IN_QUEUE can be cancelled. Cancelled reports are returned in subsequent calls to the getReport and getReports operations. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\ReportsApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$report_id = "report_id_example"; // string | The identifier for the report. This identifier is unique only in combination with a seller ID. + +try { + $result = $apiInstance->cancelReport($report_id); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling ReportsApi->cancelReport: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **report_id** | **string**| The identifier for the report. This identifier is unique only in combination with a seller ID. | + +### Return type + +[**\Swagger\Client\Models\CancelReportResponse**](../Model/CancelReportResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **cancelReportSchedule** +> \Swagger\Client\Models\CancelReportScheduleResponse cancelReportSchedule($report_schedule_id) + + + +Cancels the report schedule that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\ReportsApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$report_schedule_id = "report_schedule_id_example"; // string | The identifier for the report schedule. This identifier is unique only in combination with a seller ID. + +try { + $result = $apiInstance->cancelReportSchedule($report_schedule_id); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling ReportsApi->cancelReportSchedule: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **report_schedule_id** | **string**| The identifier for the report schedule. This identifier is unique only in combination with a seller ID. | + +### Return type + +[**\Swagger\Client\Models\CancelReportScheduleResponse**](../Model/CancelReportScheduleResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **createReport** +> \Swagger\Client\Models\CreateReportResponse createReport($body) + + + +Creates a report. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\ReportsApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$body = new \Swagger\Client\Models\CreateReportSpecification(); // \Swagger\Client\Models\CreateReportSpecification | + +try { + $result = $apiInstance->createReport($body); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling ReportsApi->createReport: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**\Swagger\Client\Models\CreateReportSpecification**](../Model/CreateReportSpecification.md)| | + +### Return type + +[**\Swagger\Client\Models\CreateReportResponse**](../Model/CreateReportResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **createReportSchedule** +> \Swagger\Client\Models\CreateReportScheduleResponse createReportSchedule($body) + + + +Creates a report schedule. If a report schedule with the same report type and marketplace IDs already exists, it will be cancelled and replaced with this one. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\ReportsApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$body = new \Swagger\Client\Models\CreateReportScheduleSpecification(); // \Swagger\Client\Models\CreateReportScheduleSpecification | + +try { + $result = $apiInstance->createReportSchedule($body); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling ReportsApi->createReportSchedule: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**\Swagger\Client\Models\CreateReportScheduleSpecification**](../Model/CreateReportScheduleSpecification.md)| | + +### Return type + +[**\Swagger\Client\Models\CreateReportScheduleResponse**](../Model/CreateReportScheduleResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **getReport** +> \Swagger\Client\Models\GetReportResponse getReport($report_id) + + + +Returns report details (including the reportDocumentId, if available) for the report that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2.0 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\ReportsApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$report_id = "report_id_example"; // string | The identifier for the report. This identifier is unique only in combination with a seller ID. + +try { + $result = $apiInstance->getReport($report_id); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling ReportsApi->getReport: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **report_id** | **string**| The identifier for the report. This identifier is unique only in combination with a seller ID. | + +### Return type + +[**\Swagger\Client\Models\GetReportResponse**](../Model/GetReportResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **getReportDocument** +> \Swagger\Client\Models\GetReportDocumentResponse getReportDocument($report_document_id) + + + +Returns the information required for retrieving a report document's contents. This includes a presigned URL for the report document as well as the information required to decrypt the document's contents. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\ReportsApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$report_document_id = "report_document_id_example"; // string | The identifier for the report document. + +try { + $result = $apiInstance->getReportDocument($report_document_id); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling ReportsApi->getReportDocument: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **report_document_id** | **string**| The identifier for the report document. | + +### Return type + +[**\Swagger\Client\Models\GetReportDocumentResponse**](../Model/GetReportDocumentResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **getReportSchedule** +> \Swagger\Client\Models\GetReportScheduleResponse getReportSchedule($report_schedule_id) + + + +Returns report schedule details for the report schedule that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\ReportsApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$report_schedule_id = "report_schedule_id_example"; // string | The identifier for the report schedule. This identifier is unique only in combination with a seller ID. + +try { + $result = $apiInstance->getReportSchedule($report_schedule_id); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling ReportsApi->getReportSchedule: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **report_schedule_id** | **string**| The identifier for the report schedule. This identifier is unique only in combination with a seller ID. | + +### Return type + +[**\Swagger\Client\Models\GetReportScheduleResponse**](../Model/GetReportScheduleResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **getReportSchedules** +> \Swagger\Client\Models\GetReportSchedulesResponse getReportSchedules($report_types) + + + +Returns report schedule details that match the filters that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\ReportsApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$report_types = array("report_types_example"); // string[] | A list of report types used to filter report schedules. + +try { + $result = $apiInstance->getReportSchedules($report_types); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling ReportsApi->getReportSchedules: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **report_types** | [**string[]**](../Model/string.md)| A list of report types used to filter report schedules. | + +### Return type + +[**\Swagger\Client\Models\GetReportSchedulesResponse**](../Model/GetReportSchedulesResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **getReports** +> \Swagger\Client\Models\GetReportsResponse getReports($report_types, $processing_statuses, $marketplace_ids, $page_size, $created_since, $created_until, $next_token) + + + +Returns report details for the reports that match the filters that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\ReportsApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$report_types = array("report_types_example"); // string[] | A list of report types used to filter reports. When reportTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. Either reportTypes or nextToken is required. +$processing_statuses = array("processing_statuses_example"); // string[] | A list of processing statuses used to filter reports. +$marketplace_ids = array("marketplace_ids_example"); // string[] | A list of marketplace identifiers used to filter reports. The reports returned will match at least one of the marketplaces that you specify. +$page_size = 10; // int | The maximum number of reports to return in a single call. +$created_since = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | The earliest report creation date and time for reports to include in the response, in ISO 8601 date time format. The default is 90 days ago. Reports are retained for a maximum of 90 days. +$created_until = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | The latest report creation date and time for reports to include in the response, in ISO 8601 date time format. The default is now. +$next_token = "next_token_example"; // string | A string token returned in the response to your previous request. nextToken is returned when the number of results exceeds the specified pageSize value. To get the next page of results, call the getReports operation and include this token as the only parameter. Specifying nextToken with any other parameters will cause the request to fail. + +try { + $result = $apiInstance->getReports($report_types, $processing_statuses, $marketplace_ids, $page_size, $created_since, $created_until, $next_token); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling ReportsApi->getReports: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **report_types** | [**string[]**](../Model/string.md)| A list of report types used to filter reports. When reportTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. Either reportTypes or nextToken is required. | [optional] + **processing_statuses** | [**string[]**](../Model/string.md)| A list of processing statuses used to filter reports. | [optional] + **marketplace_ids** | [**string[]**](../Model/string.md)| A list of marketplace identifiers used to filter reports. The reports returned will match at least one of the marketplaces that you specify. | [optional] + **page_size** | **int**| The maximum number of reports to return in a single call. | [optional] [default to 10] + **created_since** | **\DateTime**| The earliest report creation date and time for reports to include in the response, in ISO 8601 date time format. The default is 90 days ago. Reports are retained for a maximum of 90 days. | [optional] + **created_until** | **\DateTime**| The latest report creation date and time for reports to include in the response, in ISO 8601 date time format. The default is now. | [optional] + **next_token** | **string**| A string token returned in the response to your previous request. nextToken is returned when the number of results exceeds the specified pageSize value. To get the next page of results, call the getReports operation and include this token as the only parameter. Specifying nextToken with any other parameters will cause the request to fail. | [optional] + +### Return type + +[**\Swagger\Client\Models\GetReportsResponse**](../Model/GetReportsResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + diff --git a/SalesApi.md b/SalesApi.md new file mode 100644 index 00000000..140bdc42 --- /dev/null +++ b/SalesApi.md @@ -0,0 +1,80 @@ +# Swagger\Client\SalesApi + +All URIs are relative to *https://sellingpartnerapi-na.amazon.com/* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getOrderMetrics**](SalesApi.md#getordermetrics) | **GET** /sales/v1/orderMetrics | + +# **getOrderMetrics** +> \Swagger\Client\Models\GetOrderMetricsResponse getOrderMetrics($marketplace_ids, $interval, $granularity, $granularity_time_zone, $buyer_type, $fulfillment_network, $first_day_of_week, $asin, $sku) + + + +Returns aggregated order metrics for given interval, broken down by granularity, for given buyer type. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | .5 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\SalesApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$marketplace_ids = array("marketplace_ids_example"); // string[] | A list of marketplace identifiers. Example: ATVPDKIKX0DER indicates the US marketplace. +$interval = "interval_example"; // string | A time interval used for selecting order metrics. This takes the form of two dates separated by two hyphens (first date is inclusive; second date is exclusive). Dates are in ISO8601 format and must represent absolute time (either Z notation or offset notation). Example: 2018-09-01T00:00:00-07:00--2018-09-04T00:00:00-07:00 requests order metrics for Sept 1st, 2nd and 3rd in the -07:00 zone. +$granularity = "granularity_example"; // string | The granularity of the grouping of order metrics, based on a unit of time. Specifying granularity=Hour results in a successful request only if the interval specified is less than or equal to 30 days from now. For all other granularities, the interval specified must be less or equal to 2 years from now. Specifying granularity=Total results in order metrics that are aggregated over the entire interval that you specify. If the interval start and end date don’t align with the specified granularity, the head and tail end of the response interval will contain partial data. Example: Day to get a daily breakdown of the request interval, where the day boundary is defined by the granularityTimeZone. +$granularity_time_zone = "granularity_time_zone_example"; // string | An IANA-compatible time zone for determining the day boundary. Required when specifying a granularity value greater than Hour. The granularityTimeZone value must align with the offset of the specified interval value. For example, if the interval value uses Z notation, then granularityTimeZone must be UTC. If the interval value uses an offset, then granularityTimeZone must be an IANA-compatible time zone that matches the offset. Example: US/Pacific to compute day boundaries, accounting for daylight time savings, for US/Pacific zone. +$buyer_type = "All"; // string | Filters the results by the buyer type that you specify, B2B (business to business) or B2C (business to customer). Example: B2B, if you want the response to include order metrics for only B2B buyers. +$fulfillment_network = "fulfillment_network_example"; // string | Filters the results by the fulfillment network that you specify, MFN (merchant fulfillment network) or AFN (Amazon fulfillment network). Do not include this filter if you want the response to include order metrics for all fulfillment networks. Example: AFN, if you want the response to include order metrics for only Amazon fulfillment network. +$first_day_of_week = "Monday"; // string | Specifies the day that the week starts on when granularity=Week, either Monday or Sunday. Default: Monday. Example: Sunday, if you want the week to start on a Sunday. +$asin = "asin_example"; // string | Filters the results by the ASIN that you specify. Specifying both ASIN and SKU returns an error. Do not include this filter if you want the response to include order metrics for all ASINs. Example: B0792R1RSN, if you want the response to include order metrics for only ASIN B0792R1RSN. +$sku = "sku_example"; // string | Filters the results by the SKU that you specify. Specifying both ASIN and SKU returns an error. Do not include this filter if you want the response to include order metrics for all SKUs. Example: TestSKU, if you want the response to include order metrics for only SKU TestSKU. + +try { + $result = $apiInstance->getOrderMetrics($marketplace_ids, $interval, $granularity, $granularity_time_zone, $buyer_type, $fulfillment_network, $first_day_of_week, $asin, $sku); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling SalesApi->getOrderMetrics: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **marketplace_ids** | [**string[]**](../Model/string.md)| A list of marketplace identifiers. Example: ATVPDKIKX0DER indicates the US marketplace. | + **interval** | **string**| A time interval used for selecting order metrics. This takes the form of two dates separated by two hyphens (first date is inclusive; second date is exclusive). Dates are in ISO8601 format and must represent absolute time (either Z notation or offset notation). Example: 2018-09-01T00:00:00-07:00--2018-09-04T00:00:00-07:00 requests order metrics for Sept 1st, 2nd and 3rd in the -07:00 zone. | + **granularity** | **string**| The granularity of the grouping of order metrics, based on a unit of time. Specifying granularity=Hour results in a successful request only if the interval specified is less than or equal to 30 days from now. For all other granularities, the interval specified must be less or equal to 2 years from now. Specifying granularity=Total results in order metrics that are aggregated over the entire interval that you specify. If the interval start and end date don’t align with the specified granularity, the head and tail end of the response interval will contain partial data. Example: Day to get a daily breakdown of the request interval, where the day boundary is defined by the granularityTimeZone. | + **granularity_time_zone** | **string**| An IANA-compatible time zone for determining the day boundary. Required when specifying a granularity value greater than Hour. The granularityTimeZone value must align with the offset of the specified interval value. For example, if the interval value uses Z notation, then granularityTimeZone must be UTC. If the interval value uses an offset, then granularityTimeZone must be an IANA-compatible time zone that matches the offset. Example: US/Pacific to compute day boundaries, accounting for daylight time savings, for US/Pacific zone. | [optional] + **buyer_type** | **string**| Filters the results by the buyer type that you specify, B2B (business to business) or B2C (business to customer). Example: B2B, if you want the response to include order metrics for only B2B buyers. | [optional] [default to All] + **fulfillment_network** | **string**| Filters the results by the fulfillment network that you specify, MFN (merchant fulfillment network) or AFN (Amazon fulfillment network). Do not include this filter if you want the response to include order metrics for all fulfillment networks. Example: AFN, if you want the response to include order metrics for only Amazon fulfillment network. | [optional] + **first_day_of_week** | **string**| Specifies the day that the week starts on when granularity=Week, either Monday or Sunday. Default: Monday. Example: Sunday, if you want the week to start on a Sunday. | [optional] [default to Monday] + **asin** | **string**| Filters the results by the ASIN that you specify. Specifying both ASIN and SKU returns an error. Do not include this filter if you want the response to include order metrics for all ASINs. Example: B0792R1RSN, if you want the response to include order metrics for only ASIN B0792R1RSN. | [optional] + **sku** | **string**| Filters the results by the SKU that you specify. Specifying both ASIN and SKU returns an error. Do not include this filter if you want the response to include order metrics for all SKUs. Example: TestSKU, if you want the response to include order metrics for only SKU TestSKU. | [optional] + +### Return type + +[**\Swagger\Client\Models\GetOrderMetricsResponse**](../Model/GetOrderMetricsResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, payload + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + diff --git a/SellersApi.md b/SellersApi.md new file mode 100644 index 00000000..47ba4eeb --- /dev/null +++ b/SellersApi.md @@ -0,0 +1,60 @@ +# Swagger\Client\SellersApi + +All URIs are relative to *https://sellingpartnerapi-na.amazon.com/* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getMarketplaceParticipations**](SellersApi.md#getmarketplaceparticipations) | **GET** /sellers/v1/marketplaceParticipations | + +# **getMarketplaceParticipations** +> \Swagger\Client\Models\GetMarketplaceParticipationsResponse getMarketplaceParticipations() + + + +Returns a list of marketplaces that the seller submitting the request can sell in and information about the seller's participation in those marketplaces. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | .016 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\SellersApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); + +try { + $result = $apiInstance->getMarketplaceParticipations(); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling SellersApi->getMarketplaceParticipations: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**\Swagger\Client\Models\GetMarketplaceParticipationsResponse**](../Model/GetMarketplaceParticipationsResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, payload + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + diff --git a/ServiceApi.md b/ServiceApi.md new file mode 100644 index 00000000..e1c03729 --- /dev/null +++ b/ServiceApi.md @@ -0,0 +1,381 @@ +# Swagger\Client\ServiceApi + +All URIs are relative to *https://sellingpartnerapi-na.amazon.com/* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**addAppointmentForServiceJobByServiceJobId**](ServiceApi.md#addappointmentforservicejobbyservicejobid) | **POST** /service/v1/serviceJobs/{serviceJobId}/appointments | +[**cancelServiceJobByServiceJobId**](ServiceApi.md#cancelservicejobbyservicejobid) | **PUT** /service/v1/serviceJobs/{serviceJobId}/cancellations | +[**completeServiceJobByServiceJobId**](ServiceApi.md#completeservicejobbyservicejobid) | **PUT** /service/v1/serviceJobs/{serviceJobId}/completions | +[**getServiceJobByServiceJobId**](ServiceApi.md#getservicejobbyservicejobid) | **GET** /service/v1/serviceJobs/{serviceJobId} | +[**getServiceJobs**](ServiceApi.md#getservicejobs) | **GET** /service/v1/serviceJobs | +[**rescheduleAppointmentForServiceJobByServiceJobId**](ServiceApi.md#rescheduleappointmentforservicejobbyservicejobid) | **POST** /service/v1/serviceJobs/{serviceJobId}/appointments/{appointmentId} | + +# **addAppointmentForServiceJobByServiceJobId** +> \Swagger\Client\Models\SetAppointmentResponse addAppointmentForServiceJobByServiceJobId($body, $service_job_id) + + + +Adds an appointment to the service job indicated by the service job identifier you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\ServiceApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$body = new \Swagger\Client\Models\AddAppointmentRequest(); // \Swagger\Client\Models\AddAppointmentRequest | Add appointment operation input details. +$service_job_id = "service_job_id_example"; // string | An Amazon defined service job identifier. + +try { + $result = $apiInstance->addAppointmentForServiceJobByServiceJobId($body, $service_job_id); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling ServiceApi->addAppointmentForServiceJobByServiceJobId: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**\Swagger\Client\Models\AddAppointmentRequest**](../Model/AddAppointmentRequest.md)| Add appointment operation input details. | + **service_job_id** | **string**| An Amazon defined service job identifier. | + +### Return type + +[**\Swagger\Client\Models\SetAppointmentResponse**](../Model/SetAppointmentResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **cancelServiceJobByServiceJobId** +> \Swagger\Client\Models\CancelServiceJobByServiceJobIdResponse cancelServiceJobByServiceJobId($service_job_id, $cancellation_reason_code) + + + +Cancels the service job indicated by the service job identifier you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\ServiceApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$service_job_id = "service_job_id_example"; // string | An Amazon defined service job identifier. +$cancellation_reason_code = "cancellation_reason_code_example"; // string | A cancel reason code that specifies the reason for cancelling a service job. + +try { + $result = $apiInstance->cancelServiceJobByServiceJobId($service_job_id, $cancellation_reason_code); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling ServiceApi->cancelServiceJobByServiceJobId: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_job_id** | **string**| An Amazon defined service job identifier. | + **cancellation_reason_code** | **string**| A cancel reason code that specifies the reason for cancelling a service job. | + +### Return type + +[**\Swagger\Client\Models\CancelServiceJobByServiceJobIdResponse**](../Model/CancelServiceJobByServiceJobIdResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **completeServiceJobByServiceJobId** +> \Swagger\Client\Models\CompleteServiceJobByServiceJobIdResponse completeServiceJobByServiceJobId($service_job_id) + + + +Completes the service job indicated by the service job identifier you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\ServiceApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$service_job_id = "service_job_id_example"; // string | An Amazon defined service job identifier. + +try { + $result = $apiInstance->completeServiceJobByServiceJobId($service_job_id); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling ServiceApi->completeServiceJobByServiceJobId: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_job_id** | **string**| An Amazon defined service job identifier. | + +### Return type + +[**\Swagger\Client\Models\CompleteServiceJobByServiceJobIdResponse**](../Model/CompleteServiceJobByServiceJobIdResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **getServiceJobByServiceJobId** +> \Swagger\Client\Models\GetServiceJobByServiceJobIdResponse getServiceJobByServiceJobId($service_job_id) + + + +Gets service job details for the service job indicated by the service job identifier you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\ServiceApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$service_job_id = "service_job_id_example"; // string | A service job identifier. + +try { + $result = $apiInstance->getServiceJobByServiceJobId($service_job_id); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling ServiceApi->getServiceJobByServiceJobId: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_job_id** | **string**| A service job identifier. | + +### Return type + +[**\Swagger\Client\Models\GetServiceJobByServiceJobIdResponse**](../Model/GetServiceJobByServiceJobIdResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **getServiceJobs** +> \Swagger\Client\Models\GetServiceJobsResponse getServiceJobs($marketplace_ids, $service_order_ids, $service_job_status, $page_token, $page_size, $sort_field, $sort_order, $created_after, $created_before, $last_updated_after, $last_updated_before, $schedule_start_date, $schedule_end_date) + + + +Gets service job details for the specified filter query. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\ServiceApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$marketplace_ids = array("marketplace_ids_example"); // string[] | Used to select jobs that were placed in the specified marketplaces. +$service_order_ids = array("service_order_ids_example"); // string[] | List of service order ids for the query you want to perform.Max values supported 20. +$service_job_status = array("service_job_status_example"); // string[] | A list of one or more job status by which to filter the list of jobs. +$page_token = "page_token_example"; // string | String returned in the response of your previous request. +$page_size = 20; // int | A non-negative integer that indicates the maximum number of jobs to return in the list, Value must be 1 - 20. Default 20. +$sort_field = "sort_field_example"; // string | Sort fields on which you want to sort the output. +$sort_order = "sort_order_example"; // string | sort order for the query you want to perform. +$created_after = "created_after_example"; // string | A date used for selecting jobs created after (or at) a specified time must be in ISO 8601 format. Required if LastUpdatedAfter is not specified.Specifying both CreatedAfter and LastUpdatedAfter returns an error. +$created_before = "created_before_example"; // string | A date used for selecting jobs created before (or at) a specified time must be in ISO 8601 format. +$last_updated_after = "last_updated_after_example"; // string | A date used for selecting jobs updated after (or at) a specified time must be in ISO 8601 format. Required if createdAfter is not specified.Specifying both CreatedAfter and LastUpdatedAfter returns an error. +$last_updated_before = "last_updated_before_example"; // string | A date used for selecting jobs updated before (or at) a specified time must be in ISO 8601 format. +$schedule_start_date = "schedule_start_date_example"; // string | A date used for filtering jobs schedule after (or at) a specified time must be in ISO 8601 format. schedule end date should not be earlier than schedule start date. +$schedule_end_date = "schedule_end_date_example"; // string | A date used for filtering jobs schedule before (or at) a specified time must be in ISO 8601 format. schedule end date should not be earlier than schedule start date. + +try { + $result = $apiInstance->getServiceJobs($marketplace_ids, $service_order_ids, $service_job_status, $page_token, $page_size, $sort_field, $sort_order, $created_after, $created_before, $last_updated_after, $last_updated_before, $schedule_start_date, $schedule_end_date); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling ServiceApi->getServiceJobs: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **marketplace_ids** | [**string[]**](../Model/string.md)| Used to select jobs that were placed in the specified marketplaces. | + **service_order_ids** | [**string[]**](../Model/string.md)| List of service order ids for the query you want to perform.Max values supported 20. | [optional] + **service_job_status** | [**string[]**](../Model/string.md)| A list of one or more job status by which to filter the list of jobs. | [optional] + **page_token** | **string**| String returned in the response of your previous request. | [optional] + **page_size** | **int**| A non-negative integer that indicates the maximum number of jobs to return in the list, Value must be 1 - 20. Default 20. | [optional] [default to 20] + **sort_field** | **string**| Sort fields on which you want to sort the output. | [optional] + **sort_order** | **string**| sort order for the query you want to perform. | [optional] + **created_after** | **string**| A date used for selecting jobs created after (or at) a specified time must be in ISO 8601 format. Required if LastUpdatedAfter is not specified.Specifying both CreatedAfter and LastUpdatedAfter returns an error. | [optional] + **created_before** | **string**| A date used for selecting jobs created before (or at) a specified time must be in ISO 8601 format. | [optional] + **last_updated_after** | **string**| A date used for selecting jobs updated after (or at) a specified time must be in ISO 8601 format. Required if createdAfter is not specified.Specifying both CreatedAfter and LastUpdatedAfter returns an error. | [optional] + **last_updated_before** | **string**| A date used for selecting jobs updated before (or at) a specified time must be in ISO 8601 format. | [optional] + **schedule_start_date** | **string**| A date used for filtering jobs schedule after (or at) a specified time must be in ISO 8601 format. schedule end date should not be earlier than schedule start date. | [optional] + **schedule_end_date** | **string**| A date used for filtering jobs schedule before (or at) a specified time must be in ISO 8601 format. schedule end date should not be earlier than schedule start date. | [optional] + +### Return type + +[**\Swagger\Client\Models\GetServiceJobsResponse**](../Model/GetServiceJobsResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **rescheduleAppointmentForServiceJobByServiceJobId** +> \Swagger\Client\Models\SetAppointmentResponse rescheduleAppointmentForServiceJobByServiceJobId($body, $service_job_id, $appointment_id) + + + +Reschedules an appointment for the service job indicated by the service job identifier you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\ServiceApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$body = new \Swagger\Client\Models\RescheduleAppointmentRequest(); // \Swagger\Client\Models\RescheduleAppointmentRequest | Reschedule appointment operation input details. +$service_job_id = "service_job_id_example"; // string | An Amazon defined service job identifier. +$appointment_id = "appointment_id_example"; // string | An existing appointment identifier for the Service Job. + +try { + $result = $apiInstance->rescheduleAppointmentForServiceJobByServiceJobId($body, $service_job_id, $appointment_id); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling ServiceApi->rescheduleAppointmentForServiceJobByServiceJobId: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**\Swagger\Client\Models\RescheduleAppointmentRequest**](../Model/RescheduleAppointmentRequest.md)| Reschedule appointment operation input details. | + **service_job_id** | **string**| An Amazon defined service job identifier. | + **appointment_id** | **string**| An existing appointment identifier for the Service Job. | + +### Return type + +[**\Swagger\Client\Models\SetAppointmentResponse**](../Model/SetAppointmentResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + diff --git a/ShippingApi.md b/ShippingApi.md new file mode 100644 index 00000000..febffdfa --- /dev/null +++ b/ShippingApi.md @@ -0,0 +1,522 @@ +# Swagger\Client\ShippingApi + +All URIs are relative to *https://sellingpartnerapi-na.amazon.com/* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**cancelShipment**](ShippingApi.md#cancelshipment) | **POST** /shipping/v1/shipments/{shipmentId}/cancel | +[**createShipment**](ShippingApi.md#createshipment) | **POST** /shipping/v1/shipments | +[**getAccount**](ShippingApi.md#getaccount) | **GET** /shipping/v1/account | +[**getRates**](ShippingApi.md#getrates) | **POST** /shipping/v1/rates | +[**getShipment**](ShippingApi.md#getshipment) | **GET** /shipping/v1/shipments/{shipmentId} | +[**getTrackingInformation**](ShippingApi.md#gettrackinginformation) | **GET** /shipping/v1/tracking/{trackingId} | +[**purchaseLabels**](ShippingApi.md#purchaselabels) | **POST** /shipping/v1/shipments/{shipmentId}/purchaseLabels | +[**purchaseShipment**](ShippingApi.md#purchaseshipment) | **POST** /shipping/v1/purchaseShipment | +[**retrieveShippingLabel**](ShippingApi.md#retrieveshippinglabel) | **POST** /shipping/v1/shipments/{shipmentId}/containers/{trackingId}/label | + +# **cancelShipment** +> \Swagger\Client\Models\CancelShipmentResponse cancelShipment($shipment_id) + + + +Cancel a shipment by the given shipmentId. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\ShippingApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$shipment_id = "shipment_id_example"; // string | + +try { + $result = $apiInstance->cancelShipment($shipment_id); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling ShippingApi->cancelShipment: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **shipment_id** | **string**| | + +### Return type + +[**\Swagger\Client\Models\CancelShipmentResponse**](../Model/CancelShipmentResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **createShipment** +> \Swagger\Client\Models\CreateShipmentResponse createShipment($body) + + + +Create a new shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\ShippingApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$body = new \Swagger\Client\Models\CreateShipmentRequest(); // \Swagger\Client\Models\CreateShipmentRequest | + +try { + $result = $apiInstance->createShipment($body); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling ShippingApi->createShipment: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**\Swagger\Client\Models\CreateShipmentRequest**](../Model/CreateShipmentRequest.md)| | + +### Return type + +[**\Swagger\Client\Models\CreateShipmentResponse**](../Model/CreateShipmentResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **getAccount** +> \Swagger\Client\Models\GetAccountResponse getAccount() + + + +Verify if the current account is valid. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\ShippingApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); + +try { + $result = $apiInstance->getAccount(); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling ShippingApi->getAccount: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**\Swagger\Client\Models\GetAccountResponse**](../Model/GetAccountResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **getRates** +> \Swagger\Client\Models\GetRatesResponse getRates($body) + + + +Get service rates. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\ShippingApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$body = new \Swagger\Client\Models\GetRatesRequest(); // \Swagger\Client\Models\GetRatesRequest | + +try { + $result = $apiInstance->getRates($body); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling ShippingApi->getRates: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**\Swagger\Client\Models\GetRatesRequest**](../Model/GetRatesRequest.md)| | + +### Return type + +[**\Swagger\Client\Models\GetRatesResponse**](../Model/GetRatesResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **getShipment** +> \Swagger\Client\Models\GetShipmentResponse getShipment($shipment_id) + + + +Return the entire shipment object for the shipmentId. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\ShippingApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$shipment_id = "shipment_id_example"; // string | + +try { + $result = $apiInstance->getShipment($shipment_id); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling ShippingApi->getShipment: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **shipment_id** | **string**| | + +### Return type + +[**\Swagger\Client\Models\GetShipmentResponse**](../Model/GetShipmentResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **getTrackingInformation** +> \Swagger\Client\Models\GetTrackingInformationResponse getTrackingInformation($tracking_id) + + + +Return the tracking information of a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\ShippingApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$tracking_id = "tracking_id_example"; // string | + +try { + $result = $apiInstance->getTrackingInformation($tracking_id); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling ShippingApi->getTrackingInformation: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **tracking_id** | **string**| | + +### Return type + +[**\Swagger\Client\Models\GetTrackingInformationResponse**](../Model/GetTrackingInformationResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **purchaseLabels** +> \Swagger\Client\Models\PurchaseLabelsResponse purchaseLabels($body, $shipment_id) + + + +Purchase shipping labels based on a given rate. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\ShippingApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$body = new \Swagger\Client\Models\PurchaseLabelsRequest(); // \Swagger\Client\Models\PurchaseLabelsRequest | +$shipment_id = "shipment_id_example"; // string | + +try { + $result = $apiInstance->purchaseLabels($body, $shipment_id); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling ShippingApi->purchaseLabels: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**\Swagger\Client\Models\PurchaseLabelsRequest**](../Model/PurchaseLabelsRequest.md)| | + **shipment_id** | **string**| | + +### Return type + +[**\Swagger\Client\Models\PurchaseLabelsResponse**](../Model/PurchaseLabelsResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **purchaseShipment** +> \Swagger\Client\Models\PurchaseShipmentResponse purchaseShipment($body) + + + +Purchase shipping labels. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\ShippingApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$body = new \Swagger\Client\Models\PurchaseShipmentRequest(); // \Swagger\Client\Models\PurchaseShipmentRequest | + +try { + $result = $apiInstance->purchaseShipment($body); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling ShippingApi->purchaseShipment: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**\Swagger\Client\Models\PurchaseShipmentRequest**](../Model/PurchaseShipmentRequest.md)| | + +### Return type + +[**\Swagger\Client\Models\PurchaseShipmentResponse**](../Model/PurchaseShipmentResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **retrieveShippingLabel** +> \Swagger\Client\Models\RetrieveShippingLabelResponse retrieveShippingLabel($body, $shipment_id, $tracking_id) + + + +Retrieve shipping label based on the shipment id and tracking id. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\ShippingApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$body = new \Swagger\Client\Models\RetrieveShippingLabelRequest(); // \Swagger\Client\Models\RetrieveShippingLabelRequest | +$shipment_id = "shipment_id_example"; // string | +$tracking_id = "tracking_id_example"; // string | + +try { + $result = $apiInstance->retrieveShippingLabel($body, $shipment_id, $tracking_id); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling ShippingApi->retrieveShippingLabel: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**\Swagger\Client\Models\RetrieveShippingLabelRequest**](../Model/RetrieveShippingLabelRequest.md)| | + **shipment_id** | **string**| | + **tracking_id** | **string**| | + +### Return type + +[**\Swagger\Client\Models\RetrieveShippingLabelResponse**](../Model/RetrieveShippingLabelResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + diff --git a/SmallAndLightApi.md b/SmallAndLightApi.md new file mode 100644 index 00000000..79485b4f --- /dev/null +++ b/SmallAndLightApi.md @@ -0,0 +1,299 @@ +# Swagger\Client\SmallAndLightApi + +All URIs are relative to *https://sellingpartnerapi-na.amazon.com/* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**deleteSmallAndLightEnrollmentBySellerSKU**](SmallAndLightApi.md#deletesmallandlightenrollmentbysellersku) | **DELETE** /fba/smallAndLight/v1/enrollments/{sellerSKU} | +[**getSmallAndLightEligibilityBySellerSKU**](SmallAndLightApi.md#getsmallandlighteligibilitybysellersku) | **GET** /fba/smallAndLight/v1/eligibilities/{sellerSKU} | +[**getSmallAndLightEnrollmentBySellerSKU**](SmallAndLightApi.md#getsmallandlightenrollmentbysellersku) | **GET** /fba/smallAndLight/v1/enrollments/{sellerSKU} | +[**getSmallAndLightFeePreview**](SmallAndLightApi.md#getsmallandlightfeepreview) | **POST** /fba/smallAndLight/v1/feePreviews | +[**putSmallAndLightEnrollmentBySellerSKU**](SmallAndLightApi.md#putsmallandlightenrollmentbysellersku) | **PUT** /fba/smallAndLight/v1/enrollments/{sellerSKU} | + +# **deleteSmallAndLightEnrollmentBySellerSKU** +> deleteSmallAndLightEnrollmentBySellerSKU($seller_sku, $marketplace_ids) + + + +Removes the item indicated by the specified seller SKU from the Small and Light program in the specified marketplace. If the item is not eligible for disenrollment, the ineligibility reasons are returned. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 5 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\SmallAndLightApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$seller_sku = "seller_sku_example"; // string | The seller SKU that identifies the item. +$marketplace_ids = array("marketplace_ids_example"); // string[] | The marketplace in which to remove the item from the Small and Light program. Note: Accepts a single marketplace only. + +try { + $apiInstance->deleteSmallAndLightEnrollmentBySellerSKU($seller_sku, $marketplace_ids); +} catch (Exception $e) { + echo 'Exception when calling SmallAndLightApi->deleteSmallAndLightEnrollmentBySellerSKU: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **seller_sku** | **string**| The seller SKU that identifies the item. | + **marketplace_ids** | [**string[]**](../Model/string.md)| The marketplace in which to remove the item from the Small and Light program. Note: Accepts a single marketplace only. | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **getSmallAndLightEligibilityBySellerSKU** +> \Swagger\Client\Models\SmallAndLightEligibility getSmallAndLightEligibilityBySellerSKU($seller_sku, $marketplace_ids) + + + +Returns the Small and Light program eligibility status of the item indicated by the specified seller SKU in the specified marketplace. If the item is not eligible, the ineligibility reasons are returned. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\SmallAndLightApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$seller_sku = "seller_sku_example"; // string | The seller SKU that identifies the item. +$marketplace_ids = array("marketplace_ids_example"); // string[] | The marketplace for which the eligibility status is retrieved. NOTE: Accepts a single marketplace only. + +try { + $result = $apiInstance->getSmallAndLightEligibilityBySellerSKU($seller_sku, $marketplace_ids); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling SmallAndLightApi->getSmallAndLightEligibilityBySellerSKU: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **seller_sku** | **string**| The seller SKU that identifies the item. | + **marketplace_ids** | [**string[]**](../Model/string.md)| The marketplace for which the eligibility status is retrieved. NOTE: Accepts a single marketplace only. | + +### Return type + +[**\Swagger\Client\Models\SmallAndLightEligibility**](../Model/SmallAndLightEligibility.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **getSmallAndLightEnrollmentBySellerSKU** +> \Swagger\Client\Models\SmallAndLightEnrollment getSmallAndLightEnrollmentBySellerSKU($seller_sku, $marketplace_ids) + + + +Returns the Small and Light enrollment status for the item indicated by the specified seller SKU in the specified marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\SmallAndLightApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$seller_sku = "seller_sku_example"; // string | The seller SKU that identifies the item. +$marketplace_ids = array("marketplace_ids_example"); // string[] | The marketplace for which the enrollment status is retrieved. Note: Accepts a single marketplace only. + +try { + $result = $apiInstance->getSmallAndLightEnrollmentBySellerSKU($seller_sku, $marketplace_ids); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling SmallAndLightApi->getSmallAndLightEnrollmentBySellerSKU: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **seller_sku** | **string**| The seller SKU that identifies the item. | + **marketplace_ids** | [**string[]**](../Model/string.md)| The marketplace for which the enrollment status is retrieved. Note: Accepts a single marketplace only. | + +### Return type + +[**\Swagger\Client\Models\SmallAndLightEnrollment**](../Model/SmallAndLightEnrollment.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **getSmallAndLightFeePreview** +> \Swagger\Client\Models\SmallAndLightFeePreviews getSmallAndLightFeePreview($body) + + + +Returns the Small and Light fee estimates for the specified items. You must include a marketplaceId parameter to retrieve the proper fee estimates for items to be sold in that marketplace. The ordering of items in the response will mirror the order of the items in the request. Duplicate ASIN/price combinations are removed. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 3 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\SmallAndLightApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$body = new \Swagger\Client\Models\SmallAndLightFeePreviewRequest(); // \Swagger\Client\Models\SmallAndLightFeePreviewRequest | + +try { + $result = $apiInstance->getSmallAndLightFeePreview($body); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling SmallAndLightApi->getSmallAndLightFeePreview: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**\Swagger\Client\Models\SmallAndLightFeePreviewRequest**](../Model/SmallAndLightFeePreviewRequest.md)| | + +### Return type + +[**\Swagger\Client\Models\SmallAndLightFeePreviews**](../Model/SmallAndLightFeePreviews.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **putSmallAndLightEnrollmentBySellerSKU** +> \Swagger\Client\Models\SmallAndLightEnrollment putSmallAndLightEnrollmentBySellerSKU($seller_sku, $marketplace_ids) + + + +Enrolls the item indicated by the specified seller SKU in the Small and Light program in the specified marketplace. If the item is not eligible, the ineligibility reasons are returned. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 5 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\SmallAndLightApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$seller_sku = "seller_sku_example"; // string | The seller SKU that identifies the item. +$marketplace_ids = array("marketplace_ids_example"); // string[] | The marketplace in which to enroll the item. Note: Accepts a single marketplace only. + +try { + $result = $apiInstance->putSmallAndLightEnrollmentBySellerSKU($seller_sku, $marketplace_ids); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling SmallAndLightApi->putSmallAndLightEnrollmentBySellerSKU: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **seller_sku** | **string**| The seller SKU that identifies the item. | + **marketplace_ids** | [**string[]**](../Model/string.md)| The marketplace in which to enroll the item. Note: Accepts a single marketplace only. | + +### Return type + +[**\Swagger\Client\Models\SmallAndLightEnrollment**](../Model/SmallAndLightEnrollment.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + diff --git a/SolicitationsApi.md b/SolicitationsApi.md new file mode 100644 index 00000000..cd6b1d0a --- /dev/null +++ b/SolicitationsApi.md @@ -0,0 +1,125 @@ +# Swagger\Client\SolicitationsApi + +All URIs are relative to *https://sellingpartnerapi-na.amazon.com/* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createProductReviewAndSellerFeedbackSolicitation**](SolicitationsApi.md#createproductreviewandsellerfeedbacksolicitation) | **POST** /solicitations/v1/orders/{amazonOrderId}/solicitations/productReviewAndSellerFeedback | +[**getSolicitationActionsForOrder**](SolicitationsApi.md#getsolicitationactionsfororder) | **GET** /solicitations/v1/orders/{amazonOrderId} | + +# **createProductReviewAndSellerFeedbackSolicitation** +> \Swagger\Client\Models\CreateProductReviewAndSellerFeedbackSolicitationResponse createProductReviewAndSellerFeedbackSolicitation($amazon_order_id, $marketplace_ids) + + + +Sends a solicitation to a buyer asking for seller feedback and a product review for the specified order. Send only one productReviewAndSellerFeedback or free form proactive message per order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.1 | 5 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\SolicitationsApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$amazon_order_id = "amazon_order_id_example"; // string | An Amazon order identifier. This specifies the order for which a solicitation is sent. +$marketplace_ids = array("marketplace_ids_example"); // string[] | A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. + +try { + $result = $apiInstance->createProductReviewAndSellerFeedbackSolicitation($amazon_order_id, $marketplace_ids); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling SolicitationsApi->createProductReviewAndSellerFeedbackSolicitation: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **amazon_order_id** | **string**| An Amazon order identifier. This specifies the order for which a solicitation is sent. | + **marketplace_ids** | [**string[]**](../Model/string.md)| A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. | + +### Return type + +[**\Swagger\Client\Models\CreateProductReviewAndSellerFeedbackSolicitationResponse**](../Model/CreateProductReviewAndSellerFeedbackSolicitationResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/hal+json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **getSolicitationActionsForOrder** +> \Swagger\Client\Models\GetSolicitationActionsForOrderResponse getSolicitationActionsForOrder($amazon_order_id, $marketplace_ids) + + + +Returns a list of solicitation types that are available for an order that you specify. A solicitation type is represented by an actions object, which contains a path and query parameter(s). You can use the path and parameter(s) to call an operation that sends a solicitation. Currently only the productReviewAndSellerFeedbackSolicitation solicitation type is available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.1 | 5 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + +### Example +```php +setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + +$apiInstance = new Swagger\Client\Api\SolicitationsApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$amazon_order_id = "amazon_order_id_example"; // string | An Amazon order identifier. This specifies the order for which you want a list of available solicitation types. +$marketplace_ids = array("marketplace_ids_example"); // string[] | A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. + +try { + $result = $apiInstance->getSolicitationActionsForOrder($amazon_order_id, $marketplace_ids); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling SolicitationsApi->getSolicitationActionsForOrder: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **amazon_order_id** | **string**| An Amazon order identifier. This specifies the order for which you want a list of available solicitation types. | + **marketplace_ids** | [**string[]**](../Model/string.md)| A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. | + +### Return type + +[**\Swagger\Client\Models\GetSolicitationActionsForOrderResponse**](../Model/GetSolicitationActionsForOrderResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/hal+json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + From 1106893f817edc3ec8661eb1f9cb12d9996b3ba5 Mon Sep 17 00:00:00 2001 From: rodrigojob Date: Sat, 21 Nov 2020 16:37:23 -0300 Subject: [PATCH 03/25] Delete CatalogApi.md --- CatalogApi.md | 197 -------------------------------------------------- 1 file changed, 197 deletions(-) delete mode 100644 CatalogApi.md diff --git a/CatalogApi.md b/CatalogApi.md deleted file mode 100644 index 10fe8b6b..00000000 --- a/CatalogApi.md +++ /dev/null @@ -1,197 +0,0 @@ -# Swagger\Client\CatalogApi - -All URIs are relative to *https://sellingpartnerapi-na.amazon.com/* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getCatalogItem**](CatalogApi.md#getcatalogitem) | **GET** /catalog/v0/items/{asin} | -[**listCatalogCategories**](CatalogApi.md#listcatalogcategories) | **GET** /catalog/v0/categories | -[**listCatalogItems**](CatalogApi.md#listcatalogitems) | **GET** /catalog/v0/items | - -# **getCatalogItem** -> \Swagger\Client\Models\GetCatalogItemResponse getCatalogItem($marketplace_id, $asin) - - -Returns a specified item and its attributes. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\CatalogApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$marketplace_id = "marketplace_id_example"; // string | A marketplace identifier. Specifies the marketplace for the item. -$asin = "asin_example"; // string | The Amazon Standard Identification Number (ASIN) of the item. - -try { - $result = $apiInstance->getCatalogItem($marketplace_id, $asin); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling CatalogApi->getCatalogItem: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **marketplace_id** | **string**| A marketplace identifier. Specifies the marketplace for the item. | - **asin** | **string**| The Amazon Standard Identification Number (ASIN) of the item. | - -### Return type - -[**\Swagger\Client\Models\GetCatalogItemResponse**](../Model/GetCatalogItemResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **listCatalogCategories** -> \Swagger\Client\Models\ListCatalogCategoriesResponse listCatalogCategories($marketplace_id, $asin, $seller_sku) - - - -Returns the parent categories to which an item belongs, based on the specified ASIN or SellerSKU. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\CatalogApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$marketplace_id = "marketplace_id_example"; // string | A marketplace identifier. Specifies the marketplace for the item. -$asin = "asin_example"; // string | The Amazon Standard Identification Number (ASIN) of the item. -$seller_sku = "seller_sku_example"; // string | Used to identify items in the given marketplace. SellerSKU is qualified by the seller's SellerId, which is included with every operation that you submit. - -try { - $result = $apiInstance->listCatalogCategories($marketplace_id, $asin, $seller_sku); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling CatalogApi->listCatalogCategories: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **marketplace_id** | **string**| A marketplace identifier. Specifies the marketplace for the item. | - **asin** | **string**| The Amazon Standard Identification Number (ASIN) of the item. | [optional] - **seller_sku** | **string**| Used to identify items in the given marketplace. SellerSKU is qualified by the seller's SellerId, which is included with every operation that you submit. | [optional] - -### Return type - -[**\Swagger\Client\Models\ListCatalogCategoriesResponse**](../Model/ListCatalogCategoriesResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **listCatalogItems** -> \Swagger\Client\Models\ListCatalogItemsResponse listCatalogItems($marketplace_id, $query, $query_context_id, $seller_sku, $upc, $ean, $isbn, $jan) - - - -Returns a list of items and their attributes, based on a search query or item identifiers that you specify. When based on a search query, provide the Query parameter and optionally, the QueryContextId parameter. When based on item identifiers, provide a single appropriate parameter based on the identifier type, and specify the associated item value. MarketplaceId is always required. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\CatalogApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$marketplace_id = "marketplace_id_example"; // string | A marketplace identifier. Specifies the marketplace for which items are returned. -$query = "query_example"; // string | Keyword(s) to use to search for items in the catalog. Example: 'harry potter books'. -$query_context_id = "query_context_id_example"; // string | An identifier for the context within which the given search will be performed. A marketplace might provide mechanisms for constraining a search to a subset of potential items. For example, the retail marketplace allows queries to be constrained to a specific category. The QueryContextId parameter specifies such a subset. If it is omitted, the search will be performed using the default context for the marketplace, which will typically contain the largest set of items. -$seller_sku = "seller_sku_example"; // string | Used to identify an item in the given marketplace. SellerSKU is qualified by the seller's SellerId, which is included with every operation that you submit. -$upc = "upc_example"; // string | A 12-digit bar code used for retail packaging. -$ean = "ean_example"; // string | A European article number that uniquely identifies the catalog item, manufacturer, and its attributes. -$isbn = "isbn_example"; // string | The unique commercial book identifier used to identify books internationally. -$jan = "jan_example"; // string | A Japanese article number that uniquely identifies the product, manufacturer, and its attributes. - -try { - $result = $apiInstance->listCatalogItems($marketplace_id, $query, $query_context_id, $seller_sku, $upc, $ean, $isbn, $jan); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling CatalogApi->listCatalogItems: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **marketplace_id** | **string**| A marketplace identifier. Specifies the marketplace for which items are returned. | - **query** | **string**| Keyword(s) to use to search for items in the catalog. Example: 'harry potter books'. | [optional] - **query_context_id** | **string**| An identifier for the context within which the given search will be performed. A marketplace might provide mechanisms for constraining a search to a subset of potential items. For example, the retail marketplace allows queries to be constrained to a specific category. The QueryContextId parameter specifies such a subset. If it is omitted, the search will be performed using the default context for the marketplace, which will typically contain the largest set of items. | [optional] - **seller_sku** | **string**| Used to identify an item in the given marketplace. SellerSKU is qualified by the seller's SellerId, which is included with every operation that you submit. | [optional] - **upc** | **string**| A 12-digit bar code used for retail packaging. | [optional] - **ean** | **string**| A European article number that uniquely identifies the catalog item, manufacturer, and its attributes. | [optional] - **isbn** | **string**| The unique commercial book identifier used to identify books internationally. | [optional] - **jan** | **string**| A Japanese article number that uniquely identifies the product, manufacturer, and its attributes. | [optional] - -### Return type - -[**\Swagger\Client\Models\ListCatalogItemsResponse**](../Model/ListCatalogItemsResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - From d515b00f94902202240c45a6f4e0d6f7e6a44f1f Mon Sep 17 00:00:00 2001 From: rodrigojob Date: Sat, 21 Nov 2020 16:37:43 -0300 Subject: [PATCH 04/25] Delete DefaultApi.md --- DefaultApi.md | 255 -------------------------------------------------- 1 file changed, 255 deletions(-) delete mode 100644 DefaultApi.md diff --git a/DefaultApi.md b/DefaultApi.md deleted file mode 100644 index 6d33fbf3..00000000 --- a/DefaultApi.md +++ /dev/null @@ -1,255 +0,0 @@ -# Swagger\Client\DefaultApi - -All URIs are relative to *https://sellingpartnerapi-na.amazon.com/* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**listFinancialEventGroups**](DefaultApi.md#listfinancialeventgroups) | **GET** /finances/v0/financialEventGroups | -[**listFinancialEvents**](DefaultApi.md#listfinancialevents) | **GET** /finances/v0/financialEvents | -[**listFinancialEventsByGroupId**](DefaultApi.md#listfinancialeventsbygroupid) | **GET** /finances/v0/financialEventGroups/{eventGroupId}/financialEvents | -[**listFinancialEventsByOrderId**](DefaultApi.md#listfinancialeventsbyorderid) | **GET** /finances/v0/orders/{orderId}/financialEvents | - -# **listFinancialEventGroups** -> \Swagger\Client\Models\ListFinancialEventGroupsResponse listFinancialEventGroups($max_results_per_page, $financial_event_group_started_before, $financial_event_group_started_after, $next_token) - - - -Returns financial event groups for a given date range. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\DefaultApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$max_results_per_page = 100; // int | The maximum number of results to return per page. -$financial_event_group_started_before = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | A date used for selecting financial event groups that opened before (but not at) a specified date and time, in ISO 8601 format. The date-time must be later than FinancialEventGroupStartedAfter and no later than two minutes before the request was submitted. If FinancialEventGroupStartedAfter and FinancialEventGroupStartedBefore are more than 180 days apart, no financial event groups are returned. -$financial_event_group_started_after = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | A date used for selecting financial event groups that opened after (or at) a specified date and time, in ISO 8601 format. The date-time must be no later than two minutes before the request was submitted. -$next_token = "next_token_example"; // string | A string token returned in the response of your previous request. - -try { - $result = $apiInstance->listFinancialEventGroups($max_results_per_page, $financial_event_group_started_before, $financial_event_group_started_after, $next_token); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling DefaultApi->listFinancialEventGroups: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **max_results_per_page** | **int**| The maximum number of results to return per page. | [optional] [default to 100] - **financial_event_group_started_before** | **\DateTime**| A date used for selecting financial event groups that opened before (but not at) a specified date and time, in ISO 8601 format. The date-time must be later than FinancialEventGroupStartedAfter and no later than two minutes before the request was submitted. If FinancialEventGroupStartedAfter and FinancialEventGroupStartedBefore are more than 180 days apart, no financial event groups are returned. | [optional] - **financial_event_group_started_after** | **\DateTime**| A date used for selecting financial event groups that opened after (or at) a specified date and time, in ISO 8601 format. The date-time must be no later than two minutes before the request was submitted. | [optional] - **next_token** | **string**| A string token returned in the response of your previous request. | [optional] - -### Return type - -[**\Swagger\Client\Models\ListFinancialEventGroupsResponse**](../Model/ListFinancialEventGroupsResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **listFinancialEvents** -> \Swagger\Client\Models\ListFinancialEventsResponse listFinancialEvents($max_results_per_page, $posted_after, $posted_before, $next_token) - - - -Returns financial events for the specified data range. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\DefaultApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$max_results_per_page = 100; // int | The maximum number of results to return per page. -$posted_after = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | A date used for selecting financial events posted after (or at) a specified time. The date-time must be no later than two minutes before the request was submitted, in ISO 8601 date time format. -$posted_before = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | A date used for selecting financial events posted before (but not at) a specified time. The date-time must be later than PostedAfter and no later than two minutes before the request was submitted, in ISO 8601 date time format. If PostedAfter and PostedBefore are more than 180 days apart, no financial events are returned. You must specify the PostedAfter parameter if you specify the PostedBefore parameter. Default: Now minus two minutes. -$next_token = "next_token_example"; // string | A string token returned in the response of your previous request. - -try { - $result = $apiInstance->listFinancialEvents($max_results_per_page, $posted_after, $posted_before, $next_token); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling DefaultApi->listFinancialEvents: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **max_results_per_page** | **int**| The maximum number of results to return per page. | [optional] [default to 100] - **posted_after** | **\DateTime**| A date used for selecting financial events posted after (or at) a specified time. The date-time must be no later than two minutes before the request was submitted, in ISO 8601 date time format. | [optional] - **posted_before** | **\DateTime**| A date used for selecting financial events posted before (but not at) a specified time. The date-time must be later than PostedAfter and no later than two minutes before the request was submitted, in ISO 8601 date time format. If PostedAfter and PostedBefore are more than 180 days apart, no financial events are returned. You must specify the PostedAfter parameter if you specify the PostedBefore parameter. Default: Now minus two minutes. | [optional] - **next_token** | **string**| A string token returned in the response of your previous request. | [optional] - -### Return type - -[**\Swagger\Client\Models\ListFinancialEventsResponse**](../Model/ListFinancialEventsResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **listFinancialEventsByGroupId** -> \Swagger\Client\Models\ListFinancialEventsResponse listFinancialEventsByGroupId($event_group_id, $max_results_per_page, $next_token) - - - -Returns all financial events for the specified financial event group. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\DefaultApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$event_group_id = "event_group_id_example"; // string | The identifier of the financial event group to which the events belong. -$max_results_per_page = 100; // int | The maximum number of results to return per page. -$next_token = "next_token_example"; // string | A string token returned in the response of your previous request. - -try { - $result = $apiInstance->listFinancialEventsByGroupId($event_group_id, $max_results_per_page, $next_token); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling DefaultApi->listFinancialEventsByGroupId: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **event_group_id** | **string**| The identifier of the financial event group to which the events belong. | - **max_results_per_page** | **int**| The maximum number of results to return per page. | [optional] [default to 100] - **next_token** | **string**| A string token returned in the response of your previous request. | [optional] - -### Return type - -[**\Swagger\Client\Models\ListFinancialEventsResponse**](../Model/ListFinancialEventsResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **listFinancialEventsByOrderId** -> \Swagger\Client\Models\ListFinancialEventsResponse listFinancialEventsByOrderId($order_id, $max_results_per_page, $next_token) - - - -Returns all financial events for the specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\DefaultApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$order_id = "order_id_example"; // string | An Amazon-defined order identifier, in 3-7-7 format. -$max_results_per_page = 100; // int | The maximum number of results to return per page. -$next_token = "next_token_example"; // string | A string token returned in the response of your previous request. - -try { - $result = $apiInstance->listFinancialEventsByOrderId($order_id, $max_results_per_page, $next_token); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling DefaultApi->listFinancialEventsByOrderId: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **order_id** | **string**| An Amazon-defined order identifier, in 3-7-7 format. | - **max_results_per_page** | **int**| The maximum number of results to return per page. | [optional] [default to 100] - **next_token** | **string**| A string token returned in the response of your previous request. | [optional] - -### Return type - -[**\Swagger\Client\Models\ListFinancialEventsResponse**](../Model/ListFinancialEventsResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - From b21404ff6bc7ac792bd4dfef7e0191ad3e124402 Mon Sep 17 00:00:00 2001 From: rodrigojob Date: Sat, 21 Nov 2020 16:37:59 -0300 Subject: [PATCH 05/25] Delete FbaInboundApi.md --- FbaInboundApi.md | 1028 ---------------------------------------------- 1 file changed, 1028 deletions(-) delete mode 100644 FbaInboundApi.md diff --git a/FbaInboundApi.md b/FbaInboundApi.md deleted file mode 100644 index bd3fe92c..00000000 --- a/FbaInboundApi.md +++ /dev/null @@ -1,1028 +0,0 @@ -# Swagger\Client\FbaInboundApi - -All URIs are relative to *https://sellingpartnerapi-na.amazon.com/* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**confirmPreorder**](FbaInboundApi.md#confirmpreorder) | **PUT** /fba/inbound/v0/shipments/{shipmentId}/preorder/confirm | -[**confirmTransport**](FbaInboundApi.md#confirmtransport) | **POST** /fba/inbound/v0/shipments/{shipmentId}/transport/confirm | -[**createInboundShipment**](FbaInboundApi.md#createinboundshipment) | **POST** /fba/inbound/v0/shipments/{shipmentId} | -[**createInboundShipmentPlan**](FbaInboundApi.md#createinboundshipmentplan) | **POST** /fba/inbound/v0/plans | -[**estimateTransport**](FbaInboundApi.md#estimatetransport) | **POST** /fba/inbound/v0/shipments/{shipmentId}/transport/estimate | -[**getBillOfLading**](FbaInboundApi.md#getbilloflading) | **GET** /fba/inbound/v0/shipments/{shipmentId}/billOfLading | -[**getInboundGuidance**](FbaInboundApi.md#getinboundguidance) | **GET** /fba/inbound/v0/itemsGuidance | -[**getLabels**](FbaInboundApi.md#getlabels) | **GET** /fba/inbound/v0/shipments/{shipmentId}/labels | -[**getPreorderInfo**](FbaInboundApi.md#getpreorderinfo) | **GET** /fba/inbound/v0/shipments/{shipmentId}/preorder | -[**getPrepInstructions**](FbaInboundApi.md#getprepinstructions) | **GET** /fba/inbound/v0/prepInstructions | -[**getShipmentItems**](FbaInboundApi.md#getshipmentitems) | **GET** /fba/inbound/v0/shipmentItems | -[**getShipmentItemsByShipmentId**](FbaInboundApi.md#getshipmentitemsbyshipmentid) | **GET** /fba/inbound/v0/shipments/{shipmentId}/items | -[**getShipments**](FbaInboundApi.md#getshipments) | **GET** /fba/inbound/v0/shipments | -[**getTransportDetails**](FbaInboundApi.md#gettransportdetails) | **GET** /fba/inbound/v0/shipments/{shipmentId}/transport | -[**putTransportDetails**](FbaInboundApi.md#puttransportdetails) | **PUT** /fba/inbound/v0/shipments/{shipmentId}/transport | -[**updateInboundShipment**](FbaInboundApi.md#updateinboundshipment) | **PUT** /fba/inbound/v0/shipments/{shipmentId} | -[**voidTransport**](FbaInboundApi.md#voidtransport) | **POST** /fba/inbound/v0/shipments/{shipmentId}/transport/void | - -# **confirmPreorder** -> \Swagger\Client\Models\ConfirmPreorderResponse confirmPreorder($shipment_id, $need_by_date, $marketplace_id) - - - -Returns information needed to confirm a shipment for pre-order. Call this operation after calling the getPreorderInfo operation to get the NeedByDate value and other pre-order information about the shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\FbaInboundApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$shipment_id = "shipment_id_example"; // string | A shipment identifier originally returned by the createInboundShipmentPlan operation. -$need_by_date = new \DateTime("2013-10-20"); // \DateTime | Date that the shipment must arrive at the Amazon fulfillment center to avoid delivery promise breaks for pre-ordered items. Must be in YYYY-MM-DD format. The response to the getPreorderInfo operation returns this value. -$marketplace_id = "marketplace_id_example"; // string | A marketplace identifier. Specifies the marketplace the shipment is tied to. - -try { - $result = $apiInstance->confirmPreorder($shipment_id, $need_by_date, $marketplace_id); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling FbaInboundApi->confirmPreorder: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **shipment_id** | **string**| A shipment identifier originally returned by the createInboundShipmentPlan operation. | - **need_by_date** | **\DateTime**| Date that the shipment must arrive at the Amazon fulfillment center to avoid delivery promise breaks for pre-ordered items. Must be in YYYY-MM-DD format. The response to the getPreorderInfo operation returns this value. | - **marketplace_id** | **string**| A marketplace identifier. Specifies the marketplace the shipment is tied to. | - -### Return type - -[**\Swagger\Client\Models\ConfirmPreorderResponse**](../Model/ConfirmPreorderResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **confirmTransport** -> \Swagger\Client\Models\ConfirmTransportResponse confirmTransport($shipment_id) - - - -Confirms that the seller accepts the Amazon-partnered shipping estimate, agrees to allow Amazon to charge their account for the shipping cost, and requests that the Amazon-partnered carrier ship the inbound shipment. Prior to calling the confirmTransport operation, you should call the getTransportDetails operation to get the Amazon-partnered shipping estimate. Important: After confirming the transportation request, if the seller decides that they do not want the Amazon-partnered carrier to ship the inbound shipment, you can call the voidTransport operation to cancel the transportation request. Note that for a Small Parcel shipment, the seller has 24 hours after confirming a transportation request to void the transportation request. For a Less Than Truckload/Full Truckload (LTL/FTL) shipment, the seller has one hour after confirming a transportation request to void it. After the grace period has expired the seller's account will be charged for the shipping cost. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\FbaInboundApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$shipment_id = "shipment_id_example"; // string | A shipment identifier originally returned by the createInboundShipmentPlan operation. - -try { - $result = $apiInstance->confirmTransport($shipment_id); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling FbaInboundApi->confirmTransport: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **shipment_id** | **string**| A shipment identifier originally returned by the createInboundShipmentPlan operation. | - -### Return type - -[**\Swagger\Client\Models\ConfirmTransportResponse**](../Model/ConfirmTransportResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **createInboundShipment** -> \Swagger\Client\Models\InboundShipmentResponse createInboundShipment($body, $shipment_id) - - - -Returns a new inbound shipment based on the specified shipmentId that was returned by the createInboundShipmentPlan operation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\FbaInboundApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$body = new \Swagger\Client\Models\InboundShipmentRequest(); // \Swagger\Client\Models\InboundShipmentRequest | -$shipment_id = "shipment_id_example"; // string | A shipment identifier originally returned by the createInboundShipmentPlan operation. - -try { - $result = $apiInstance->createInboundShipment($body, $shipment_id); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling FbaInboundApi->createInboundShipment: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | [**\Swagger\Client\Models\InboundShipmentRequest**](../Model/InboundShipmentRequest.md)| | - **shipment_id** | **string**| A shipment identifier originally returned by the createInboundShipmentPlan operation. | - -### Return type - -[**\Swagger\Client\Models\InboundShipmentResponse**](../Model/InboundShipmentResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **createInboundShipmentPlan** -> \Swagger\Client\Models\CreateInboundShipmentPlanResponse createInboundShipmentPlan($body) - - - -Returns one or more inbound shipment plans, which provide the information you need to create one or more inbound shipments for a set of items that you specify. Multiple inbound shipment plans might be required so that items can be optimally placed in Amazon's fulfillment network—for example, positioning inventory closer to the customer. Alternatively, two inbound shipment plans might be created with the same Amazon fulfillment center destination if the two shipment plans require different processing—for example, items that require labels must be shipped separately from stickerless, commingled inventory. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\FbaInboundApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$body = new \Swagger\Client\Models\CreateInboundShipmentPlanRequest(); // \Swagger\Client\Models\CreateInboundShipmentPlanRequest | - -try { - $result = $apiInstance->createInboundShipmentPlan($body); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling FbaInboundApi->createInboundShipmentPlan: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | [**\Swagger\Client\Models\CreateInboundShipmentPlanRequest**](../Model/CreateInboundShipmentPlanRequest.md)| | - -### Return type - -[**\Swagger\Client\Models\CreateInboundShipmentPlanResponse**](../Model/CreateInboundShipmentPlanResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **estimateTransport** -> \Swagger\Client\Models\EstimateTransportResponse estimateTransport($shipment_id) - - - -Initiates the process of estimating the shipping cost for an inbound shipment by an Amazon-partnered carrier. Prior to calling the estimateTransport operation, you must call the putTransportDetails operation to provide Amazon with the transportation information for the inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\FbaInboundApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$shipment_id = "shipment_id_example"; // string | A shipment identifier originally returned by the createInboundShipmentPlan operation. - -try { - $result = $apiInstance->estimateTransport($shipment_id); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling FbaInboundApi->estimateTransport: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **shipment_id** | **string**| A shipment identifier originally returned by the createInboundShipmentPlan operation. | - -### Return type - -[**\Swagger\Client\Models\EstimateTransportResponse**](../Model/EstimateTransportResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **getBillOfLading** -> \Swagger\Client\Models\GetBillOfLadingResponse getBillOfLading($shipment_id) - - - -Returns a bill of lading for a Less Than Truckload/Full Truckload (LTL/FTL) shipment. The getBillOfLading operation returns PDF document data for printing a bill of lading for an Amazon-partnered Less Than Truckload/Full Truckload (LTL/FTL) inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\FbaInboundApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$shipment_id = "shipment_id_example"; // string | A shipment identifier originally returned by the createInboundShipmentPlan operation. - -try { - $result = $apiInstance->getBillOfLading($shipment_id); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling FbaInboundApi->getBillOfLading: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **shipment_id** | **string**| A shipment identifier originally returned by the createInboundShipmentPlan operation. | - -### Return type - -[**\Swagger\Client\Models\GetBillOfLadingResponse**](../Model/GetBillOfLadingResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **getInboundGuidance** -> \Swagger\Client\Models\GetInboundGuidanceResponse getInboundGuidance($marketplace_id, $seller_sku_list, $asin_list) - - - -Returns information that lets a seller know if Amazon recommends sending an item to a given marketplace. In some cases, Amazon provides guidance for why a given SellerSKU or ASIN is not recommended for shipment to Amazon's fulfillment network. Sellers may still ship items that are not recommended, at their discretion. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\FbaInboundApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$marketplace_id = "marketplace_id_example"; // string | A marketplace identifier. Specifies the marketplace where the product would be stored. -$seller_sku_list = array("seller_sku_list_example"); // string[] | A list of SellerSKU values. Used to identify items for which you want inbound guidance for shipment to Amazon's fulfillment network. Note: SellerSKU is qualified by the SellerId, which is included with every Selling Partner API operation that you submit. If you specify a SellerSKU that identifies a variation parent ASIN, this operation returns an error. A variation parent ASIN represents a generic product that cannot be sold. Variation child ASINs represent products that have specific characteristics (such as size and color) and can be sold. -$asin_list = array("asin_list_example"); // string[] | A list of ASIN values. Used to identify items for which you want inbound guidance for shipment to Amazon's fulfillment network. Note: If you specify a ASIN that identifies a variation parent ASIN, this operation returns an error. A variation parent ASIN represents a generic product that cannot be sold. Variation child ASINs represent products that have specific characteristics (such as size and color) and can be sold. - -try { - $result = $apiInstance->getInboundGuidance($marketplace_id, $seller_sku_list, $asin_list); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling FbaInboundApi->getInboundGuidance: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **marketplace_id** | **string**| A marketplace identifier. Specifies the marketplace where the product would be stored. | - **seller_sku_list** | [**string[]**](../Model/string.md)| A list of SellerSKU values. Used to identify items for which you want inbound guidance for shipment to Amazon's fulfillment network. Note: SellerSKU is qualified by the SellerId, which is included with every Selling Partner API operation that you submit. If you specify a SellerSKU that identifies a variation parent ASIN, this operation returns an error. A variation parent ASIN represents a generic product that cannot be sold. Variation child ASINs represent products that have specific characteristics (such as size and color) and can be sold. | [optional] - **asin_list** | [**string[]**](../Model/string.md)| A list of ASIN values. Used to identify items for which you want inbound guidance for shipment to Amazon's fulfillment network. Note: If you specify a ASIN that identifies a variation parent ASIN, this operation returns an error. A variation parent ASIN represents a generic product that cannot be sold. Variation child ASINs represent products that have specific characteristics (such as size and color) and can be sold. | [optional] - -### Return type - -[**\Swagger\Client\Models\GetInboundGuidanceResponse**](../Model/GetInboundGuidanceResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **getLabels** -> \Swagger\Client\Models\GetLabelsResponse getLabels($shipment_id, $page_type, $label_type, $number_of_packages, $package_labels_to_print, $number_of_pallets) - - - -Returns package/pallet labels for faster and more accurate shipment processing at the Amazon fulfillment center. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\FbaInboundApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$shipment_id = "shipment_id_example"; // string | A shipment identifier originally returned by the createInboundShipmentPlan operation. -$page_type = "page_type_example"; // string | The page type to use to print the labels. Submitting a PageType value that is not supported in your marketplace returns an error. -$label_type = "label_type_example"; // string | The type of labels requested. -$number_of_packages = 56; // int | The number of packages in the shipment. -$package_labels_to_print = array("package_labels_to_print_example"); // string[] | A list of identifiers that specify packages for which you want package labels printed. Must match CartonId values previously passed using the FBA Inbound Shipment Carton Information Feed. If not, the operation returns the IncorrectPackageIdentifier error code. -$number_of_pallets = 56; // int | The number of pallets in the shipment. This returns four identical labels for each pallet. - -try { - $result = $apiInstance->getLabels($shipment_id, $page_type, $label_type, $number_of_packages, $package_labels_to_print, $number_of_pallets); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling FbaInboundApi->getLabels: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **shipment_id** | **string**| A shipment identifier originally returned by the createInboundShipmentPlan operation. | - **page_type** | **string**| The page type to use to print the labels. Submitting a PageType value that is not supported in your marketplace returns an error. | - **label_type** | **string**| The type of labels requested. | - **number_of_packages** | **int**| The number of packages in the shipment. | [optional] - **package_labels_to_print** | [**string[]**](../Model/string.md)| A list of identifiers that specify packages for which you want package labels printed. Must match CartonId values previously passed using the FBA Inbound Shipment Carton Information Feed. If not, the operation returns the IncorrectPackageIdentifier error code. | [optional] - **number_of_pallets** | **int**| The number of pallets in the shipment. This returns four identical labels for each pallet. | [optional] - -### Return type - -[**\Swagger\Client\Models\GetLabelsResponse**](../Model/GetLabelsResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **getPreorderInfo** -> \Swagger\Client\Models\GetPreorderInfoResponse getPreorderInfo($shipment_id, $marketplace_id) - - - -Returns pre-order information, including dates, that a seller needs before confirming a shipment for pre-order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\FbaInboundApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$shipment_id = "shipment_id_example"; // string | A shipment identifier originally returned by the createInboundShipmentPlan operation. -$marketplace_id = "marketplace_id_example"; // string | A marketplace identifier. Specifies the marketplace the shipment is tied to. - -try { - $result = $apiInstance->getPreorderInfo($shipment_id, $marketplace_id); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling FbaInboundApi->getPreorderInfo: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **shipment_id** | **string**| A shipment identifier originally returned by the createInboundShipmentPlan operation. | - **marketplace_id** | **string**| A marketplace identifier. Specifies the marketplace the shipment is tied to. | - -### Return type - -[**\Swagger\Client\Models\GetPreorderInfoResponse**](../Model/GetPreorderInfoResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **getPrepInstructions** -> \Swagger\Client\Models\GetPrepInstructionsResponse getPrepInstructions($ship_to_country_code, $seller_sku_list, $asin_list) - - - -Returns labeling requirements and item preparation instructions to help prepare items for shipment to Amazon's fulfillment network. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\FbaInboundApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$ship_to_country_code = "ship_to_country_code_example"; // string | The country code of the country to which the items will be shipped. Note that labeling requirements and item preparation instructions can vary by country. -$seller_sku_list = array("seller_sku_list_example"); // string[] | A list of SellerSKU values. Used to identify items for which you want labeling requirements and item preparation instructions for shipment to Amazon's fulfillment network. The SellerSKU is qualified by the Seller ID, which is included with every call to the Seller Partner API. Note: Include seller SKUs that you have used to list items on Amazon's retail website. If you include a seller SKU that you have never used to list an item on Amazon's retail website, the seller SKU is returned in the InvalidSKUList property in the response. -$asin_list = array("asin_list_example"); // string[] | A list of ASIN values. Used to identify items for which you want item preparation instructions to help with item sourcing decisions. Note: ASINs must be included in the product catalog for at least one of the marketplaces that the seller participates in. Any ASIN that is not included in the product catalog for at least one of the marketplaces that the seller participates in is returned in the InvalidASINList property in the response. You can find out which marketplaces a seller participates in by calling the getMarketplaceParticipations operation in the Selling Partner API for Sellers. - -try { - $result = $apiInstance->getPrepInstructions($ship_to_country_code, $seller_sku_list, $asin_list); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling FbaInboundApi->getPrepInstructions: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **ship_to_country_code** | **string**| The country code of the country to which the items will be shipped. Note that labeling requirements and item preparation instructions can vary by country. | - **seller_sku_list** | [**string[]**](../Model/string.md)| A list of SellerSKU values. Used to identify items for which you want labeling requirements and item preparation instructions for shipment to Amazon's fulfillment network. The SellerSKU is qualified by the Seller ID, which is included with every call to the Seller Partner API. Note: Include seller SKUs that you have used to list items on Amazon's retail website. If you include a seller SKU that you have never used to list an item on Amazon's retail website, the seller SKU is returned in the InvalidSKUList property in the response. | [optional] - **asin_list** | [**string[]**](../Model/string.md)| A list of ASIN values. Used to identify items for which you want item preparation instructions to help with item sourcing decisions. Note: ASINs must be included in the product catalog for at least one of the marketplaces that the seller participates in. Any ASIN that is not included in the product catalog for at least one of the marketplaces that the seller participates in is returned in the InvalidASINList property in the response. You can find out which marketplaces a seller participates in by calling the getMarketplaceParticipations operation in the Selling Partner API for Sellers. | [optional] - -### Return type - -[**\Swagger\Client\Models\GetPrepInstructionsResponse**](../Model/GetPrepInstructionsResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **getShipmentItems** -> \Swagger\Client\Models\GetShipmentItemsResponse getShipmentItems($query_type, $marketplace_id, $last_updated_after, $last_updated_before, $next_token) - - - -Returns a list of items in a specified inbound shipment, or a list of items that were updated within a specified time frame. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\FbaInboundApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$query_type = "query_type_example"; // string | Indicates whether items are returned using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or using NextToken, which continues returning items specified in a previous request. -$marketplace_id = "marketplace_id_example"; // string | A marketplace identifier. Specifies the marketplace where the product would be stored. -$last_updated_after = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | A date used for selecting inbound shipment items that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller. -$last_updated_before = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | A date used for selecting inbound shipment items that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller. -$next_token = "next_token_example"; // string | A string token returned in the response to your previous request. - -try { - $result = $apiInstance->getShipmentItems($query_type, $marketplace_id, $last_updated_after, $last_updated_before, $next_token); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling FbaInboundApi->getShipmentItems: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **query_type** | **string**| Indicates whether items are returned using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or using NextToken, which continues returning items specified in a previous request. | - **marketplace_id** | **string**| A marketplace identifier. Specifies the marketplace where the product would be stored. | - **last_updated_after** | **\DateTime**| A date used for selecting inbound shipment items that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller. | [optional] - **last_updated_before** | **\DateTime**| A date used for selecting inbound shipment items that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller. | [optional] - **next_token** | **string**| A string token returned in the response to your previous request. | [optional] - -### Return type - -[**\Swagger\Client\Models\GetShipmentItemsResponse**](../Model/GetShipmentItemsResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **getShipmentItemsByShipmentId** -> \Swagger\Client\Models\GetShipmentItemsResponse getShipmentItemsByShipmentId($shipment_id, $marketplace_id) - - - -Returns a list of items in a specified inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\FbaInboundApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$shipment_id = "shipment_id_example"; // string | A shipment identifier used for selecting items in a specific inbound shipment. -$marketplace_id = "marketplace_id_example"; // string | A marketplace identifier. Specifies the marketplace where the product would be stored. - -try { - $result = $apiInstance->getShipmentItemsByShipmentId($shipment_id, $marketplace_id); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling FbaInboundApi->getShipmentItemsByShipmentId: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **shipment_id** | **string**| A shipment identifier used for selecting items in a specific inbound shipment. | - **marketplace_id** | **string**| A marketplace identifier. Specifies the marketplace where the product would be stored. | - -### Return type - -[**\Swagger\Client\Models\GetShipmentItemsResponse**](../Model/GetShipmentItemsResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **getShipments** -> \Swagger\Client\Models\GetShipmentsResponse getShipments($query_type, $marketplace_id, $shipment_status_list, $shipment_id_list, $last_updated_after, $last_updated_before, $next_token) - - - -Returns a list of inbound shipments based on criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\FbaInboundApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$query_type = "query_type_example"; // string | Indicates whether shipments are returned using shipment information (by providing the ShipmentStatusList or ShipmentIdList parameters), using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or by using NextToken to continue returning items specified in a previous request. -$marketplace_id = "marketplace_id_example"; // string | A marketplace identifier. Specifies the marketplace where the product would be stored. -$shipment_status_list = array("shipment_status_list_example"); // string[] | A list of ShipmentStatus values. Used to select shipments with a current status that matches the status values that you specify. -$shipment_id_list = array("shipment_id_list_example"); // string[] | A list of shipment IDs used to select the shipments that you want. If both ShipmentStatusList and ShipmentIdList are specified, only shipments that match both parameters are returned. -$last_updated_after = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | A date used for selecting inbound shipments that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller. -$last_updated_before = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | A date used for selecting inbound shipments that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller. -$next_token = "next_token_example"; // string | A string token returned in the response to your previous request. - -try { - $result = $apiInstance->getShipments($query_type, $marketplace_id, $shipment_status_list, $shipment_id_list, $last_updated_after, $last_updated_before, $next_token); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling FbaInboundApi->getShipments: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **query_type** | **string**| Indicates whether shipments are returned using shipment information (by providing the ShipmentStatusList or ShipmentIdList parameters), using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or by using NextToken to continue returning items specified in a previous request. | - **marketplace_id** | **string**| A marketplace identifier. Specifies the marketplace where the product would be stored. | - **shipment_status_list** | [**string[]**](../Model/string.md)| A list of ShipmentStatus values. Used to select shipments with a current status that matches the status values that you specify. | [optional] - **shipment_id_list** | [**string[]**](../Model/string.md)| A list of shipment IDs used to select the shipments that you want. If both ShipmentStatusList and ShipmentIdList are specified, only shipments that match both parameters are returned. | [optional] - **last_updated_after** | **\DateTime**| A date used for selecting inbound shipments that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller. | [optional] - **last_updated_before** | **\DateTime**| A date used for selecting inbound shipments that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller. | [optional] - **next_token** | **string**| A string token returned in the response to your previous request. | [optional] - -### Return type - -[**\Swagger\Client\Models\GetShipmentsResponse**](../Model/GetShipmentsResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **getTransportDetails** -> \Swagger\Client\Models\GetTransportDetailsResponse getTransportDetails($shipment_id) - - - -Returns current transportation information about an inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\FbaInboundApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$shipment_id = "shipment_id_example"; // string | A shipment identifier originally returned by the createInboundShipmentPlan operation. - -try { - $result = $apiInstance->getTransportDetails($shipment_id); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling FbaInboundApi->getTransportDetails: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **shipment_id** | **string**| A shipment identifier originally returned by the createInboundShipmentPlan operation. | - -### Return type - -[**\Swagger\Client\Models\GetTransportDetailsResponse**](../Model/GetTransportDetailsResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **putTransportDetails** -> \Swagger\Client\Models\PutTransportDetailsResponse putTransportDetails($body, $shipment_id) - - - -Sends transportation information to Amazon about an inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\FbaInboundApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$body = new \Swagger\Client\Models\PutTransportDetailsRequest(); // \Swagger\Client\Models\PutTransportDetailsRequest | -$shipment_id = "shipment_id_example"; // string | A shipment identifier originally returned by the createInboundShipmentPlan operation. - -try { - $result = $apiInstance->putTransportDetails($body, $shipment_id); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling FbaInboundApi->putTransportDetails: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | [**\Swagger\Client\Models\PutTransportDetailsRequest**](../Model/PutTransportDetailsRequest.md)| | - **shipment_id** | **string**| A shipment identifier originally returned by the createInboundShipmentPlan operation. | - -### Return type - -[**\Swagger\Client\Models\PutTransportDetailsResponse**](../Model/PutTransportDetailsResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **updateInboundShipment** -> \Swagger\Client\Models\InboundShipmentResponse updateInboundShipment($body, $shipment_id) - - - -Adds, updates, or removes items from the inbound shipment identified by the specified shipment identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\FbaInboundApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$body = new \Swagger\Client\Models\InboundShipmentRequest(); // \Swagger\Client\Models\InboundShipmentRequest | -$shipment_id = "shipment_id_example"; // string | A shipment identifier originally returned by the createInboundShipmentPlan operation. - -try { - $result = $apiInstance->updateInboundShipment($body, $shipment_id); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling FbaInboundApi->updateInboundShipment: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | [**\Swagger\Client\Models\InboundShipmentRequest**](../Model/InboundShipmentRequest.md)| | - **shipment_id** | **string**| A shipment identifier originally returned by the createInboundShipmentPlan operation. | - -### Return type - -[**\Swagger\Client\Models\InboundShipmentResponse**](../Model/InboundShipmentResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **voidTransport** -> \Swagger\Client\Models\VoidTransportResponse voidTransport($shipment_id) - - - -Cancels a previously-confirmed request to ship an inbound shipment using an Amazon-partnered carrier. To be successful, you must call this operation before the VoidDeadline date that is returned by the getTransportDetails operation. Important: The VoidDeadline date is 24 hours after you confirm a Small Parcel shipment transportation request or one hour after you confirm a Less Than Truckload/Full Truckload (LTL/FTL) shipment transportation request. After the void deadline passes, your account will be charged for the shipping cost. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\FbaInboundApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$shipment_id = "shipment_id_example"; // string | A shipment identifier originally returned by the createInboundShipmentPlan operation. - -try { - $result = $apiInstance->voidTransport($shipment_id); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling FbaInboundApi->voidTransport: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **shipment_id** | **string**| A shipment identifier originally returned by the createInboundShipmentPlan operation. | - -### Return type - -[**\Swagger\Client\Models\VoidTransportResponse**](../Model/VoidTransportResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - From adebaa1fe9d70afde1297d2374525d4f1d873257 Mon Sep 17 00:00:00 2001 From: rodrigojob Date: Sat, 21 Nov 2020 16:38:20 -0300 Subject: [PATCH 06/25] Delete FbaInventoryApi.md --- FbaInventoryApi.md | 76 ---------------------------------------------- 1 file changed, 76 deletions(-) delete mode 100644 FbaInventoryApi.md diff --git a/FbaInventoryApi.md b/FbaInventoryApi.md deleted file mode 100644 index 1ffcbe70..00000000 --- a/FbaInventoryApi.md +++ /dev/null @@ -1,76 +0,0 @@ -# Swagger\Client\FbaInventoryApi - -All URIs are relative to *https://sellingpartnerapi-na.amazon.com/* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getInventorySummaries**](FbaInventoryApi.md#getinventorysummaries) | **GET** /fba/inventory/v1/summaries | - -# **getInventorySummaries** -> \Swagger\Client\Models\GetInventorySummariesResponse getInventorySummaries($granularity_type, $granularity_id, $marketplace_ids, $details, $start_date_time, $seller_skus, $next_token) - - - -Returns a list of inventory summaries. The summaries returned depend on the presence or absence of the startDateTime and sellerSkus parameters: - All inventory summaries with available details are returned when the startDateTime and sellerSkus parameters are omitted. - When startDateTime is provided, the operation returns inventory summaries that have had changes after the date and time specified. The sellerSkus parameter is ignored. - When the sellerSkus parameter is provided, the operation returns inventory summaries for only the specified sellerSkus. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 90 | 150 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\FbaInventoryApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$granularity_type = "granularity_type_example"; // string | The granularity type for the inventory aggregation level. -$granularity_id = "granularity_id_example"; // string | The granularity ID for the inventory aggregation level. -$marketplace_ids = array("marketplace_ids_example"); // string[] | The marketplace ID for the marketplace for which to return inventory summaries. -$details = false; // bool | true to return inventory summaries with additional summarized inventory details and quantities. Otherwise, returns inventory summaries only (default value). -$start_date_time = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | A start date and time in ISO8601 format. If specified, all inventory summaries that have changed since then are returned. You must specify a date and time that is no earlier than 18 months prior to the date and time when you call the API. Note: Changes in inboundWorkingQuantity, inboundShippedQuantity and inboundReceivingQuantity are not detected. -$seller_skus = array("seller_skus_example"); // string[] | A list of seller SKUs for which to return inventory summaries. You may specify up to 50 SKUs. -$next_token = "next_token_example"; // string | String token returned in the response of your previous request. - -try { - $result = $apiInstance->getInventorySummaries($granularity_type, $granularity_id, $marketplace_ids, $details, $start_date_time, $seller_skus, $next_token); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling FbaInventoryApi->getInventorySummaries: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **granularity_type** | **string**| The granularity type for the inventory aggregation level. | - **granularity_id** | **string**| The granularity ID for the inventory aggregation level. | - **marketplace_ids** | [**string[]**](../Model/string.md)| The marketplace ID for the marketplace for which to return inventory summaries. | - **details** | **bool**| true to return inventory summaries with additional summarized inventory details and quantities. Otherwise, returns inventory summaries only (default value). | [optional] [default to false] - **start_date_time** | **\DateTime**| A start date and time in ISO8601 format. If specified, all inventory summaries that have changed since then are returned. You must specify a date and time that is no earlier than 18 months prior to the date and time when you call the API. Note: Changes in inboundWorkingQuantity, inboundShippedQuantity and inboundReceivingQuantity are not detected. | [optional] - **seller_skus** | [**string[]**](../Model/string.md)| A list of seller SKUs for which to return inventory summaries. You may specify up to 50 SKUs. | [optional] - **next_token** | **string**| String token returned in the response of your previous request. | [optional] - -### Return type - -[**\Swagger\Client\Models\GetInventorySummariesResponse**](../Model/GetInventorySummariesResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - From 06b6ce044a5e0c9e783f6387e44a6d9d9884369e Mon Sep 17 00:00:00 2001 From: rodrigojob Date: Sat, 21 Nov 2020 16:38:31 -0300 Subject: [PATCH 07/25] Delete FbaOutboundApi.md --- FbaOutboundApi.md | 543 ---------------------------------------------- 1 file changed, 543 deletions(-) delete mode 100644 FbaOutboundApi.md diff --git a/FbaOutboundApi.md b/FbaOutboundApi.md deleted file mode 100644 index e9459e3a..00000000 --- a/FbaOutboundApi.md +++ /dev/null @@ -1,543 +0,0 @@ -# Swagger\Client\FbaOutboundApi - -All URIs are relative to *https://sellingpartnerapi-na.amazon.com/* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**cancelFulfillmentOrder**](FbaOutboundApi.md#cancelfulfillmentorder) | **PUT** /fba/outbound/v0/fulfillmentOrders/{sellerFulfillmentOrderId}/cancel | -[**createFulfillmentOrder**](FbaOutboundApi.md#createfulfillmentorder) | **POST** /fba/outbound/v0/fulfillmentOrders | -[**createFulfillmentReturn**](FbaOutboundApi.md#createfulfillmentreturn) | **PUT** /fba/outbound/v0/fulfillmentOrders/{sellerFulfillmentOrderId}/return | -[**getFulfillmentOrder**](FbaOutboundApi.md#getfulfillmentorder) | **GET** /fba/outbound/v0/fulfillmentOrders/{sellerFulfillmentOrderId} | -[**getFulfillmentPreview**](FbaOutboundApi.md#getfulfillmentpreview) | **POST** /fba/outbound/v0/fulfillmentOrders/preview | -[**getPackageTrackingDetails**](FbaOutboundApi.md#getpackagetrackingdetails) | **GET** /fba/outbound/v0/tracking | -[**listAllFulfillmentOrders**](FbaOutboundApi.md#listallfulfillmentorders) | **GET** /fba/outbound/v0/fulfillmentOrders | -[**listReturnReasonCodes**](FbaOutboundApi.md#listreturnreasoncodes) | **GET** /fba/outbound/v0/returnReasonCodes | -[**updateFulfillmentOrder**](FbaOutboundApi.md#updatefulfillmentorder) | **PUT** /fba/outbound/v0/fulfillmentOrders/{sellerFulfillmentOrderId} | - -# **cancelFulfillmentOrder** -> \Swagger\Client\Models\CancelFulfillmentOrderResponse cancelFulfillmentOrder($seller_fulfillment_order_id) - - - -Requests that Amazon stop attempting to fulfill the fulfillment order indicated by the specified order identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - - -$apiInstance = new Swagger\Client\Api\FbaOutboundApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$seller_fulfillment_order_id = "seller_fulfillment_order_id_example"; // string | The identifier assigned to the item by the seller when the fulfillment order was created. - -try { - $result = $apiInstance->cancelFulfillmentOrder($seller_fulfillment_order_id); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling FbaOutboundApi->cancelFulfillmentOrder: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **seller_fulfillment_order_id** | **string**| The identifier assigned to the item by the seller when the fulfillment order was created. | - -### Return type - -[**\Swagger\Client\Models\CancelFulfillmentOrderResponse**](../Model/CancelFulfillmentOrderResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **createFulfillmentOrder** -> \Swagger\Client\Models\CreateFulfillmentOrderResponse createFulfillmentOrder($body) - - - -Requests that Amazon ship items from the seller's inventory in Amazon's fulfillment network to a destination address. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - - -$apiInstance = new Swagger\Client\Api\FbaOutboundApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$body = new \Swagger\Client\Models\CreateFulfillmentOrderRequest(); // \Swagger\Client\Models\CreateFulfillmentOrderRequest | - -try { - $result = $apiInstance->createFulfillmentOrder($body); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling FbaOutboundApi->createFulfillmentOrder: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | [**\Swagger\Client\Models\CreateFulfillmentOrderRequest**](../Model/CreateFulfillmentOrderRequest.md)| | - -### Return type - -[**\Swagger\Client\Models\CreateFulfillmentOrderResponse**](../Model/CreateFulfillmentOrderResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **createFulfillmentReturn** -> \Swagger\Client\Models\CreateFulfillmentReturnResponse createFulfillmentReturn($body, $seller_fulfillment_order_id) - - - -Creates a fulfillment return. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - - -$apiInstance = new Swagger\Client\Api\FbaOutboundApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$body = new \Swagger\Client\Models\CreateFulfillmentReturnRequest(); // \Swagger\Client\Models\CreateFulfillmentReturnRequest | -$seller_fulfillment_order_id = "seller_fulfillment_order_id_example"; // string | An identifier assigned by the seller to the fulfillment order at the time it was created. The seller uses their own records to find the correct SellerFulfillmentOrderId value based on the buyer's request to return items. - -try { - $result = $apiInstance->createFulfillmentReturn($body, $seller_fulfillment_order_id); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling FbaOutboundApi->createFulfillmentReturn: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | [**\Swagger\Client\Models\CreateFulfillmentReturnRequest**](../Model/CreateFulfillmentReturnRequest.md)| | - **seller_fulfillment_order_id** | **string**| An identifier assigned by the seller to the fulfillment order at the time it was created. The seller uses their own records to find the correct SellerFulfillmentOrderId value based on the buyer's request to return items. | - -### Return type - -[**\Swagger\Client\Models\CreateFulfillmentReturnResponse**](../Model/CreateFulfillmentReturnResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **getFulfillmentOrder** -> \Swagger\Client\Models\GetFulfillmentOrderResponse getFulfillmentOrder($seller_fulfillment_order_id) - - - -Returns the fulfillment order indicated by the specified order identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - - -$apiInstance = new Swagger\Client\Api\FbaOutboundApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$seller_fulfillment_order_id = "seller_fulfillment_order_id_example"; // string | The identifier assigned to the item by the seller when the fulfillment order was created. - -try { - $result = $apiInstance->getFulfillmentOrder($seller_fulfillment_order_id); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling FbaOutboundApi->getFulfillmentOrder: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **seller_fulfillment_order_id** | **string**| The identifier assigned to the item by the seller when the fulfillment order was created. | - -### Return type - -[**\Swagger\Client\Models\GetFulfillmentOrderResponse**](../Model/GetFulfillmentOrderResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **getFulfillmentPreview** -> \Swagger\Client\Models\GetFulfillmentPreviewResponse getFulfillmentPreview($body) - - - -Returns a list of fulfillment order previews based on shipping criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - - -$apiInstance = new Swagger\Client\Api\FbaOutboundApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$body = new \Swagger\Client\Models\GetFulfillmentPreviewRequest(); // \Swagger\Client\Models\GetFulfillmentPreviewRequest | - -try { - $result = $apiInstance->getFulfillmentPreview($body); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling FbaOutboundApi->getFulfillmentPreview: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | [**\Swagger\Client\Models\GetFulfillmentPreviewRequest**](../Model/GetFulfillmentPreviewRequest.md)| | - -### Return type - -[**\Swagger\Client\Models\GetFulfillmentPreviewResponse**](../Model/GetFulfillmentPreviewResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **getPackageTrackingDetails** -> \Swagger\Client\Models\GetPackageTrackingDetailsResponse getPackageTrackingDetails($package_number) - - - -Returns delivery tracking information for a package in an outbound shipment for a Multi-Channel Fulfillment order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - - -$apiInstance = new Swagger\Client\Api\FbaOutboundApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$package_number = 56; // int | The unencrypted package identifier returned by the getFulfillmentOrder operation. - -try { - $result = $apiInstance->getPackageTrackingDetails($package_number); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling FbaOutboundApi->getPackageTrackingDetails: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **package_number** | **int**| The unencrypted package identifier returned by the getFulfillmentOrder operation. | - -### Return type - -[**\Swagger\Client\Models\GetPackageTrackingDetailsResponse**](../Model/GetPackageTrackingDetailsResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **listAllFulfillmentOrders** -> \Swagger\Client\Models\ListAllFulfillmentOrdersResponse listAllFulfillmentOrders($query_start_date_time, $fulfillment_method, $next_token) - - - -Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the next token parameter. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - - -$apiInstance = new Swagger\Client\Api\FbaOutboundApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$query_start_date_time = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | A date and time used to select fulfillment orders that were last updated after (or at) a specified time. An update is defined as any change in fulfillment order status, including the creation of a new fulfillment order. -$fulfillment_method = array("fulfillment_method_example"); // string[] | Indicates the intended recipient channel for the order. -$next_token = "next_token_example"; // string | A string token returned in the response to your previous request. - -try { - $result = $apiInstance->listAllFulfillmentOrders($query_start_date_time, $fulfillment_method, $next_token); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling FbaOutboundApi->listAllFulfillmentOrders: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **query_start_date_time** | **\DateTime**| A date and time used to select fulfillment orders that were last updated after (or at) a specified time. An update is defined as any change in fulfillment order status, including the creation of a new fulfillment order. | [optional] - **fulfillment_method** | [**string[]**](../Model/string.md)| Indicates the intended recipient channel for the order. | [optional] - **next_token** | **string**| A string token returned in the response to your previous request. | [optional] - -### Return type - -[**\Swagger\Client\Models\ListAllFulfillmentOrdersResponse**](../Model/ListAllFulfillmentOrdersResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **listReturnReasonCodes** -> \Swagger\Client\Models\ListReturnReasonCodesResponse listReturnReasonCodes($seller_sku, $language, $marketplace_id, $seller_fulfillment_order_id) - - - -Returns a list of return reason codes for a seller SKU in a given marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - - -$apiInstance = new Swagger\Client\Api\FbaOutboundApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$seller_sku = "seller_sku_example"; // string | The seller SKU for which return reason codes are required. -$language = "language_example"; // string | The language that the TranslatedDescription property of the ReasonCodeDetails response object should be translated into. -$marketplace_id = "marketplace_id_example"; // string | The marketplace for which the seller wants return reason codes. -$seller_fulfillment_order_id = "seller_fulfillment_order_id_example"; // string | The identifier assigned to the item by the seller when the fulfillment order was created. The service uses this value to determine the marketplace for which the seller wants return reason codes. - -try { - $result = $apiInstance->listReturnReasonCodes($seller_sku, $language, $marketplace_id, $seller_fulfillment_order_id); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling FbaOutboundApi->listReturnReasonCodes: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **seller_sku** | **string**| The seller SKU for which return reason codes are required. | - **language** | **string**| The language that the TranslatedDescription property of the ReasonCodeDetails response object should be translated into. | - **marketplace_id** | **string**| The marketplace for which the seller wants return reason codes. | [optional] - **seller_fulfillment_order_id** | **string**| The identifier assigned to the item by the seller when the fulfillment order was created. The service uses this value to determine the marketplace for which the seller wants return reason codes. | [optional] - -### Return type - -[**\Swagger\Client\Models\ListReturnReasonCodesResponse**](../Model/ListReturnReasonCodesResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **updateFulfillmentOrder** -> \Swagger\Client\Models\UpdateFulfillmentOrderResponse updateFulfillmentOrder($body, $seller_fulfillment_order_id) - - - -Updates and/or requests shipment for a fulfillment order with an order hold on it. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - - -$apiInstance = new Swagger\Client\Api\FbaOutboundApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$body = new \Swagger\Client\Models\UpdateFulfillmentOrderRequest(); // \Swagger\Client\Models\UpdateFulfillmentOrderRequest | -$seller_fulfillment_order_id = "seller_fulfillment_order_id_example"; // string | The identifier assigned to the item by the seller when the fulfillment order was created. - -try { - $result = $apiInstance->updateFulfillmentOrder($body, $seller_fulfillment_order_id); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling FbaOutboundApi->updateFulfillmentOrder: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | [**\Swagger\Client\Models\UpdateFulfillmentOrderRequest**](../Model/UpdateFulfillmentOrderRequest.md)| | - **seller_fulfillment_order_id** | **string**| The identifier assigned to the item by the seller when the fulfillment order was created. | - -### Return type - -[**\Swagger\Client\Models\UpdateFulfillmentOrderResponse**](../Model/UpdateFulfillmentOrderResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - From 97813fb3073f82b586ae628e4a8716480cd951e8 Mon Sep 17 00:00:00 2001 From: rodrigojob Date: Sat, 21 Nov 2020 16:38:53 -0300 Subject: [PATCH 08/25] Delete FeedsApi.md --- FeedsApi.md | 361 ---------------------------------------------------- 1 file changed, 361 deletions(-) delete mode 100644 FeedsApi.md diff --git a/FeedsApi.md b/FeedsApi.md deleted file mode 100644 index 9d6a1e73..00000000 --- a/FeedsApi.md +++ /dev/null @@ -1,361 +0,0 @@ -# Swagger\Client\FeedsApi - -All URIs are relative to *https://sellingpartnerapi-na.amazon.com/* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**cancelFeed**](FeedsApi.md#cancelfeed) | **DELETE** /feeds/2020-09-04/feeds/{feedId} | -[**createFeed**](FeedsApi.md#createfeed) | **POST** /feeds/2020-09-04/feeds | -[**createFeedDocument**](FeedsApi.md#createfeeddocument) | **POST** /feeds/2020-09-04/documents | -[**getFeed**](FeedsApi.md#getfeed) | **GET** /feeds/2020-09-04/feeds/{feedId} | -[**getFeedDocument**](FeedsApi.md#getfeeddocument) | **GET** /feeds/2020-09-04/documents/{feedDocumentId} | -[**getFeeds**](FeedsApi.md#getfeeds) | **GET** /feeds/2020-09-04/feeds | - -# **cancelFeed** -> \Swagger\Client\Models\CancelFeedResponse cancelFeed($feed_id) - - - -Cancels the feed that you specify. Only feeds with processingStatus=IN_QUEUE can be cancelled. Cancelled feeds are returned in subsequent calls to the getFeed and getFeeds operations. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\FeedsApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$feed_id = "feed_id_example"; // string | The identifier for the feed. This identifier is unique only in combination with a seller ID. - -try { - $result = $apiInstance->cancelFeed($feed_id); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling FeedsApi->cancelFeed: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **feed_id** | **string**| The identifier for the feed. This identifier is unique only in combination with a seller ID. | - -### Return type - -[**\Swagger\Client\Models\CancelFeedResponse**](../Model/CancelFeedResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **createFeed** -> \Swagger\Client\Models\CreateFeedResponse createFeed($body) - - - -Creates a feed. Encrypt and upload the contents of the feed document before calling this operation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0083 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\FeedsApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$body = new \Swagger\Client\Models\CreateFeedSpecification(); // \Swagger\Client\Models\CreateFeedSpecification | - -try { - $result = $apiInstance->createFeed($body); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling FeedsApi->createFeed: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | [**\Swagger\Client\Models\CreateFeedSpecification**](../Model/CreateFeedSpecification.md)| | - -### Return type - -[**\Swagger\Client\Models\CreateFeedResponse**](../Model/CreateFeedResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **createFeedDocument** -> \Swagger\Client\Models\CreateFeedDocumentResponse createFeedDocument($body) - - - -Creates a feed document for the feed type that you specify. This operation returns encryption details for encrypting the contents of the document, as well as a presigned URL for uploading the encrypted feed document contents. It also returns a feedDocumentId value that you can pass in with a subsequent call to the createFeed operation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0083 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\FeedsApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$body = new \Swagger\Client\Models\CreateFeedDocumentSpecification(); // \Swagger\Client\Models\CreateFeedDocumentSpecification | - -try { - $result = $apiInstance->createFeedDocument($body); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling FeedsApi->createFeedDocument: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | [**\Swagger\Client\Models\CreateFeedDocumentSpecification**](../Model/CreateFeedDocumentSpecification.md)| | - -### Return type - -[**\Swagger\Client\Models\CreateFeedDocumentResponse**](../Model/CreateFeedDocumentResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **getFeed** -> \Swagger\Client\Models\GetFeedResponse getFeed($feed_id) - - - -Returns feed details (including the resultDocumentId, if available) for the feed that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2.0 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\FeedsApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$feed_id = "feed_id_example"; // string | The identifier for the feed. This identifier is unique only in combination with a seller ID. - -try { - $result = $apiInstance->getFeed($feed_id); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling FeedsApi->getFeed: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **feed_id** | **string**| The identifier for the feed. This identifier is unique only in combination with a seller ID. | - -### Return type - -[**\Swagger\Client\Models\GetFeedResponse**](../Model/GetFeedResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **getFeedDocument** -> \Swagger\Client\Models\GetFeedDocumentResponse getFeedDocument($feed_document_id) - - - -Returns the information required for retrieving a feed document's contents. This includes a presigned URL for the feed document as well as the information required to decrypt the document's contents. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\FeedsApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$feed_document_id = "feed_document_id_example"; // string | The identifier of the feed document. - -try { - $result = $apiInstance->getFeedDocument($feed_document_id); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling FeedsApi->getFeedDocument: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **feed_document_id** | **string**| The identifier of the feed document. | - -### Return type - -[**\Swagger\Client\Models\GetFeedDocumentResponse**](../Model/GetFeedDocumentResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **getFeeds** -> \Swagger\Client\Models\GetFeedsResponse getFeeds($feed_types, $marketplace_ids, $page_size, $processing_statuses, $created_since, $created_until, $next_token) - - - -Returns feed details for the feeds that match the filters that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\FeedsApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$feed_types = array("feed_types_example"); // string[] | A list of feed types used to filter feeds. When feedTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. Either feedTypes or nextToken is required. -$marketplace_ids = array("marketplace_ids_example"); // string[] | A list of marketplace identifiers used to filter feeds. The feeds returned will match at least one of the marketplaces that you specify. -$page_size = 10; // int | The maximum number of feeds to return in a single call. -$processing_statuses = array("processing_statuses_example"); // string[] | A list of processing statuses used to filter feeds. -$created_since = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | The earliest feed creation date and time for feeds included in the response, in ISO 8601 format. The default is 90 days ago. Feeds are retained for a maximum of 90 days. -$created_until = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | The latest feed creation date and time for feeds included in the response, in ISO 8601 format. The default is now. -$next_token = "next_token_example"; // string | A string token returned in the response to your previous request. nextToken is returned when the number of results exceeds the specified pageSize value. To get the next page of results, call the getFeeds operation and include this token as the only parameter. Specifying nextToken with any other parameters will cause the request to fail. - -try { - $result = $apiInstance->getFeeds($feed_types, $marketplace_ids, $page_size, $processing_statuses, $created_since, $created_until, $next_token); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling FeedsApi->getFeeds: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **feed_types** | [**string[]**](../Model/string.md)| A list of feed types used to filter feeds. When feedTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. Either feedTypes or nextToken is required. | [optional] - **marketplace_ids** | [**string[]**](../Model/string.md)| A list of marketplace identifiers used to filter feeds. The feeds returned will match at least one of the marketplaces that you specify. | [optional] - **page_size** | **int**| The maximum number of feeds to return in a single call. | [optional] [default to 10] - **processing_statuses** | [**string[]**](../Model/string.md)| A list of processing statuses used to filter feeds. | [optional] - **created_since** | **\DateTime**| The earliest feed creation date and time for feeds included in the response, in ISO 8601 format. The default is 90 days ago. Feeds are retained for a maximum of 90 days. | [optional] - **created_until** | **\DateTime**| The latest feed creation date and time for feeds included in the response, in ISO 8601 format. The default is now. | [optional] - **next_token** | **string**| A string token returned in the response to your previous request. nextToken is returned when the number of results exceeds the specified pageSize value. To get the next page of results, call the getFeeds operation and include this token as the only parameter. Specifying nextToken with any other parameters will cause the request to fail. | [optional] - -### Return type - -[**\Swagger\Client\Models\GetFeedsResponse**](../Model/GetFeedsResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - From d48428975536c181daa496c1e54c6b3c36257ada Mon Sep 17 00:00:00 2001 From: rodrigojob Date: Sat, 21 Nov 2020 16:39:08 -0300 Subject: [PATCH 09/25] Delete MerchantFulfillmentApi.md --- MerchantFulfillmentApi.md | 463 -------------------------------------- 1 file changed, 463 deletions(-) delete mode 100644 MerchantFulfillmentApi.md diff --git a/MerchantFulfillmentApi.md b/MerchantFulfillmentApi.md deleted file mode 100644 index 1c197fa7..00000000 --- a/MerchantFulfillmentApi.md +++ /dev/null @@ -1,463 +0,0 @@ -# Swagger\Client\MerchantFulfillmentApi - -All URIs are relative to *https://sellingpartnerapi-na.amazon.com/* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**cancelShipment**](MerchantFulfillmentApi.md#cancelshipment) | **DELETE** /mfn/v0/shipments/{shipmentId} | -[**cancelShipmentOld**](MerchantFulfillmentApi.md#cancelshipmentold) | **PUT** /mfn/v0/shipments/{shipmentId}/cancel | -[**createShipment**](MerchantFulfillmentApi.md#createshipment) | **POST** /mfn/v0/shipments | -[**getAdditionalSellerInputs**](MerchantFulfillmentApi.md#getadditionalsellerinputs) | **POST** /mfn/v0/additionalSellerInputs | -[**getAdditionalSellerInputsOld**](MerchantFulfillmentApi.md#getadditionalsellerinputsold) | **POST** /mfn/v0/sellerInputs | -[**getEligibleShipmentServices**](MerchantFulfillmentApi.md#geteligibleshipmentservices) | **POST** /mfn/v0/eligibleShippingServices | -[**getEligibleShipmentServicesOld**](MerchantFulfillmentApi.md#geteligibleshipmentservicesold) | **POST** /mfn/v0/eligibleServices | -[**getShipment**](MerchantFulfillmentApi.md#getshipment) | **GET** /mfn/v0/shipments/{shipmentId} | - -# **cancelShipment** -> \Swagger\Client\Models\CancelShipmentResponse cancelShipment($shipment_id) - - - -Cancel the shipment indicated by the specified shipment identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\MerchantFulfillmentApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$shipment_id = "shipment_id_example"; // string | The Amazon-defined shipment identifier for the shipment to cancel. - -try { - $result = $apiInstance->cancelShipment($shipment_id); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling MerchantFulfillmentApi->cancelShipment: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **shipment_id** | **string**| The Amazon-defined shipment identifier for the shipment to cancel. | - -### Return type - -[**\Swagger\Client\Models\CancelShipmentResponse**](../Model/CancelShipmentResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **cancelShipmentOld** -> \Swagger\Client\Models\CancelShipmentResponse cancelShipmentOld($shipment_id) - - - -Cancel the shipment indicated by the specified shipment identifer. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\MerchantFulfillmentApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$shipment_id = "shipment_id_example"; // string | The Amazon-defined shipment identifier for the shipment to cancel. - -try { - $result = $apiInstance->cancelShipmentOld($shipment_id); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling MerchantFulfillmentApi->cancelShipmentOld: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **shipment_id** | **string**| The Amazon-defined shipment identifier for the shipment to cancel. | - -### Return type - -[**\Swagger\Client\Models\CancelShipmentResponse**](../Model/CancelShipmentResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **createShipment** -> \Swagger\Client\Models\CreateShipmentResponse createShipment($body) - - - -Create a shipment with the information provided. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\MerchantFulfillmentApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$body = new \Swagger\Client\Models\CreateShipmentRequest(); // \Swagger\Client\Models\CreateShipmentRequest | - -try { - $result = $apiInstance->createShipment($body); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling MerchantFulfillmentApi->createShipment: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | [**\Swagger\Client\Models\CreateShipmentRequest**](../Model/CreateShipmentRequest.md)| | - -### Return type - -[**\Swagger\Client\Models\CreateShipmentResponse**](../Model/CreateShipmentResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **getAdditionalSellerInputs** -> \Swagger\Client\Models\GetAdditionalSellerInputsResponse getAdditionalSellerInputs($body) - - - -Gets a list of additional seller inputs required for a ship method. This is generally used for international shipping. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\MerchantFulfillmentApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$body = new \Swagger\Client\Models\GetAdditionalSellerInputsRequest(); // \Swagger\Client\Models\GetAdditionalSellerInputsRequest | - -try { - $result = $apiInstance->getAdditionalSellerInputs($body); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling MerchantFulfillmentApi->getAdditionalSellerInputs: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | [**\Swagger\Client\Models\GetAdditionalSellerInputsRequest**](../Model/GetAdditionalSellerInputsRequest.md)| | - -### Return type - -[**\Swagger\Client\Models\GetAdditionalSellerInputsResponse**](../Model/GetAdditionalSellerInputsResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **getAdditionalSellerInputsOld** -> \Swagger\Client\Models\GetAdditionalSellerInputsResponse getAdditionalSellerInputsOld($body) - - - -Get a list of additional seller inputs required for a ship method. This is generally used for international shipping. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\MerchantFulfillmentApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$body = new \Swagger\Client\Models\GetAdditionalSellerInputsRequest(); // \Swagger\Client\Models\GetAdditionalSellerInputsRequest | - -try { - $result = $apiInstance->getAdditionalSellerInputsOld($body); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling MerchantFulfillmentApi->getAdditionalSellerInputsOld: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | [**\Swagger\Client\Models\GetAdditionalSellerInputsRequest**](../Model/GetAdditionalSellerInputsRequest.md)| | - -### Return type - -[**\Swagger\Client\Models\GetAdditionalSellerInputsResponse**](../Model/GetAdditionalSellerInputsResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **getEligibleShipmentServices** -> \Swagger\Client\Models\GetEligibleShipmentServicesResponse getEligibleShipmentServices($body) - - - -Returns a list of shipping service offers that satisfy the specified shipment request details. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\MerchantFulfillmentApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$body = new \Swagger\Client\Models\GetEligibleShipmentServicesRequest(); // \Swagger\Client\Models\GetEligibleShipmentServicesRequest | - -try { - $result = $apiInstance->getEligibleShipmentServices($body); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling MerchantFulfillmentApi->getEligibleShipmentServices: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | [**\Swagger\Client\Models\GetEligibleShipmentServicesRequest**](../Model/GetEligibleShipmentServicesRequest.md)| | - -### Return type - -[**\Swagger\Client\Models\GetEligibleShipmentServicesResponse**](../Model/GetEligibleShipmentServicesResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **getEligibleShipmentServicesOld** -> \Swagger\Client\Models\GetEligibleShipmentServicesResponse getEligibleShipmentServicesOld($body) - - - -Returns a list of shipping service offers that satisfy the specified shipment request details. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\MerchantFulfillmentApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$body = new \Swagger\Client\Models\GetEligibleShipmentServicesRequest(); // \Swagger\Client\Models\GetEligibleShipmentServicesRequest | - -try { - $result = $apiInstance->getEligibleShipmentServicesOld($body); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling MerchantFulfillmentApi->getEligibleShipmentServicesOld: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | [**\Swagger\Client\Models\GetEligibleShipmentServicesRequest**](../Model/GetEligibleShipmentServicesRequest.md)| | - -### Return type - -[**\Swagger\Client\Models\GetEligibleShipmentServicesResponse**](../Model/GetEligibleShipmentServicesResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **getShipment** -> \Swagger\Client\Models\GetShipmentResponse getShipment($shipment_id) - - - -Returns the shipment information for an existing shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\MerchantFulfillmentApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$shipment_id = "shipment_id_example"; // string | The Amazon-defined shipment identifier for the shipment. - -try { - $result = $apiInstance->getShipment($shipment_id); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling MerchantFulfillmentApi->getShipment: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **shipment_id** | **string**| The Amazon-defined shipment identifier for the shipment. | - -### Return type - -[**\Swagger\Client\Models\GetShipmentResponse**](../Model/GetShipmentResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - From ba6936164ca3442f62fc9c8d5010cda61e6fda62 Mon Sep 17 00:00:00 2001 From: rodrigojob Date: Sat, 21 Nov 2020 16:39:18 -0300 Subject: [PATCH 10/25] Delete FeesApi.md --- FeesApi.md | 125 ----------------------------------------------------- 1 file changed, 125 deletions(-) delete mode 100644 FeesApi.md diff --git a/FeesApi.md b/FeesApi.md deleted file mode 100644 index 2fc243de..00000000 --- a/FeesApi.md +++ /dev/null @@ -1,125 +0,0 @@ -# Swagger\Client\FeesApi - -All URIs are relative to *https://sellingpartnerapi-na.amazon.com/* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getMyFeesEstimateForASIN**](FeesApi.md#getmyfeesestimateforasin) | **POST** /products/fees/v0/items/{Asin}/feesEstimate | -[**getMyFeesEstimateForSKU**](FeesApi.md#getmyfeesestimateforsku) | **POST** /products/fees/v0/listings/{SellerSKU}/feesEstimate | - -# **getMyFeesEstimateForASIN** -> \Swagger\Client\Models\GetMyFeesEstimateResponse getMyFeesEstimateForASIN($body, $asin) - - - -Returns the estimated fees for the item indicated by the specified Asin in the marketplace specified in the request body. You can call getMyFeesEstimateForASIN for an item on behalf of a seller before the seller sets the item's price. They can then take estimated fees into account. With each product fees request, you must include an original identifier. This identifier is included in the fees estimate so you can correlate a fees estimate with the original request. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\FeesApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$body = new \Swagger\Client\Models\GetMyFeesEstimateRequest(); // \Swagger\Client\Models\GetMyFeesEstimateRequest | -$asin = "asin_example"; // string | The Amazon Standard Identification Number (ASIN) of the item. - -try { - $result = $apiInstance->getMyFeesEstimateForASIN($body, $asin); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling FeesApi->getMyFeesEstimateForASIN: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | [**\Swagger\Client\Models\GetMyFeesEstimateRequest**](../Model/GetMyFeesEstimateRequest.md)| | - **asin** | **string**| The Amazon Standard Identification Number (ASIN) of the item. | - -### Return type - -[**\Swagger\Client\Models\GetMyFeesEstimateResponse**](../Model/GetMyFeesEstimateResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **getMyFeesEstimateForSKU** -> \Swagger\Client\Models\GetMyFeesEstimateResponse getMyFeesEstimateForSKU($body, $seller_sku) - - - -Returns the estimated fees for the item indicated by the specified seller SKU in the marketplace specified in the request body. You can call getMyFeesEstimateForSKU for an item on behalf of a seller before the seller sets the item's price. They can then take estimated fees into account. With each fees estimate request, you must include an original identifier. This identifier is included in the fees estimate so you can correlate a fees estimate with the original request. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\FeesApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$body = new \Swagger\Client\Models\GetMyFeesEstimateRequest(); // \Swagger\Client\Models\GetMyFeesEstimateRequest | -$seller_sku = "seller_sku_example"; // string | Used to identify an item in the given marketplace. SellerSKU is qualified by the seller's SellerId, which is included with every operation that you submit. - -try { - $result = $apiInstance->getMyFeesEstimateForSKU($body, $seller_sku); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling FeesApi->getMyFeesEstimateForSKU: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | [**\Swagger\Client\Models\GetMyFeesEstimateRequest**](../Model/GetMyFeesEstimateRequest.md)| | - **seller_sku** | **string**| Used to identify an item in the given marketplace. SellerSKU is qualified by the seller's SellerId, which is included with every operation that you submit. | - -### Return type - -[**\Swagger\Client\Models\GetMyFeesEstimateResponse**](../Model/GetMyFeesEstimateResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - From 1ecec1e89066f9e7d36a537854183cc894675700 Mon Sep 17 00:00:00 2001 From: rodrigojob Date: Sat, 21 Nov 2020 16:39:48 -0300 Subject: [PATCH 11/25] Delete NotificationsApi.md --- NotificationsApi.md | 465 -------------------------------------------- 1 file changed, 465 deletions(-) delete mode 100644 NotificationsApi.md diff --git a/NotificationsApi.md b/NotificationsApi.md deleted file mode 100644 index 6af4a6fb..00000000 --- a/NotificationsApi.md +++ /dev/null @@ -1,465 +0,0 @@ -# Swagger\Client\NotificationsApi - -All URIs are relative to *https://sellingpartnerapi-na.amazon.com/* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createDestination**](NotificationsApi.md#createdestination) | **POST** /notifications/v1/destinations | -[**createSubscription**](NotificationsApi.md#createsubscription) | **POST** /notifications/v1/subscriptions/{notificationType} | -[**deleteDestination**](NotificationsApi.md#deletedestination) | **DELETE** /notifications/v1/destinations/{destinationId} | -[**deleteSubscriptionById**](NotificationsApi.md#deletesubscriptionbyid) | **DELETE** /notifications/v1/subscriptions/{notificationType}/{subscriptionId} | -[**getDestination**](NotificationsApi.md#getdestination) | **GET** /notifications/v1/destinations/{destinationId} | -[**getDestinations**](NotificationsApi.md#getdestinations) | **GET** /notifications/v1/destinations | -[**getSubscription**](NotificationsApi.md#getsubscription) | **GET** /notifications/v1/subscriptions/{notificationType} | -[**getSubscriptionById**](NotificationsApi.md#getsubscriptionbyid) | **GET** /notifications/v1/subscriptions/{notificationType}/{subscriptionId} | - -# **createDestination** -> \Swagger\Client\Models\CreateDestinationResponse createDestination($body) - - - -Creates a destination resource to receive notifications. The createDestination API is grantless. For more information, see \"Grantless operations\" in the Selling Partner API Developer Guide. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\NotificationsApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$body = new \Swagger\Client\Models\CreateDestinationRequest(); // \Swagger\Client\Models\CreateDestinationRequest | - -try { - $result = $apiInstance->createDestination($body); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling NotificationsApi->createDestination: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | [**\Swagger\Client\Models\CreateDestinationRequest**](../Model/CreateDestinationRequest.md)| | - -### Return type - -[**\Swagger\Client\Models\CreateDestinationResponse**](../Model/CreateDestinationResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json, Successful Response - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **createSubscription** -> \Swagger\Client\Models\CreateSubscriptionResponse createSubscription($body, $notification_type) - - - -Creates a subscription for the specified notification type to be delivered to the specified destination. Before you can subscribe, you must first create the destination by calling the createDestination operation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\NotificationsApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$body = new \Swagger\Client\Models\CreateSubscriptionRequest(); // \Swagger\Client\Models\CreateSubscriptionRequest | -$notification_type = "notification_type_example"; // string | The type of notification to which you want to subscribe. For more information about notification types, see the Notifications API Use Case Guide. - -try { - $result = $apiInstance->createSubscription($body, $notification_type); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling NotificationsApi->createSubscription: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | [**\Swagger\Client\Models\CreateSubscriptionRequest**](../Model/CreateSubscriptionRequest.md)| | - **notification_type** | **string**| The type of notification to which you want to subscribe. For more information about notification types, see the Notifications API Use Case Guide. | - -### Return type - -[**\Swagger\Client\Models\CreateSubscriptionResponse**](../Model/CreateSubscriptionResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json, Successful Response - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **deleteDestination** -> \Swagger\Client\Models\DeleteDestinationResponse deleteDestination($destination_id) - - - -Deletes the destination that you specify. The deleteDestination API is grantless. For more information, see \"Grantless operations\" in the Selling Partner API Developer Guide. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\NotificationsApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$destination_id = "destination_id_example"; // string | The identifier for the destination that you want to delete. - -try { - $result = $apiInstance->deleteDestination($destination_id); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling NotificationsApi->deleteDestination: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **destination_id** | **string**| The identifier for the destination that you want to delete. | - -### Return type - -[**\Swagger\Client\Models\DeleteDestinationResponse**](../Model/DeleteDestinationResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, Successful Response - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **deleteSubscriptionById** -> \Swagger\Client\Models\DeleteSubscriptionByIdResponse deleteSubscriptionById($subscription_id, $notification_type) - - - -Deletes the subscription indicated by the subscription identifier and notification type that you specify. The subscription identifier can be for any subscription associated with your application. After you successfully call this operation, notifications will stop being sent for the associated subscription. The deleteSubscriptionById API is grantless. For more information, see \"Grantless operations\" in the Selling Partner API Developer Guide. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\NotificationsApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$subscription_id = "subscription_id_example"; // string | The identifier for the subscription that you want to delete. -$notification_type = "notification_type_example"; // string | The type of notification to which you want to subscribe. For more information about notification types, see the Notifications API Use Case Guide. - -try { - $result = $apiInstance->deleteSubscriptionById($subscription_id, $notification_type); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling NotificationsApi->deleteSubscriptionById: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **subscription_id** | **string**| The identifier for the subscription that you want to delete. | - **notification_type** | **string**| The type of notification to which you want to subscribe. For more information about notification types, see the Notifications API Use Case Guide. | - -### Return type - -[**\Swagger\Client\Models\DeleteSubscriptionByIdResponse**](../Model/DeleteSubscriptionByIdResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, Successful Operation Response - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **getDestination** -> \Swagger\Client\Models\GetDestinationResponse getDestination($destination_id) - - - -Returns information about the destination that you specify. The getDestination API is grantless. For more information, see \"Grantless operations\" in the Selling Partner API Developer Guide. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\NotificationsApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$destination_id = "destination_id_example"; // string | The identifier generated when you created the destination. - -try { - $result = $apiInstance->getDestination($destination_id); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling NotificationsApi->getDestination: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **destination_id** | **string**| The identifier generated when you created the destination. | - -### Return type - -[**\Swagger\Client\Models\GetDestinationResponse**](../Model/GetDestinationResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, Successful Response - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **getDestinations** -> \Swagger\Client\Models\GetDestinationsResponse getDestinations() - - - -Returns information about all destinations. The getDestinations API is grantless. For more information, see \"Grantless operations\" in the Selling Partner API Developer Guide. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\NotificationsApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); - -try { - $result = $apiInstance->getDestinations(); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling NotificationsApi->getDestinations: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**\Swagger\Client\Models\GetDestinationsResponse**](../Model/GetDestinationsResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, Successful Response - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **getSubscription** -> \Swagger\Client\Models\GetSubscriptionResponse getSubscription($notification_type) - - - -Returns information about subscriptions of the specified notification type. You can use this API to get subscription information when you do not have a subscription identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\NotificationsApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$notification_type = "notification_type_example"; // string | The type of notification to which you want to subscribe. For more information about notification types, see the Notifications API Use Case Guide. - -try { - $result = $apiInstance->getSubscription($notification_type); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling NotificationsApi->getSubscription: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **notification_type** | **string**| The type of notification to which you want to subscribe. For more information about notification types, see the Notifications API Use Case Guide. | - -### Return type - -[**\Swagger\Client\Models\GetSubscriptionResponse**](../Model/GetSubscriptionResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, Successful Response - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **getSubscriptionById** -> \Swagger\Client\Models\GetSubscriptionByIdResponse getSubscriptionById($subscription_id, $notification_type) - - - -Returns information about a subscription for the specified notification type. The getSubscriptionById API is grantless. For more information, see \"Grantless operations\" in the Selling Partner API Developer Guide. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\NotificationsApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$subscription_id = "subscription_id_example"; // string | The identifier for the subscription that you want to get. -$notification_type = "notification_type_example"; // string | The type of notification to which you want to subscribe. For more information about notification types, see the Notifications API Use Case Guide. - -try { - $result = $apiInstance->getSubscriptionById($subscription_id, $notification_type); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling NotificationsApi->getSubscriptionById: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **subscription_id** | **string**| The identifier for the subscription that you want to get. | - **notification_type** | **string**| The type of notification to which you want to subscribe. For more information about notification types, see the Notifications API Use Case Guide. | - -### Return type - -[**\Swagger\Client\Models\GetSubscriptionByIdResponse**](../Model/GetSubscriptionByIdResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, Successful Response - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - From a2fdebc9acaba237695e33a239458dc8bc5c3eee Mon Sep 17 00:00:00 2001 From: rodrigojob Date: Sat, 21 Nov 2020 16:40:04 -0300 Subject: [PATCH 12/25] Delete OrdersV0Api.md --- OrdersV0Api.md | 378 ------------------------------------------------- 1 file changed, 378 deletions(-) delete mode 100644 OrdersV0Api.md diff --git a/OrdersV0Api.md b/OrdersV0Api.md deleted file mode 100644 index b3d9ecdd..00000000 --- a/OrdersV0Api.md +++ /dev/null @@ -1,378 +0,0 @@ -# Swagger\Client\OrdersV0Api - -All URIs are relative to *https://sellingpartnerapi-na.amazon.com/* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getOrder**](OrdersV0Api.md#getorder) | **GET** /orders/v0/orders/{orderId} | -[**getOrderAddress**](OrdersV0Api.md#getorderaddress) | **GET** /orders/v0/orders/{orderId}/address | -[**getOrderBuyerInfo**](OrdersV0Api.md#getorderbuyerinfo) | **GET** /orders/v0/orders/{orderId}/buyerInfo | -[**getOrderItems**](OrdersV0Api.md#getorderitems) | **GET** /orders/v0/orders/{orderId}/orderItems | -[**getOrderItemsBuyerInfo**](OrdersV0Api.md#getorderitemsbuyerinfo) | **GET** /orders/v0/orders/{orderId}/orderItems/buyerInfo | -[**getOrders**](OrdersV0Api.md#getorders) | **GET** /orders/v0/orders | - -# **getOrder** -> \Swagger\Client\Models\GetOrderResponse getOrder($order_id) - - - -Returns the order indicated by the specified order ID. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0055 | 20 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\OrdersV0Api( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$order_id = "order_id_example"; // string | An Amazon-defined order identifier, in 3-7-7 format. - -try { - $result = $apiInstance->getOrder($order_id); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling OrdersV0Api->getOrder: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **order_id** | **string**| An Amazon-defined order identifier, in 3-7-7 format. | - -### Return type - -[**\Swagger\Client\Models\GetOrderResponse**](../Model/GetOrderResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **getOrderAddress** -> \Swagger\Client\Models\GetOrderAddressResponse getOrderAddress($order_id) - - - -Returns the shipping address for the order indicated by the specified order ID. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0055 | 20 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\OrdersV0Api( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$order_id = "order_id_example"; // string | An orderId is an Amazon-defined order identifier, in 3-7-7 format. - -try { - $result = $apiInstance->getOrderAddress($order_id); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling OrdersV0Api->getOrderAddress: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **order_id** | **string**| An orderId is an Amazon-defined order identifier, in 3-7-7 format. | - -### Return type - -[**\Swagger\Client\Models\GetOrderAddressResponse**](../Model/GetOrderAddressResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **getOrderBuyerInfo** -> \Swagger\Client\Models\GetOrderBuyerInfoResponse getOrderBuyerInfo($order_id) - - - -Returns buyer information for the order indicated by the specified order ID. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0055 | 20 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\OrdersV0Api( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$order_id = "order_id_example"; // string | An orderId is an Amazon-defined order identifier, in 3-7-7 format. - -try { - $result = $apiInstance->getOrderBuyerInfo($order_id); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling OrdersV0Api->getOrderBuyerInfo: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **order_id** | **string**| An orderId is an Amazon-defined order identifier, in 3-7-7 format. | - -### Return type - -[**\Swagger\Client\Models\GetOrderBuyerInfoResponse**](../Model/GetOrderBuyerInfoResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **getOrderItems** -> \Swagger\Client\Models\GetOrderItemsResponse getOrderItems($order_id, $next_token) - - - -Returns detailed order item information for the order indicated by the specified order ID. If NextToken is provided, it's used to retrieve the next page of order items. Note: When an order is in the Pending state (the order has been placed but payment has not been authorized), the getOrderItems operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped, Partially Shipped, or Shipped state, the getOrderItems operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0055 | 20 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\OrdersV0Api( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$order_id = "order_id_example"; // string | An Amazon-defined order identifier, in 3-7-7 format. -$next_token = "next_token_example"; // string | A string token returned in the response of your previous request. - -try { - $result = $apiInstance->getOrderItems($order_id, $next_token); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling OrdersV0Api->getOrderItems: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **order_id** | **string**| An Amazon-defined order identifier, in 3-7-7 format. | - **next_token** | **string**| A string token returned in the response of your previous request. | [optional] - -### Return type - -[**\Swagger\Client\Models\GetOrderItemsResponse**](../Model/GetOrderItemsResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **getOrderItemsBuyerInfo** -> \Swagger\Client\Models\GetOrderItemsBuyerInfoResponse getOrderItemsBuyerInfo($order_id, $next_token) - - - -Returns buyer information in the order items of the order indicated by the specified order ID. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0055 | 20 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\OrdersV0Api( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$order_id = "order_id_example"; // string | An Amazon-defined order identifier, in 3-7-7 format. -$next_token = "next_token_example"; // string | A string token returned in the response of your previous request. - -try { - $result = $apiInstance->getOrderItemsBuyerInfo($order_id, $next_token); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling OrdersV0Api->getOrderItemsBuyerInfo: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **order_id** | **string**| An Amazon-defined order identifier, in 3-7-7 format. | - **next_token** | **string**| A string token returned in the response of your previous request. | [optional] - -### Return type - -[**\Swagger\Client\Models\GetOrderItemsBuyerInfoResponse**](../Model/GetOrderItemsBuyerInfoResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **getOrders** -> \Swagger\Client\Models\GetOrdersResponse getOrders($marketplace_ids, $created_after, $created_before, $last_updated_after, $last_updated_before, $order_statuses, $fulfillment_channels, $payment_methods, $buyer_email, $seller_order_id, $max_results_per_page, $easy_ship_shipment_statuses, $next_token, $amazon_order_ids) - - - -Returns orders created or updated during the time frame indicated by the specified parameters. You can also apply a range of filtering criteria to narrow the list of orders returned. If NextToken is present, that will be used to retrieve the orders instead of other criteria. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0055 | 20 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\OrdersV0Api( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$marketplace_ids = array("marketplace_ids_example"); // string[] | A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces. -$created_after = "created_after_example"; // string | A date used for selecting orders created after (or at) a specified time. Only orders placed after the specified time are returned. Either the CreatedAfter parameter or the LastUpdatedAfter parameter is required. Both cannot be empty. The date must be in ISO 8601 format. -$created_before = "created_before_example"; // string | A date used for selecting orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in ISO 8601 format. -$last_updated_after = "last_updated_after_example"; // string | A date used for selecting orders that were last updated after (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in ISO 8601 format. -$last_updated_before = "last_updated_before_example"; // string | A date used for selecting orders that were last updated before (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in ISO 8601 format. -$order_statuses = array("order_statuses_example"); // string[] | A list of OrderStatus values used to filter the results. Possible values: PendingAvailability (This status is available for pre-orders only. The order has been placed, payment has not been authorized, and the release date of the item is in the future.); Pending (The order has been placed but payment has not been authorized); Unshipped (Payment has been authorized and the order is ready for shipment, but no items in the order have been shipped); PartiallyShipped (One or more, but not all, items in the order have been shipped); Shipped (All items in the order have been shipped); InvoiceUnconfirmed (All items in the order have been shipped. The seller has not yet given confirmation to Amazon that the invoice has been shipped to the buyer.); Canceled (The order has been canceled); and Unfulfillable (The order cannot be fulfilled. This state applies only to Multi-Channel Fulfillment orders.). -$fulfillment_channels = array("fulfillment_channels_example"); // string[] | A list that indicates how an order was fulfilled. Filters the results by fulfillment channel. Possible values: FBA (Fulfillment by Amazon); SellerFulfilled (Fulfilled by the seller). -$payment_methods = array("payment_methods_example"); // string[] | A list of payment method values. Used to select orders paid using the specified payment methods. Possible values: COD (Cash on delivery); CVS (Convenience store payment); Other (Any payment method other than COD or CVS). -$buyer_email = "buyer_email_example"; // string | The email address of a buyer. Used to select orders that contain the specified email address. -$seller_order_id = "seller_order_id_example"; // string | An order identifier that is specified by the seller. Used to select only the orders that match the order identifier. If SellerOrderId is specified, then FulfillmentChannels, OrderStatuses, PaymentMethod, LastUpdatedAfter, LastUpdatedBefore, and BuyerEmail cannot be specified. -$max_results_per_page = 56; // int | A number that indicates the maximum number of orders that can be returned per page. Value must be 1 - 100. Default 100. -$easy_ship_shipment_statuses = array("easy_ship_shipment_statuses_example"); // string[] | A list of EasyShipShipmentStatus values. Used to select Easy Ship orders with statuses that match the specified values. If EasyShipShipmentStatus is specified, only Amazon Easy Ship orders are returned.Possible values: PendingPickUp (Amazon has not yet picked up the package from the seller). LabelCanceled (The seller canceled the pickup). PickedUp (Amazon has picked up the package from the seller). AtOriginFC (The packaged is at the origin fulfillment center). AtDestinationFC (The package is at the destination fulfillment center). OutForDelivery (The package is out for delivery). Damaged (The package was damaged by the carrier). Delivered (The package has been delivered to the buyer). RejectedByBuyer (The package has been rejected by the buyer). Undeliverable (The package cannot be delivered). ReturnedToSeller (The package was not delivered to the buyer and was returned to the seller). ReturningToSeller (The package was not delivered to the buyer and is being returned to the seller). -$next_token = "next_token_example"; // string | A string token returned in the response of your previous request. -$amazon_order_ids = array("amazon_order_ids_example"); // string[] | A list of AmazonOrderId values. An AmazonOrderId is an Amazon-defined order identifier, in 3-7-7 format. - -try { - $result = $apiInstance->getOrders($marketplace_ids, $created_after, $created_before, $last_updated_after, $last_updated_before, $order_statuses, $fulfillment_channels, $payment_methods, $buyer_email, $seller_order_id, $max_results_per_page, $easy_ship_shipment_statuses, $next_token, $amazon_order_ids); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling OrdersV0Api->getOrders: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **marketplace_ids** | [**string[]**](../Model/string.md)| A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces. | - **created_after** | **string**| A date used for selecting orders created after (or at) a specified time. Only orders placed after the specified time are returned. Either the CreatedAfter parameter or the LastUpdatedAfter parameter is required. Both cannot be empty. The date must be in ISO 8601 format. | [optional] - **created_before** | **string**| A date used for selecting orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in ISO 8601 format. | [optional] - **last_updated_after** | **string**| A date used for selecting orders that were last updated after (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in ISO 8601 format. | [optional] - **last_updated_before** | **string**| A date used for selecting orders that were last updated before (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in ISO 8601 format. | [optional] - **order_statuses** | [**string[]**](../Model/string.md)| A list of OrderStatus values used to filter the results. Possible values: PendingAvailability (This status is available for pre-orders only. The order has been placed, payment has not been authorized, and the release date of the item is in the future.); Pending (The order has been placed but payment has not been authorized); Unshipped (Payment has been authorized and the order is ready for shipment, but no items in the order have been shipped); PartiallyShipped (One or more, but not all, items in the order have been shipped); Shipped (All items in the order have been shipped); InvoiceUnconfirmed (All items in the order have been shipped. The seller has not yet given confirmation to Amazon that the invoice has been shipped to the buyer.); Canceled (The order has been canceled); and Unfulfillable (The order cannot be fulfilled. This state applies only to Multi-Channel Fulfillment orders.). | [optional] - **fulfillment_channels** | [**string[]**](../Model/string.md)| A list that indicates how an order was fulfilled. Filters the results by fulfillment channel. Possible values: FBA (Fulfillment by Amazon); SellerFulfilled (Fulfilled by the seller). | [optional] - **payment_methods** | [**string[]**](../Model/string.md)| A list of payment method values. Used to select orders paid using the specified payment methods. Possible values: COD (Cash on delivery); CVS (Convenience store payment); Other (Any payment method other than COD or CVS). | [optional] - **buyer_email** | **string**| The email address of a buyer. Used to select orders that contain the specified email address. | [optional] - **seller_order_id** | **string**| An order identifier that is specified by the seller. Used to select only the orders that match the order identifier. If SellerOrderId is specified, then FulfillmentChannels, OrderStatuses, PaymentMethod, LastUpdatedAfter, LastUpdatedBefore, and BuyerEmail cannot be specified. | [optional] - **max_results_per_page** | **int**| A number that indicates the maximum number of orders that can be returned per page. Value must be 1 - 100. Default 100. | [optional] - **easy_ship_shipment_statuses** | [**string[]**](../Model/string.md)| A list of EasyShipShipmentStatus values. Used to select Easy Ship orders with statuses that match the specified values. If EasyShipShipmentStatus is specified, only Amazon Easy Ship orders are returned.Possible values: PendingPickUp (Amazon has not yet picked up the package from the seller). LabelCanceled (The seller canceled the pickup). PickedUp (Amazon has picked up the package from the seller). AtOriginFC (The packaged is at the origin fulfillment center). AtDestinationFC (The package is at the destination fulfillment center). OutForDelivery (The package is out for delivery). Damaged (The package was damaged by the carrier). Delivered (The package has been delivered to the buyer). RejectedByBuyer (The package has been rejected by the buyer). Undeliverable (The package cannot be delivered). ReturnedToSeller (The package was not delivered to the buyer and was returned to the seller). ReturningToSeller (The package was not delivered to the buyer and is being returned to the seller). | [optional] - **next_token** | **string**| A string token returned in the response of your previous request. | [optional] - **amazon_order_ids** | [**string[]**](../Model/string.md)| A list of AmazonOrderId values. An AmazonOrderId is an Amazon-defined order identifier, in 3-7-7 format. | [optional] - -### Return type - -[**\Swagger\Client\Models\GetOrdersResponse**](../Model/GetOrdersResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - From 4b166de856b607e68d8444027547497559416ce1 Mon Sep 17 00:00:00 2001 From: rodrigojob Date: Sat, 21 Nov 2020 16:40:21 -0300 Subject: [PATCH 13/25] Delete ProductPricingApi.md --- ProductPricingApi.md | 257 ------------------------------------------- 1 file changed, 257 deletions(-) delete mode 100644 ProductPricingApi.md diff --git a/ProductPricingApi.md b/ProductPricingApi.md deleted file mode 100644 index 8c7d772e..00000000 --- a/ProductPricingApi.md +++ /dev/null @@ -1,257 +0,0 @@ -# Swagger\Client\ProductPricingApi - -All URIs are relative to *https://sellingpartnerapi-na.amazon.com/* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getCompetitivePricing**](ProductPricingApi.md#getcompetitivepricing) | **GET** /products/pricing/v0/competitivePrice | -[**getItemOffers**](ProductPricingApi.md#getitemoffers) | **GET** /products/pricing/v0/items/{Asin}/offers | -[**getListingOffers**](ProductPricingApi.md#getlistingoffers) | **GET** /products/pricing/v0/listings/{SellerSKU}/offers | -[**getPricing**](ProductPricingApi.md#getpricing) | **GET** /products/pricing/v0/price | - -# **getCompetitivePricing** -> \Swagger\Client\Models\GetPricingResponse getCompetitivePricing($marketplace_id, $item_type, $asins, $skus) - - - -Returns competitive pricing information for a seller's offer listings based on seller SKU or ASIN. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\ProductPricingApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$marketplace_id = "marketplace_id_example"; // string | A marketplace identifier. Specifies the marketplace for which prices are returned. -$item_type = "item_type_example"; // string | Indicates whether ASIN values or seller SKU values are used to identify items. If you specify Asin, the information in the response will be dependent on the list of Asins you provide in the Asins parameter. If you specify Sku, the information in the response will be dependent on the list of Skus you provide in the Skus parameter. Possible values: Asin, Sku. -$asins = array("asins_example"); // string[] | A list of up to twenty Amazon Standard Identification Number (ASIN) values used to identify items in the given marketplace. -$skus = array("skus_example"); // string[] | A list of up to twenty seller SKU values used to identify items in the given marketplace. - -try { - $result = $apiInstance->getCompetitivePricing($marketplace_id, $item_type, $asins, $skus); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling ProductPricingApi->getCompetitivePricing: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **marketplace_id** | **string**| A marketplace identifier. Specifies the marketplace for which prices are returned. | - **item_type** | **string**| Indicates whether ASIN values or seller SKU values are used to identify items. If you specify Asin, the information in the response will be dependent on the list of Asins you provide in the Asins parameter. If you specify Sku, the information in the response will be dependent on the list of Skus you provide in the Skus parameter. Possible values: Asin, Sku. | - **asins** | [**string[]**](../Model/string.md)| A list of up to twenty Amazon Standard Identification Number (ASIN) values used to identify items in the given marketplace. | [optional] - **skus** | [**string[]**](../Model/string.md)| A list of up to twenty seller SKU values used to identify items in the given marketplace. | [optional] - -### Return type - -[**\Swagger\Client\Models\GetPricingResponse**](../Model/GetPricingResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **getItemOffers** -> \Swagger\Client\Models\GetOffersResponse getItemOffers($marketplace_id, $item_condition, $asin) - - - -Returns the lowest priced offers for a single item based on ASIN. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\ProductPricingApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$marketplace_id = "marketplace_id_example"; // string | A marketplace identifier. Specifies the marketplace for which prices are returned. -$item_condition = "item_condition_example"; // string | Filters the offer listings to be considered based on item condition. Possible values: New, Used, Collectible, Refurbished, Club. -$asin = "asin_example"; // string | The Amazon Standard Identification Number (ASIN) of the item. - -try { - $result = $apiInstance->getItemOffers($marketplace_id, $item_condition, $asin); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling ProductPricingApi->getItemOffers: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **marketplace_id** | **string**| A marketplace identifier. Specifies the marketplace for which prices are returned. | - **item_condition** | **string**| Filters the offer listings to be considered based on item condition. Possible values: New, Used, Collectible, Refurbished, Club. | - **asin** | **string**| The Amazon Standard Identification Number (ASIN) of the item. | - -### Return type - -[**\Swagger\Client\Models\GetOffersResponse**](../Model/GetOffersResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **getListingOffers** -> \Swagger\Client\Models\GetOffersResponse getListingOffers($marketplace_id, $item_condition, $seller_sku) - - - -Returns the lowest priced offers for a single SKU listing. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\ProductPricingApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$marketplace_id = "marketplace_id_example"; // string | A marketplace identifier. Specifies the marketplace for which prices are returned. -$item_condition = "item_condition_example"; // string | Filters the offer listings based on item condition. Possible values: New, Used, Collectible, Refurbished, Club. -$seller_sku = "seller_sku_example"; // string | Identifies an item in the given marketplace. SellerSKU is qualified by the seller's SellerId, which is included with every operation that you submit. - -try { - $result = $apiInstance->getListingOffers($marketplace_id, $item_condition, $seller_sku); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling ProductPricingApi->getListingOffers: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **marketplace_id** | **string**| A marketplace identifier. Specifies the marketplace for which prices are returned. | - **item_condition** | **string**| Filters the offer listings based on item condition. Possible values: New, Used, Collectible, Refurbished, Club. | - **seller_sku** | **string**| Identifies an item in the given marketplace. SellerSKU is qualified by the seller's SellerId, which is included with every operation that you submit. | - -### Return type - -[**\Swagger\Client\Models\GetOffersResponse**](../Model/GetOffersResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **getPricing** -> \Swagger\Client\Models\GetPricingResponse getPricing($marketplace_id, $item_type, $asins, $skus, $item_condition) - - - -Returns pricing information for a seller's offer listings based on seller SKU or ASIN. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\ProductPricingApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$marketplace_id = "marketplace_id_example"; // string | A marketplace identifier. Specifies the marketplace for which prices are returned. -$item_type = "item_type_example"; // string | Indicates whether ASIN values or seller SKU values are used to identify items. If you specify Asin, the information in the response will be dependent on the list of Asins you provide in the Asins parameter. If you specify Sku, the information in the response will be dependent on the list of Skus you provide in the Skus parameter. -$asins = array("asins_example"); // string[] | A list of up to twenty Amazon Standard Identification Number (ASIN) values used to identify items in the given marketplace. -$skus = array("skus_example"); // string[] | A list of up to twenty seller SKU values used to identify items in the given marketplace. -$item_condition = "item_condition_example"; // string | Filters the offer listings based on item condition. Possible values: New, Used, Collectible, Refurbished, Club. - -try { - $result = $apiInstance->getPricing($marketplace_id, $item_type, $asins, $skus, $item_condition); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling ProductPricingApi->getPricing: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **marketplace_id** | **string**| A marketplace identifier. Specifies the marketplace for which prices are returned. | - **item_type** | **string**| Indicates whether ASIN values or seller SKU values are used to identify items. If you specify Asin, the information in the response will be dependent on the list of Asins you provide in the Asins parameter. If you specify Sku, the information in the response will be dependent on the list of Skus you provide in the Skus parameter. | - **asins** | [**string[]**](../Model/string.md)| A list of up to twenty Amazon Standard Identification Number (ASIN) values used to identify items in the given marketplace. | [optional] - **skus** | [**string[]**](../Model/string.md)| A list of up to twenty seller SKU values used to identify items in the given marketplace. | [optional] - **item_condition** | **string**| Filters the offer listings based on item condition. Possible values: New, Used, Collectible, Refurbished, Club. | [optional] - -### Return type - -[**\Swagger\Client\Models\GetPricingResponse**](../Model/GetPricingResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - From df746af1ce740306a4cc1c94c5c6bd6f4a95bc7f Mon Sep 17 00:00:00 2001 From: rodrigojob Date: Sat, 21 Nov 2020 16:40:39 -0300 Subject: [PATCH 14/25] Delete ReportsApi.md --- ReportsApi.md | 532 -------------------------------------------------- 1 file changed, 532 deletions(-) delete mode 100644 ReportsApi.md diff --git a/ReportsApi.md b/ReportsApi.md deleted file mode 100644 index 92ea49a7..00000000 --- a/ReportsApi.md +++ /dev/null @@ -1,532 +0,0 @@ -# Swagger\Client\ReportsApi - -All URIs are relative to *https://sellingpartnerapi-na.amazon.com/* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**cancelReport**](ReportsApi.md#cancelreport) | **DELETE** /reports/2020-09-04/reports/{reportId} | -[**cancelReportSchedule**](ReportsApi.md#cancelreportschedule) | **DELETE** /reports/2020-09-04/schedules/{reportScheduleId} | -[**createReport**](ReportsApi.md#createreport) | **POST** /reports/2020-09-04/reports | -[**createReportSchedule**](ReportsApi.md#createreportschedule) | **POST** /reports/2020-09-04/schedules | -[**getReport**](ReportsApi.md#getreport) | **GET** /reports/2020-09-04/reports/{reportId} | -[**getReportDocument**](ReportsApi.md#getreportdocument) | **GET** /reports/2020-09-04/documents/{reportDocumentId} | -[**getReportSchedule**](ReportsApi.md#getreportschedule) | **GET** /reports/2020-09-04/schedules/{reportScheduleId} | -[**getReportSchedules**](ReportsApi.md#getreportschedules) | **GET** /reports/2020-09-04/schedules | -[**getReports**](ReportsApi.md#getreports) | **GET** /reports/2020-09-04/reports | - -# **cancelReport** -> \Swagger\Client\Models\CancelReportResponse cancelReport($report_id) - - - -Cancels the report that you specify. Only reports with processingStatus=IN_QUEUE can be cancelled. Cancelled reports are returned in subsequent calls to the getReport and getReports operations. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\ReportsApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$report_id = "report_id_example"; // string | The identifier for the report. This identifier is unique only in combination with a seller ID. - -try { - $result = $apiInstance->cancelReport($report_id); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling ReportsApi->cancelReport: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **report_id** | **string**| The identifier for the report. This identifier is unique only in combination with a seller ID. | - -### Return type - -[**\Swagger\Client\Models\CancelReportResponse**](../Model/CancelReportResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **cancelReportSchedule** -> \Swagger\Client\Models\CancelReportScheduleResponse cancelReportSchedule($report_schedule_id) - - - -Cancels the report schedule that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\ReportsApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$report_schedule_id = "report_schedule_id_example"; // string | The identifier for the report schedule. This identifier is unique only in combination with a seller ID. - -try { - $result = $apiInstance->cancelReportSchedule($report_schedule_id); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling ReportsApi->cancelReportSchedule: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **report_schedule_id** | **string**| The identifier for the report schedule. This identifier is unique only in combination with a seller ID. | - -### Return type - -[**\Swagger\Client\Models\CancelReportScheduleResponse**](../Model/CancelReportScheduleResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **createReport** -> \Swagger\Client\Models\CreateReportResponse createReport($body) - - - -Creates a report. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\ReportsApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$body = new \Swagger\Client\Models\CreateReportSpecification(); // \Swagger\Client\Models\CreateReportSpecification | - -try { - $result = $apiInstance->createReport($body); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling ReportsApi->createReport: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | [**\Swagger\Client\Models\CreateReportSpecification**](../Model/CreateReportSpecification.md)| | - -### Return type - -[**\Swagger\Client\Models\CreateReportResponse**](../Model/CreateReportResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **createReportSchedule** -> \Swagger\Client\Models\CreateReportScheduleResponse createReportSchedule($body) - - - -Creates a report schedule. If a report schedule with the same report type and marketplace IDs already exists, it will be cancelled and replaced with this one. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\ReportsApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$body = new \Swagger\Client\Models\CreateReportScheduleSpecification(); // \Swagger\Client\Models\CreateReportScheduleSpecification | - -try { - $result = $apiInstance->createReportSchedule($body); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling ReportsApi->createReportSchedule: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | [**\Swagger\Client\Models\CreateReportScheduleSpecification**](../Model/CreateReportScheduleSpecification.md)| | - -### Return type - -[**\Swagger\Client\Models\CreateReportScheduleResponse**](../Model/CreateReportScheduleResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **getReport** -> \Swagger\Client\Models\GetReportResponse getReport($report_id) - - - -Returns report details (including the reportDocumentId, if available) for the report that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2.0 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\ReportsApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$report_id = "report_id_example"; // string | The identifier for the report. This identifier is unique only in combination with a seller ID. - -try { - $result = $apiInstance->getReport($report_id); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling ReportsApi->getReport: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **report_id** | **string**| The identifier for the report. This identifier is unique only in combination with a seller ID. | - -### Return type - -[**\Swagger\Client\Models\GetReportResponse**](../Model/GetReportResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **getReportDocument** -> \Swagger\Client\Models\GetReportDocumentResponse getReportDocument($report_document_id) - - - -Returns the information required for retrieving a report document's contents. This includes a presigned URL for the report document as well as the information required to decrypt the document's contents. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\ReportsApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$report_document_id = "report_document_id_example"; // string | The identifier for the report document. - -try { - $result = $apiInstance->getReportDocument($report_document_id); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling ReportsApi->getReportDocument: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **report_document_id** | **string**| The identifier for the report document. | - -### Return type - -[**\Swagger\Client\Models\GetReportDocumentResponse**](../Model/GetReportDocumentResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **getReportSchedule** -> \Swagger\Client\Models\GetReportScheduleResponse getReportSchedule($report_schedule_id) - - - -Returns report schedule details for the report schedule that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\ReportsApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$report_schedule_id = "report_schedule_id_example"; // string | The identifier for the report schedule. This identifier is unique only in combination with a seller ID. - -try { - $result = $apiInstance->getReportSchedule($report_schedule_id); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling ReportsApi->getReportSchedule: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **report_schedule_id** | **string**| The identifier for the report schedule. This identifier is unique only in combination with a seller ID. | - -### Return type - -[**\Swagger\Client\Models\GetReportScheduleResponse**](../Model/GetReportScheduleResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **getReportSchedules** -> \Swagger\Client\Models\GetReportSchedulesResponse getReportSchedules($report_types) - - - -Returns report schedule details that match the filters that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\ReportsApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$report_types = array("report_types_example"); // string[] | A list of report types used to filter report schedules. - -try { - $result = $apiInstance->getReportSchedules($report_types); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling ReportsApi->getReportSchedules: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **report_types** | [**string[]**](../Model/string.md)| A list of report types used to filter report schedules. | - -### Return type - -[**\Swagger\Client\Models\GetReportSchedulesResponse**](../Model/GetReportSchedulesResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **getReports** -> \Swagger\Client\Models\GetReportsResponse getReports($report_types, $processing_statuses, $marketplace_ids, $page_size, $created_since, $created_until, $next_token) - - - -Returns report details for the reports that match the filters that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\ReportsApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$report_types = array("report_types_example"); // string[] | A list of report types used to filter reports. When reportTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. Either reportTypes or nextToken is required. -$processing_statuses = array("processing_statuses_example"); // string[] | A list of processing statuses used to filter reports. -$marketplace_ids = array("marketplace_ids_example"); // string[] | A list of marketplace identifiers used to filter reports. The reports returned will match at least one of the marketplaces that you specify. -$page_size = 10; // int | The maximum number of reports to return in a single call. -$created_since = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | The earliest report creation date and time for reports to include in the response, in ISO 8601 date time format. The default is 90 days ago. Reports are retained for a maximum of 90 days. -$created_until = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | The latest report creation date and time for reports to include in the response, in ISO 8601 date time format. The default is now. -$next_token = "next_token_example"; // string | A string token returned in the response to your previous request. nextToken is returned when the number of results exceeds the specified pageSize value. To get the next page of results, call the getReports operation and include this token as the only parameter. Specifying nextToken with any other parameters will cause the request to fail. - -try { - $result = $apiInstance->getReports($report_types, $processing_statuses, $marketplace_ids, $page_size, $created_since, $created_until, $next_token); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling ReportsApi->getReports: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **report_types** | [**string[]**](../Model/string.md)| A list of report types used to filter reports. When reportTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. Either reportTypes or nextToken is required. | [optional] - **processing_statuses** | [**string[]**](../Model/string.md)| A list of processing statuses used to filter reports. | [optional] - **marketplace_ids** | [**string[]**](../Model/string.md)| A list of marketplace identifiers used to filter reports. The reports returned will match at least one of the marketplaces that you specify. | [optional] - **page_size** | **int**| The maximum number of reports to return in a single call. | [optional] [default to 10] - **created_since** | **\DateTime**| The earliest report creation date and time for reports to include in the response, in ISO 8601 date time format. The default is 90 days ago. Reports are retained for a maximum of 90 days. | [optional] - **created_until** | **\DateTime**| The latest report creation date and time for reports to include in the response, in ISO 8601 date time format. The default is now. | [optional] - **next_token** | **string**| A string token returned in the response to your previous request. nextToken is returned when the number of results exceeds the specified pageSize value. To get the next page of results, call the getReports operation and include this token as the only parameter. Specifying nextToken with any other parameters will cause the request to fail. | [optional] - -### Return type - -[**\Swagger\Client\Models\GetReportsResponse**](../Model/GetReportsResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - From 3d2b50f2d22f825d49f2c618884031b26f94e1dd Mon Sep 17 00:00:00 2001 From: rodrigojob Date: Sat, 21 Nov 2020 16:41:05 -0300 Subject: [PATCH 15/25] Delete SalesApi.md --- SalesApi.md | 80 ----------------------------------------------------- 1 file changed, 80 deletions(-) delete mode 100644 SalesApi.md diff --git a/SalesApi.md b/SalesApi.md deleted file mode 100644 index 140bdc42..00000000 --- a/SalesApi.md +++ /dev/null @@ -1,80 +0,0 @@ -# Swagger\Client\SalesApi - -All URIs are relative to *https://sellingpartnerapi-na.amazon.com/* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getOrderMetrics**](SalesApi.md#getordermetrics) | **GET** /sales/v1/orderMetrics | - -# **getOrderMetrics** -> \Swagger\Client\Models\GetOrderMetricsResponse getOrderMetrics($marketplace_ids, $interval, $granularity, $granularity_time_zone, $buyer_type, $fulfillment_network, $first_day_of_week, $asin, $sku) - - - -Returns aggregated order metrics for given interval, broken down by granularity, for given buyer type. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | .5 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\SalesApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$marketplace_ids = array("marketplace_ids_example"); // string[] | A list of marketplace identifiers. Example: ATVPDKIKX0DER indicates the US marketplace. -$interval = "interval_example"; // string | A time interval used for selecting order metrics. This takes the form of two dates separated by two hyphens (first date is inclusive; second date is exclusive). Dates are in ISO8601 format and must represent absolute time (either Z notation or offset notation). Example: 2018-09-01T00:00:00-07:00--2018-09-04T00:00:00-07:00 requests order metrics for Sept 1st, 2nd and 3rd in the -07:00 zone. -$granularity = "granularity_example"; // string | The granularity of the grouping of order metrics, based on a unit of time. Specifying granularity=Hour results in a successful request only if the interval specified is less than or equal to 30 days from now. For all other granularities, the interval specified must be less or equal to 2 years from now. Specifying granularity=Total results in order metrics that are aggregated over the entire interval that you specify. If the interval start and end date don’t align with the specified granularity, the head and tail end of the response interval will contain partial data. Example: Day to get a daily breakdown of the request interval, where the day boundary is defined by the granularityTimeZone. -$granularity_time_zone = "granularity_time_zone_example"; // string | An IANA-compatible time zone for determining the day boundary. Required when specifying a granularity value greater than Hour. The granularityTimeZone value must align with the offset of the specified interval value. For example, if the interval value uses Z notation, then granularityTimeZone must be UTC. If the interval value uses an offset, then granularityTimeZone must be an IANA-compatible time zone that matches the offset. Example: US/Pacific to compute day boundaries, accounting for daylight time savings, for US/Pacific zone. -$buyer_type = "All"; // string | Filters the results by the buyer type that you specify, B2B (business to business) or B2C (business to customer). Example: B2B, if you want the response to include order metrics for only B2B buyers. -$fulfillment_network = "fulfillment_network_example"; // string | Filters the results by the fulfillment network that you specify, MFN (merchant fulfillment network) or AFN (Amazon fulfillment network). Do not include this filter if you want the response to include order metrics for all fulfillment networks. Example: AFN, if you want the response to include order metrics for only Amazon fulfillment network. -$first_day_of_week = "Monday"; // string | Specifies the day that the week starts on when granularity=Week, either Monday or Sunday. Default: Monday. Example: Sunday, if you want the week to start on a Sunday. -$asin = "asin_example"; // string | Filters the results by the ASIN that you specify. Specifying both ASIN and SKU returns an error. Do not include this filter if you want the response to include order metrics for all ASINs. Example: B0792R1RSN, if you want the response to include order metrics for only ASIN B0792R1RSN. -$sku = "sku_example"; // string | Filters the results by the SKU that you specify. Specifying both ASIN and SKU returns an error. Do not include this filter if you want the response to include order metrics for all SKUs. Example: TestSKU, if you want the response to include order metrics for only SKU TestSKU. - -try { - $result = $apiInstance->getOrderMetrics($marketplace_ids, $interval, $granularity, $granularity_time_zone, $buyer_type, $fulfillment_network, $first_day_of_week, $asin, $sku); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling SalesApi->getOrderMetrics: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **marketplace_ids** | [**string[]**](../Model/string.md)| A list of marketplace identifiers. Example: ATVPDKIKX0DER indicates the US marketplace. | - **interval** | **string**| A time interval used for selecting order metrics. This takes the form of two dates separated by two hyphens (first date is inclusive; second date is exclusive). Dates are in ISO8601 format and must represent absolute time (either Z notation or offset notation). Example: 2018-09-01T00:00:00-07:00--2018-09-04T00:00:00-07:00 requests order metrics for Sept 1st, 2nd and 3rd in the -07:00 zone. | - **granularity** | **string**| The granularity of the grouping of order metrics, based on a unit of time. Specifying granularity=Hour results in a successful request only if the interval specified is less than or equal to 30 days from now. For all other granularities, the interval specified must be less or equal to 2 years from now. Specifying granularity=Total results in order metrics that are aggregated over the entire interval that you specify. If the interval start and end date don’t align with the specified granularity, the head and tail end of the response interval will contain partial data. Example: Day to get a daily breakdown of the request interval, where the day boundary is defined by the granularityTimeZone. | - **granularity_time_zone** | **string**| An IANA-compatible time zone for determining the day boundary. Required when specifying a granularity value greater than Hour. The granularityTimeZone value must align with the offset of the specified interval value. For example, if the interval value uses Z notation, then granularityTimeZone must be UTC. If the interval value uses an offset, then granularityTimeZone must be an IANA-compatible time zone that matches the offset. Example: US/Pacific to compute day boundaries, accounting for daylight time savings, for US/Pacific zone. | [optional] - **buyer_type** | **string**| Filters the results by the buyer type that you specify, B2B (business to business) or B2C (business to customer). Example: B2B, if you want the response to include order metrics for only B2B buyers. | [optional] [default to All] - **fulfillment_network** | **string**| Filters the results by the fulfillment network that you specify, MFN (merchant fulfillment network) or AFN (Amazon fulfillment network). Do not include this filter if you want the response to include order metrics for all fulfillment networks. Example: AFN, if you want the response to include order metrics for only Amazon fulfillment network. | [optional] - **first_day_of_week** | **string**| Specifies the day that the week starts on when granularity=Week, either Monday or Sunday. Default: Monday. Example: Sunday, if you want the week to start on a Sunday. | [optional] [default to Monday] - **asin** | **string**| Filters the results by the ASIN that you specify. Specifying both ASIN and SKU returns an error. Do not include this filter if you want the response to include order metrics for all ASINs. Example: B0792R1RSN, if you want the response to include order metrics for only ASIN B0792R1RSN. | [optional] - **sku** | **string**| Filters the results by the SKU that you specify. Specifying both ASIN and SKU returns an error. Do not include this filter if you want the response to include order metrics for all SKUs. Example: TestSKU, if you want the response to include order metrics for only SKU TestSKU. | [optional] - -### Return type - -[**\Swagger\Client\Models\GetOrderMetricsResponse**](../Model/GetOrderMetricsResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, payload - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - From 561bf80e401ed896be7f4010d981e9f20039e614 Mon Sep 17 00:00:00 2001 From: rodrigojob Date: Sat, 21 Nov 2020 16:41:24 -0300 Subject: [PATCH 16/25] Delete SellersApi.md --- SellersApi.md | 60 --------------------------------------------------- 1 file changed, 60 deletions(-) delete mode 100644 SellersApi.md diff --git a/SellersApi.md b/SellersApi.md deleted file mode 100644 index 47ba4eeb..00000000 --- a/SellersApi.md +++ /dev/null @@ -1,60 +0,0 @@ -# Swagger\Client\SellersApi - -All URIs are relative to *https://sellingpartnerapi-na.amazon.com/* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getMarketplaceParticipations**](SellersApi.md#getmarketplaceparticipations) | **GET** /sellers/v1/marketplaceParticipations | - -# **getMarketplaceParticipations** -> \Swagger\Client\Models\GetMarketplaceParticipationsResponse getMarketplaceParticipations() - - - -Returns a list of marketplaces that the seller submitting the request can sell in and information about the seller's participation in those marketplaces. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | .016 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\SellersApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); - -try { - $result = $apiInstance->getMarketplaceParticipations(); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling SellersApi->getMarketplaceParticipations: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**\Swagger\Client\Models\GetMarketplaceParticipationsResponse**](../Model/GetMarketplaceParticipationsResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, payload - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - From 5df03162fc064851c0fcaa21e3caa569eee84c42 Mon Sep 17 00:00:00 2001 From: rodrigojob Date: Sat, 21 Nov 2020 16:41:38 -0300 Subject: [PATCH 17/25] Delete ServiceApi.md --- ServiceApi.md | 381 -------------------------------------------------- 1 file changed, 381 deletions(-) delete mode 100644 ServiceApi.md diff --git a/ServiceApi.md b/ServiceApi.md deleted file mode 100644 index e1c03729..00000000 --- a/ServiceApi.md +++ /dev/null @@ -1,381 +0,0 @@ -# Swagger\Client\ServiceApi - -All URIs are relative to *https://sellingpartnerapi-na.amazon.com/* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**addAppointmentForServiceJobByServiceJobId**](ServiceApi.md#addappointmentforservicejobbyservicejobid) | **POST** /service/v1/serviceJobs/{serviceJobId}/appointments | -[**cancelServiceJobByServiceJobId**](ServiceApi.md#cancelservicejobbyservicejobid) | **PUT** /service/v1/serviceJobs/{serviceJobId}/cancellations | -[**completeServiceJobByServiceJobId**](ServiceApi.md#completeservicejobbyservicejobid) | **PUT** /service/v1/serviceJobs/{serviceJobId}/completions | -[**getServiceJobByServiceJobId**](ServiceApi.md#getservicejobbyservicejobid) | **GET** /service/v1/serviceJobs/{serviceJobId} | -[**getServiceJobs**](ServiceApi.md#getservicejobs) | **GET** /service/v1/serviceJobs | -[**rescheduleAppointmentForServiceJobByServiceJobId**](ServiceApi.md#rescheduleappointmentforservicejobbyservicejobid) | **POST** /service/v1/serviceJobs/{serviceJobId}/appointments/{appointmentId} | - -# **addAppointmentForServiceJobByServiceJobId** -> \Swagger\Client\Models\SetAppointmentResponse addAppointmentForServiceJobByServiceJobId($body, $service_job_id) - - - -Adds an appointment to the service job indicated by the service job identifier you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\ServiceApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$body = new \Swagger\Client\Models\AddAppointmentRequest(); // \Swagger\Client\Models\AddAppointmentRequest | Add appointment operation input details. -$service_job_id = "service_job_id_example"; // string | An Amazon defined service job identifier. - -try { - $result = $apiInstance->addAppointmentForServiceJobByServiceJobId($body, $service_job_id); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling ServiceApi->addAppointmentForServiceJobByServiceJobId: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | [**\Swagger\Client\Models\AddAppointmentRequest**](../Model/AddAppointmentRequest.md)| Add appointment operation input details. | - **service_job_id** | **string**| An Amazon defined service job identifier. | - -### Return type - -[**\Swagger\Client\Models\SetAppointmentResponse**](../Model/SetAppointmentResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **cancelServiceJobByServiceJobId** -> \Swagger\Client\Models\CancelServiceJobByServiceJobIdResponse cancelServiceJobByServiceJobId($service_job_id, $cancellation_reason_code) - - - -Cancels the service job indicated by the service job identifier you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\ServiceApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$service_job_id = "service_job_id_example"; // string | An Amazon defined service job identifier. -$cancellation_reason_code = "cancellation_reason_code_example"; // string | A cancel reason code that specifies the reason for cancelling a service job. - -try { - $result = $apiInstance->cancelServiceJobByServiceJobId($service_job_id, $cancellation_reason_code); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling ServiceApi->cancelServiceJobByServiceJobId: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **service_job_id** | **string**| An Amazon defined service job identifier. | - **cancellation_reason_code** | **string**| A cancel reason code that specifies the reason for cancelling a service job. | - -### Return type - -[**\Swagger\Client\Models\CancelServiceJobByServiceJobIdResponse**](../Model/CancelServiceJobByServiceJobIdResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **completeServiceJobByServiceJobId** -> \Swagger\Client\Models\CompleteServiceJobByServiceJobIdResponse completeServiceJobByServiceJobId($service_job_id) - - - -Completes the service job indicated by the service job identifier you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\ServiceApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$service_job_id = "service_job_id_example"; // string | An Amazon defined service job identifier. - -try { - $result = $apiInstance->completeServiceJobByServiceJobId($service_job_id); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling ServiceApi->completeServiceJobByServiceJobId: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **service_job_id** | **string**| An Amazon defined service job identifier. | - -### Return type - -[**\Swagger\Client\Models\CompleteServiceJobByServiceJobIdResponse**](../Model/CompleteServiceJobByServiceJobIdResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **getServiceJobByServiceJobId** -> \Swagger\Client\Models\GetServiceJobByServiceJobIdResponse getServiceJobByServiceJobId($service_job_id) - - - -Gets service job details for the service job indicated by the service job identifier you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\ServiceApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$service_job_id = "service_job_id_example"; // string | A service job identifier. - -try { - $result = $apiInstance->getServiceJobByServiceJobId($service_job_id); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling ServiceApi->getServiceJobByServiceJobId: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **service_job_id** | **string**| A service job identifier. | - -### Return type - -[**\Swagger\Client\Models\GetServiceJobByServiceJobIdResponse**](../Model/GetServiceJobByServiceJobIdResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **getServiceJobs** -> \Swagger\Client\Models\GetServiceJobsResponse getServiceJobs($marketplace_ids, $service_order_ids, $service_job_status, $page_token, $page_size, $sort_field, $sort_order, $created_after, $created_before, $last_updated_after, $last_updated_before, $schedule_start_date, $schedule_end_date) - - - -Gets service job details for the specified filter query. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\ServiceApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$marketplace_ids = array("marketplace_ids_example"); // string[] | Used to select jobs that were placed in the specified marketplaces. -$service_order_ids = array("service_order_ids_example"); // string[] | List of service order ids for the query you want to perform.Max values supported 20. -$service_job_status = array("service_job_status_example"); // string[] | A list of one or more job status by which to filter the list of jobs. -$page_token = "page_token_example"; // string | String returned in the response of your previous request. -$page_size = 20; // int | A non-negative integer that indicates the maximum number of jobs to return in the list, Value must be 1 - 20. Default 20. -$sort_field = "sort_field_example"; // string | Sort fields on which you want to sort the output. -$sort_order = "sort_order_example"; // string | sort order for the query you want to perform. -$created_after = "created_after_example"; // string | A date used for selecting jobs created after (or at) a specified time must be in ISO 8601 format. Required if LastUpdatedAfter is not specified.Specifying both CreatedAfter and LastUpdatedAfter returns an error. -$created_before = "created_before_example"; // string | A date used for selecting jobs created before (or at) a specified time must be in ISO 8601 format. -$last_updated_after = "last_updated_after_example"; // string | A date used for selecting jobs updated after (or at) a specified time must be in ISO 8601 format. Required if createdAfter is not specified.Specifying both CreatedAfter and LastUpdatedAfter returns an error. -$last_updated_before = "last_updated_before_example"; // string | A date used for selecting jobs updated before (or at) a specified time must be in ISO 8601 format. -$schedule_start_date = "schedule_start_date_example"; // string | A date used for filtering jobs schedule after (or at) a specified time must be in ISO 8601 format. schedule end date should not be earlier than schedule start date. -$schedule_end_date = "schedule_end_date_example"; // string | A date used for filtering jobs schedule before (or at) a specified time must be in ISO 8601 format. schedule end date should not be earlier than schedule start date. - -try { - $result = $apiInstance->getServiceJobs($marketplace_ids, $service_order_ids, $service_job_status, $page_token, $page_size, $sort_field, $sort_order, $created_after, $created_before, $last_updated_after, $last_updated_before, $schedule_start_date, $schedule_end_date); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling ServiceApi->getServiceJobs: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **marketplace_ids** | [**string[]**](../Model/string.md)| Used to select jobs that were placed in the specified marketplaces. | - **service_order_ids** | [**string[]**](../Model/string.md)| List of service order ids for the query you want to perform.Max values supported 20. | [optional] - **service_job_status** | [**string[]**](../Model/string.md)| A list of one or more job status by which to filter the list of jobs. | [optional] - **page_token** | **string**| String returned in the response of your previous request. | [optional] - **page_size** | **int**| A non-negative integer that indicates the maximum number of jobs to return in the list, Value must be 1 - 20. Default 20. | [optional] [default to 20] - **sort_field** | **string**| Sort fields on which you want to sort the output. | [optional] - **sort_order** | **string**| sort order for the query you want to perform. | [optional] - **created_after** | **string**| A date used for selecting jobs created after (or at) a specified time must be in ISO 8601 format. Required if LastUpdatedAfter is not specified.Specifying both CreatedAfter and LastUpdatedAfter returns an error. | [optional] - **created_before** | **string**| A date used for selecting jobs created before (or at) a specified time must be in ISO 8601 format. | [optional] - **last_updated_after** | **string**| A date used for selecting jobs updated after (or at) a specified time must be in ISO 8601 format. Required if createdAfter is not specified.Specifying both CreatedAfter and LastUpdatedAfter returns an error. | [optional] - **last_updated_before** | **string**| A date used for selecting jobs updated before (or at) a specified time must be in ISO 8601 format. | [optional] - **schedule_start_date** | **string**| A date used for filtering jobs schedule after (or at) a specified time must be in ISO 8601 format. schedule end date should not be earlier than schedule start date. | [optional] - **schedule_end_date** | **string**| A date used for filtering jobs schedule before (or at) a specified time must be in ISO 8601 format. schedule end date should not be earlier than schedule start date. | [optional] - -### Return type - -[**\Swagger\Client\Models\GetServiceJobsResponse**](../Model/GetServiceJobsResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **rescheduleAppointmentForServiceJobByServiceJobId** -> \Swagger\Client\Models\SetAppointmentResponse rescheduleAppointmentForServiceJobByServiceJobId($body, $service_job_id, $appointment_id) - - - -Reschedules an appointment for the service job indicated by the service job identifier you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\ServiceApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$body = new \Swagger\Client\Models\RescheduleAppointmentRequest(); // \Swagger\Client\Models\RescheduleAppointmentRequest | Reschedule appointment operation input details. -$service_job_id = "service_job_id_example"; // string | An Amazon defined service job identifier. -$appointment_id = "appointment_id_example"; // string | An existing appointment identifier for the Service Job. - -try { - $result = $apiInstance->rescheduleAppointmentForServiceJobByServiceJobId($body, $service_job_id, $appointment_id); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling ServiceApi->rescheduleAppointmentForServiceJobByServiceJobId: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | [**\Swagger\Client\Models\RescheduleAppointmentRequest**](../Model/RescheduleAppointmentRequest.md)| Reschedule appointment operation input details. | - **service_job_id** | **string**| An Amazon defined service job identifier. | - **appointment_id** | **string**| An existing appointment identifier for the Service Job. | - -### Return type - -[**\Swagger\Client\Models\SetAppointmentResponse**](../Model/SetAppointmentResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - From 4aebe4996d2154b98ccb1d1e5b15dfa2d1b3e059 Mon Sep 17 00:00:00 2001 From: rodrigojob Date: Sat, 21 Nov 2020 16:41:58 -0300 Subject: [PATCH 18/25] Delete ShippingApi.md --- ShippingApi.md | 522 ------------------------------------------------- 1 file changed, 522 deletions(-) delete mode 100644 ShippingApi.md diff --git a/ShippingApi.md b/ShippingApi.md deleted file mode 100644 index febffdfa..00000000 --- a/ShippingApi.md +++ /dev/null @@ -1,522 +0,0 @@ -# Swagger\Client\ShippingApi - -All URIs are relative to *https://sellingpartnerapi-na.amazon.com/* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**cancelShipment**](ShippingApi.md#cancelshipment) | **POST** /shipping/v1/shipments/{shipmentId}/cancel | -[**createShipment**](ShippingApi.md#createshipment) | **POST** /shipping/v1/shipments | -[**getAccount**](ShippingApi.md#getaccount) | **GET** /shipping/v1/account | -[**getRates**](ShippingApi.md#getrates) | **POST** /shipping/v1/rates | -[**getShipment**](ShippingApi.md#getshipment) | **GET** /shipping/v1/shipments/{shipmentId} | -[**getTrackingInformation**](ShippingApi.md#gettrackinginformation) | **GET** /shipping/v1/tracking/{trackingId} | -[**purchaseLabels**](ShippingApi.md#purchaselabels) | **POST** /shipping/v1/shipments/{shipmentId}/purchaseLabels | -[**purchaseShipment**](ShippingApi.md#purchaseshipment) | **POST** /shipping/v1/purchaseShipment | -[**retrieveShippingLabel**](ShippingApi.md#retrieveshippinglabel) | **POST** /shipping/v1/shipments/{shipmentId}/containers/{trackingId}/label | - -# **cancelShipment** -> \Swagger\Client\Models\CancelShipmentResponse cancelShipment($shipment_id) - - - -Cancel a shipment by the given shipmentId. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\ShippingApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$shipment_id = "shipment_id_example"; // string | - -try { - $result = $apiInstance->cancelShipment($shipment_id); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling ShippingApi->cancelShipment: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **shipment_id** | **string**| | - -### Return type - -[**\Swagger\Client\Models\CancelShipmentResponse**](../Model/CancelShipmentResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **createShipment** -> \Swagger\Client\Models\CreateShipmentResponse createShipment($body) - - - -Create a new shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\ShippingApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$body = new \Swagger\Client\Models\CreateShipmentRequest(); // \Swagger\Client\Models\CreateShipmentRequest | - -try { - $result = $apiInstance->createShipment($body); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling ShippingApi->createShipment: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | [**\Swagger\Client\Models\CreateShipmentRequest**](../Model/CreateShipmentRequest.md)| | - -### Return type - -[**\Swagger\Client\Models\CreateShipmentResponse**](../Model/CreateShipmentResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **getAccount** -> \Swagger\Client\Models\GetAccountResponse getAccount() - - - -Verify if the current account is valid. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\ShippingApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); - -try { - $result = $apiInstance->getAccount(); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling ShippingApi->getAccount: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**\Swagger\Client\Models\GetAccountResponse**](../Model/GetAccountResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **getRates** -> \Swagger\Client\Models\GetRatesResponse getRates($body) - - - -Get service rates. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\ShippingApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$body = new \Swagger\Client\Models\GetRatesRequest(); // \Swagger\Client\Models\GetRatesRequest | - -try { - $result = $apiInstance->getRates($body); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling ShippingApi->getRates: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | [**\Swagger\Client\Models\GetRatesRequest**](../Model/GetRatesRequest.md)| | - -### Return type - -[**\Swagger\Client\Models\GetRatesResponse**](../Model/GetRatesResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **getShipment** -> \Swagger\Client\Models\GetShipmentResponse getShipment($shipment_id) - - - -Return the entire shipment object for the shipmentId. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\ShippingApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$shipment_id = "shipment_id_example"; // string | - -try { - $result = $apiInstance->getShipment($shipment_id); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling ShippingApi->getShipment: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **shipment_id** | **string**| | - -### Return type - -[**\Swagger\Client\Models\GetShipmentResponse**](../Model/GetShipmentResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **getTrackingInformation** -> \Swagger\Client\Models\GetTrackingInformationResponse getTrackingInformation($tracking_id) - - - -Return the tracking information of a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\ShippingApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$tracking_id = "tracking_id_example"; // string | - -try { - $result = $apiInstance->getTrackingInformation($tracking_id); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling ShippingApi->getTrackingInformation: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **tracking_id** | **string**| | - -### Return type - -[**\Swagger\Client\Models\GetTrackingInformationResponse**](../Model/GetTrackingInformationResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **purchaseLabels** -> \Swagger\Client\Models\PurchaseLabelsResponse purchaseLabels($body, $shipment_id) - - - -Purchase shipping labels based on a given rate. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\ShippingApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$body = new \Swagger\Client\Models\PurchaseLabelsRequest(); // \Swagger\Client\Models\PurchaseLabelsRequest | -$shipment_id = "shipment_id_example"; // string | - -try { - $result = $apiInstance->purchaseLabels($body, $shipment_id); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling ShippingApi->purchaseLabels: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | [**\Swagger\Client\Models\PurchaseLabelsRequest**](../Model/PurchaseLabelsRequest.md)| | - **shipment_id** | **string**| | - -### Return type - -[**\Swagger\Client\Models\PurchaseLabelsResponse**](../Model/PurchaseLabelsResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **purchaseShipment** -> \Swagger\Client\Models\PurchaseShipmentResponse purchaseShipment($body) - - - -Purchase shipping labels. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\ShippingApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$body = new \Swagger\Client\Models\PurchaseShipmentRequest(); // \Swagger\Client\Models\PurchaseShipmentRequest | - -try { - $result = $apiInstance->purchaseShipment($body); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling ShippingApi->purchaseShipment: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | [**\Swagger\Client\Models\PurchaseShipmentRequest**](../Model/PurchaseShipmentRequest.md)| | - -### Return type - -[**\Swagger\Client\Models\PurchaseShipmentResponse**](../Model/PurchaseShipmentResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **retrieveShippingLabel** -> \Swagger\Client\Models\RetrieveShippingLabelResponse retrieveShippingLabel($body, $shipment_id, $tracking_id) - - - -Retrieve shipping label based on the shipment id and tracking id. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\ShippingApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$body = new \Swagger\Client\Models\RetrieveShippingLabelRequest(); // \Swagger\Client\Models\RetrieveShippingLabelRequest | -$shipment_id = "shipment_id_example"; // string | -$tracking_id = "tracking_id_example"; // string | - -try { - $result = $apiInstance->retrieveShippingLabel($body, $shipment_id, $tracking_id); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling ShippingApi->retrieveShippingLabel: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | [**\Swagger\Client\Models\RetrieveShippingLabelRequest**](../Model/RetrieveShippingLabelRequest.md)| | - **shipment_id** | **string**| | - **tracking_id** | **string**| | - -### Return type - -[**\Swagger\Client\Models\RetrieveShippingLabelResponse**](../Model/RetrieveShippingLabelResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - From 1adcf55278c51493d99e80cbeb78d8cab2b11327 Mon Sep 17 00:00:00 2001 From: rodrigojob Date: Sat, 21 Nov 2020 16:42:03 -0300 Subject: [PATCH 19/25] Delete SolicitationsApi.md --- SolicitationsApi.md | 125 -------------------------------------------- 1 file changed, 125 deletions(-) delete mode 100644 SolicitationsApi.md diff --git a/SolicitationsApi.md b/SolicitationsApi.md deleted file mode 100644 index cd6b1d0a..00000000 --- a/SolicitationsApi.md +++ /dev/null @@ -1,125 +0,0 @@ -# Swagger\Client\SolicitationsApi - -All URIs are relative to *https://sellingpartnerapi-na.amazon.com/* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createProductReviewAndSellerFeedbackSolicitation**](SolicitationsApi.md#createproductreviewandsellerfeedbacksolicitation) | **POST** /solicitations/v1/orders/{amazonOrderId}/solicitations/productReviewAndSellerFeedback | -[**getSolicitationActionsForOrder**](SolicitationsApi.md#getsolicitationactionsfororder) | **GET** /solicitations/v1/orders/{amazonOrderId} | - -# **createProductReviewAndSellerFeedbackSolicitation** -> \Swagger\Client\Models\CreateProductReviewAndSellerFeedbackSolicitationResponse createProductReviewAndSellerFeedbackSolicitation($amazon_order_id, $marketplace_ids) - - - -Sends a solicitation to a buyer asking for seller feedback and a product review for the specified order. Send only one productReviewAndSellerFeedback or free form proactive message per order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.1 | 5 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\SolicitationsApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$amazon_order_id = "amazon_order_id_example"; // string | An Amazon order identifier. This specifies the order for which a solicitation is sent. -$marketplace_ids = array("marketplace_ids_example"); // string[] | A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. - -try { - $result = $apiInstance->createProductReviewAndSellerFeedbackSolicitation($amazon_order_id, $marketplace_ids); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling SolicitationsApi->createProductReviewAndSellerFeedbackSolicitation: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **amazon_order_id** | **string**| An Amazon order identifier. This specifies the order for which a solicitation is sent. | - **marketplace_ids** | [**string[]**](../Model/string.md)| A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. | - -### Return type - -[**\Swagger\Client\Models\CreateProductReviewAndSellerFeedbackSolicitationResponse**](../Model/CreateProductReviewAndSellerFeedbackSolicitationResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/hal+json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **getSolicitationActionsForOrder** -> \Swagger\Client\Models\GetSolicitationActionsForOrderResponse getSolicitationActionsForOrder($amazon_order_id, $marketplace_ids) - - - -Returns a list of solicitation types that are available for an order that you specify. A solicitation type is represented by an actions object, which contains a path and query parameter(s). You can use the path and parameter(s) to call an operation that sends a solicitation. Currently only the productReviewAndSellerFeedbackSolicitation solicitation type is available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.1 | 5 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\SolicitationsApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$amazon_order_id = "amazon_order_id_example"; // string | An Amazon order identifier. This specifies the order for which you want a list of available solicitation types. -$marketplace_ids = array("marketplace_ids_example"); // string[] | A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. - -try { - $result = $apiInstance->getSolicitationActionsForOrder($amazon_order_id, $marketplace_ids); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling SolicitationsApi->getSolicitationActionsForOrder: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **amazon_order_id** | **string**| An Amazon order identifier. This specifies the order for which you want a list of available solicitation types. | - **marketplace_ids** | [**string[]**](../Model/string.md)| A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. | - -### Return type - -[**\Swagger\Client\Models\GetSolicitationActionsForOrderResponse**](../Model/GetSolicitationActionsForOrderResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/hal+json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - From 3c30849bff7e8a9218e30d3731739fcfe8e99cbc Mon Sep 17 00:00:00 2001 From: rodrigojob Date: Sat, 21 Nov 2020 16:42:35 -0300 Subject: [PATCH 20/25] Delete SmallAndLightApi.md --- SmallAndLightApi.md | 299 -------------------------------------------- 1 file changed, 299 deletions(-) delete mode 100644 SmallAndLightApi.md diff --git a/SmallAndLightApi.md b/SmallAndLightApi.md deleted file mode 100644 index 79485b4f..00000000 --- a/SmallAndLightApi.md +++ /dev/null @@ -1,299 +0,0 @@ -# Swagger\Client\SmallAndLightApi - -All URIs are relative to *https://sellingpartnerapi-na.amazon.com/* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**deleteSmallAndLightEnrollmentBySellerSKU**](SmallAndLightApi.md#deletesmallandlightenrollmentbysellersku) | **DELETE** /fba/smallAndLight/v1/enrollments/{sellerSKU} | -[**getSmallAndLightEligibilityBySellerSKU**](SmallAndLightApi.md#getsmallandlighteligibilitybysellersku) | **GET** /fba/smallAndLight/v1/eligibilities/{sellerSKU} | -[**getSmallAndLightEnrollmentBySellerSKU**](SmallAndLightApi.md#getsmallandlightenrollmentbysellersku) | **GET** /fba/smallAndLight/v1/enrollments/{sellerSKU} | -[**getSmallAndLightFeePreview**](SmallAndLightApi.md#getsmallandlightfeepreview) | **POST** /fba/smallAndLight/v1/feePreviews | -[**putSmallAndLightEnrollmentBySellerSKU**](SmallAndLightApi.md#putsmallandlightenrollmentbysellersku) | **PUT** /fba/smallAndLight/v1/enrollments/{sellerSKU} | - -# **deleteSmallAndLightEnrollmentBySellerSKU** -> deleteSmallAndLightEnrollmentBySellerSKU($seller_sku, $marketplace_ids) - - - -Removes the item indicated by the specified seller SKU from the Small and Light program in the specified marketplace. If the item is not eligible for disenrollment, the ineligibility reasons are returned. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 5 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\SmallAndLightApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$seller_sku = "seller_sku_example"; // string | The seller SKU that identifies the item. -$marketplace_ids = array("marketplace_ids_example"); // string[] | The marketplace in which to remove the item from the Small and Light program. Note: Accepts a single marketplace only. - -try { - $apiInstance->deleteSmallAndLightEnrollmentBySellerSKU($seller_sku, $marketplace_ids); -} catch (Exception $e) { - echo 'Exception when calling SmallAndLightApi->deleteSmallAndLightEnrollmentBySellerSKU: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **seller_sku** | **string**| The seller SKU that identifies the item. | - **marketplace_ids** | [**string[]**](../Model/string.md)| The marketplace in which to remove the item from the Small and Light program. Note: Accepts a single marketplace only. | - -### Return type - -void (empty response body) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **getSmallAndLightEligibilityBySellerSKU** -> \Swagger\Client\Models\SmallAndLightEligibility getSmallAndLightEligibilityBySellerSKU($seller_sku, $marketplace_ids) - - - -Returns the Small and Light program eligibility status of the item indicated by the specified seller SKU in the specified marketplace. If the item is not eligible, the ineligibility reasons are returned. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\SmallAndLightApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$seller_sku = "seller_sku_example"; // string | The seller SKU that identifies the item. -$marketplace_ids = array("marketplace_ids_example"); // string[] | The marketplace for which the eligibility status is retrieved. NOTE: Accepts a single marketplace only. - -try { - $result = $apiInstance->getSmallAndLightEligibilityBySellerSKU($seller_sku, $marketplace_ids); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling SmallAndLightApi->getSmallAndLightEligibilityBySellerSKU: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **seller_sku** | **string**| The seller SKU that identifies the item. | - **marketplace_ids** | [**string[]**](../Model/string.md)| The marketplace for which the eligibility status is retrieved. NOTE: Accepts a single marketplace only. | - -### Return type - -[**\Swagger\Client\Models\SmallAndLightEligibility**](../Model/SmallAndLightEligibility.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **getSmallAndLightEnrollmentBySellerSKU** -> \Swagger\Client\Models\SmallAndLightEnrollment getSmallAndLightEnrollmentBySellerSKU($seller_sku, $marketplace_ids) - - - -Returns the Small and Light enrollment status for the item indicated by the specified seller SKU in the specified marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\SmallAndLightApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$seller_sku = "seller_sku_example"; // string | The seller SKU that identifies the item. -$marketplace_ids = array("marketplace_ids_example"); // string[] | The marketplace for which the enrollment status is retrieved. Note: Accepts a single marketplace only. - -try { - $result = $apiInstance->getSmallAndLightEnrollmentBySellerSKU($seller_sku, $marketplace_ids); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling SmallAndLightApi->getSmallAndLightEnrollmentBySellerSKU: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **seller_sku** | **string**| The seller SKU that identifies the item. | - **marketplace_ids** | [**string[]**](../Model/string.md)| The marketplace for which the enrollment status is retrieved. Note: Accepts a single marketplace only. | - -### Return type - -[**\Swagger\Client\Models\SmallAndLightEnrollment**](../Model/SmallAndLightEnrollment.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **getSmallAndLightFeePreview** -> \Swagger\Client\Models\SmallAndLightFeePreviews getSmallAndLightFeePreview($body) - - - -Returns the Small and Light fee estimates for the specified items. You must include a marketplaceId parameter to retrieve the proper fee estimates for items to be sold in that marketplace. The ordering of items in the response will mirror the order of the items in the request. Duplicate ASIN/price combinations are removed. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 3 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\SmallAndLightApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$body = new \Swagger\Client\Models\SmallAndLightFeePreviewRequest(); // \Swagger\Client\Models\SmallAndLightFeePreviewRequest | - -try { - $result = $apiInstance->getSmallAndLightFeePreview($body); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling SmallAndLightApi->getSmallAndLightFeePreview: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | [**\Swagger\Client\Models\SmallAndLightFeePreviewRequest**](../Model/SmallAndLightFeePreviewRequest.md)| | - -### Return type - -[**\Swagger\Client\Models\SmallAndLightFeePreviews**](../Model/SmallAndLightFeePreviews.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - -# **putSmallAndLightEnrollmentBySellerSKU** -> \Swagger\Client\Models\SmallAndLightEnrollment putSmallAndLightEnrollmentBySellerSKU($seller_sku, $marketplace_ids) - - - -Enrolls the item indicated by the specified seller SKU in the Small and Light program in the specified marketplace. If the item is not eligible, the ineligibility reasons are returned. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 5 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. - -### Example -```php -setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner -$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM -$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM -$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country - -$apiInstance = new Swagger\Client\Api\SmallAndLightApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$seller_sku = "seller_sku_example"; // string | The seller SKU that identifies the item. -$marketplace_ids = array("marketplace_ids_example"); // string[] | The marketplace in which to enroll the item. Note: Accepts a single marketplace only. - -try { - $result = $apiInstance->putSmallAndLightEnrollmentBySellerSKU($seller_sku, $marketplace_ids); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling SmallAndLightApi->putSmallAndLightEnrollmentBySellerSKU: ', $e->getMessage(), PHP_EOL; -} -?> -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **seller_sku** | **string**| The seller SKU that identifies the item. | - **marketplace_ids** | [**string[]**](../Model/string.md)| The marketplace in which to enroll the item. Note: Accepts a single marketplace only. | - -### Return type - -[**\Swagger\Client\Models\SmallAndLightEnrollment**](../Model/SmallAndLightEnrollment.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - From 248d1e0b24d4f0ee6869edd63919371251550f86 Mon Sep 17 00:00:00 2001 From: rodrigojob Date: Sat, 21 Nov 2020 16:44:37 -0300 Subject: [PATCH 21/25] Add request signature Added signature in header of request --- docs/Api/CatalogApi.md | 28 +++++- docs/Api/DefaultApi.md | 36 ++++++- docs/Api/FbaInboundApi.md | 153 +++++++++++++++++++++++++---- docs/Api/FbaInventoryApi.md | 9 +- docs/Api/FbaOutboundApi.md | 90 +++++++++++++++-- docs/Api/FeedsApi.md | 54 ++++++++-- docs/Api/FeesApi.md | 18 +++- docs/Api/MerchantFulfillmentApi.md | 72 ++++++++++++-- docs/Api/NotificationsApi.md | 72 ++++++++++++-- docs/Api/OrdersV0Api.md | 53 ++++++++-- docs/Api/ProductPricingApi.md | 36 ++++++- docs/Api/ReportsApi.md | 81 +++++++++++++-- docs/Api/SalesApi.md | 9 +- docs/Api/SellersApi.md | 9 +- docs/Api/ServiceApi.md | 54 ++++++++-- docs/Api/ShippingApi.md | 81 +++++++++++++-- docs/Api/SmallAndLightApi.md | 45 ++++++++- docs/Api/SolicitationsApi.md | 18 +++- 18 files changed, 816 insertions(+), 102 deletions(-) diff --git a/docs/Api/CatalogApi.md b/docs/Api/CatalogApi.md index 23b389a4..10fe8b6b 100644 --- a/docs/Api/CatalogApi.md +++ b/docs/Api/CatalogApi.md @@ -12,7 +12,6 @@ Method | HTTP request | Description > \Swagger\Client\Models\GetCatalogItemResponse getCatalogItem($marketplace_id, $asin) - Returns a specified item and its attributes. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. ### Example @@ -20,10 +19,17 @@ Returns a specified item and its attributes. **Usage Plan:** | Rate (requests setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\CatalogApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $marketplace_id = "marketplace_id_example"; // string | A marketplace identifier. Specifies the marketplace for the item. $asin = "asin_example"; // string | The Amazon Standard Identification Number (ASIN) of the item. @@ -71,10 +77,17 @@ Returns the parent categories to which an item belongs, based on the specified A setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\CatalogApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $marketplace_id = "marketplace_id_example"; // string | A marketplace identifier. Specifies the marketplace for the item. $asin = "asin_example"; // string | The Amazon Standard Identification Number (ASIN) of the item. @@ -124,10 +137,17 @@ Returns a list of items and their attributes, based on a search query or item id setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\CatalogApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $marketplace_id = "marketplace_id_example"; // string | A marketplace identifier. Specifies the marketplace for which items are returned. $query = "query_example"; // string | Keyword(s) to use to search for items in the catalog. Example: 'harry potter books'. diff --git a/docs/Api/DefaultApi.md b/docs/Api/DefaultApi.md index 3a35e581..6d33fbf3 100644 --- a/docs/Api/DefaultApi.md +++ b/docs/Api/DefaultApi.md @@ -21,10 +21,17 @@ Returns financial event groups for a given date range. **Usage Plan:** | Rate setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\DefaultApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $max_results_per_page = 100; // int | The maximum number of results to return per page. $financial_event_group_started_before = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | A date used for selecting financial event groups that opened before (but not at) a specified date and time, in ISO 8601 format. The date-time must be later than FinancialEventGroupStartedAfter and no later than two minutes before the request was submitted. If FinancialEventGroupStartedAfter and FinancialEventGroupStartedBefore are more than 180 days apart, no financial event groups are returned. @@ -76,10 +83,17 @@ Returns financial events for the specified data range. **Usage Plan:** | Rate setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\DefaultApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $max_results_per_page = 100; // int | The maximum number of results to return per page. $posted_after = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | A date used for selecting financial events posted after (or at) a specified time. The date-time must be no later than two minutes before the request was submitted, in ISO 8601 date time format. @@ -131,10 +145,17 @@ Returns all financial events for the specified financial event group. **Usage P setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\DefaultApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $event_group_id = "event_group_id_example"; // string | The identifier of the financial event group to which the events belong. $max_results_per_page = 100; // int | The maximum number of results to return per page. @@ -184,10 +205,17 @@ Returns all financial events for the specified order. **Usage Plan:** | Rate ( setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\DefaultApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $order_id = "order_id_example"; // string | An Amazon-defined order identifier, in 3-7-7 format. $max_results_per_page = 100; // int | The maximum number of results to return per page. diff --git a/docs/Api/FbaInboundApi.md b/docs/Api/FbaInboundApi.md index c11e3f78..bd3fe92c 100644 --- a/docs/Api/FbaInboundApi.md +++ b/docs/Api/FbaInboundApi.md @@ -34,10 +34,17 @@ Returns information needed to confirm a shipment for pre-order. Call this operat setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\FbaInboundApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $shipment_id = "shipment_id_example"; // string | A shipment identifier originally returned by the createInboundShipmentPlan operation. $need_by_date = new \DateTime("2013-10-20"); // \DateTime | Date that the shipment must arrive at the Amazon fulfillment center to avoid delivery promise breaks for pre-ordered items. Must be in YYYY-MM-DD format. The response to the getPreorderInfo operation returns this value. @@ -87,10 +94,17 @@ Confirms that the seller accepts the Amazon-partnered shipping estimate, agrees setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\FbaInboundApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $shipment_id = "shipment_id_example"; // string | A shipment identifier originally returned by the createInboundShipmentPlan operation. @@ -136,10 +150,17 @@ Returns a new inbound shipment based on the specified shipmentId that was return setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\FbaInboundApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $body = new \Swagger\Client\Models\InboundShipmentRequest(); // \Swagger\Client\Models\InboundShipmentRequest | $shipment_id = "shipment_id_example"; // string | A shipment identifier originally returned by the createInboundShipmentPlan operation. @@ -187,10 +208,17 @@ Returns one or more inbound shipment plans, which provide the information you ne setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\FbaInboundApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $body = new \Swagger\Client\Models\CreateInboundShipmentPlanRequest(); // \Swagger\Client\Models\CreateInboundShipmentPlanRequest | @@ -236,10 +264,17 @@ Initiates the process of estimating the shipping cost for an inbound shipment by setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\FbaInboundApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $shipment_id = "shipment_id_example"; // string | A shipment identifier originally returned by the createInboundShipmentPlan operation. @@ -285,10 +320,17 @@ Returns a bill of lading for a Less Than Truckload/Full Truckload (LTL/FTL) ship setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\FbaInboundApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $shipment_id = "shipment_id_example"; // string | A shipment identifier originally returned by the createInboundShipmentPlan operation. @@ -334,10 +376,17 @@ Returns information that lets a seller know if Amazon recommends sending an item setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\FbaInboundApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $marketplace_id = "marketplace_id_example"; // string | A marketplace identifier. Specifies the marketplace where the product would be stored. $seller_sku_list = array("seller_sku_list_example"); // string[] | A list of SellerSKU values. Used to identify items for which you want inbound guidance for shipment to Amazon's fulfillment network. Note: SellerSKU is qualified by the SellerId, which is included with every Selling Partner API operation that you submit. If you specify a SellerSKU that identifies a variation parent ASIN, this operation returns an error. A variation parent ASIN represents a generic product that cannot be sold. Variation child ASINs represent products that have specific characteristics (such as size and color) and can be sold. @@ -387,10 +436,17 @@ Returns package/pallet labels for faster and more accurate shipment processing a setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\FbaInboundApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $shipment_id = "shipment_id_example"; // string | A shipment identifier originally returned by the createInboundShipmentPlan operation. $page_type = "page_type_example"; // string | The page type to use to print the labels. Submitting a PageType value that is not supported in your marketplace returns an error. @@ -446,10 +502,17 @@ Returns pre-order information, including dates, that a seller needs before confi setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\FbaInboundApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $shipment_id = "shipment_id_example"; // string | A shipment identifier originally returned by the createInboundShipmentPlan operation. $marketplace_id = "marketplace_id_example"; // string | A marketplace identifier. Specifies the marketplace the shipment is tied to. @@ -497,10 +560,17 @@ Returns labeling requirements and item preparation instructions to help prepare setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\FbaInboundApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $ship_to_country_code = "ship_to_country_code_example"; // string | The country code of the country to which the items will be shipped. Note that labeling requirements and item preparation instructions can vary by country. $seller_sku_list = array("seller_sku_list_example"); // string[] | A list of SellerSKU values. Used to identify items for which you want labeling requirements and item preparation instructions for shipment to Amazon's fulfillment network. The SellerSKU is qualified by the Seller ID, which is included with every call to the Seller Partner API. Note: Include seller SKUs that you have used to list items on Amazon's retail website. If you include a seller SKU that you have never used to list an item on Amazon's retail website, the seller SKU is returned in the InvalidSKUList property in the response. @@ -550,10 +620,17 @@ Returns a list of items in a specified inbound shipment, or a list of items that setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\FbaInboundApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $query_type = "query_type_example"; // string | Indicates whether items are returned using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or using NextToken, which continues returning items specified in a previous request. $marketplace_id = "marketplace_id_example"; // string | A marketplace identifier. Specifies the marketplace where the product would be stored. @@ -607,10 +684,17 @@ Returns a list of items in a specified inbound shipment. **Usage Plan:** | Rat setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\FbaInboundApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $shipment_id = "shipment_id_example"; // string | A shipment identifier used for selecting items in a specific inbound shipment. $marketplace_id = "marketplace_id_example"; // string | A marketplace identifier. Specifies the marketplace where the product would be stored. @@ -658,10 +742,17 @@ Returns a list of inbound shipments based on criteria that you specify. **Usage setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\FbaInboundApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $query_type = "query_type_example"; // string | Indicates whether shipments are returned using shipment information (by providing the ShipmentStatusList or ShipmentIdList parameters), using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or by using NextToken to continue returning items specified in a previous request. $marketplace_id = "marketplace_id_example"; // string | A marketplace identifier. Specifies the marketplace where the product would be stored. @@ -719,10 +810,17 @@ Returns current transportation information about an inbound shipment. **Usage P setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\FbaInboundApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $shipment_id = "shipment_id_example"; // string | A shipment identifier originally returned by the createInboundShipmentPlan operation. @@ -768,10 +866,17 @@ Sends transportation information to Amazon about an inbound shipment. **Usage P setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\FbaInboundApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $body = new \Swagger\Client\Models\PutTransportDetailsRequest(); // \Swagger\Client\Models\PutTransportDetailsRequest | $shipment_id = "shipment_id_example"; // string | A shipment identifier originally returned by the createInboundShipmentPlan operation. @@ -819,10 +924,17 @@ Adds, updates, or removes items from the inbound shipment identified by the spec setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\FbaInboundApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $body = new \Swagger\Client\Models\InboundShipmentRequest(); // \Swagger\Client\Models\InboundShipmentRequest | $shipment_id = "shipment_id_example"; // string | A shipment identifier originally returned by the createInboundShipmentPlan operation. @@ -870,10 +982,17 @@ Cancels a previously-confirmed request to ship an inbound shipment using an Amaz setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\FbaInboundApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $shipment_id = "shipment_id_example"; // string | A shipment identifier originally returned by the createInboundShipmentPlan operation. diff --git a/docs/Api/FbaInventoryApi.md b/docs/Api/FbaInventoryApi.md index 8635bb62..1ffcbe70 100644 --- a/docs/Api/FbaInventoryApi.md +++ b/docs/Api/FbaInventoryApi.md @@ -18,10 +18,17 @@ Returns a list of inventory summaries. The summaries returned depend on the pres setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\FbaInventoryApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $granularity_type = "granularity_type_example"; // string | The granularity type for the inventory aggregation level. $granularity_id = "granularity_id_example"; // string | The granularity ID for the inventory aggregation level. diff --git a/docs/Api/FbaOutboundApi.md b/docs/Api/FbaOutboundApi.md index 9e7b53f6..e9459e3a 100644 --- a/docs/Api/FbaOutboundApi.md +++ b/docs/Api/FbaOutboundApi.md @@ -26,10 +26,18 @@ Requests that Amazon stop attempting to fulfill the fulfillment order indicated setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + + $apiInstance = new Swagger\Client\Api\FbaOutboundApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $seller_fulfillment_order_id = "seller_fulfillment_order_id_example"; // string | The identifier assigned to the item by the seller when the fulfillment order was created. @@ -75,10 +83,18 @@ Requests that Amazon ship items from the seller's inventory in Amazon's fulfillm setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + + $apiInstance = new Swagger\Client\Api\FbaOutboundApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $body = new \Swagger\Client\Models\CreateFulfillmentOrderRequest(); // \Swagger\Client\Models\CreateFulfillmentOrderRequest | @@ -124,10 +140,18 @@ Creates a fulfillment return. **Usage Plan:** | Rate (requests per second) | setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + + $apiInstance = new Swagger\Client\Api\FbaOutboundApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $body = new \Swagger\Client\Models\CreateFulfillmentReturnRequest(); // \Swagger\Client\Models\CreateFulfillmentReturnRequest | $seller_fulfillment_order_id = "seller_fulfillment_order_id_example"; // string | An identifier assigned by the seller to the fulfillment order at the time it was created. The seller uses their own records to find the correct SellerFulfillmentOrderId value based on the buyer's request to return items. @@ -175,10 +199,18 @@ Returns the fulfillment order indicated by the specified order identifier. **Us setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + + $apiInstance = new Swagger\Client\Api\FbaOutboundApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $seller_fulfillment_order_id = "seller_fulfillment_order_id_example"; // string | The identifier assigned to the item by the seller when the fulfillment order was created. @@ -224,10 +256,18 @@ Returns a list of fulfillment order previews based on shipping criteria that you setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + + $apiInstance = new Swagger\Client\Api\FbaOutboundApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $body = new \Swagger\Client\Models\GetFulfillmentPreviewRequest(); // \Swagger\Client\Models\GetFulfillmentPreviewRequest | @@ -273,10 +313,18 @@ Returns delivery tracking information for a package in an outbound shipment for setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + + $apiInstance = new Swagger\Client\Api\FbaOutboundApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $package_number = 56; // int | The unencrypted package identifier returned by the getFulfillmentOrder operation. @@ -322,10 +370,18 @@ Returns a list of fulfillment orders fulfilled after (or at) a specified date-ti setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + + $apiInstance = new Swagger\Client\Api\FbaOutboundApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $query_start_date_time = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | A date and time used to select fulfillment orders that were last updated after (or at) a specified time. An update is defined as any change in fulfillment order status, including the creation of a new fulfillment order. $fulfillment_method = array("fulfillment_method_example"); // string[] | Indicates the intended recipient channel for the order. @@ -375,10 +431,18 @@ Returns a list of return reason codes for a seller SKU in a given marketplace. setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + + $apiInstance = new Swagger\Client\Api\FbaOutboundApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $seller_sku = "seller_sku_example"; // string | The seller SKU for which return reason codes are required. $language = "language_example"; // string | The language that the TranslatedDescription property of the ReasonCodeDetails response object should be translated into. @@ -430,10 +494,18 @@ Updates and/or requests shipment for a fulfillment order with an order hold on i setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + + $apiInstance = new Swagger\Client\Api\FbaOutboundApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $body = new \Swagger\Client\Models\UpdateFulfillmentOrderRequest(); // \Swagger\Client\Models\UpdateFulfillmentOrderRequest | $seller_fulfillment_order_id = "seller_fulfillment_order_id_example"; // string | The identifier assigned to the item by the seller when the fulfillment order was created. diff --git a/docs/Api/FeedsApi.md b/docs/Api/FeedsApi.md index 6043795a..9d6a1e73 100644 --- a/docs/Api/FeedsApi.md +++ b/docs/Api/FeedsApi.md @@ -23,10 +23,17 @@ Cancels the feed that you specify. Only feeds with processingStatus=IN_QUEUE can setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\FeedsApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $feed_id = "feed_id_example"; // string | The identifier for the feed. This identifier is unique only in combination with a seller ID. @@ -72,10 +79,17 @@ Creates a feed. Encrypt and upload the contents of the feed document before call setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\FeedsApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $body = new \Swagger\Client\Models\CreateFeedSpecification(); // \Swagger\Client\Models\CreateFeedSpecification | @@ -121,10 +135,17 @@ Creates a feed document for the feed type that you specify. This operation retur setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\FeedsApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $body = new \Swagger\Client\Models\CreateFeedDocumentSpecification(); // \Swagger\Client\Models\CreateFeedDocumentSpecification | @@ -170,10 +191,17 @@ Returns feed details (including the resultDocumentId, if available) for the feed setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\FeedsApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $feed_id = "feed_id_example"; // string | The identifier for the feed. This identifier is unique only in combination with a seller ID. @@ -219,10 +247,17 @@ Returns the information required for retrieving a feed document's contents. This setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\FeedsApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $feed_document_id = "feed_document_id_example"; // string | The identifier of the feed document. @@ -268,10 +303,17 @@ Returns feed details for the feeds that match the filters that you specify. **U setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\FeedsApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $feed_types = array("feed_types_example"); // string[] | A list of feed types used to filter feeds. When feedTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. Either feedTypes or nextToken is required. $marketplace_ids = array("marketplace_ids_example"); // string[] | A list of marketplace identifiers used to filter feeds. The feeds returned will match at least one of the marketplaces that you specify. diff --git a/docs/Api/FeesApi.md b/docs/Api/FeesApi.md index a9d2b9fa..2fc243de 100644 --- a/docs/Api/FeesApi.md +++ b/docs/Api/FeesApi.md @@ -19,10 +19,17 @@ Returns the estimated fees for the item indicated by the specified Asin in the m setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\FeesApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $body = new \Swagger\Client\Models\GetMyFeesEstimateRequest(); // \Swagger\Client\Models\GetMyFeesEstimateRequest | $asin = "asin_example"; // string | The Amazon Standard Identification Number (ASIN) of the item. @@ -70,10 +77,17 @@ Returns the estimated fees for the item indicated by the specified seller SKU in setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\FeesApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $body = new \Swagger\Client\Models\GetMyFeesEstimateRequest(); // \Swagger\Client\Models\GetMyFeesEstimateRequest | $seller_sku = "seller_sku_example"; // string | Used to identify an item in the given marketplace. SellerSKU is qualified by the seller's SellerId, which is included with every operation that you submit. diff --git a/docs/Api/MerchantFulfillmentApi.md b/docs/Api/MerchantFulfillmentApi.md index bd0bdeec..1c197fa7 100644 --- a/docs/Api/MerchantFulfillmentApi.md +++ b/docs/Api/MerchantFulfillmentApi.md @@ -25,10 +25,17 @@ Cancel the shipment indicated by the specified shipment identifier. **Usage Pla setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\MerchantFulfillmentApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $shipment_id = "shipment_id_example"; // string | The Amazon-defined shipment identifier for the shipment to cancel. @@ -74,10 +81,17 @@ Cancel the shipment indicated by the specified shipment identifer. **Usage Plan setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\MerchantFulfillmentApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $shipment_id = "shipment_id_example"; // string | The Amazon-defined shipment identifier for the shipment to cancel. @@ -123,10 +137,17 @@ Create a shipment with the information provided. **Usage Plan:** | Rate (reque setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\MerchantFulfillmentApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $body = new \Swagger\Client\Models\CreateShipmentRequest(); // \Swagger\Client\Models\CreateShipmentRequest | @@ -172,10 +193,17 @@ Gets a list of additional seller inputs required for a ship method. This is gene setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\MerchantFulfillmentApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $body = new \Swagger\Client\Models\GetAdditionalSellerInputsRequest(); // \Swagger\Client\Models\GetAdditionalSellerInputsRequest | @@ -221,10 +249,17 @@ Get a list of additional seller inputs required for a ship method. This is gener setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\MerchantFulfillmentApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $body = new \Swagger\Client\Models\GetAdditionalSellerInputsRequest(); // \Swagger\Client\Models\GetAdditionalSellerInputsRequest | @@ -270,10 +305,17 @@ Returns a list of shipping service offers that satisfy the specified shipment re setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\MerchantFulfillmentApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $body = new \Swagger\Client\Models\GetEligibleShipmentServicesRequest(); // \Swagger\Client\Models\GetEligibleShipmentServicesRequest | @@ -319,10 +361,17 @@ Returns a list of shipping service offers that satisfy the specified shipment re setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\MerchantFulfillmentApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $body = new \Swagger\Client\Models\GetEligibleShipmentServicesRequest(); // \Swagger\Client\Models\GetEligibleShipmentServicesRequest | @@ -368,10 +417,17 @@ Returns the shipment information for an existing shipment. **Usage Plan:** | R setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\MerchantFulfillmentApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $shipment_id = "shipment_id_example"; // string | The Amazon-defined shipment identifier for the shipment. diff --git a/docs/Api/NotificationsApi.md b/docs/Api/NotificationsApi.md index 096aed0a..6af4a6fb 100644 --- a/docs/Api/NotificationsApi.md +++ b/docs/Api/NotificationsApi.md @@ -25,10 +25,17 @@ Creates a destination resource to receive notifications. The createDestination A setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\NotificationsApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $body = new \Swagger\Client\Models\CreateDestinationRequest(); // \Swagger\Client\Models\CreateDestinationRequest | @@ -74,10 +81,17 @@ Creates a subscription for the specified notification type to be delivered to th setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\NotificationsApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $body = new \Swagger\Client\Models\CreateSubscriptionRequest(); // \Swagger\Client\Models\CreateSubscriptionRequest | $notification_type = "notification_type_example"; // string | The type of notification to which you want to subscribe. For more information about notification types, see the Notifications API Use Case Guide. @@ -125,10 +139,17 @@ Deletes the destination that you specify. The deleteDestination API is grantless setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\NotificationsApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $destination_id = "destination_id_example"; // string | The identifier for the destination that you want to delete. @@ -174,10 +195,17 @@ Deletes the subscription indicated by the subscription identifier and notificati setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\NotificationsApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $subscription_id = "subscription_id_example"; // string | The identifier for the subscription that you want to delete. $notification_type = "notification_type_example"; // string | The type of notification to which you want to subscribe. For more information about notification types, see the Notifications API Use Case Guide. @@ -225,10 +253,17 @@ Returns information about the destination that you specify. The getDestination A setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\NotificationsApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $destination_id = "destination_id_example"; // string | The identifier generated when you created the destination. @@ -274,10 +309,17 @@ Returns information about all destinations. The getDestinations API is grantless setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\NotificationsApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); try { @@ -319,10 +361,17 @@ Returns information about subscriptions of the specified notification type. You setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\NotificationsApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $notification_type = "notification_type_example"; // string | The type of notification to which you want to subscribe. For more information about notification types, see the Notifications API Use Case Guide. @@ -368,10 +417,17 @@ Returns information about a subscription for the specified notification type. Th setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\NotificationsApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $subscription_id = "subscription_id_example"; // string | The identifier for the subscription that you want to get. $notification_type = "notification_type_example"; // string | The type of notification to which you want to subscribe. For more information about notification types, see the Notifications API Use Case Guide. diff --git a/docs/Api/OrdersV0Api.md b/docs/Api/OrdersV0Api.md index ac2507ea..b3d9ecdd 100644 --- a/docs/Api/OrdersV0Api.md +++ b/docs/Api/OrdersV0Api.md @@ -22,11 +22,17 @@ Returns the order indicated by the specified order ID. **Usage Plan:** | Rate ```php setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country $apiInstance = new Swagger\Client\Api\OrdersV0Api( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $order_id = "order_id_example"; // string | An Amazon-defined order identifier, in 3-7-7 format. @@ -72,10 +78,17 @@ Returns the shipping address for the order indicated by the specified order ID. setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\OrdersV0Api( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $order_id = "order_id_example"; // string | An orderId is an Amazon-defined order identifier, in 3-7-7 format. @@ -121,10 +134,17 @@ Returns buyer information for the order indicated by the specified order ID. ** setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\OrdersV0Api( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $order_id = "order_id_example"; // string | An orderId is an Amazon-defined order identifier, in 3-7-7 format. @@ -170,10 +190,17 @@ Returns detailed order item information for the order indicated by the specified setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\OrdersV0Api( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $order_id = "order_id_example"; // string | An Amazon-defined order identifier, in 3-7-7 format. $next_token = "next_token_example"; // string | A string token returned in the response of your previous request. @@ -221,10 +248,17 @@ Returns buyer information in the order items of the order indicated by the speci setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\OrdersV0Api( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $order_id = "order_id_example"; // string | An Amazon-defined order identifier, in 3-7-7 format. $next_token = "next_token_example"; // string | A string token returned in the response of your previous request. @@ -272,10 +306,17 @@ Returns orders created or updated during the time frame indicated by the specifi setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\OrdersV0Api( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $marketplace_ids = array("marketplace_ids_example"); // string[] | A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces. $created_after = "created_after_example"; // string | A date used for selecting orders created after (or at) a specified time. Only orders placed after the specified time are returned. Either the CreatedAfter parameter or the LastUpdatedAfter parameter is required. Both cannot be empty. The date must be in ISO 8601 format. diff --git a/docs/Api/ProductPricingApi.md b/docs/Api/ProductPricingApi.md index 292ea390..8c7d772e 100644 --- a/docs/Api/ProductPricingApi.md +++ b/docs/Api/ProductPricingApi.md @@ -21,10 +21,17 @@ Returns competitive pricing information for a seller's offer listings based on s setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\ProductPricingApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $marketplace_id = "marketplace_id_example"; // string | A marketplace identifier. Specifies the marketplace for which prices are returned. $item_type = "item_type_example"; // string | Indicates whether ASIN values or seller SKU values are used to identify items. If you specify Asin, the information in the response will be dependent on the list of Asins you provide in the Asins parameter. If you specify Sku, the information in the response will be dependent on the list of Skus you provide in the Skus parameter. Possible values: Asin, Sku. @@ -76,10 +83,17 @@ Returns the lowest priced offers for a single item based on ASIN. **Usage Plan: setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\ProductPricingApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $marketplace_id = "marketplace_id_example"; // string | A marketplace identifier. Specifies the marketplace for which prices are returned. $item_condition = "item_condition_example"; // string | Filters the offer listings to be considered based on item condition. Possible values: New, Used, Collectible, Refurbished, Club. @@ -129,10 +143,17 @@ Returns the lowest priced offers for a single SKU listing. **Usage Plan:** | R setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\ProductPricingApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $marketplace_id = "marketplace_id_example"; // string | A marketplace identifier. Specifies the marketplace for which prices are returned. $item_condition = "item_condition_example"; // string | Filters the offer listings based on item condition. Possible values: New, Used, Collectible, Refurbished, Club. @@ -182,10 +203,17 @@ Returns pricing information for a seller's offer listings based on seller SKU or setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\ProductPricingApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $marketplace_id = "marketplace_id_example"; // string | A marketplace identifier. Specifies the marketplace for which prices are returned. $item_type = "item_type_example"; // string | Indicates whether ASIN values or seller SKU values are used to identify items. If you specify Asin, the information in the response will be dependent on the list of Asins you provide in the Asins parameter. If you specify Sku, the information in the response will be dependent on the list of Skus you provide in the Skus parameter. diff --git a/docs/Api/ReportsApi.md b/docs/Api/ReportsApi.md index 55f06d13..92ea49a7 100644 --- a/docs/Api/ReportsApi.md +++ b/docs/Api/ReportsApi.md @@ -26,10 +26,17 @@ Cancels the report that you specify. Only reports with processingStatus=IN_QUEUE setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\ReportsApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $report_id = "report_id_example"; // string | The identifier for the report. This identifier is unique only in combination with a seller ID. @@ -75,10 +82,17 @@ Cancels the report schedule that you specify. **Usage Plan:** | Rate (requests setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\ReportsApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $report_schedule_id = "report_schedule_id_example"; // string | The identifier for the report schedule. This identifier is unique only in combination with a seller ID. @@ -124,10 +138,17 @@ Creates a report. **Usage Plan:** | Rate (requests per second) | Burst | | --- setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\ReportsApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $body = new \Swagger\Client\Models\CreateReportSpecification(); // \Swagger\Client\Models\CreateReportSpecification | @@ -173,10 +194,17 @@ Creates a report schedule. If a report schedule with the same report type and ma setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\ReportsApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $body = new \Swagger\Client\Models\CreateReportScheduleSpecification(); // \Swagger\Client\Models\CreateReportScheduleSpecification | @@ -222,10 +250,17 @@ Returns report details (including the reportDocumentId, if available) for the re setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\ReportsApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $report_id = "report_id_example"; // string | The identifier for the report. This identifier is unique only in combination with a seller ID. @@ -271,10 +306,17 @@ Returns the information required for retrieving a report document's contents. Th setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\ReportsApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $report_document_id = "report_document_id_example"; // string | The identifier for the report document. @@ -320,10 +362,17 @@ Returns report schedule details for the report schedule that you specify. **Usa setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\ReportsApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $report_schedule_id = "report_schedule_id_example"; // string | The identifier for the report schedule. This identifier is unique only in combination with a seller ID. @@ -369,10 +418,17 @@ Returns report schedule details that match the filters that you specify. **Usag setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\ReportsApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $report_types = array("report_types_example"); // string[] | A list of report types used to filter report schedules. @@ -418,10 +474,17 @@ Returns report details for the reports that match the filters that you specify. setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\ReportsApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $report_types = array("report_types_example"); // string[] | A list of report types used to filter reports. When reportTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. Either reportTypes or nextToken is required. $processing_statuses = array("processing_statuses_example"); // string[] | A list of processing statuses used to filter reports. diff --git a/docs/Api/SalesApi.md b/docs/Api/SalesApi.md index 8a52e8f7..140bdc42 100644 --- a/docs/Api/SalesApi.md +++ b/docs/Api/SalesApi.md @@ -18,10 +18,17 @@ Returns aggregated order metrics for given interval, broken down by granularity, setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\SalesApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $marketplace_ids = array("marketplace_ids_example"); // string[] | A list of marketplace identifiers. Example: ATVPDKIKX0DER indicates the US marketplace. $interval = "interval_example"; // string | A time interval used for selecting order metrics. This takes the form of two dates separated by two hyphens (first date is inclusive; second date is exclusive). Dates are in ISO8601 format and must represent absolute time (either Z notation or offset notation). Example: 2018-09-01T00:00:00-07:00--2018-09-04T00:00:00-07:00 requests order metrics for Sept 1st, 2nd and 3rd in the -07:00 zone. diff --git a/docs/Api/SellersApi.md b/docs/Api/SellersApi.md index b7a1e671..47ba4eeb 100644 --- a/docs/Api/SellersApi.md +++ b/docs/Api/SellersApi.md @@ -18,10 +18,17 @@ Returns a list of marketplaces that the seller submitting the request can sell i setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\SellersApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); try { diff --git a/docs/Api/ServiceApi.md b/docs/Api/ServiceApi.md index e218e45c..e1c03729 100644 --- a/docs/Api/ServiceApi.md +++ b/docs/Api/ServiceApi.md @@ -23,10 +23,17 @@ Adds an appointment to the service job indicated by the service job identifier y setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\ServiceApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $body = new \Swagger\Client\Models\AddAppointmentRequest(); // \Swagger\Client\Models\AddAppointmentRequest | Add appointment operation input details. $service_job_id = "service_job_id_example"; // string | An Amazon defined service job identifier. @@ -74,10 +81,17 @@ Cancels the service job indicated by the service job identifier you specify. ** setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\ServiceApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $service_job_id = "service_job_id_example"; // string | An Amazon defined service job identifier. $cancellation_reason_code = "cancellation_reason_code_example"; // string | A cancel reason code that specifies the reason for cancelling a service job. @@ -125,10 +139,17 @@ Completes the service job indicated by the service job identifier you specify. setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\ServiceApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $service_job_id = "service_job_id_example"; // string | An Amazon defined service job identifier. @@ -174,10 +195,17 @@ Gets service job details for the service job indicated by the service job identi setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\ServiceApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $service_job_id = "service_job_id_example"; // string | A service job identifier. @@ -223,10 +251,17 @@ Gets service job details for the specified filter query. **Usage Plan:** | Rat setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\ServiceApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $marketplace_ids = array("marketplace_ids_example"); // string[] | Used to select jobs that were placed in the specified marketplaces. $service_order_ids = array("service_order_ids_example"); // string[] | List of service order ids for the query you want to perform.Max values supported 20. @@ -296,10 +331,17 @@ Reschedules an appointment for the service job indicated by the service job iden setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\ServiceApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $body = new \Swagger\Client\Models\RescheduleAppointmentRequest(); // \Swagger\Client\Models\RescheduleAppointmentRequest | Reschedule appointment operation input details. $service_job_id = "service_job_id_example"; // string | An Amazon defined service job identifier. diff --git a/docs/Api/ShippingApi.md b/docs/Api/ShippingApi.md index 891b491a..febffdfa 100644 --- a/docs/Api/ShippingApi.md +++ b/docs/Api/ShippingApi.md @@ -26,10 +26,17 @@ Cancel a shipment by the given shipmentId. **Usage Plan:** | Rate (requests pe setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\ShippingApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $shipment_id = "shipment_id_example"; // string | @@ -75,10 +82,17 @@ Create a new shipment. **Usage Plan:** | Rate (requests per second) | Burst | setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\ShippingApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $body = new \Swagger\Client\Models\CreateShipmentRequest(); // \Swagger\Client\Models\CreateShipmentRequest | @@ -124,10 +138,17 @@ Verify if the current account is valid. **Usage Plan:** | Rate (requests per s setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\ShippingApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); try { @@ -169,10 +190,17 @@ Get service rates. **Usage Plan:** | Rate (requests per second) | Burst | | -- setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\ShippingApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $body = new \Swagger\Client\Models\GetRatesRequest(); // \Swagger\Client\Models\GetRatesRequest | @@ -218,10 +246,17 @@ Return the entire shipment object for the shipmentId. **Usage Plan:** | Rate ( setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\ShippingApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $shipment_id = "shipment_id_example"; // string | @@ -267,10 +302,17 @@ Return the tracking information of a shipment. **Usage Plan:** | Rate (request setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\ShippingApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $tracking_id = "tracking_id_example"; // string | @@ -316,10 +358,17 @@ Purchase shipping labels based on a given rate. **Usage Plan:** | Rate (reques setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\ShippingApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $body = new \Swagger\Client\Models\PurchaseLabelsRequest(); // \Swagger\Client\Models\PurchaseLabelsRequest | $shipment_id = "shipment_id_example"; // string | @@ -367,10 +416,17 @@ Purchase shipping labels. **Usage Plan:** | Rate (requests per second) | Burst setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\ShippingApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $body = new \Swagger\Client\Models\PurchaseShipmentRequest(); // \Swagger\Client\Models\PurchaseShipmentRequest | @@ -416,10 +472,17 @@ Retrieve shipping label based on the shipment id and tracking id. **Usage Plan: setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\ShippingApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $body = new \Swagger\Client\Models\RetrieveShippingLabelRequest(); // \Swagger\Client\Models\RetrieveShippingLabelRequest | $shipment_id = "shipment_id_example"; // string | diff --git a/docs/Api/SmallAndLightApi.md b/docs/Api/SmallAndLightApi.md index 20a83929..79485b4f 100644 --- a/docs/Api/SmallAndLightApi.md +++ b/docs/Api/SmallAndLightApi.md @@ -22,10 +22,17 @@ Removes the item indicated by the specified seller SKU from the Small and Light setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\SmallAndLightApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $seller_sku = "seller_sku_example"; // string | The seller SKU that identifies the item. $marketplace_ids = array("marketplace_ids_example"); // string[] | The marketplace in which to remove the item from the Small and Light program. Note: Accepts a single marketplace only. @@ -72,10 +79,17 @@ Returns the Small and Light program eligibility status of the item indicated by setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\SmallAndLightApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $seller_sku = "seller_sku_example"; // string | The seller SKU that identifies the item. $marketplace_ids = array("marketplace_ids_example"); // string[] | The marketplace for which the eligibility status is retrieved. NOTE: Accepts a single marketplace only. @@ -123,10 +137,17 @@ Returns the Small and Light enrollment status for the item indicated by the spec setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\SmallAndLightApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $seller_sku = "seller_sku_example"; // string | The seller SKU that identifies the item. $marketplace_ids = array("marketplace_ids_example"); // string[] | The marketplace for which the enrollment status is retrieved. Note: Accepts a single marketplace only. @@ -174,10 +195,17 @@ Returns the Small and Light fee estimates for the specified items. You must incl setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\SmallAndLightApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $body = new \Swagger\Client\Models\SmallAndLightFeePreviewRequest(); // \Swagger\Client\Models\SmallAndLightFeePreviewRequest | @@ -223,10 +251,17 @@ Enrolls the item indicated by the specified seller SKU in the Small and Light pr setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\SmallAndLightApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $seller_sku = "seller_sku_example"; // string | The seller SKU that identifies the item. $marketplace_ids = array("marketplace_ids_example"); // string[] | The marketplace in which to enroll the item. Note: Accepts a single marketplace only. diff --git a/docs/Api/SolicitationsApi.md b/docs/Api/SolicitationsApi.md index bbfa85db..cd6b1d0a 100644 --- a/docs/Api/SolicitationsApi.md +++ b/docs/Api/SolicitationsApi.md @@ -19,10 +19,17 @@ Sends a solicitation to a buyer asking for seller feedback and a product review setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\SolicitationsApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $amazon_order_id = "amazon_order_id_example"; // string | An Amazon order identifier. This specifies the order for which a solicitation is sent. $marketplace_ids = array("marketplace_ids_example"); // string[] | A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. @@ -70,10 +77,17 @@ Returns a list of solicitation types that are available for an order that you sp setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner +$config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM +$config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM +$config->setApiKey("region", 'us-east-1'); //region of MarketPlace country + $apiInstance = new Swagger\Client\Api\SolicitationsApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client() + new GuzzleHttp\Client(), + $config ); $amazon_order_id = "amazon_order_id_example"; // string | An Amazon order identifier. This specifies the order for which you want a list of available solicitation types. $marketplace_ids = array("marketplace_ids_example"); // string[] | A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. From 9a5b4035d96e5d6fe55ef3ff5ffdef9465a0db45 Mon Sep 17 00:00:00 2001 From: rodrigojob Date: Sat, 21 Nov 2020 16:46:56 -0300 Subject: [PATCH 22/25] Add signing request Added signature in header of request --- lib/Api/CatalogApi.php | 53 +++--- lib/Api/DefaultApi.php | 61 +++---- lib/Api/FbaInboundApi.php | 256 +++++++++++++++-------------- lib/Api/FbaInventoryApi.php | 16 +- lib/Api/FbaOutboundApi.php | 135 ++++++++------- lib/Api/FeedsApi.php | 118 ++++++------- lib/Api/FeesApi.php | 31 ++-- lib/Api/MerchantFulfillmentApi.php | 121 +++++++------- lib/Api/NotificationsApi.php | 121 +++++++------- lib/Api/OrdersV0Api.php | 119 +++++++------- lib/Api/ProductPricingApi.php | 61 +++---- lib/Api/ReportsApi.php | 136 ++++++++------- lib/Api/SalesApi.php | 16 +- lib/Api/SellersApi.php | 21 +-- lib/Api/ServiceApi.php | 91 +++++----- lib/Api/ShippingApi.php | 136 ++++++++------- lib/Api/SmallAndLightApi.php | 76 +++++---- lib/Api/SolicitationsApi.php | 31 ++-- 18 files changed, 853 insertions(+), 746 deletions(-) diff --git a/lib/Api/CatalogApi.php b/lib/Api/CatalogApi.php index 69641bd1..31673659 100644 --- a/lib/Api/CatalogApi.php +++ b/lib/Api/CatalogApi.php @@ -37,6 +37,7 @@ use Swagger\Client\Configuration; use Swagger\Client\HeaderSelector; use Swagger\Client\ObjectSerializer; +use Swagger\Client\Signature; /** * CatalogApi Class Doc Comment @@ -395,23 +396,18 @@ protected function getCatalogItemRequest($marketplace_id, $asin) } - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $query = \GuzzleHttp\Psr7\build_query($queryParams); + + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'GET', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers - ); - - $query = \GuzzleHttp\Psr7\build_query($queryParams); - return new Request( - 'GET', - $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, - $httpBody + $headersX ); } @@ -722,19 +718,20 @@ protected function listCatalogCategoriesRequest($marketplace_id, $asin = null, $ } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'GET', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -1096,18 +1093,20 @@ protected function listCatalogItemsRequest($marketplace_id, $query = null, $quer } - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $query = \GuzzleHttp\Psr7\build_query($queryParams); + + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'GET', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), diff --git a/lib/Api/DefaultApi.php b/lib/Api/DefaultApi.php index 80d482d2..a2427bcf 100644 --- a/lib/Api/DefaultApi.php +++ b/lib/Api/DefaultApi.php @@ -37,6 +37,7 @@ use Swagger\Client\Configuration; use Swagger\Client\HeaderSelector; use Swagger\Client\ObjectSerializer; +use Swagger\Client\Signature; /** * DefaultApi Class Doc Comment @@ -388,19 +389,20 @@ protected function listFinancialEventGroupsRequest($max_results_per_page = '100' } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'GET', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -711,19 +713,20 @@ protected function listFinancialEventsRequest($max_results_per_page = '100', $po } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'GET', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -1035,19 +1038,20 @@ protected function listFinancialEventsByGroupIdRequest($event_group_id, $max_res } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'GET', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -1359,19 +1363,20 @@ protected function listFinancialEventsByOrderIdRequest($order_id, $max_results_p } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'GET', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), diff --git a/lib/Api/FbaInboundApi.php b/lib/Api/FbaInboundApi.php index f41cbb30..62b45e02 100644 --- a/lib/Api/FbaInboundApi.php +++ b/lib/Api/FbaInboundApi.php @@ -37,6 +37,7 @@ use Swagger\Client\Configuration; use Swagger\Client\HeaderSelector; use Swagger\Client\ObjectSerializer; +use Swagger\Client\Signature; /** * FbaInboundApi Class Doc Comment @@ -409,19 +410,20 @@ protected function confirmPreorderRequest($shipment_id, $need_by_date, $marketpl } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'PUT', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'PUT', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -723,19 +725,20 @@ protected function confirmTransportRequest($shipment_id) } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'POST', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -1051,19 +1054,20 @@ protected function createInboundShipmentRequest($body, $shipment_id) } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'POST', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -1360,19 +1364,20 @@ protected function createInboundShipmentPlanRequest($body) } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'POST', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -1674,19 +1679,20 @@ protected function estimateTransportRequest($shipment_id) } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'POST', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -1988,19 +1994,20 @@ protected function getBillOfLadingRequest($shipment_id) } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'GET', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -2322,19 +2329,20 @@ protected function getInboundGuidanceRequest($marketplace_id, $seller_sku_list = } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'GET', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -2696,19 +2704,20 @@ protected function getLabelsRequest($shipment_id, $page_type, $label_type, $numb } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'GET', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -3025,19 +3034,20 @@ protected function getPreorderInfoRequest($shipment_id, $marketplace_id) } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'GET', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -3359,19 +3369,20 @@ protected function getPrepInstructionsRequest($ship_to_country_code, $seller_sku } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'GET', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -3711,19 +3722,20 @@ protected function getShipmentItemsRequest($query_type, $marketplace_id, $last_u } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'GET', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -4040,19 +4052,20 @@ protected function getShipmentItemsByShipmentIdRequest($shipment_id, $marketplac } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'GET', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -4416,19 +4429,20 @@ protected function getShipmentsRequest($query_type, $marketplace_id, $shipment_s } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'GET', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -4730,19 +4744,20 @@ protected function getTransportDetailsRequest($shipment_id) } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'GET', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -5058,19 +5073,20 @@ protected function putTransportDetailsRequest($body, $shipment_id) } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'PUT', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'PUT', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -5386,19 +5402,20 @@ protected function updateInboundShipmentRequest($body, $shipment_id) } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'PUT', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'PUT', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -5700,19 +5717,20 @@ protected function voidTransportRequest($shipment_id) } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'POST', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), diff --git a/lib/Api/FbaInventoryApi.php b/lib/Api/FbaInventoryApi.php index f93898cb..1d8071ea 100644 --- a/lib/Api/FbaInventoryApi.php +++ b/lib/Api/FbaInventoryApi.php @@ -37,6 +37,7 @@ use Swagger\Client\Configuration; use Swagger\Client\HeaderSelector; use Swagger\Client\ObjectSerializer; +use Swagger\Client\Signature; /** * FbaInventoryApi Class Doc Comment @@ -439,19 +440,20 @@ protected function getInventorySummariesRequest($granularity_type, $granularity_ } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'GET', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), diff --git a/lib/Api/FbaOutboundApi.php b/lib/Api/FbaOutboundApi.php index 20e5abb9..749cbd53 100644 --- a/lib/Api/FbaOutboundApi.php +++ b/lib/Api/FbaOutboundApi.php @@ -379,19 +379,20 @@ protected function cancelFulfillmentOrderRequest($seller_fulfillment_order_id) } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'PUT', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'PUT', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -688,19 +689,20 @@ protected function createFulfillmentOrderRequest($body) } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'POST', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -1016,19 +1018,20 @@ protected function createFulfillmentReturnRequest($body, $seller_fulfillment_ord } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'PUT', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'PUT', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -1330,19 +1333,20 @@ protected function getFulfillmentOrderRequest($seller_fulfillment_order_id) } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'GET', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -1639,19 +1643,20 @@ protected function getFulfillmentPreviewRequest($body) } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'POST', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -1949,19 +1954,20 @@ protected function getPackageTrackingDetailsRequest($package_number) } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'GET', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -2274,19 +2280,20 @@ protected function listAllFulfillmentOrdersRequest($query_start_date_time = null } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'GET', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -2617,19 +2624,20 @@ protected function listReturnReasonCodesRequest($seller_sku, $language, $marketp } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'GET', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -2945,19 +2953,20 @@ protected function updateFulfillmentOrderRequest($body, $seller_fulfillment_orde } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'PUT', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'PUT', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), diff --git a/lib/Api/FeedsApi.php b/lib/Api/FeedsApi.php index 2ec393c8..cd06aa0b 100644 --- a/lib/Api/FeedsApi.php +++ b/lib/Api/FeedsApi.php @@ -15,7 +15,7 @@ * The Selling Partner API for Feeds lets you upload data to Amazon on behalf of a selling partner. * * OpenAPI spec version: 2020-09-04 - * + * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.20 */ @@ -37,6 +37,7 @@ use Swagger\Client\Configuration; use Swagger\Client\HeaderSelector; use Swagger\Client\ObjectSerializer; +use Swagger\Client\Signature; /** * FeedsApi Class Doc Comment @@ -241,7 +242,7 @@ public function cancelFeedWithHttpInfo($feed_id) /** * Operation cancelFeedAsync * - * + * * * @param string $feed_id The identifier for the feed. This identifier is unique only in combination with a seller ID. (required) * @@ -261,7 +262,7 @@ function ($response) { /** * Operation cancelFeedAsyncWithHttpInfo * - * + * * * @param string $feed_id The identifier for the feed. This identifier is unique only in combination with a seller ID. (required) * @@ -387,19 +388,20 @@ protected function cancelFeedRequest($feed_id) } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'DELETE', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'DELETE', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -563,7 +565,7 @@ public function createFeedWithHttpInfo($body) /** * Operation createFeedAsync * - * + * * * @param \Swagger\Client\Models\CreateFeedSpecification $body (required) * @@ -583,7 +585,7 @@ function ($response) { /** * Operation createFeedAsyncWithHttpInfo * - * + * * * @param \Swagger\Client\Models\CreateFeedSpecification $body (required) * @@ -704,19 +706,21 @@ protected function createFeedRequest($body) } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'POST', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); + return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -880,7 +884,7 @@ public function createFeedDocumentWithHttpInfo($body) /** * Operation createFeedDocumentAsync * - * + * * * @param \Swagger\Client\Models\CreateFeedDocumentSpecification $body (required) * @@ -900,7 +904,7 @@ function ($response) { /** * Operation createFeedDocumentAsyncWithHttpInfo * - * + * * * @param \Swagger\Client\Models\CreateFeedDocumentSpecification $body (required) * @@ -1021,19 +1025,20 @@ protected function createFeedDocumentRequest($body) } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'POST', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -1197,7 +1202,7 @@ public function getFeedWithHttpInfo($feed_id) /** * Operation getFeedAsync * - * + * * * @param string $feed_id The identifier for the feed. This identifier is unique only in combination with a seller ID. (required) * @@ -1217,7 +1222,7 @@ function ($response) { /** * Operation getFeedAsyncWithHttpInfo * - * + * * * @param string $feed_id The identifier for the feed. This identifier is unique only in combination with a seller ID. (required) * @@ -1343,19 +1348,20 @@ protected function getFeedRequest($feed_id) } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'GET', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -1519,7 +1525,7 @@ public function getFeedDocumentWithHttpInfo($feed_document_id) /** * Operation getFeedDocumentAsync * - * + * * * @param string $feed_document_id The identifier of the feed document. (required) * @@ -1539,7 +1545,7 @@ function ($response) { /** * Operation getFeedDocumentAsyncWithHttpInfo * - * + * * * @param string $feed_document_id The identifier of the feed document. (required) * @@ -1665,19 +1671,20 @@ protected function getFeedDocumentRequest($feed_document_id) } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'GET', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -1853,7 +1860,7 @@ public function getFeedsWithHttpInfo($feed_types = null, $marketplace_ids = null /** * Operation getFeedsAsync * - * + * * * @param string[] $feed_types A list of feed types used to filter feeds. When feedTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. Either feedTypes or nextToken is required. (optional) * @param string[] $marketplace_ids A list of marketplace identifiers used to filter feeds. The feeds returned will match at least one of the marketplaces that you specify. (optional) @@ -1879,7 +1886,7 @@ function ($response) { /** * Operation getFeedsAsyncWithHttpInfo * - * + * * * @param string[] $feed_types A list of feed types used to filter feeds. When feedTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. Either feedTypes or nextToken is required. (optional) * @param string[] $marketplace_ids A list of marketplace identifiers used to filter feeds. The feeds returned will match at least one of the marketplaces that you specify. (optional) @@ -2040,19 +2047,20 @@ protected function getFeedsRequest($feed_types = null, $marketplace_ids = null, } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'GET', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), diff --git a/lib/Api/FeesApi.php b/lib/Api/FeesApi.php index 350e98de..22cebe49 100644 --- a/lib/Api/FeesApi.php +++ b/lib/Api/FeesApi.php @@ -393,19 +393,20 @@ protected function getMyFeesEstimateForASINRequest($body, $asin) } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'POST', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -722,18 +723,20 @@ protected function getMyFeesEstimateForSKURequest($body, $seller_sku) } - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $query = \GuzzleHttp\Psr7\build_query($queryParams); + + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'POST', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), diff --git a/lib/Api/MerchantFulfillmentApi.php b/lib/Api/MerchantFulfillmentApi.php index cddf7fcf..fb53cc2c 100644 --- a/lib/Api/MerchantFulfillmentApi.php +++ b/lib/Api/MerchantFulfillmentApi.php @@ -37,6 +37,7 @@ use Swagger\Client\Configuration; use Swagger\Client\HeaderSelector; use Swagger\Client\ObjectSerializer; +use Swagger\Client\Signature; /** * MerchantFulfillmentApi Class Doc Comment @@ -379,19 +380,20 @@ protected function cancelShipmentRequest($shipment_id) } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'DELETE', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'DELETE', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -693,19 +695,20 @@ protected function cancelShipmentOldRequest($shipment_id) } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'PUT', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'PUT', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -1002,19 +1005,20 @@ protected function createShipmentRequest($body) } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'POST', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -1311,19 +1315,20 @@ protected function getAdditionalSellerInputsRequest($body) } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'POST', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -1620,19 +1625,20 @@ protected function getAdditionalSellerInputsOldRequest($body) } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'POST', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -1929,19 +1935,20 @@ protected function getEligibleShipmentServicesRequest($body) } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'POST', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -2238,19 +2245,20 @@ protected function getEligibleShipmentServicesOldRequest($body) } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'POST', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -2552,19 +2560,20 @@ protected function getShipmentRequest($shipment_id) } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'GET', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), diff --git a/lib/Api/NotificationsApi.php b/lib/Api/NotificationsApi.php index 4d6f9d6e..9f4742b4 100644 --- a/lib/Api/NotificationsApi.php +++ b/lib/Api/NotificationsApi.php @@ -37,6 +37,7 @@ use Swagger\Client\Configuration; use Swagger\Client\HeaderSelector; use Swagger\Client\ObjectSerializer; +use Swagger\Client\Signature; /** * NotificationsApi Class Doc Comment @@ -390,19 +391,20 @@ protected function createDestinationRequest($body) } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'POST', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -734,19 +736,20 @@ protected function createSubscriptionRequest($body, $notification_type) } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'POST', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -1064,19 +1067,20 @@ protected function deleteDestinationRequest($destination_id) } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'DELETE', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'DELETE', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -1413,19 +1417,20 @@ protected function deleteSubscriptionByIdRequest($subscription_id, $notification } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'DELETE', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'DELETE', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -1743,19 +1748,20 @@ protected function getDestinationRequest($destination_id) } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'GET', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -2054,19 +2060,20 @@ protected function getDestinationsRequest() } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'GET', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -2376,19 +2383,20 @@ protected function getSubscriptionRequest($notification_type) } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'GET', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -2725,19 +2733,20 @@ protected function getSubscriptionByIdRequest($subscription_id, $notification_ty } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'GET', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), diff --git a/lib/Api/OrdersV0Api.php b/lib/Api/OrdersV0Api.php index 021d63c9..9afcc474 100644 --- a/lib/Api/OrdersV0Api.php +++ b/lib/Api/OrdersV0Api.php @@ -15,7 +15,7 @@ * The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools. * * OpenAPI spec version: v0 - * + * * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 3.0.20 */ @@ -37,7 +37,7 @@ use Swagger\Client\Configuration; use Swagger\Client\HeaderSelector; use Swagger\Client\ObjectSerializer; - +use Swagger\Client\Signature; /** * OrdersV0Api Class Doc Comment * @@ -117,6 +117,7 @@ public function getOrderWithHttpInfo($order_id) try { $options = $this->createHttpClientOption(); + try { $response = $this->client->send($request, $options); } catch (RequestException $e) { @@ -225,7 +226,7 @@ public function getOrderWithHttpInfo($order_id) /** * Operation getOrderAsync * - * + * * * @param string $order_id An Amazon-defined order identifier, in 3-7-7 format. (required) * @@ -245,7 +246,7 @@ function ($response) { /** * Operation getOrderAsyncWithHttpInfo * - * + * * * @param string $order_id An Amazon-defined order identifier, in 3-7-7 format. (required) * @@ -371,19 +372,20 @@ protected function getOrderRequest($order_id) } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'GET', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -531,7 +533,7 @@ public function getOrderAddressWithHttpInfo($order_id) /** * Operation getOrderAddressAsync * - * + * * * @param string $order_id An orderId is an Amazon-defined order identifier, in 3-7-7 format. (required) * @@ -551,7 +553,7 @@ function ($response) { /** * Operation getOrderAddressAsyncWithHttpInfo * - * + * * * @param string $order_id An orderId is an Amazon-defined order identifier, in 3-7-7 format. (required) * @@ -677,19 +679,20 @@ protected function getOrderAddressRequest($order_id) } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'GET', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -837,7 +840,7 @@ public function getOrderBuyerInfoWithHttpInfo($order_id) /** * Operation getOrderBuyerInfoAsync * - * + * * * @param string $order_id An orderId is an Amazon-defined order identifier, in 3-7-7 format. (required) * @@ -857,7 +860,7 @@ function ($response) { /** * Operation getOrderBuyerInfoAsyncWithHttpInfo * - * + * * * @param string $order_id An orderId is an Amazon-defined order identifier, in 3-7-7 format. (required) * @@ -983,19 +986,20 @@ protected function getOrderBuyerInfoRequest($order_id) } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'GET', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -1145,7 +1149,7 @@ public function getOrderItemsWithHttpInfo($order_id, $next_token = null) /** * Operation getOrderItemsAsync * - * + * * * @param string $order_id An Amazon-defined order identifier, in 3-7-7 format. (required) * @param string $next_token A string token returned in the response of your previous request. (optional) @@ -1166,7 +1170,7 @@ function ($response) { /** * Operation getOrderItemsAsyncWithHttpInfo * - * + * * * @param string $order_id An Amazon-defined order identifier, in 3-7-7 format. (required) * @param string $next_token A string token returned in the response of your previous request. (optional) @@ -1298,19 +1302,20 @@ protected function getOrderItemsRequest($order_id, $next_token = null) } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'GET', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -1460,7 +1465,7 @@ public function getOrderItemsBuyerInfoWithHttpInfo($order_id, $next_token = null /** * Operation getOrderItemsBuyerInfoAsync * - * + * * * @param string $order_id An Amazon-defined order identifier, in 3-7-7 format. (required) * @param string $next_token A string token returned in the response of your previous request. (optional) @@ -1481,7 +1486,7 @@ function ($response) { /** * Operation getOrderItemsBuyerInfoAsyncWithHttpInfo * - * + * * * @param string $order_id An Amazon-defined order identifier, in 3-7-7 format. (required) * @param string $next_token A string token returned in the response of your previous request. (optional) @@ -1613,19 +1618,20 @@ protected function getOrderItemsBuyerInfoRequest($order_id, $next_token = null) } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'GET', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -1799,7 +1805,7 @@ public function getOrdersWithHttpInfo($marketplace_ids, $created_after = null, $ /** * Operation getOrdersAsync * - * + * * * @param string[] $marketplace_ids A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces. (required) * @param string $created_after A date used for selecting orders created after (or at) a specified time. Only orders placed after the specified time are returned. Either the CreatedAfter parameter or the LastUpdatedAfter parameter is required. Both cannot be empty. The date must be in ISO 8601 format. (optional) @@ -1832,7 +1838,7 @@ function ($response) { /** * Operation getOrdersAsyncWithHttpInfo * - * + * * * @param string[] $marketplace_ids A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces. (required) * @param string $created_after A date used for selecting orders created after (or at) a specified time. Only orders placed after the specified time are returned. Either the CreatedAfter parameter or the LastUpdatedAfter parameter is required. Both cannot be empty. The date must be in ISO 8601 format. (optional) @@ -2050,19 +2056,20 @@ protected function getOrdersRequest($marketplace_ids, $created_after = null, $cr } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'GET', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), diff --git a/lib/Api/ProductPricingApi.php b/lib/Api/ProductPricingApi.php index 8e2caaf0..032543d0 100644 --- a/lib/Api/ProductPricingApi.php +++ b/lib/Api/ProductPricingApi.php @@ -37,6 +37,7 @@ use Swagger\Client\Configuration; use Swagger\Client\HeaderSelector; use Swagger\Client\ObjectSerializer; +use Swagger\Client\Signature; /** * ProductPricingApi Class Doc Comment @@ -414,19 +415,20 @@ protected function getCompetitivePricingRequest($marketplace_id, $item_type, $as } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'GET', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -758,19 +760,20 @@ protected function getItemOffersRequest($marketplace_id, $item_condition, $asin) } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'GET', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -1102,19 +1105,20 @@ protected function getListingOffersRequest($marketplace_id, $item_condition, $se } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'GET', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -1460,19 +1464,20 @@ protected function getPricingRequest($marketplace_id, $item_type, $asins = null, } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'GET', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), diff --git a/lib/Api/ReportsApi.php b/lib/Api/ReportsApi.php index 6c2f3550..8d544e77 100644 --- a/lib/Api/ReportsApi.php +++ b/lib/Api/ReportsApi.php @@ -37,6 +37,7 @@ use Swagger\Client\Configuration; use Swagger\Client\HeaderSelector; use Swagger\Client\ObjectSerializer; +use Swagger\Client\Signature; /** * ReportsApi Class Doc Comment @@ -387,19 +388,20 @@ protected function cancelReportRequest($report_id) } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'DELETE', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'DELETE', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -709,19 +711,20 @@ protected function cancelReportScheduleRequest($report_schedule_id) } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'DELETE', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'DELETE', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -1026,19 +1029,20 @@ protected function createReportRequest($body) } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'POST', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -1343,19 +1347,20 @@ protected function createReportScheduleRequest($body) } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'POST', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -1665,19 +1670,20 @@ protected function getReportRequest($report_id) } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'GET', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -1987,19 +1993,20 @@ protected function getReportDocumentRequest($report_document_id) } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'GET', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -2309,19 +2316,20 @@ protected function getReportScheduleRequest($report_schedule_id) } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'GET', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -2630,19 +2638,20 @@ protected function getReportSchedulesRequest($report_types) } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'GET', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -3005,19 +3014,20 @@ protected function getReportsRequest($report_types = null, $processing_statuses } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'GET', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), diff --git a/lib/Api/SalesApi.php b/lib/Api/SalesApi.php index 1d95e72d..22655fbd 100644 --- a/lib/Api/SalesApi.php +++ b/lib/Api/SalesApi.php @@ -37,6 +37,7 @@ use Swagger\Client\Configuration; use Swagger\Client\HeaderSelector; use Swagger\Client\ObjectSerializer; +use Swagger\Client\Signature; /** * SalesApi Class Doc Comment @@ -470,19 +471,20 @@ protected function getOrderMetricsRequest($marketplace_ids, $interval, $granular } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'GET', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), diff --git a/lib/Api/SellersApi.php b/lib/Api/SellersApi.php index d770e4b5..96338d3a 100644 --- a/lib/Api/SellersApi.php +++ b/lib/Api/SellersApi.php @@ -37,6 +37,7 @@ use Swagger\Client\Configuration; use Swagger\Client\HeaderSelector; use Swagger\Client\ObjectSerializer; +use Swagger\Client\Signature; /** * SellersApi Class Doc Comment @@ -368,24 +369,18 @@ protected function getMarketplaceParticipationsRequest() } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'GET', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers - ); - - $query = \GuzzleHttp\Psr7\build_query($queryParams); - return new Request( - 'GET', - $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, - $httpBody + $headersX ); } diff --git a/lib/Api/ServiceApi.php b/lib/Api/ServiceApi.php index c7a43918..b406145f 100644 --- a/lib/Api/ServiceApi.php +++ b/lib/Api/ServiceApi.php @@ -37,6 +37,7 @@ use Swagger\Client\Configuration; use Swagger\Client\HeaderSelector; use Swagger\Client\ObjectSerializer; +use Swagger\Client\Signature; /** * ServiceApi Class Doc Comment @@ -409,19 +410,20 @@ protected function addAppointmentForServiceJobByServiceJobIdRequest($body, $serv } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'POST', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -754,19 +756,20 @@ protected function cancelServiceJobByServiceJobIdRequest($service_job_id, $cance } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'PUT', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'PUT', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -1084,19 +1087,20 @@ protected function completeServiceJobByServiceJobIdRequest($service_job_id) } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'PUT', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'PUT', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -1414,19 +1418,20 @@ protected function getServiceJobByServiceJobIdRequest($service_job_id) } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'GET', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -1849,19 +1854,20 @@ protected function getServiceJobsRequest($marketplace_ids, $service_order_ids = } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'GET', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -2212,19 +2218,20 @@ protected function rescheduleAppointmentForServiceJobByServiceJobIdRequest($body } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'POST', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), diff --git a/lib/Api/ShippingApi.php b/lib/Api/ShippingApi.php index f0463af1..01de04e6 100644 --- a/lib/Api/ShippingApi.php +++ b/lib/Api/ShippingApi.php @@ -37,6 +37,7 @@ use Swagger\Client\Configuration; use Swagger\Client\HeaderSelector; use Swagger\Client\ObjectSerializer; +use Swagger\Client\Signature; /** * ShippingApi Class Doc Comment @@ -379,19 +380,20 @@ protected function cancelShipmentRequest($shipment_id) } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'POST', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -688,19 +690,20 @@ protected function createShipmentRequest($body) } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'POST', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -983,19 +986,20 @@ protected function getAccountRequest() } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'GET', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -1292,19 +1296,20 @@ protected function getRatesRequest($body) } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'POST', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -1606,19 +1611,20 @@ protected function getShipmentRequest($shipment_id) } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'GET', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -1920,19 +1926,20 @@ protected function getTrackingInformationRequest($tracking_id) } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'GET', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -2248,19 +2255,20 @@ protected function purchaseLabelsRequest($body, $shipment_id) } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'POST', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -2557,19 +2565,20 @@ protected function purchaseShipmentRequest($body) } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'POST', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -2904,19 +2913,20 @@ protected function retrieveShippingLabelRequest($body, $shipment_id, $tracking_i } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'POST', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), diff --git a/lib/Api/SmallAndLightApi.php b/lib/Api/SmallAndLightApi.php index e2cae8fa..81de2759 100644 --- a/lib/Api/SmallAndLightApi.php +++ b/lib/Api/SmallAndLightApi.php @@ -37,6 +37,7 @@ use Swagger\Client\Configuration; use Swagger\Client\HeaderSelector; use Swagger\Client\ObjectSerializer; +use Swagger\Client\Signature; /** * SmallAndLightApi Class Doc Comment @@ -368,19 +369,20 @@ protected function deleteSmallAndLightEnrollmentBySellerSKURequest($seller_sku, } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'DELETE', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'DELETE', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -708,19 +710,20 @@ protected function getSmallAndLightEligibilityBySellerSKURequest($seller_sku, $m } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'GET', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -1048,19 +1051,20 @@ protected function getSmallAndLightEnrollmentBySellerSKURequest($seller_sku, $ma } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'GET', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -1357,19 +1361,20 @@ protected function getSmallAndLightFeePreviewRequest($body) } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'POST', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -1697,19 +1702,20 @@ protected function putSmallAndLightEnrollmentBySellerSKURequest($seller_sku, $ma } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'PUT', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'PUT', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), diff --git a/lib/Api/SolicitationsApi.php b/lib/Api/SolicitationsApi.php index c2a89f46..34dc808e 100644 --- a/lib/Api/SolicitationsApi.php +++ b/lib/Api/SolicitationsApi.php @@ -37,6 +37,7 @@ use Swagger\Client\Configuration; use Swagger\Client\HeaderSelector; use Swagger\Client\ObjectSerializer; +use Swagger\Client\Signature; /** * SolicitationsApi Class Doc Comment @@ -405,19 +406,20 @@ protected function createProductReviewAndSellerFeedbackSolicitationRequest($amaz } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'POST', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), @@ -745,19 +747,20 @@ protected function getSolicitationActionsForOrderRequest($amazon_order_id, $mark } } + $query = \GuzzleHttp\Psr7\build_query($queryParams); - $defaultHeaders = []; - if ($this->config->getUserAgent()) { - $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); - } + $sign = new SignatureSellingPartner(); + $headersX = $sign->calculateSignature($this->config->getApiKey("accessKey"), + $this->config->getApiKey("secretKey"), $this->config->getApiKey("region"), + $this->config->getAccessToken(), $this->config->getUserAgent(), str_replace("https://", "", $this->config->getHost()), + 'GET', $resourcePath, $query); $headers = array_merge( - $defaultHeaders, $headerParams, - $headers + $headers, + $headersX ); - $query = \GuzzleHttp\Psr7\build_query($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), From f54c3988d673b4fc1287281b27ae8a82e0f7e171 Mon Sep 17 00:00:00 2001 From: rodrigojob Date: Sat, 21 Nov 2020 16:48:28 -0300 Subject: [PATCH 23/25] Add Class SignatureSellingPartner This class is used in signature of request when need header signed --- lib/Signature.php | 99 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 99 insertions(+) create mode 100644 lib/Signature.php diff --git a/lib/Signature.php b/lib/Signature.php new file mode 100644 index 00000000..bb52fbbf --- /dev/null +++ b/lib/Signature.php @@ -0,0 +1,99 @@ +JSON Hypertext Application Language (HAL) standard. + * + * OpenAPI spec version: v1 + * + * Generated by: https://github.com/swagger-api/swagger-codegen.git + * Swagger Codegen version: 3.0.20 + */ +/** + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen + * Do not edit the class manually. + */ + +namespace Swagger\Client; + +/** + * Signature Class Doc Comment + * + * @category Class + * @package Swagger\Client + * @author rodrigojob + */ +class SignatureSellingPartner { + + /** + * calculateSignature data + * + * @param string $accessKey the Selling Partner Access Key + * @param string $secretKey the IAM secret + * @param string $region the region use AWS + * @param string $accessToken the Selling Partner access-token + * @param string $userAgent the user-agent to sign + * @param string $host the host to sign + * @param string $method the method to sign + * @param string $uri the uri to sign + * @param string $queryString the queryString to sign + * @param mixed $data the data to sign + * + * @return array headers signed + */ + public static function calculateSignature($accessKey, $secretKey, $region, $accessToken, $userAgent, $host, $method, $uri = "", $queryString = "", $data = array()){ + $service = 'execute-api'; + $terminationString = 'aws4_request'; + $algorithm = 'AWS4-HMAC-SHA256'; + $amzdate = gmdate('Ymd\THis\Z'); + $date = substr($amzdate, 0, 8); + + $param = json_encode($data); + if ($param == "[]") { + $requestPayload = ""; + } else { + $requestPayload = strtolower($param); + } + $hashedPayload = hash('sha256', $requestPayload); + + $canonical_headers = "host:" . $host . "\n" . "user-agent:" . $userAgent . "\n" . "x-amz-access-token:" . $accessToken . "\n" . "x-amz-date:" . $amzdate . "\n"; + $credential_scope = $date . '/' . $region . '/' . $service . '/' . $terminationString; + $signed_headers = 'host;user-agent;x-amz-access-token;x-amz-date'; + + $canonical_request = $method . "\n" . $uri . "\n" . $queryString . "\n" . $canonical_headers . "\n" . $signed_headers . "\n" . $hashedPayload; + + $stringToSign = $algorithm . "\n" . $amzdate . "\n" . $credential_scope . "\n" . hash('sha256', $canonical_request); + + $kSecret = "AWS4" . $secretKey; + $kDate = hash_hmac('sha256', $date, $kSecret, true); + $kRegion = hash_hmac('sha256', $region, $kDate, true); + $kService = hash_hmac('sha256', $service, $kRegion, true); + $kSigning = hash_hmac('sha256', $terminationString, $kService, true); + + $signature = trim(hash_hmac('sha256', $stringToSign, $kSigning)); // Without fourth parameter passed as true, returns lowercase hexits as called for by docs + + $authorization_header = $algorithm . " Credential={$accessKey}/{$credential_scope}, SignedHeaders={$signed_headers}, Signature={$signature}"; + + $headers = array( + "host" => $host, + "Authorization" => $authorization_header, + "user-agent" => $userAgent, + "x-amz-access-token" => $accessToken, + "x-amz-date" => $amzdate + ); + + return $headers; + } + +} From 9aa0df249694201b65dd3c9de2255eba6b897563 Mon Sep 17 00:00:00 2001 From: rodrigojob Date: Sat, 21 Nov 2020 16:49:36 -0300 Subject: [PATCH 24/25] Update README.md Add this repository --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 23e276ba..4bfe8e59 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,8 @@ Just require this package via composer: ``` composer require clousale/amazon-sp-api-php +or +composer require rodrigojob/amazon-sp-api-php ``` # Detailed Documentation @@ -29,4 +31,4 @@ You can find general information about the Amazon Selling Partner API on [the of # Notes -If you're looking for a complete Repricing & FBA-Reimbursement solution, you might want to consider giving [ClouSale.com](https://www.clousale.com) a shot. \ No newline at end of file +If you're looking for a complete Repricing & FBA-Reimbursement solution, you might want to consider giving [ClouSale.com](https://www.clousale.com) a shot. From 204cdbf8d26a3f175cb05428d1d5b6dc1fb1011a Mon Sep 17 00:00:00 2001 From: clousale <72204433+clousale@users.noreply.github.com> Date: Wed, 25 Nov 2020 21:56:22 +0100 Subject: [PATCH 25/25] Update README.md --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4bfe8e59..6ec7093a 100644 --- a/README.md +++ b/README.md @@ -19,8 +19,6 @@ Just require this package via composer: ``` composer require clousale/amazon-sp-api-php -or -composer require rodrigojob/amazon-sp-api-php ``` # Detailed Documentation @@ -32,3 +30,9 @@ You can find general information about the Amazon Selling Partner API on [the of # Notes If you're looking for a complete Repricing & FBA-Reimbursement solution, you might want to consider giving [ClouSale.com](https://www.clousale.com) a shot. + +# Thanks + +Thanks go out to everybody who added PRs and worked on this package: + +- [rodrigojob](https://www.github.com/rodrigojob)