Class: AmznSpApi::ShipmentInvoicingApiModel::ShipmentInvoiceApi

Inherits:
Object
  • Object
show all
Defined in:
lib/shipment_invoicing_api_model/api/shipment_invoice_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ShipmentInvoiceApi

Returns a new instance of ShipmentInvoiceApi.



14
15
16
 
# File 'lib/shipment_invoicing_api_model/api/shipment_invoice_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/shipment_invoicing_api_model/api/shipment_invoice_api.rb', line 12

def api_client
  @api_client
end

Instance Method Details

#get_invoice_status(shipment_id, opts = {}) ⇒ GetInvoiceStatusResponse

Returns the invoice status for the shipment you specify. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 1.133 | 25 | 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:

  • shipment_id —

    The shipment identifier for the shipment.

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

    the optional parameters

Returns:



22
23
24
25
 
# File 'lib/shipment_invoicing_api_model/api/shipment_invoice_api.rb', line 22

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

#get_invoice_status_with_http_info(shipment_id, opts = {}) ⇒ Array<(GetInvoiceStatusResponse, Integer, Hash)>

Returns the invoice status for the shipment you specify. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 1.133 | 25 | 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:

  • shipment_id —

    The shipment identifier for the shipment.

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

    the optional parameters

Returns:

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

    GetInvoiceStatusResponse 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/shipment_invoicing_api_model/api/shipment_invoice_api.rb', line 31

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

  # resource path
  local_var_path = '/fba/outbound/brazil/v0/shipments/{shipmentId}/invoice/status'.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] || 'GetInvoiceStatusResponse'

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

#get_shipment_details(shipment_id, opts = {}) ⇒ GetShipmentDetailsResponse

Returns the shipment details required to issue an invoice for the specified shipment. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 1.133 | 25 | 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:

  • shipment_id —

    The identifier for the shipment. Get this value from the FBAOutboundShipmentStatus notification. For information about subscribing to notifications, see the [Notifications API Use Case Guide](doc:notifications-api-v1-use-case-guide).

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

    the optional parameters

Returns:



72
73
74
75
 
# File 'lib/shipment_invoicing_api_model/api/shipment_invoice_api.rb', line 72

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

#get_shipment_details_with_http_info(shipment_id, opts = {}) ⇒ Array<(GetShipmentDetailsResponse, Integer, Hash)>

Returns the shipment details required to issue an invoice for the specified shipment. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 1.133 | 25 | 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:

  • shipment_id —

    The identifier for the shipment. Get this value from the FBAOutboundShipmentStatus notification. For information about subscribing to notifications, see the [Notifications API Use Case Guide](doc:notifications-api-v1-use-case-guide).

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

    the optional parameters

Returns:

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

    GetShipmentDetailsResponse 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/shipment_invoicing_api_model/api/shipment_invoice_api.rb', line 81

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

  # resource path
  local_var_path = '/fba/outbound/brazil/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] || 'GetShipmentDetailsResponse'

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

#submit_invoice(body, shipment_id, opts = {}) ⇒ SubmitInvoiceResponse

Submits a shipment invoice document for a given shipment. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 1.133 | 25 | 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
  • shipment_id —

    The identifier for the shipment.

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

    the optional parameters

Returns:



123
124
125
126
 
# File 'lib/shipment_invoicing_api_model/api/shipment_invoice_api.rb', line 123

def submit_invoice(body, shipment_id, opts = {})
  data, _status_code, _headers = submit_invoice_with_http_info(body, shipment_id, opts)
  data
end

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

Submits a shipment invoice document for a given shipment. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 1.133 | 25 | 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
  • shipment_id —

    The identifier for the shipment.

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

    the optional parameters

Returns:

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

    SubmitInvoiceResponse data, response status code and response headers

Raises:

  • (ArgumentError) 


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
169
170
171
172
 
# File 'lib/shipment_invoicing_api_model/api/shipment_invoice_api.rb', line 133

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

  # resource path
  local_var_path = '/fba/outbound/brazil/v0/shipments/{shipmentId}/invoice'.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] || 'SubmitInvoiceResponse'

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