sp_api_clients 2.0.1 → 2.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +26 -0
- data/README.md +37 -5
- data/lib/amazon_sp_clients/v2/apis/feeds_2021.rb +10 -5
- data/lib/amazon_sp_clients/v2/apis/fulfillment_outbound_2020.rb +10 -10
- data/lib/amazon_sp_clients/v2/apis/listings_items_2021.rb +22 -22
- data/lib/amazon_sp_clients/v2/apis/orders_2026.rb +59 -0
- data/lib/amazon_sp_clients/v2/apis/orders_v0.rb +17 -17
- data/lib/amazon_sp_clients/v2/apis/reports_2021.rb +7 -2
- data/lib/amazon_sp_clients/v2/apis/vendor_orders.rb +1 -1
- data/lib/amazon_sp_clients/v2/apis/vendors_shipments.rb +2 -2
- data/lib/amazon_sp_clients/v2/apis.rb +5 -0
- data/lib/amazon_sp_clients/v2.rb +1 -1
- data/lib/amazon_sp_clients/version.rb +1 -1
- data/vendor/feeds_2021/lib/sp_feeds_2021/api/feeds_api.rb +9 -6
- data/vendor/fulfillment_outbound_2020/lib/sp_fulfillment_outbound_2020/api/fba_outbound_api.rb +20 -20
- data/vendor/listings_items_2021/lib/sp_listings_items_2021/api/listings_api.rb +43 -43
- data/vendor/listings_items_2021/lib/sp_listings_items_2021.rb +1 -1
- data/vendor/orders_v0/lib/sp_orders_v0/api/orders_v0_api.rb +32 -32
- data/vendor/orders_v0/lib/sp_orders_v0/api/shipment_api.rb +2 -2
- data/vendor/reports_2021/lib/sp_reports_2021/api/reports_api.rb +3 -0
- data/vendor/vendor_orders/lib/sp_vendor_orders/api/vendor_orders_api.rb +2 -2
- data/vendor/vendors_shipments/lib/sp_vendors_shipments/api/vendor_shipping_api.rb +4 -4
- metadata +2 -1
|
@@ -60,10 +60,15 @@ module AmazonSpClients
|
|
|
60
60
|
# Returns the information required for retrieving a report document's contents. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
61
61
|
#
|
|
62
62
|
# @param report_document_id [String] The identifier for the report document.
|
|
63
|
+
# @param enable_content_encoding_url_header [Boolean, nil] When `true`, the Content-Encoding header on the returned URL is set to `gzip` instead of the default `identity` when `compressionAlgorithm` is `GZIP`. This allows automatic decompression by HTTP clients.
|
|
63
64
|
# @param rdt [Array<RDT::Resource>, nil] send a restricted data token for these resources
|
|
64
65
|
# @return [AmazonSpClients::ApiResponse]
|
|
65
|
-
def get_report_document(report_document_id, rdt: nil)
|
|
66
|
-
|
|
66
|
+
def get_report_document(report_document_id, enable_content_encoding_url_header: nil, rdt: nil)
|
|
67
|
+
query = {
|
|
68
|
+
'enableContentEncodingUrlHeader' => enable_content_encoding_url_header
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
request(:get, "/reports/2021-06-30/documents/#{encode(report_document_id)}", query: query, rdt: rdt)
|
|
67
72
|
end
|
|
68
73
|
|
|
69
74
|
# Returns report schedule details for the report schedule that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
@@ -21,7 +21,7 @@ module AmazonSpClients
|
|
|
21
21
|
request(:get, "/vendor/orders/v1/purchaseOrders/#{encode(purchase_order_number)}", rdt: rdt)
|
|
22
22
|
end
|
|
23
23
|
|
|
24
|
-
# Returns a list of purchase orders created or changed during the time frame that you specify. You define the time frame using the `createdAfter`, `createdBefore`, `changedAfter` and `changedBefore` parameters. The date range to
|
|
24
|
+
# Returns a list of purchase orders created or changed during the time frame that you specify. You define the time frame using the `createdAfter`, `createdBefore`, `changedAfter` and `changedBefore` parameters. The date range must not exceed 7 days and is available to pull data from the past 6 months. You can choose to get only the purchase order numbers by setting `includeDetails` to false. You can then use the `getPurchaseOrder` operation to receive details for a specific purchase order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
25
25
|
#
|
|
26
26
|
# @param limit [Integer, nil] The limit to the number of records returned. Default value is 100 records.
|
|
27
27
|
# @param created_after [String, nil] Purchase orders that became available after this time will be included in the result. Must be in ISO-8601 date/time format.
|
|
@@ -26,7 +26,7 @@ module AmazonSpClients
|
|
|
26
26
|
# @param shipped_before [String, nil] Get Shipment Details by passing Shipped Date Before. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.
|
|
27
27
|
# @param shipped_after [String, nil] Get Shipment Details by passing Shipped Date After. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.
|
|
28
28
|
# @param estimated_delivery_before [String, nil] Get Shipment Details by passing Estimated Delivery Date Before. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.
|
|
29
|
-
# @param estimated_delivery_after [String, nil] Get Shipment Details by passing Estimated Delivery Date
|
|
29
|
+
# @param estimated_delivery_after [String, nil] Get Shipment Details by passing Estimated Delivery Date After. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.
|
|
30
30
|
# @param shipment_delivery_before [String, nil] Get Shipment Details by passing Shipment Delivery Date Before. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.
|
|
31
31
|
# @param shipment_delivery_after [String, nil] Get Shipment Details by passing Shipment Delivery Date After. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.
|
|
32
32
|
# @param requested_pick_up_before [String, nil] Get Shipment Details by passing Before Requested pickup date. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.
|
|
@@ -75,7 +75,7 @@ module AmazonSpClients
|
|
|
75
75
|
#
|
|
76
76
|
# @param limit [Integer, nil] The limit to the number of records returned. Default value is 50 records.
|
|
77
77
|
# @param sort_order [String, nil] Sort the list by shipment label creation date in ascending or descending order.
|
|
78
|
-
# @param next_token [String, nil] A token that
|
|
78
|
+
# @param next_token [String, nil] A token that you use to retrieve the next page of results. The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
79
79
|
# @param label_created_after [String, nil] Shipment labels created after this time will be included in the result. This field must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format.
|
|
80
80
|
# @param label_created_before [String, nil] Shipment labels created before this time will be included in the result. This field must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format.
|
|
81
81
|
# @param buyer_reference_number [String, nil] Get Shipment labels by passing buyer reference number.
|
|
@@ -10,6 +10,7 @@ module AmazonSpClients
|
|
|
10
10
|
autoload :Feeds2021, 'amazon_sp_clients/v2/apis/feeds_2021'
|
|
11
11
|
autoload :FulfillmentOutbound2020, 'amazon_sp_clients/v2/apis/fulfillment_outbound_2020'
|
|
12
12
|
autoload :ListingsItems2021, 'amazon_sp_clients/v2/apis/listings_items_2021'
|
|
13
|
+
autoload :Orders2026, 'amazon_sp_clients/v2/apis/orders_2026'
|
|
13
14
|
autoload :OrdersV0, 'amazon_sp_clients/v2/apis/orders_v0'
|
|
14
15
|
autoload :Reports2021, 'amazon_sp_clients/v2/apis/reports_2021'
|
|
15
16
|
autoload :Tokens2021, 'amazon_sp_clients/v2/apis/tokens_2021'
|
|
@@ -38,6 +39,10 @@ module AmazonSpClients
|
|
|
38
39
|
# @return [ListingsItems2021]
|
|
39
40
|
def listings_items_2021 = api(ListingsItems2021)
|
|
40
41
|
|
|
42
|
+
# The Selling Partner API for Orders
|
|
43
|
+
# @return [Orders2026]
|
|
44
|
+
def orders_2026 = api(Orders2026)
|
|
45
|
+
|
|
41
46
|
# Selling Partner API for Orders
|
|
42
47
|
# @return [OrdersV0]
|
|
43
48
|
def orders_v0 = api(OrdersV0)
|
data/lib/amazon_sp_clients/v2.rb
CHANGED
|
@@ -27,7 +27,7 @@ module AmazonSpClients
|
|
|
27
27
|
#
|
|
28
28
|
# config = AmazonSpClients::V2::Config.new(endpoint: 'na')
|
|
29
29
|
# client = AmazonSpClients::V2::Client.new(config) { current_access_token }
|
|
30
|
-
# client.
|
|
30
|
+
# client.orders_2026.search_orders(marketplace_ids: ids, created_after: since)
|
|
31
31
|
module V2
|
|
32
32
|
end
|
|
33
33
|
end
|
|
@@ -16,7 +16,7 @@ module AmazonSpClients
|
|
|
16
16
|
def initialize(session)
|
|
17
17
|
@api_client = AmazonSpClients::ApiClient.new(session)
|
|
18
18
|
end
|
|
19
|
-
# 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`](https://developer-docs.amazon.com/sp-api/
|
|
19
|
+
# 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`](https://developer-docs.amazon.com/sp-api/reference/getfeed) and [`getFeeds`](https://developer-docs.amazon.com/sp-api/reference/getfeeds) operations. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
20
20
|
# @param feed_id The identifier for the feed. This identifier is unique only in combination with a seller ID.
|
|
21
21
|
# @param [Hash] opts the optional parameters
|
|
22
22
|
# @return [nil]
|
|
@@ -25,7 +25,7 @@ module AmazonSpClients
|
|
|
25
25
|
return nil
|
|
26
26
|
end
|
|
27
27
|
|
|
28
|
-
# 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`](https://developer-docs.amazon.com/sp-api/
|
|
28
|
+
# 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`](https://developer-docs.amazon.com/sp-api/reference/getfeed) and [`getFeeds`](https://developer-docs.amazon.com/sp-api/reference/getfeeds) operations. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
29
29
|
# @param feed_id The identifier for the feed. This identifier is unique only in combination with a seller ID.
|
|
30
30
|
# @param [Hash] opts the optional parameters
|
|
31
31
|
# @return [Array<(nil)>] nil, response status code and response headers
|
|
@@ -70,7 +70,7 @@ module AmazonSpClients
|
|
|
70
70
|
end
|
|
71
71
|
return data
|
|
72
72
|
end
|
|
73
|
-
# Creates a feed. Upload the contents of the feed document before calling this operation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0083 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). The rate limit for the [`JSON_LISTINGS_FEED`](https://developer-docs.amazon.com/sp-api/docs/listings-feed-type-values#listings-feed) feed type differs from the rate limit for the [`createFeed`](https://developer-docs.amazon.com/sp-api/
|
|
73
|
+
# Creates a feed. Upload the contents of the feed document before calling this operation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0083 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). The rate limit for the [`JSON_LISTINGS_FEED`](https://developer-docs.amazon.com/sp-api/docs/listings-feed-type-values#listings-feed) feed type differs from the rate limit for the [`createFeed`](https://developer-docs.amazon.com/sp-api/reference/createfeed) operation. For more information, refer to the [Building Listings Management Workflows Guide](https://developer-docs.amazon.com/sp-api/docs/building-listings-management-workflows-guide#should-i-submit-in-bulk-using-the-json_listings_feed-or-individually-with-the-listings-items-api).
|
|
74
74
|
# @param body Information required to create the feed.
|
|
75
75
|
# @param [Hash] opts the optional parameters
|
|
76
76
|
# @return [CreateFeedResponse]
|
|
@@ -79,7 +79,7 @@ module AmazonSpClients
|
|
|
79
79
|
return data
|
|
80
80
|
end
|
|
81
81
|
|
|
82
|
-
# Creates a feed. Upload the contents of the feed document before calling this operation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0083 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). The rate limit for the [`JSON_LISTINGS_FEED`](https://developer-docs.amazon.com/sp-api/docs/listings-feed-type-values#listings-feed) feed type differs from the rate limit for the [`createFeed`](https://developer-docs.amazon.com/sp-api/
|
|
82
|
+
# Creates a feed. Upload the contents of the feed document before calling this operation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0083 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). The rate limit for the [`JSON_LISTINGS_FEED`](https://developer-docs.amazon.com/sp-api/docs/listings-feed-type-values#listings-feed) feed type differs from the rate limit for the [`createFeed`](https://developer-docs.amazon.com/sp-api/reference/createfeed) operation. For more information, refer to the [Building Listings Management Workflows Guide](https://developer-docs.amazon.com/sp-api/docs/building-listings-management-workflows-guide#should-i-submit-in-bulk-using-the-json_listings_feed-or-individually-with-the-listings-items-api).
|
|
83
83
|
# @param body Information required to create the feed.
|
|
84
84
|
# @param [Hash] opts the optional parameters
|
|
85
85
|
# @return [Array<(CreateFeedResponse)>] CreateFeedResponse data, response status code and response headers
|
|
@@ -126,7 +126,7 @@ module AmazonSpClients
|
|
|
126
126
|
end
|
|
127
127
|
return data
|
|
128
128
|
end
|
|
129
|
-
# Creates a feed document for the feed type that you specify. This operation returns a presigned URL for uploading the feed document contents. It also returns a `feedDocumentId` value that you can pass in with a subsequent call to the [`createFeed`](https://developer-docs.amazon.com/sp-api/
|
|
129
|
+
# Creates a feed document for the feed type that you specify. This operation returns a presigned URL for uploading the feed document contents. It also returns a `feedDocumentId` value that you can pass in with a subsequent call to the [`createFeed`](https://developer-docs.amazon.com/sp-api/reference/createfeed) operation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
130
130
|
# @param body Specifies the content type for the createFeedDocument operation.
|
|
131
131
|
# @param [Hash] opts the optional parameters
|
|
132
132
|
# @return [CreateFeedDocumentResponse]
|
|
@@ -135,7 +135,7 @@ module AmazonSpClients
|
|
|
135
135
|
return data
|
|
136
136
|
end
|
|
137
137
|
|
|
138
|
-
# Creates a feed document for the feed type that you specify. This operation returns a presigned URL for uploading the feed document contents. It also returns a `feedDocumentId` value that you can pass in with a subsequent call to the [`createFeed`](https://developer-docs.amazon.com/sp-api/
|
|
138
|
+
# Creates a feed document for the feed type that you specify. This operation returns a presigned URL for uploading the feed document contents. It also returns a `feedDocumentId` value that you can pass in with a subsequent call to the [`createFeed`](https://developer-docs.amazon.com/sp-api/reference/createfeed) operation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
139
139
|
# @param body Specifies the content type for the createFeedDocument operation.
|
|
140
140
|
# @param [Hash] opts the optional parameters
|
|
141
141
|
# @return [Array<(CreateFeedDocumentResponse)>] CreateFeedDocumentResponse data, response status code and response headers
|
|
@@ -239,6 +239,7 @@ module AmazonSpClients
|
|
|
239
239
|
# Returns the information required for retrieving a feed document's contents. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
240
240
|
# @param feed_document_id The identifier of the feed document.
|
|
241
241
|
# @param [Hash] opts the optional parameters
|
|
242
|
+
# @option opts [BOOLEAN] :enable_content_encoding_url_header When `true`, the Content-Encoding header on the returned URL is set to `gzip` instead of the default `identity` when `compressionAlgorithm` is `GZIP`. This allows automatic decompression by HTTP clients.
|
|
242
243
|
# @return [FeedDocument]
|
|
243
244
|
def get_feed_document(feed_document_id, opts = {})
|
|
244
245
|
data = get_feed_document_with_http_info(feed_document_id, opts)
|
|
@@ -248,6 +249,7 @@ module AmazonSpClients
|
|
|
248
249
|
# Returns the information required for retrieving a feed document's contents. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
249
250
|
# @param feed_document_id The identifier of the feed document.
|
|
250
251
|
# @param [Hash] opts the optional parameters
|
|
252
|
+
# @option opts [BOOLEAN] :enable_content_encoding_url_header When `true`, the Content-Encoding header on the returned URL is set to `gzip` instead of the default `identity` when `compressionAlgorithm` is `GZIP`. This allows automatic decompression by HTTP clients.
|
|
251
253
|
# @return [Array<(FeedDocument)>] FeedDocument data, response status code and response headers
|
|
252
254
|
def get_feed_document_with_http_info(feed_document_id, opts = {})
|
|
253
255
|
if @api_client.config.debugging
|
|
@@ -262,6 +264,7 @@ module AmazonSpClients
|
|
|
262
264
|
|
|
263
265
|
# query parameters
|
|
264
266
|
query_params = opts[:query_params] || {}
|
|
267
|
+
query_params[:'enableContentEncodingUrlHeader'] = opts[:'enable_content_encoding_url_header'] if !opts[:'enable_content_encoding_url_header'].nil?
|
|
265
268
|
|
|
266
269
|
# header parameters
|
|
267
270
|
header_params = opts[:header_params] || {}
|
data/vendor/fulfillment_outbound_2020/lib/sp_fulfillment_outbound_2020/api/fba_outbound_api.rb
CHANGED
|
@@ -127,8 +127,8 @@ module AmazonSpClients
|
|
|
127
127
|
return data
|
|
128
128
|
end
|
|
129
129
|
# Creates a fulfillment return. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
130
|
-
# @param body
|
|
131
|
-
# @param seller_fulfillment_order_id An identifier
|
|
130
|
+
# @param body The request body of the `createFulfillmentReturn` operation.
|
|
131
|
+
# @param seller_fulfillment_order_id An identifier the seller assigns 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.
|
|
132
132
|
# @param [Hash] opts the optional parameters
|
|
133
133
|
# @return [CreateFulfillmentReturnResponse]
|
|
134
134
|
def create_fulfillment_return(body, seller_fulfillment_order_id, opts = {})
|
|
@@ -137,8 +137,8 @@ module AmazonSpClients
|
|
|
137
137
|
end
|
|
138
138
|
|
|
139
139
|
# Creates a fulfillment return. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
140
|
-
# @param body
|
|
141
|
-
# @param seller_fulfillment_order_id An identifier
|
|
140
|
+
# @param body The request body of the `createFulfillmentReturn` operation.
|
|
141
|
+
# @param seller_fulfillment_order_id An identifier the seller assigns 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.
|
|
142
142
|
# @param [Hash] opts the optional parameters
|
|
143
143
|
# @return [Array<(CreateFulfillmentReturnResponse)>] CreateFulfillmentReturnResponse data, response status code and response headers
|
|
144
144
|
def create_fulfillment_return_with_http_info(body, seller_fulfillment_order_id, opts = {})
|
|
@@ -244,24 +244,24 @@ module AmazonSpClients
|
|
|
244
244
|
end
|
|
245
245
|
return data
|
|
246
246
|
end
|
|
247
|
-
# Returns a list of inventory items that are eligible for the fulfillment feature you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)
|
|
247
|
+
# Returns a list of inventory items that are eligible for the fulfillment feature you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
248
248
|
# @param marketplace_id The marketplace for which to return a list of the inventory that is eligible for the specified feature.
|
|
249
249
|
# @param feature_name The name of the feature for which to return a list of eligible inventory.
|
|
250
250
|
# @param [Hash] opts the optional parameters
|
|
251
|
-
# @option opts [String] :next_token A string token returned in the response to your previous request that is used to return the next response page. A value of null will return the first page.
|
|
252
|
-
# @option opts [DateTime] :query_start_date A date that you can use to select inventory that has been updated since a specified date. An update is defined as any change in feature-enabled inventory availability. The date must be in the format yyyy-MM-ddTHH:mm:ss.sssZ
|
|
251
|
+
# @option opts [String] :next_token A string token returned in the response to your previous request that is used to return the next response page. A value of `null` will return the first page.
|
|
252
|
+
# @option opts [DateTime] :query_start_date A date that you can use to select inventory that has been updated since a specified date. An update is defined as any change in feature-enabled inventory availability. The date must be in the format `yyyy-MM-ddTHH:mm:ss.sssZ`
|
|
253
253
|
# @return [GetFeatureInventoryResponse]
|
|
254
254
|
def get_feature_inventory(marketplace_id, feature_name, opts = {})
|
|
255
255
|
data = get_feature_inventory_with_http_info(marketplace_id, feature_name, opts)
|
|
256
256
|
return data
|
|
257
257
|
end
|
|
258
258
|
|
|
259
|
-
# Returns a list of inventory items that are eligible for the fulfillment feature you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)
|
|
259
|
+
# Returns a list of inventory items that are eligible for the fulfillment feature you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
260
260
|
# @param marketplace_id The marketplace for which to return a list of the inventory that is eligible for the specified feature.
|
|
261
261
|
# @param feature_name The name of the feature for which to return a list of eligible inventory.
|
|
262
262
|
# @param [Hash] opts the optional parameters
|
|
263
|
-
# @option opts [String] :next_token A string token returned in the response to your previous request that is used to return the next response page. A value of null will return the first page.
|
|
264
|
-
# @option opts [DateTime] :query_start_date A date that you can use to select inventory that has been updated since a specified date. An update is defined as any change in feature-enabled inventory availability. The date must be in the format yyyy-MM-ddTHH:mm:ss.sssZ
|
|
263
|
+
# @option opts [String] :next_token A string token returned in the response to your previous request that is used to return the next response page. A value of `null` will return the first page.
|
|
264
|
+
# @option opts [DateTime] :query_start_date A date that you can use to select inventory that has been updated since a specified date. An update is defined as any change in feature-enabled inventory availability. The date must be in the format `yyyy-MM-ddTHH:mm:ss.sssZ`
|
|
265
265
|
# @return [Array<(GetFeatureInventoryResponse)>] GetFeatureInventoryResponse data, response status code and response headers
|
|
266
266
|
def get_feature_inventory_with_http_info(marketplace_id, feature_name, opts = {})
|
|
267
267
|
if @api_client.config.debugging
|
|
@@ -311,10 +311,10 @@ module AmazonSpClients
|
|
|
311
311
|
end
|
|
312
312
|
return data
|
|
313
313
|
end
|
|
314
|
-
# Returns the number of items with the
|
|
314
|
+
# Returns the number of items with the `sellerSku` you specify that can have orders fulfilled using the specified feature. Note that if the `sellerSku` isn't eligible, the response will contain an empty `skuInfo` object. The parameters for this operation may contain special characters that require URL encoding. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
315
315
|
# @param marketplace_id The marketplace for which to return the count.
|
|
316
316
|
# @param feature_name The name of the feature.
|
|
317
|
-
# @param seller_sku Used to identify an item in the given marketplace. `
|
|
317
|
+
# @param seller_sku 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.
|
|
318
318
|
# @param [Hash] opts the optional parameters
|
|
319
319
|
# @return [GetFeatureSkuResponse]
|
|
320
320
|
def get_feature_sku(marketplace_id, feature_name, seller_sku, opts = {})
|
|
@@ -322,10 +322,10 @@ module AmazonSpClients
|
|
|
322
322
|
return data
|
|
323
323
|
end
|
|
324
324
|
|
|
325
|
-
# Returns the number of items with the
|
|
325
|
+
# Returns the number of items with the `sellerSku` you specify that can have orders fulfilled using the specified feature. Note that if the `sellerSku` isn't eligible, the response will contain an empty `skuInfo` object. The parameters for this operation may contain special characters that require URL encoding. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
326
326
|
# @param marketplace_id The marketplace for which to return the count.
|
|
327
327
|
# @param feature_name The name of the feature.
|
|
328
|
-
# @param seller_sku Used to identify an item in the given marketplace. `
|
|
328
|
+
# @param seller_sku 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.
|
|
329
329
|
# @param [Hash] opts the optional parameters
|
|
330
330
|
# @return [Array<(GetFeatureSkuResponse)>] GetFeatureSkuResponse data, response status code and response headers
|
|
331
331
|
def get_feature_sku_with_http_info(marketplace_id, feature_name, seller_sku, opts = {})
|
|
@@ -544,7 +544,7 @@ module AmazonSpClients
|
|
|
544
544
|
return data
|
|
545
545
|
end
|
|
546
546
|
# 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 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
547
|
-
# @param package_number The unencrypted package identifier
|
|
547
|
+
# @param package_number The unencrypted package identifier. You can obtain this value from the `getFulfillmentOrder` operation.
|
|
548
548
|
# @param [Hash] opts the optional parameters
|
|
549
549
|
# @return [GetPackageTrackingDetailsResponse]
|
|
550
550
|
def get_package_tracking_details(package_number, opts = {})
|
|
@@ -553,7 +553,7 @@ module AmazonSpClients
|
|
|
553
553
|
end
|
|
554
554
|
|
|
555
555
|
# 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 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
556
|
-
# @param package_number The unencrypted package identifier
|
|
556
|
+
# @param package_number The unencrypted package identifier. You can obtain this value from the `getFulfillmentOrder` operation.
|
|
557
557
|
# @param [Hash] opts the optional parameters
|
|
558
558
|
# @return [Array<(GetPackageTrackingDetailsResponse)>] GetPackageTrackingDetailsResponse data, response status code and response headers
|
|
559
559
|
def get_package_tracking_details_with_http_info(package_number, opts = {})
|
|
@@ -598,7 +598,7 @@ module AmazonSpClients
|
|
|
598
598
|
end
|
|
599
599
|
return data
|
|
600
600
|
end
|
|
601
|
-
# Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the
|
|
601
|
+
# Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the `nextToken` parameter. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)
|
|
602
602
|
# @param [Hash] opts the optional parameters
|
|
603
603
|
# @option opts [DateTime] :query_start_date A date 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.
|
|
604
604
|
# @option opts [String] :next_token A string token returned in the response to your previous request.
|
|
@@ -608,7 +608,7 @@ module AmazonSpClients
|
|
|
608
608
|
return data
|
|
609
609
|
end
|
|
610
610
|
|
|
611
|
-
# Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the
|
|
611
|
+
# Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the `nextToken` parameter. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)
|
|
612
612
|
# @param [Hash] opts the optional parameters
|
|
613
613
|
# @option opts [DateTime] :query_start_date A date 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.
|
|
614
614
|
# @option opts [String] :next_token A string token returned in the response to your previous request.
|
|
@@ -779,7 +779,7 @@ module AmazonSpClients
|
|
|
779
779
|
return data
|
|
780
780
|
end
|
|
781
781
|
# Updates and/or requests shipment for a fulfillment order with an order hold on it. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
782
|
-
# @param body
|
|
782
|
+
# @param body The request body of the `updateFulfillmentOrder` operation.
|
|
783
783
|
# @param seller_fulfillment_order_id The identifier assigned to the item by the seller when the fulfillment order was created.
|
|
784
784
|
# @param [Hash] opts the optional parameters
|
|
785
785
|
# @return [UpdateFulfillmentOrderResponse]
|
|
@@ -789,7 +789,7 @@ module AmazonSpClients
|
|
|
789
789
|
end
|
|
790
790
|
|
|
791
791
|
# Updates and/or requests shipment for a fulfillment order with an order hold on it. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
792
|
-
# @param body
|
|
792
|
+
# @param body The request body of the `updateFulfillmentOrder` operation.
|
|
793
793
|
# @param seller_fulfillment_order_id The identifier assigned to the item by the seller when the fulfillment order was created.
|
|
794
794
|
# @param [Hash] opts the optional parameters
|
|
795
795
|
# @return [Array<(UpdateFulfillmentOrderResponse)>] UpdateFulfillmentOrderResponse data, response status code and response headers
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Selling Partner API for Listings Items
|
|
3
3
|
|
|
4
|
-
#The Selling Partner API for Listings Items (Listings Items API) provides programmatic access to selling partner listings on Amazon. Use this API in collaboration with the Selling Partner API for Product Type Definitions, which you use to retrieve the information about Amazon product types needed to use the Listings Items API. For more information,
|
|
4
|
+
#The Selling Partner API for Listings Items (Listings Items API) provides programmatic access to selling partner listings on Amazon. Use this API in collaboration with the Selling Partner API for Product Type Definitions, which you can use to retrieve the information about Amazon product types needed to use the Listings Items API. For more information, refer to the [Listings Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/listings-items-api-v2021-08-01-use-case-guide).
|
|
5
5
|
|
|
6
6
|
OpenAPI spec version: 2021-08-01
|
|
7
7
|
|
|
@@ -16,24 +16,24 @@ module AmazonSpClients
|
|
|
16
16
|
def initialize(session)
|
|
17
17
|
@api_client = AmazonSpClients::ApiClient.new(session)
|
|
18
18
|
end
|
|
19
|
-
# Delete a listings item for a selling partner. **
|
|
19
|
+
# Delete a listings item for a selling partner. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can receive higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API documentation.
|
|
20
20
|
# @param seller_id A selling partner identifier, such as a merchant account or vendor code.
|
|
21
|
-
# @param sku A selling partner
|
|
22
|
-
# @param marketplace_ids A comma-delimited list of Amazon
|
|
21
|
+
# @param sku A selling partner-provided identifier for an Amazon listing.
|
|
22
|
+
# @param marketplace_ids A comma-delimited list of Amazon store identifiers for the request.
|
|
23
23
|
# @param [Hash] opts the optional parameters
|
|
24
|
-
# @option opts [String] :issue_locale A locale for localization of issues. When not provided, the default language code of the first
|
|
24
|
+
# @option opts [String] :issue_locale A locale for localization of issues. When not provided, the default language code of the first Amazon store is used. Examples: `en_US`, `fr_CA`, `fr_FR`. Localized messages default to `en_US` when localization is not available for the specified locale.
|
|
25
25
|
# @return [ListingsItemSubmissionResponse]
|
|
26
26
|
def delete_listings_item(seller_id, sku, marketplace_ids, opts = {})
|
|
27
27
|
data = delete_listings_item_with_http_info(seller_id, sku, marketplace_ids, opts)
|
|
28
28
|
return data
|
|
29
29
|
end
|
|
30
30
|
|
|
31
|
-
# Delete a listings item for a selling partner. **
|
|
31
|
+
# Delete a listings item for a selling partner. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can receive higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API documentation.
|
|
32
32
|
# @param seller_id A selling partner identifier, such as a merchant account or vendor code.
|
|
33
|
-
# @param sku A selling partner
|
|
34
|
-
# @param marketplace_ids A comma-delimited list of Amazon
|
|
33
|
+
# @param sku A selling partner-provided identifier for an Amazon listing.
|
|
34
|
+
# @param marketplace_ids A comma-delimited list of Amazon store identifiers for the request.
|
|
35
35
|
# @param [Hash] opts the optional parameters
|
|
36
|
-
# @option opts [String] :issue_locale A locale for localization of issues. When not provided, the default language code of the first
|
|
36
|
+
# @option opts [String] :issue_locale A locale for localization of issues. When not provided, the default language code of the first Amazon store is used. Examples: `en_US`, `fr_CA`, `fr_FR`. Localized messages default to `en_US` when localization is not available for the specified locale.
|
|
37
37
|
# @return [Array<(ListingsItemSubmissionResponse)>] ListingsItemSubmissionResponse data, response status code and response headers
|
|
38
38
|
def delete_listings_item_with_http_info(seller_id, sku, marketplace_ids, opts = {})
|
|
39
39
|
if @api_client.config.debugging
|
|
@@ -86,12 +86,12 @@ module AmazonSpClients
|
|
|
86
86
|
end
|
|
87
87
|
return data
|
|
88
88
|
end
|
|
89
|
-
# Returns details about a listings item for a selling partner. **
|
|
89
|
+
# Returns details about a listings item for a selling partner. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can receive higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API documentation.
|
|
90
90
|
# @param seller_id A selling partner identifier, such as a merchant account or vendor code.
|
|
91
|
-
# @param sku A selling partner
|
|
92
|
-
# @param marketplace_ids A comma-delimited list of Amazon
|
|
91
|
+
# @param sku A selling partner-provided identifier for an Amazon listing.
|
|
92
|
+
# @param marketplace_ids A comma-delimited list of Amazon store identifiers for the request.
|
|
93
93
|
# @param [Hash] opts the optional parameters
|
|
94
|
-
# @option opts [String] :issue_locale A locale for localization of issues. When not provided, the default language code of the first
|
|
94
|
+
# @option opts [String] :issue_locale A locale for localization of issues. When not provided, the default language code of the first Amazon store is used. Examples: `en_US`, `fr_CA`, `fr_FR`. Localized messages default to `en_US` when localization is not available for the specified locale.
|
|
95
95
|
# @option opts [Array<String>] :included_data A comma-delimited list of data sets to include in the response. Default: `summaries`.
|
|
96
96
|
# @return [Item]
|
|
97
97
|
def get_listings_item(seller_id, sku, marketplace_ids, opts = {})
|
|
@@ -99,12 +99,12 @@ module AmazonSpClients
|
|
|
99
99
|
return data
|
|
100
100
|
end
|
|
101
101
|
|
|
102
|
-
# Returns details about a listings item for a selling partner. **
|
|
102
|
+
# Returns details about a listings item for a selling partner. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can receive higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API documentation.
|
|
103
103
|
# @param seller_id A selling partner identifier, such as a merchant account or vendor code.
|
|
104
|
-
# @param sku A selling partner
|
|
105
|
-
# @param marketplace_ids A comma-delimited list of Amazon
|
|
104
|
+
# @param sku A selling partner-provided identifier for an Amazon listing.
|
|
105
|
+
# @param marketplace_ids A comma-delimited list of Amazon store identifiers for the request.
|
|
106
106
|
# @param [Hash] opts the optional parameters
|
|
107
|
-
# @option opts [String] :issue_locale A locale for localization of issues. When not provided, the default language code of the first
|
|
107
|
+
# @option opts [String] :issue_locale A locale for localization of issues. When not provided, the default language code of the first Amazon store is used. Examples: `en_US`, `fr_CA`, `fr_FR`. Localized messages default to `en_US` when localization is not available for the specified locale.
|
|
108
108
|
# @option opts [Array<String>] :included_data A comma-delimited list of data sets to include in the response. Default: `summaries`.
|
|
109
109
|
# @return [Array<(Item)>] Item data, response status code and response headers
|
|
110
110
|
def get_listings_item_with_http_info(seller_id, sku, marketplace_ids, opts = {})
|
|
@@ -162,30 +162,30 @@ module AmazonSpClients
|
|
|
162
162
|
end
|
|
163
163
|
return data
|
|
164
164
|
end
|
|
165
|
-
# Partially update (patch) a listings item for a selling partner. Only top-level listings item attributes can be patched. Patching nested attributes is not supported. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can receive higher rate and burst values
|
|
165
|
+
# Partially update (patch) a listings item for a selling partner. Only top-level listings item attributes can be patched. Patching nested attributes is not supported. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can receive higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API documentation.
|
|
166
166
|
# @param body The request body schema for the `patchListingsItem` operation.
|
|
167
|
-
# @param marketplace_ids A comma-delimited list of Amazon
|
|
167
|
+
# @param marketplace_ids A comma-delimited list of Amazon store identifiers for the request.
|
|
168
168
|
# @param seller_id A selling partner identifier, such as a merchant account or vendor code.
|
|
169
|
-
# @param sku A selling partner
|
|
169
|
+
# @param sku A selling partner-provided identifier for an Amazon listing.
|
|
170
170
|
# @param [Hash] opts the optional parameters
|
|
171
171
|
# @option opts [Array<String>] :included_data A comma-delimited list of data sets to include in the response. Default: `issues`.
|
|
172
|
-
# @option opts [String] :mode
|
|
173
|
-
# @option opts [String] :issue_locale A locale for localization of issues. When not provided, the default language code of the first
|
|
172
|
+
# @option opts [String] :mode Describes the mode of operation for the request.
|
|
173
|
+
# @option opts [String] :issue_locale A locale for localization of issues. When not provided, the default language code of the first Amazon store is used. Examples: `en_US`, `fr_CA`, `fr_FR`. Localized messages default to `en_US` when localization is not available for the specified locale.
|
|
174
174
|
# @return [ListingsItemSubmissionResponse]
|
|
175
175
|
def patch_listings_item(body, marketplace_ids, seller_id, sku, opts = {})
|
|
176
176
|
data = patch_listings_item_with_http_info(body, marketplace_ids, seller_id, sku, opts)
|
|
177
177
|
return data
|
|
178
178
|
end
|
|
179
179
|
|
|
180
|
-
# Partially update (patch) a listings item for a selling partner. Only top-level listings item attributes can be patched. Patching nested attributes is not supported. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can receive higher rate and burst values
|
|
180
|
+
# Partially update (patch) a listings item for a selling partner. Only top-level listings item attributes can be patched. Patching nested attributes is not supported. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can receive higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API documentation.
|
|
181
181
|
# @param body The request body schema for the `patchListingsItem` operation.
|
|
182
|
-
# @param marketplace_ids A comma-delimited list of Amazon
|
|
182
|
+
# @param marketplace_ids A comma-delimited list of Amazon store identifiers for the request.
|
|
183
183
|
# @param seller_id A selling partner identifier, such as a merchant account or vendor code.
|
|
184
|
-
# @param sku A selling partner
|
|
184
|
+
# @param sku A selling partner-provided identifier for an Amazon listing.
|
|
185
185
|
# @param [Hash] opts the optional parameters
|
|
186
186
|
# @option opts [Array<String>] :included_data A comma-delimited list of data sets to include in the response. Default: `issues`.
|
|
187
|
-
# @option opts [String] :mode
|
|
188
|
-
# @option opts [String] :issue_locale A locale for localization of issues. When not provided, the default language code of the first
|
|
187
|
+
# @option opts [String] :mode Describes the mode of operation for the request.
|
|
188
|
+
# @option opts [String] :issue_locale A locale for localization of issues. When not provided, the default language code of the first Amazon store is used. Examples: `en_US`, `fr_CA`, `fr_FR`. Localized messages default to `en_US` when localization is not available for the specified locale.
|
|
189
189
|
# @return [Array<(ListingsItemSubmissionResponse)>] ListingsItemSubmissionResponse data, response status code and response headers
|
|
190
190
|
def patch_listings_item_with_http_info(body, marketplace_ids, seller_id, sku, opts = {})
|
|
191
191
|
if @api_client.config.debugging
|
|
@@ -252,30 +252,30 @@ module AmazonSpClients
|
|
|
252
252
|
end
|
|
253
253
|
return data
|
|
254
254
|
end
|
|
255
|
-
# Creates or fully
|
|
255
|
+
# Creates a new or fully-updates an existing listings item for a selling partner. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can receive higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API documentation.
|
|
256
256
|
# @param body The request body schema for the `putListingsItem` operation.
|
|
257
|
-
# @param marketplace_ids A comma-delimited list of Amazon
|
|
257
|
+
# @param marketplace_ids A comma-delimited list of Amazon store identifiers for the request.
|
|
258
258
|
# @param seller_id A selling partner identifier, such as a merchant account or vendor code.
|
|
259
|
-
# @param sku A selling partner
|
|
259
|
+
# @param sku A selling partner-provided identifier for an Amazon listing.
|
|
260
260
|
# @param [Hash] opts the optional parameters
|
|
261
261
|
# @option opts [Array<String>] :included_data A comma-delimited list of data sets to include in the response. Default: `issues`.
|
|
262
|
-
# @option opts [String] :mode
|
|
263
|
-
# @option opts [String] :issue_locale A locale for localization of issues. When not provided, the default language code of the first
|
|
262
|
+
# @option opts [String] :mode Describes the mode of operation for the request.
|
|
263
|
+
# @option opts [String] :issue_locale A locale for localization of issues. When not provided, the default language code of the first Amazon store is used. Examples: `en_US`, `fr_CA`, `fr_FR`. Localized messages default to `en_US` when localization is not available for the specified locale.
|
|
264
264
|
# @return [ListingsItemSubmissionResponse]
|
|
265
265
|
def put_listings_item(body, marketplace_ids, seller_id, sku, opts = {})
|
|
266
266
|
data = put_listings_item_with_http_info(body, marketplace_ids, seller_id, sku, opts)
|
|
267
267
|
return data
|
|
268
268
|
end
|
|
269
269
|
|
|
270
|
-
# Creates or fully
|
|
270
|
+
# Creates a new or fully-updates an existing listings item for a selling partner. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can receive higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API documentation.
|
|
271
271
|
# @param body The request body schema for the `putListingsItem` operation.
|
|
272
|
-
# @param marketplace_ids A comma-delimited list of Amazon
|
|
272
|
+
# @param marketplace_ids A comma-delimited list of Amazon store identifiers for the request.
|
|
273
273
|
# @param seller_id A selling partner identifier, such as a merchant account or vendor code.
|
|
274
|
-
# @param sku A selling partner
|
|
274
|
+
# @param sku A selling partner-provided identifier for an Amazon listing.
|
|
275
275
|
# @param [Hash] opts the optional parameters
|
|
276
276
|
# @option opts [Array<String>] :included_data A comma-delimited list of data sets to include in the response. Default: `issues`.
|
|
277
|
-
# @option opts [String] :mode
|
|
278
|
-
# @option opts [String] :issue_locale A locale for localization of issues. When not provided, the default language code of the first
|
|
277
|
+
# @option opts [String] :mode Describes the mode of operation for the request.
|
|
278
|
+
# @option opts [String] :issue_locale A locale for localization of issues. When not provided, the default language code of the first Amazon store is used. Examples: `en_US`, `fr_CA`, `fr_FR`. Localized messages default to `en_US` when localization is not available for the specified locale.
|
|
279
279
|
# @return [Array<(ListingsItemSubmissionResponse)>] ListingsItemSubmissionResponse data, response status code and response headers
|
|
280
280
|
def put_listings_item_with_http_info(body, marketplace_ids, seller_id, sku, opts = {})
|
|
281
281
|
if @api_client.config.debugging
|
|
@@ -344,10 +344,10 @@ module AmazonSpClients
|
|
|
344
344
|
end
|
|
345
345
|
# Search for and return a list of selling partner listings items and their respective details. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
346
346
|
# @param seller_id A selling partner identifier, such as a merchant account or vendor code.
|
|
347
|
-
# @param marketplace_ids A comma-delimited list of Amazon
|
|
347
|
+
# @param marketplace_ids A comma-delimited list of Amazon store identifiers for the request.
|
|
348
348
|
# @param [Hash] opts the optional parameters
|
|
349
|
-
# @option opts [String] :issue_locale A locale that is used to localize issues. When not provided, the default language code of the first
|
|
350
|
-
# @option opts [Array<String>] :included_data A comma-delimited list of
|
|
349
|
+
# @option opts [String] :issue_locale A locale that is used to localize issues. When not provided, the default language code of the first Amazon store is used. Examples: \"en_US\", \"fr_CA\", \"fr_FR\". When a localization is not available in the specified locale, localized messages default to \"en_US\".
|
|
350
|
+
# @option opts [Array<String>] :included_data A comma-delimited list of data sets that you want to include in the response. Default: `summaries`.
|
|
351
351
|
# @option opts [Array<String>] :identifiers A comma-delimited list of product identifiers that you can use to search for listings items. **Note**: 1. This is required when you specify `identifiersType`. 2. You cannot use 'identifiers' if you specify `variationParentSku` or `packageHierarchySku`.
|
|
352
352
|
# @option opts [String] :identifiers_type A type of product identifiers that you can use to search for listings items. **Note**: This is required when `identifiers` is provided.
|
|
353
353
|
# @option opts [String] :variation_parent_sku Filters results to include listing items that are variation children of the specified SKU. **Note**: You cannot use `variationParentSku` if you include `identifiers` or `packageHierarchySku` in your request.
|
|
@@ -371,10 +371,10 @@ module AmazonSpClients
|
|
|
371
371
|
|
|
372
372
|
# Search for and return a list of selling partner listings items and their respective details. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
373
373
|
# @param seller_id A selling partner identifier, such as a merchant account or vendor code.
|
|
374
|
-
# @param marketplace_ids A comma-delimited list of Amazon
|
|
374
|
+
# @param marketplace_ids A comma-delimited list of Amazon store identifiers for the request.
|
|
375
375
|
# @param [Hash] opts the optional parameters
|
|
376
|
-
# @option opts [String] :issue_locale A locale that is used to localize issues. When not provided, the default language code of the first
|
|
377
|
-
# @option opts [Array<String>] :included_data A comma-delimited list of
|
|
376
|
+
# @option opts [String] :issue_locale A locale that is used to localize issues. When not provided, the default language code of the first Amazon store is used. Examples: \"en_US\", \"fr_CA\", \"fr_FR\". When a localization is not available in the specified locale, localized messages default to \"en_US\".
|
|
377
|
+
# @option opts [Array<String>] :included_data A comma-delimited list of data sets that you want to include in the response. Default: `summaries`.
|
|
378
378
|
# @option opts [Array<String>] :identifiers A comma-delimited list of product identifiers that you can use to search for listings items. **Note**: 1. This is required when you specify `identifiersType`. 2. You cannot use 'identifiers' if you specify `variationParentSku` or `packageHierarchySku`.
|
|
379
379
|
# @option opts [String] :identifiers_type A type of product identifiers that you can use to search for listings items. **Note**: This is required when `identifiers` is provided.
|
|
380
380
|
# @option opts [String] :variation_parent_sku Filters results to include listing items that are variation children of the specified SKU. **Note**: You cannot use `variationParentSku` if you include `identifiers` or `packageHierarchySku` in your request.
|