Class: Peddler::API::FulfillmentInboundV0
- Inherits:
-
Peddler::API
- Object
- Peddler::API
- Peddler::API::FulfillmentInboundV0
- Defined in:
- lib/peddler/api/fulfillment_inbound_v0.rb
Overview
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.
Instance Attribute Summary
Attributes inherited from Peddler::API
Instance Method Summary collapse
-
#confirm_preorder(shipment_id, need_by_date, marketplace_id, rate_limit: 2.0) ⇒ Hash
Returns information needed to confirm a shipment for pre-order.
-
#confirm_transport(shipment_id, rate_limit: 2.0) ⇒ Hash
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.
-
#create_inbound_shipment(body, shipment_id, rate_limit: 2.0) ⇒ Hash
Returns a new inbound shipment based on the specified shipmentId that was returned by the createInboundShipmentPlan operation.
-
#create_inbound_shipment_plan(body, rate_limit: 2.0) ⇒ Hash
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.
-
#estimate_transport(shipment_id, rate_limit: 2.0) ⇒ Hash
Initiates the process of estimating the shipping cost for an inbound shipment by an Amazon-partnered carrier.
-
#get_bill_of_lading(shipment_id, rate_limit: 2.0) ⇒ Hash
Returns a bill of lading for a Less Than Truckload/Full Truckload (LTL/FTL) shipment.
-
#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) ⇒ Hash
Returns package/pallet labels for faster and more accurate shipment processing at the Amazon fulfillment center.
-
#get_preorder_info(shipment_id, marketplace_id, rate_limit: 2.0) ⇒ Hash
Returns pre-order information, including dates, that a seller needs before confirming a shipment for pre-order.
-
#get_prep_instructions(ship_to_country_code, seller_sku_list: nil, asin_list: nil, rate_limit: 2.0) ⇒ Hash
Returns labeling requirements and item preparation instructions to help prepare items for shipment to Amazon's fulfillment network.
-
#get_shipment_items(query_type, marketplace_id, last_updated_after: nil, last_updated_before: nil, next_token: nil, rate_limit: 2.0) ⇒ Hash
Returns a list of items in a specified inbound shipment, or a list of items that were updated within a specified time frame.
-
#get_shipment_items_by_shipment_id(shipment_id, marketplace_id, rate_limit: 2.0) ⇒ Hash
Returns a list of items in a specified inbound shipment.
-
#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) ⇒ Hash
Returns a list of inbound shipments based on criteria that you specify.
-
#get_transport_details(shipment_id, rate_limit: 2.0) ⇒ Hash
Returns current transportation information about an inbound shipment.
-
#put_transport_details(shipment_id, body, rate_limit: 2.0) ⇒ Hash
Sends transportation information to Amazon about an inbound shipment.
-
#update_inbound_shipment(body, shipment_id, rate_limit: 2.0) ⇒ Hash
Updates or removes items from the inbound shipment identified by the specified shipment identifier.
-
#void_transport(shipment_id, rate_limit: 2.0) ⇒ Hash
Cancels a previously-confirmed request to ship an inbound shipment using an Amazon-partnered carrier.
Methods inherited from Peddler::API
#cannot_sandbox!, #endpoint_uri, #http, #initialize, #meter, #must_sandbox!, #retriable, #sandbox, #sandbox?, #use, #via
Constructor Details
This class inherits a constructor from Peddler::API
Instance Method Details
#confirm_preorder(shipment_id, need_by_date, marketplace_id, rate_limit: 2.0) ⇒ Hash
This operation can make a static sandbox call.
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.
95 96 97 98 99 100 101 102 103 |
# File 'lib/peddler/api/fulfillment_inbound_v0.rb', line 95 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) ⇒ Hash
This operation can make a static sandbox call.
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.
211 212 213 214 215 |
# File 'lib/peddler/api/fulfillment_inbound_v0.rb', line 211 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) ⇒ Hash
This operation can make a static sandbox call.
Returns a new inbound shipment based on the specified shipmentId that was returned by the createInboundShipmentPlan operation.
45 46 47 48 49 |
# File 'lib/peddler/api/fulfillment_inbound_v0.rb', line 45 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) ⇒ Hash
This operation can make a static sandbox call.
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.
30 31 32 33 34 |
# File 'lib/peddler/api/fulfillment_inbound_v0.rb', line 30 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) ⇒ Hash
This operation can make a static sandbox call.
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.
190 191 192 193 194 |
# File 'lib/peddler/api/fulfillment_inbound_v0.rb', line 190 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) ⇒ Hash
This operation can make a static sandbox call.
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.
262 263 264 265 266 |
# File 'lib/peddler/api/fulfillment_inbound_v0.rb', line 262 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) ⇒ Hash
This operation can make a static sandbox call.
Returns package/pallet labels for faster and more accurate shipment processing at the Amazon fulfillment center.
237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 |
# File 'lib/peddler/api/fulfillment_inbound_v0.rb', line 237 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) ⇒ Hash
This operation can make a static sandbox call.
Returns pre-order information, including dates, that a seller needs before confirming a shipment for pre-order.
74 75 76 77 78 79 80 81 |
# File 'lib/peddler/api/fulfillment_inbound_v0.rb', line 74 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) ⇒ Hash
This operation can make a static sandbox call.
Returns labeling requirements and item preparation instructions to help prepare items for shipment to Amazon's fulfillment network.
125 126 127 128 129 130 131 132 133 134 |
# File 'lib/peddler/api/fulfillment_inbound_v0.rb', line 125 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) ⇒ Hash
This operation can make a static sandbox call.
Returns a list of items in a specified inbound shipment, or a list of items that were updated within a specified time frame.
338 339 340 341 342 343 344 345 346 347 348 349 350 |
# File 'lib/peddler/api/fulfillment_inbound_v0.rb', line 338 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) ⇒ Hash
This operation can make a static sandbox call.
Returns a list of items in a specified inbound shipment.
313 314 315 316 317 318 319 320 |
# File 'lib/peddler/api/fulfillment_inbound_v0.rb', line 313 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) ⇒ Hash
This operation can make a static sandbox call.
Returns a list of inbound shipments based on criteria that you specify.
289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 |
# File 'lib/peddler/api/fulfillment_inbound_v0.rb', line 289 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) ⇒ Hash
This operation can make a static sandbox call.
Returns current transportation information about an inbound shipment.
143 144 145 146 147 |
# File 'lib/peddler/api/fulfillment_inbound_v0.rb', line 143 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) ⇒ Hash
This operation can make a static sandbox call.
Sends transportation information to Amazon about an inbound shipment.
157 158 159 160 161 |
# File 'lib/peddler/api/fulfillment_inbound_v0.rb', line 157 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) ⇒ Hash
This operation can make a static sandbox call.
Updates or removes items from the inbound shipment identified by the specified shipment identifier. Adding new items is not supported.
60 61 62 63 64 |
# File 'lib/peddler/api/fulfillment_inbound_v0.rb', line 60 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) ⇒ Hash
This operation can make a static sandbox call.
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.
175 176 177 178 179 |
# File 'lib/peddler/api/fulfillment_inbound_v0.rb', line 175 def void_transport(shipment_id, rate_limit: 2.0) path = "/fba/inbound/v0/shipments/#{shipment_id}/transport/void" meter(rate_limit).post(path) end |