Class: AmznSpApi::OrdersApiModel::ShipmentApi

Inherits:
Object
  • Object
show all
Defined in:
lib/orders_api_model/api/shipment_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ShipmentApi

Returns a new instance of ShipmentApi.



14
15
16
 
# File 'lib/orders_api_model/api/shipment_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/orders_api_model/api/shipment_api.rb', line 12

def api_client
  @api_client
end

Instance Method Details

#update_shipment_status(body, order_id, opts = {}) ⇒ nil

Update the shipment status for an order that you specify. **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 then 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 —

    The request body for the updateShipmentStatus operation.

  • order_id —

    An Amazon-defined order identifier, in 3-7-7 format.

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

    the optional parameters

Returns:

  • (nil) 


23
24
25
26
 
# File 'lib/orders_api_model/api/shipment_api.rb', line 23

def update_shipment_status(body, order_id, opts = {})
  update_shipment_status_with_http_info(body, order_id, opts)
  nil
end

#update_shipment_status_with_http_info(body, order_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Update the shipment status for an order that you specify. **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 then 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 —

    The request body for the updateShipmentStatus operation.

  • order_id —

    An Amazon-defined order identifier, in 3-7-7 format.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers

Raises:

  • (ArgumentError) 


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/orders_api_model/api/shipment_api.rb', line 33

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

  # resource path
  local_var_path = '/orders/v0/orders/{orderId}/shipment'.sub('{' + 'orderId' + '}', order_id.to_s)

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

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

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

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

  return_type = opts[:return_type]

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