Module: Peddler::Types::EasyShip20220323

Defined in:

lib/peddler/types/easy_ship_2022_03_23/item.rb,
lib/peddler/types/easy_ship_2022_03_23/error.rb,
lib/peddler/types/easy_ship_2022_03_23/weight.rb,
lib/peddler/types/easy_ship_2022_03_23/package.rb,
lib/peddler/types/easy_ship_2022_03_23/packages.rb,
lib/peddler/types/easy_ship_2022_03_23/time_slot.rb,
lib/peddler/types/easy_ship_2022_03_23/dimensions.rb,
lib/peddler/types/easy_ship_2022_03_23/error_list.rb,
lib/peddler/types/easy_ship_2022_03_23/invoice_data.rb,
lib/peddler/types/easy_ship_2022_03_23/rejected_order.rb,
lib/peddler/types/easy_ship_2022_03_23/package_details.rb,
lib/peddler/types/easy_ship_2022_03_23/tracking_details.rb,
lib/peddler/types/easy_ship_2022_03_23/scheduled_package_id.rb,
lib/peddler/types/easy_ship_2022_03_23/order_schedule_details.rb,
lib/peddler/types/easy_ship_2022_03_23/update_package_details.rb,
lib/peddler/types/easy_ship_2022_03_23/list_handover_slots_request.rb,
lib/peddler/types/easy_ship_2022_03_23/list_handover_slots_response.rb,
lib/peddler/types/easy_ship_2022_03_23/create_scheduled_package_request.rb,
lib/peddler/types/easy_ship_2022_03_23/create_scheduled_packages_request.rb,
lib/peddler/types/easy_ship_2022_03_23/update_scheduled_packages_request.rb,
lib/peddler/types/easy_ship_2022_03_23/create_scheduled_packages_response.rb

Constant Summary

Item =

Item identifier and serial number information.

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

  # @return [Array<OrderItemSerialNumber>]
  attribute(:order_item_serial_numbers, Array, from: "orderItemSerialNumbers")
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.
  attribute(:message, String)

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

Weight =

The weight of the scheduled package

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

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

Package =

This object contains all the details of the scheduled Easy Ship package.

Structure.new do
  # @return [ScheduledPackageId]
  attribute(:scheduled_package_id, ScheduledPackageId, from: "scheduledPackageId")

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

  # @return [Weight]
  attribute(:package_weight, Weight, from: "packageWeight")

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

  # @return [TimeSlot]
  attribute(:package_time_slot, TimeSlot, from: "packageTimeSlot")

  # @return [String]
  attribute(:package_identifier, String, from: "packageIdentifier")

  # @return [InvoiceData]
  attribute(:invoice, InvoiceData)

  # @return [String]
  attribute(:package_status, String, from: "packageStatus")

  # @return [TrackingDetails]
  attribute(:tracking_details, TrackingDetails, from: "trackingDetails")
end

Packages =

A list of packages.

Structure.new do
  # @return [Array<Package>] A list of packages.
  attribute(:packages, [Package])
end

TimeSlot =

A time window to hand over an Easy Ship package to Amazon Logistics.

Structure.new do
  # @return [String] An Amazon-defined identifier for a time slot.
  attribute(:slot_id, String, from: "slotId")

  # @return [String] The start date and time of the time slot.
  attribute(:start_time, String, from: "startTime")

  # @return [String] The end date and time of the time slot.
  attribute(:end_time, String, from: "endTime")

  # @return [String] The method by which a seller will hand a package over to Amazon Logistics.
  attribute(:handover_method, String, from: "handoverMethod")
end

Dimensions =

The dimensions of the scheduled package.

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

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

  # @return [Float] The height dimension.
  attribute(:height, Float)

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

  # @return [String] Identifier for custom package dimensions.
  attribute(:identifier, String)
end

ErrorList =

A list of error responses returned when a request is unsuccessful.

Structure.new do
  # @return [Array<Error>] A list of error responses returned when a request is unsuccessful.
  attribute(:errors, [Error])
end

InvoiceData =

Invoice number and date.

Structure.new do
  # @return [String] The invoice number.
  attribute(:invoice_number, String, from: "invoiceNumber")

  # @return [String] The date that the invoice was generated.
  attribute(:invoice_date, String, from: "invoiceDate")
end

RejectedOrder =

A order which we couldn't schedule on your behalf. It contains its id, and information on the error.

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

  # @return [Error]
  attribute(:error, Error)
end

PackageDetails =

Package details. Includes packageItems, packageTimeSlot, and packageIdentifier.

Structure.new do
  # @return [Array<Item>]
  attribute(:package_items, [Item], from: "packageItems")

  # @return [TimeSlot]
  attribute(:package_time_slot, TimeSlot, from: "packageTimeSlot")

  # @return [String]
  attribute(:package_identifier, String, from: "packageIdentifier")
end

TrackingDetails =

Representation of tracking metadata.

Structure.new do
  # @return [String] The tracking identifier for the scheduled package.
  attribute(:tracking_id, String, from: "trackingId")
end

ScheduledPackageId =

Identifies the scheduled package to be updated.

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

  # @return [String]
  attribute(:package_id, String, from: "packageId")
end

OrderScheduleDetails =

This object allows users to specify an order to be scheduled. Only the amazonOrderId is required.

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

  # @return [PackageDetails]
  attribute(:package_details, PackageDetails, from: "packageDetails")
end

UpdatePackageDetails =

Request to update the time slot of a package.

Structure.new do
  # @return [ScheduledPackageId]
  attribute(:scheduled_package_id, ScheduledPackageId, from: "scheduledPackageId")

  # @return [TimeSlot]
  attribute(:package_time_slot, TimeSlot, from: "packageTimeSlot")
end

ListHandoverSlotsRequest =

The request schema for the listHandoverSlots operation.

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

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

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

  # @return [Weight]
  attribute(:package_weight, Weight, from: "packageWeight")
end

ListHandoverSlotsResponse =

The response schema for the listHandoverSlots operation.

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

  # @return [Array<TimeSlot>]
  attribute(:time_slots, [TimeSlot], from: "timeSlots")
end

CreateScheduledPackageRequest =

The request schema for the createScheduledPackage operation.

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

  # @return [String]
  attribute(:marketplace_id, String, from: "marketplaceId")

  # @return [PackageDetails]
  attribute(:package_details, PackageDetails, from: "packageDetails")
end

CreateScheduledPackagesRequest =

The request body for the POST /easyShip/2022-03-23/packages/bulk API.

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

  # @return [Array<OrderScheduleDetails>] An array allowing users to specify orders to be scheduled.
  attribute(:order_schedule_details_list, [OrderScheduleDetails], from: "orderScheduleDetailsList")

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

UpdateScheduledPackagesRequest =

The request schema for the updateScheduledPackages operation.

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

  # @return [Array<UpdatePackageDetails>]
  attribute(:update_package_details_list, [UpdatePackageDetails], from: "updatePackageDetailsList")
end

CreateScheduledPackagesResponse =

The response schema for the bulk scheduling API. It returns by the bulk scheduling API containing an array of the scheduled packtages, an optional list of orders we couldn't schedule with the reason, and a pre-signed URL for a ZIP file containing the associated shipping labels plus the documents enabled for your marketplace.

Structure.new do
  # @return [Array<Package>] A list of packages. Refer to the `Package` object.
  attribute(:scheduled_packages, [Package], from: "scheduledPackages")

  # @return [Array<RejectedOrder>] A list of orders we couldn't scheduled on your behalf. Each element contains
  # the reason and details on the error.
  attribute(:rejected_orders, [RejectedOrder], from: "rejectedOrders")

  # @return [String]
  attribute(:printable_documents_url, String, from: "printableDocumentsUrl")
end