AmzSpApi::FulfillmentOutboundApiModel::FbaOutboundApi

All URIs are relative to https://sellingpartnerapi-na.amazon.com/

Method | HTTP request | Description ————- | ————- | ————- {cancel_fulfillment_order} | PUT /fba/outbound/2020-07-01/fulfillmentOrders/{sellerFulfillmentOrderId}/cancel | {create_fulfillment_order} | POST /fba/outbound/2020-07-01/fulfillmentOrders | {create_fulfillment_return} | PUT /fba/outbound/2020-07-01/fulfillmentOrders/{sellerFulfillmentOrderId}/return | {get_feature_inventory} | GET /fba/outbound/2020-07-01/features/inventory/{featureName} | {get_feature_sku} | GET /fba/outbound/2020-07-01/features/inventory/{featureName}/{sellerSku} | {get_features} | GET /fba/outbound/2020-07-01/features | {get_fulfillment_order} | GET /fba/outbound/2020-07-01/fulfillmentOrders/{sellerFulfillmentOrderId} | {get_fulfillment_preview} | POST /fba/outbound/2020-07-01/fulfillmentOrders/preview | {get_package_tracking_details} | GET /fba/outbound/2020-07-01/tracking | {list_all_fulfillment_orders} | GET /fba/outbound/2020-07-01/fulfillmentOrders | {list_return_reason_codes} | GET /fba/outbound/2020-07-01/returnReasonCodes | {update_fulfillment_order} | PUT /fba/outbound/2020-07-01/fulfillmentOrders/{sellerFulfillmentOrderId} |

cancel_fulfillment_order

CancelFulfillmentOrderResponse cancel_fulfillment_order(seller_fulfillment_order_id)

Requests that Amazon stop attempting to fulfill the fulfillment order indicated by the specified order identifier. Usage Plan: | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Example

# load the gem
require 'fulfillment-outbound-api-model'

api_instance = AmzSpApi::FulfillmentOutboundApiModel::FbaOutboundApi.new
seller_fulfillment_order_id = 'seller_fulfillment_order_id_example' # String | The identifier assigned to the item by the seller when the fulfillment order was created.


begin
  result = api_instance.cancel_fulfillment_order(seller_fulfillment_order_id)
  p result
rescue AmzSpApi::FulfillmentOutboundApiModel::ApiError => e
  puts "Exception when calling FbaOutboundApi->cancel_fulfillment_order: #{e}"
end

Parameters

Name | Type | Description | Notes ————- | ————- | ————- | ————- seller_fulfillment_order_id | String| The identifier assigned to the item by the seller when the fulfillment order was created. |

Return type

{CancelFulfillmentOrderResponse}

Authorization

No authorization required

HTTP request headers

create_fulfillment_order

CreateFulfillmentOrderResponse create_fulfillment_order(body)

Requests that Amazon ship items from the seller's inventory in Amazon's fulfillment network to a destination address. Usage Plan: | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Example

# load the gem
require 'fulfillment-outbound-api-model'

api_instance = AmzSpApi::FulfillmentOutboundApiModel::FbaOutboundApi.new
body = AmzSpApi::FulfillmentOutboundApiModel::CreateFulfillmentOrderRequest.new # CreateFulfillmentOrderRequest |


begin
  result = api_instance.create_fulfillment_order(body)
  p result
rescue AmzSpApi::FulfillmentOutboundApiModel::ApiError => e
  puts "Exception when calling FbaOutboundApi->create_fulfillment_order: #{e}"
end

Parameters

Name | Type | Description | Notes ————- | ————- | ————- | ————- body | {CreateFulfillmentOrderRequest}| |

Return type

{CreateFulfillmentOrderResponse}

Authorization

No authorization required

HTTP request headers

create_fulfillment_return

CreateFulfillmentReturnResponse create_fulfillment_return(bodyseller_fulfillment_order_id)

Creates a fulfillment return. Usage Plan: | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Example

# load the gem
require 'fulfillment-outbound-api-model'

api_instance = AmzSpApi::FulfillmentOutboundApiModel::FbaOutboundApi.new
body = AmzSpApi::FulfillmentOutboundApiModel::CreateFulfillmentReturnRequest.new # CreateFulfillmentReturnRequest |
seller_fulfillment_order_id = 'seller_fulfillment_order_id_example' # String | An identifier assigned by the seller 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.


begin
  result = api_instance.create_fulfillment_return(bodyseller_fulfillment_order_id)
  p result
rescue AmzSpApi::FulfillmentOutboundApiModel::ApiError => e
  puts "Exception when calling FbaOutboundApi->create_fulfillment_return: #{e}"
end

Parameters

Name | Type | Description | Notes ————- | ————- | ————- | ————- body | {CreateFulfillmentReturnRequest}| | seller_fulfillment_order_id | String| An identifier assigned by the seller 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. |

Return type

{CreateFulfillmentReturnResponse}

Authorization

No authorization required

HTTP request headers

get_feature_inventory

GetFeatureInventoryResponse get_feature_inventory(marketplace_id, feature_name, opts)

Returns a list of inventory items that are eligible for the fulfillment feature you specify. Usage Plan: | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Example

# load the gem
require 'fulfillment-outbound-api-model'

api_instance = AmzSpApi::FulfillmentOutboundApiModel::FbaOutboundApi.new
marketplace_id = 'marketplace_id_example' # String | The marketplace for which to return a list of the inventory that is eligible for the specified feature.
feature_name = 'feature_name_example' # String | The name of the feature for which to return a list of eligible inventory.
opts = { 
  next_token: 'next_token_example' # String | 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.
}

begin
  result = api_instance.get_feature_inventory(marketplace_id, feature_name, opts)
  p result
rescue AmzSpApi::FulfillmentOutboundApiModel::ApiError => e
  puts "Exception when calling FbaOutboundApi->get_feature_inventory: #{e}"
end

Parameters

Name | Type | Description | Notes ————- | ————- | ————- | ————- 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| 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. | [optional]

Return type

{GetFeatureInventoryResponse}

Authorization

No authorization required

HTTP request headers

get_feature_sku

GetFeatureSkuResponse get_feature_sku(marketplace_id, feature_name, seller_sku)

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. Usage Plan: | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Example

# load the gem
require 'fulfillment-outbound-api-model'

api_instance = AmzSpApi::FulfillmentOutboundApiModel::FbaOutboundApi.new
marketplace_id = 'marketplace_id_example' # String | The marketplace for which to return the count.
feature_name = 'feature_name_example' # String | The name of the feature.
seller_sku = 'seller_sku_example' # 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.


begin
  result = api_instance.get_feature_sku(marketplace_id, feature_name, seller_sku)
  p result
rescue AmzSpApi::FulfillmentOutboundApiModel::ApiError => e
  puts "Exception when calling FbaOutboundApi->get_feature_sku: #{e}"
end

Parameters

Name | Type | Description | Notes ————- | ————- | ————- | ————- 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. |

Return type

{GetFeatureSkuResponse}

Authorization

No authorization required

HTTP request headers

get_features

GetFeaturesResponse get_features(marketplace_id)

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. Usage Plan: | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Example

# load the gem
require 'fulfillment-outbound-api-model'

api_instance = AmzSpApi::FulfillmentOutboundApiModel::FbaOutboundApi.new
marketplace_id = 'marketplace_id_example' # String | The marketplace for which to return the list of features.


begin
  result = api_instance.get_features(marketplace_id)
  p result
rescue AmzSpApi::FulfillmentOutboundApiModel::ApiError => e
  puts "Exception when calling FbaOutboundApi->get_features: #{e}"
end

Parameters

Name | Type | Description | Notes ————- | ————- | ————- | ————- marketplace_id | String| The marketplace for which to return the list of features. |

Return type

{GetFeaturesResponse}

Authorization

No authorization required

HTTP request headers

get_fulfillment_order

GetFulfillmentOrderResponse get_fulfillment_order(seller_fulfillment_order_id)

Returns the fulfillment order indicated by the specified order identifier. Usage Plan: | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Example

# load the gem
require 'fulfillment-outbound-api-model'

api_instance = AmzSpApi::FulfillmentOutboundApiModel::FbaOutboundApi.new
seller_fulfillment_order_id = 'seller_fulfillment_order_id_example' # String | The identifier assigned to the item by the seller when the fulfillment order was created.


begin
  result = api_instance.get_fulfillment_order(seller_fulfillment_order_id)
  p result
rescue AmzSpApi::FulfillmentOutboundApiModel::ApiError => e
  puts "Exception when calling FbaOutboundApi->get_fulfillment_order: #{e}"
end

Parameters

Name | Type | Description | Notes ————- | ————- | ————- | ————- seller_fulfillment_order_id | String| The identifier assigned to the item by the seller when the fulfillment order was created. |

Return type

{GetFulfillmentOrderResponse}

Authorization

No authorization required

HTTP request headers

get_fulfillment_preview

GetFulfillmentPreviewResponse get_fulfillment_preview(body)

Returns a list of fulfillment order previews based on shipping criteria that you specify. Usage Plan: | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Example

# load the gem
require 'fulfillment-outbound-api-model'

api_instance = AmzSpApi::FulfillmentOutboundApiModel::FbaOutboundApi.new
body = AmzSpApi::FulfillmentOutboundApiModel::GetFulfillmentPreviewRequest.new # GetFulfillmentPreviewRequest |


begin
  result = api_instance.get_fulfillment_preview(body)
  p result
rescue AmzSpApi::FulfillmentOutboundApiModel::ApiError => e
  puts "Exception when calling FbaOutboundApi->get_fulfillment_preview: #{e}"
end

Parameters

Name | Type | Description | Notes ————- | ————- | ————- | ————- body | {GetFulfillmentPreviewRequest}| |

Return type

{GetFulfillmentPreviewResponse}

Authorization

No authorization required

HTTP request headers

get_package_tracking_details

GetPackageTrackingDetailsResponse get_package_tracking_details(package_number)

Returns delivery tracking information for a package in an outbound shipment for a Multi-Channel Fulfillment order. Usage Plan: | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Example

# load the gem
require 'fulfillment-outbound-api-model'

api_instance = AmzSpApi::FulfillmentOutboundApiModel::FbaOutboundApi.new
package_number = 56 # Integer | The unencrypted package identifier returned by the getFulfillmentOrder operation.


begin
  result = api_instance.get_package_tracking_details(package_number)
  p result
rescue AmzSpApi::FulfillmentOutboundApiModel::ApiError => e
  puts "Exception when calling FbaOutboundApi->get_package_tracking_details: #{e}"
end

Parameters

Name | Type | Description | Notes ————- | ————- | ————- | ————- package_number | Integer| The unencrypted package identifier returned by the getFulfillmentOrder operation. |

Return type

{GetPackageTrackingDetailsResponse}

Authorization

No authorization required

HTTP request headers

list_all_fulfillment_orders

ListAllFulfillmentOrdersResponse list_all_fulfillment_orders(opts)

Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the next token parameter. Usage Plan: | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Example

# load the gem
require 'fulfillment-outbound-api-model'

api_instance = AmzSpApi::FulfillmentOutboundApiModel::FbaOutboundApi.new
opts = { 
  query_start_date: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | 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: 'next_token_example' # String | A string token returned in the response to your previous request.
}

begin
  result = api_instance.list_all_fulfillment_orders(opts)
  p result
rescue AmzSpApi::FulfillmentOutboundApiModel::ApiError => e
  puts "Exception when calling FbaOutboundApi->list_all_fulfillment_orders: #{e}"
end

Parameters

Name | Type | Description | Notes ————- | ————- | ————- | ————- query_start_date | DateTime| 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. | [optional] next_token | String| A string token returned in the response to your previous request. | [optional]

Return type

{ListAllFulfillmentOrdersResponse}

Authorization

No authorization required

HTTP request headers

list_return_reason_codes

ListReturnReasonCodesResponse list_return_reason_codes(seller_sku, language, opts)

Returns a list of return reason codes for a seller SKU in a given marketplace. Usage Plan: | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Example

# load the gem
require 'fulfillment-outbound-api-model'

api_instance = AmzSpApi::FulfillmentOutboundApiModel::FbaOutboundApi.new
seller_sku = 'seller_sku_example' # String | The seller SKU for which return reason codes are required.
language = 'language_example' # String | The language that the TranslatedDescription property of the ReasonCodeDetails response object should be translated into.
opts = { 
  marketplace_id: 'marketplace_id_example', # String | The marketplace for which the seller wants return reason codes.
  seller_fulfillment_order_id: 'seller_fulfillment_order_id_example' # String | 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.
}

begin
  result = api_instance.list_return_reason_codes(seller_sku, language, opts)
  p result
rescue AmzSpApi::FulfillmentOutboundApiModel::ApiError => e
  puts "Exception when calling FbaOutboundApi->list_return_reason_codes: #{e}"
end

Parameters

Name | Type | Description | Notes ————- | ————- | ————- | ————- seller_sku | String| The seller SKU for which return reason codes are required. | language | String| The language that the TranslatedDescription property of the ReasonCodeDetails response object should be translated into. | marketplace_id | String| The marketplace for which the seller wants return reason codes. | [optional] seller_fulfillment_order_id | String| 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. | [optional]

Return type

{ListReturnReasonCodesResponse}

Authorization

No authorization required

HTTP request headers

update_fulfillment_order

UpdateFulfillmentOrderResponse update_fulfillment_order(bodyseller_fulfillment_order_id)

Updates and/or requests shipment for a fulfillment order with an order hold on it. Usage Plan: | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Example

# load the gem
require 'fulfillment-outbound-api-model'

api_instance = AmzSpApi::FulfillmentOutboundApiModel::FbaOutboundApi.new
body = AmzSpApi::FulfillmentOutboundApiModel::UpdateFulfillmentOrderRequest.new # UpdateFulfillmentOrderRequest |
seller_fulfillment_order_id = 'seller_fulfillment_order_id_example' # String | The identifier assigned to the item by the seller when the fulfillment order was created.


begin
  result = api_instance.update_fulfillment_order(bodyseller_fulfillment_order_id)
  p result
rescue AmzSpApi::FulfillmentOutboundApiModel::ApiError => e
  puts "Exception when calling FbaOutboundApi->update_fulfillment_order: #{e}"
end

Parameters

Name | Type | Description | Notes ————- | ————- | ————- | ————- body | {UpdateFulfillmentOrderRequest}| | seller_fulfillment_order_id | String| The identifier assigned to the item by the seller when the fulfillment order was created. |

Return type

{UpdateFulfillmentOrderResponse}

Authorization

No authorization required

HTTP request headers