Module: Peddler::Types::FulfillmentInboundV0

Defined in:

lib/peddler/types/fulfillment_inbound_v0/error.rb,
lib/peddler/types/fulfillment_inbound_v0/amount.rb,
lib/peddler/types/fulfillment_inbound_v0/address.rb,
lib/peddler/types/fulfillment_inbound_v0/invalid_sku.rb,
lib/peddler/types/fulfillment_inbound_v0/invalid_asin.rb,
lib/peddler/types/fulfillment_inbound_v0/prep_details.rb,
lib/peddler/types/fulfillment_inbound_v0/label_download_url.rb,
lib/peddler/types/fulfillment_inbound_v0/get_labels_response.rb,
lib/peddler/types/fulfillment_inbound_v0/get_shipments_result.rb,
lib/peddler/types/fulfillment_inbound_v0/inbound_shipment_info.rb,
lib/peddler/types/fulfillment_inbound_v0/inbound_shipment_item.rb,
lib/peddler/types/fulfillment_inbound_v0/sku_prep_instructions.rb,
lib/peddler/types/fulfillment_inbound_v0/asin_prep_instructions.rb,
lib/peddler/types/fulfillment_inbound_v0/get_shipments_response.rb,
lib/peddler/types/fulfillment_inbound_v0/amazon_prep_fees_details.rb,
lib/peddler/types/fulfillment_inbound_v0/box_contents_fee_details.rb,
lib/peddler/types/fulfillment_inbound_v0/get_shipment_items_result.rb,
lib/peddler/types/fulfillment_inbound_v0/bill_of_lading_download_url.rb,
lib/peddler/types/fulfillment_inbound_v0/get_bill_of_lading_response.rb,
lib/peddler/types/fulfillment_inbound_v0/get_shipment_items_response.rb,
lib/peddler/types/fulfillment_inbound_v0/get_prep_instructions_result.rb,
lib/peddler/types/fulfillment_inbound_v0/get_prep_instructions_response.rb

Constant Summary

Error =

Error response returned when the request is unsuccessful.

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

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

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

Amount =

The monetary value.

Structure.new do
  # @return [String]
  attribute(:currency_code, String, from: "CurrencyCode")

  # @return [Float] The amount.
  attribute(:value, Float, from: "Value")
end

Address =

Specific details to identify a place.

Structure.new do
  # @return [String] Name of the individual or business.
  attribute(:name, String, from: "Name")

  # @return [String] The street address information.
  attribute(:address_line1, String, from: "AddressLine1")

  # @return [String] Additional street address information, if required.
  attribute(:address_line2, String, from: "AddressLine2")

  # @return [String] The district or county.
  attribute(:district_or_county, String, from: "DistrictOrCounty")

  # @return [String] The city.
  attribute(:city, String, from: "City")

  # @return [String] The state or province code.
  #
  # If state or province codes are used in your marketplace, it is recommended that you include one with your
  # request. This helps Amazon to select the most appropriate Amazon fulfillment center for your inbound shipment
  # plan.
  attribute(:state_or_province_code, String, from: "StateOrProvinceCode")

  # @return [String] The country code in two-character ISO 3166-1 alpha-2 format.
  attribute(:country_code, String, from: "CountryCode")

  # @return [String] The postal code.
  #
  # If postal codes are used in your marketplace, we recommended that you include one with your request. This
  # helps Amazon select the most appropriate Amazon fulfillment center for the inbound shipment plan.
  attribute(:postal_code, String, from: "PostalCode")
end

InvalidSKU =

Contains detail about an invalid SKU

Structure.new do
  # @return [String] The seller SKU of the item.
  attribute(:seller_sku, String, from: "SellerSKU")

  # @return [String] The reason why the seller SKU is invalid.
  attribute(:error_reason, String, from: "ErrorReason")
end

InvalidASIN =

Contains details about an invalid ASIN

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

  # @return [String] The reason that the ASIN is invalid.
  attribute(:error_reason, String, from: "ErrorReason")
end

PrepDetails =

Preparation instructions and who is responsible for the preparation.

Structure.new do
  # @return [String]
  attribute(:prep_instruction, String, from: "PrepInstruction")

  # @return [String]
  attribute(:prep_owner, String, from: "PrepOwner")
end

LabelDownloadURL =

Download URL for a label

Structure.new do
  # @return [String] URL to download the label for the package. Note: The URL will only be valid for 15 seconds
  attribute(:download_url, String, from: "DownloadURL")
end

GetLabelsResponse =

The response schema for the getLabels operation.

Structure.new do
  # @return [LabelDownloadURL] The payload for the getLabels operation.
  attribute(:payload, LabelDownloadURL)

  # @return [Array<Error>]
  attribute(:errors, [Error])
end

GetShipmentsResult =

Result for the get shipments operation

Structure.new do
  # @return [Array<InboundShipmentInfo>] Information about your inbound shipments.
  attribute(:shipment_data, [InboundShipmentInfo], from: "ShipmentData")

  # @return [String] When present and not empty, pass this string token in the next request to return the next
  # response page.
  attribute(:next_token, String, from: "NextToken")
end

InboundShipmentInfo =

Information about the seller's inbound shipments. Returned by the listInboundShipments operation.

Structure.new do
  # @return [String] The shipment identifier submitted in the request.
  attribute(:shipment_id, String, from: "ShipmentId")

  # @return [String] The name for the inbound shipment.
  attribute(:shipment_name, String, from: "ShipmentName")

  # @return [Address] The return address.
  attribute(:ship_from_address, Address, from: "ShipFromAddress")

  # @return [String] An Amazon fulfillment center identifier created by Amazon.
  attribute(:destination_fulfillment_center_id, String, from: "DestinationFulfillmentCenterId")

  # @return [String]
  attribute(:shipment_status, String, from: "ShipmentStatus")

  # @return [String]
  attribute(:label_prep_type, String, from: "LabelPrepType")

  # @return [:boolean] Indicates whether or not an inbound shipment contains case-packed boxes. When
  # AreCasesRequired = true for an inbound shipment, all items in the inbound shipment must be case packed.
  attribute(:are_cases_required, :boolean, from: "AreCasesRequired")

  # @return [String] Date by which the shipment must arrive at the Amazon fulfillment center to avoid delivery
  # promise breaks for pre-ordered items.
  attribute(:confirmed_need_by_date, String, from: "ConfirmedNeedByDate")

  # @return [String]
  attribute(:box_contents_source, String, from: "BoxContentsSource")

  # @return [BoxContentsFeeDetails] An estimate of the manual processing fee charged by Amazon for boxes without
  # box content information. This is only returned when BoxContentsSource is NONE.
  attribute(:estimated_box_contents_fee, BoxContentsFeeDetails, from: "EstimatedBoxContentsFee")
end

InboundShipmentItem =

Item information for an inbound shipment. Submitted with a call to the createInboundShipment or updateInboundShipment operation.

Structure.new do
  # @return [String] A shipment identifier originally returned by the createInboundShipmentPlan operation.
  attribute(:shipment_id, String, from: "ShipmentId")

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

  # @return [String] Amazon's fulfillment network SKU of the item.
  attribute(:fulfillment_network_sku, String, from: "FulfillmentNetworkSKU")

  # @return [Integer] The item quantity that you are shipping.
  attribute(:quantity_shipped, Integer, from: "QuantityShipped")

  # @return [Integer] The item quantity that has been received at an Amazon fulfillment center.
  attribute(:quantity_received, Integer, from: "QuantityReceived")

  # @return [Integer] The item quantity in each case, for case-packed items. Note that QuantityInCase multiplied
  # by the number of boxes in the inbound shipment equals QuantityShipped. Also note that all of the boxes of an
  # inbound shipment must either be case packed or individually packed. For that reason, when you submit the
  # createInboundShipment or the updateInboundShipment operation, the value of QuantityInCase must be provided for
  # every item in the shipment or for none of the items in the shipment.
  attribute(:quantity_in_case, Integer, from: "QuantityInCase")

  # @return [String] The date that a pre-order item will be available for sale.
  attribute(:release_date, String, from: "ReleaseDate")

  # @return [Array<PrepDetails>]
  attribute(:prep_details_list, [PrepDetails], from: "PrepDetailsList")
end

SKUPrepInstructions =

Labeling requirements and item preparation instructions to help you prepare items for shipment to Amazon's fulfillment network.

Structure.new do
  # @return [String] The seller SKU of the item.
  attribute(:seller_sku, String, from: "SellerSKU")

  # @return [String] The Amazon Standard Identification Number (ASIN) of the item.
  attribute(:asin, String, from: "ASIN")

  # @return [String]
  attribute(:barcode_instruction, String, from: "BarcodeInstruction")

  # @return [String]
  attribute(:prep_guidance, String, from: "PrepGuidance")

  # @return [Array<PrepInstruction>]
  attribute(:prep_instruction_list, Array, from: "PrepInstructionList")

  # @return [Array<AmazonPrepFeesDetails>]
  attribute(:amazon_prep_fees_details_list, [AmazonPrepFeesDetails], from: "AmazonPrepFeesDetailsList")
end

ASINPrepInstructions =

Item preparation instructions to help with item sourcing decisions.

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

  # @return [String]
  attribute(:barcode_instruction, String, from: "BarcodeInstruction")

  # @return [String]
  attribute(:prep_guidance, String, from: "PrepGuidance")

  # @return [Array<PrepInstruction>]
  attribute(:prep_instruction_list, Array, from: "PrepInstructionList")
end

GetShipmentsResponse =

The response schema for the getShipments operation.

Structure.new do
  # @return [GetShipmentsResult] The payload for the getShipments operation.
  attribute(:payload, GetShipmentsResult)

  # @return [Array<Error>]
  attribute(:errors, [Error])
end

AmazonPrepFeesDetails =

The fees for Amazon to prep goods for shipment.

Structure.new do
  # @return [String]
  attribute(:prep_instruction, String, from: "PrepInstruction")

  # @return [Amount] The fee for Amazon to prepare 1 unit.
  attribute(:fee_per_unit, Amount, from: "FeePerUnit")
end

BoxContentsFeeDetails =

The manual processing fee per unit and total fee for a shipment.

Structure.new do
  # @return [Integer] The number of units to ship.
  attribute(:total_units, Integer, from: "TotalUnits")

  # @return [Amount] The manual processing fee per unit.
  attribute(:fee_per_unit, Amount, from: "FeePerUnit")

  # @return [Amount] The total manual processing fee for the shipment.
  attribute(:total_fee, Amount, from: "TotalFee")
end

GetShipmentItemsResult =

Result for the get shipment items operation

Structure.new do
  # @return [Array<InboundShipmentItem>] A list of item information for an inbound shipment.
  attribute(:item_data, [InboundShipmentItem], from: "ItemData")

  # @return [String] When present and not empty, pass this string token in the next request to return the next
  # response page.
  attribute(:next_token, String, from: "NextToken")
end

BillOfLadingDownloadURL =

Download URL for the bill of lading.

Structure.new do
  # @return [String] URL to download the bill of lading for the package. Note: The URL will only be valid for 15
  # seconds
  attribute(:download_url, String, from: "DownloadURL")
end

GetBillOfLadingResponse =

The response schema for the getBillOfLading operation.

Structure.new do
  # @return [BillOfLadingDownloadURL] The payload for the getBillOfLading operation.
  attribute(:payload, BillOfLadingDownloadURL)

  # @return [Array<Error>]
  attribute(:errors, [Error])
end

GetShipmentItemsResponse =

The response schema for the getShipmentItems operation.

Structure.new do
  # @return [GetShipmentItemsResult] The payload for the getShipmentItems operation.
  attribute(:payload, GetShipmentItemsResult)

  # @return [Array<Error>]
  attribute(:errors, [Error])
end

GetPrepInstructionsResult =

Result for the get prep instructions operation

Structure.new do
  # @return [Array<SKUPrepInstructions>]
  attribute(:sku_prep_instructions_list, [SKUPrepInstructions], from: "SKUPrepInstructionsList")

  # @return [Array<InvalidSKU>]
  attribute(:invalid_sku_list, [InvalidSKU], from: "InvalidSKUList")

  # @return [Array<ASINPrepInstructions>]
  attribute(:asin_prep_instructions_list, [ASINPrepInstructions], from: "ASINPrepInstructionsList")

  # @return [Array<InvalidASIN>]
  attribute(:invalid_asin_list, [InvalidASIN], from: "InvalidASINList")
end

GetPrepInstructionsResponse =

The response schema for the getPrepInstructions operation.

Structure.new do
  # @return [GetPrepInstructionsResult] The payload for the getPrepInstructions operation.
  attribute(:payload, GetPrepInstructionsResult)

  # @return [Array<Error>]
  attribute(:errors, [Error])
end