Class: AmznSpApi::FulfillmentOutboundApiModel::FbaOutboundApi

Inherits:
Object
  • Object
show all
Defined in:
lib/fulfillment_outbound_api_model/api/fba_outbound_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ FbaOutboundApi

Returns a new instance of FbaOutboundApi.



14
15
16
 
# File 'lib/fulfillment_outbound_api_model/api/fba_outbound_api.rb', line 14

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



12
13
14
 
# File 'lib/fulfillment_outbound_api_model/api/fba_outbound_api.rb', line 12

def api_client
  @api_client
end

Instance Method Details

#cancel_fulfillment_order(seller_fulfillment_order_id, opts = {}) ⇒ CancelFulfillmentOrderResponse

Requests that Amazon stop attempting to fulfill the fulfillment order indicated by the specified order identifier. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | 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, see [Usage Plans and Rate Limits in the Selling Partner API](developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • seller_fulfillment_order_id —

    The identifier assigned to the item by the seller when the fulfillment order was created.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



22
23
24
25
 
# File 'lib/fulfillment_outbound_api_model/api/fba_outbound_api.rb', line 22

def cancel_fulfillment_order(seller_fulfillment_order_id, opts = {})
  data, _status_code, _headers = cancel_fulfillment_order_with_http_info(seller_fulfillment_order_id, opts)
  data
end

#cancel_fulfillment_order_with_http_info(seller_fulfillment_order_id, opts = {}) ⇒ Array<(CancelFulfillmentOrderResponse, Integer, Hash)>

Requests that Amazon stop attempting to fulfill the fulfillment order indicated by the specified order identifier. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | The &#x60;x-amzn-RateLimit-Limit&#x60; 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, see [Usage Plans and Rate Limits in the Selling Partner API](developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • seller_fulfillment_order_id —

    The identifier assigned to the item by the seller when the fulfillment order was created.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

Raises:

  • (ArgumentError) 


31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/fulfillment_outbound_api_model/api/fba_outbound_api.rb', line 31

def cancel_fulfillment_order_with_http_info(seller_fulfillment_order_id, opts = {})
  @api_client.config.logger.debug 'Calling API: FbaOutboundApi.cancel_fulfillment_order ...' if @api_client.config.debugging
  # verify the required parameter 'seller_fulfillment_order_id' is set
  raise ArgumentError, "Missing the required parameter 'seller_fulfillment_order_id' when calling FbaOutboundApi.cancel_fulfillment_order" if @api_client.config.client_side_validation && seller_fulfillment_order_id.nil?

  # resource path
  local_var_path = '/fba/outbound/2020-07-01/fulfillmentOrders/{sellerFulfillmentOrderId}/cancel'.sub('{' + 'sellerFulfillmentOrderId' + '}', seller_fulfillment_order_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body]

  return_type = opts[:return_type] || 'CancelFulfillmentOrderResponse'

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
                                                    header_params: header_params,
                                                    query_params: query_params,
                                                    form_params: form_params,
                                                    body: post_body,
                                                    auth_names: auth_names,
                                                    return_type: return_type)

  @api_client.config.logger.debug "API called: FbaOutboundApi#cancel_fulfillment_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#create_fulfillment_order(body, opts = {}) ⇒ CreateFulfillmentOrderResponse

Requests that Amazon ship items from the seller’s inventory in Amazon’s fulfillment network to a destination address. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | 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, see [Usage Plans and Rate Limits in the Selling Partner API](developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)

Parameters:

  • body
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



72
73
74
75
 
# File 'lib/fulfillment_outbound_api_model/api/fba_outbound_api.rb', line 72

def create_fulfillment_order(body, opts = {})
  data, _status_code, _headers = create_fulfillment_order_with_http_info(body, opts)
  data
end

#create_fulfillment_order_with_http_info(body, opts = {}) ⇒ Array<(CreateFulfillmentOrderResponse, Integer, Hash)>

Requests that Amazon ship items from the seller&#x27;s inventory in Amazon&#x27;s fulfillment network to a destination address. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | The &#x60;x-amzn-RateLimit-Limit&#x60; 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, see [Usage Plans and Rate Limits in the Selling Partner API](developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)

Parameters:

  • body
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

Raises:

  • (ArgumentError) 


81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/fulfillment_outbound_api_model/api/fba_outbound_api.rb', line 81

def create_fulfillment_order_with_http_info(body, opts = {})
  @api_client.config.logger.debug 'Calling API: FbaOutboundApi.create_fulfillment_order ...' if @api_client.config.debugging
  # verify the required parameter 'body' is set
  raise ArgumentError, "Missing the required parameter 'body' when calling FbaOutboundApi.create_fulfillment_order" if @api_client.config.client_side_validation && body.nil?

  # resource path
  local_var_path = '/fba/outbound/2020-07-01/fulfillmentOrders'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body)

  return_type = opts[:return_type] || 'CreateFulfillmentOrderResponse'

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
                                                    header_params: header_params,
                                                    query_params: query_params,
                                                    form_params: form_params,
                                                    body: post_body,
                                                    auth_names: auth_names,
                                                    return_type: return_type)

  @api_client.config.logger.debug "API called: FbaOutboundApi#create_fulfillment_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#create_fulfillment_return(body, seller_fulfillment_order_id, opts = {}) ⇒ CreateFulfillmentReturnResponse

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 see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • body
  • seller_fulfillment_order_id —

    An identifier assigned by the seller to the fulfillment order at the time it was created. The seller uses their own records to find the correct SellerFulfillmentOrderId value based on the buyer&#x27;s request to return items.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



125
126
127
128
 
# File 'lib/fulfillment_outbound_api_model/api/fba_outbound_api.rb', line 125

def create_fulfillment_return(body, seller_fulfillment_order_id, opts = {})
  data, _status_code, _headers = create_fulfillment_return_with_http_info(body, seller_fulfillment_order_id, opts)
  data
end

#create_fulfillment_return_with_http_info(body, seller_fulfillment_order_id, opts = {}) ⇒ Array<(CreateFulfillmentReturnResponse, Integer, Hash)>

Creates a fulfillment return. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | The &#x60;x-amzn-RateLimit-Limit&#x60; 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, see [Usage Plans and Rate Limits in the Selling Partner API](developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • body
  • seller_fulfillment_order_id —

    An identifier assigned by the seller to the fulfillment order at the time it was created. The seller uses their own records to find the correct SellerFulfillmentOrderId value based on the buyer&#x27;s request to return items.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

Raises:

  • (ArgumentError) 


135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/fulfillment_outbound_api_model/api/fba_outbound_api.rb', line 135

def create_fulfillment_return_with_http_info(body, seller_fulfillment_order_id, opts = {})
  @api_client.config.logger.debug 'Calling API: FbaOutboundApi.create_fulfillment_return ...' if @api_client.config.debugging
  # verify the required parameter 'body' is set
  raise ArgumentError, "Missing the required parameter 'body' when calling FbaOutboundApi.create_fulfillment_return" if @api_client.config.client_side_validation && body.nil?
  # verify the required parameter 'seller_fulfillment_order_id' is set
  raise ArgumentError, "Missing the required parameter 'seller_fulfillment_order_id' when calling FbaOutboundApi.create_fulfillment_return" if @api_client.config.client_side_validation && seller_fulfillment_order_id.nil?

  # resource path
  local_var_path = '/fba/outbound/2020-07-01/fulfillmentOrders/{sellerFulfillmentOrderId}/return'.sub('{' + 'sellerFulfillmentOrderId' + '}', seller_fulfillment_order_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'payload'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body)

  return_type = opts[:return_type] || 'CreateFulfillmentReturnResponse'

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
                                                    header_params: header_params,
                                                    query_params: query_params,
                                                    form_params: form_params,
                                                    body: post_body,
                                                    auth_names: auth_names,
                                                    return_type: return_type)

  @api_client.config.logger.debug "API called: FbaOutboundApi#create_fulfillment_return\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#get_feature_inventory(marketplace_id, feature_name, opts = {}) ⇒ GetFeatureInventoryResponse

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 see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)..

Parameters:

  • marketplace_id —

    The marketplace for which to return a list of the inventory that is eligible for the specified feature.

  • feature_name —

    The name of the feature for which to return a list of eligible inventory.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :next_token (String) —

    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.

Returns:



182
183
184
185
 
# File 'lib/fulfillment_outbound_api_model/api/fba_outbound_api.rb', line 182

def get_feature_inventory(marketplace_id, feature_name, opts = {})
  data, _status_code, _headers = get_feature_inventory_with_http_info(marketplace_id, feature_name, opts)
  data
end

#get_feature_inventory_with_http_info(marketplace_id, feature_name, opts = {}) ⇒ Array<(GetFeatureInventoryResponse, Integer, Hash)>

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 &#x60;x-amzn-RateLimit-Limit&#x60; 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, see [Usage Plans and Rate Limits in the Selling Partner API](developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)..

Parameters:

  • marketplace_id —

    The marketplace for which to return a list of the inventory that is eligible for the specified feature.

  • feature_name —

    The name of the feature for which to return a list of eligible inventory.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :next_token (String) —

    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.

Returns:

  • (Array<(GetFeatureInventoryResponse, Integer, Hash)>) —

    GetFeatureInventoryResponse data, response status code and response headers

Raises:

  • (ArgumentError) 


193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/fulfillment_outbound_api_model/api/fba_outbound_api.rb', line 193

def get_feature_inventory_with_http_info(marketplace_id, feature_name, opts = {})
  @api_client.config.logger.debug 'Calling API: FbaOutboundApi.get_feature_inventory ...' if @api_client.config.debugging
  # verify the required parameter 'marketplace_id' is set
  raise ArgumentError, "Missing the required parameter 'marketplace_id' when calling FbaOutboundApi.get_feature_inventory" if @api_client.config.client_side_validation && marketplace_id.nil?
  # verify the required parameter 'feature_name' is set
  raise ArgumentError, "Missing the required parameter 'feature_name' when calling FbaOutboundApi.get_feature_inventory" if @api_client.config.client_side_validation && feature_name.nil?

  # resource path
  local_var_path = '/fba/outbound/2020-07-01/features/inventory/{featureName}'.sub('{' + 'featureName' + '}', feature_name.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:marketplaceId] = marketplace_id
  query_params[:nextToken] = opts[:next_token] unless opts[:next_token].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'payload'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body]

  return_type = opts[:return_type] || 'GetFeatureInventoryResponse'

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
                                                    header_params: header_params,
                                                    query_params: query_params,
                                                    form_params: form_params,
                                                    body: post_body,
                                                    auth_names: auth_names,
                                                    return_type: return_type)

  @api_client.config.logger.debug "API called: FbaOutboundApi#get_feature_inventory\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#get_feature_sku(marketplace_id, feature_name, seller_sku, opts = {}) ⇒ GetFeatureSkuResponse

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](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 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, see [Usage Plans and Rate Limits in the Selling Partner API](developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • marketplace_id —

    The marketplace for which to return the count.

  • feature_name —

    The name of the feature.

  • seller_sku —

    Used to identify an item in the given marketplace. SellerSKU is qualified by the seller&#x27;s SellerId, which is included with every operation that you submit.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



240
241
242
243
 
# File 'lib/fulfillment_outbound_api_model/api/fba_outbound_api.rb', line 240

def get_feature_sku(marketplace_id, feature_name, seller_sku, opts = {})
  data, _status_code, _headers = get_feature_sku_with_http_info(marketplace_id, feature_name, seller_sku, opts)
  data
end

#get_feature_sku_with_http_info(marketplace_id, feature_name, seller_sku, opts = {}) ⇒ Array<(GetFeatureSkuResponse, Integer, Hash)>

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&#x27;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](developer-docs.amazon.com/sp-api/docs/url-encoding). **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | The &#x60;x-amzn-RateLimit-Limit&#x60; 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, see [Usage Plans and Rate Limits in the Selling Partner API](developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • marketplace_id —

    The marketplace for which to return the count.

  • feature_name —

    The name of the feature.

  • seller_sku —

    Used to identify an item in the given marketplace. SellerSKU is qualified by the seller&#x27;s SellerId, which is included with every operation that you submit.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(GetFeatureSkuResponse, Integer, Hash)>) —

    GetFeatureSkuResponse data, response status code and response headers

Raises:

  • (ArgumentError) 


251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/fulfillment_outbound_api_model/api/fba_outbound_api.rb', line 251

def get_feature_sku_with_http_info(marketplace_id, feature_name, seller_sku, opts = {})
  @api_client.config.logger.debug 'Calling API: FbaOutboundApi.get_feature_sku ...' if @api_client.config.debugging
  # verify the required parameter 'marketplace_id' is set
  raise ArgumentError, "Missing the required parameter 'marketplace_id' when calling FbaOutboundApi.get_feature_sku" if @api_client.config.client_side_validation && marketplace_id.nil?
  # verify the required parameter 'feature_name' is set
  raise ArgumentError, "Missing the required parameter 'feature_name' when calling FbaOutboundApi.get_feature_sku" if @api_client.config.client_side_validation && feature_name.nil?
  # verify the required parameter 'seller_sku' is set
  raise ArgumentError, "Missing the required parameter 'seller_sku' when calling FbaOutboundApi.get_feature_sku" if @api_client.config.client_side_validation && seller_sku.nil?

  # resource path
  local_var_path = '/fba/outbound/2020-07-01/features/inventory/{featureName}/{sellerSku}'.sub('{' + 'featureName' + '}', feature_name.to_s).sub('{' + 'sellerSku' + '}', seller_sku.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:marketplaceId] = marketplace_id

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'payload'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body]

  return_type = opts[:return_type] || 'GetFeatureSkuResponse'

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
                                                    header_params: header_params,
                                                    query_params: query_params,
                                                    form_params: form_params,
                                                    body: post_body,
                                                    auth_names: auth_names,
                                                    return_type: return_type)

  @api_client.config.logger.debug "API called: FbaOutboundApi#get_feature_sku\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#get_features(marketplace_id, opts = {}) ⇒ GetFeaturesResponse

Returns a list of features available for Multi-Channel Fulfillment orders in the marketplace you specify, and whether the seller for which you made the call is enrolled for each feature. **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 see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • marketplace_id —

    The marketplace for which to return the list of features.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



297
298
299
300
 
# File 'lib/fulfillment_outbound_api_model/api/fba_outbound_api.rb', line 297

def get_features(marketplace_id, opts = {})
  data, _status_code, _headers = get_features_with_http_info(marketplace_id, opts)
  data
end

#get_features_with_http_info(marketplace_id, opts = {}) ⇒ Array<(GetFeaturesResponse, Integer, Hash)>

Returns a list of features available for Multi-Channel Fulfillment orders in the marketplace you specify, and whether the seller for which you made the call is enrolled for each feature. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | The &#x60;x-amzn-RateLimit-Limit&#x60; 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, see [Usage Plans and Rate Limits in the Selling Partner API](developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • marketplace_id —

    The marketplace for which to return the list of features.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(GetFeaturesResponse, Integer, Hash)>) —

    GetFeaturesResponse data, response status code and response headers

Raises:

  • (ArgumentError) 


306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/fulfillment_outbound_api_model/api/fba_outbound_api.rb', line 306

def get_features_with_http_info(marketplace_id, opts = {})
  @api_client.config.logger.debug 'Calling API: FbaOutboundApi.get_features ...' if @api_client.config.debugging
  # verify the required parameter 'marketplace_id' is set
  raise ArgumentError, "Missing the required parameter 'marketplace_id' when calling FbaOutboundApi.get_features" if @api_client.config.client_side_validation && marketplace_id.nil?

  # resource path
  local_var_path = '/fba/outbound/2020-07-01/features'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:marketplaceId] = marketplace_id

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'payload'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body]

  return_type = opts[:return_type] || 'GetFeaturesResponse'

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
                                                    header_params: header_params,
                                                    query_params: query_params,
                                                    form_params: form_params,
                                                    body: post_body,
                                                    auth_names: auth_names,
                                                    return_type: return_type)

  @api_client.config.logger.debug "API called: FbaOutboundApi#get_features\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#get_fulfillment_order(seller_fulfillment_order_id, opts = {}) ⇒ GetFulfillmentOrderResponse

Returns the fulfillment order indicated by the specified order identifier. **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 see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • seller_fulfillment_order_id —

    The identifier assigned to the item by the seller when the fulfillment order was created.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



348
349
350
351
 
# File 'lib/fulfillment_outbound_api_model/api/fba_outbound_api.rb', line 348

def get_fulfillment_order(seller_fulfillment_order_id, opts = {})
  data, _status_code, _headers = get_fulfillment_order_with_http_info(seller_fulfillment_order_id, opts)
  data
end

#get_fulfillment_order_with_http_info(seller_fulfillment_order_id, opts = {}) ⇒ Array<(GetFulfillmentOrderResponse, Integer, Hash)>

Returns the fulfillment order indicated by the specified order identifier. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | The &#x60;x-amzn-RateLimit-Limit&#x60; 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, see [Usage Plans and Rate Limits in the Selling Partner API](developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • seller_fulfillment_order_id —

    The identifier assigned to the item by the seller when the fulfillment order was created.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(GetFulfillmentOrderResponse, Integer, Hash)>) —

    GetFulfillmentOrderResponse data, response status code and response headers

Raises:

  • (ArgumentError) 


357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/fulfillment_outbound_api_model/api/fba_outbound_api.rb', line 357

def get_fulfillment_order_with_http_info(seller_fulfillment_order_id, opts = {})
  @api_client.config.logger.debug 'Calling API: FbaOutboundApi.get_fulfillment_order ...' if @api_client.config.debugging
  # verify the required parameter 'seller_fulfillment_order_id' is set
  raise ArgumentError, "Missing the required parameter 'seller_fulfillment_order_id' when calling FbaOutboundApi.get_fulfillment_order" if @api_client.config.client_side_validation && seller_fulfillment_order_id.nil?

  # resource path
  local_var_path = '/fba/outbound/2020-07-01/fulfillmentOrders/{sellerFulfillmentOrderId}'.sub('{' + 'sellerFulfillmentOrderId' + '}', seller_fulfillment_order_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'payload'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body]

  return_type = opts[:return_type] || 'GetFulfillmentOrderResponse'

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
                                                    header_params: header_params,
                                                    query_params: query_params,
                                                    form_params: form_params,
                                                    body: post_body,
                                                    auth_names: auth_names,
                                                    return_type: return_type)

  @api_client.config.logger.debug "API called: FbaOutboundApi#get_fulfillment_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#get_fulfillment_preview(body, opts = {}) ⇒ GetFulfillmentPreviewResponse

Returns a list of fulfillment order previews based on shipping criteria that 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 see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • body
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



398
399
400
401
 
# File 'lib/fulfillment_outbound_api_model/api/fba_outbound_api.rb', line 398

def get_fulfillment_preview(body, opts = {})
  data, _status_code, _headers = get_fulfillment_preview_with_http_info(body, opts)
  data
end

#get_fulfillment_preview_with_http_info(body, opts = {}) ⇒ Array<(GetFulfillmentPreviewResponse, Integer, Hash)>

Returns a list of fulfillment order previews based on shipping criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | The &#x60;x-amzn-RateLimit-Limit&#x60; 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, see [Usage Plans and Rate Limits in the Selling Partner API](developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • body
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

Raises:

  • (ArgumentError) 


407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
 
# File 'lib/fulfillment_outbound_api_model/api/fba_outbound_api.rb', line 407

def get_fulfillment_preview_with_http_info(body, opts = {})
  @api_client.config.logger.debug 'Calling API: FbaOutboundApi.get_fulfillment_preview ...' if @api_client.config.debugging
  # verify the required parameter 'body' is set
  raise ArgumentError, "Missing the required parameter 'body' when calling FbaOutboundApi.get_fulfillment_preview" if @api_client.config.client_side_validation && body.nil?

  # resource path
  local_var_path = '/fba/outbound/2020-07-01/fulfillmentOrders/preview'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'payload'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body)

  return_type = opts[:return_type] || 'GetFulfillmentPreviewResponse'

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
                                                    header_params: header_params,
                                                    query_params: query_params,
                                                    form_params: form_params,
                                                    body: post_body,
                                                    auth_names: auth_names,
                                                    return_type: return_type)

  @api_client.config.logger.debug "API called: FbaOutboundApi#get_fulfillment_preview\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#get_package_tracking_details(package_number, opts = {}) ⇒ GetPackageTrackingDetailsResponse

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 see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • package_number —

    The unencrypted package identifier returned by the getFulfillmentOrder operation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



450
451
452
453
 
# File 'lib/fulfillment_outbound_api_model/api/fba_outbound_api.rb', line 450

def get_package_tracking_details(package_number, opts = {})
  data, _status_code, _headers = get_package_tracking_details_with_http_info(package_number, opts)
  data
end

#get_package_tracking_details_with_http_info(package_number, opts = {}) ⇒ Array<(GetPackageTrackingDetailsResponse, Integer, Hash)>

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 &#x60;x-amzn-RateLimit-Limit&#x60; 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, see [Usage Plans and Rate Limits in the Selling Partner API](developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • package_number —

    The unencrypted package identifier returned by the getFulfillmentOrder operation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

Raises:

  • (ArgumentError) 


459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
 
# File 'lib/fulfillment_outbound_api_model/api/fba_outbound_api.rb', line 459

def get_package_tracking_details_with_http_info(package_number, opts = {})
  @api_client.config.logger.debug 'Calling API: FbaOutboundApi.get_package_tracking_details ...' if @api_client.config.debugging
  # verify the required parameter 'package_number' is set
  raise ArgumentError, "Missing the required parameter 'package_number' when calling FbaOutboundApi.get_package_tracking_details" if @api_client.config.client_side_validation && package_number.nil?

  # resource path
  local_var_path = '/fba/outbound/2020-07-01/tracking'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:packageNumber] = package_number

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'payload'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body]

  return_type = opts[:return_type] || 'GetPackageTrackingDetailsResponse'

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
                                                    header_params: header_params,
                                                    query_params: query_params,
                                                    form_params: form_params,
                                                    body: post_body,
                                                    auth_names: auth_names,
                                                    return_type: return_type)

  @api_client.config.logger.debug "API called: FbaOutboundApi#get_package_tracking_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#list_all_fulfillment_orders(opts = {}) ⇒ ListAllFulfillmentOrdersResponse

Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the next token parameter. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | 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, see [Usage Plans and Rate Limits in the Selling Partner API](developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :query_start_date (DateTime) —

    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.

  • :next_token (String) —

    A string token returned in the response to your previous request.

Returns:



502
503
504
505
 
# File 'lib/fulfillment_outbound_api_model/api/fba_outbound_api.rb', line 502

def list_all_fulfillment_orders(opts = {})
  data, _status_code, _headers = list_all_fulfillment_orders_with_http_info(opts)
  data
end

#list_all_fulfillment_orders_with_http_info(opts = {}) ⇒ Array<(ListAllFulfillmentOrdersResponse, Integer, Hash)>

Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the next token parameter. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | The &#x60;x-amzn-RateLimit-Limit&#x60; 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, see [Usage Plans and Rate Limits in the Selling Partner API](developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :query_start_date (DateTime) —

    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.

  • :next_token (String) —

    A string token returned in the response to your previous request.

Returns:



512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
 
# File 'lib/fulfillment_outbound_api_model/api/fba_outbound_api.rb', line 512

def list_all_fulfillment_orders_with_http_info(opts = {})
  @api_client.config.logger.debug 'Calling API: FbaOutboundApi.list_all_fulfillment_orders ...' if @api_client.config.debugging
  # resource path
  local_var_path = '/fba/outbound/2020-07-01/fulfillmentOrders'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:queryStartDate] = opts[:query_start_date] unless opts[:query_start_date].nil?
  query_params[:nextToken] = opts[:next_token] unless opts[:next_token].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'payload'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body]

  return_type = opts[:return_type] || 'ListAllFulfillmentOrdersResponse'

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
                                                    header_params: header_params,
                                                    query_params: query_params,
                                                    form_params: form_params,
                                                    body: post_body,
                                                    auth_names: auth_names,
                                                    return_type: return_type)

  @api_client.config.logger.debug "API called: FbaOutboundApi#list_all_fulfillment_orders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#list_return_reason_codes(seller_sku, language, opts = {}) ⇒ ListReturnReasonCodesResponse

Returns a list of return reason codes for a seller SKU in a given marketplace. 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](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 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, see [Usage Plans and Rate Limits in the Selling Partner API](developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • seller_sku —

    The seller SKU for which return reason codes are required.

  • language —

    The language that the TranslatedDescription property of the ReasonCodeDetails response object should be translated into.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :marketplace_id (String) —

    The marketplace for which the seller wants return reason codes.

  • :seller_fulfillment_order_id (String) —

    The identifier assigned to the item by the seller when the fulfillment order was created. The service uses this value to determine the marketplace for which the seller wants return reason codes.

Returns:



555
556
557
558
 
# File 'lib/fulfillment_outbound_api_model/api/fba_outbound_api.rb', line 555

def list_return_reason_codes(seller_sku, language, opts = {})
  data, _status_code, _headers = list_return_reason_codes_with_http_info(seller_sku, language, opts)
  data
end

#list_return_reason_codes_with_http_info(seller_sku, language, opts = {}) ⇒ Array<(ListReturnReasonCodesResponse, Integer, Hash)>

Returns a list of return reason codes for a seller SKU in a given marketplace. 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](developer-docs.amazon.com/sp-api/docs/url-encoding). **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | The &#x60;x-amzn-RateLimit-Limit&#x60; 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, see [Usage Plans and Rate Limits in the Selling Partner API](developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • seller_sku —

    The seller SKU for which return reason codes are required.

  • language —

    The language that the TranslatedDescription property of the ReasonCodeDetails response object should be translated into.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :marketplace_id (String) —

    The marketplace for which the seller wants return reason codes.

  • :seller_fulfillment_order_id (String) —

    The identifier assigned to the item by the seller when the fulfillment order was created. The service uses this value to determine the marketplace for which the seller wants return reason codes.

Returns:

Raises:

  • (ArgumentError) 


567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
 
# File 'lib/fulfillment_outbound_api_model/api/fba_outbound_api.rb', line 567

def list_return_reason_codes_with_http_info(seller_sku, language, opts = {})
  @api_client.config.logger.debug 'Calling API: FbaOutboundApi.list_return_reason_codes ...' if @api_client.config.debugging
  # verify the required parameter 'seller_sku' is set
  raise ArgumentError, "Missing the required parameter 'seller_sku' when calling FbaOutboundApi.list_return_reason_codes" if @api_client.config.client_side_validation && seller_sku.nil?
  # verify the required parameter 'language' is set
  raise ArgumentError, "Missing the required parameter 'language' when calling FbaOutboundApi.list_return_reason_codes" if @api_client.config.client_side_validation && language.nil?

  # resource path
  local_var_path = '/fba/outbound/2020-07-01/returnReasonCodes'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:sellerSku] = seller_sku
  query_params[:language] = language
  query_params[:marketplaceId] = opts[:marketplace_id] unless opts[:marketplace_id].nil?
  query_params[:sellerFulfillmentOrderId] = opts[:seller_fulfillment_order_id] unless opts[:seller_fulfillment_order_id].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'payload'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body]

  return_type = opts[:return_type] || 'ListReturnReasonCodesResponse'

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
                                                    header_params: header_params,
                                                    query_params: query_params,
                                                    form_params: form_params,
                                                    body: post_body,
                                                    auth_names: auth_names,
                                                    return_type: return_type)

  @api_client.config.logger.debug "API called: FbaOutboundApi#list_return_reason_codes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#submit_fulfillment_order_status_update(body, seller_fulfillment_order_id, opts = {}) ⇒ SubmitFulfillmentOrderStatusUpdateResponse

Requests that Amazon update the status of an order in the sandbox testing environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Fulfillment Outbound Dynamic Sandbox Guide](developer-docs.amazon.com/sp-api/docs/fulfillment-outbound-dynamic-sandbox-guide) and [Selling Partner API sandbox](developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information.

Parameters:

  • body
  • seller_fulfillment_order_id —

    The identifier assigned to the item by the seller when the fulfillment order was created.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



615
616
617
618
 
# File 'lib/fulfillment_outbound_api_model/api/fba_outbound_api.rb', line 615

def submit_fulfillment_order_status_update(body, seller_fulfillment_order_id, opts = {})
  data, _status_code, _headers = submit_fulfillment_order_status_update_with_http_info(body, seller_fulfillment_order_id, opts)
  data
end

#submit_fulfillment_order_status_update_with_http_info(body, seller_fulfillment_order_id, opts = {}) ⇒ Array<(SubmitFulfillmentOrderStatusUpdateResponse, Integer, Hash)>

Requests that Amazon update the status of an order in the sandbox testing environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Fulfillment Outbound Dynamic Sandbox Guide](developer-docs.amazon.com/sp-api/docs/fulfillment-outbound-dynamic-sandbox-guide) and [Selling Partner API sandbox](developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information.

Parameters:

  • body
  • seller_fulfillment_order_id —

    The identifier assigned to the item by the seller when the fulfillment order was created.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

Raises:

  • (ArgumentError) 


625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
 
# File 'lib/fulfillment_outbound_api_model/api/fba_outbound_api.rb', line 625

def submit_fulfillment_order_status_update_with_http_info(body, seller_fulfillment_order_id, opts = {})
  @api_client.config.logger.debug 'Calling API: FbaOutboundApi.submit_fulfillment_order_status_update ...' if @api_client.config.debugging
  # verify the required parameter 'body' is set
  raise ArgumentError, "Missing the required parameter 'body' when calling FbaOutboundApi.submit_fulfillment_order_status_update" if @api_client.config.client_side_validation && body.nil?
  # verify the required parameter 'seller_fulfillment_order_id' is set
  raise ArgumentError, "Missing the required parameter 'seller_fulfillment_order_id' when calling FbaOutboundApi.submit_fulfillment_order_status_update" if @api_client.config.client_side_validation && seller_fulfillment_order_id.nil?

  # resource path
  local_var_path = '/fba/outbound/2020-07-01/fulfillmentOrders/{sellerFulfillmentOrderId}/status'.sub('{' + 'sellerFulfillmentOrderId' + '}', seller_fulfillment_order_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body)

  return_type = opts[:return_type] || 'SubmitFulfillmentOrderStatusUpdateResponse'

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
                                                    header_params: header_params,
                                                    query_params: query_params,
                                                    form_params: form_params,
                                                    body: post_body,
                                                    auth_names: auth_names,
                                                    return_type: return_type)

  @api_client.config.logger.debug "API called: FbaOutboundApi#submit_fulfillment_order_status_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#update_fulfillment_order(body, seller_fulfillment_order_id, opts = {}) ⇒ UpdateFulfillmentOrderResponse

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 see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • body
  • seller_fulfillment_order_id —

    The identifier assigned to the item by the seller when the fulfillment order was created.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



671
672
673
674
 
# File 'lib/fulfillment_outbound_api_model/api/fba_outbound_api.rb', line 671

def update_fulfillment_order(body, seller_fulfillment_order_id, opts = {})
  data, _status_code, _headers = update_fulfillment_order_with_http_info(body, seller_fulfillment_order_id, opts)
  data
end

#update_fulfillment_order_with_http_info(body, seller_fulfillment_order_id, opts = {}) ⇒ Array<(UpdateFulfillmentOrderResponse, Integer, Hash)>

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 &#x60;x-amzn-RateLimit-Limit&#x60; 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, see [Usage Plans and Rate Limits in the Selling Partner API](developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • body
  • seller_fulfillment_order_id —

    The identifier assigned to the item by the seller when the fulfillment order was created.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

Raises:

  • (ArgumentError) 


681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
 
# File 'lib/fulfillment_outbound_api_model/api/fba_outbound_api.rb', line 681

def update_fulfillment_order_with_http_info(body, seller_fulfillment_order_id, opts = {})
  @api_client.config.logger.debug 'Calling API: FbaOutboundApi.update_fulfillment_order ...' if @api_client.config.debugging
  # verify the required parameter 'body' is set
  raise ArgumentError, "Missing the required parameter 'body' when calling FbaOutboundApi.update_fulfillment_order" if @api_client.config.client_side_validation && body.nil?
  # verify the required parameter 'seller_fulfillment_order_id' is set
  raise ArgumentError, "Missing the required parameter 'seller_fulfillment_order_id' when calling FbaOutboundApi.update_fulfillment_order" if @api_client.config.client_side_validation && seller_fulfillment_order_id.nil?

  # resource path
  local_var_path = '/fba/outbound/2020-07-01/fulfillmentOrders/{sellerFulfillmentOrderId}'.sub('{' + 'sellerFulfillmentOrderId' + '}', seller_fulfillment_order_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body)

  return_type = opts[:return_type] || 'UpdateFulfillmentOrderResponse'

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
                                                    header_params: header_params,
                                                    query_params: query_params,
                                                    form_params: form_params,
                                                    body: post_body,
                                                    auth_names: auth_names,
                                                    return_type: return_type)

  @api_client.config.logger.debug "API called: FbaOutboundApi#update_fulfillment_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end