Module: Peddler::Types::ShippingV1

Defined in:

lib/peddler/types/shipping_v1/rate.rb,
lib/peddler/types/shipping_v1/error.rb,
lib/peddler/types/shipping_v1/event.rb,
lib/peddler/types/shipping_v1/label.rb,
lib/peddler/types/shipping_v1/party.rb,
lib/peddler/types/shipping_v1/weight.rb,
lib/peddler/types/shipping_v1/account.rb,
lib/peddler/types/shipping_v1/address.rb,
lib/peddler/types/shipping_v1/currency.rb,
lib/peddler/types/shipping_v1/location.rb,
lib/peddler/types/shipping_v1/shipment.rb,
lib/peddler/types/shipping_v1/container.rb,
lib/peddler/types/shipping_v1/dimensions.rb,
lib/peddler/types/shipping_v1/time_range.rb,
lib/peddler/types/shipping_v1/label_result.rb,
lib/peddler/types/shipping_v1/service_rate.rb,
lib/peddler/types/shipping_v1/accepted_rate.rb,
lib/peddler/types/shipping_v1/container_item.rb,
lib/peddler/types/shipping_v1/get_rates_result.rb,
lib/peddler/types/shipping_v1/tracking_summary.rb,
lib/peddler/types/shipping_v1/get_rates_request.rb,
lib/peddler/types/shipping_v1/get_rates_response.rb,
lib/peddler/types/shipping_v1/label_specification.rb,
lib/peddler/types/shipping_v1/get_account_response.rb,
lib/peddler/types/shipping_v1/shipping_promise_set.rb,
lib/peddler/types/shipping_v1/tracking_information.rb,
lib/peddler/types/shipping_v1/get_shipment_response.rb,
lib/peddler/types/shipping_v1/create_shipment_result.rb,
lib/peddler/types/shipping_v1/purchase_labels_result.rb,
lib/peddler/types/shipping_v1/container_specification.rb,
lib/peddler/types/shipping_v1/create_shipment_request.rb,
lib/peddler/types/shipping_v1/purchase_labels_request.rb,
lib/peddler/types/shipping_v1/cancel_shipment_response.rb,
lib/peddler/types/shipping_v1/create_shipment_response.rb,
lib/peddler/types/shipping_v1/purchase_labels_response.rb,
lib/peddler/types/shipping_v1/purchase_shipment_result.rb,
lib/peddler/types/shipping_v1/purchase_shipment_request.rb,
lib/peddler/types/shipping_v1/purchase_shipment_response.rb,
lib/peddler/types/shipping_v1/retrieve_shipping_label_result.rb,
lib/peddler/types/shipping_v1/retrieve_shipping_label_request.rb,
lib/peddler/types/shipping_v1/retrieve_shipping_label_response.rb,
lib/peddler/types/shipping_v1/get_tracking_information_response.rb

Constant Summary

Rate =

The available rate that can be used to send the shipment

Structure.new do
  # @return [String] An identifier for the rate.
  attribute(:rate_id, String, from: "rateId")

  # @return [Currency] The total charge that will be billed for the rate.
  attribute(:total_charge, Currency, from: "totalCharge")

  # @return [Weight] The weight that was used to calculate the totalCharge.
  attribute(:billed_weight, Weight, from: "billedWeight")

  # @return [String] The time after which the offering will expire.
  attribute(:expiration_time, String, from: "expirationTime")

  # @return [String]
  attribute(:service_type, String, from: "serviceType")

  # @return [ShippingPromiseSet]
  attribute(:promise, ShippingPromiseSet)
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

Event =

An event of a shipment

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

  # @return [String] The date and time of an event for a shipment.
  attribute(:event_time, String, from: "eventTime")

  # @return [Location]
  attribute(:location, Location)
end

Label =

The label details of the container.

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

  # @return [LabelSpecification]
  attribute(:label_specification, LabelSpecification, from: "labelSpecification")
end

Party =

The account related with the shipment.

Structure.new do
  # @return [String]
  attribute(:account_id, String, from: "accountId")
end

Weight =

The weight.

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

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

Account =

The account related data.

Structure.new do
  # @return [String]
  attribute(:account_id, String, from: "accountId")
end

Address =

The address.

Structure.new do
  # @return [String] The name of the person, business or institution at that address.
  attribute(:name, String)

  # @return [String] First line of that address.
  attribute(:address_line1, String, from: "addressLine1")

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

  # @return [String] Additional address information, if required.
  attribute(:address_line3, String, from: "addressLine3")

  # @return [String]
  attribute(:state_or_region, String, from: "stateOrRegion")

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

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

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

  # @return [String] The email address of the contact associated with the address.
  attribute(:email, String)

  # @return [Array<String>] The email cc addresses of the contact associated with the address.
  attribute(:copy_emails, [String], from: "copyEmails")

  # @return [String] The phone number of the person, business or institution located at that address.
  attribute(:phone_number, String, from: "phoneNumber")
end

Currency =

The total value of all items in the container.

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

  # @return [String] A 3-character currency code.
  attribute(:unit, String)
end

Location =

The location where the person, business or institution is located.

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

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

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

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

Shipment =

The shipment related data.

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

  # @return [String]
  attribute(:client_reference_id, String, from: "clientReferenceId")

  # @return [Address]
  attribute(:ship_from, Address, from: "shipFrom")

  # @return [Address]
  attribute(:ship_to, Address, from: "shipTo")

  # @return [AcceptedRate]
  attribute(:accepted_rate, AcceptedRate, from: "acceptedRate")

  # @return [Party]
  attribute(:shipper, Party)

  # @return [Array<Container>]
  attribute(:containers, [Container])
end

Container =

Container in the shipment.

Structure.new do
  # @return [String] The type of physical container being used. (always 'PACKAGE')
  attribute(:container_type, String, from: "containerType")

  # @return [String]
  attribute(:container_reference_id, String, from: "containerReferenceId")

  # @return [Currency] The total value of all items in the container.
  attribute(:value, Currency)

  # @return [Dimensions] The length, width, height, and weight of the container.
  attribute(:dimensions, Dimensions)

  # @return [Array<ContainerItem>] A list of the items in the container.
  attribute(:items, [ContainerItem])

  # @return [Weight] The weight of the container.
  attribute(:weight, Weight)
end

Dimensions =

A set of measurements for a three-dimensional object.

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

  # @return [Float] The width of the container.
  attribute(:width, Float)

  # @return [Float] The height of the container.
  attribute(:height, Float)

  # @return [String] The unit of these measurements.
  attribute(:unit, String)
end

TimeRange =

The time range.

Structure.new do
  # @return [String] The start date and time. This defaults to the current date and time.
  attribute(:start, String)

  # @return [String] The end date and time. This must come after the value of start. This defaults to the next
  # business day from the start.
  attribute(:end, String)
end

LabelResult =

Label details including label stream, format, size.

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

  # @return [String] The tracking identifier assigned to the container.
  attribute(:tracking_id, String, from: "trackingId")

  # @return [Label]
  attribute(:label, Label)
end

ServiceRate =

The specific rate for a shipping service, or null if no service available.

Structure.new do
  # @return [Currency] The total charge that will be billed for the rate.
  attribute(:total_charge, Currency, from: "totalCharge")

  # @return [Weight] The weight that was used to calculate the totalCharge.
  attribute(:billable_weight, Weight, from: "billableWeight")

  # @return [String]
  attribute(:service_type, String, from: "serviceType")

  # @return [ShippingPromiseSet]
  attribute(:promise, ShippingPromiseSet)
end

AcceptedRate =

The specific rate purchased for the shipment, or null if unpurchased.

Structure.new do
  # @return [Currency] The total charge that will be billed for the rate.
  attribute(:total_charge, Currency, from: "totalCharge")

  # @return [Weight] The weight that was used to calculate the totalCharge.
  attribute(:billed_weight, Weight, from: "billedWeight")

  # @return [String]
  attribute(:service_type, String, from: "serviceType")

  # @return [ShippingPromiseSet]
  attribute(:promise, ShippingPromiseSet)
end

ContainerItem =

Item in the container.

Structure.new do
  # @return [Float] The quantity of the items of this type in the container.
  attribute(:quantity, Float)

  # @return [Currency] The unit price of an item of this type (the total value of this item type in the container
  # is unitPrice x quantity).
  attribute(:unit_price, Currency, from: "unitPrice")

  # @return [Weight] The unit weight of an item of this type (the total weight of this item type in the container
  # is unitWeight x quantity).
  attribute(:unit_weight, Weight, from: "unitWeight")

  # @return [String] A descriptive title of the item.
  attribute(:title, String)
end

GetRatesResult =

The payload schema for the getRates operation.

Structure.new do
  # @return [Array<ServiceRate>]
  attribute(:service_rates, [ServiceRate], from: "serviceRates")
end

TrackingSummary =

The tracking summary.

Structure.new do
  # @return [String] The derived status based on the events in the eventHistory.
  attribute(:status, String)
end

GetRatesRequest =

The payload schema for the getRates operation.

Structure.new do
  # @return [Address]
  attribute(:ship_to, Address, from: "shipTo")

  # @return [Address]
  attribute(:ship_from, Address, from: "shipFrom")

  # @return [Array<ServiceType>]
  attribute(:service_types, Array, from: "serviceTypes")

  # @return [String] The start date and time. This defaults to the current date and time.
  attribute(:ship_date, String, from: "shipDate")

  # @return [Array<ContainerSpecification>]
  attribute(:container_specifications, [ContainerSpecification], from: "containerSpecifications")
end

GetRatesResponse =

The response schema for the getRates operation.

Structure.new do
  # @return [GetRatesResult] The payload for getRates operation
  attribute(:payload, GetRatesResult)

  # @return [Array<Error>] Encountered errors for the operation.
  attribute(:errors, [Error])
end

LabelSpecification =

The label specification info.

Structure.new do
  # @return [String] The format of the label. Enum of PNG only for now.
  attribute(:label_format, String, from: "labelFormat")

  # @return [String] The label stock size specification in length and height. Enum of 4x6 only for now.
  attribute(:label_stock_size, String, from: "labelStockSize")
end

GetAccountResponse =

The response schema for the getAccount operation.

Structure.new do
  # @return [Account] The payload for getAccount operation
  attribute(:payload, Account)

  # @return [Array<Error>] Encountered errors for the operation.
  attribute(:errors, [Error])
end

ShippingPromiseSet =

The promised delivery time and pickup time.

Structure.new do
  # @return [TimeRange] The time window in which the shipment will be delivered.
  attribute(:delivery_window, TimeRange, from: "deliveryWindow")

  # @return [TimeRange] The time window in which Amazon Shipping will pick up the shipment.
  attribute(:receive_window, TimeRange, from: "receiveWindow")
end

TrackingInformation =

The payload schema for the getTrackingInformation operation.

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

  # @return [TrackingSummary]
  attribute(:summary, TrackingSummary)

  # @return [String]
  attribute(:promised_delivery_date, String, from: "promisedDeliveryDate")

  # @return [Array<Event>]
  attribute(:event_history, [Event], from: "eventHistory")
end

GetShipmentResponse =

The response schema for the getShipment operation.

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

  # @return [Array<Error>] Encountered errors for the operation.
  attribute(:errors, [Error])
end

CreateShipmentResult =

The payload schema for the createShipment operation.

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

  # @return [Array<Rate>]
  attribute(:eligible_rates, [Rate], from: "eligibleRates")
end

PurchaseLabelsResult =

The payload schema for the purchaseLabels operation.

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

  # @return [String]
  attribute(:client_reference_id, String, from: "clientReferenceId")

  # @return [AcceptedRate]
  attribute(:accepted_rate, AcceptedRate, from: "acceptedRate")

  # @return [Array<LabelResult>]
  attribute(:label_results, [LabelResult], from: "labelResults")
end

ContainerSpecification =

Container specification for checking the service rate.

Structure.new do
  # @return [Dimensions] The length, width, and height of the container.
  attribute(:dimensions, Dimensions)

  # @return [Weight] The weight of the container.
  attribute(:weight, Weight)
end

CreateShipmentRequest =

The request schema for the createShipment operation.

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

  # @return [Address]
  attribute(:ship_to, Address, from: "shipTo")

  # @return [Address]
  attribute(:ship_from, Address, from: "shipFrom")

  # @return [Array<Container>]
  attribute(:containers, [Container])
end

PurchaseLabelsRequest =

The request schema for the purchaseLabels operation.

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

  # @return [LabelSpecification]
  attribute(:label_specification, LabelSpecification, from: "labelSpecification")
end

CancelShipmentResponse =

The response schema for the cancelShipment operation.

Structure.new do
  # @return [Array<Error>] Encountered errors for the operation.
  attribute(:errors, [Error])
end

CreateShipmentResponse =

The response schema for the createShipment operation.

Structure.new do
  # @return [CreateShipmentResult] The payload for createShipment operation
  attribute(:payload, CreateShipmentResult)

  # @return [Array<Error>] Encountered errors for the operation.
  attribute(:errors, [Error])
end

PurchaseLabelsResponse =

The response schema for the purchaseLabels operation.

Structure.new do
  # @return [PurchaseLabelsResult] The payload for purchaseLabels operation
  attribute(:payload, PurchaseLabelsResult)

  # @return [Array<Error>] Encountered errors for the operation.
  attribute(:errors, [Error])
end

PurchaseShipmentResult =

The payload schema for the purchaseShipment operation.

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

  # @return [ServiceRate]
  attribute(:service_rate, ServiceRate, from: "serviceRate")

  # @return [Array<LabelResult>]
  attribute(:label_results, [LabelResult], from: "labelResults")
end

PurchaseShipmentRequest =

The payload schema for the purchaseShipment operation.

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

  # @return [Address]
  attribute(:ship_to, Address, from: "shipTo")

  # @return [Address]
  attribute(:ship_from, Address, from: "shipFrom")

  # @return [String] The start date and time. This defaults to the current date and time.
  attribute(:ship_date, String, from: "shipDate")

  # @return [String]
  attribute(:service_type, String, from: "serviceType")

  # @return [Array<Container>]
  attribute(:containers, [Container])

  # @return [LabelSpecification]
  attribute(:label_specification, LabelSpecification, from: "labelSpecification")
end

PurchaseShipmentResponse =

The response schema for the purchaseShipment operation.

Structure.new do
  # @return [PurchaseShipmentResult] The payload for purchaseShipment operation
  attribute(:payload, PurchaseShipmentResult)

  # @return [Array<Error>] Encountered errors for the operation.
  attribute(:errors, [Error])
end

RetrieveShippingLabelResult =

The payload schema for the retrieveShippingLabel operation.

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

  # @return [LabelSpecification]
  attribute(:label_specification, LabelSpecification, from: "labelSpecification")
end

RetrieveShippingLabelRequest =

The request schema for the retrieveShippingLabel operation.

Structure.new do
  # @return [LabelSpecification]
  attribute(:label_specification, LabelSpecification, from: "labelSpecification")
end

RetrieveShippingLabelResponse =

The response schema for the retrieveShippingLabel operation.

Structure.new do
  # @return [RetrieveShippingLabelResult] The payload for retrieveShippingLabel operation
  attribute(:payload, RetrieveShippingLabelResult)

  # @return [Array<Error>] Encountered errors for the operation.
  attribute(:errors, [Error])
end

GetTrackingInformationResponse =

The response schema for the getTrackingInformation operation.

Structure.new do
  # @return [TrackingInformation] The payload for getTrackingInformation operation
  attribute(:payload, TrackingInformation)

  # @return [Array<Error>] Encountered errors for the operation.
  attribute(:errors, [Error])
end