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
|
@@ -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,7 +16,7 @@ module AmazonSpClients
|
|
|
16
16
|
def initialize(session)
|
|
17
17
|
@api_client = AmazonSpClients::ApiClient.new(session)
|
|
18
18
|
end
|
|
19
|
-
# Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header
|
|
19
|
+
# Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the 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).
|
|
20
20
|
# @param body Request body of `confirmShipment`.
|
|
21
21
|
# @param order_id An Amazon-defined order identifier, in 3-7-7 format.
|
|
22
22
|
# @param [Hash] opts the optional parameters
|
|
@@ -26,7 +26,7 @@ module AmazonSpClients
|
|
|
26
26
|
return nil
|
|
27
27
|
end
|
|
28
28
|
|
|
29
|
-
# Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header
|
|
29
|
+
# Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the 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).
|
|
30
30
|
# @param body Request body of `confirmShipment`.
|
|
31
31
|
# @param order_id An Amazon-defined order identifier, in 3-7-7 format.
|
|
32
32
|
# @param [Hash] opts the optional parameters
|
|
@@ -78,7 +78,7 @@ module AmazonSpClients
|
|
|
78
78
|
end
|
|
79
79
|
return data
|
|
80
80
|
end
|
|
81
|
-
# Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
81
|
+
# Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the 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).
|
|
82
82
|
# @param order_id An Amazon-defined order identifier, in 3-7-7 format.
|
|
83
83
|
# @param [Hash] opts the optional parameters
|
|
84
84
|
# @return [GetOrderResponse]
|
|
@@ -87,7 +87,7 @@ module AmazonSpClients
|
|
|
87
87
|
return data
|
|
88
88
|
end
|
|
89
89
|
|
|
90
|
-
# Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
90
|
+
# Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the 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).
|
|
91
91
|
# @param order_id An Amazon-defined order identifier, in 3-7-7 format.
|
|
92
92
|
# @param [Hash] opts the optional parameters
|
|
93
93
|
# @return [Array<(GetOrderResponse)>] GetOrderResponse data, response status code and response headers
|
|
@@ -132,8 +132,8 @@ module AmazonSpClients
|
|
|
132
132
|
end
|
|
133
133
|
return data
|
|
134
134
|
end
|
|
135
|
-
# Returns the shipping address for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
136
|
-
# @param order_id
|
|
135
|
+
# Returns the shipping address for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the 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).
|
|
136
|
+
# @param order_id The Amazon order identifier in 3-7-7 format.
|
|
137
137
|
# @param [Hash] opts the optional parameters
|
|
138
138
|
# @return [GetOrderAddressResponse]
|
|
139
139
|
def get_order_address(order_id, opts = {})
|
|
@@ -141,8 +141,8 @@ module AmazonSpClients
|
|
|
141
141
|
return data
|
|
142
142
|
end
|
|
143
143
|
|
|
144
|
-
# Returns the shipping address for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
145
|
-
# @param order_id
|
|
144
|
+
# Returns the shipping address for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the 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).
|
|
145
|
+
# @param order_id The Amazon order identifier in 3-7-7 format.
|
|
146
146
|
# @param [Hash] opts the optional parameters
|
|
147
147
|
# @return [Array<(GetOrderAddressResponse)>] GetOrderAddressResponse data, response status code and response headers
|
|
148
148
|
def get_order_address_with_http_info(order_id, opts = {})
|
|
@@ -186,8 +186,8 @@ module AmazonSpClients
|
|
|
186
186
|
end
|
|
187
187
|
return data
|
|
188
188
|
end
|
|
189
|
-
# Returns buyer information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
190
|
-
# @param order_id
|
|
189
|
+
# Returns buyer information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the 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).
|
|
190
|
+
# @param order_id The Amazon order identifier in 3-7-7 format.
|
|
191
191
|
# @param [Hash] opts the optional parameters
|
|
192
192
|
# @return [GetOrderBuyerInfoResponse]
|
|
193
193
|
def get_order_buyer_info(order_id, opts = {})
|
|
@@ -195,8 +195,8 @@ module AmazonSpClients
|
|
|
195
195
|
return data
|
|
196
196
|
end
|
|
197
197
|
|
|
198
|
-
# Returns buyer information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
199
|
-
# @param order_id
|
|
198
|
+
# Returns buyer information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the 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).
|
|
199
|
+
# @param order_id The Amazon order identifier in 3-7-7 format.
|
|
200
200
|
# @param [Hash] opts the optional parameters
|
|
201
201
|
# @return [Array<(GetOrderBuyerInfoResponse)>] GetOrderBuyerInfoResponse data, response status code and response headers
|
|
202
202
|
def get_order_buyer_info_with_http_info(order_id, opts = {})
|
|
@@ -240,7 +240,7 @@ module AmazonSpClients
|
|
|
240
240
|
end
|
|
241
241
|
return data
|
|
242
242
|
end
|
|
243
|
-
# Returns detailed order item information for the order that you specify. If `NextToken` is provided, it's used to retrieve the next page of order items. __Note__: When an order is in the Pending state (the order has been placed but payment has not been authorized), the getOrderItems operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped, Partially Shipped, or Shipped state, the getOrderItems operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
243
|
+
# Returns detailed order item information for the order that you specify. If `NextToken` is provided, it's used to retrieve the next page of order items. __Note__: When an order is in the Pending state (the order has been placed but payment has not been authorized), the getOrderItems operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped, Partially Shipped, or Shipped state, the getOrderItems operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the 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).
|
|
244
244
|
# @param order_id An Amazon-defined order identifier, in 3-7-7 format.
|
|
245
245
|
# @param [Hash] opts the optional parameters
|
|
246
246
|
# @option opts [String] :next_token A string token returned in the response of your previous request.
|
|
@@ -250,7 +250,7 @@ module AmazonSpClients
|
|
|
250
250
|
return data
|
|
251
251
|
end
|
|
252
252
|
|
|
253
|
-
# Returns detailed order item information for the order that you specify. If `NextToken` is provided, it's used to retrieve the next page of order items. __Note__: When an order is in the Pending state (the order has been placed but payment has not been authorized), the getOrderItems operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped, Partially Shipped, or Shipped state, the getOrderItems operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
253
|
+
# Returns detailed order item information for the order that you specify. If `NextToken` is provided, it's used to retrieve the next page of order items. __Note__: When an order is in the Pending state (the order has been placed but payment has not been authorized), the getOrderItems operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped, Partially Shipped, or Shipped state, the getOrderItems operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the 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).
|
|
254
254
|
# @param order_id An Amazon-defined order identifier, in 3-7-7 format.
|
|
255
255
|
# @param [Hash] opts the optional parameters
|
|
256
256
|
# @option opts [String] :next_token A string token returned in the response of your previous request.
|
|
@@ -297,7 +297,7 @@ module AmazonSpClients
|
|
|
297
297
|
end
|
|
298
298
|
return data
|
|
299
299
|
end
|
|
300
|
-
# Returns buyer information for the order items in the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
300
|
+
# Returns buyer information for the order items in the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the 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).
|
|
301
301
|
# @param order_id An Amazon-defined order identifier, in 3-7-7 format.
|
|
302
302
|
# @param [Hash] opts the optional parameters
|
|
303
303
|
# @option opts [String] :next_token A string token returned in the response of your previous request.
|
|
@@ -307,7 +307,7 @@ module AmazonSpClients
|
|
|
307
307
|
return data
|
|
308
308
|
end
|
|
309
309
|
|
|
310
|
-
# Returns buyer information for the order items in the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
310
|
+
# Returns buyer information for the order items in the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the 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).
|
|
311
311
|
# @param order_id An Amazon-defined order identifier, in 3-7-7 format.
|
|
312
312
|
# @param [Hash] opts the optional parameters
|
|
313
313
|
# @option opts [String] :next_token A string token returned in the response of your previous request.
|
|
@@ -354,8 +354,8 @@ module AmazonSpClients
|
|
|
354
354
|
end
|
|
355
355
|
return data
|
|
356
356
|
end
|
|
357
|
-
# Returns regulated information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
358
|
-
# @param order_id
|
|
357
|
+
# Returns regulated information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the 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).
|
|
358
|
+
# @param order_id The Amazon order identifier in 3-7-7 format.
|
|
359
359
|
# @param [Hash] opts the optional parameters
|
|
360
360
|
# @return [GetOrderRegulatedInfoResponse]
|
|
361
361
|
def get_order_regulated_info(order_id, opts = {})
|
|
@@ -363,8 +363,8 @@ module AmazonSpClients
|
|
|
363
363
|
return data
|
|
364
364
|
end
|
|
365
365
|
|
|
366
|
-
# Returns regulated information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
367
|
-
# @param order_id
|
|
366
|
+
# Returns regulated information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the 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).
|
|
367
|
+
# @param order_id The Amazon order identifier in 3-7-7 format.
|
|
368
368
|
# @param [Hash] opts the optional parameters
|
|
369
369
|
# @return [Array<(GetOrderRegulatedInfoResponse)>] GetOrderRegulatedInfoResponse data, response status code and response headers
|
|
370
370
|
def get_order_regulated_info_with_http_info(order_id, opts = {})
|
|
@@ -408,7 +408,7 @@ module AmazonSpClients
|
|
|
408
408
|
end
|
|
409
409
|
return data
|
|
410
410
|
end
|
|
411
|
-
# Returns orders that are created or updated during the specified time period. If you want to return specific types of orders, you can apply filters to your request. `NextToken` doesn't affect any filters that you include in your request; it only impacts the pagination for the filtered orders response. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header
|
|
411
|
+
# Returns orders that are created or updated during the specified time period. If you want to return specific types of orders, you can apply filters to your request. `NextToken` doesn't affect any filters that you include in your request; it only impacts the pagination for the filtered orders response. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the 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).
|
|
412
412
|
# @param marketplace_ids A list of `MarketplaceId` values. Used to select orders that were placed in the specified marketplaces. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of `marketplaceId` values.
|
|
413
413
|
# @param [Hash] opts the optional parameters
|
|
414
414
|
# @option opts [String] :created_after Use this date to select orders created after (or at) a specified time. Only orders placed after the specified time are returned. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. **Note**: Either the `CreatedAfter` parameter or the `LastUpdatedAfter` parameter is required. Both cannot be empty. `LastUpdatedAfter` and `LastUpdatedBefore` cannot be set when `CreatedAfter` is set.
|
|
@@ -419,7 +419,7 @@ module AmazonSpClients
|
|
|
419
419
|
# @option opts [Array<String>] :fulfillment_channels A list that indicates how an order was fulfilled. Filters the results by fulfillment channel. **Possible values**: `AFN` (fulfilled by Amazon), `MFN` (fulfilled by seller).
|
|
420
420
|
# @option opts [Array<String>] :payment_methods A list of payment method values. Use this field to select orders that were paid with the specified payment methods. **Possible values**: `COD` (cash on delivery), `CVS` (convenience store), `Other` (Any payment method other than COD or CVS).
|
|
421
421
|
# @option opts [String] :buyer_email The email address of a buyer. Used to select orders that contain the specified email address.
|
|
422
|
-
# @option opts [String] :seller_order_id An order identifier that is specified by the seller. Used to select only the orders that match the order identifier. If `SellerOrderId` is specified, then `FulfillmentChannels`, `OrderStatuses`, `PaymentMethod`, `LastUpdatedAfter`, LastUpdatedBefore
|
|
422
|
+
# @option opts [String] :seller_order_id An order identifier that is specified by the seller. Used to select only the orders that match the order identifier. If `SellerOrderId` is specified, then `FulfillmentChannels`, `OrderStatuses`, `PaymentMethod`, `LastUpdatedAfter`, `LastUpdatedBefore`, and `BuyerEmail` cannot be specified.
|
|
423
423
|
# @option opts [Integer] :max_results_per_page A number that indicates the maximum number of orders that can be returned per page. Value must be 1 - 100. Default 100.
|
|
424
424
|
# @option opts [Array<String>] :easy_ship_shipment_statuses A list of `EasyShipShipmentStatus` values. Used to select Easy Ship orders with statuses that match the specified values. If `EasyShipShipmentStatus` is specified, only Amazon Easy Ship orders are returned. **Possible values:** - `PendingSchedule` (The package is awaiting the schedule for pick-up.) - `PendingPickUp` (Amazon has not yet picked up the package from the seller.) - `PendingDropOff` (The seller will deliver the package to the carrier.) - `LabelCanceled` (The seller canceled the pickup.) - `PickedUp` (Amazon has picked up the package from the seller.) - `DroppedOff` (The package is delivered to the carrier by the seller.) - `AtOriginFC` (The packaged is at the origin fulfillment center.) - `AtDestinationFC` (The package is at the destination fulfillment center.) - `Delivered` (The package has been delivered.) - `RejectedByBuyer` (The package has been rejected by the buyer.) - `Undeliverable` (The package cannot be delivered.) - `ReturningToSeller` (The package was not delivered and is being returned to the seller.) - `ReturnedToSeller` (The package was not delivered and was returned to the seller.) - `Lost` (The package is lost.) - `OutForDelivery` (The package is out for delivery.) - `Damaged` (The package was damaged by the carrier.)
|
|
425
425
|
# @option opts [Array<String>] :electronic_invoice_statuses A list of `ElectronicInvoiceStatus` values. Used to select orders with electronic invoice statuses that match the specified values. **Possible values:** - `NotRequired` (Electronic invoice submission is not required for this order.) - `NotFound` (The electronic invoice was not submitted for this order.) - `Processing` (The electronic invoice is being processed for this order.) - `Errored` (The last submitted electronic invoice was rejected for this order.) - `Accepted` (The last submitted electronic invoice was submitted and accepted.)
|
|
@@ -428,8 +428,8 @@ module AmazonSpClients
|
|
|
428
428
|
# @option opts [String] :actual_fulfillment_supply_source_id The `sourceId` of the location from where you want the order fulfilled.
|
|
429
429
|
# @option opts [BOOLEAN] :is_ispu When true, this order is marked to be picked up from a store rather than delivered.
|
|
430
430
|
# @option opts [String] :store_chain_store_id The store chain store identifier. Linked to a specific store in a store chain.
|
|
431
|
-
# @option opts [String] :earliest_delivery_date_before Use this date to select orders with
|
|
432
|
-
# @option opts [String] :earliest_delivery_date_after Use this date to select orders with
|
|
431
|
+
# @option opts [String] :earliest_delivery_date_before Use this date to select orders with an earliest delivery date before (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
|
|
432
|
+
# @option opts [String] :earliest_delivery_date_after Use this date to select orders with an earliest delivery date after (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
|
|
433
433
|
# @option opts [String] :latest_delivery_date_before Use this date to select orders with a latest delivery date before (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
|
|
434
434
|
# @option opts [String] :latest_delivery_date_after Use this date to select orders with a latest delivery date after (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
|
|
435
435
|
# @return [GetOrdersResponse]
|
|
@@ -438,7 +438,7 @@ module AmazonSpClients
|
|
|
438
438
|
return data
|
|
439
439
|
end
|
|
440
440
|
|
|
441
|
-
# Returns orders that are created or updated during the specified time period. If you want to return specific types of orders, you can apply filters to your request. `NextToken` doesn't affect any filters that you include in your request; it only impacts the pagination for the filtered orders response. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header
|
|
441
|
+
# Returns orders that are created or updated during the specified time period. If you want to return specific types of orders, you can apply filters to your request. `NextToken` doesn't affect any filters that you include in your request; it only impacts the pagination for the filtered orders response. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the 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).
|
|
442
442
|
# @param marketplace_ids A list of `MarketplaceId` values. Used to select orders that were placed in the specified marketplaces. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of `marketplaceId` values.
|
|
443
443
|
# @param [Hash] opts the optional parameters
|
|
444
444
|
# @option opts [String] :created_after Use this date to select orders created after (or at) a specified time. Only orders placed after the specified time are returned. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. **Note**: Either the `CreatedAfter` parameter or the `LastUpdatedAfter` parameter is required. Both cannot be empty. `LastUpdatedAfter` and `LastUpdatedBefore` cannot be set when `CreatedAfter` is set.
|
|
@@ -449,7 +449,7 @@ module AmazonSpClients
|
|
|
449
449
|
# @option opts [Array<String>] :fulfillment_channels A list that indicates how an order was fulfilled. Filters the results by fulfillment channel. **Possible values**: `AFN` (fulfilled by Amazon), `MFN` (fulfilled by seller).
|
|
450
450
|
# @option opts [Array<String>] :payment_methods A list of payment method values. Use this field to select orders that were paid with the specified payment methods. **Possible values**: `COD` (cash on delivery), `CVS` (convenience store), `Other` (Any payment method other than COD or CVS).
|
|
451
451
|
# @option opts [String] :buyer_email The email address of a buyer. Used to select orders that contain the specified email address.
|
|
452
|
-
# @option opts [String] :seller_order_id An order identifier that is specified by the seller. Used to select only the orders that match the order identifier. If `SellerOrderId` is specified, then `FulfillmentChannels`, `OrderStatuses`, `PaymentMethod`, `LastUpdatedAfter`, LastUpdatedBefore
|
|
452
|
+
# @option opts [String] :seller_order_id An order identifier that is specified by the seller. Used to select only the orders that match the order identifier. If `SellerOrderId` is specified, then `FulfillmentChannels`, `OrderStatuses`, `PaymentMethod`, `LastUpdatedAfter`, `LastUpdatedBefore`, and `BuyerEmail` cannot be specified.
|
|
453
453
|
# @option opts [Integer] :max_results_per_page A number that indicates the maximum number of orders that can be returned per page. Value must be 1 - 100. Default 100.
|
|
454
454
|
# @option opts [Array<String>] :easy_ship_shipment_statuses A list of `EasyShipShipmentStatus` values. Used to select Easy Ship orders with statuses that match the specified values. If `EasyShipShipmentStatus` is specified, only Amazon Easy Ship orders are returned. **Possible values:** - `PendingSchedule` (The package is awaiting the schedule for pick-up.) - `PendingPickUp` (Amazon has not yet picked up the package from the seller.) - `PendingDropOff` (The seller will deliver the package to the carrier.) - `LabelCanceled` (The seller canceled the pickup.) - `PickedUp` (Amazon has picked up the package from the seller.) - `DroppedOff` (The package is delivered to the carrier by the seller.) - `AtOriginFC` (The packaged is at the origin fulfillment center.) - `AtDestinationFC` (The package is at the destination fulfillment center.) - `Delivered` (The package has been delivered.) - `RejectedByBuyer` (The package has been rejected by the buyer.) - `Undeliverable` (The package cannot be delivered.) - `ReturningToSeller` (The package was not delivered and is being returned to the seller.) - `ReturnedToSeller` (The package was not delivered and was returned to the seller.) - `Lost` (The package is lost.) - `OutForDelivery` (The package is out for delivery.) - `Damaged` (The package was damaged by the carrier.)
|
|
455
455
|
# @option opts [Array<String>] :electronic_invoice_statuses A list of `ElectronicInvoiceStatus` values. Used to select orders with electronic invoice statuses that match the specified values. **Possible values:** - `NotRequired` (Electronic invoice submission is not required for this order.) - `NotFound` (The electronic invoice was not submitted for this order.) - `Processing` (The electronic invoice is being processed for this order.) - `Errored` (The last submitted electronic invoice was rejected for this order.) - `Accepted` (The last submitted electronic invoice was submitted and accepted.)
|
|
@@ -458,8 +458,8 @@ module AmazonSpClients
|
|
|
458
458
|
# @option opts [String] :actual_fulfillment_supply_source_id The `sourceId` of the location from where you want the order fulfilled.
|
|
459
459
|
# @option opts [BOOLEAN] :is_ispu When true, this order is marked to be picked up from a store rather than delivered.
|
|
460
460
|
# @option opts [String] :store_chain_store_id The store chain store identifier. Linked to a specific store in a store chain.
|
|
461
|
-
# @option opts [String] :earliest_delivery_date_before Use this date to select orders with
|
|
462
|
-
# @option opts [String] :earliest_delivery_date_after Use this date to select orders with
|
|
461
|
+
# @option opts [String] :earliest_delivery_date_before Use this date to select orders with an earliest delivery date before (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
|
|
462
|
+
# @option opts [String] :earliest_delivery_date_after Use this date to select orders with an earliest delivery date after (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
|
|
463
463
|
# @option opts [String] :latest_delivery_date_before Use this date to select orders with a latest delivery date before (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
|
|
464
464
|
# @option opts [String] :latest_delivery_date_after Use this date to select orders with a latest delivery date after (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
|
|
465
465
|
# @return [Array<(GetOrdersResponse)>] GetOrdersResponse data, response status code and response headers
|
|
@@ -526,9 +526,9 @@ module AmazonSpClients
|
|
|
526
526
|
end
|
|
527
527
|
return data
|
|
528
528
|
end
|
|
529
|
-
# Updates (approves or rejects) the verification status of an order containing regulated products. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
529
|
+
# Updates (approves or rejects) the verification status of an order containing regulated products. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the 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).
|
|
530
530
|
# @param body The request body for the `updateVerificationStatus` operation.
|
|
531
|
-
# @param order_id
|
|
531
|
+
# @param order_id The Amazon order identifier in 3-7-7 format.
|
|
532
532
|
# @param [Hash] opts the optional parameters
|
|
533
533
|
# @return [nil]
|
|
534
534
|
def update_verification_status(body, order_id, opts = {})
|
|
@@ -536,9 +536,9 @@ module AmazonSpClients
|
|
|
536
536
|
return nil
|
|
537
537
|
end
|
|
538
538
|
|
|
539
|
-
# Updates (approves or rejects) the verification status of an order containing regulated products. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
539
|
+
# Updates (approves or rejects) the verification status of an order containing regulated products. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the 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).
|
|
540
540
|
# @param body The request body for the `updateVerificationStatus` operation.
|
|
541
|
-
# @param order_id
|
|
541
|
+
# @param order_id The Amazon order identifier in 3-7-7 format.
|
|
542
542
|
# @param [Hash] opts the optional parameters
|
|
543
543
|
# @return [Array<(nil)>] nil, response status code and response headers
|
|
544
544
|
def update_verification_status_with_http_info(body, order_id, opts = {})
|
|
@@ -16,7 +16,7 @@ module AmazonSpClients
|
|
|
16
16
|
def initialize(session)
|
|
17
17
|
@api_client = AmazonSpClients::ApiClient.new(session)
|
|
18
18
|
end
|
|
19
|
-
# Update the shipment status for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | The `x-amzn-RateLimit-Limit` response header
|
|
19
|
+
# Update the shipment status for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the 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).
|
|
20
20
|
# @param body The request body for the `updateShipmentStatus` operation.
|
|
21
21
|
# @param order_id An Amazon-defined order identifier, in 3-7-7 format.
|
|
22
22
|
# @param [Hash] opts the optional parameters
|
|
@@ -26,7 +26,7 @@ module AmazonSpClients
|
|
|
26
26
|
return nil
|
|
27
27
|
end
|
|
28
28
|
|
|
29
|
-
# Update the shipment status for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | The `x-amzn-RateLimit-Limit` response header
|
|
29
|
+
# Update the shipment status for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the 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).
|
|
30
30
|
# @param body The request body for the `updateShipmentStatus` operation.
|
|
31
31
|
# @param order_id An Amazon-defined order identifier, in 3-7-7 format.
|
|
32
32
|
# @param [Hash] opts the optional parameters
|
|
@@ -293,6 +293,7 @@ module AmazonSpClients
|
|
|
293
293
|
# 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).
|
|
294
294
|
# @param report_document_id The identifier for the report document.
|
|
295
295
|
# @param [Hash] opts the optional parameters
|
|
296
|
+
# @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.
|
|
296
297
|
# @return [ReportDocument]
|
|
297
298
|
def get_report_document(report_document_id, opts = {})
|
|
298
299
|
data = get_report_document_with_http_info(report_document_id, opts)
|
|
@@ -302,6 +303,7 @@ module AmazonSpClients
|
|
|
302
303
|
# 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).
|
|
303
304
|
# @param report_document_id The identifier for the report document.
|
|
304
305
|
# @param [Hash] opts the optional parameters
|
|
306
|
+
# @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.
|
|
305
307
|
# @return [Array<(ReportDocument)>] ReportDocument data, response status code and response headers
|
|
306
308
|
def get_report_document_with_http_info(report_document_id, opts = {})
|
|
307
309
|
if @api_client.config.debugging
|
|
@@ -316,6 +318,7 @@ module AmazonSpClients
|
|
|
316
318
|
|
|
317
319
|
# query parameters
|
|
318
320
|
query_params = opts[:query_params] || {}
|
|
321
|
+
query_params[:'enableContentEncodingUrlHeader'] = opts[:'enable_content_encoding_url_header'] if !opts[:'enable_content_encoding_url_header'].nil?
|
|
319
322
|
|
|
320
323
|
# header parameters
|
|
321
324
|
header_params = opts[:header_params] || {}
|
|
@@ -70,7 +70,7 @@ module AmazonSpClients
|
|
|
70
70
|
end
|
|
71
71
|
return data
|
|
72
72
|
end
|
|
73
|
-
# 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
|
|
73
|
+
# 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).
|
|
74
74
|
# @param [Hash] opts the optional parameters
|
|
75
75
|
# @option opts [Integer] :limit The limit to the number of records returned. Default value is 100 records.
|
|
76
76
|
# @option opts [DateTime] :created_after Purchase orders that became available after this time will be included in the result. Must be in ISO-8601 date/time format.
|
|
@@ -90,7 +90,7 @@ module AmazonSpClients
|
|
|
90
90
|
return data
|
|
91
91
|
end
|
|
92
92
|
|
|
93
|
-
# 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
|
|
93
|
+
# 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).
|
|
94
94
|
# @param [Hash] opts the optional parameters
|
|
95
95
|
# @option opts [Integer] :limit The limit to the number of records returned. Default value is 100 records.
|
|
96
96
|
# @option opts [DateTime] :created_after Purchase orders that became available after this time will be included in the result. Must be in ISO-8601 date/time format.
|
|
@@ -31,7 +31,7 @@ module AmazonSpClients
|
|
|
31
31
|
# @option opts [DateTime] :shipped_before 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.
|
|
32
32
|
# @option opts [DateTime] :shipped_after 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.
|
|
33
33
|
# @option opts [DateTime] :estimated_delivery_before 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.
|
|
34
|
-
# @option opts [DateTime] :estimated_delivery_after Get Shipment Details by passing Estimated Delivery Date
|
|
34
|
+
# @option opts [DateTime] :estimated_delivery_after 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.
|
|
35
35
|
# @option opts [DateTime] :shipment_delivery_before 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.
|
|
36
36
|
# @option opts [DateTime] :shipment_delivery_after 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.
|
|
37
37
|
# @option opts [DateTime] :requested_pick_up_before 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.
|
|
@@ -64,7 +64,7 @@ module AmazonSpClients
|
|
|
64
64
|
# @option opts [DateTime] :shipped_before 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.
|
|
65
65
|
# @option opts [DateTime] :shipped_after 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.
|
|
66
66
|
# @option opts [DateTime] :estimated_delivery_before 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.
|
|
67
|
-
# @option opts [DateTime] :estimated_delivery_after Get Shipment Details by passing Estimated Delivery Date
|
|
67
|
+
# @option opts [DateTime] :estimated_delivery_after 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.
|
|
68
68
|
# @option opts [DateTime] :shipment_delivery_before 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.
|
|
69
69
|
# @option opts [DateTime] :shipment_delivery_after 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.
|
|
70
70
|
# @option opts [DateTime] :requested_pick_up_before 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.
|
|
@@ -145,7 +145,7 @@ module AmazonSpClients
|
|
|
145
145
|
# @param [Hash] opts the optional parameters
|
|
146
146
|
# @option opts [Integer] :limit The limit to the number of records returned. Default value is 50 records.
|
|
147
147
|
# @option opts [String] :sort_order Sort the list by shipment label creation date in ascending or descending order.
|
|
148
|
-
# @option opts [String] :next_token A token that
|
|
148
|
+
# @option opts [String] :next_token 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.
|
|
149
149
|
# @option opts [DateTime] :label_created_after 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.
|
|
150
150
|
# @option opts [DateTime] :label_created_before 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.
|
|
151
151
|
# @option opts [String] :buyer_reference_number Get Shipment labels by passing buyer reference number.
|
|
@@ -161,7 +161,7 @@ module AmazonSpClients
|
|
|
161
161
|
# @param [Hash] opts the optional parameters
|
|
162
162
|
# @option opts [Integer] :limit The limit to the number of records returned. Default value is 50 records.
|
|
163
163
|
# @option opts [String] :sort_order Sort the list by shipment label creation date in ascending or descending order.
|
|
164
|
-
# @option opts [String] :next_token A token that
|
|
164
|
+
# @option opts [String] :next_token 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.
|
|
165
165
|
# @option opts [DateTime] :label_created_after 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.
|
|
166
166
|
# @option opts [DateTime] :label_created_before 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.
|
|
167
167
|
# @option opts [String] :buyer_reference_number Get Shipment labels by passing buyer reference number.
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: sp_api_clients
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 2.0
|
|
4
|
+
version: 2.1.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Dropstream
|
|
@@ -239,6 +239,7 @@ files:
|
|
|
239
239
|
- lib/amazon_sp_clients/v2/apis/feeds_2021.rb
|
|
240
240
|
- lib/amazon_sp_clients/v2/apis/fulfillment_outbound_2020.rb
|
|
241
241
|
- lib/amazon_sp_clients/v2/apis/listings_items_2021.rb
|
|
242
|
+
- lib/amazon_sp_clients/v2/apis/orders_2026.rb
|
|
242
243
|
- lib/amazon_sp_clients/v2/apis/orders_v0.rb
|
|
243
244
|
- lib/amazon_sp_clients/v2/apis/reports_2021.rb
|
|
244
245
|
- lib/amazon_sp_clients/v2/apis/tokens_2021.rb
|