class Peddler::API::FulfillmentInboundV0

Selling Partner API for Fulfillment Inbound

The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon’s fulfillment network.

Public Instance Methods

confirm_preorder(shipment_id, need_by_date, marketplace_id, rate_limit: 2.0) 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.

@note This operation can make a static sandbox call. @param shipment_id [String] A shipment identifier originally returned by the createInboundShipmentPlan

operation.

@param need_by_date [String] 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 [String] A marketplace identifier. Specifies the marketplace the shipment is tied to. @param rate_limit [Float] Requests per second @return [Hash] The API response

# File lib/peddler/api/fulfillment_inbound_v0.rb, line 94
def confirm_preorder(shipment_id, need_by_date, marketplace_id, rate_limit: 2.0)
  path = "/fba/inbound/v0/shipments/#{shipment_id}/preorder/confirm"
  params = {
    "NeedByDate" => need_by_date,
    "MarketplaceId" => marketplace_id,
  }.compact

  meter(rate_limit).put(path, params:)
end
confirm_transport(shipment_id, rate_limit: 2.0) 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.

@note This operation can make a static sandbox call. @param shipment_id [String] A shipment identifier originally returned by the createInboundShipmentPlan

operation.

@param rate_limit [Float] Requests per second @return [Hash] The API response

# File lib/peddler/api/fulfillment_inbound_v0.rb, line 210
def confirm_transport(shipment_id, rate_limit: 2.0)
  path = "/fba/inbound/v0/shipments/#{shipment_id}/transport/confirm"

  meter(rate_limit).post(path)
end
create_inbound_shipment(body, shipment_id, rate_limit: 2.0) click to toggle source

Returns a new inbound shipment based on the specified shipmentId that was returned by the createInboundShipmentPlan operation.

@note This operation can make a static sandbox call. @param body [Hash] The request schema for the InboundShipmentRequest operation. @param shipment_id [String] A shipment identifier originally returned by the createInboundShipmentPlan

operation.

@param rate_limit [Float] Requests per second @return [Hash] The API response

# File lib/peddler/api/fulfillment_inbound_v0.rb, line 44
def create_inbound_shipment(body, shipment_id, rate_limit: 2.0)
  path = "/fba/inbound/v0/shipments/#{shipment_id}"

  meter(rate_limit).post(path, body:)
end
create_inbound_shipment_plan(body, rate_limit: 2.0) 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.

@note This operation can make a static sandbox call. @param body [Hash] The request schema for the CreateInboundShipmentPlanRequest operation. @param rate_limit [Float] Requests per second @return [Hash] The API response

# File lib/peddler/api/fulfillment_inbound_v0.rb, line 29
def create_inbound_shipment_plan(body, rate_limit: 2.0)
  path = "/fba/inbound/v0/plans"

  meter(rate_limit).post(path, body:)
end
estimate_transport(shipment_id, rate_limit: 2.0) 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.

@note This operation can make a static sandbox call. @param shipment_id [String] A shipment identifier originally returned by the createInboundShipmentPlan

operation.

@param rate_limit [Float] Requests per second @return [Hash] The API response

# File lib/peddler/api/fulfillment_inbound_v0.rb, line 189
def estimate_transport(shipment_id, rate_limit: 2.0)
  path = "/fba/inbound/v0/shipments/#{shipment_id}/transport/estimate"

  meter(rate_limit).post(path)
end
get_bill_of_lading(shipment_id, rate_limit: 2.0) 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.

@note This operation can make a static sandbox call. @param shipment_id [String] A shipment identifier originally returned by the createInboundShipmentPlan

operation.

@param rate_limit [Float] Requests per second @return [Hash] The API response

# File lib/peddler/api/fulfillment_inbound_v0.rb, line 261
def get_bill_of_lading(shipment_id, rate_limit: 2.0)
  path = "/fba/inbound/v0/shipments/#{shipment_id}/billOfLading"

  meter(rate_limit).get(path)
end
get_labels(shipment_id, page_type, label_type, number_of_packages: nil, package_labels_to_print: nil, number_of_pallets: nil, page_size: nil, page_start_index: nil, rate_limit: 2.0) click to toggle source

Returns package/pallet labels for faster and more accurate shipment processing at the Amazon fulfillment center.

@note This operation can make a static sandbox call. @param shipment_id [String] A shipment identifier originally returned by the createInboundShipmentPlan

operation.

@param page_type [String] 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 [String] The type of labels requested. @param number_of_packages [Integer] The number of packages in the shipment. @param package_labels_to_print [Array<String>] 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.

@param number_of_pallets [Integer] The number of pallets in the shipment. This returns four identical labels for

each pallet.

@param page_size [Integer] The page size for paginating through the total packages’ labels. This is a required

parameter for Non-Partnered LTL Shipments. Max value:1000.

@param page_start_index [Integer] The page start index for paginating through the total packages’ labels. This

is a required parameter for Non-Partnered LTL Shipments.

@param rate_limit [Float] Requests per second @return [Hash] The API response

# File lib/peddler/api/fulfillment_inbound_v0.rb, line 236
def get_labels(shipment_id, page_type, label_type, number_of_packages: nil, package_labels_to_print: nil,
  number_of_pallets: nil, page_size: nil, page_start_index: nil, rate_limit: 2.0)
  path = "/fba/inbound/v0/shipments/#{shipment_id}/labels"
  params = {
    "PageType" => page_type,
    "LabelType" => label_type,
    "NumberOfPackages" => number_of_packages,
    "PackageLabelsToPrint" => package_labels_to_print,
    "NumberOfPallets" => number_of_pallets,
    "PageSize" => page_size,
    "PageStartIndex" => page_start_index,
  }.compact

  meter(rate_limit).get(path, params:)
end
get_preorder_info(shipment_id, marketplace_id, rate_limit: 2.0) click to toggle source

Returns pre-order information, including dates, that a seller needs before confirming a shipment for pre-order.

@note This operation can make a static sandbox call. @param shipment_id [String] A shipment identifier originally returned by the createInboundShipmentPlan

operation.

@param marketplace_id [String] A marketplace identifier. Specifies the marketplace the shipment is tied to. @param rate_limit [Float] Requests per second @return [Hash] The API response

# File lib/peddler/api/fulfillment_inbound_v0.rb, line 73
def get_preorder_info(shipment_id, marketplace_id, rate_limit: 2.0)
  path = "/fba/inbound/v0/shipments/#{shipment_id}/preorder"
  params = {
    "MarketplaceId" => marketplace_id,
  }.compact

  meter(rate_limit).get(path, params:)
end
get_prep_instructions(ship_to_country_code, seller_sku_list: nil, asin_list: nil, rate_limit: 2.0) click to toggle source

Returns labeling requirements and item preparation instructions to help prepare items for shipment to Amazon’s fulfillment network.

@note This operation can make a static sandbox call. @param ship_to_country_code [String] 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 seller_sku_list [Array<String>] A list of SellerSKU values. Used to identify items for which you want

labeling requirements and item preparation instructions for shipment to Amazon'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's retail website. If you include a seller SKU
that you have never used to list an item on Amazon's retail website, the seller SKU is returned in the
InvalidSKUList property in the response.

@param asin_list [Array<String>] 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.

@param rate_limit [Float] Requests per second @return [Hash] The API response

# File lib/peddler/api/fulfillment_inbound_v0.rb, line 124
def get_prep_instructions(ship_to_country_code, seller_sku_list: nil, asin_list: nil, rate_limit: 2.0)
  path = "/fba/inbound/v0/prepInstructions"
  params = {
    "ShipToCountryCode" => ship_to_country_code,
    "SellerSKUList" => seller_sku_list,
    "ASINList" => asin_list,
  }.compact

  meter(rate_limit).get(path, params:)
end
get_shipment_items(query_type, marketplace_id, last_updated_after: nil, last_updated_before: nil, next_token: nil, rate_limit: 2.0) 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.

@note This operation can make a static sandbox call. @param last_updated_after [String] 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.

@param last_updated_before [String] 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.

@param query_type [String] 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 next_token [String] A string token returned in the response to your previous request. @param marketplace_id [String] A marketplace identifier. Specifies the marketplace where the product would be

stored.

@param rate_limit [Float] Requests per second @return [Hash] The API response

# File lib/peddler/api/fulfillment_inbound_v0.rb, line 337
def get_shipment_items(query_type, marketplace_id, last_updated_after: nil, last_updated_before: nil,
  next_token: nil, rate_limit: 2.0)
  path = "/fba/inbound/v0/shipmentItems"
  params = {
    "LastUpdatedAfter" => last_updated_after,
    "LastUpdatedBefore" => last_updated_before,
    "QueryType" => query_type,
    "NextToken" => next_token,
    "MarketplaceId" => marketplace_id,
  }.compact

  meter(rate_limit).get(path, params:)
end
get_shipment_items_by_shipment_id(shipment_id, marketplace_id, rate_limit: 2.0) click to toggle source

Returns a list of items in a specified inbound shipment.

@note This operation can make a static sandbox call. @param shipment_id [String] A shipment identifier used for selecting items in a specific inbound shipment. @param marketplace_id [String] A marketplace identifier. Specifies the marketplace where the product would be

stored.

@param rate_limit [Float] Requests per second @return [Hash] The API response

# File lib/peddler/api/fulfillment_inbound_v0.rb, line 312
def get_shipment_items_by_shipment_id(shipment_id, marketplace_id, rate_limit: 2.0)
  path = "/fba/inbound/v0/shipments/#{shipment_id}/items"
  params = {
    "MarketplaceId" => marketplace_id,
  }.compact

  meter(rate_limit).get(path, params:)
end
get_shipments(query_type, marketplace_id, shipment_status_list: nil, shipment_id_list: nil, last_updated_after: nil, last_updated_before: nil, next_token: nil, rate_limit: 2.0) click to toggle source

Returns a list of inbound shipments based on criteria that you specify.

@note This operation can make a static sandbox call. @param shipment_status_list [Array<String>] A list of ShipmentStatus values. Used to select shipments with a

current status that matches the status values that you specify.

@param shipment_id_list [Array<String>] 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.

@param last_updated_after [String] 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.

@param last_updated_before [String] 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.

@param query_type [String] 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 next_token [String] A string token returned in the response to your previous request. @param marketplace_id [String] A marketplace identifier. Specifies the marketplace where the product would be

stored.

@param rate_limit [Float] Requests per second @return [Hash] The API response

# File lib/peddler/api/fulfillment_inbound_v0.rb, line 288
def get_shipments(query_type, marketplace_id, shipment_status_list: nil, shipment_id_list: nil,
  last_updated_after: nil, last_updated_before: nil, next_token: nil, rate_limit: 2.0)
  path = "/fba/inbound/v0/shipments"
  params = {
    "ShipmentStatusList" => shipment_status_list,
    "ShipmentIdList" => shipment_id_list,
    "LastUpdatedAfter" => last_updated_after,
    "LastUpdatedBefore" => last_updated_before,
    "QueryType" => query_type,
    "NextToken" => next_token,
    "MarketplaceId" => marketplace_id,
  }.compact

  meter(rate_limit).get(path, params:)
end
get_transport_details(shipment_id, rate_limit: 2.0) click to toggle source

Returns current transportation information about an inbound shipment.

@note This operation can make a static sandbox call. @param shipment_id [String] A shipment identifier originally returned by the createInboundShipmentPlan

operation.

@param rate_limit [Float] Requests per second @return [Hash] The API response

# File lib/peddler/api/fulfillment_inbound_v0.rb, line 142
def get_transport_details(shipment_id, rate_limit: 2.0)
  path = "/fba/inbound/v0/shipments/#{shipment_id}/transport"

  meter(rate_limit).get(path)
end
put_transport_details(shipment_id, body, rate_limit: 2.0) click to toggle source

Sends transportation information to Amazon about an inbound shipment.

@note This operation can make a static sandbox call. @param shipment_id [String] A shipment identifier originally returned by the createInboundShipmentPlan

operation.

@param body [Hash] The request schema for the PutTransportDetailsRequest operation. @param rate_limit [Float] Requests per second @return [Hash] The API response

# File lib/peddler/api/fulfillment_inbound_v0.rb, line 156
def put_transport_details(shipment_id, body, rate_limit: 2.0)
  path = "/fba/inbound/v0/shipments/#{shipment_id}/transport"

  meter(rate_limit).put(path, body:)
end
update_inbound_shipment(body, shipment_id, rate_limit: 2.0) click to toggle source

Updates or removes items from the inbound shipment identified by the specified shipment identifier. Adding new items is not supported.

@note This operation can make a static sandbox call. @param body [Hash] The request schema for the InboundShipmentRequest operation. @param shipment_id [String] A shipment identifier originally returned by the createInboundShipmentPlan

operation.

@param rate_limit [Float] Requests per second @return [Hash] The API response

# File lib/peddler/api/fulfillment_inbound_v0.rb, line 59
def update_inbound_shipment(body, shipment_id, rate_limit: 2.0)
  path = "/fba/inbound/v0/shipments/#{shipment_id}"

  meter(rate_limit).put(path, body:)
end
void_transport(shipment_id, rate_limit: 2.0) 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.

@note This operation can make a static sandbox call. @param shipment_id [String] A shipment identifier originally returned by the createInboundShipmentPlan

operation.

@param rate_limit [Float] Requests per second @return [Hash] The API response

# File lib/peddler/api/fulfillment_inbound_v0.rb, line 174
def void_transport(shipment_id, rate_limit: 2.0)
  path = "/fba/inbound/v0/shipments/#{shipment_id}/transport/void"

  meter(rate_limit).post(path)
end