Class: Peddler::APIs::FulfillmentOutbound20200701
- Inherits:
-
Peddler::API
- Object
- Peddler::API
- Peddler::APIs::FulfillmentOutbound20200701
- Defined in:
- lib/peddler/apis/fulfillment_outbound_2020_07_01.rb
Overview
Selling Partner APIs for Fulfillment Outbound
The Selling Partner API for Fulfillment Outbound lets you create applications that help a seller fulfill Multi-Channel Fulfillment orders using their inventory in Amazon's fulfillment network. You can get information on both potential and existing fulfillment orders.
Instance Attribute Summary
Attributes inherited from Peddler::API
#access_token, #endpoint, #parser, #retries
Instance Method Summary collapse
-
#cancel_fulfillment_order(seller_fulfillment_order_id, rate_limit: 2.0) ⇒ Peddler::Response
Requests that Amazon stop attempting to fulfill the fulfillment order indicated by the specified order identifier.
-
#create_fulfillment_order(body, rate_limit: 2.0) ⇒ Peddler::Response
Requests that Amazon ship items from the seller's inventory in Amazon's fulfillment network to a destination address.
-
#create_fulfillment_return(body, seller_fulfillment_order_id, rate_limit: 2.0) ⇒ Peddler::Response
Creates a fulfillment return.
-
#delivery_offers(body, rate_limit: 5.0) ⇒ Peddler::Response
Returns delivery options that include an estimated delivery date and offer expiration, based on criteria that you specify.
-
#get_feature_inventory(marketplace_id, feature_name, next_token: nil, query_start_date: nil, rate_limit: 2.0) ⇒ Peddler::Response
Returns a list of inventory items that are eligible for the fulfillment feature you specify.
-
#get_feature_sku(marketplace_id, feature_name, seller_sku, rate_limit: 2.0) ⇒ Peddler::Response
Returns the number of items with the
sellerSku
you specify that can have orders fulfilled using the specified feature. -
#get_features(marketplace_id, rate_limit: 2.0) ⇒ Peddler::Response
Returns a list of features available for Multi-Channel Fulfillment orders in the marketplace you specify, and whether the seller for which you made the call is enrolled for each feature.
-
#get_fulfillment_order(seller_fulfillment_order_id, rate_limit: 2.0) ⇒ Peddler::Response
Returns the fulfillment order indicated by the specified order identifier.
-
#get_fulfillment_preview(body, rate_limit: 2.0) ⇒ Peddler::Response
Returns a list of fulfillment order previews based on shipping criteria that you specify.
-
#get_package_tracking_details(package_number: nil, amazon_fulfillment_tracking_number: nil, rate_limit: 2.0) ⇒ Peddler::Response
Returns delivery tracking information for a package in an outbound shipment for a Multi-Channel Fulfillment order.
-
#list_all_fulfillment_orders(query_start_date: nil, next_token: nil, rate_limit: 2.0) ⇒ Peddler::Response
Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the
nextToken
parameter. -
#list_return_reason_codes(seller_sku, marketplace_id: nil, seller_fulfillment_order_id: nil, language: nil, rate_limit: 2.0) ⇒ Peddler::Response
Returns a list of return reason codes for a seller SKU in a given marketplace.
-
#submit_fulfillment_order_status_update(seller_fulfillment_order_id, body) ⇒ Peddler::Response
Requests that Amazon update the status of an order in the sandbox testing environment.
-
#update_fulfillment_order(body, seller_fulfillment_order_id, rate_limit: 2.0) ⇒ Peddler::Response
Updates and/or requests shipment for a fulfillment order with an order hold on it.
Methods inherited from Peddler::API
#endpoint_uri, #http, #initialize, #meter, #retriable, #sandbox, #sandbox?, #use, #via
Constructor Details
This class inherits a constructor from Peddler::API
Instance Method Details
#cancel_fulfillment_order(seller_fulfillment_order_id, rate_limit: 2.0) ⇒ Peddler::Response
This operation can make a dynamic sandbox call.
Requests that Amazon stop attempting to fulfill the fulfillment order indicated by the specified order identifier.
174 175 176 177 178 |
# File 'lib/peddler/apis/fulfillment_outbound_2020_07_01.rb', line 174 def cancel_fulfillment_order(seller_fulfillment_order_id, rate_limit: 2.0) path = "/fba/outbound/2020-07-01/fulfillmentOrders/#{percent_encode(seller_fulfillment_order_id)}/cancel" meter(rate_limit).put(path) end |
#create_fulfillment_order(body, rate_limit: 2.0) ⇒ Peddler::Response
This operation can make a dynamic sandbox call.
Requests that Amazon ship items from the seller's inventory in Amazon's fulfillment network to a destination address.
71 72 73 74 75 |
# File 'lib/peddler/apis/fulfillment_outbound_2020_07_01.rb', line 71 def create_fulfillment_order(body, rate_limit: 2.0) path = "/fba/outbound/2020-07-01/fulfillmentOrders" meter(rate_limit).post(path, body:) end |
#create_fulfillment_return(body, seller_fulfillment_order_id, rate_limit: 2.0) ⇒ Peddler::Response
This operation can make a dynamic sandbox call.
Creates a fulfillment return.
133 134 135 136 137 |
# File 'lib/peddler/apis/fulfillment_outbound_2020_07_01.rb', line 133 def create_fulfillment_return(body, seller_fulfillment_order_id, rate_limit: 2.0) path = "/fba/outbound/2020-07-01/fulfillmentOrders/#{percent_encode(seller_fulfillment_order_id)}/return" meter(rate_limit).put(path, body:) end |
#delivery_offers(body, rate_limit: 5.0) ⇒ Peddler::Response
This operation can make a dynamic sandbox call.
Returns delivery options that include an estimated delivery date and offer expiration, based on criteria that you specify.
38 39 40 41 42 |
# File 'lib/peddler/apis/fulfillment_outbound_2020_07_01.rb', line 38 def delivery_offers(body, rate_limit: 5.0) path = "/fba/outbound/2020-07-01/deliveryOffers" meter(rate_limit).post(path, body:) end |
#get_feature_inventory(marketplace_id, feature_name, next_token: nil, query_start_date: nil, rate_limit: 2.0) ⇒ Peddler::Response
This operation can make a dynamic sandbox call.
Returns a list of inventory items that are eligible for the fulfillment feature you specify.
228 229 230 231 232 233 234 235 236 237 |
# File 'lib/peddler/apis/fulfillment_outbound_2020_07_01.rb', line 228 def get_feature_inventory(marketplace_id, feature_name, next_token: nil, query_start_date: nil, rate_limit: 2.0) path = "/fba/outbound/2020-07-01/features/inventory/#{percent_encode(feature_name)}" params = { "marketplaceId" => marketplace_id, "nextToken" => next_token, "queryStartDate" => query_start_date, }.compact meter(rate_limit).get(path, params:) end |
#get_feature_sku(marketplace_id, feature_name, seller_sku, rate_limit: 2.0) ⇒ Peddler::Response
This operation can make a dynamic sandbox call.
Returns the number of items with the sellerSku
you specify that can have orders fulfilled using the specified
feature. Note that if the sellerSku
isn't eligible, the response will contain an empty skuInfo
object. The
parameters for this operation may contain special characters that require URL encoding. To avoid errors with
SKUs when encoding URLs, refer to URL Encoding.
251 252 253 254 255 256 257 258 |
# File 'lib/peddler/apis/fulfillment_outbound_2020_07_01.rb', line 251 def get_feature_sku(marketplace_id, feature_name, seller_sku, rate_limit: 2.0) path = "/fba/outbound/2020-07-01/features/inventory/#{percent_encode(feature_name)}/#{percent_encode(seller_sku)}" params = { "marketplaceId" => marketplace_id, }.compact meter(rate_limit).get(path, params:) end |
#get_features(marketplace_id, rate_limit: 2.0) ⇒ Peddler::Response
This operation can make a dynamic sandbox call.
Returns a list of features available for Multi-Channel Fulfillment orders in the marketplace you specify, and whether the seller for which you made the call is enrolled for each feature.
206 207 208 209 210 211 212 213 |
# File 'lib/peddler/apis/fulfillment_outbound_2020_07_01.rb', line 206 def get_features(marketplace_id, rate_limit: 2.0) path = "/fba/outbound/2020-07-01/features" params = { "marketplaceId" => marketplace_id, }.compact meter(rate_limit).get(path, params:) end |
#get_fulfillment_order(seller_fulfillment_order_id, rate_limit: 2.0) ⇒ Peddler::Response
This operation can make a dynamic sandbox call.
Returns the fulfillment order indicated by the specified order identifier.
146 147 148 149 150 |
# File 'lib/peddler/apis/fulfillment_outbound_2020_07_01.rb', line 146 def get_fulfillment_order(seller_fulfillment_order_id, rate_limit: 2.0) path = "/fba/outbound/2020-07-01/fulfillmentOrders/#{percent_encode(seller_fulfillment_order_id)}" meter(rate_limit).get(path) end |
#get_fulfillment_preview(body, rate_limit: 2.0) ⇒ Peddler::Response
This operation can make a dynamic sandbox call.
Returns a list of fulfillment order previews based on shipping criteria that you specify.
25 26 27 28 29 |
# File 'lib/peddler/apis/fulfillment_outbound_2020_07_01.rb', line 25 def get_fulfillment_preview(body, rate_limit: 2.0) path = "/fba/outbound/2020-07-01/fulfillmentOrders/preview" meter(rate_limit).post(path, body:) end |
#get_package_tracking_details(package_number: nil, amazon_fulfillment_tracking_number: nil, rate_limit: 2.0) ⇒ Peddler::Response
This operation can make a dynamic sandbox call.
Returns delivery tracking information for a package in an outbound shipment for a Multi-Channel Fulfillment order.
87 88 89 90 91 92 93 94 95 |
# File 'lib/peddler/apis/fulfillment_outbound_2020_07_01.rb', line 87 def get_package_tracking_details(package_number: nil, amazon_fulfillment_tracking_number: nil, rate_limit: 2.0) path = "/fba/outbound/2020-07-01/tracking" params = { "packageNumber" => package_number, "amazonFulfillmentTrackingNumber" => amazon_fulfillment_tracking_number, }.compact meter(rate_limit).get(path, params:) end |
#list_all_fulfillment_orders(query_start_date: nil, next_token: nil, rate_limit: 2.0) ⇒ Peddler::Response
This operation can make a dynamic sandbox call.
Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the
nextToken
parameter.
54 55 56 57 58 59 60 61 62 |
# File 'lib/peddler/apis/fulfillment_outbound_2020_07_01.rb', line 54 def list_all_fulfillment_orders(query_start_date: nil, next_token: nil, rate_limit: 2.0) path = "/fba/outbound/2020-07-01/fulfillmentOrders" params = { "queryStartDate" => query_start_date, "nextToken" => next_token, }.compact meter(rate_limit).get(path, params:) end |
#list_return_reason_codes(seller_sku, marketplace_id: nil, seller_fulfillment_order_id: nil, language: nil, rate_limit: 2.0) ⇒ Peddler::Response
This operation can make a dynamic sandbox call.
Returns a list of return reason codes for a seller SKU in a given marketplace. The parameters for this operation may contain special characters that require URL encoding. To avoid errors with SKUs when encoding URLs, refer to URL Encoding.
111 112 113 114 115 116 117 118 119 120 121 122 |
# File 'lib/peddler/apis/fulfillment_outbound_2020_07_01.rb', line 111 def list_return_reason_codes(seller_sku, marketplace_id: nil, seller_fulfillment_order_id: nil, language: nil, rate_limit: 2.0) path = "/fba/outbound/2020-07-01/returnReasonCodes" params = { "sellerSku" => seller_sku, "marketplaceId" => marketplace_id, "sellerFulfillmentOrderId" => seller_fulfillment_order_id, "language" => language, }.compact meter(rate_limit).get(path, params:) end |
#submit_fulfillment_order_status_update(seller_fulfillment_order_id, body) ⇒ Peddler::Response
This operation can make a dynamic sandbox call.
Requests that Amazon update the status of an order in the sandbox testing environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to Fulfillment Outbound Dynamic Sandbox Guide and Selling Partner API sandbox for more information.
191 192 193 194 195 196 197 |
# File 'lib/peddler/apis/fulfillment_outbound_2020_07_01.rb', line 191 def submit_fulfillment_order_status_update(seller_fulfillment_order_id, body) must_sandbox! path = "/fba/outbound/2020-07-01/fulfillmentOrders/#{percent_encode(seller_fulfillment_order_id)}/status" put(path, body:) end |
#update_fulfillment_order(body, seller_fulfillment_order_id, rate_limit: 2.0) ⇒ Peddler::Response
This operation can make a dynamic sandbox call.
Updates and/or requests shipment for a fulfillment order with an order hold on it.
160 161 162 163 164 |
# File 'lib/peddler/apis/fulfillment_outbound_2020_07_01.rb', line 160 def update_fulfillment_order(body, seller_fulfillment_order_id, rate_limit: 2.0) path = "/fba/outbound/2020-07-01/fulfillmentOrders/#{percent_encode(seller_fulfillment_order_id)}" meter(rate_limit).put(path, body:) end |