Class: Peddler::APIs::FulfillmentInboundV0

Inherits:
Peddler::API show all
Defined in:
lib/peddler/apis/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.

See Also:

Instance Attribute Summary

Attributes inherited from Peddler::API

#access_token, #endpoint, #retries

Instance Method Summary collapse

Methods inherited from Peddler::API

#endpoint_uri, #http, #initialize, #meter, #retriable, #sandbox, #sandbox?, #typed, #typed?, #use, #via

Constructor Details

This class inherits a constructor from Peddler::API

Instance Method Details

#get_bill_of_lading(shipment_id, rate_limit: 2.0) ⇒ Peddler::Response

Note:

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.

Parameters:

  • shipment_id (String) —

    A shipment identifier originally returned by the createInboundShipmentPlan operation.

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

    Requests per second

Returns:



104
105
106
107
108
 
# File 'lib/peddler/apis/fulfillment_inbound_v0.rb', line 104

def get_bill_of_lading(shipment_id, rate_limit: 2.0)
  path = "/fba/inbound/v0/shipments/#{percent_encode(shipment_id)}/billOfLading"
  parser = Peddler::Types::FulfillmentInboundV0::GetBillOfLadingResponse if typed?
  meter(rate_limit).get(path, parser:)
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) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Returns package/pallet labels for faster and more accurate shipment processing at the Amazon fulfillment center.

Parameters:

  • shipment_id (String) —

    A shipment identifier originally returned by the createInboundShipmentPlan operation.

  • page_type (String) —

    The page type to use to print the labels. Submitting a PageType value that is not supported in your marketplace returns an error.

  • label_type (String) —

    The type of labels requested.

  • number_of_packages (Integer) (defaults to: nil) —

    The number of packages in the shipment.

  • package_labels_to_print (Array<String>) (defaults to: nil) —

    A list of identifiers that specify packages for which you want package labels printed. If you provide box content information with the [FBA Inbound Shipment Carton Information Feed](developer-docs.amazon.com/sp-api/docs/fulfillment-by-amazon-feed-type-values#fba-inbound-shipment-carton-information-feed), then ‘PackageLabelsToPrint` must match the `CartonId` values you provide through that feed. If you provide box content information with the Fulfillment Inbound API v2024-03-20, then `PackageLabelsToPrint` must match the `boxID` values from the [`listShipmentBoxes`](developer-docs.amazon.com/sp-api/reference/listshipmentboxes) response. If these values do not match as required, the operation returns the `IncorrectPackageIdentifier` error code.

  • number_of_pallets (Integer) (defaults to: nil) —

    The number of pallets in the shipment. This returns four identical labels for each pallet.

  • page_size (Integer) (defaults to: nil) —

    The page size for paginating through the total packages’ labels. This is a required parameter for Non-Partnered LTL Shipments. Max value:1000.

  • page_start_index (Integer) (defaults to: nil) —

    The page start index for paginating through the total packages’ labels. This is a required parameter for Non-Partnered LTL Shipments.

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

    Requests per second

Returns:



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/peddler/apis/fulfillment_inbound_v0.rb', line 79

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/#{percent_encode(shipment_id)}/labels"
  params = {
    "PageType" => page_type,
    "LabelType" => label_type,
    "NumberOfPackages" => number_of_packages,
    "PackageLabelsToPrint" => stringify_array(package_labels_to_print),
    "NumberOfPallets" => number_of_pallets,
    "PageSize" => page_size,
    "PageStartIndex" => page_start_index,
  }.compact
  parser = Peddler::Types::FulfillmentInboundV0::GetLabelsResponse if typed?
  meter(rate_limit).get(path, params:, parser:)
end

#get_prep_instructions(ship_to_country_code, seller_sku_list: nil, asin_list: nil, rate_limit: 2.0) ⇒ Peddler::Response

Note:

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.

Parameters:

  • ship_to_country_code (String) —

    The country code of the country to which the items will be shipped. Note that labeling requirements and item preparation instructions can vary by country.

  • seller_sku_list (Array<String>) (defaults to: nil) —

    A list of SellerSKU values. Used to identify items for which you want labeling requirements and item preparation instructions for shipment to Amazon’s fulfillment network. The SellerSKU is qualified by the Seller ID, which is included with every call to the Seller Partner API. Note: Include seller SKUs that you have used to list items on Amazon’s retail website. If you include a seller SKU that you have never used to list an item on Amazon’s retail website, the seller SKU is returned in the InvalidSKUList property in the response.

  • asin_list (Array<String>) (defaults to: nil) —

    A list of ASIN values. Used to identify items for which you want item preparation instructions to help with item sourcing decisions. Note: ASINs must be included in the product catalog for at least one of the marketplaces that the seller participates in. Any ASIN that is not included in the product catalog for at least one of the marketplaces that the seller participates in is returned in the InvalidASINList property in the response. You can find out which marketplaces a seller participates in by calling the getMarketplaceParticipations operation in the Selling Partner API for Sellers.

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

    Requests per second

Returns:



42
43
44
45
46
47
48
49
50
51
 
# File 'lib/peddler/apis/fulfillment_inbound_v0.rb', line 42

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" => stringify_array(seller_sku_list),
    "ASINList" => stringify_array(asin_list),
  }.compact
  parser = Peddler::Types::FulfillmentInboundV0::GetPrepInstructionsResponse if typed?
  meter(rate_limit).get(path, params:, parser:)
end

#get_shipment_items(query_type, marketplace_id, last_updated_after: nil, last_updated_before: nil, next_token: nil, rate_limit: 2.0) ⇒ Peddler::Response

Note:

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.

Parameters:

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

    A date used for selecting inbound shipment items that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller.

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

    A date used for selecting inbound shipment items that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller.

  • query_type (String) —

    Indicates whether items are returned using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or using NextToken, which continues returning items specified in a previous request.

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

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

  • marketplace_id (String) —

    A marketplace identifier. Specifies the marketplace where the product would be stored.

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

    Requests per second

Returns:



179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/peddler/apis/fulfillment_inbound_v0.rb', line 179

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
  parser = Peddler::Types::FulfillmentInboundV0::GetShipmentItemsResponse if typed?
  meter(rate_limit).get(path, params:, parser:)
end

#get_shipment_items_by_shipment_id(shipment_id, marketplace_id: nil, rate_limit: 2.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Returns a list of items in a specified inbound shipment.

Parameters:

  • shipment_id (String) —

    A shipment identifier used for selecting items in a specific inbound shipment.

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

    Deprecated. Do not use.

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

    Requests per second

Returns:



154
155
156
157
158
159
160
161
 
# File 'lib/peddler/apis/fulfillment_inbound_v0.rb', line 154

def get_shipment_items_by_shipment_id(shipment_id, marketplace_id: nil, rate_limit: 2.0)
  path = "/fba/inbound/v0/shipments/#{percent_encode(shipment_id)}/items"
  params = {
    "MarketplaceId" => marketplace_id,
  }.compact
  parser = Peddler::Types::FulfillmentInboundV0::GetShipmentItemsResponse if typed?
  meter(rate_limit).get(path, params:, parser:)
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) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Returns a list of inbound shipments based on criteria that you specify.

Parameters:

  • shipment_status_list (Array<String>) (defaults to: nil) —

    A list of ShipmentStatus values. Used to select shipments with a current status that matches the status values that you specify.

  • shipment_id_list (Array<String>) (defaults to: nil) —

    A list of shipment IDs used to select the shipments that you want. If both ShipmentStatusList and ShipmentIdList are specified, only shipments that match both parameters are returned.

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

    A date used for selecting inbound shipments that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller.

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

    A date used for selecting inbound shipments that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller.

  • query_type (String) —

    Indicates whether shipments are returned using shipment information (by providing the ShipmentStatusList or ShipmentIdList parameters), using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or by using NextToken to continue returning items specified in a previous request.

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

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

  • marketplace_id (String) —

    A marketplace identifier. Specifies the marketplace where the product would be stored.

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

    Requests per second

Returns:



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/peddler/apis/fulfillment_inbound_v0.rb', line 131

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" => stringify_array(shipment_status_list),
    "ShipmentIdList" => stringify_array(shipment_id_list),
    "LastUpdatedAfter" => last_updated_after,
    "LastUpdatedBefore" => last_updated_before,
    "QueryType" => query_type,
    "NextToken" => next_token,
    "MarketplaceId" => marketplace_id,
  }.compact
  parser = Peddler::Types::FulfillmentInboundV0::GetShipmentsResponse if typed?
  meter(rate_limit).get(path, params:, parser:)
end