class AmzSpApi::ShippingApiModel::ShippingApi
Attributes
Public Class Methods
# File lib/shipping-api-model/api/shipping_api.rb, line 16 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
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. @param shipment_id @param [Hash] opts the optional parameters @return [CancelShipmentResponse]
# 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 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. @param shipment_id @param [Hash] opts the optional parameters @return [Array<(CancelShipmentResponse
, Integer, Hash)>] CancelShipmentResponse
data, response status code and response headers
# 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 a new shipment. **Usage Plan:** | Rate
(requests per second) | Burst | | —- | —- | | 5 | 15 | For more information, see "Usage Plans and Rate
Limits" in the Selling Partner API documentation. @param body @param [Hash] opts the optional parameters @return [CreateShipmentResponse]
# 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 a new shipment. **Usage Plan:** | Rate
(requests per second) | Burst | | —- | —- | | 5 | 15 | For more information, see "Usage Plans and Rate
Limits" in the Selling Partner API documentation. @param body @param [Hash] opts the optional parameters @return [Array<(CreateShipmentResponse
, Integer, Hash)>] CreateShipmentResponse
data, response status code and response headers
# 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
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. @param [Hash] opts the optional parameters @return [GetAccountResponse]
# File lib/shipping-api-model/api/shipping_api.rb, line 132 def get_account(opts = {}) data, _status_code, _headers = get_account_with_http_info(opts) data end
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. @param [Hash] opts the optional parameters @return [Array<(GetAccountResponse
, Integer, Hash)>] GetAccountResponse
data, response status code and response headers
# File lib/shipping-api-model/api/shipping_api.rb, line 140 def get_account_with_http_info(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 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. @param body @param [Hash] opts the optional parameters @return [GetRatesResponse]
# 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 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. @param body @param [Hash] opts the optional parameters @return [Array<(GetRatesResponse
, Integer, Hash)>] GetRatesResponse
data, response status code and response headers
# 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
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. @param shipment_id @param [Hash] opts the optional parameters @return [GetShipmentResponse]
# 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
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. @param shipment_id @param [Hash] opts the optional parameters @return [Array<(GetShipmentResponse
, Integer, Hash)>] GetShipmentResponse
data, response status code and response headers
# 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
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. @param tracking_id @param [Hash] opts the optional parameters @return [GetTrackingInformationResponse]
# 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
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. @param tracking_id @param [Hash] opts the optional parameters @return [Array<(GetTrackingInformationResponse
, Integer, Hash)>] GetTrackingInformationResponse
data, response status code and response headers
# 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 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. @param body @param shipment_id @param [Hash] opts the optional parameters @return [PurchaseLabelsResponse]
# 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 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. @param body @param shipment_id @param [Hash] opts the optional parameters @return [Array<(PurchaseLabelsResponse
, Integer, Hash)>] PurchaseLabelsResponse
data, response status code and response headers
# 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 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. @param body @param [Hash] opts the optional parameters @return [PurchaseShipmentResponse]
# 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 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. @param body @param [Hash] opts the optional parameters @return [Array<(PurchaseShipmentResponse
, Integer, Hash)>] PurchaseShipmentResponse
data, response status code and response headers
# 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 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. @param body @param shipment_id @param tracking_id @param [Hash] opts the optional parameters @return [RetrieveShippingLabelResponse]
# 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 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. @param body @param shipment_id @param tracking_id @param [Hash] opts the optional parameters @return [Array<(RetrieveShippingLabelResponse
, Integer, Hash)>] RetrieveShippingLabelResponse
data, response status code and response headers
# 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