Skip to content

Commit

Permalink
Documentation improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
jlevers committed Apr 11, 2023
1 parent bb25ba8 commit 510b861
Show file tree
Hide file tree
Showing 113 changed files with 578 additions and 512 deletions.
108 changes: 35 additions & 73 deletions docs/Api/OrdersV0Api.md

Large diffs are not rendered by default.

5 changes: 2 additions & 3 deletions docs/Api/ProductTypeDefinitionsV20200901Api.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ $config = new SellingPartnerApi\Configuration([
$apiInstance = new SellingPartnerApi\Api\ProductTypeDefinitionsV20200901Api($config);
$product_type = LUGGAGE; // string | The Amazon product type name.
$marketplace_ids = ATVPDKIKX0DER; // string[] | A comma-delimited list of Amazon marketplace identifiers for the request.
Note: This parameter is limited to one marketplaceId at this time.
// Note: This parameter is limited to one marketplaceId at this time.
$seller_id = 'seller_id_example'; // string | A selling partner identifier. When provided, seller-specific requirements and values are populated within the product type definition schema, such as brand names associated with the selling partner.
$product_type_version = LATEST; // string | The version of the Amazon product type to retrieve. Defaults to \"LATEST\",. Prerelease versions of product type definitions may be retrieved with \"RELEASE_CANDIDATE\". If no prerelease version is currently available, the \"LATEST\" live version will be provided.
$requirements = LISTING; // string | The name of the requirements set to retrieve requirements for.
Expand All @@ -64,8 +64,7 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**product_type** | **string**| The Amazon product type name. |
**marketplace_ids** | [**string[]**](../Model/ProductTypeDefinitionsV20200901/string.md)| A comma-delimited list of Amazon marketplace identifiers for the request.
Note: This parameter is limited to one marketplaceId at this time. |
**marketplace_ids** | [**string[]**](../Model/ProductTypeDefinitionsV20200901/string.md)| A comma-delimited list of Amazon marketplace identifiers for the request.<br>Note: This parameter is limited to one marketplaceId at this time. |
**seller_id** | **string**| A selling partner identifier. When provided, seller-specific requirements and values are populated within the product type definition schema, such as brand names associated with the selling partner. | [optional]
**product_type_version** | **string**| The version of the Amazon product type to retrieve. Defaults to \"LATEST\",. Prerelease versions of product type definitions may be retrieved with \"RELEASE_CANDIDATE\". If no prerelease version is currently available, the \"LATEST\" live version will be provided. | [optional] [default to 'LATEST']
**requirements** | **string**| The name of the requirements set to retrieve requirements for. | [optional] [default to 'LISTING']
Expand Down
7 changes: 2 additions & 5 deletions docs/Api/SalesV1Api.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,7 @@ $config = new SellingPartnerApi\Configuration([

$apiInstance = new SellingPartnerApi\Api\SalesV1Api($config);
$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.

For example, ATVPDKIKX0DER indicates the US marketplace.
// For 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.
Expand All @@ -64,9 +63,7 @@ try {

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**marketplace_ids** | [**string[]**](../Model/SalesV1/string.md)| A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.

For example, ATVPDKIKX0DER indicates the US marketplace. |
**marketplace_ids** | [**string[]**](../Model/SalesV1/string.md)| A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.<br><br>For 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]
Expand Down
10 changes: 3 additions & 7 deletions docs/Api/ShippingV2Api.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,9 +115,8 @@ $apiInstance = new SellingPartnerApi\Api\ShippingV2Api($config);
$body = new \SellingPartnerApi\Model\ShippingV2\DirectPurchaseRequest(); // \SellingPartnerApi\Model\ShippingV2\DirectPurchaseRequest
$x_amzn_idempotency_key = 'x_amzn_idempotency_key_example'; // string | A unique value which the server uses to recognize subsequent retries of the same request.
$locale = 'locale_example'; // string | The IETF Language Tag. Note that this only supports the primary language subtag with one secondary language subtag (i.e. en-US, fr-CA).
The secondary language subtag is almost always a regional designation.
This does not support additional subtags beyond the primary and secondary language subtags.

// The secondary language subtag is almost always a regional designation.
// This does not support additional subtags beyond the primary and secondary language subtags.
$x_amzn_shipping_business_id = 'x_amzn_shipping_business_id_example'; // string | Amazon shipping business to assume for this request. The default is AmazonShipping_UK.

try {
Expand All @@ -134,10 +133,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**\SellingPartnerApi\Model\ShippingV2\DirectPurchaseRequest**](../Model/ShippingV2/DirectPurchaseRequest.md)| |
**x_amzn_idempotency_key** | **string**| A unique value which the server uses to recognize subsequent retries of the same request. | [optional]
**locale** | **string**| The IETF Language Tag. Note that this only supports the primary language subtag with one secondary language subtag (i.e. en-US, fr-CA).
The secondary language subtag is almost always a regional designation.
This does not support additional subtags beyond the primary and secondary language subtags.
| [optional]
**locale** | **string**| The IETF Language Tag. Note that this only supports the primary language subtag with one secondary language subtag (i.e. en-US, fr-CA).<br>The secondary language subtag is almost always a regional designation.<br>This does not support additional subtags beyond the primary and secondary language subtags.<br> | [optional]
**x_amzn_shipping_business_id** | **string**| Amazon shipping business to assume for this request. The default is AmazonShipping_UK. | [optional]

### Return type
Expand Down
4 changes: 1 addition & 3 deletions docs/Model/CatalogItemsV20201201/ItemSearchResults.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,7 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**number_of_results** | **int** | The estimated total number of products matched by the search query (only results up to the page count limit will be returned per request regardless of the number found).

Note: The maximum number of items (ASINs) that can be returned and paged through is 1000. |
**number_of_results** | **int** | The estimated total number of products matched by the search query (only results up to the page count limit will be returned per request regardless of the number found).<br><br>Note: The maximum number of items (ASINs) that can be returned and paged through is 1000. |
**pagination** | [**\SellingPartnerApi\Model\CatalogItemsV20201201\Pagination**](Pagination.md) | |
**refinements** | [**\SellingPartnerApi\Model\CatalogItemsV20201201\Refinements**](Refinements.md) | |
**items** | [**\SellingPartnerApi\Model\CatalogItemsV20201201\Item[]**](Item.md) | A list of items from the Amazon catalog. |
Expand Down
4 changes: 1 addition & 3 deletions docs/Model/CatalogItemsV20220401/ItemSearchResults.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,7 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**number_of_results** | **int** | For `identifiers`-based searches, the total number of Amazon catalog items found. For `keywords`-based searches, the estimated total number of Amazon catalog items matched by the search query (only results up to the page count limit will be returned per request regardless of the number found).

Note: The maximum number of items (ASINs) that can be returned and paged through is 1000. |
**number_of_results** | **int** | For `identifiers`-based searches, the total number of Amazon catalog items found. For `keywords`-based searches, the estimated total number of Amazon catalog items matched by the search query (only results up to the page count limit will be returned per request regardless of the number found).<br><br>Note: The maximum number of items (ASINs) that can be returned and paged through is 1000. |
**pagination** | [**\SellingPartnerApi\Model\CatalogItemsV20220401\Pagination**](Pagination.md) | |
**refinements** | [**\SellingPartnerApi\Model\CatalogItemsV20220401\Refinements**](Refinements.md) | |
**items** | [**\SellingPartnerApi\Model\CatalogItemsV20220401\Item[]**](Item.md) | A list of items from the Amazon catalog. |
Expand Down
7 changes: 1 addition & 6 deletions docs/Model/FbaOutboundV20200701/GetFeatureSkuResult.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,7 @@ Name | Type | Description | Notes
**marketplace_id** | **string** | The requested marketplace. |
**feature_name** | **string** | The name of the feature. |
**is_eligible** | **bool** | When true, the seller SKU is eligible for the requested feature. |
**ineligible_reasons** | **string[]** | A list of one or more reasons that the seller SKU is ineligibile for the feature.

Possible values:
* MERCHANT_NOT_ENROLLED - The merchant isn't enrolled for the feature.
* SKU_NOT_ELIGIBLE - The SKU doesn't reside in a warehouse that supports the feature.
* INVALID_SKU - There is an issue with the SKU provided. | [optional]
**ineligible_reasons** | **string[]** | A list of one or more reasons that the seller SKU is ineligibile for the feature.<br><br>Possible values:<br>* MERCHANT_NOT_ENROLLED - The merchant isn't enrolled for the feature.<br>* SKU_NOT_ELIGIBLE - The SKU doesn't reside in a warehouse that supports the feature.<br>* INVALID_SKU - There is an issue with the SKU provided. | [optional]
**sku_info** | [**\SellingPartnerApi\Model\FbaOutboundV20200701\FeatureSku**](FeatureSku.md) | | [optional]

[[FbaOutboundV20200701 Models]](../) [[API list]](../../Api) [[README]](../../../README.md)
4 changes: 1 addition & 3 deletions docs/Model/FinancesV0/AdhocDisbursementEvent.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,7 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**transaction_type** | **string** | Indicates the type of transaction.

Example: \"Disbursed to Amazon Gift Card balance\" | [optional]
**transaction_type** | **string** | Indicates the type of transaction.<br><br>Example: \"Disbursed to Amazon Gift Card balance\" | [optional]
**posted_date** | **string** | A date string in ISO 8601 format. | [optional]
**transaction_id** | **string** | The identifier for the transaction. | [optional]
**transaction_amount** | [**\SellingPartnerApi\Model\FinancesV0\Currency**](Currency.md) | | [optional]
Expand Down
20 changes: 1 addition & 19 deletions docs/Model/FinancesV0/AdjustmentEvent.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,7 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**adjustment_type** | **string** | The type of adjustment.

Possible values:

* FBAInventoryReimbursement - An FBA inventory reimbursement to a seller's account. This occurs if a seller's inventory is damaged.

* ReserveEvent - A reserve event that is generated at the time of a settlement period closing. This occurs when some money from a seller's account is held back.

* PostageBilling - The amount paid by a seller for shipping labels.

* PostageRefund - The reimbursement of shipping labels purchased for orders that were canceled or refunded.

* LostOrDamagedReimbursement - An Amazon Easy Ship reimbursement to a seller's account for a package that we lost or damaged.

* CanceledButPickedUpReimbursement - An Amazon Easy Ship reimbursement to a seller's account. This occurs when a package is picked up and the order is subsequently canceled. This value is used only in the India marketplace.

* ReimbursementClawback - An Amazon Easy Ship reimbursement clawback from a seller's account. This occurs when a prior reimbursement is reversed. This value is used only in the India marketplace.

* SellerRewards - An award credited to a seller's account for their participation in an offer in the Seller Rewards program. Applies only to the India marketplace. | [optional]
**adjustment_type** | **string** | The type of adjustment.<br><br>Possible values:<br><br>* FBAInventoryReimbursement - An FBA inventory reimbursement to a seller's account. This occurs if a seller's inventory is damaged.<br><br>* ReserveEvent - A reserve event that is generated at the time of a settlement period closing. This occurs when some money from a seller's account is held back.<br><br>* PostageBilling - The amount paid by a seller for shipping labels.<br><br>* PostageRefund - The reimbursement of shipping labels purchased for orders that were canceled or refunded.<br><br>* LostOrDamagedReimbursement - An Amazon Easy Ship reimbursement to a seller's account for a package that we lost or damaged.<br><br>* CanceledButPickedUpReimbursement - An Amazon Easy Ship reimbursement to a seller's account. This occurs when a package is picked up and the order is subsequently canceled. This value is used only in the India marketplace.<br><br>* ReimbursementClawback - An Amazon Easy Ship reimbursement clawback from a seller's account. This occurs when a prior reimbursement is reversed. This value is used only in the India marketplace.<br><br>* SellerRewards - An award credited to a seller's account for their participation in an offer in the Seller Rewards program. Applies only to the India marketplace. | [optional]
**posted_date** | **string** | A date string in ISO 8601 format. | [optional]
**adjustment_amount** | [**\SellingPartnerApi\Model\FinancesV0\Currency**](Currency.md) | | [optional]
**adjustment_item_list** | [**\SellingPartnerApi\Model\FinancesV0\AdjustmentItem[]**](AdjustmentItem.md) | A list of information about items in an adjustment to the seller's account. | [optional]
Expand Down
8 changes: 1 addition & 7 deletions docs/Model/FinancesV0/AffordabilityExpenseEvent.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,7 @@ Name | Type | Description | Notes
**amazon_order_id** | **string** | An Amazon-defined identifier for an order. | [optional]
**posted_date** | **string** | A date string in ISO 8601 format. | [optional]
**marketplace_id** | **string** | An encrypted, Amazon-defined marketplace identifier. | [optional]
**transaction_type** | **string** | Indicates the type of transaction.

Possible values:

* Charge - For an affordability promotion expense.

* Refund - For an affordability promotion expense reversal. | [optional]
**transaction_type** | **string** | Indicates the type of transaction. <br><br>Possible values:<br><br>* Charge - For an affordability promotion expense.<br><br>* Refund - For an affordability promotion expense reversal. | [optional]
**base_expense** | [**\SellingPartnerApi\Model\FinancesV0\Currency**](Currency.md) | | [optional]
**tax_type_cgst** | [**\SellingPartnerApi\Model\FinancesV0\Currency**](Currency.md) | |
**tax_type_sgst** | [**\SellingPartnerApi\Model\FinancesV0\Currency**](Currency.md) | |
Expand Down
8 changes: 2 additions & 6 deletions docs/Model/FinancesV0/ChargeRefundEvent.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**posted_date** | **string** | A date string in ISO 8601 format. | [optional]
**reason_code** | **string** | The reason given for a charge refund.

Example: `SubscriptionFeeCorrection` | [optional]
**reason_code_description** | **string** | A description of the Reason Code.

Example: `SubscriptionFeeCorrection` | [optional]
**reason_code** | **string** | The reason given for a charge refund.<br><br>Example: `SubscriptionFeeCorrection` | [optional]
**reason_code_description** | **string** | A description of the Reason Code. <br><br>Example: `SubscriptionFeeCorrection` | [optional]
**charge_refund_transactions** | [**\SellingPartnerApi\Model\FinancesV0\ChargeRefundTransaction**](ChargeRefundTransaction.md) | | [optional]

[[FinancesV0 Models]](../) [[API list]](../../Api) [[README]](../../../README.md)
10 changes: 1 addition & 9 deletions docs/Model/FinancesV0/DebtRecoveryEvent.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,7 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**debt_recovery_type** | **string** | The debt recovery type.

Possible values:

* DebtPayment

* DebtPaymentFailure

*DebtAdjustment | [optional]
**debt_recovery_type** | **string** | The debt recovery type.<br><br>Possible values:<br><br>* DebtPayment<br><br>* DebtPaymentFailure<br><br>*DebtAdjustment | [optional]
**recovery_amount** | [**\SellingPartnerApi\Model\FinancesV0\Currency**](Currency.md) | | [optional]
**over_payment_credit** | [**\SellingPartnerApi\Model\FinancesV0\Currency**](Currency.md) | | [optional]
**debt_recovery_item_list** | [**\SellingPartnerApi\Model\FinancesV0\DebtRecoveryItem[]**](DebtRecoveryItem.md) | A list of debt recovery item information. | [optional]
Expand Down
Loading

0 comments on commit 510b861

Please sign in to comment.