peddler 5.1.0 → 5.2.0

data/lib/peddler/apis/orders_2026_01_01/item_shipping.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+require "time"
+
+module Peddler
+  module APIs
+    class Orders20260101
+      # Information related to the shipping and delivery process for an order item.
+      ItemShipping = Structure.new do
+        # @return [ItemInternationalShipping] Additional information needed for cross-border delivery of this item.
+        attribute?(:international_shipping, ItemInternationalShipping, from: "internationalShipping")
+
+        # @return [DateTimeRange] When this item is expected to be delivered to the customer.
+        attribute?(:scheduled_delivery_window, DateTimeRange, from: "scheduledDeliveryWindow")
+
+        # @return [ItemShippingConstraints] Special shipping requirements and restrictions that apply to this item.
+        attribute?(:shipping_constraints, ItemShippingConstraints, from: "shippingConstraints")
+      end
+    end
+  end
+end

data/lib/peddler/apis/orders_2026_01_01/item_shipping_constraints.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+
+module Peddler
+  module APIs
+    class Orders20260101
+      # Special shipping requirements and restrictions that must be observed when shipping an order item.
+      ItemShippingConstraints = Structure.new do
+        # @return [String] Payment must be collected from the customer at the time of delivery.
+        attribute?(:cash_on_delivery, String, from: "cashOnDelivery")
+
+        # @return [String] The line item must be delivered by pallet.
+        attribute?(:pallet_delivery, String, from: "palletDelivery")
+
+        # @return [String] The carrier must confirm that the recipient is of the legal age to receive the line item upon
+        #   delivery.
+        attribute?(:recipient_age_verification, String, from: "recipientAgeVerification")
+
+        # @return [String] The person receiving the line item must be the same as the intended recipient of the order.
+        attribute?(:recipient_identity_verification, String, from: "recipientIdentityVerification")
+
+        # @return [String] The recipient of the line item must sign to confirm its delivery.
+        attribute?(:signature_confirmation, String, from: "signatureConfirmation")
+      end
+    end
+  end
+end

data/lib/peddler/apis/orders_2026_01_01/item_substitution_option.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+
+module Peddler
+  module APIs
+    class Orders20260101
+      # Alternative product that can be substituted for an original order item when it becomes unavailable during
+      # fulfillment.
+      ItemSubstitutionOption = Structure.new do
+        # @return [String] Amazon Standard Identification Number of the substitute product.
+        attribute?(:asin, String)
+
+        # @return [Measurement] Unit of measure and quantity specifications for the substitute product.
+        attribute?(:measurement, Measurement)
+
+        # @return [Integer] Number of units of the substitute item to be selected if substitution occurs.
+        attribute?(:quantity_ordered, Integer, from: "quantityOrdered")
+
+        # @return [String] The item's seller stock keeping unit (SKU).
+        attribute?(:seller_sku, String, from: "sellerSku")
+
+        # @return [String] Product name or title of the substitute item as displayed to customers.
+        attribute?(:title, String)
+      end
+    end
+  end
+end

data/lib/peddler/apis/orders_2026_01_01/item_substitution_preference.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+
+module Peddler
+  module APIs
+    class Orders20260101
+      # Substitution preference for an order item when it becomes unavailable during fulfillment.
+      ItemSubstitutionPreference = Structure.new do
+        # @return [String] Source and nature of the substitution preferences for this item.
+        attribute(:substitution_type, String, from: "substitutionType")
+
+        # @return [Array<ItemSubstitutionOption>] List of alternative products that can be substituted for the original
+        #   item if it becomes unavailable.
+        attribute?(:substitution_options, [ItemSubstitutionOption], from: "substitutionOptions")
+      end
+    end
+  end
+end

data/lib/peddler/apis/orders_2026_01_01/measurement.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+
+module Peddler
+  module APIs
+    class Orders20260101
+      # Specifies the unit of measure and quantity for items that are sold by weight, volume, length, or other
+      # measurements rather than simple count.
+      Measurement = Structure.new do
+        # @return [String] The specific unit of measurement used to quantify this item.
+        attribute(:unit, String)
+
+        # @return [Float] The numerical quantity or amount being measured in the specified unit.
+        attribute(:value, Float)
+      end
+    end
+  end
+end

data/lib/peddler/apis/orders_2026_01_01/merchant_address.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+
+module Peddler
+  module APIs
+    class Orders20260101
+      # The physical address of the merchant.
+      MerchantAddress = Structure.new do
+        # @return [String] The primary street address of the merchant's location.
+        attribute?(:address_line1, String, from: "addressLine1")
+
+        # @return [String] Additional address information.
+        attribute?(:address_line2, String, from: "addressLine2")
+
+        # @return [String] Additional address information.
+        attribute?(:address_line3, String, from: "addressLine3")
+
+        # @return [String] The city of the address.
+        attribute?(:city, String)
+
+        # @return [String] The two-letter country code for the address, in ISO 3166-1 format.
+        attribute?(:country_code, String, from: "countryCode")
+
+        # @return [String] The district or county of the address.
+        attribute?(:district_or_county, String, from: "districtOrCounty")
+
+        # @return [String] The municipality of the address.
+        attribute?(:municipality, String)
+
+        # @return [String] The name of the business or facility at this address.
+        attribute?(:name, String)
+
+        # @return [String] The postal code or ZIP code of the address.
+        attribute?(:postal_code, String, from: "postalCode")
+
+        # @return [String] The state, province, or region of the address.
+        attribute?(:state_or_region, String, from: "stateOrRegion")
+      end
+    end
+  end
+end

data/lib/peddler/apis/orders_2026_01_01/order.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+require "time"
+
+module Peddler
+  module APIs
+    class Orders20260101
+      # Comprehensive information about a customer order.
+      Order = Structure.new do
+        # @return [Time] The time when the customer placed the order. In [ISO
+        #   8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
+        attribute(:created_time, Time, from: "createdTime")
+
+        # @return [Time] The most recent time when any aspect of this order was modified by Amazon or the seller. In
+        #   [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
+        attribute(:last_updated_time, Time, from: "lastUpdatedTime")
+
+        # @return [String] An Amazon-defined order identifier.
+        attribute(:order_id, String, from: "orderId")
+
+        # @return [Array<OrderItem>] The list of all order items included in this order.
+        attribute(:order_items, [OrderItem], from: "orderItems")
+
+        # @return [SalesChannel] Information about where this order was placed.
+        attribute(:sales_channel, SalesChannel, from: "salesChannel")
+
+        # @return [Array<AssociatedOrder>] Other orders that have a direct relationship to this order, such as
+        #   replacement or exchange orders.
+        attribute?(:associated_orders, [AssociatedOrder], from: "associatedOrders")
+
+        # @return [Buyer] Information about the customer who purchased this order.
+        attribute?(:buyer, Buyer)
+
+        # @return [OrderFulfillment] Information about how this order is being processed and shipped.
+        attribute?(:fulfillment, OrderFulfillment)
+
+        # @return [Array<Alias>] Alternative identifiers that can be used to reference this order, such as
+        #   seller-defined order numbers.
+        attribute?(:order_aliases, [Alias], from: "orderAliases")
+
+        # @return [Array<OrderPackage>] Shipping packages created for this order, including tracking information.
+        #   **Note:** Only available for merchant-fulfilled (FBM) orders.
+        attribute?(:packages, [OrderPackage])
+
+        # @return [OrderProceeds] Financial information about this order.
+        attribute?(:proceeds, OrderProceeds)
+
+        # @return [Array<String>] Special programs associated with this order that may affect fulfillment or customer
+        #   experience.
+        #
+        # **Possible values**: `AMAZON_BAZAAR`, `AMAZON_BUSINESS`, `AMAZON_EASY_SHIP`, `AMAZON_HAUL`,
+        #   `DELIVERY_BY_AMAZON`, `FBM_SHIP_PLUS`, `IN_STORE_PICK_UP`, `PREMIUM`, `PREORDER`, `PRIME`
+        attribute?(:programs, [String])
+
+        # @return [Recipient] Information about the person or location where this order should be delivered.
+        attribute?(:recipient, Recipient)
+      end
+    end
+  end
+end

data/lib/peddler/apis/orders_2026_01_01/order_fulfillment.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+require "time"
+
+module Peddler
+  module APIs
+    class Orders20260101
+      # Information about how the order is being processed, packed, and shipped to the customer.
+      OrderFulfillment = Structure.new do
+        # @return [String] The current status of the order in the fulfillment process, from pending to handover to
+        #   carrier.
+        attribute(:fulfillment_status, String, from: "fulfillmentStatus")
+
+        # @return [DateTimeRange] The promised time period within which the order should be delivered to the customer.
+        attribute?(:deliver_by_window, DateTimeRange, from: "deliverByWindow")
+
+        # @return [String] Specifies whether Amazon or the merchant is responsible for fulfilling this order.
+        #
+        # **Possible values**: `AMAZON`, `MERCHANT`.
+        attribute?(:fulfilled_by, String, from: "fulfilledBy")
+
+        # @return [String] The category of the shipping speed option selected by the customer at checkout.
+        #
+        # **Possible values**: `EXPEDITED`, `FREE_ECONOMY`, `NEXT_DAY`, `PRIORITY`, `SAME_DAY`, `SECOND_DAY`,
+        #   `SCHEDULED`, `STANDARD`.
+        attribute?(:fulfillment_service_level, String, from: "fulfillmentServiceLevel")
+
+        # @return [DateTimeRange] The promised time period within which the order must be shipped to meet the customer's
+        #   delivery expectations.
+        attribute?(:ship_by_window, DateTimeRange, from: "shipByWindow")
+      end
+    end
+  end
+end

data/lib/peddler/apis/orders_2026_01_01/order_item.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+
+module Peddler
+  module APIs
+    class Orders20260101
+      # Information about a single product within an order.
+      OrderItem = Structure.new do
+        # @return [String] A unique identifier for this specific item within the order.
+        attribute(:order_item_id, String, from: "orderItemId")
+
+        # @return [ItemProduct] Information about the product being ordered.
+        attribute(:product, ItemProduct)
+
+        # @return [Integer] The number of units of this item that the customer ordered.
+        attribute(:quantity_ordered, Integer, from: "quantityOrdered")
+
+        # @return [ItemCancellation] The cancellation information of the order item.
+        attribute?(:cancellation, ItemCancellation)
+
+        # @return [ItemExpense] The expense information related to this specific item.
+        attribute?(:expense, ItemExpense)
+
+        # @return [ItemFulfillment] Information about how the order item should be processed, packed, and shipped to the
+        #   customer.
+        attribute?(:fulfillment, ItemFulfillment)
+
+        # @return [Measurement] The unit of measure and value for items sold by weight, volume, or other measurements
+        #   rather than simple count.
+        attribute?(:measurement, Measurement)
+
+        # @return [ItemProceeds] The money that the seller receives from the sale of this specific item.
+        attribute?(:proceeds, ItemProceeds)
+
+        # @return [Array<String>] Special programs that apply specifically to this item within the order.
+        #
+        # **Possible values**: `TRANSPARENCY`, `SUBSCRIBE_AND_SAVE`
+        attribute?(:programs, [String])
+
+        # @return [ItemPromotion] Details about any discounts, coupons, or promotional offers applied to this item.
+        attribute?(:promotion, ItemPromotion)
+      end
+    end
+  end
+end

data/lib/peddler/apis/orders_2026_01_01/order_package.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+require "time"
+
+module Peddler
+  module APIs
+    class Orders20260101
+      # Information about a physical shipping package, including tracking details. **Note:** Only available for
+      # merchant-fulfilled (FBM) orders.
+      OrderPackage = Structure.new do
+        # @return [String] A unique identifier for this package within the context of the order.
+        attribute(:package_reference_id, String, from: "packageReferenceId")
+
+        # @return [String] The carrier responsible for transporting this package to the customer.
+        attribute?(:carrier, String)
+
+        # @return [Time] The exact time when this shipping package was created and prepared for shipment. In [ISO
+        #   8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
+        attribute?(:created_time, Time, from: "createdTime")
+
+        # @return [Array<PackageItem>] A list of all order items included in this specific package.
+        attribute?(:package_items, [PackageItem], from: "packageItems")
+
+        # @return [PackageStatus] The current status of this package.
+        attribute?(:package_status, PackageStatus, from: "packageStatus")
+
+        # @return [MerchantAddress] The physical address from which this package was shipped, typically the merchant's
+        #   warehouse or fulfillment center.
+        attribute?(:ship_from_address, MerchantAddress, from: "shipFromAddress")
+
+        # @return [Time] The exact time when this package was handed over to the carrier and began its journey to the
+        #   customer. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
+        attribute?(:ship_time, Time, from: "shipTime")
+
+        # @return [String] The specific shipping method or service used for delivering this package.
+        attribute?(:shipping_service, String, from: "shippingService")
+
+        # @return [String] The carrier-provided tracking number that customers can use to monitor the package's delivery
+        #   progress.
+        attribute?(:tracking_number, String, from: "trackingNumber")
+      end
+    end
+  end
+end

data/lib/peddler/apis/orders_2026_01_01/order_proceeds.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+
+module Peddler
+  module APIs
+    class Orders20260101
+      # The money that the seller receives from the sale of the order.
+      OrderProceeds = Structure.new do
+        # @return [Money] The total amount that the seller receives from the sale of the order.
+        attribute?(:grand_total, Money, from: "grandTotal")
+      end
+    end
+  end
+end

data/lib/peddler/apis/orders_2026_01_01/package_item.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+
+module Peddler
+  module APIs
+    class Orders20260101
+      # Individual order item contained within a shipping package.
+      PackageItem = Structure.new do
+        # @return [String] Unique identifier of the order item included in this package.
+        attribute(:order_item_id, String, from: "orderItemId")
+
+        # @return [Integer] Number of units of this item included in the package shipment.
+        attribute(:quantity, Integer)
+
+        # @return [Array<String>] The transparency codes associated with this item for product authentication.
+        attribute?(:transparency_codes, [String], from: "transparencyCodes")
+      end
+    end
+  end
+end

data/lib/peddler/apis/orders_2026_01_01/package_status.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+
+module Peddler
+  module APIs
+    class Orders20260101
+      # Current status and detailed tracking information for a shipping package throughout the delivery process.
+      PackageStatus = Structure.new do
+        # @return [String] Primary status classification of the package in the shipping workflow.
+        attribute(:status, String)
+
+        # @return [String] Granular status information providing specific details about the package's current location
+        #   and handling stage.
+        #
+        # **Possible values:** - `PENDING_SCHEDULE` (Package awaiting pickup scheduling) - `PENDING_PICK_UP` (Package
+        #   ready for carrier collection from seller) - `PENDING_DROP_OFF` (Package awaiting seller delivery to carrier)
+        #   - `LABEL_CANCELLED` (Shipping label canceled by seller) - `PICKED_UP` (Package collected by carrier from
+        #   seller location) - `DROPPED_OFF` (Package delivered to carrier by seller) - `AT_ORIGIN_FC` (Package at
+        #   originating fulfillment center) - `AT_DESTINATION_FC` (Package at destination fulfillment center) -
+        #   `DELIVERED` (Package successfully delivered to recipient) - `REJECTED_BY_BUYER` (Package refused by intended
+        #   recipient) - `UNDELIVERABLE` (Package cannot be delivered due to address or access issues) -
+        #   `RETURNING_TO_SELLER` (Package in transit back to seller) - `RETURNED_TO_SELLER` (Package successfully
+        #   returned to seller) - `LOST` (Package location unknown or confirmed lost) - `OUT_FOR_DELIVERY` (Package on
+        #   delivery vehicle for final delivery) - `DAMAGED` (Package damaged during transit)
+        attribute?(:detailed_status, String, from: "detailedStatus")
+      end
+    end
+  end
+end

data/lib/peddler/apis/orders_2026_01_01/pagination.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+
+module Peddler
+  module APIs
+    class Orders20260101
+      # When a request has results that are not included in the response, pagination occurs. This means the results are
+      # divided into individual pages. To retrieve a different page, you must pass the token value as the
+      # `paginationToken` query parameter in the subsequent request. All other parameters must be provided with the same
+      # values that were provided with the request that generated this token, with the exception of `maxResultsPerPage`
+      # and `includedData`, which can be modified between calls. The token will expire after 24 hours. When there are no
+      # other pages to fetch, the `pagination` field will be absent from the response.
+      Pagination = Structure.new do
+        # @return [String] A token that can be used to fetch the next page of results.
+        attribute?(:next_token, String, from: "nextToken")
+      end
+    end
+  end
+end

data/lib/peddler/apis/orders_2026_01_01/points_granted.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+
+module Peddler
+  module APIs
+    class Orders20260101
+      # Information about Amazon Points awarded with an item purchase.
+      PointsGranted = Structure.new do
+        # @return [Money] Cash equivalent value of the awarded Amazon Points.
+        attribute?(:points_monetary_value, Money, from: "pointsMonetaryValue")
+
+        # @return [Integer] Total number of Amazon Points granted to the customer's account for this item purchase.
+        attribute?(:points_number, Integer, from: "pointsNumber")
+      end
+    end
+  end
+end

data/lib/peddler/apis/orders_2026_01_01/preferred_delivery_time.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+require "time"
+
+module Peddler
+  module APIs
+    class Orders20260101
+      # Customer-specified time preferences for when deliveries should be attempted at the destination address.
+      PreferredDeliveryTime = Structure.new do
+        # @return [Array<BusinessHour>] Business hours when the business is open for deliveries.
+        attribute?(:business_hours, [BusinessHour], from: "businessHours")
+
+        # @return [Array<ExceptionDate>] Specific dates within the next 30 days when normal business hours do not apply.
+        attribute?(:exception_dates, [ExceptionDate], from: "exceptionDates")
+      end
+    end
+  end
+end

data/lib/peddler/apis/orders_2026_01_01/recipient.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+
+module Peddler
+  module APIs
+    class Orders20260101
+      # Information about the recipient to whom the order should be delivered.
+      Recipient = Structure.new do
+        # @return [CustomerAddress] The address where the order should be delivered to the customer.
+        attribute?(:delivery_address, CustomerAddress, from: "deliveryAddress")
+
+        # @return [DeliveryPreference] Special instructions and preferences that the customer specifies for how the
+        #   order should be delivered.
+        attribute?(:delivery_preference, DeliveryPreference, from: "deliveryPreference")
+      end
+    end
+  end
+end

data/lib/peddler/apis/orders_2026_01_01/sales_channel.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+
+module Peddler
+  module APIs
+    class Orders20260101
+      # Information about where the customer placed this order.
+      SalesChannel = Structure.new do
+        # @return [String] The name of the sales platform or channel where the customer placed this order.
+        #
+        # **Possible values**: `AMAZON`, `NON_AMAZON`
+        attribute(:channel_name, String, from: "channelName")
+
+        # @return [String] The unique identifier for the specific marketplace within the sales channel where this order
+        #   was placed.
+        attribute?(:marketplace_id, String, from: "marketplaceId")
+
+        # @return [String] The human-readable name of the marketplace where this order was placed.
+        attribute?(:marketplace_name, String, from: "marketplaceName")
+      end
+    end
+  end
+end

data/lib/peddler/apis/orders_2026_01_01/search_orders_response.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+require "time"
+
+module Peddler
+  module APIs
+    class Orders20260101
+      # A list of orders.
+      SearchOrdersResponse = Structure.new do
+        # @return [Array<Order>] An array containing all orders that match the search criteria.
+        attribute(:orders, [Order])
+
+        # @return [Time] Only orders placed before the specified time are returned. The date must be in
+        #   {https://developer-docs.amazon.com/sp-api/docs/iso-8601 ISO 8601} format.
+        attribute?(:created_before, Time, from: "createdBefore")
+
+        # @return [Time] Only orders updated before the specified time are returned. The date must be in
+        #   {https://developer-docs.amazon.com/sp-api/docs/iso-8601 ISO 8601} format.
+        attribute?(:last_updated_before, Time, from: "lastUpdatedBefore")
+
+        # @return [Pagination] When a request has results that are not included in the response, pagination occurs. This
+        #   means the results are divided into individual pages. To retrieve a different page, you must pass the token
+        #   value as the `paginationToken` query parameter in the subsequent request. All other parameters must be
+        #   provided with the same values that were provided with the request that generated this token, with the
+        #   exception of `maxResultsPerPage` and `includedData`, which can be modified between calls. The token will
+        #   expire after 24 hours. When there are no other pages to fetch, the `pagination` field will be absent from
+        #   the response.
+        attribute?(:pagination, Pagination)
+      end
+    end
+  end
+end

data/lib/peddler/apis/orders_2026_01_01/time_window.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+
+module Peddler
+  module APIs
+    class Orders20260101
+      # Specific time interval defining the start and end times.
+      TimeWindow = Structure.new do
+        # @return [HourMinute] The end of the time window.
+        attribute?(:end_time, HourMinute, from: "endTime")
+
+        # @return [HourMinute] The beginning of the time window.
+        attribute?(:start_time, HourMinute, from: "startTime")
+      end
+    end
+  end
+end