Class: Peddler::APIs::FulfillmentOutbound20200701

Inherits:
Peddler::API
  • Object
show all
Defined in:
lib/peddler/apis/fulfillment_outbound_2020_07_01.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/fee.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/error.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/amount.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/origin.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/weight.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/address.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/feature.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/features.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/fee_list.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/date_range.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/error_list.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/destination.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/feature_sku.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/return_item.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/string_list.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/cod_settings.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/delivery_offer.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/locker_details.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/tracking_event.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/delivery_policy.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/delivery_window.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/delivery_message.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/feature_settings.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/return_item_list.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/tracking_address.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/delivery_document.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/drop_off_location.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/fulfillment_order.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/create_return_item.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/product_identifier.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/fulfillment_preview.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/get_features_result.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/invalid_item_reason.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/invalid_return_item.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/payment_information.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/reason_code_details.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/tracking_event_list.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/delivery_information.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/delivery_offers_list.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/delivery_preferences.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/delivery_window_list.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/fulfillment_shipment.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/return_authorization.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/get_features_response.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/delivery_document_list.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/fulfillment_order_item.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/get_feature_sku_result.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/create_return_item_list.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/notification_email_list.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/scheduled_delivery_info.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/fulfillment_preview_item.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/fulfillment_preview_list.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/get_feature_sku_response.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/invalid_return_item_list.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/package_tracking_details.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/payment_information_list.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/reason_code_details_list.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/fulfillment_shipment_item.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/fulfillment_shipment_list.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/get_delivery_offers_terms.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/return_authorization_list.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/get_delivery_offers_result.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/unfulfillable_preview_item.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/variable_precision_address.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/fulfillment_order_item_list.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/get_delivery_offers_product.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/get_delivery_offers_request.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/fulfillment_preview_shipment.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/fulfillment_shipment_package.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/get_delivery_offers_response.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/get_feature_inventory_result.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/get_fulfillment_order_result.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/get_fulfillment_preview_item.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/shipping_speed_category_list.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/create_fulfillment_order_item.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/fulfillment_preview_item_list.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/update_fulfillment_order_item.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/fulfillment_shipment_item_list.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/get_feature_inventory_response.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/get_fulfillment_order_response.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/get_fulfillment_preview_result.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/get_fulfillment_preview_request.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/list_return_reason_codes_result.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/unfulfillable_preview_item_list.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/create_fulfillment_order_request.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/create_fulfillment_return_result.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/get_fulfillment_preview_response.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/update_fulfillment_order_request.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/cancel_fulfillment_order_response.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/create_fulfillment_order_response.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/create_fulfillment_return_request.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/fulfillment_preview_shipment_list.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/fulfillment_shipment_package_list.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/get_fulfillment_preview_item_list.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/list_return_reason_codes_response.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/update_fulfillment_order_response.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/create_fulfillment_order_item_list.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/create_fulfillment_return_response.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/list_all_fulfillment_orders_result.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/update_fulfillment_order_item_list.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/list_all_fulfillment_orders_response.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/get_package_tracking_details_response.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/submit_fulfillment_order_status_update_request.rb,
lib/peddler/apis/fulfillment_outbound_2020_07_01/submit_fulfillment_order_status_update_response.rb,
sig/peddler/apis/fulfillment_outbound_2020_07_01.rbs

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.

See Also:

Defined Under Namespace

Classes: Address, Amount, CODSettings, CancelFulfillmentOrderResponse, CreateFulfillmentOrderItem, CreateFulfillmentOrderItemList, CreateFulfillmentOrderRequest, CreateFulfillmentOrderResponse, CreateFulfillmentReturnRequest, CreateFulfillmentReturnResponse, CreateFulfillmentReturnResult, CreateReturnItem, CreateReturnItemList, DateRange, DeliveryDocument, DeliveryDocumentList, DeliveryInformation, DeliveryMessage, DeliveryOffer, DeliveryOffersList, DeliveryPolicy, DeliveryPreferences, DeliveryWindow, DeliveryWindowList, Destination, DropOffLocation, Error, ErrorList, Feature, FeatureSKU, FeatureSettings, Features, Fee, FeeList, FulfillmentOrder, FulfillmentOrderItem, FulfillmentOrderItemList, FulfillmentPreview, FulfillmentPreviewItem, FulfillmentPreviewItemList, FulfillmentPreviewList, FulfillmentPreviewShipment, FulfillmentPreviewShipmentList, FulfillmentShipment, FulfillmentShipmentItem, FulfillmentShipmentItemList, FulfillmentShipmentList, FulfillmentShipmentPackage, FulfillmentShipmentPackageList, GetDeliveryOffersProduct, GetDeliveryOffersRequest, GetDeliveryOffersResponse, GetDeliveryOffersResult, GetDeliveryOffersTerms, GetFeatureInventoryResponse, GetFeatureInventoryResult, GetFeatureSKUResponse, GetFeatureSKUResult, GetFeaturesResponse, GetFeaturesResult, GetFulfillmentOrderResponse, GetFulfillmentOrderResult, GetFulfillmentPreviewItem, GetFulfillmentPreviewItemList, GetFulfillmentPreviewRequest, GetFulfillmentPreviewResponse, GetFulfillmentPreviewResult, GetPackageTrackingDetailsResponse, InvalidItemReason, InvalidReturnItem, InvalidReturnItemList, ListAllFulfillmentOrdersResponse, ListAllFulfillmentOrdersResult, ListReturnReasonCodesResponse, ListReturnReasonCodesResult, LockerDetails, NotificationEmailList, Origin, PackageTrackingDetails, PaymentInformation, PaymentInformationList, ProductIdentifier, ReasonCodeDetails, ReasonCodeDetailsList, ReturnAuthorization, ReturnAuthorizationList, ReturnItem, ReturnItemList, ScheduledDeliveryInfo, ShippingSpeedCategoryList, StringList, SubmitFulfillmentOrderStatusUpdateRequest, SubmitFulfillmentOrderStatusUpdateResponse, TrackingAddress, TrackingEvent, TrackingEventList, UnfulfillablePreviewItem, UnfulfillablePreviewItemList, UpdateFulfillmentOrderItem, UpdateFulfillmentOrderItemList, UpdateFulfillmentOrderRequest, UpdateFulfillmentOrderResponse, VariablePrecisionAddress, Weight

Instance Attribute Summary

Attributes inherited from Peddler::API

#access_token, #endpoint, #retries

Instance Method Summary collapse

Methods inherited from Peddler::API

#cannot_sandbox!, #delete, #endpoint_uri, #get, #http, #initialize, #must_sandbox!, #patch, #percent_encode, #post, #put, #request, #sandbox, #sandbox?, #stringify_array, #timestamp, #user_agent

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

Note:

This operation can make a dynamic sandbox call.

Requests that Amazon stop attempting to fulfill the fulfillment order indicated by the specified order identifier.

Parameters:

  • seller_fulfillment_order_id (String) —

    The identifier assigned to the item by the seller when the fulfillment order was created.

  • rate_limit (Float) (defaults to: 2.0) —

    Requests per second

  • (String)
  • rate_limit: (Float) (defaults to: 2.0)

Returns:



167
168
169
170
171
 
# File 'lib/peddler/apis/fulfillment_outbound_2020_07_01.rb', line 167

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"
  parser = -> { CancelFulfillmentOrderResponse }
  put(path, rate_limit:, parser:)
end

#create_fulfillment_order(body, rate_limit: 2.0) ⇒ Peddler::Response

Note:

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.

Parameters:

  • body (Hash) —

    CreateFulfillmentOrderRequest parameter

  • rate_limit (Float) (defaults to: 2.0) —

    Requests per second

  • (Hash[untyped, untyped])
  • rate_limit: (Float) (defaults to: 2.0)

Returns:



67
68
69
70
71
 
# File 'lib/peddler/apis/fulfillment_outbound_2020_07_01.rb', line 67

def create_fulfillment_order(body, rate_limit: 2.0)
  path = "/fba/outbound/2020-07-01/fulfillmentOrders"
  parser = -> { CreateFulfillmentOrderResponse }
  post(path, body:, rate_limit:, parser:)
end

#create_fulfillment_return(body, seller_fulfillment_order_id, rate_limit: 2.0) ⇒ Peddler::Response

Note:

This operation can make a dynamic sandbox call.

Creates a fulfillment return.

Parameters:

  • body (Hash) —

    The request body of the createFulfillmentReturn operation.

  • seller_fulfillment_order_id (String) —

    An identifier the seller assigns to the fulfillment order at the time it was created. The seller uses their own records to find the correct sellerFulfillmentOrderId value based on the buyer's request to return items.

  • rate_limit (Float) (defaults to: 2.0) —

    Requests per second

  • (Hash[untyped, untyped])
  • (String)
  • rate_limit: (Float) (defaults to: 2.0)

Returns:



126
127
128
129
130
 
# File 'lib/peddler/apis/fulfillment_outbound_2020_07_01.rb', line 126

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"
  parser = -> { CreateFulfillmentReturnResponse }
  put(path, body:, rate_limit:, parser:)
end

#delivery_offers(body, rate_limit: 5.0) ⇒ Peddler::Response

Note:

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.

Parameters:

  • body (Hash) —

    GetDeliveryOffersRequest parameter

  • rate_limit (Float) (defaults to: 5.0) —

    Requests per second

  • (Hash[untyped, untyped])
  • rate_limit: (Float) (defaults to: 5.0)

Returns:



34
35
36
37
38
 
# File 'lib/peddler/apis/fulfillment_outbound_2020_07_01.rb', line 34

def delivery_offers(body, rate_limit: 5.0)
  path = "/fba/outbound/2020-07-01/deliveryOffers"
  parser = -> { GetDeliveryOffersResponse }
  post(path, body:, rate_limit:, parser:)
end

#get_feature_inventory(marketplace_id, feature_name, next_token: nil, query_start_date: nil, rate_limit: 2.0) ⇒ Peddler::Response

Note:

This operation can make a dynamic sandbox call.

Returns a list of inventory items that are eligible for the fulfillment feature you specify.

Parameters:

  • marketplace_id (String) —

    The marketplace for which to return a list of the inventory that is eligible for the specified feature.

  • feature_name (String) —

    The name of the feature for which to return a list of eligible inventory.

  • next_token (String) (defaults to: nil) —

    A string token returned in the response to your previous request that is used to return the next response page. A value of null will return the first page.

  • query_start_date (String) (defaults to: nil) —

    A date that you can use to select inventory that has been updated since a specified date. An update is defined as any change in feature-enabled inventory availability. The date must be in the format yyyy-MM-ddTHH:mm:ss.sssZ

  • rate_limit (Float) (defaults to: 2.0) —

    Requests per second

  • (String)
  • (String)
  • next_token: (String, nil) (defaults to: nil)
  • query_start_date: (String, nil) (defaults to: nil)
  • rate_limit: (Float) (defaults to: 2.0)

Returns:



221
222
223
224
225
226
227
228
229
230
 
# File 'lib/peddler/apis/fulfillment_outbound_2020_07_01.rb', line 221

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
  parser = -> { GetFeatureInventoryResponse }
  get(path, params:, rate_limit:, parser:)
end

#get_feature_sku(marketplace_id, feature_name, seller_sku, rate_limit: 2.0) ⇒ Peddler::Response

Note:

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.

Parameters:

  • marketplace_id (String) —

    The marketplace for which to return the count.

  • feature_name (String) —

    The name of the feature.

  • seller_sku (String) —

    Used to identify an item in the given marketplace. sellerSku is qualified by the seller's sellerId, which is included with every operation that you submit.

  • rate_limit (Float) (defaults to: 2.0) —

    Requests per second

  • (String)
  • (String)
  • (String)
  • rate_limit: (Float) (defaults to: 2.0)

Returns:



244
245
246
247
248
249
250
251
 
# File 'lib/peddler/apis/fulfillment_outbound_2020_07_01.rb', line 244

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
  parser = -> { GetFeatureSKUResponse }
  get(path, params:, rate_limit:, parser:)
end

#get_features(marketplace_id, rate_limit: 2.0) ⇒ Peddler::Response

Note:

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.

Parameters:

  • marketplace_id (String) —

    The marketplace for which to return the list of features.

  • rate_limit (Float) (defaults to: 2.0) —

    Requests per second

  • (String)
  • rate_limit: (Float) (defaults to: 2.0)

Returns:



199
200
201
202
203
204
205
206
 
# File 'lib/peddler/apis/fulfillment_outbound_2020_07_01.rb', line 199

def get_features(marketplace_id, rate_limit: 2.0)
  path = "/fba/outbound/2020-07-01/features"
  params = {
    "marketplaceId" => marketplace_id,
  }.compact
  parser = -> { GetFeaturesResponse }
  get(path, params:, rate_limit:, parser:)
end

#get_fulfillment_order(seller_fulfillment_order_id, rate_limit: 2.0) ⇒ Peddler::Response

Note:

This operation can make a dynamic sandbox call.

Returns the fulfillment order indicated by the specified order identifier.

Parameters:

  • seller_fulfillment_order_id (String) —

    The identifier assigned to the item by the seller when the fulfillment order was created.

  • rate_limit (Float) (defaults to: 2.0) —

    Requests per second

  • (String)
  • rate_limit: (Float) (defaults to: 2.0)

Returns:



139
140
141
142
143
 
# File 'lib/peddler/apis/fulfillment_outbound_2020_07_01.rb', line 139

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)}"
  parser = -> { GetFulfillmentOrderResponse }
  get(path, rate_limit:, parser:)
end

#get_fulfillment_preview(body, rate_limit: 2.0) ⇒ Peddler::Response

Note:

This operation can make a dynamic sandbox call.

Returns a list of fulfillment order previews based on shipping criteria that you specify.

Parameters:

  • body (Hash) —

    GetFulfillmentPreviewRequest parameter

  • rate_limit (Float) (defaults to: 2.0) —

    Requests per second

  • (Hash[untyped, untyped])
  • rate_limit: (Float) (defaults to: 2.0)

Returns:



21
22
23
24
25
 
# File 'lib/peddler/apis/fulfillment_outbound_2020_07_01.rb', line 21

def get_fulfillment_preview(body, rate_limit: 2.0)
  path = "/fba/outbound/2020-07-01/fulfillmentOrders/preview"
  parser = -> { GetFulfillmentPreviewResponse }
  post(path, body:, rate_limit:, parser:)
end

#get_package_tracking_details(package_number, rate_limit: 2.0) ⇒ Peddler::Response

Note:

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.

Parameters:

  • package_number (Integer) —

    The unencrypted package identifier. You can obtain this value from the getFulfillmentOrder operation.

  • rate_limit (Float) (defaults to: 2.0) —

    Requests per second

  • (Integer)
  • rate_limit: (Float) (defaults to: 2.0)

Returns:



81
82
83
84
85
86
87
88
 
# File 'lib/peddler/apis/fulfillment_outbound_2020_07_01.rb', line 81

def get_package_tracking_details(package_number, rate_limit: 2.0)
  path = "/fba/outbound/2020-07-01/tracking"
  params = {
    "packageNumber" => package_number,
  }.compact
  parser = -> { GetPackageTrackingDetailsResponse }
  get(path, params:, rate_limit:, parser:)
end

#list_all_fulfillment_orders(query_start_date: nil, next_token: nil, rate_limit: 2.0) ⇒ Peddler::Response

Note:

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.

Parameters:

  • query_start_date (String) (defaults to: nil) —

    A date used to select fulfillment orders that were last updated after (or at) a specified time. An update is defined as any change in fulfillment order status, including the creation of a new fulfillment order.

  • next_token (String) (defaults to: nil) —

    A string token returned in the response to your previous request.

  • rate_limit (Float) (defaults to: 2.0) —

    Requests per second

  • query_start_date: (String, nil) (defaults to: nil)
  • next_token: (String, nil) (defaults to: nil)
  • rate_limit: (Float) (defaults to: 2.0)

Returns:



50
51
52
53
54
55
56
57
58
 
# File 'lib/peddler/apis/fulfillment_outbound_2020_07_01.rb', line 50

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
  parser = -> { ListAllFulfillmentOrdersResponse }
  get(path, params:, rate_limit:, parser:)
end

#list_return_reason_codes(seller_sku, marketplace_id: nil, seller_fulfillment_order_id: nil, language: nil, rate_limit: 2.0) ⇒ Peddler::Response

Note:

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.

Parameters:

  • seller_sku (String) —

    The seller SKU for which return reason codes are required.

  • marketplace_id (String) (defaults to: nil) —

    The marketplace for which the seller wants return reason codes.

  • seller_fulfillment_order_id (String) (defaults to: nil) —

    The identifier assigned to the item by the seller when the fulfillment order was created. The service uses this value to determine the marketplace for which the seller wants return reason codes.

  • language (String) (defaults to: nil) —

    The language that the TranslatedDescription property of the ReasonCodeDetails response object should be translated into.

  • rate_limit (Float) (defaults to: 2.0) —

    Requests per second

  • (String)
  • marketplace_id: (String, nil) (defaults to: nil)
  • seller_fulfillment_order_id: (String, nil) (defaults to: nil)
  • language: (String, nil) (defaults to: nil)
  • rate_limit: (Float) (defaults to: 2.0)

Returns:



104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/peddler/apis/fulfillment_outbound_2020_07_01.rb', line 104

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
  parser = -> { ListReturnReasonCodesResponse }
  get(path, params:, rate_limit:, parser:)
end

#submit_fulfillment_order_status_update(seller_fulfillment_order_id, body) ⇒ Peddler::Response

Note:

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.

Parameters:

  • seller_fulfillment_order_id (String) —

    The identifier assigned to the item by the seller when the fulfillment order was created.

  • body (Hash) —

    The identifier assigned to the item by the seller when the fulfillment order was created.

  • (String)
  • (Hash[untyped, untyped])

Returns:



184
185
186
187
188
189
190
 
# File 'lib/peddler/apis/fulfillment_outbound_2020_07_01.rb', line 184

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"
  parser = -> { SubmitFulfillmentOrderStatusUpdateResponse }
  put(path, body:, parser:)
end

#update_fulfillment_order(body, seller_fulfillment_order_id, rate_limit: 2.0) ⇒ Peddler::Response

Note:

This operation can make a dynamic sandbox call.

Updates and/or requests shipment for a fulfillment order with an order hold on it.

Parameters:

  • body (Hash) —

    The request body of the updateFulfillmentOrder operation.

  • seller_fulfillment_order_id (String) —

    The identifier assigned to the item by the seller when the fulfillment order was created.

  • rate_limit (Float) (defaults to: 2.0) —

    Requests per second

  • (Hash[untyped, untyped])
  • (String)
  • rate_limit: (Float) (defaults to: 2.0)

Returns:



153
154
155
156
157
 
# File 'lib/peddler/apis/fulfillment_outbound_2020_07_01.rb', line 153

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)}"
  parser = -> { UpdateFulfillmentOrderResponse }
  put(path, body:, rate_limit:, parser:)
end