Class: AmznSpApi::MerchantFulfillmentApiModel::MerchantFulfillmentApi

Inherits:
Object
  • Object
show all
Defined in:
lib/merchant_fulfillment_api_model/api/merchant_fulfillment_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ MerchantFulfillmentApi

Returns a new instance of MerchantFulfillmentApi.



14
15
16
 
# File 'lib/merchant_fulfillment_api_model/api/merchant_fulfillment_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/merchant_fulfillment_api_model/api/merchant_fulfillment_api.rb', line 12

def api_client
  @api_client
end

Instance Method Details

#cancel_shipment(shipment_id, opts = {}) ⇒ CancelShipmentResponse

Cancel the shipment indicated by the specified shipment identifier. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 1 | 1 | 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:

  • shipment_id —

    The Amazon-defined shipment identifier for the shipment to cancel.

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

    the optional parameters

Returns:



22
23
24
25
 
# File 'lib/merchant_fulfillment_api_model/api/merchant_fulfillment_api.rb', line 22

def cancel_shipment(shipment_id, opts = {})
  data, _status_code, _headers = cancel_shipment_with_http_info(shipment_id, opts)
  data
end

#cancel_shipment_old(shipment_id, opts = {}) ⇒ CancelShipmentResponse

Cancel the shipment indicated by the specified shipment identifer. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 1 | 1 | 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:

  • shipment_id —

    The Amazon-defined shipment identifier for the shipment to cancel.

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

    the optional parameters

Returns:



72
73
74
75
 
# File 'lib/merchant_fulfillment_api_model/api/merchant_fulfillment_api.rb', line 72

def cancel_shipment_old(shipment_id, opts = {})
  data, _status_code, _headers = cancel_shipment_old_with_http_info(shipment_id, opts)
  data
end

#cancel_shipment_old_with_http_info(shipment_id, opts = {}) ⇒ Array<(CancelShipmentResponse, Integer, Hash)>

Cancel the shipment indicated by the specified shipment identifer. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 1 | 1 | 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:

  • shipment_id —

    The Amazon-defined shipment identifier for the shipment to cancel.

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

    the optional parameters

Returns:

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

    CancelShipmentResponse data, response status code and response headers

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
 
# File 'lib/merchant_fulfillment_api_model/api/merchant_fulfillment_api.rb', line 81

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

  # resource path
  local_var_path = '/mfn/v0/shipments/{shipmentId}/cancel'.sub('{' + 'shipmentId' + '}', shipment_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] || 'CancelShipmentResponse'

  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: MerchantFulfillmentApi#cancel_shipment_old\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#cancel_shipment_with_http_info(shipment_id, opts = {}) ⇒ Array<(CancelShipmentResponse, Integer, Hash)>

Cancel the shipment indicated by the specified shipment identifier. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 1 | 1 | 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:

  • shipment_id —

    The Amazon-defined shipment identifier for the shipment to cancel.

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

    the optional parameters

Returns:

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

    CancelShipmentResponse data, response status code and response headers

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/merchant_fulfillment_api_model/api/merchant_fulfillment_api.rb', line 31

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

  # resource path
  local_var_path = '/mfn/v0/shipments/{shipmentId}'.sub('{' + 'shipmentId' + '}', shipment_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] || 'CancelShipmentResponse'

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:DELETE, 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: MerchantFulfillmentApi#cancel_shipment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#create_shipment(body, opts = {}) ⇒ CreateShipmentResponse

Create a shipment with the information provided. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 1 | 1 | 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:



122
123
124
125
 
# File 'lib/merchant_fulfillment_api_model/api/merchant_fulfillment_api.rb', line 122

def create_shipment(body, opts = {})
  data, _status_code, _headers = create_shipment_with_http_info(body, opts)
  data
end

#create_shipment_with_http_info(body, opts = {}) ⇒ Array<(CreateShipmentResponse, Integer, Hash)>

Create a shipment with the information provided. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 1 | 1 | 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:

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

    CreateShipmentResponse data, response status code and response headers

Raises:

  • (ArgumentError) 


131
132
133
134
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
 
# File 'lib/merchant_fulfillment_api_model/api/merchant_fulfillment_api.rb', line 131

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

  # resource path
  local_var_path = '/mfn/v0/shipments'

  # 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] || 'CreateShipmentResponse'

  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: MerchantFulfillmentApi#create_shipment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#get_additional_seller_inputs(body, opts = {}) ⇒ GetAdditionalSellerInputsResponse

Gets a list of additional seller inputs required for a ship method. This is generally used for international shipping. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 1 | 1 | 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:



174
175
176
177
 
# File 'lib/merchant_fulfillment_api_model/api/merchant_fulfillment_api.rb', line 174

def get_additional_seller_inputs(body, opts = {})
  data, _status_code, _headers = get_additional_seller_inputs_with_http_info(body, opts)
  data
end

#get_additional_seller_inputs_old(body, opts = {}) ⇒ GetAdditionalSellerInputsResponse

Get a list of additional seller inputs required for a ship method. This is generally used for international shipping. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 1 | 1 | 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:



226
227
228
229
 
# File 'lib/merchant_fulfillment_api_model/api/merchant_fulfillment_api.rb', line 226

def get_additional_seller_inputs_old(body, opts = {})
  data, _status_code, _headers = get_additional_seller_inputs_old_with_http_info(body, opts)
  data
end

#get_additional_seller_inputs_old_with_http_info(body, opts = {}) ⇒ Array<(GetAdditionalSellerInputsResponse, Integer, Hash)>

Get a list of additional seller inputs required for a ship method. This is generally used for international shipping. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 1 | 1 | 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) 


235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/merchant_fulfillment_api_model/api/merchant_fulfillment_api.rb', line 235

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

  # resource path
  local_var_path = '/mfn/v0/sellerInputs'

  # 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] || 'GetAdditionalSellerInputsResponse'

  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: MerchantFulfillmentApi#get_additional_seller_inputs_old\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#get_additional_seller_inputs_with_http_info(body, opts = {}) ⇒ Array<(GetAdditionalSellerInputsResponse, Integer, Hash)>

Gets a list of additional seller inputs required for a ship method. This is generally used for international shipping. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 1 | 1 | 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) 


183
184
185
186
187
188
189
190
191
192
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
 
# File 'lib/merchant_fulfillment_api_model/api/merchant_fulfillment_api.rb', line 183

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

  # resource path
  local_var_path = '/mfn/v0/additionalSellerInputs'

  # 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] || 'GetAdditionalSellerInputsResponse'

  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: MerchantFulfillmentApi#get_additional_seller_inputs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#get_eligible_shipment_services(body, opts = {}) ⇒ GetEligibleShipmentServicesResponse

Returns a list of shipping service offers that satisfy the specified shipment request details. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 5 | 10 | The ‘x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The 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:



278
279
280
281
 
# File 'lib/merchant_fulfillment_api_model/api/merchant_fulfillment_api.rb', line 278

def get_eligible_shipment_services(body, opts = {})
  data, _status_code, _headers = get_eligible_shipment_services_with_http_info(body, opts)
  data
end

#get_eligible_shipment_services_old(body, opts = {}) ⇒ GetEligibleShipmentServicesResponse

Returns a list of shipping service offers that satisfy the specified shipment request details. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 1 | 1 | 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:



330
331
332
333
 
# File 'lib/merchant_fulfillment_api_model/api/merchant_fulfillment_api.rb', line 330

def get_eligible_shipment_services_old(body, opts = {})
  data, _status_code, _headers = get_eligible_shipment_services_old_with_http_info(body, opts)
  data
end

#get_eligible_shipment_services_old_with_http_info(body, opts = {}) ⇒ Array<(GetEligibleShipmentServicesResponse, Integer, Hash)>

Returns a list of shipping service offers that satisfy the specified shipment request details. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 1 | 1 | 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) 


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/merchant_fulfillment_api_model/api/merchant_fulfillment_api.rb', line 339

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

  # resource path
  local_var_path = '/mfn/v0/eligibleServices'

  # 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] || 'GetEligibleShipmentServicesResponse'

  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: MerchantFulfillmentApi#get_eligible_shipment_services_old\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#get_eligible_shipment_services_with_http_info(body, opts = {}) ⇒ Array<(GetEligibleShipmentServicesResponse, Integer, Hash)>

Returns a list of shipping service offers that satisfy the specified shipment request details. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 5 | 10 | 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) 


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
322
323
324
 
# File 'lib/merchant_fulfillment_api_model/api/merchant_fulfillment_api.rb', line 287

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

  # resource path
  local_var_path = '/mfn/v0/eligibleShippingServices'

  # 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] || 'GetEligibleShipmentServicesResponse'

  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: MerchantFulfillmentApi#get_eligible_shipment_services\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#get_shipment(shipment_id, opts = {}) ⇒ GetShipmentResponse

Returns the shipment information for an existing shipment. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 1 | 1 | 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:

  • shipment_id —

    The Amazon-defined shipment identifier for the shipment.

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

    the optional parameters

Returns:



382
383
384
385
 
# File 'lib/merchant_fulfillment_api_model/api/merchant_fulfillment_api.rb', line 382

def get_shipment(shipment_id, opts = {})
  data, _status_code, _headers = get_shipment_with_http_info(shipment_id, opts)
  data
end

#get_shipment_with_http_info(shipment_id, opts = {}) ⇒ Array<(GetShipmentResponse, Integer, Hash)>

Returns the shipment information for an existing shipment. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 1 | 1 | 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:

  • shipment_id —

    The Amazon-defined shipment identifier for the shipment.

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

    the optional parameters

Returns:

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

    GetShipmentResponse data, response status code and response headers

Raises:

  • (ArgumentError) 


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
 
# File 'lib/merchant_fulfillment_api_model/api/merchant_fulfillment_api.rb', line 391

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

  # resource path
  local_var_path = '/mfn/v0/shipments/{shipmentId}'.sub('{' + 'shipmentId' + '}', shipment_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] || 'GetShipmentResponse'

  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: MerchantFulfillmentApi#get_shipment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end