Module: Peddler::Types::MerchantFulfillmentV0

Defined in:

lib/peddler/types/merchant_fulfillment_v0/item.rb,
lib/peddler/types/merchant_fulfillment_v0/error.rb,
lib/peddler/types/merchant_fulfillment_v0/label.rb,
lib/peddler/types/merchant_fulfillment_v0/length.rb,
lib/peddler/types/merchant_fulfillment_v0/weight.rb,
lib/peddler/types/merchant_fulfillment_v0/address.rb,
lib/peddler/types/merchant_fulfillment_v0/benefits.rb,
lib/peddler/types/merchant_fulfillment_v0/shipment.rb,
lib/peddler/types/merchant_fulfillment_v0/constraint.rb,
lib/peddler/types/merchant_fulfillment_v0/file_contents.rb,
lib/peddler/types/merchant_fulfillment_v0/liquid_volume.rb,
lib/peddler/types/merchant_fulfillment_v0/currency_amount.rb,
lib/peddler/types/merchant_fulfillment_v0/excluded_benefit.rb,
lib/peddler/types/merchant_fulfillment_v0/label_dimensions.rb,
lib/peddler/types/merchant_fulfillment_v0/shipping_service.rb,
lib/peddler/types/merchant_fulfillment_v0/additional_inputs.rb,
lib/peddler/types/merchant_fulfillment_v0/item_level_fields.rb,
lib/peddler/types/merchant_fulfillment_v0/package_dimensions.rb,
lib/peddler/types/merchant_fulfillment_v0/label_customization.rb,
lib/peddler/types/merchant_fulfillment_v0/label_format_option.rb,
lib/peddler/types/merchant_fulfillment_v0/get_shipment_response.rb,
lib/peddler/types/merchant_fulfillment_v0/additional_seller_input.rb,
lib/peddler/types/merchant_fulfillment_v0/create_shipment_request.rb,
lib/peddler/types/merchant_fulfillment_v0/dangerous_goods_details.rb,
lib/peddler/types/merchant_fulfillment_v0/seller_input_definition.rb,
lib/peddler/types/merchant_fulfillment_v0/additional_seller_inputs.rb,
lib/peddler/types/merchant_fulfillment_v0/cancel_shipment_response.rb,
lib/peddler/types/merchant_fulfillment_v0/create_shipment_response.rb,
lib/peddler/types/merchant_fulfillment_v0/shipment_request_details.rb,
lib/peddler/types/merchant_fulfillment_v0/shipping_offering_filter.rb,
lib/peddler/types/merchant_fulfillment_v0/shipping_service_options.rb,
lib/peddler/types/merchant_fulfillment_v0/rejected_shipping_service.rb,
lib/peddler/types/merchant_fulfillment_v0/label_format_option_request.rb,
lib/peddler/types/merchant_fulfillment_v0/temporarily_unavailable_carrier.rb,
lib/peddler/types/merchant_fulfillment_v0/available_shipping_service_options.rb,
lib/peddler/types/merchant_fulfillment_v0/get_additional_seller_inputs_result.rb,
lib/peddler/types/merchant_fulfillment_v0/available_delivery_experience_option.rb,
lib/peddler/types/merchant_fulfillment_v0/get_additional_seller_inputs_request.rb,
lib/peddler/types/merchant_fulfillment_v0/available_carrier_will_pick_up_option.rb,
lib/peddler/types/merchant_fulfillment_v0/get_additional_seller_inputs_response.rb,
lib/peddler/types/merchant_fulfillment_v0/get_eligible_shipment_services_result.rb,
lib/peddler/types/merchant_fulfillment_v0/get_eligible_shipment_services_request.rb,
lib/peddler/types/merchant_fulfillment_v0/get_eligible_shipment_services_response.rb,
lib/peddler/types/merchant_fulfillment_v0/terms_and_conditions_not_accepted_carrier.rb

Constant Summary

Item =

An Amazon order item identifier and a quantity.

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

  # @return [Integer]
  attribute(:quantity, Integer, from: "Quantity")

  # @return [Weight]
  attribute(:item_weight, Weight, from: "ItemWeight")

  # @return [String]
  attribute(:item_description, String, from: "ItemDescription")

  # @return [Array<TransparencyCode>]
  attribute(:transparency_code_list, Array, from: "TransparencyCodeList")

  # @return [Array<AdditionalSellerInputs>] A list of additional seller inputs required to ship this item using
  # the chosen shipping service.
  attribute(:item_level_seller_inputs_list, [AdditionalSellerInputs], from: "ItemLevelSellerInputsList")

  # @return [LiquidVolume]
  attribute(:liquid_volume, LiquidVolume, from: "LiquidVolume")

  # @return [:boolean] When true, the item qualifies as hazardous materials (hazmat). Defaults to false.
  attribute(:hazmat, :boolean, from: "IsHazmat")

  # @return [DangerousGoodsDetails]
  attribute(:dangerous_goods_details, DangerousGoodsDetails, from: "DangerousGoodsDetails")
end

Error =

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] 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

Label =

Data for creating a shipping label and dimensions for printing the label.

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

  # @return [LabelDimensions]
  attribute(:dimensions, LabelDimensions, from: "Dimensions")

  # @return [FileContents]
  attribute(:file_contents, FileContents, from: "FileContents")

  # @return [String]
  attribute(:label_format, String, from: "LabelFormat")

  # @return [String]
  attribute(:standard_id_for_label, String, from: "StandardIdForLabel")
end

Length =

The length.

Structure.new do
  # @return [Float] The value in units.
  attribute(:value, Float)

  # @return [String]
  attribute(:unit, String)
end

Weight =

The weight.

Structure.new do
  # @return [Float]
  attribute(:value, Float, from: "Value")

  # @return [String]
  attribute(:unit, String, from: "Unit")
end

Address =

The postal address information.

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

  # @return [String]
  attribute(:address_line1, String, from: "AddressLine1")

  # @return [String]
  attribute(:address_line2, String, from: "AddressLine2")

  # @return [String]
  attribute(:address_line3, String, from: "AddressLine3")

  # @return [String]
  attribute(:district_or_county, String, from: "DistrictOrCounty")

  # @return [String]
  attribute(:email, String, from: "Email")

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

  # @return [String]
  attribute(:state_or_province_code, String, from: "StateOrProvinceCode")

  # @return [String]
  attribute(:postal_code, String, from: "PostalCode")

  # @return [String]
  attribute(:country_code, String, from: "CountryCode")

  # @return [String]
  attribute(:phone, String, from: "Phone")
end

Benefits =

Benefits that are included and excluded for each shipping offer. Benefits represents services provided by Amazon (for example, CLAIMS_PROTECTED) when sellers purchase shipping through Amazon. Benefit details are made available for any shipment placed on or after January 1st 2024 00:00 UTC.

Structure.new do
  # @return [Array]
  attribute(:included_benefits, Array, from: "IncludedBenefits")

  # @return [Array<ExcludedBenefit>]
  attribute(:excluded_benefits, [ExcludedBenefit], from: "ExcludedBenefits")
end

Shipment =

The details of a shipment. Includes the shipment status.

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

  # @return [String]
  attribute(:amazon_order_id, String, from: "AmazonOrderId")

  # @return [String]
  attribute(:seller_order_id, String, from: "SellerOrderId")

  # @return [Array<Item>]
  attribute(:item_list, [Item], from: "ItemList")

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

  # @return [Address] The destination address for the shipment.
  attribute(:ship_to_address, Address, from: "ShipToAddress")

  # @return [PackageDimensions]
  attribute(:package_dimensions, PackageDimensions, from: "PackageDimensions")

  # @return [Weight] The package weight.
  attribute(:weight, Weight, from: "Weight")

  # @return [CurrencyAmount] If you specify `DeclaredValue` in a previous call to the `createShipment` operation,
  # then `Insurance` indicates the shipment insurance amount that the carrier uses. If `DeclaredValue` isn't with
  # a previous call to the `createShipment` operation, then the shipment is insured for the carrier's minimum
  # insurance amount, or the combined sale prices that the items are listed for in the shipment.
  attribute(:insurance, CurrencyAmount, from: "Insurance")

  # @return [ShippingService]
  attribute(:shipping_service, ShippingService, from: "ShippingService")

  # @return [Label] Data for creating a shipping label and dimensions for printing the label. If the shipment is
  # canceled, an empty label is returned.
  attribute(:label, Label, from: "Label")

  # @return [String] The shipment status.
  attribute(:status, String, from: "Status")

  # @return [String]
  attribute(:tracking_id, String, from: "TrackingId")

  # @return [String] The date and time the shipment is created.
  attribute(:created_date, String, from: "CreatedDate")

  # @return [String] The date and time of the last update.
  attribute(:last_updated_date, String, from: "LastUpdatedDate")
end

Constraint =

A validation constraint.

Structure.new do
  # @return [String] A regular expression.
  attribute(:validation_reg_ex, String, from: "ValidationRegEx")

  # @return [String] A validation string.
  attribute(:validation_string, String, from: "ValidationString")
end

FileContents =

The document data and checksum.

Structure.new do
  # @return [String] Data for printing labels encoded into a Base64, GZip-compressed string.
  attribute(:contents, String, from: "Contents")

  # @return [String]
  attribute(:file_type, String, from: "FileType")

  # @return [String] An MD5 hash to validate the PDF document data, in the form of a Base64 string.
  attribute(:checksum, String, from: "Checksum")
end

LiquidVolume =

Liquid volume.

Structure.new do
  # @return [String] The unit of measurement.
  attribute(:unit, String, from: "Unit")

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

CurrencyAmount =

Currency type and amount.

Structure.new do
  # @return [String] Three-digit currency code in ISO 4217 format.
  attribute(:currency_code, String, from: "CurrencyCode")

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

ExcludedBenefit =

An object representing an excluded benefit that is excluded for a shipping offer or rate.

Structure.new do
  # @return [String] A benefit that is being excluded from a shipment.
  attribute(:benefit, String, from: "Benefit")

  # @return [Array]
  attribute(:reason_codes, Array, from: "ReasonCodes")
end

LabelDimensions =

Dimensions for printing a shipping label.

Structure.new do
  # @return [Float] The length dimension.
  attribute(:length, Float, from: "Length")

  # @return [Float] The width dimension.
  attribute(:width, Float, from: "Width")

  # @return [String] The unit of measurement.
  attribute(:unit, String, from: "Unit")
end

ShippingService =

A shipping service offer made by a carrier.

Structure.new do
  # @return [String] A plain text representation of a carrier's shipping service. For example, "UPS Ground" or
  # "FedEx Standard Overnight".
  attribute(:shipping_service_name, String, from: "ShippingServiceName")

  # @return [String] The name of the carrier.
  attribute(:carrier_name, String, from: "CarrierName")

  # @return [String]
  attribute(:shipping_service_id, String, from: "ShippingServiceId")

  # @return [String] An Amazon-defined shipping service offer identifier.
  attribute(:shipping_service_offer_id, String, from: "ShippingServiceOfferId")

  # @return [String] The date that the carrier will ship the package.
  attribute(:ship_date, String, from: "ShipDate")

  # @return [String] The earliest date by which the shipment will be delivered.
  attribute(:earliest_estimated_delivery_date, String, from: "EarliestEstimatedDeliveryDate")

  # @return [String] The latest date by which the shipment will be delivered.
  attribute(:latest_estimated_delivery_date, String, from: "LatestEstimatedDeliveryDate")

  # @return [CurrencyAmount] The amount that the carrier will charge for the shipment.
  attribute(:rate, CurrencyAmount, from: "Rate")

  # @return [ShippingServiceOptions] Extra services offered by the carrier.
  attribute(:shipping_service_options, ShippingServiceOptions, from: "ShippingServiceOptions")

  # @return [AvailableShippingServiceOptions]
  attribute(:available_shipping_service_options, AvailableShippingServiceOptions, from: "AvailableShippingServiceOptions")

  # @return [Array<LabelFormat>]
  attribute(:available_label_formats, Array, from: "AvailableLabelFormats")

  # @return [Array<LabelFormatOption>]
  attribute(:available_format_options_for_label, [LabelFormatOption], from: "AvailableFormatOptionsForLabel")

  # @return [:boolean] When true, additional seller inputs are required.
  attribute(:requires_additional_seller_inputs, :boolean, from: "RequiresAdditionalSellerInputs")

  # @return [Benefits]
  attribute(:benefits, Benefits, from: "Benefits")
end

AdditionalInputs =

Maps the additional seller input to the definition. The key to the map is the field name.

Structure.new do
  # @return [String] The field name.
  attribute(:additional_input_field_name, String, from: "AdditionalInputFieldName")

  # @return [SellerInputDefinition]
  attribute(:seller_input_definition, SellerInputDefinition, from: "SellerInputDefinition")
end

ItemLevelFields =

A list of item level fields.

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

  # @return [Array<AdditionalInputs>]
  attribute(:additional_inputs, [AdditionalInputs], from: "AdditionalInputs")
end

PackageDimensions =

The dimensions of a package contained in a shipment.

Structure.new do
  # @return [Float] The length dimension. If you don't specify `PredefinedPackageDimensions`, you must specify the
  # length.
  attribute(:length, Float, from: "Length")

  # @return [Float] The width dimension. If you don't specify `PredefinedPackageDimensions`, you must specify the
  # width.
  attribute(:width, Float, from: "Width")

  # @return [Float] The height dimension. If you don't specify `PredefinedPackageDimensions`, you must specify the
  # height.
  attribute(:height, Float, from: "Height")

  # @return [String] The unit of measurement. If you don't specify `PredefinedPackageDimensions`, you must specify
  # the unit.
  attribute(:unit, String, from: "Unit")

  # @return [String]
  attribute(:predefined_package_dimensions, String, from: "PredefinedPackageDimensions")
end

LabelCustomization =

Custom text for shipping labels.

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

  # @return [String]
  attribute(:standard_id_for_label, String, from: "StandardIdForLabel")
end

LabelFormatOption =

The label format details and whether to include a packing slip.

Structure.new do
  # @return [:boolean] When true, include a packing slip with the label.
  attribute(:include_packing_slip_with_label, :boolean, from: "IncludePackingSlipWithLabel")

  # @return [String]
  attribute(:label_format, String, from: "LabelFormat")
end

GetShipmentResponse =

Response schema.

Structure.new do
  # @return [Shipment] The payload for the `getShipment` operation.
  attribute(:payload, Shipment)

  # @return [Array<Error>] One or more unexpected errors occurred during this operation.
  attribute(:errors, [Error])
end

AdditionalSellerInput =

Additional information required to purchase shipping.

Structure.new do
  # @return [String] The data type of the additional information.
  attribute(:data_type, String, from: "DataType")

  # @return [String] The value when the data type is string.
  attribute(:value_as_string, String, from: "ValueAsString")

  # @return [:boolean] The value when the data type is boolean.
  attribute(:value_as_boolean, :boolean, from: "ValueAsBoolean")

  # @return [Integer] The value when the data type is integer.
  attribute(:value_as_integer, Integer, from: "ValueAsInteger")

  # @return [String] The value when the data type is a date-time formatted string.
  attribute(:value_as_timestamp, String, from: "ValueAsTimestamp")

  # @return [Address]
  attribute(:value_as_address, Address, from: "ValueAsAddress")

  # @return [Weight]
  attribute(:value_as_weight, Weight, from: "ValueAsWeight")

  # @return [Length]
  attribute(:value_as_dimension, Length, from: "ValueAsDimension")

  # @return [CurrencyAmount]
  attribute(:value_as_currency, CurrencyAmount, from: "ValueAsCurrency")
end

CreateShipmentRequest =

Request schema.

Structure.new do
  # @return [ShipmentRequestDetails] Shipment information required to create a shipment.
  attribute(:shipment_request_details, ShipmentRequestDetails, from: "ShipmentRequestDetails")

  # @return [String]
  attribute(:shipping_service_id, String, from: "ShippingServiceId")

  # @return [String] Identifies a shipping service order made by a carrier.
  attribute(:shipping_service_offer_id, String, from: "ShippingServiceOfferId")

  # @return [String] Hazardous materials options for a package. Consult the terms and conditions for each carrier
  # for more information about hazardous materials.
  attribute(:hazmat_type, String, from: "HazmatType")

  # @return [LabelFormatOptionRequest]
  attribute(:label_format_option, LabelFormatOptionRequest, from: "LabelFormatOption")

  # @return [Array<AdditionalSellerInputs>] A list of additional seller inputs required to ship this shipment.
  attribute(:shipment_level_seller_inputs_list, [AdditionalSellerInputs], from: "ShipmentLevelSellerInputsList")
end

DangerousGoodsDetails =

Details related to any dangerous goods or items that are shipped.

Structure.new do
  # @return [String] The specific UNID of the item being shipped.
  attribute(:united_nations_regulatory_id, String, from: "UnitedNationsRegulatoryId")

  # @return [String] The specific regulatory class of the shipped item.
  attribute(:transportation_regulatory_class, String, from: "TransportationRegulatoryClass")

  # @return [String] The specific packaging group of the item being shipped.
  attribute(:packing_group, String, from: "PackingGroup")

  # @return [String] The specific packing instruction of the item being shipped.
  attribute(:packing_instruction, String, from: "PackingInstruction")
end

SellerInputDefinition =

Specifies characteristics that apply to a seller input.

Structure.new do
  # @return [:boolean] When true, the additional input field is required.
  attribute(:required, :boolean, from: "IsRequired")

  # @return [String] The data type of the additional input field.
  attribute(:data_type, String, from: "DataType")

  # @return [Array<Constraint>]
  attribute(:constraints, [Constraint], from: "Constraints")

  # @return [String] The display text for the additional input field.
  attribute(:input_display_text, String, from: "InputDisplayText")

  # @return [String] Whether the seller input applies to the item or the shipment.
  attribute(:input_target, String, from: "InputTarget")

  # @return [AdditionalSellerInput]
  attribute(:stored_value, AdditionalSellerInput, from: "StoredValue")

  # @return [Array]
  attribute(:restricted_set_values, Array, from: "RestrictedSetValues")
end

AdditionalSellerInputs =

An additional set of seller inputs required to purchase shipping.

Structure.new do
  # @return [String] The name of the additional input field.
  attribute(:additional_input_field_name, String, from: "AdditionalInputFieldName")

  # @return [AdditionalSellerInput]
  attribute(:additional_seller_input, AdditionalSellerInput, from: "AdditionalSellerInput")
end

CancelShipmentResponse =

Response schema.

Structure.new do
  # @return [Shipment] The payload for the `cancelShipment` operation.
  attribute(:payload, Shipment)

  # @return [Array<Error>] One or more unexpected errors occurred during the `cancelShipment` operation.
  attribute(:errors, [Error])
end

CreateShipmentResponse =

Response schema.

Structure.new do
  # @return [Shipment] Shipment information.
  attribute(:payload, Shipment)

  # @return [Array<Error>] One or more unexpected errors occurred during the `createShipment` operation.
  attribute(:errors, [Error])
end

ShipmentRequestDetails =

Shipment information required for requesting shipping service offers or for creating a shipment.

Structure.new do
  # @return [String] An Amazon-defined order identifier in 3-7-7 format.
  attribute(:amazon_order_id, String, from: "AmazonOrderId")

  # @return [String] A seller-defined order identifier.
  attribute(:seller_order_id, String, from: "SellerOrderId")

  # @return [Array<Item>]
  attribute(:item_list, [Item], from: "ItemList")

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

  # @return [PackageDimensions] The package dimensions.
  attribute(:package_dimensions, PackageDimensions, from: "PackageDimensions")

  # @return [Weight] The package weight.
  attribute(:weight, Weight, from: "Weight")

  # @return [String] The date by which the package must arrive to keep the promise to the customer, in [ISO
  # 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. If `MustArriveByDate` is
  # specified, only shipping service offers that can be delivered by that date are returned.
  attribute(:must_arrive_by_date, String, from: "MustArriveByDate")

  # @return [String] When used in a request, this is the date and time that the seller wants to ship the package.
  # When used in a response, this is the date and time that the package can be shipped by the indicated method.
  attribute(:ship_date, String, from: "ShipDate")

  # @return [ShippingServiceOptions] Extra services offered by the carrier.
  attribute(:shipping_service_options, ShippingServiceOptions, from: "ShippingServiceOptions")

  # @return [LabelCustomization] Label customization options.
  attribute(:label_customization, LabelCustomization, from: "LabelCustomization")
end

ShippingOfferingFilter =

Filter for use when requesting eligible shipping services.

Structure.new do
  # @return [:boolean] When true, include a packing slip with the label.
  attribute(:include_packing_slip_with_label, :boolean, from: "IncludePackingSlipWithLabel")

  # @return [:boolean] When true, include complex shipping options.
  attribute(:include_complex_shipping_options, :boolean, from: "IncludeComplexShippingOptions")

  # @return [String]
  attribute(:carrier_will_pick_up, String, from: "CarrierWillPickUp")

  # @return [String]
  attribute(:delivery_experience, String, from: "DeliveryExperience")
end

ShippingServiceOptions =

Extra services provided by a carrier.

Structure.new do
  # @return [String] The delivery confirmation level.
  attribute(:delivery_experience, String, from: "DeliveryExperience")

  # @return [CurrencyAmount] The declared value of the shipment. The carrier uses this value to determine the
  # amount to use to insure the shipment. If `DeclaredValue` is greater than the carrier's minimum insurance
  # amount, the seller is charged for the additional insurance, as determined by the carrier. For information
  # about optional insurance coverage, refer to Seller Central Help:
  # [UK](https://sellercentral.amazon.co.uk/gp/help/200204080),
  # [US](https://sellercentral.amazon.com/gp/help/200204080).
  attribute(:declared_value, CurrencyAmount, from: "DeclaredValue")

  # @return [:boolean] When true, the carrier will pick up the package. Note: Scheduled carrier pickup is
  # available only using Dynamex (US), DPD (UK), and Royal Mail (UK).
  attribute(:carrier_will_pick_up, :boolean, from: "CarrierWillPickUp")

  # @return [String]
  attribute(:carrier_will_pick_up_option, String, from: "CarrierWillPickUpOption")

  # @return [String] The seller's preferred label format.
  attribute(:label_format, String, from: "LabelFormat")
end

RejectedShippingService =

Information about a rejected shipping service

Structure.new do
  # @return [String] The rejected shipping carrier name. For example, USPS.
  attribute(:carrier_name, String, from: "CarrierName")

  # @return [String] The rejected shipping service localized name. For example, FedEx Standard Overnight.
  attribute(:shipping_service_name, String, from: "ShippingServiceName")

  # @return [String] The rejected shipping service identifier. For example, `FEDEX_PTP_STANDARD_OVERNIGHT`.
  attribute(:shipping_service_id, String, from: "ShippingServiceId")

  # @return [String] A reason code meant to be consumed programatically. For example,
  # `CARRIER_CANNOT_SHIP_TO_POBOX`.
  attribute(:rejection_reason_code, String, from: "RejectionReasonCode")

  # @return [String] A localized human readable description of the rejected reason.
  attribute(:rejection_reason_message, String, from: "RejectionReasonMessage")
end

LabelFormatOptionRequest =

Whether to include a packing slip.

Structure.new do
  # @return [:boolean] When true, include a packing slip with the label.
  attribute(:include_packing_slip_with_label, :boolean, from: "IncludePackingSlipWithLabel")
end

TemporarilyUnavailableCarrier =

A carrier who is temporarily unavailable, most likely due to a service outage experienced by the carrier.

Structure.new do
  # @return [String] The name of the carrier.
  attribute(:carrier_name, String, from: "CarrierName")
end

AvailableShippingServiceOptions =

The available shipping service options.

Structure.new do
  # @return [Array<AvailableCarrierWillPickUpOption>]
  attribute(:available_carrier_will_pick_up_options, [AvailableCarrierWillPickUpOption], from: "AvailableCarrierWillPickUpOptions")

  # @return [Array<AvailableDeliveryExperienceOption>]
  attribute(:available_delivery_experience_options, [AvailableDeliveryExperienceOption], from: "AvailableDeliveryExperienceOptions")
end

GetAdditionalSellerInputsResult =

The payload for the getAdditionalSellerInputs operation.

Structure.new do
  # @return [Array<AdditionalInputs>]
  attribute(:shipment_level_fields, [AdditionalInputs], from: "ShipmentLevelFields")

  # @return [Array<ItemLevelFields>]
  attribute(:item_level_fields_list, [ItemLevelFields], from: "ItemLevelFieldsList")
end

AvailableDeliveryExperienceOption =

The available delivery confirmation options, and the fee charged, if any.

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

  # @return [CurrencyAmount]
  attribute(:charge, CurrencyAmount, from: "Charge")
end

GetAdditionalSellerInputsRequest =

Request schema.

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

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

  # @return [String] An Amazon defined order identifier
  attribute(:order_id, String, from: "OrderId")
end

AvailableCarrierWillPickUpOption =

Indicates whether the carrier will pick up the package, and what fee is charged, if any.

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

  # @return [CurrencyAmount] The fee charged.
  attribute(:charge, CurrencyAmount, from: "Charge")
end

GetAdditionalSellerInputsResponse =

Response schema.

Structure.new do
  # @return [GetAdditionalSellerInputsResult]
  attribute(:payload, GetAdditionalSellerInputsResult)

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

GetEligibleShipmentServicesResult =

The payload for the getEligibleShipmentServices operation.

Structure.new do
  # @return [Array<ShippingService>] A list of shipping services offers.
  attribute(:shipping_service_list, [ShippingService], from: "ShippingServiceList")

  # @return [Array<RejectedShippingService>]
  attribute(:rejected_shipping_service_list, [RejectedShippingService], from: "RejectedShippingServiceList")

  # @return [Array<TemporarilyUnavailableCarrier>]
  attribute(:temporarily_unavailable_carrier_list, [TemporarilyUnavailableCarrier], from: "TemporarilyUnavailableCarrierList")

  # @return [Array<TermsAndConditionsNotAcceptedCarrier>]
  attribute(:terms_and_conditions_not_accepted_carrier_list, [TermsAndConditionsNotAcceptedCarrier], from: "TermsAndConditionsNotAcceptedCarrierList")
end

GetEligibleShipmentServicesRequest =

Request schema.

Structure.new do
  # @return [ShipmentRequestDetails] Shipment information required for requesting shipping service offers.
  attribute(:shipment_request_details, ShipmentRequestDetails, from: "ShipmentRequestDetails")

  # @return [ShippingOfferingFilter]
  attribute(:shipping_offering_filter, ShippingOfferingFilter, from: "ShippingOfferingFilter")
end

GetEligibleShipmentServicesResponse =

Response schema.

Structure.new do
  # @return [GetEligibleShipmentServicesResult]
  attribute(:payload, GetEligibleShipmentServicesResult)

  # @return [Array<Error>] One or more unexpected errors occurred during this operation.
  attribute(:errors, [Error])
end

TermsAndConditionsNotAcceptedCarrier =

A carrier whose terms and conditions have not been accepted by the seller.

Structure.new do
  # @return [String] The name of the carrier.
  attribute(:carrier_name, String, from: "CarrierName")
end