Class: Peddler::APIs::FulfillmentOutbound20260704

Inherits:
Peddler::API
  • Object
show all
Defined in:
lib/peddler/apis/fulfillment_outbound_2026_07_04.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/error.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/amount.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/weight.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/address.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/package.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/payment.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/shipment.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/tracking.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/constraint.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/error_list.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/offer_item.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/pagination.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/offer_option.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/offer_result.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/order_origin.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/rollup_price.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/order_product.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/service_level.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/shipment_item.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/time_interval.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/order_services.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/amazon_facility.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/amazon_tracking.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/estimated_price.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/order_line_item.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/preview_product.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/carrier_tracking.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/delivery_service.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/preview_services.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/constraint_detail.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/fulfillment_order.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/offer_destination.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/order_destination.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/packaging_service.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/preview_line_item.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/proof_of_delivery.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/get_offers_request.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/get_order_response.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/order_packing_slip.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/product_identifier.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/get_offers_response.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/offer_service_level.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/payment_information.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/preview_destination.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/create_order_request.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/list_orders_response.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/update_order_request.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/cancel_order_response.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/create_order_response.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/preview_service_level.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/update_order_response.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/create_order_line_item.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/preview_delivery_offer.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/preview_offer_services.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/shipment_service_level.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/update_package_request.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/order_drop_off_location.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/order_line_item_services.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/preview_delivery_service.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/preview_planned_shipment.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/get_order_preview_request.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/preview_packaging_service.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/get_order_preview_response.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/variable_precision_address.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/preview_offer_service_level.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/update_order_status_request.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/preview_planned_shipment_item.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/create_order_accepted_response.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/offer_fulfillment_configuration.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/order_fulfillment_configuration.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/order_line_item_delivery_service.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/order_line_item_packaging_service.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/preview_fulfillment_configuration.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/line_item_fulfillment_configuration.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/order_line_item_payment_on_delivery.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/offer_option_fulfillment_configuration.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/update_order_fulfillment_configuration.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/preview_offer_fulfillment_configuration.rb,
lib/peddler/apis/fulfillment_outbound_2026_07_04/order_response_fulfillment_configuration.rb,
sig/peddler/apis/fulfillment_outbound_2026_07_04.rbs

Overview

The Selling Partner API 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, AmazonFacility, AmazonTracking, Amount, CancelOrderResponse, CarrierTracking, Constraint, ConstraintDetail, CreateOrderAcceptedResponse, CreateOrderLineItem, CreateOrderRequest, CreateOrderResponse, DeliveryService, Error, ErrorList, EstimatedPrice, FulfillmentOrder, GetOffersRequest, GetOffersResponse, GetOrderPreviewRequest, GetOrderPreviewResponse, GetOrderResponse, LineItemFulfillmentConfiguration, ListOrdersResponse, OfferDestination, OfferFulfillmentConfiguration, OfferItem, OfferOption, OfferOptionFulfillmentConfiguration, OfferResult, OfferServiceLevel, OrderDestination, OrderDropOffLocation, OrderFulfillmentConfiguration, OrderLineItem, OrderLineItemDeliveryService, OrderLineItemPackagingService, OrderLineItemPaymentOnDelivery, OrderLineItemServices, OrderOrigin, OrderPackingSlip, OrderProduct, OrderResponseFulfillmentConfiguration, OrderServices, Package, PackagingService, Pagination, Payment, PaymentInformation, PreviewDeliveryOffer, PreviewDeliveryService, PreviewDestination, PreviewFulfillmentConfiguration, PreviewLineItem, PreviewOfferFulfillmentConfiguration, PreviewOfferServiceLevel, PreviewOfferServices, PreviewPackagingService, PreviewPlannedShipment, PreviewPlannedShipmentItem, PreviewProduct, PreviewServiceLevel, PreviewServices, ProductIdentifier, ProofOfDelivery, RollupPrice, ServiceLevel, Shipment, ShipmentItem, ShipmentServiceLevel, TimeInterval, Tracking, UpdateOrderFulfillmentConfiguration, UpdateOrderRequest, UpdateOrderResponse, UpdateOrderStatusRequest, UpdatePackageRequest, VariablePrecisionAddress, Weight

Constant Summary

Constants inherited from Peddler::API

Peddler::API::TRANSIENT_STATUSES

Instance Attribute Summary

Attributes inherited from Peddler::API

#access_token, #base_url, #endpoint, #retries

Instance Method Summary collapse

Methods inherited from Peddler::API

#cannot_sandbox!, #delete, #endpoint_uri, #get, #host_header, #http, #initialize, #must_sandbox!, #parse_base_url, #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_order(order_id, x_amzn_fulfillment_service_id: nil, rate_limit: 2.0) ⇒ Peddler::Response

Note:

This operation can make a dynamic sandbox call.

Request that Amazon stop attempting to fulfill a fulfillment order.

Parameters:

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

    The identifier of the fulfillment service used for this operation.

  • order_id (String) —

    The ID of the order that you want to cancel.

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

    Requests per second

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

Returns:



49
50
51
52
53
 
# File 'lib/peddler/apis/fulfillment_outbound_2026_07_04.rb', line 49

def cancel_order(order_id, x_amzn_fulfillment_service_id: nil, rate_limit: 2.0)
  path = "/fulfillment/outbound/2026-07-04/orders/#{percent_encode(order_id)}/cancel"
  parser = -> { CancelOrderResponse }
  put(path, rate_limit:, parser:)
end

#create_order(body, x_amzn_fulfillment_service_id: nil, rate_limit: 2.0) ⇒ Peddler::Response

Note:

This operation can make a dynamic sandbox call.

Request that Amazon ship items from the seller's inventory in Amazon's fulfillment network to a destination address.

Parameters:

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

    The identifier of the fulfillment service used for this operation.

  • body (Hash) —

    The request body schema for the createOrder operation.

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

    Requests per second

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

Returns:



156
157
158
159
160
 
# File 'lib/peddler/apis/fulfillment_outbound_2026_07_04.rb', line 156

def create_order(body, x_amzn_fulfillment_service_id: nil, rate_limit: 2.0)
  path = "/fulfillment/outbound/2026-07-04/orders"
  parser = -> { CreateOrderResponse }
  post(path, body:, rate_limit:, parser:)
end

#get_offers(body, x_amzn_fulfillment_service_id: nil, rate_limit: 5.0) ⇒ Peddler::Response

Note:

This operation can make a dynamic sandbox call.

Retrieve delivery options that include an estimated delivery date and offer expiration, based on criteria that you specify.

Parameters:

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

    The identifier of the fulfillment service used for this operation.

  • body (Hash) —

    The request body schema for the getOffers operation.

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

    Requests per second

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

Returns:



36
37
38
39
40
 
# File 'lib/peddler/apis/fulfillment_outbound_2026_07_04.rb', line 36

def get_offers(body, x_amzn_fulfillment_service_id: nil, rate_limit: 5.0)
  path = "/fulfillment/outbound/2026-07-04/offers"
  parser = -> { GetOffersResponse }
  post(path, body:, rate_limit:, parser:)
end

#get_order(order_id, x_amzn_fulfillment_service_id: nil, shipments: nil, rate_limit: 2.0) ⇒ Peddler::Response

Note:

This operation can make a dynamic sandbox call.

Retrieve a fulfillment order.

Parameters:

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

    The identifier of the fulfillment service used for this operation.

  • order_id (String) —

    The ID of the order you want to retrieve.

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

    Whether to include shipment data in the response. Included by default.

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

    Requests per second

  • (String)
  • x_amzn_fulfillment_service_id: (String, nil) (defaults to: nil)
  • shipments: (String, nil) (defaults to: nil)
  • rate_limit: (Float) (defaults to: 2.0)

Returns:



114
115
116
117
118
119
120
121
 
# File 'lib/peddler/apis/fulfillment_outbound_2026_07_04.rb', line 114

def get_order(order_id, x_amzn_fulfillment_service_id: nil, shipments: nil, rate_limit: 2.0)
  path = "/fulfillment/outbound/2026-07-04/orders/#{percent_encode(order_id)}"
  params = {
    "shipments" => shipments,
  }.compact
  parser = -> { GetOrderResponse }
  get(path, params:, rate_limit:, parser:)
end

#get_order_preview(body, x_amzn_fulfillment_service_id: nil, rate_limit: 2.0) ⇒ Peddler::Response

Note:

This operation can make a dynamic sandbox call.

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

Parameters:

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

    The identifier of the fulfillment service used for this operation.

  • body (Hash) —

    The request body schema for the getOrderPreview operation.

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

    Requests per second

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

Returns:



22
23
24
25
26
 
# File 'lib/peddler/apis/fulfillment_outbound_2026_07_04.rb', line 22

def get_order_preview(body, x_amzn_fulfillment_service_id: nil, rate_limit: 2.0)
  path = "/fulfillment/outbound/2026-07-04/previews"
  parser = -> { GetOrderPreviewResponse }
  post(path, body:, rate_limit:, parser:)
end

#list_orders(x_amzn_fulfillment_service_id: nil, updated_after: nil, page_token: nil, shipments: nil, rate_limit: 2.0) ⇒ Peddler::Response

Note:

This operation can make a dynamic sandbox call.

Retrieve a list of fulfillment orders that match the criteria you specify.

Parameters:

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

    The identifier of the fulfillment service used for this operation.

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

    The response includes orders updated after this time. Must be in ISO 8601 format.

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

    A token that you use to retrieve the next page of results. The response includes pageToken when the number of results exceeds the page size. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until pageToken is null.

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

    Whether to include shipment data in the response. Included by default.

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

    Requests per second

  • x_amzn_fulfillment_service_id: (String, nil) (defaults to: nil)
  • updated_after: (String, nil) (defaults to: nil)
  • page_token: (String, nil) (defaults to: nil)
  • shipments: (String, nil) (defaults to: nil)
  • rate_limit: (Float) (defaults to: 2.0)

Returns:



136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/peddler/apis/fulfillment_outbound_2026_07_04.rb', line 136

def list_orders(x_amzn_fulfillment_service_id: nil, updated_after: nil, page_token: nil, shipments: nil,
  rate_limit: 2.0)
  path = "/fulfillment/outbound/2026-07-04/orders"
  params = {
    "updatedAfter" => updated_after,
    "pageToken" => page_token,
    "shipments" => shipments,
  }.compact
  parser = -> { ListOrdersResponse }
  get(path, params:, rate_limit:, parser:)
end

#update_order(order_id, body, x_amzn_fulfillment_service_id: nil, rate_limit: 2.0) ⇒ Peddler::Response

Note:

This operation can make a dynamic sandbox call.

Update and/or request shipment for a fulfillment order with an order hold on it.

Parameters:

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

    The identifier of the fulfillment service used for this operation.

  • order_id (String) —

    The ID of the order that you want to update and/or request shipment of.

  • body (Hash) —

    The request body schema for the updateOrder operation.

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

    Requests per second

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

Returns:



100
101
102
103
104
 
# File 'lib/peddler/apis/fulfillment_outbound_2026_07_04.rb', line 100

def update_order(order_id, body, x_amzn_fulfillment_service_id: nil, rate_limit: 2.0)
  path = "/fulfillment/outbound/2026-07-04/orders/#{percent_encode(order_id)}"
  parser = -> { UpdateOrderResponse }
  put(path, body:, rate_limit:, parser:)
end

#update_order_status(order_id, body, x_amzn_fulfillment_service_id: nil) ⇒ Peddler::Response

Note:

This operation can make a dynamic sandbox call.

Request 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:

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

    The identifier of the fulfillment service used for this operation.

  • order_id (String) —

    The ID of the order that you want to update.

  • body (Hash) —

    The new status of the fulfillment order.

  • (String)
  • (Hash[untyped, untyped])
  • x_amzn_fulfillment_service_id: (String, nil) (defaults to: nil)

Returns:



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

def update_order_status(order_id, body, x_amzn_fulfillment_service_id: nil)
  must_sandbox!

  path = "/fulfillment/outbound/2026-07-04/orders/#{percent_encode(order_id)}/status"
  put(path, body:)
end

#update_package(order_id, package_id, body, x_amzn_fulfillment_service_id: nil) ⇒ Peddler::Response

Note:

This operation can make a dynamic sandbox call.

Update package information for a specific package in a fulfillment order. 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:

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

    The identifier of the fulfillment service used for this operation.

  • order_id (String) —

    The ID of the order that contains the package that you want to update.

  • package_id (String) —

    The ID of the package that you want to update.

  • body (Hash) —

    The new package information.

  • (String)
  • (String)
  • (Hash[untyped, untyped])
  • x_amzn_fulfillment_service_id: (String, nil) (defaults to: nil)

Returns:



85
86
87
88
89
90
 
# File 'lib/peddler/apis/fulfillment_outbound_2026_07_04.rb', line 85

def update_package(order_id, package_id, body, x_amzn_fulfillment_service_id: nil)
  must_sandbox!

  path = "/fulfillment/outbound/2026-07-04/orders/#{percent_encode(order_id)}/packages/#{percent_encode(package_id)}"
  put(path, body:)
end