Module: Peddler::Types::FBAInventoryV1

Defined in:

lib/peddler/types/fba_inventory_v1/error.rb,
lib/peddler/types/fba_inventory_v1/error_list.rb,
lib/peddler/types/fba_inventory_v1/pagination.rb,
lib/peddler/types/fba_inventory_v1/granularity.rb,
lib/peddler/types/fba_inventory_v1/inventory_item.rb,
lib/peddler/types/fba_inventory_v1/inventory_items.rb,
lib/peddler/types/fba_inventory_v1/inventory_details.rb,
lib/peddler/types/fba_inventory_v1/inventory_summary.rb,
lib/peddler/types/fba_inventory_v1/reserved_quantity.rb,
lib/peddler/types/fba_inventory_v1/inventory_summaries.rb,
lib/peddler/types/fba_inventory_v1/researching_quantity.rb,
lib/peddler/types/fba_inventory_v1/add_inventory_request.rb,
lib/peddler/types/fba_inventory_v1/add_inventory_response.rb,
lib/peddler/types/fba_inventory_v1/unfulfillable_quantity.rb,
lib/peddler/types/fba_inventory_v1/researching_quantity_entry.rb,
lib/peddler/types/fba_inventory_v1/create_inventory_item_request.rb,
lib/peddler/types/fba_inventory_v1/create_inventory_item_response.rb,
lib/peddler/types/fba_inventory_v1/delete_inventory_item_response.rb,
lib/peddler/types/fba_inventory_v1/get_inventory_summaries_result.rb,
lib/peddler/types/fba_inventory_v1/get_inventory_summaries_response.rb

Defined Under Namespace

Classes: ErrorList, InventoryItems, InventorySummaries

Constant Summary

Error =

An error response returned when the request is unsuccessful.

Structure.new do
  # @return [String] An error code that identifies the type of error that occurred.
  attribute(:code, String)

  # @return [String] Additional information that can help the caller understand or fix the issue.
  attribute?(:details, String)

  # @return [String] A message that describes the error condition in a human-readable form.
  attribute?(:message, String)
end

Pagination =

The process of returning the results to a request in batches of a defined size called pages. This is done to exercise some control over result size and overall throughput. It’s a form of traffic management.

Structure.new do
  # @return [String] A generated string used to retrieve the next page of the result. If nextToken is returned,
  # pass the value of nextToken to the next request. If nextToken is not returned, there are no more items to
  # return.
  attribute?(:next_token, String, from: "nextToken")
end

Granularity =

Describes a granularity at which inventory data can be aggregated. For example, if you use Marketplace granularity, the fulfillable quantity will reflect inventory that could be fulfilled in the given marketplace.

Structure.new do
  # @return [String] The granularity ID for the specified granularity type. When granularityType is Marketplace,
  # specify the marketplaceId.
  attribute?(:granularity_id, String, from: "granularityId")

  # @return [String] The granularity type for the inventory aggregation level.
  attribute?(:granularity_type, String, from: "granularityType")
end

InventoryItem =

An item in the list of inventory to be added.

Structure.new do
  # @return [String] The marketplaceId.
  attribute(:marketplace_id, String, from: "marketplaceId")

  # @return [Integer] The quantity of item to add.
  attribute(:quantity, Integer)

  # @return [String] The seller SKU of the item.
  attribute(:seller_sku, String, from: "sellerSku")
end

InventoryDetails =

Summarized inventory details. This object will not appear if the details parameter in the request is false.

Structure.new do
  # @return [Integer] The item quantity that can be picked, packed, and shipped.
  attribute?(:fulfillable_quantity, Integer, from: "fulfillableQuantity")

  # @return [Integer] The number of units that have not yet been received at an Amazon fulfillment center for
  # processing, but are part of an inbound shipment with some units that have already been received and processed.
  attribute?(:inbound_receiving_quantity, Integer, from: "inboundReceivingQuantity")

  # @return [Integer] The number of units in an inbound shipment that you have notified Amazon about and have
  # provided a tracking number.
  attribute?(:inbound_shipped_quantity, Integer, from: "inboundShippedQuantity")

  # @return [Integer] The number of units in an inbound shipment for which you have notified Amazon.
  attribute?(:inbound_working_quantity, Integer, from: "inboundWorkingQuantity")

  # @return [ResearchingQuantity]
  attribute?(:researching_quantity, ResearchingQuantity, from: "researchingQuantity")

  # @return [ReservedQuantity]
  attribute?(:reserved_quantity, ReservedQuantity, from: "reservedQuantity")

  # @return [UnfulfillableQuantity]
  attribute?(:unfulfillable_quantity, UnfulfillableQuantity, from: "unfulfillableQuantity")
end

InventorySummary =

Inventory summary for a specific item.

Structure.new do
  # @return [String] The Amazon Standard Identification Number (ASIN) of an item.
  attribute?(:asin, String)

  # @return [String] The condition of the item as described by the seller (for example, New Item).
  attribute?(:condition, String)

  # @return [String] Amazon's fulfillment network SKU identifier.
  attribute?(:fn_sku, String, from: "fnSku")

  # @return [InventoryDetails]
  attribute?(:inventory_details, InventoryDetails, from: "inventoryDetails")

  # @return [String] The date and time that any quantity was last updated.
  attribute?(:last_updated_time, String, from: "lastUpdatedTime")

  # @return [String] The localized language product title of the item within the specific marketplace.
  attribute?(:product_name, String, from: "productName")

  # @return [String] The seller SKU of the item.
  attribute?(:seller_sku, String, from: "sellerSku")

  # @return [Array<String>] A list of seller-enrolled stores that apply to this seller SKU.
  attribute?(:stores, [String])

  # @return [Integer] The total number of units in an inbound shipment or in Amazon fulfillment centers.
  attribute?(:total_quantity, Integer, from: "totalQuantity")
end

ReservedQuantity =

The quantity of reserved inventory.

Structure.new do
  # @return [Integer] The number of units that have been sidelined at the fulfillment center for additional
  # processing.
  attribute?(:fc_processing_quantity, Integer, from: "fcProcessingQuantity")

  # @return [Integer] The number of units reserved for customer orders.
  attribute?(:pending_customer_order_quantity, Integer, from: "pendingCustomerOrderQuantity")

  # @return [Integer] The number of units being transferred from one fulfillment center to another.
  attribute?(:pending_transshipment_quantity, Integer, from: "pendingTransshipmentQuantity")

  # @return [Integer] The total number of units in Amazon's fulfillment network that are currently being picked,
  # packed, and shipped; or are sidelined for measurement, sampling, or other internal processes.
  attribute?(:total_reserved_quantity, Integer, from: "totalReservedQuantity")
end

ResearchingQuantity =

The number of misplaced or warehouse damaged units that are actively being confirmed at our fulfillment centers.

Structure.new do
  # @return [Array<ResearchingQuantityEntry>] A list of quantity details for items currently being researched.
  attribute?(:researching_quantity_breakdown, [ResearchingQuantityEntry], from: "researchingQuantityBreakdown")

  # @return [Integer] The total number of units currently being researched in Amazon's fulfillment network.
  attribute?(:total_researching_quantity, Integer, from: "totalResearchingQuantity")
end

AddInventoryRequest =

The object with the list of Inventory to be added

Structure.new do
  # @return [Array<InventoryItem>]
  attribute?(:inventory_items, [InventoryItem], from: "inventoryItems")
end

AddInventoryResponse =

The response schema for the AddInventory operation.

Structure.new do
  # @return [Array<Error>] One or more unexpected errors occurred during the AddInventory operation.
  attribute?(:errors, [Error])
end

UnfulfillableQuantity =

The quantity of unfulfillable inventory.

Structure.new do
  # @return [Integer] The number of units in carrier damaged disposition.
  attribute?(:carrier_damaged_quantity, Integer, from: "carrierDamagedQuantity")

  # @return [Integer] The number of units in customer damaged disposition.
  attribute?(:customer_damaged_quantity, Integer, from: "customerDamagedQuantity")

  # @return [Integer] The number of units in defective disposition.
  attribute?(:defective_quantity, Integer, from: "defectiveQuantity")

  # @return [Integer] The number of units in distributor damaged disposition.
  attribute?(:distributor_damaged_quantity, Integer, from: "distributorDamagedQuantity")

  # @return [Integer] The number of units in expired disposition.
  attribute?(:expired_quantity, Integer, from: "expiredQuantity")

  # @return [Integer] The total number of units in Amazon's fulfillment network in unsellable condition.
  attribute?(:total_unfulfillable_quantity, Integer, from: "totalUnfulfillableQuantity")

  # @return [Integer] The number of units in warehouse damaged disposition.
  attribute?(:warehouse_damaged_quantity, Integer, from: "warehouseDamagedQuantity")
end

ResearchingQuantityEntry =

The misplaced or warehouse damaged inventory that is actively being confirmed at our fulfillment centers.

Structure.new do
  # @return [String] The duration of the research.
  attribute(:name, String)

  # @return [Integer] The number of units.
  attribute(:quantity, Integer)
end

CreateInventoryItemRequest =

An item to be created in the inventory.

Structure.new do
  # @return [String] The marketplaceId.
  attribute(:marketplace_id, String, from: "marketplaceId")

  # @return [String] The name of the item.
  attribute(:product_name, String, from: "productName")

  # @return [String] The seller SKU of the item.
  attribute(:seller_sku, String, from: "sellerSku")
end

CreateInventoryItemResponse =

The response schema for the CreateInventoryItem operation.

Structure.new do
  # @return [Array<Error>] One or more unexpected errors occurred during the CreateInventoryItem operation.
  attribute?(:errors, [Error])
end

DeleteInventoryItemResponse =

The response schema for the DeleteInventoryItem operation.

Structure.new do
  # @return [Array<Error>] One or more unexpected errors occurred during the DeleteInventoryItem operation.
  attribute?(:errors, [Error])
end

GetInventorySummariesResult =

The payload schema for the getInventorySummaries operation.

Structure.new do
  # @return [Granularity]
  attribute(:granularity, Granularity)

  # @return [Array<InventorySummary>]
  attribute(:inventory_summaries, [InventorySummary], from: "inventorySummaries")
end

GetInventorySummariesResponse =

The Response schema.

Structure.new do
  # @return [Array<Error>] One or more unexpected errors occurred during the getInventorySummaries operation.
  attribute?(:errors, [Error])

  # @return [Pagination]
  attribute?(:pagination, Pagination)

  # @return [GetInventorySummariesResult] The payload for the getInventorySummaries operation.
  attribute?(:payload, GetInventorySummariesResult)
end