class AmzSpApi::FulfillmentInboundApiModel::FbaInboundApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/fulfillment-inbound-api-model/api/fba_inbound_api.rb, line 16
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

confirm_preorder(shipment_id, need_by_date, marketplace_id, opts = {}) click to toggle source

Returns information needed to confirm a shipment for pre-order. Call this operation after calling the getPreorderInfo operation to get the NeedByDate value and other pre-order information about the shipment. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation. @param shipment_id A shipment identifier originally returned by the createInboundShipmentPlan operation. @param need_by_date Date that the shipment must arrive at the Amazon fulfillment center to avoid delivery promise breaks for pre-ordered items. Must be in YYYY-MM-DD format. The response to the getPreorderInfo operation returns this value. @param marketplace_id A marketplace identifier. Specifies the marketplace the shipment is tied to. @param [Hash] opts the optional parameters @return [ConfirmPreorderResponse]

# File lib/fulfillment-inbound-api-model/api/fba_inbound_api.rb, line 25
def confirm_preorder(shipment_id, need_by_date, marketplace_id, opts = {})
  data, _status_code, _headers = confirm_preorder_with_http_info(shipment_id, need_by_date, marketplace_id, opts)
  data
end
confirm_preorder_with_http_info(shipment_id, need_by_date, marketplace_id, opts = {}) click to toggle source

Returns information needed to confirm a shipment for pre-order. Call this operation after calling the getPreorderInfo operation to get the NeedByDate value and other pre-order information about the shipment. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | For more information, see "Usage Plans and Rate Limits&quot; in the Selling Partner API documentation. @param shipment_id A shipment identifier originally returned by the createInboundShipmentPlan operation. @param need_by_date Date that the shipment must arrive at the Amazon fulfillment center to avoid delivery promise breaks for pre-ordered items. Must be in YYYY-MM-DD format. The response to the getPreorderInfo operation returns this value. @param marketplace_id A marketplace identifier. Specifies the marketplace the shipment is tied to. @param [Hash] opts the optional parameters @return [Array<(ConfirmPreorderResponse, Integer, Hash)>] ConfirmPreorderResponse data, response status code and response headers

# File lib/fulfillment-inbound-api-model/api/fba_inbound_api.rb, line 36
def confirm_preorder_with_http_info(shipment_id, need_by_date, marketplace_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FbaInboundApi.confirm_preorder ...'
  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 FbaInboundApi.confirm_preorder"
  end
  # verify the required parameter 'need_by_date' is set
  if @api_client.config.client_side_validation && need_by_date.nil?
    fail ArgumentError, "Missing the required parameter 'need_by_date' when calling FbaInboundApi.confirm_preorder"
  end
  # verify the required parameter 'marketplace_id' is set
  if @api_client.config.client_side_validation && marketplace_id.nil?
    fail ArgumentError, "Missing the required parameter 'marketplace_id' when calling FbaInboundApi.confirm_preorder"
  end
  # resource path
  local_var_path = '/fba/inbound/v0/shipments/{shipmentId}/preorder/confirm'.sub('{' + 'shipmentId' + '}', shipment_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'NeedByDate'] = need_by_date
  query_params[:'MarketplaceId'] = marketplace_id

  # 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] || 'ConfirmPreorderResponse' 

  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: FbaInboundApi#confirm_preorder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
confirm_transport(shipment_id, opts = {}) click to toggle source

Confirms that the seller accepts the Amazon-partnered shipping estimate, agrees to allow Amazon to charge their account for the shipping cost, and requests that the Amazon-partnered carrier ship the inbound shipment. Prior to calling the confirmTransport operation, you should call the getTransportDetails operation to get the Amazon-partnered shipping estimate. Important: After confirming the transportation request, if the seller decides that they do not want the Amazon-partnered carrier to ship the inbound shipment, you can call the voidTransport operation to cancel the transportation request. Note that for a Small Parcel shipment, the seller has 24 hours after confirming a transportation request to void the transportation request. For a Less Than Truckload/Full Truckload (LTL/FTL) shipment, the seller has one hour after confirming a transportation request to void it. After the grace period has expired the seller's account will be charged for the shipping cost. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation. @param shipment_id A shipment identifier originally returned by the createInboundShipmentPlan operation. @param [Hash] opts the optional parameters @return [ConfirmTransportResponse]

# File lib/fulfillment-inbound-api-model/api/fba_inbound_api.rb, line 91
def confirm_transport(shipment_id, opts = {})
  data, _status_code, _headers = confirm_transport_with_http_info(shipment_id, opts)
  data
end
confirm_transport_with_http_info(shipment_id, opts = {}) click to toggle source

Confirms that the seller accepts the Amazon-partnered shipping estimate, agrees to allow Amazon to charge their account for the shipping cost, and requests that the Amazon-partnered carrier ship the inbound shipment. Prior to calling the confirmTransport operation, you should call the getTransportDetails operation to get the Amazon-partnered shipping estimate. Important: After confirming the transportation request, if the seller decides that they do not want the Amazon-partnered carrier to ship the inbound shipment, you can call the voidTransport operation to cancel the transportation request. Note that for a Small Parcel shipment, the seller has 24 hours after confirming a transportation request to void the transportation request. For a Less Than Truckload/Full Truckload (LTL/FTL) shipment, the seller has one hour after confirming a transportation request to void it. After the grace period has expired the seller&#x27;s account will be charged for the shipping cost. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | For more information, see "Usage Plans and Rate Limits&quot; in the Selling Partner API documentation. @param shipment_id A shipment identifier originally returned by the createInboundShipmentPlan operation. @param [Hash] opts the optional parameters @return [Array<(ConfirmTransportResponse, Integer, Hash)>] ConfirmTransportResponse data, response status code and response headers

# File lib/fulfillment-inbound-api-model/api/fba_inbound_api.rb, line 100
def confirm_transport_with_http_info(shipment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FbaInboundApi.confirm_transport ...'
  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 FbaInboundApi.confirm_transport"
  end
  # resource path
  local_var_path = '/fba/inbound/v0/shipments/{shipmentId}/transport/confirm'.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] || 'ConfirmTransportResponse' 

  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: FbaInboundApi#confirm_transport\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
create_inbound_shipment(body, shipment_id, opts = {}) click to toggle source

Returns a new inbound shipment based on the specified shipmentId that was returned by the createInboundShipmentPlan operation. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation. @param body @param shipment_id A shipment identifier originally returned by the createInboundShipmentPlan operation. @param [Hash] opts the optional parameters @return [InboundShipmentResponse]

# File lib/fulfillment-inbound-api-model/api/fba_inbound_api.rb, line 146
def create_inbound_shipment(body, shipment_id, opts = {})
  data, _status_code, _headers = create_inbound_shipment_with_http_info(body, shipment_id, opts)
  data
end
create_inbound_shipment_plan(body, opts = {}) click to toggle source

Returns one or more inbound shipment plans, which provide the information you need to create one or more inbound shipments for a set of items that you specify. Multiple inbound shipment plans might be required so that items can be optimally placed in Amazon's fulfillment network—for example, positioning inventory closer to the customer. Alternatively, two inbound shipment plans might be created with the same Amazon fulfillment center destination if the two shipment plans require different processing—for example, items that require labels must be shipped separately from stickerless, commingled inventory. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation. @param body @param [Hash] opts the optional parameters @return [CreateInboundShipmentPlanResponse]

# File lib/fulfillment-inbound-api-model/api/fba_inbound_api.rb, line 207
def create_inbound_shipment_plan(body, opts = {})
  data, _status_code, _headers = create_inbound_shipment_plan_with_http_info(body, opts)
  data
end
create_inbound_shipment_plan_with_http_info(body, opts = {}) click to toggle source

Returns one or more inbound shipment plans, which provide the information you need to create one or more inbound shipments for a set of items that you specify. Multiple inbound shipment plans might be required so that items can be optimally placed in Amazon&#x27;s fulfillment network—for example, positioning inventory closer to the customer. Alternatively, two inbound shipment plans might be created with the same Amazon fulfillment center destination if the two shipment plans require different processing—for example, items that require labels must be shipped separately from stickerless, commingled inventory. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | For more information, see "Usage Plans and Rate Limits&quot; in the Selling Partner API documentation. @param body @param [Hash] opts the optional parameters @return [Array<(CreateInboundShipmentPlanResponse, Integer, Hash)>] CreateInboundShipmentPlanResponse data, response status code and response headers

# File lib/fulfillment-inbound-api-model/api/fba_inbound_api.rb, line 216
def create_inbound_shipment_plan_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FbaInboundApi.create_inbound_shipment_plan ...'
  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 FbaInboundApi.create_inbound_shipment_plan"
  end
  # resource path
  local_var_path = '/fba/inbound/v0/plans'

  # 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] || 'CreateInboundShipmentPlanResponse' 

  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: FbaInboundApi#create_inbound_shipment_plan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
create_inbound_shipment_with_http_info(body, shipment_id, opts = {}) click to toggle source

Returns a new inbound shipment based on the specified shipmentId that was returned by the createInboundShipmentPlan operation. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | For more information, see "Usage Plans and Rate Limits&quot; in the Selling Partner API documentation. @param body @param shipment_id A shipment identifier originally returned by the createInboundShipmentPlan operation. @param [Hash] opts the optional parameters @return [Array<(InboundShipmentResponse, Integer, Hash)>] InboundShipmentResponse data, response status code and response headers

# File lib/fulfillment-inbound-api-model/api/fba_inbound_api.rb, line 156
def create_inbound_shipment_with_http_info(body, shipment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FbaInboundApi.create_inbound_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 FbaInboundApi.create_inbound_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 FbaInboundApi.create_inbound_shipment"
  end
  # resource path
  local_var_path = '/fba/inbound/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'])
  # 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] || 'InboundShipmentResponse' 

  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: FbaInboundApi#create_inbound_shipment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
estimate_transport(shipment_id, opts = {}) click to toggle source

Initiates the process of estimating the shipping cost for an inbound shipment by an Amazon-partnered carrier. Prior to calling the estimateTransport operation, you must call the putTransportDetails operation to provide Amazon with the transportation information for the inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation. @param shipment_id A shipment identifier originally returned by the createInboundShipmentPlan operation. @param [Hash] opts the optional parameters @return [EstimateTransportResponse]

# File lib/fulfillment-inbound-api-model/api/fba_inbound_api.rb, line 263
def estimate_transport(shipment_id, opts = {})
  data, _status_code, _headers = estimate_transport_with_http_info(shipment_id, opts)
  data
end
estimate_transport_with_http_info(shipment_id, opts = {}) click to toggle source

Initiates the process of estimating the shipping cost for an inbound shipment by an Amazon-partnered carrier. Prior to calling the estimateTransport operation, you must call the putTransportDetails operation to provide Amazon with the transportation information for the inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | For more information, see "Usage Plans and Rate Limits&quot; in the Selling Partner API documentation. @param shipment_id A shipment identifier originally returned by the createInboundShipmentPlan operation. @param [Hash] opts the optional parameters @return [Array<(EstimateTransportResponse, Integer, Hash)>] EstimateTransportResponse data, response status code and response headers

# File lib/fulfillment-inbound-api-model/api/fba_inbound_api.rb, line 272
def estimate_transport_with_http_info(shipment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FbaInboundApi.estimate_transport ...'
  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 FbaInboundApi.estimate_transport"
  end
  # resource path
  local_var_path = '/fba/inbound/v0/shipments/{shipmentId}/transport/estimate'.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] || 'EstimateTransportResponse' 

  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: FbaInboundApi#estimate_transport\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_bill_of_lading(shipment_id, opts = {}) click to toggle source

Returns a bill of lading for a Less Than Truckload/Full Truckload (LTL/FTL) shipment. The getBillOfLading operation returns PDF document data for printing a bill of lading for an Amazon-partnered Less Than Truckload/Full Truckload (LTL/FTL) inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation. @param shipment_id A shipment identifier originally returned by the createInboundShipmentPlan operation. @param [Hash] opts the optional parameters @return [GetBillOfLadingResponse]

# File lib/fulfillment-inbound-api-model/api/fba_inbound_api.rb, line 317
def get_bill_of_lading(shipment_id, opts = {})
  data, _status_code, _headers = get_bill_of_lading_with_http_info(shipment_id, opts)
  data
end
get_bill_of_lading_with_http_info(shipment_id, opts = {}) click to toggle source

Returns a bill of lading for a Less Than Truckload/Full Truckload (LTL/FTL) shipment. The getBillOfLading operation returns PDF document data for printing a bill of lading for an Amazon-partnered Less Than Truckload/Full Truckload (LTL/FTL) inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | For more information, see "Usage Plans and Rate Limits&quot; in the Selling Partner API documentation. @param shipment_id A shipment identifier originally returned by the createInboundShipmentPlan operation. @param [Hash] opts the optional parameters @return [Array<(GetBillOfLadingResponse, Integer, Hash)>] GetBillOfLadingResponse data, response status code and response headers

# File lib/fulfillment-inbound-api-model/api/fba_inbound_api.rb, line 326
def get_bill_of_lading_with_http_info(shipment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FbaInboundApi.get_bill_of_lading ...'
  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 FbaInboundApi.get_bill_of_lading"
  end
  # resource path
  local_var_path = '/fba/inbound/v0/shipments/{shipmentId}/billOfLading'.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] || 'GetBillOfLadingResponse' 

  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: FbaInboundApi#get_bill_of_lading\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_inbound_guidance(marketplace_id, opts = {}) click to toggle source

Returns information that lets a seller know if Amazon recommends sending an item to a given marketplace. In some cases, Amazon provides guidance for why a given SellerSKU or ASIN is not recommended for shipment to Amazon's fulfillment network. Sellers may still ship items that are not recommended, at their discretion. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation. @param marketplace_id A marketplace identifier. Specifies the marketplace where the product would be stored. @param [Hash] opts the optional parameters @option opts [Array<String>] :seller_sku_list A list of SellerSKU values. Used to identify items for which you want inbound guidance for shipment to Amazon&#x27;s fulfillment network. Note: SellerSKU is qualified by the SellerId, which is included with every Selling Partner API operation that you submit. If you specify a SellerSKU that identifies a variation parent ASIN, this operation returns an error. A variation parent ASIN represents a generic product that cannot be sold. Variation child ASINs represent products that have specific characteristics (such as size and color) and can be sold. @option opts [Array<String>] :asin_list A list of ASIN values. Used to identify items for which you want inbound guidance for shipment to Amazon&#x27;s fulfillment network. Note: If you specify a ASIN that identifies a variation parent ASIN, this operation returns an error. A variation parent ASIN represents a generic product that cannot be sold. Variation child ASINs represent products that have specific characteristics (such as size and color) and can be sold. @return [GetInboundGuidanceResponse]

# File lib/fulfillment-inbound-api-model/api/fba_inbound_api.rb, line 373
def get_inbound_guidance(marketplace_id, opts = {})
  data, _status_code, _headers = get_inbound_guidance_with_http_info(marketplace_id, opts)
  data
end
get_inbound_guidance_with_http_info(marketplace_id, opts = {}) click to toggle source

Returns information that lets a seller know if Amazon recommends sending an item to a given marketplace. In some cases, Amazon provides guidance for why a given SellerSKU or ASIN is not recommended for shipment to Amazon&#x27;s fulfillment network. Sellers may still ship items that are not recommended, at their discretion. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | For more information, see "Usage Plans and Rate Limits&quot; in the Selling Partner API documentation. @param marketplace_id A marketplace identifier. Specifies the marketplace where the product would be stored. @param [Hash] opts the optional parameters @option opts [Array<String>] :seller_sku_list A list of SellerSKU values. Used to identify items for which you want inbound guidance for shipment to Amazon&#x27;s fulfillment network. Note: SellerSKU is qualified by the SellerId, which is included with every Selling Partner API operation that you submit. If you specify a SellerSKU that identifies a variation parent ASIN, this operation returns an error. A variation parent ASIN represents a generic product that cannot be sold. Variation child ASINs represent products that have specific characteristics (such as size and color) and can be sold. @option opts [Array<String>] :asin_list A list of ASIN values. Used to identify items for which you want inbound guidance for shipment to Amazon&#x27;s fulfillment network. Note: If you specify a ASIN that identifies a variation parent ASIN, this operation returns an error. A variation parent ASIN represents a generic product that cannot be sold. Variation child ASINs represent products that have specific characteristics (such as size and color) and can be sold. @return [Array<(GetInboundGuidanceResponse, Integer, Hash)>] GetInboundGuidanceResponse data, response status code and response headers

# File lib/fulfillment-inbound-api-model/api/fba_inbound_api.rb, line 384
def get_inbound_guidance_with_http_info(marketplace_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FbaInboundApi.get_inbound_guidance ...'
  end
  # verify the required parameter 'marketplace_id' is set
  if @api_client.config.client_side_validation && marketplace_id.nil?
    fail ArgumentError, "Missing the required parameter 'marketplace_id' when calling FbaInboundApi.get_inbound_guidance"
  end
  # resource path
  local_var_path = '/fba/inbound/v0/itemsGuidance'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'MarketplaceId'] = marketplace_id
  query_params[:'SellerSKUList'] = @api_client.build_collection_param(opts[:'seller_sku_list'], :csv) if !opts[:'seller_sku_list'].nil?
  query_params[:'ASINList'] = @api_client.build_collection_param(opts[:'asin_list'], :csv) if !opts[:'asin_list'].nil?

  # 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] || 'GetInboundGuidanceResponse' 

  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: FbaInboundApi#get_inbound_guidance\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_labels(shipment_id, page_type, label_type, opts = {}) click to toggle source

Returns package/pallet labels for faster and more accurate shipment processing at the Amazon fulfillment center. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation. @param shipment_id A shipment identifier originally returned by the createInboundShipmentPlan operation. @param page_type The page type to use to print the labels. Submitting a PageType value that is not supported in your marketplace returns an error. @param label_type The type of labels requested. @param [Hash] opts the optional parameters @option opts [Integer] :number_of_packages The number of packages in the shipment. @option opts [Array<String>] :package_labels_to_print A list of identifiers that specify packages for which you want package labels printed. Must match CartonId values previously passed using the FBA Inbound Shipment Carton Information Feed. If not, the operation returns the IncorrectPackageIdentifier error code. @option opts [Integer] :number_of_pallets The number of pallets in the shipment. This returns four identical labels for each pallet. @return [GetLabelsResponse]

# File lib/fulfillment-inbound-api-model/api/fba_inbound_api.rb, line 437
def get_labels(shipment_id, page_type, label_type, opts = {})
  data, _status_code, _headers = get_labels_with_http_info(shipment_id, page_type, label_type, opts)
  data
end
get_labels_with_http_info(shipment_id, page_type, label_type, opts = {}) click to toggle source

Returns package/pallet labels for faster and more accurate shipment processing at the Amazon fulfillment center. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | For more information, see "Usage Plans and Rate Limits&quot; in the Selling Partner API documentation. @param shipment_id A shipment identifier originally returned by the createInboundShipmentPlan operation. @param page_type The page type to use to print the labels. Submitting a PageType value that is not supported in your marketplace returns an error. @param label_type The type of labels requested. @param [Hash] opts the optional parameters @option opts [Integer] :number_of_packages The number of packages in the shipment. @option opts [Array<String>] :package_labels_to_print A list of identifiers that specify packages for which you want package labels printed. Must match CartonId values previously passed using the FBA Inbound Shipment Carton Information Feed. If not, the operation returns the IncorrectPackageIdentifier error code. @option opts [Integer] :number_of_pallets The number of pallets in the shipment. This returns four identical labels for each pallet. @return [Array<(GetLabelsResponse, Integer, Hash)>] GetLabelsResponse data, response status code and response headers

# File lib/fulfillment-inbound-api-model/api/fba_inbound_api.rb, line 451
def get_labels_with_http_info(shipment_id, page_type, label_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FbaInboundApi.get_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 FbaInboundApi.get_labels"
  end
  # verify the required parameter 'page_type' is set
  if @api_client.config.client_side_validation && page_type.nil?
    fail ArgumentError, "Missing the required parameter 'page_type' when calling FbaInboundApi.get_labels"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['PackageLabel_Letter_2', 'PackageLabel_Letter_4', 'PackageLabel_Letter_6', 'PackageLabel_Letter_6_CarrierLeft', 'PackageLabel_A4_2', 'PackageLabel_A4_4', 'PackageLabel_Plain_Paper', 'PackageLabel_Plain_Paper_CarrierBottom', 'PackageLabel_Thermal', 'PackageLabel_Thermal_Unified', 'PackageLabel_Thermal_NonPCP', 'PackageLabel_Thermal_No_Carrier_Rotation'].include?(page_type)
    fail ArgumentError, "invalid value for 'page_type', must be one of PackageLabel_Letter_2, PackageLabel_Letter_4, PackageLabel_Letter_6, PackageLabel_Letter_6_CarrierLeft, PackageLabel_A4_2, PackageLabel_A4_4, PackageLabel_Plain_Paper, PackageLabel_Plain_Paper_CarrierBottom, PackageLabel_Thermal, PackageLabel_Thermal_Unified, PackageLabel_Thermal_NonPCP, PackageLabel_Thermal_No_Carrier_Rotation"
  end
  # verify the required parameter 'label_type' is set
  if @api_client.config.client_side_validation && label_type.nil?
    fail ArgumentError, "Missing the required parameter 'label_type' when calling FbaInboundApi.get_labels"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['DEFAULT', 'UNIQUE', 'PALLET'].include?(label_type)
    fail ArgumentError, "invalid value for 'label_type', must be one of DEFAULT, UNIQUE, PALLET"
  end
  # resource path
  local_var_path = '/fba/inbound/v0/shipments/{shipmentId}/labels'.sub('{' + 'shipmentId' + '}', shipment_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'PageType'] = page_type
  query_params[:'LabelType'] = label_type
  query_params[:'NumberOfPackages'] = opts[:'number_of_packages'] if !opts[:'number_of_packages'].nil?
  query_params[:'PackageLabelsToPrint'] = @api_client.build_collection_param(opts[:'package_labels_to_print'], :csv) if !opts[:'package_labels_to_print'].nil?
  query_params[:'NumberOfPallets'] = opts[:'number_of_pallets'] if !opts[:'number_of_pallets'].nil?

  # 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] || 'GetLabelsResponse' 

  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: FbaInboundApi#get_labels\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_preorder_info(shipment_id, marketplace_id, opts = {}) click to toggle source

Returns pre-order information, including dates, that a seller needs before confirming a shipment for pre-order. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation. @param shipment_id A shipment identifier originally returned by the createInboundShipmentPlan operation. @param marketplace_id A marketplace identifier. Specifies the marketplace the shipment is tied to. @param [Hash] opts the optional parameters @return [GetPreorderInfoResponse]

# File lib/fulfillment-inbound-api-model/api/fba_inbound_api.rb, line 518
def get_preorder_info(shipment_id, marketplace_id, opts = {})
  data, _status_code, _headers = get_preorder_info_with_http_info(shipment_id, marketplace_id, opts)
  data
end
get_preorder_info_with_http_info(shipment_id, marketplace_id, opts = {}) click to toggle source

Returns pre-order information, including dates, that a seller needs before confirming a shipment for pre-order. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | For more information, see "Usage Plans and Rate Limits&quot; in the Selling Partner API documentation. @param shipment_id A shipment identifier originally returned by the createInboundShipmentPlan operation. @param marketplace_id A marketplace identifier. Specifies the marketplace the shipment is tied to. @param [Hash] opts the optional parameters @return [Array<(GetPreorderInfoResponse, Integer, Hash)>] GetPreorderInfoResponse data, response status code and response headers

# File lib/fulfillment-inbound-api-model/api/fba_inbound_api.rb, line 528
def get_preorder_info_with_http_info(shipment_id, marketplace_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FbaInboundApi.get_preorder_info ...'
  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 FbaInboundApi.get_preorder_info"
  end
  # verify the required parameter 'marketplace_id' is set
  if @api_client.config.client_side_validation && marketplace_id.nil?
    fail ArgumentError, "Missing the required parameter 'marketplace_id' when calling FbaInboundApi.get_preorder_info"
  end
  # resource path
  local_var_path = '/fba/inbound/v0/shipments/{shipmentId}/preorder'.sub('{' + 'shipmentId' + '}', shipment_id.to_s)

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

  # 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] || 'GetPreorderInfoResponse' 

  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: FbaInboundApi#get_preorder_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_prep_instructions(ship_to_country_code, opts = {}) click to toggle source

Returns labeling requirements and item preparation instructions to help prepare items for shipment to Amazon's fulfillment network. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation. @param ship_to_country_code The country code of the country to which the items will be shipped. Note that labeling requirements and item preparation instructions can vary by country. @param [Hash] opts the optional parameters @option opts [Array<String>] :seller_sku_list A list of SellerSKU values. Used to identify items for which you want labeling requirements and item preparation instructions for shipment to Amazon&#x27;s fulfillment network. The SellerSKU is qualified by the Seller ID, which is included with every call to the Seller Partner API. Note: Include seller SKUs that you have used to list items on Amazon&#x27;s retail website. If you include a seller SKU that you have never used to list an item on Amazon&#x27;s retail website, the seller SKU is returned in the InvalidSKUList property in the response. @option opts [Array<String>] :asin_list A list of ASIN values. Used to identify items for which you want item preparation instructions to help with item sourcing decisions. Note: ASINs must be included in the product catalog for at least one of the marketplaces that the seller participates in. Any ASIN that is not included in the product catalog for at least one of the marketplaces that the seller participates in is returned in the InvalidASINList property in the response. You can find out which marketplaces a seller participates in by calling the getMarketplaceParticipations operation in the Selling Partner API for Sellers. @return [GetPrepInstructionsResponse]

# File lib/fulfillment-inbound-api-model/api/fba_inbound_api.rb, line 580
def get_prep_instructions(ship_to_country_code, opts = {})
  data, _status_code, _headers = get_prep_instructions_with_http_info(ship_to_country_code, opts)
  data
end
get_prep_instructions_with_http_info(ship_to_country_code, opts = {}) click to toggle source

Returns labeling requirements and item preparation instructions to help prepare items for shipment to Amazon&#x27;s fulfillment network. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | For more information, see "Usage Plans and Rate Limits&quot; in the Selling Partner API documentation. @param ship_to_country_code The country code of the country to which the items will be shipped. Note that labeling requirements and item preparation instructions can vary by country. @param [Hash] opts the optional parameters @option opts [Array<String>] :seller_sku_list A list of SellerSKU values. Used to identify items for which you want labeling requirements and item preparation instructions for shipment to Amazon&#x27;s fulfillment network. The SellerSKU is qualified by the Seller ID, which is included with every call to the Seller Partner API. Note: Include seller SKUs that you have used to list items on Amazon&#x27;s retail website. If you include a seller SKU that you have never used to list an item on Amazon&#x27;s retail website, the seller SKU is returned in the InvalidSKUList property in the response. @option opts [Array<String>] :asin_list A list of ASIN values. Used to identify items for which you want item preparation instructions to help with item sourcing decisions. Note: ASINs must be included in the product catalog for at least one of the marketplaces that the seller participates in. Any ASIN that is not included in the product catalog for at least one of the marketplaces that the seller participates in is returned in the InvalidASINList property in the response. You can find out which marketplaces a seller participates in by calling the getMarketplaceParticipations operation in the Selling Partner API for Sellers. @return [Array<(GetPrepInstructionsResponse, Integer, Hash)>] GetPrepInstructionsResponse data, response status code and response headers

# File lib/fulfillment-inbound-api-model/api/fba_inbound_api.rb, line 591
def get_prep_instructions_with_http_info(ship_to_country_code, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FbaInboundApi.get_prep_instructions ...'
  end
  # verify the required parameter 'ship_to_country_code' is set
  if @api_client.config.client_side_validation && ship_to_country_code.nil?
    fail ArgumentError, "Missing the required parameter 'ship_to_country_code' when calling FbaInboundApi.get_prep_instructions"
  end
  # resource path
  local_var_path = '/fba/inbound/v0/prepInstructions'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ShipToCountryCode'] = ship_to_country_code
  query_params[:'SellerSKUList'] = @api_client.build_collection_param(opts[:'seller_sku_list'], :csv) if !opts[:'seller_sku_list'].nil?
  query_params[:'ASINList'] = @api_client.build_collection_param(opts[:'asin_list'], :csv) if !opts[:'asin_list'].nil?

  # 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] || 'GetPrepInstructionsResponse' 

  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: FbaInboundApi#get_prep_instructions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_shipment_items(query_type, marketplace_id, opts = {}) click to toggle source

Returns a list of items in a specified inbound shipment, or a list of items that were updated within a specified time frame. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation. @param query_type Indicates whether items are returned using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or using NextToken, which continues returning items specified in a previous request. @param marketplace_id A marketplace identifier. Specifies the marketplace where the product would be stored. @param [Hash] opts the optional parameters @option opts [DateTime] :last_updated_after A date used for selecting inbound shipment items that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller. @option opts [DateTime] :last_updated_before A date used for selecting inbound shipment items that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller. @option opts [String] :next_token A string token returned in the response to your previous request. @return [GetShipmentItemsResponse]

# File lib/fulfillment-inbound-api-model/api/fba_inbound_api.rb, line 643
def get_shipment_items(query_type, marketplace_id, opts = {})
  data, _status_code, _headers = get_shipment_items_with_http_info(query_type, marketplace_id, opts)
  data
end
get_shipment_items_by_shipment_id(shipment_id, marketplace_id, opts = {}) click to toggle source

Returns a list of items in a specified inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation. @param shipment_id A shipment identifier used for selecting items in a specific inbound shipment. @param marketplace_id A marketplace identifier. Specifies the marketplace where the product would be stored. @param [Hash] opts the optional parameters @return [GetShipmentItemsResponse]

# File lib/fulfillment-inbound-api-model/api/fba_inbound_api.rb, line 715
def get_shipment_items_by_shipment_id(shipment_id, marketplace_id, opts = {})
  data, _status_code, _headers = get_shipment_items_by_shipment_id_with_http_info(shipment_id, marketplace_id, opts)
  data
end
get_shipment_items_by_shipment_id_with_http_info(shipment_id, marketplace_id, opts = {}) click to toggle source

Returns a list of items in a specified inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | For more information, see "Usage Plans and Rate Limits&quot; in the Selling Partner API documentation. @param shipment_id A shipment identifier used for selecting items in a specific inbound shipment. @param marketplace_id A marketplace identifier. Specifies the marketplace where the product would be stored. @param [Hash] opts the optional parameters @return [Array<(GetShipmentItemsResponse, Integer, Hash)>] GetShipmentItemsResponse data, response status code and response headers

# File lib/fulfillment-inbound-api-model/api/fba_inbound_api.rb, line 725
def get_shipment_items_by_shipment_id_with_http_info(shipment_id, marketplace_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FbaInboundApi.get_shipment_items_by_shipment_id ...'
  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 FbaInboundApi.get_shipment_items_by_shipment_id"
  end
  # verify the required parameter 'marketplace_id' is set
  if @api_client.config.client_side_validation && marketplace_id.nil?
    fail ArgumentError, "Missing the required parameter 'marketplace_id' when calling FbaInboundApi.get_shipment_items_by_shipment_id"
  end
  # resource path
  local_var_path = '/fba/inbound/v0/shipments/{shipmentId}/items'.sub('{' + 'shipmentId' + '}', shipment_id.to_s)

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

  # 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] || 'GetShipmentItemsResponse' 

  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: FbaInboundApi#get_shipment_items_by_shipment_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_shipment_items_with_http_info(query_type, marketplace_id, opts = {}) click to toggle source

Returns a list of items in a specified inbound shipment, or a list of items that were updated within a specified time frame. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | For more information, see "Usage Plans and Rate Limits&quot; in the Selling Partner API documentation. @param query_type Indicates whether items are returned using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or using NextToken, which continues returning items specified in a previous request. @param marketplace_id A marketplace identifier. Specifies the marketplace where the product would be stored. @param [Hash] opts the optional parameters @option opts [DateTime] :last_updated_after A date used for selecting inbound shipment items that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller. @option opts [DateTime] :last_updated_before A date used for selecting inbound shipment items that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller. @option opts [String] :next_token A string token returned in the response to your previous request. @return [Array<(GetShipmentItemsResponse, Integer, Hash)>] GetShipmentItemsResponse data, response status code and response headers

# File lib/fulfillment-inbound-api-model/api/fba_inbound_api.rb, line 656
def get_shipment_items_with_http_info(query_type, marketplace_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FbaInboundApi.get_shipment_items ...'
  end
  # verify the required parameter 'query_type' is set
  if @api_client.config.client_side_validation && query_type.nil?
    fail ArgumentError, "Missing the required parameter 'query_type' when calling FbaInboundApi.get_shipment_items"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['DATE_RANGE', 'NEXT_TOKEN'].include?(query_type)
    fail ArgumentError, "invalid value for 'query_type', must be one of DATE_RANGE, NEXT_TOKEN"
  end
  # verify the required parameter 'marketplace_id' is set
  if @api_client.config.client_side_validation && marketplace_id.nil?
    fail ArgumentError, "Missing the required parameter 'marketplace_id' when calling FbaInboundApi.get_shipment_items"
  end
  # resource path
  local_var_path = '/fba/inbound/v0/shipmentItems'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'QueryType'] = query_type
  query_params[:'MarketplaceId'] = marketplace_id
  query_params[:'LastUpdatedAfter'] = opts[:'last_updated_after'] if !opts[:'last_updated_after'].nil?
  query_params[:'LastUpdatedBefore'] = opts[:'last_updated_before'] if !opts[:'last_updated_before'].nil?
  query_params[:'NextToken'] = opts[:'next_token'] if !opts[:'next_token'].nil?

  # 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] || 'GetShipmentItemsResponse' 

  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: FbaInboundApi#get_shipment_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_shipments(query_type, marketplace_id, opts = {}) click to toggle source

Returns a list of inbound shipments based on criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation. @param query_type Indicates whether shipments are returned using shipment information (by providing the ShipmentStatusList or ShipmentIdList parameters), using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or by using NextToken to continue returning items specified in a previous request. @param marketplace_id A marketplace identifier. Specifies the marketplace where the product would be stored. @param [Hash] opts the optional parameters @option opts [Array<String>] :shipment_status_list A list of ShipmentStatus values. Used to select shipments with a current status that matches the status values that you specify. @option opts [Array<String>] :shipment_id_list A list of shipment IDs used to select the shipments that you want. If both ShipmentStatusList and ShipmentIdList are specified, only shipments that match both parameters are returned. @option opts [DateTime] :last_updated_after A date used for selecting inbound shipments that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller. @option opts [DateTime] :last_updated_before A date used for selecting inbound shipments that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller. @option opts [String] :next_token A string token returned in the response to your previous request. @return [GetShipmentsResponse]

# File lib/fulfillment-inbound-api-model/api/fba_inbound_api.rb, line 781
def get_shipments(query_type, marketplace_id, opts = {})
  data, _status_code, _headers = get_shipments_with_http_info(query_type, marketplace_id, opts)
  data
end
get_shipments_with_http_info(query_type, marketplace_id, opts = {}) click to toggle source

Returns a list of inbound shipments based on criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | For more information, see "Usage Plans and Rate Limits&quot; in the Selling Partner API documentation. @param query_type Indicates whether shipments are returned using shipment information (by providing the ShipmentStatusList or ShipmentIdList parameters), using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or by using NextToken to continue returning items specified in a previous request. @param marketplace_id A marketplace identifier. Specifies the marketplace where the product would be stored. @param [Hash] opts the optional parameters @option opts [Array<String>] :shipment_status_list A list of ShipmentStatus values. Used to select shipments with a current status that matches the status values that you specify. @option opts [Array<String>] :shipment_id_list A list of shipment IDs used to select the shipments that you want. If both ShipmentStatusList and ShipmentIdList are specified, only shipments that match both parameters are returned. @option opts [DateTime] :last_updated_after A date used for selecting inbound shipments that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller. @option opts [DateTime] :last_updated_before A date used for selecting inbound shipments that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller. @option opts [String] :next_token A string token returned in the response to your previous request. @return [Array<(GetShipmentsResponse, Integer, Hash)>] GetShipmentsResponse data, response status code and response headers

# File lib/fulfillment-inbound-api-model/api/fba_inbound_api.rb, line 796
def get_shipments_with_http_info(query_type, marketplace_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FbaInboundApi.get_shipments ...'
  end
  # verify the required parameter 'query_type' is set
  if @api_client.config.client_side_validation && query_type.nil?
    fail ArgumentError, "Missing the required parameter 'query_type' when calling FbaInboundApi.get_shipments"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['SHIPMENT', 'DATE_RANGE', 'NEXT_TOKEN'].include?(query_type)
    fail ArgumentError, "invalid value for 'query_type', must be one of SHIPMENT, DATE_RANGE, NEXT_TOKEN"
  end
  # verify the required parameter 'marketplace_id' is set
  if @api_client.config.client_side_validation && marketplace_id.nil?
    fail ArgumentError, "Missing the required parameter 'marketplace_id' when calling FbaInboundApi.get_shipments"
  end
  if @api_client.config.client_side_validation && opts[:'shipment_status_list'] && !opts[:'shipment_status_list'].all? { |item| ['WORKING', 'SHIPPED', 'RECEIVING', 'CANCELLED', 'DELETED', 'CLOSED', 'ERROR', 'IN_TRANSIT', 'DELIVERED', 'CHECKED_IN'].include?(item) }
    fail ArgumentError, 'invalid value for "shipment_status_list", must include one of WORKING, SHIPPED, RECEIVING, CANCELLED, DELETED, CLOSED, ERROR, IN_TRANSIT, DELIVERED, CHECKED_IN'
  end
  # resource path
  local_var_path = '/fba/inbound/v0/shipments'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'QueryType'] = query_type
  query_params[:'MarketplaceId'] = marketplace_id
  query_params[:'ShipmentStatusList'] = @api_client.build_collection_param(opts[:'shipment_status_list'], :csv) if !opts[:'shipment_status_list'].nil?
  query_params[:'ShipmentIdList'] = @api_client.build_collection_param(opts[:'shipment_id_list'], :csv) if !opts[:'shipment_id_list'].nil?
  query_params[:'LastUpdatedAfter'] = opts[:'last_updated_after'] if !opts[:'last_updated_after'].nil?
  query_params[:'LastUpdatedBefore'] = opts[:'last_updated_before'] if !opts[:'last_updated_before'].nil?
  query_params[:'NextToken'] = opts[:'next_token'] if !opts[:'next_token'].nil?

  # 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] || 'GetShipmentsResponse' 

  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: FbaInboundApi#get_shipments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_transport_details(shipment_id, opts = {}) click to toggle source

Returns current transportation information about an inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation. @param shipment_id A shipment identifier originally returned by the createInboundShipmentPlan operation. @param [Hash] opts the optional parameters @return [GetTransportDetailsResponse]

# File lib/fulfillment-inbound-api-model/api/fba_inbound_api.rb, line 859
def get_transport_details(shipment_id, opts = {})
  data, _status_code, _headers = get_transport_details_with_http_info(shipment_id, opts)
  data
end
get_transport_details_with_http_info(shipment_id, opts = {}) click to toggle source

Returns current transportation information about an inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | For more information, see "Usage Plans and Rate Limits&quot; in the Selling Partner API documentation. @param shipment_id A shipment identifier originally returned by the createInboundShipmentPlan operation. @param [Hash] opts the optional parameters @return [Array<(GetTransportDetailsResponse, Integer, Hash)>] GetTransportDetailsResponse data, response status code and response headers

# File lib/fulfillment-inbound-api-model/api/fba_inbound_api.rb, line 868
def get_transport_details_with_http_info(shipment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FbaInboundApi.get_transport_details ...'
  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 FbaInboundApi.get_transport_details"
  end
  # resource path
  local_var_path = '/fba/inbound/v0/shipments/{shipmentId}/transport'.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] || 'GetTransportDetailsResponse' 

  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: FbaInboundApi#get_transport_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
put_transport_details(body, shipment_id, opts = {}) click to toggle source

Sends transportation information to Amazon about an inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation. @param body @param shipment_id A shipment identifier originally returned by the createInboundShipmentPlan operation. @param [Hash] opts the optional parameters @return [PutTransportDetailsResponse]

# File lib/fulfillment-inbound-api-model/api/fba_inbound_api.rb, line 914
def put_transport_details(body, shipment_id, opts = {})
  data, _status_code, _headers = put_transport_details_with_http_info(body, shipment_id, opts)
  data
end
put_transport_details_with_http_info(body, shipment_id, opts = {}) click to toggle source

Sends transportation information to Amazon about an inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | For more information, see "Usage Plans and Rate Limits&quot; in the Selling Partner API documentation. @param body @param shipment_id A shipment identifier originally returned by the createInboundShipmentPlan operation. @param [Hash] opts the optional parameters @return [Array<(PutTransportDetailsResponse, Integer, Hash)>] PutTransportDetailsResponse data, response status code and response headers

# File lib/fulfillment-inbound-api-model/api/fba_inbound_api.rb, line 924
def put_transport_details_with_http_info(body, shipment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FbaInboundApi.put_transport_details ...'
  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 FbaInboundApi.put_transport_details"
  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 FbaInboundApi.put_transport_details"
  end
  # resource path
  local_var_path = '/fba/inbound/v0/shipments/{shipmentId}/transport'.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] || 'PutTransportDetailsResponse' 

  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: FbaInboundApi#put_transport_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
update_inbound_shipment(body, shipment_id, opts = {}) click to toggle source

Adds, updates, or removes items from the inbound shipment identified by the specified shipment identifier. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation. @param body @param shipment_id A shipment identifier originally returned by the createInboundShipmentPlan operation. @param [Hash] opts the optional parameters @return [InboundShipmentResponse]

# File lib/fulfillment-inbound-api-model/api/fba_inbound_api.rb, line 976
def update_inbound_shipment(body, shipment_id, opts = {})
  data, _status_code, _headers = update_inbound_shipment_with_http_info(body, shipment_id, opts)
  data
end
update_inbound_shipment_with_http_info(body, shipment_id, opts = {}) click to toggle source

Adds, updates, or removes items from the inbound shipment identified by the specified shipment identifier. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | For more information, see "Usage Plans and Rate Limits&quot; in the Selling Partner API documentation. @param body @param shipment_id A shipment identifier originally returned by the createInboundShipmentPlan operation. @param [Hash] opts the optional parameters @return [Array<(InboundShipmentResponse, Integer, Hash)>] InboundShipmentResponse data, response status code and response headers

# File lib/fulfillment-inbound-api-model/api/fba_inbound_api.rb, line 986
def update_inbound_shipment_with_http_info(body, shipment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FbaInboundApi.update_inbound_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 FbaInboundApi.update_inbound_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 FbaInboundApi.update_inbound_shipment"
  end
  # resource path
  local_var_path = '/fba/inbound/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'])
  # 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] || 'InboundShipmentResponse' 

  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: FbaInboundApi#update_inbound_shipment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
void_transport(shipment_id, opts = {}) click to toggle source

Cancels a previously-confirmed request to ship an inbound shipment using an Amazon-partnered carrier. To be successful, you must call this operation before the VoidDeadline date that is returned by the getTransportDetails operation. Important: The VoidDeadline date is 24 hours after you confirm a Small Parcel shipment transportation request or one hour after you confirm a Less Than Truckload/Full Truckload (LTL/FTL) shipment transportation request. After the void deadline passes, your account will be charged for the shipping cost. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation. @param shipment_id A shipment identifier originally returned by the createInboundShipmentPlan operation. @param [Hash] opts the optional parameters @return [VoidTransportResponse]

# File lib/fulfillment-inbound-api-model/api/fba_inbound_api.rb, line 1037
def void_transport(shipment_id, opts = {})
  data, _status_code, _headers = void_transport_with_http_info(shipment_id, opts)
  data
end
void_transport_with_http_info(shipment_id, opts = {}) click to toggle source

Cancels a previously-confirmed request to ship an inbound shipment using an Amazon-partnered carrier. To be successful, you must call this operation before the VoidDeadline date that is returned by the getTransportDetails operation. Important: The VoidDeadline date is 24 hours after you confirm a Small Parcel shipment transportation request or one hour after you confirm a Less Than Truckload/Full Truckload (LTL/FTL) shipment transportation request. After the void deadline passes, your account will be charged for the shipping cost. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | For more information, see "Usage Plans and Rate Limits&quot; in the Selling Partner API documentation. @param shipment_id A shipment identifier originally returned by the createInboundShipmentPlan operation. @param [Hash] opts the optional parameters @return [Array<(VoidTransportResponse, Integer, Hash)>] VoidTransportResponse data, response status code and response headers

# File lib/fulfillment-inbound-api-model/api/fba_inbound_api.rb, line 1046
def void_transport_with_http_info(shipment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FbaInboundApi.void_transport ...'
  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 FbaInboundApi.void_transport"
  end
  # resource path
  local_var_path = '/fba/inbound/v0/shipments/{shipmentId}/transport/void'.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] || 'VoidTransportResponse' 

  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: FbaInboundApi#void_transport\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end