Class: AmzSpApi::ShippingApiModel::ShippingApi

Inherits:
Object
  • Object
show all
Defined in:
lib/shipping-api-model/api/shipping_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ShippingApi

Returns a new instance of ShippingApi.



16
17
18
 
# File 'lib/shipping-api-model/api/shipping_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/shipping-api-model/api/shipping_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

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

Cancel a shipment by the given shipmentId. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 5 | 15 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters:

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

    the optional parameters

Returns:



23
24
25
26
 
# File 'lib/shipping-api-model/api/shipping_api.rb', line 23

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

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

Cancel a shipment by the given shipmentId. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 5 | 15 | For more information, see &quot;Usage Plans and Rate Limits&quot; in the Selling Partner API documentation.

Parameters:

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

    the optional parameters

Returns:

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

    CancelShipmentResponse data, response status code and response headers



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/shipping-api-model/api/shipping_api.rb', line 32

def cancel_shipment_with_http_info(shipment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ShippingApi.cancel_shipment ...'
  end
  # verify the required parameter 'shipment_id' is set
  if @api_client.config.client_side_validation && shipment_id.nil?
    fail ArgumentError, "Missing the required parameter 'shipment_id' when calling ShippingApi.cancel_shipment"
  end
  # resource path
  local_var_path = '/shipping/v1/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(: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: ShippingApi#cancel_shipment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Create a new shipment. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 5 | 15 | The ‘x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The 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](doc:usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

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

    the optional parameters

Returns:



77
78
79
80
 
# File 'lib/shipping-api-model/api/shipping_api.rb', line 77

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 new shipment. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 5 | 15 | 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](doc: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



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/shipping-api-model/api/shipping_api.rb', line 86

def create_shipment_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ShippingApi.create_shipment ...'
  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 ShippingApi.create_shipment"
  end
  # resource path
  local_var_path = '/shipping/v1/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)

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

#get_account(opts = {}) ⇒ GetAccountResponse

Verify if the current account is valid. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 5 | 15 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters:

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

    the optional parameters

Returns:



132
133
134
135
 
# File 'lib/shipping-api-model/api/shipping_api.rb', line 132

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

#get_account_with_http_info(opts = {}) ⇒ Array<(GetAccountResponse, Integer, Hash)>

Verify if the current account is valid. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 5 | 15 | 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

Returns:

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

    GetAccountResponse data, response status code and response headers



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
175
176
 
# File 'lib/shipping-api-model/api/shipping_api.rb', line 140

def (opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ShippingApi.get_account ...'
  end
  # resource path
  local_var_path = '/shipping/v1/account'

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

  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: ShippingApi#get_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_rates(body, opts = {}) ⇒ GetRatesResponse

Get service rates. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 5 | 15 | 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:



181
182
183
184
 
# File 'lib/shipping-api-model/api/shipping_api.rb', line 181

def get_rates(body, opts = {})
  data, _status_code, _headers = get_rates_with_http_info(body, opts)
  data
end

#get_rates_with_http_info(body, opts = {}) ⇒ Array<(GetRatesResponse, Integer, Hash)>

Get service rates. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 5 | 15 | 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:

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

    GetRatesResponse data, response status code and response headers



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
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/shipping-api-model/api/shipping_api.rb', line 190

def get_rates_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ShippingApi.get_rates ...'
  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 ShippingApi.get_rates"
  end
  # resource path
  local_var_path = '/shipping/v1/rates'

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

  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: ShippingApi#get_rates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Return the entire shipment object for the shipmentId. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 5 | 15 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters:

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

    the optional parameters

Returns:



237
238
239
240
 
# File 'lib/shipping-api-model/api/shipping_api.rb', line 237

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)>

Return the entire shipment object for the shipmentId. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 5 | 15 | For more information, see &quot;Usage Plans and Rate Limits&quot; in the Selling Partner API documentation.

Parameters:

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

    the optional parameters

Returns:

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

    GetShipmentResponse data, response status code and response headers



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
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/shipping-api-model/api/shipping_api.rb', line 246

def get_shipment_with_http_info(shipment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ShippingApi.get_shipment ...'
  end
  # verify the required parameter 'shipment_id' is set
  if @api_client.config.client_side_validation && shipment_id.nil?
    fail ArgumentError, "Missing the required parameter 'shipment_id' when calling ShippingApi.get_shipment"
  end
  # resource path
  local_var_path = '/shipping/v1/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)

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

#get_tracking_information(tracking_id, opts = {}) ⇒ GetTrackingInformationResponse

Return the tracking information of a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 1 | 1 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters:

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

    the optional parameters

Returns:



291
292
293
294
 
# File 'lib/shipping-api-model/api/shipping_api.rb', line 291

def get_tracking_information(tracking_id, opts = {})
  data, _status_code, _headers = get_tracking_information_with_http_info(tracking_id, opts)
  data
end

#get_tracking_information_with_http_info(tracking_id, opts = {}) ⇒ Array<(GetTrackingInformationResponse, Integer, Hash)>

Return the tracking information of a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 1 | 1 | For more information, see &quot;Usage Plans and Rate Limits&quot; in the Selling Partner API documentation.

Parameters:

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

    the optional parameters

Returns:



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
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/shipping-api-model/api/shipping_api.rb', line 300

def get_tracking_information_with_http_info(tracking_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ShippingApi.get_tracking_information ...'
  end
  # verify the required parameter 'tracking_id' is set
  if @api_client.config.client_side_validation && tracking_id.nil?
    fail ArgumentError, "Missing the required parameter 'tracking_id' when calling ShippingApi.get_tracking_information"
  end
  # resource path
  local_var_path = '/shipping/v1/tracking/{trackingId}'.sub('{' + 'trackingId' + '}', tracking_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] || 'GetTrackingInformationResponse' 

  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: ShippingApi#get_tracking_information\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#purchase_labels(body, shipment_id, opts = {}) ⇒ PurchaseLabelsResponse

Purchase shipping labels based on a given rate. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 5 | 15 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters:

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

    the optional parameters

Returns:



346
347
348
349
 
# File 'lib/shipping-api-model/api/shipping_api.rb', line 346

def purchase_labels(body, shipment_id, opts = {})
  data, _status_code, _headers = purchase_labels_with_http_info(body, shipment_id, opts)
  data
end

#purchase_labels_with_http_info(body, shipment_id, opts = {}) ⇒ Array<(PurchaseLabelsResponse, Integer, Hash)>

Purchase shipping labels based on a given rate. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 5 | 15 | For more information, see &quot;Usage Plans and Rate Limits&quot; in the Selling Partner API documentation.

Parameters:

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

    the optional parameters

Returns:

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

    PurchaseLabelsResponse data, response status code and response headers



356
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
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/shipping-api-model/api/shipping_api.rb', line 356

def purchase_labels_with_http_info(body, shipment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ShippingApi.purchase_labels ...'
  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 ShippingApi.purchase_labels"
  end
  # verify the required parameter 'shipment_id' is set
  if @api_client.config.client_side_validation && shipment_id.nil?
    fail ArgumentError, "Missing the required parameter 'shipment_id' when calling ShippingApi.purchase_labels"
  end
  # resource path
  local_var_path = '/shipping/v1/shipments/{shipmentId}/purchaseLabels'.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'])
  # 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] || 'PurchaseLabelsResponse' 

  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: ShippingApi#purchase_labels\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#purchase_shipment(body, opts = {}) ⇒ PurchaseShipmentResponse

Purchase shipping labels. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 5 | 15 | 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:



407
408
409
410
 
# File 'lib/shipping-api-model/api/shipping_api.rb', line 407

def purchase_shipment(body, opts = {})
  data, _status_code, _headers = purchase_shipment_with_http_info(body, opts)
  data
end

#purchase_shipment_with_http_info(body, opts = {}) ⇒ Array<(PurchaseShipmentResponse, Integer, Hash)>

Purchase shipping labels. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 5 | 15 | 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:

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

    PurchaseShipmentResponse data, response status code and response headers



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

def purchase_shipment_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ShippingApi.purchase_shipment ...'
  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 ShippingApi.purchase_shipment"
  end
  # resource path
  local_var_path = '/shipping/v1/purchaseShipment'

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

  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: ShippingApi#purchase_shipment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#retrieve_shipping_label(body, shipment_id, tracking_id, opts = {}) ⇒ RetrieveShippingLabelResponse

Retrieve shipping label based on the shipment id and tracking id. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 5 | 15 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters:

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

    the optional parameters

Returns:



465
466
467
468
 
# File 'lib/shipping-api-model/api/shipping_api.rb', line 465

def retrieve_shipping_label(body, shipment_id, tracking_id, opts = {})
  data, _status_code, _headers = retrieve_shipping_label_with_http_info(body, shipment_id, tracking_id, opts)
  data
end

#retrieve_shipping_label_with_http_info(body, shipment_id, tracking_id, opts = {}) ⇒ Array<(RetrieveShippingLabelResponse, Integer, Hash)>

Retrieve shipping label based on the shipment id and tracking id. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 5 | 15 | For more information, see &quot;Usage Plans and Rate Limits&quot; in the Selling Partner API documentation.

Parameters:

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

    the optional parameters

Returns:



476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
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
 
# File 'lib/shipping-api-model/api/shipping_api.rb', line 476

def retrieve_shipping_label_with_http_info(body, shipment_id, tracking_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ShippingApi.retrieve_shipping_label ...'
  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 ShippingApi.retrieve_shipping_label"
  end
  # verify the required parameter 'shipment_id' is set
  if @api_client.config.client_side_validation && shipment_id.nil?
    fail ArgumentError, "Missing the required parameter 'shipment_id' when calling ShippingApi.retrieve_shipping_label"
  end
  # verify the required parameter 'tracking_id' is set
  if @api_client.config.client_side_validation && tracking_id.nil?
    fail ArgumentError, "Missing the required parameter 'tracking_id' when calling ShippingApi.retrieve_shipping_label"
  end
  # resource path
  local_var_path = '/shipping/v1/shipments/{shipmentId}/containers/{trackingId}/label'.sub('{' + 'shipmentId' + '}', shipment_id.to_s).sub('{' + 'trackingId' + '}', tracking_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] || 'RetrieveShippingLabelResponse' 

  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: ShippingApi#retrieve_shipping_label\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end