class AmzSpApi::MerchantFulfillmentApiModel::MerchantFulfillmentApi
Attributes
Public Class Methods
# File lib/merchant-fulfillment-api-model/api/merchant_fulfillment_api.rb, line 16 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Cancel the shipment indicated by the specified shipment identifier. **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 shipment_id The Amazon-defined shipment identifier for the shipment to cancel. @param [Hash] opts the optional parameters @return [CancelShipmentResponse]
# File lib/merchant-fulfillment-api-model/api/merchant_fulfillment_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 the shipment indicated by the specified shipment identifer. **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 shipment_id The Amazon-defined shipment identifier for the shipment to cancel. @param [Hash] opts the optional parameters @return [CancelShipmentResponse]
# File lib/merchant-fulfillment-api-model/api/merchant_fulfillment_api.rb, line 77 def cancel_shipment_old(shipment_id, opts = {}) data, _status_code, _headers = cancel_shipment_old_with_http_info(shipment_id, opts) data end
Cancel the shipment indicated by the specified shipment identifer. **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 shipment_id The Amazon-defined shipment identifier for the shipment to cancel. @param [Hash] opts the optional parameters @return [Array<(CancelShipmentResponse
, Integer, Hash)>] CancelShipmentResponse
data, response status code and response headers
# File lib/merchant-fulfillment-api-model/api/merchant_fulfillment_api.rb, line 86 def cancel_shipment_old_with_http_info(shipment_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MerchantFulfillmentApi.cancel_shipment_old ...' 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 MerchantFulfillmentApi.cancel_shipment_old" end # resource path local_var_path = '/mfn/v0/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(:PUT, 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: MerchantFulfillmentApi#cancel_shipment_old\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Cancel the shipment indicated by the specified shipment identifier. **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 shipment_id The Amazon-defined shipment identifier for the shipment to cancel. @param [Hash] opts the optional parameters @return [Array<(CancelShipmentResponse
, Integer, Hash)>] CancelShipmentResponse
data, response status code and response headers
# File lib/merchant-fulfillment-api-model/api/merchant_fulfillment_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: MerchantFulfillmentApi.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 MerchantFulfillmentApi.cancel_shipment" end # resource path local_var_path = '/mfn/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] || 'CancelShipmentResponse' auth_names = opts[:auth_names] || [] data, status_code, headers = @api_client.call_api(:DELETE, 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: MerchantFulfillmentApi#cancel_shipment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Create a shipment with the information provided. **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 body @param [Hash] opts the optional parameters @return [CreateShipmentResponse]
# File lib/merchant-fulfillment-api-model/api/merchant_fulfillment_api.rb, line 131 def create_shipment(body, opts = {}) data, _status_code, _headers = create_shipment_with_http_info(body, opts) data end
Create a shipment with the information provided. **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 body @param [Hash] opts the optional parameters @return [Array<(CreateShipmentResponse
, Integer, Hash)>] CreateShipmentResponse
data, response status code and response headers
# File lib/merchant-fulfillment-api-model/api/merchant_fulfillment_api.rb, line 140 def create_shipment_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MerchantFulfillmentApi.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 MerchantFulfillmentApi.create_shipment" end # resource path local_var_path = '/mfn/v0/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: MerchantFulfillmentApi#create_shipment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Gets a list of additional seller inputs required for a ship method. This is generally used for international shipping. **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 body @param [Hash] opts the optional parameters @return [GetAdditionalSellerInputsResponse]
# File lib/merchant-fulfillment-api-model/api/merchant_fulfillment_api.rb, line 187 def get_additional_seller_inputs(body, opts = {}) data, _status_code, _headers = get_additional_seller_inputs_with_http_info(body, opts) data end
Get a list of additional seller inputs required for a ship method. This is generally used for international shipping. **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 body @param [Hash] opts the optional parameters @return [GetAdditionalSellerInputsResponse]
# File lib/merchant-fulfillment-api-model/api/merchant_fulfillment_api.rb, line 243 def get_additional_seller_inputs_old(body, opts = {}) data, _status_code, _headers = get_additional_seller_inputs_old_with_http_info(body, opts) data end
Get a list of additional seller inputs required for a ship method. This is generally used for international shipping. **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 body @param [Hash] opts the optional parameters @return [Array<(GetAdditionalSellerInputsResponse
, Integer, Hash)>] GetAdditionalSellerInputsResponse
data, response status code and response headers
# File lib/merchant-fulfillment-api-model/api/merchant_fulfillment_api.rb, line 252 def get_additional_seller_inputs_old_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MerchantFulfillmentApi.get_additional_seller_inputs_old ...' 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 MerchantFulfillmentApi.get_additional_seller_inputs_old" end # resource path local_var_path = '/mfn/v0/sellerInputs' # 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] || 'GetAdditionalSellerInputsResponse' 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: MerchantFulfillmentApi#get_additional_seller_inputs_old\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Gets a list of additional seller inputs required for a ship method. This is generally used for international shipping. **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 body @param [Hash] opts the optional parameters @return [Array<(GetAdditionalSellerInputsResponse
, Integer, Hash)>] GetAdditionalSellerInputsResponse
data, response status code and response headers
# File lib/merchant-fulfillment-api-model/api/merchant_fulfillment_api.rb, line 196 def get_additional_seller_inputs_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MerchantFulfillmentApi.get_additional_seller_inputs ...' 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 MerchantFulfillmentApi.get_additional_seller_inputs" end # resource path local_var_path = '/mfn/v0/additionalSellerInputs' # 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] || 'GetAdditionalSellerInputsResponse' 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: MerchantFulfillmentApi#get_additional_seller_inputs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Returns a list of shipping service offers that satisfy the specified shipment request details. **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 body @param [Hash] opts the optional parameters @return [GetEligibleShipmentServicesResponse]
# File lib/merchant-fulfillment-api-model/api/merchant_fulfillment_api.rb, line 299 def get_eligible_shipment_services(body, opts = {}) data, _status_code, _headers = get_eligible_shipment_services_with_http_info(body, opts) data end
Returns a list of shipping service offers that satisfy the specified shipment request details. **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 body @param [Hash] opts the optional parameters @return [GetEligibleShipmentServicesResponse]
# File lib/merchant-fulfillment-api-model/api/merchant_fulfillment_api.rb, line 355 def get_eligible_shipment_services_old(body, opts = {}) data, _status_code, _headers = get_eligible_shipment_services_old_with_http_info(body, opts) data end
Returns a list of shipping service offers that satisfy the specified shipment request details. **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 body @param [Hash] opts the optional parameters @return [Array<(GetEligibleShipmentServicesResponse
, Integer, Hash)>] GetEligibleShipmentServicesResponse
data, response status code and response headers
# File lib/merchant-fulfillment-api-model/api/merchant_fulfillment_api.rb, line 364 def get_eligible_shipment_services_old_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MerchantFulfillmentApi.get_eligible_shipment_services_old ...' 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 MerchantFulfillmentApi.get_eligible_shipment_services_old" end # resource path local_var_path = '/mfn/v0/eligibleServices' # 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] || 'GetEligibleShipmentServicesResponse' 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: MerchantFulfillmentApi#get_eligible_shipment_services_old\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Returns a list of shipping service offers that satisfy the specified shipment request details. **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 body @param [Hash] opts the optional parameters @return [Array<(GetEligibleShipmentServicesResponse
, Integer, Hash)>] GetEligibleShipmentServicesResponse
data, response status code and response headers
# File lib/merchant-fulfillment-api-model/api/merchant_fulfillment_api.rb, line 308 def get_eligible_shipment_services_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MerchantFulfillmentApi.get_eligible_shipment_services ...' 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 MerchantFulfillmentApi.get_eligible_shipment_services" end # resource path local_var_path = '/mfn/v0/eligibleShippingServices' # 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] || 'GetEligibleShipmentServicesResponse' 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: MerchantFulfillmentApi#get_eligible_shipment_services\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Returns the shipment information for an existing 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 shipment_id The Amazon-defined shipment identifier for the shipment. @param [Hash] opts the optional parameters @return [GetShipmentResponse]
# File lib/merchant-fulfillment-api-model/api/merchant_fulfillment_api.rb, line 411 def get_shipment(shipment_id, opts = {}) data, _status_code, _headers = get_shipment_with_http_info(shipment_id, opts) data end
Returns the shipment information for an existing 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 shipment_id The Amazon-defined shipment identifier for the shipment. @param [Hash] opts the optional parameters @return [Array<(GetShipmentResponse
, Integer, Hash)>] GetShipmentResponse
data, response status code and response headers
# File lib/merchant-fulfillment-api-model/api/merchant_fulfillment_api.rb, line 420 def get_shipment_with_http_info(shipment_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MerchantFulfillmentApi.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 MerchantFulfillmentApi.get_shipment" end # resource path local_var_path = '/mfn/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] || '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: MerchantFulfillmentApi#get_shipment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end