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



14
15
16
 
# File 'lib/shipping_api_model/api/shipping_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/shipping_api_model/api/shipping_api.rb', line 12

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:



22
23
24
25
 
# File 'lib/shipping_api_model/api/shipping_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_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

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

def cancel_shipment_with_http_info(shipment_id, opts = {})
  @api_client.config.logger.debug 'Calling API: ShippingApi.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 ShippingApi.cancel_shipment" if @api_client.config.client_side_validation && shipment_id.nil?

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

  @api_client.config.logger.debug "API called: ShippingApi#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 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:



72
73
74
75
 
# File 'lib/shipping_api_model/api/shipping_api.rb', line 72

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

Raises:

  • (ArgumentError) 


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

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

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

  @api_client.config.logger.debug "API called: ShippingApi#create_shipment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [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:



123
124
125
126
 
# File 'lib/shipping_api_model/api/shipping_api.rb', line 123

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



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
 
# File 'lib/shipping_api_model/api/shipping_api.rb', line 131

def (opts = {})
  @api_client.config.logger.debug 'Calling API: ShippingApi.get_account ...' if @api_client.config.debugging
  # 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)

  @api_client.config.logger.debug "API called: ShippingApi#get_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [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:



169
170
171
172
 
# File 'lib/shipping_api_model/api/shipping_api.rb', line 169

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

Raises:

  • (ArgumentError) 


178
179
180
181
182
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
 
# File 'lib/shipping_api_model/api/shipping_api.rb', line 178

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

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

  @api_client.config.logger.debug "API called: ShippingApi#get_rates\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

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:



221
222
223
224
 
# File 'lib/shipping_api_model/api/shipping_api.rb', line 221

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

Raises:

  • (ArgumentError) 


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
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/shipping_api_model/api/shipping_api.rb', line 230

def get_shipment_with_http_info(shipment_id, opts = {})
  @api_client.config.logger.debug 'Calling API: ShippingApi.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 ShippingApi.get_shipment" if @api_client.config.client_side_validation && shipment_id.nil?

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

  @api_client.config.logger.debug "API called: ShippingApi#get_shipment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [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:



271
272
273
274
 
# File 'lib/shipping_api_model/api/shipping_api.rb', line 271

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:

Raises:

  • (ArgumentError) 


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
 
# File 'lib/shipping_api_model/api/shipping_api.rb', line 280

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

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

  @api_client.config.logger.debug "API called: ShippingApi#get_tracking_information\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [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:



322
323
324
325
 
# File 'lib/shipping_api_model/api/shipping_api.rb', line 322

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

Raises:

  • (ArgumentError) 


332
333
334
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
 
# File 'lib/shipping_api_model/api/shipping_api.rb', line 332

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

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

  @api_client.config.logger.debug "API called: ShippingApi#purchase_labels\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [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:



377
378
379
380
 
# File 'lib/shipping_api_model/api/shipping_api.rb', line 377

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

Raises:

  • (ArgumentError) 


386
387
388
389
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
 
# File 'lib/shipping_api_model/api/shipping_api.rb', line 386

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

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

  @api_client.config.logger.debug "API called: ShippingApi#purchase_shipment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [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:



431
432
433
434
 
# File 'lib/shipping_api_model/api/shipping_api.rb', line 431

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:

Raises:

  • (ArgumentError) 


442
443
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
 
# File 'lib/shipping_api_model/api/shipping_api.rb', line 442

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

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

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