Class: AmzSpApi::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.



16
17
18
 
# File 'lib/fulfillment-outbound-api-model/api/fba_outbound_api.rb', line 16

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/fulfillment-outbound-api-model/api/fba_outbound_api.rb', line 14

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 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

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:



23
24
25
26
 
# File 'lib/fulfillment-outbound-api-model/api/fba_outbound_api.rb', line 23

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 | For more information, see &quot;Usage Plans and Rate Limits&quot; in the Selling Partner API documentation.

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:



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
67
68
69
70
71
72
 
# File 'lib/fulfillment-outbound-api-model/api/fba_outbound_api.rb', line 32

def cancel_fulfillment_order_with_http_info(seller_fulfillment_order_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FbaOutboundApi.cancel_fulfillment_order ...'
  end
  # verify the required parameter 'seller_fulfillment_order_id' is set
  if @api_client.config.client_side_validation && seller_fulfillment_order_id.nil?
    fail ArgumentError, "Missing the required parameter 'seller_fulfillment_order_id' when calling FbaOutboundApi.cancel_fulfillment_order"
  end
  # 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)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FbaOutboundApi#cancel_fulfillment_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return 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 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters:

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

    the optional parameters

Returns:



77
78
79
80
 
# File 'lib/fulfillment-outbound-api-model/api/fba_outbound_api.rb', line 77

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 | For more information, see &quot;Usage Plans and Rate Limits&quot; in the Selling Partner API documentation.

Parameters:

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

    the optional parameters

Returns:



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
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/fulfillment-outbound-api-model/api/fba_outbound_api.rb', line 86

def create_fulfillment_order_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FbaOutboundApi.create_fulfillment_order ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling FbaOutboundApi.create_fulfillment_order"
  end
  # 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)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FbaOutboundApi#create_fulfillment_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return 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 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

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:



134
135
136
137
 
# File 'lib/fulfillment-outbound-api-model/api/fba_outbound_api.rb', line 134

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 | For more information, see &quot;Usage Plans and Rate Limits&quot; in the Selling Partner API documentation.

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:



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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/fulfillment-outbound-api-model/api/fba_outbound_api.rb', line 144

def create_fulfillment_return_with_http_info(body, seller_fulfillment_order_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FbaOutboundApi.create_fulfillment_return ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling FbaOutboundApi.create_fulfillment_return"
  end
  # verify the required parameter 'seller_fulfillment_order_id' is set
  if @api_client.config.client_side_validation && seller_fulfillment_order_id.nil?
    fail ArgumentError, "Missing the required parameter 'seller_fulfillment_order_id' when calling FbaOutboundApi.create_fulfillment_return"
  end
  # 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)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FbaOutboundApi#create_fulfillment_return\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return 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 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

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:



197
198
199
200
 
# File 'lib/fulfillment-outbound-api-model/api/fba_outbound_api.rb', line 197

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 | For more information, see &quot;Usage Plans and Rate Limits&quot; in the Selling Partner API documentation.

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



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
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/fulfillment-outbound-api-model/api/fba_outbound_api.rb', line 208

def get_feature_inventory_with_http_info(marketplace_id, feature_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FbaOutboundApi.get_feature_inventory ...'
  end
  # verify the required parameter 'marketplace_id' is set
  if @api_client.config.client_side_validation && marketplace_id.nil?
    fail ArgumentError, "Missing the required parameter 'marketplace_id' when calling FbaOutboundApi.get_feature_inventory"
  end
  # verify the required parameter 'feature_name' is set
  if @api_client.config.client_side_validation && feature_name.nil?
    fail ArgumentError, "Missing the required parameter 'feature_name' when calling FbaOutboundApi.get_feature_inventory"
  end
  # 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'] if !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)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FbaOutboundApi#get_feature_inventory\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return 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. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

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:



261
262
263
264
 
# File 'lib/fulfillment-outbound-api-model/api/fba_outbound_api.rb', line 261

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. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | For more information, see &quot;Usage Plans and Rate Limits&quot; in the Selling Partner API documentation.

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



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/fulfillment-outbound-api-model/api/fba_outbound_api.rb', line 272

def get_feature_sku_with_http_info(marketplace_id, feature_name, seller_sku, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FbaOutboundApi.get_feature_sku ...'
  end
  # verify the required parameter 'marketplace_id' is set
  if @api_client.config.client_side_validation && marketplace_id.nil?
    fail ArgumentError, "Missing the required parameter 'marketplace_id' when calling FbaOutboundApi.get_feature_sku"
  end
  # verify the required parameter 'feature_name' is set
  if @api_client.config.client_side_validation && feature_name.nil?
    fail ArgumentError, "Missing the required parameter 'feature_name' when calling FbaOutboundApi.get_feature_sku"
  end
  # verify the required parameter 'seller_sku' is set
  if @api_client.config.client_side_validation && seller_sku.nil?
    fail ArgumentError, "Missing the required parameter 'seller_sku' when calling FbaOutboundApi.get_feature_sku"
  end
  # 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)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FbaOutboundApi#get_feature_sku\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return 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 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters:

  • marketplace_id —

    The marketplace for which to return the list of features.

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

    the optional parameters

Returns:



326
327
328
329
 
# File 'lib/fulfillment-outbound-api-model/api/fba_outbound_api.rb', line 326

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 | For more information, see &quot;Usage Plans and Rate Limits&quot; in the Selling Partner API documentation.

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



335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/fulfillment-outbound-api-model/api/fba_outbound_api.rb', line 335

def get_features_with_http_info(marketplace_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FbaOutboundApi.get_features ...'
  end
  # verify the required parameter 'marketplace_id' is set
  if @api_client.config.client_side_validation && marketplace_id.nil?
    fail ArgumentError, "Missing the required parameter 'marketplace_id' when calling FbaOutboundApi.get_features"
  end
  # 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)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FbaOutboundApi#get_features\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return 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 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

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:



381
382
383
384
 
# File 'lib/fulfillment-outbound-api-model/api/fba_outbound_api.rb', line 381

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 | For more information, see &quot;Usage Plans and Rate Limits&quot; in the Selling Partner API documentation.

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



390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/fulfillment-outbound-api-model/api/fba_outbound_api.rb', line 390

def get_fulfillment_order_with_http_info(seller_fulfillment_order_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FbaOutboundApi.get_fulfillment_order ...'
  end
  # verify the required parameter 'seller_fulfillment_order_id' is set
  if @api_client.config.client_side_validation && seller_fulfillment_order_id.nil?
    fail ArgumentError, "Missing the required parameter 'seller_fulfillment_order_id' when calling FbaOutboundApi.get_fulfillment_order"
  end
  # 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)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FbaOutboundApi#get_fulfillment_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return 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 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters:

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

    the optional parameters

Returns:



435
436
437
438
 
# File 'lib/fulfillment-outbound-api-model/api/fba_outbound_api.rb', line 435

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 | For more information, see &quot;Usage Plans and Rate Limits&quot; in the Selling Partner API documentation.

Parameters:

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

    the optional parameters

Returns:



444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
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
 
# File 'lib/fulfillment-outbound-api-model/api/fba_outbound_api.rb', line 444

def get_fulfillment_preview_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FbaOutboundApi.get_fulfillment_preview ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling FbaOutboundApi.get_fulfillment_preview"
  end
  # 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)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FbaOutboundApi#get_fulfillment_preview\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return 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 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters:

  • package_number —

    The unencrypted package identifier returned by the getFulfillmentOrder operation.

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

    the optional parameters

Returns:



491
492
493
494
 
# File 'lib/fulfillment-outbound-api-model/api/fba_outbound_api.rb', line 491

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 | For more information, see &quot;Usage Plans and Rate Limits&quot; in the Selling Partner API documentation.

Parameters:

  • package_number —

    The unencrypted package identifier returned by the getFulfillmentOrder operation.

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

    the optional parameters

Returns:



500
501
502
503
504
505
506
507
508
509
510
511
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
 
# File 'lib/fulfillment-outbound-api-model/api/fba_outbound_api.rb', line 500

def get_package_tracking_details_with_http_info(package_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FbaOutboundApi.get_package_tracking_details ...'
  end
  # verify the required parameter 'package_number' is set
  if @api_client.config.client_side_validation && package_number.nil?
    fail ArgumentError, "Missing the required parameter 'package_number' when calling FbaOutboundApi.get_package_tracking_details"
  end
  # 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)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FbaOutboundApi#get_package_tracking_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return 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 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

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:



547
548
549
550
 
# File 'lib/fulfillment-outbound-api-model/api/fba_outbound_api.rb', line 547

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 | For more information, see &quot;Usage Plans and Rate Limits&quot; in the Selling Partner API documentation.

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:



557
558
559
560
561
562
563
564
565
566
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
 
# File 'lib/fulfillment-outbound-api-model/api/fba_outbound_api.rb', line 557

def list_all_fulfillment_orders_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FbaOutboundApi.list_all_fulfillment_orders ...'
  end
  # 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'] if !opts[:'query_start_date'].nil?
  query_params[:'nextToken'] = opts[:'next_token'] if !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)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FbaOutboundApi#list_all_fulfillment_orders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return 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. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

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:



603
604
605
606
 
# File 'lib/fulfillment-outbound-api-model/api/fba_outbound_api.rb', line 603

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. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | For more information, see &quot;Usage Plans and Rate Limits&quot; in the Selling Partner API documentation.

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:



615
616
617
618
619
620
621
622
623
624
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
 
# File 'lib/fulfillment-outbound-api-model/api/fba_outbound_api.rb', line 615

def list_return_reason_codes_with_http_info(seller_sku, language, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FbaOutboundApi.list_return_reason_codes ...'
  end
  # verify the required parameter 'seller_sku' is set
  if @api_client.config.client_side_validation && seller_sku.nil?
    fail ArgumentError, "Missing the required parameter 'seller_sku' when calling FbaOutboundApi.list_return_reason_codes"
  end
  # verify the required parameter 'language' is set
  if @api_client.config.client_side_validation && language.nil?
    fail ArgumentError, "Missing the required parameter 'language' when calling FbaOutboundApi.list_return_reason_codes"
  end
  # 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'] if !opts[:'marketplace_id'].nil?
  query_params[:'sellerFulfillmentOrderId'] = opts[:'seller_fulfillment_order_id'] if !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)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FbaOutboundApi#list_return_reason_codes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return 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 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

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:



669
670
671
672
 
# File 'lib/fulfillment-outbound-api-model/api/fba_outbound_api.rb', line 669

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 | For more information, see &quot;Usage Plans and Rate Limits&quot; in the Selling Partner API documentation.

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:



679
680
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
721
722
723
724
725
 
# File 'lib/fulfillment-outbound-api-model/api/fba_outbound_api.rb', line 679

def update_fulfillment_order_with_http_info(body, seller_fulfillment_order_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FbaOutboundApi.update_fulfillment_order ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling FbaOutboundApi.update_fulfillment_order"
  end
  # verify the required parameter 'seller_fulfillment_order_id' is set
  if @api_client.config.client_side_validation && seller_fulfillment_order_id.nil?
    fail ArgumentError, "Missing the required parameter 'seller_fulfillment_order_id' when calling FbaOutboundApi.update_fulfillment_order"
  end
  # 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)

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