peddler 5.3.1 → 5.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39a668305211189b981586a66d71362c7f641c50f6ccacf3a28172a4abb8e696
-  data.tar.gz: 68366d3f5f419c79062854e75d00ac37dfcb82098fa5660d17f56a60ebb893d2
+  metadata.gz: dfaa728f0b1fe2e6c63402f3bc188b58f9b6d2d35177666a48f2dcf36420e353
+  data.tar.gz: 80d2163af9c60fdd65feaa9d4b9d24d3c5e4babc4d6386228ed03f8ac9851bcf
 SHA512:
-  metadata.gz: dec0fa29e3b3a30a23ba120145c5baa6c98ef90b105727fba91daab9ae621393d3ab9f15aa515b2e25ed4f4c332c503b3429781d5ba1e7d0c6f425416318ce8b
-  data.tar.gz: f729c59ad31e1cc10fdb782cdccc1c749e7f7ad62b587d4beb31054569517bb185329f0d0e2f46d604543fe7e4436c5ed81bea931dec53e7d7d2acc34696f2d9
+  metadata.gz: 73ecd6efcc89cf60e4565e5d13e39c96240a8bf1e2a08e7f88eeb1ed5f72f65ed63c18a7d2f300727c09adb430a05cea4b110b22ad0e98fd73c20cb4404d4a9e
+  data.tar.gz: d1c8d6b7d388b26110edc1326fa1907e7ad696d79d8f9a7acfea37d7df739fbc6ddd6908933496e7734dded1725553fcc417be22491ed8bace4b887463169567

data/README.md

@@ -1,29 +1,31 @@
 # Peddler
 
-[![Build](https://github.com/lineofflight/peddler/actions/workflows/ci.yml/badge.svg)][build]
-
 Peddler is a Ruby interface to the [Amazon Selling Partner API (SP-API)][api-docs]. The SP-API enables Amazon sellers and vendors to programmatically access their data on orders, shipments, payments, and more.
 
-Peddler is automatically generated from the latest Open API models provided by Amazon.
+Peddler is automatically generated from the latest Open API models provided by Amazon. A nightly job tracks Amazon's spec changes, so new endpoints and fields land shortly after Amazon publishes them. Model changes are not considered breaking and don't trigger a major version bump.
 
 Peddler covers all SP-API endpoints, reports, notifications, and feeds. It's also lightweight: thanks to Zeitwerk, only the code you use gets loaded.
 
-To begin using the Amazon SP-API, you must [register as a developer][register-as-developer] and [register your application][register-application]. Once registered, [obtain your Login with Amazon (LWA) credentials][view-credentials] to access your own or other selling partners' data.
-
-- [API docs][api-docs]
-- [OpenAPI models][openapi-models]
-- [API samples][api-samples]
-
 <img src="https://github.com/hakanensari/peddler/blob/main/images/peddler.jpg?raw=true" alt="Peddler" style="max-width: 830px" />
 
 ## Installation
 
 Add to your Gemfile.
 
+### Agent skill
+
+If you use an agent, install the SP-API skill:
+
+```shell
+npx skills add lineofflight/peddler
+```
+
 ## Usage
 
 ### Authorization
 
+Before using Peddler, you must [register as a developer][register-as-developer], [register your application][register-application], and [obtain your Login with Amazon (LWA) credentials][view-credentials]; Amazon's [official SP-API code samples][api-samples] can help you get started.
+
 Set your LWA credentials in your environment.
 
 ```shell
@@ -85,6 +87,48 @@ class Seller
 end
 ```
 
+### Restricted Data Tokens (RDT) and PII
+
+Some operations are restricted because they return Personally Identifiable Information (PII), such as a buyer's name and shipping address. To call one, exchange your access token for a Restricted Data Token (RDT) scoped to the specific resources you need, then pass the RDT in place of the access token.
+
+```ruby
+api = Peddler.tokens.new(aws_region, access_token)
+response = api.create_restricted_data_token({
+  "restrictedResources" => [
+    {
+      "method" => "GET",
+      "path" => "/orders/v0/orders/123-1234567-1234567/address",
+    },
+  ],
+})
+restricted_data_token = response.parse.restricted_data_token
+```
+
+Use the RDT exactly where you would normally pass the access token.
+
+```ruby
+api = Peddler.orders.new(aws_region, restricted_data_token)
+address = api.get_order_address("123-1234567-1234567").parse.payload.shipping_address
+```
+
+For the Orders API, also specify which `dataElements` you need (`buyerInfo`, `shippingAddress`, or `buyerTaxInformation`).
+
+```ruby
+api = Peddler.tokens.new(aws_region, access_token)
+response = api.create_restricted_data_token({
+  "restrictedResources" => [
+    {
+      "method" => "GET",
+      "path" => "/orders/v0/orders",
+      "dataElements" => ["buyerInfo", "shippingAddress"],
+    },
+  ],
+})
+restricted_data_token = response.parse.restricted_data_token
+```
+
+An RDT is valid for one hour. Like access tokens, cache and reuse it across calls. See the [Tokens API Use Case Guide][tokens-guide] for the full list of restricted operations.
+
 ### Rate limiting
 
 Amazon's SP-API imposes [rate limits][rate-limits] on operations. Override the default value by passing a `:rate_limit` parameter when calling an operation.
@@ -153,6 +197,21 @@ rescue Peddler::Error => e
 end
 ```
 
+#### Rescuing Specific Errors
+
+Peddler raises specific pre-defined subclasses for common Amazon error codes (e.g., `Peddler::Errors::QuotaExceeded`, `Peddler::Errors::NotFound`, `Peddler::Errors::InvalidInput`).
+
+If Amazon returns an undocumented or newly introduced error code, Peddler dynamically instantiates a matching subclass under the `Peddler::Errors` namespace at runtime. To rescue a new specific subclass without causing a boot-time `NameError` in your application, define the class beforehand in an initializer:
+
+```ruby
+# config/initializers/peddler_errors.rb
+module Peddler
+  module Errors
+    class NewAmazonErrorCode < Error; end
+  end
+end
+```
+
 ### Available APIs
 
 Peddler provides Ruby interfaces to all Amazon SP-API endpoints. Each API is available in its respective version. Access APIs by calling methods on the Peddler module:
@@ -290,6 +349,10 @@ For complete method signatures, see [sig/peddler/apis/](sig/peddler/apis/)
 
 For a complete list of available APIs and their detailed documentation, refer to the [API models repository][openapi-models].
 
+## Best practices
+
+Writing efficient SP-API code? See the [best-practices checklist](skills/sp-api-ruby/best-practices.md) bundled with the agent skill: cutting call volume, batching, caching, API versions, reports, and per-API quirks.
+
 ## Development
 
 ```bash
@@ -309,8 +372,7 @@ bundle exec rake generate
 # Type check with Steep
 bundle exec steep check --severity-level=hint
 ```
-[build]: https://github.com/lineofflight/peddler/actions
-[api-docs]: https://developer.amazonservices.com/sp-api-docs/overview
+[api-docs]: https://developer-docs.amazon.com/sp-api/docs/welcome
 [register-as-developer]: https://developer-docs.amazon.com/sp-api/docs/registering-as-a-developer
 [register-application]: https://developer-docs.amazon.com/sp-api/docs/registering-your-application
 [openapi-models]: https://github.com/amzn/selling-partner-api-models
@@ -318,4 +380,5 @@ bundle exec steep check --severity-level=hint
 [view-credentials]: https://developer-docs.amazon.com/sp-api/docs/viewing-your-application-information-and-credentials
 [authorization]: https://developer-docs.amazon.com/sp-api/docs/authorizing-selling-partner-api-applications
 [rate-limits]: https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits
+[tokens-guide]: https://developer-docs.amazon.com/sp-api/docs/tokens-api-use-case-guide
 [httprb]: https://github.com/httprb/http

data/lib/peddler/api.rb

@@ -9,6 +9,8 @@ module Peddler
     class CannotSandbox < StandardError; end
     class MustSandbox < StandardError; end
 
+    TRANSIENT_STATUSES = [429, 500, 502, 503, 504].freeze
+
     # @return [Peddler::Endpoint]
     attr_reader :endpoint
 
@@ -24,7 +26,7 @@ module Peddler
     # @param [String] access_token The access token for authentication
     # @param [Integer] retries The number of retries if throttled (default: 0)
     # @param [HTTP::Client] http HTTP client
-    def initialize(aws_region, access_token, retries: 0, http: HTTP)
+    def initialize(aws_region, access_token, retries: 0, http: HTTP::Client.new)
       @endpoint = Endpoint.find(aws_region)
       @access_token = access_token
       @retries = retries
@@ -53,7 +55,7 @@ module Peddler
 
     # @see https://developer-docs.amazon.com/sp-api/docs/include-a-user-agent-header-in-all-requests
     # @see https://developer-docs.amazon.com/amazon-shipping/docs/connecting-to-the-selling-partner-api#step-3-add-headers-to-the-uri
-    # @return [HTTP::Client]
+    # @return [HTTP::Session]
     def http(rate_limit: nil)
       client = @http.headers(
         "Host" => endpoint_uri.host,
@@ -62,10 +64,32 @@ module Peddler
         "X-Amz-Date" => timestamp,
       )
 
-      return client if retries.zero? || rate_limit.nil?
-
-      delay = sandbox? ? 0.2 : 1.0 / rate_limit
-      client.retriable(delay:, tries: retries + 1, retry_statuses: [429]) # steep:ignore NoMethod
+      return client if retries.zero?
+
+      on_retry = ->(_req, _err, res) {
+        Thread.current[:peddler_last_retry_status] = res&.status
+      }
+
+      delay = ->(iteration) {
+        last_status = Thread.current[:peddler_last_retry_status]
+
+        if last_status == 429 && rate_limit
+          # Rate-limit-aware exponential backoff with jitter if throttled
+          # @see https://aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/
+          initial_delay = sandbox? ? 0.2 : 1.0 / rate_limit
+          (initial_delay * (2.0**(iteration - 1))) + (rand * 0.1)
+        else
+          # Standard backoff for network errors and 5xx
+          (2.0**(iteration - 1)) - 1 + rand
+        end
+      }
+
+      client.retriable(
+        tries: retries + 1,
+        delay: delay,
+        on_retry: on_retry,
+        retry_statuses: TRANSIENT_STATUSES,
+      )
     end
 
     private

data/lib/peddler/apis/amazon_warehousing_and_distribution_2024_05_09/order_attribute.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+
+module Peddler
+  module APIs
+    class AmazonWarehousingAndDistribution20240509
+      # Consists of the order preference and corresponding preference value.
+      OrderAttribute = Structure.new do
+        # @return [String] Preference for the distribution order.
+        attribute(:order_preference, String, null: false, from: "orderPreference")
+
+        # @return [String] Value for the order preference.
+        attribute(:order_preference_value, String, null: false, from: "orderPreferenceValue")
+      end
+    end
+  end
+end

data/lib/peddler/apis/amazon_warehousing_and_distribution_2024_05_09/outbound_execution_error.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+
+module Peddler
+  module APIs
+    class AmazonWarehousingAndDistribution20240509
+      # Execution errors associated with the outbound order. This field will be populated if the order failed
+      # validation.
+      OutboundExecutionError = Structure.new do
+        # @return [String] Failure code details for the error.
+        attribute(:failure_code, String, null: false, from: "failureCode")
+
+        # @return [Array<String>] Failure reasons for the error.
+        attribute(:failure_reasons, [String], null: false, from: "failureReasons")
+
+        # @return [String] MSKU associated with the error.
+        attribute?(:sku, String)
+      end
+    end
+  end
+end

data/lib/peddler/apis/amazon_warehousing_and_distribution_2024_05_09/outbound_listing.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+
+module Peddler
+  module APIs
+    class AmazonWarehousingAndDistribution20240509
+      # A list of paginated outbound orders filtered by the attributes passed in the request.
+      OutboundListing = Structure.new do
+        # @return [String] TA token that is used to retrieve the next page of results. The response includes `nextToken`
+        #   when the number of results exceeds the specified `maxResults` value. To get the next page of results, call
+        #   the operation with this token and include the same arguments as the call that produced the token. To get a
+        #   complete list, call this operation until `nextToken` is null. Note that this operation can return empty
+        #   pages.
+        attribute?(:next_token, String, from: "nextToken")
+
+        # @return [Array<OutboundOrder>] List of outbound orders.
+        attribute?(:outbound_orders, [OutboundOrder], from: "outboundOrders")
+      end
+    end
+  end
+end

data/lib/peddler/apis/amazon_warehousing_and_distribution_2024_05_09/outbound_order.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+require "time"
+
+module Peddler
+  module APIs
+    class AmazonWarehousingAndDistribution20240509
+      # Represents an AWD outbound order.
+      OutboundOrder = Structure.new do
+        # @return [String] Order ID for the outbound order.
+        attribute(:order_id, String, null: false, from: "orderId")
+
+        # @return [String] Status for the outbound order.
+        attribute(:order_status, String, null: false, from: "orderStatus")
+
+        # @return [Array<OutboundShipment>] List of outbound shipments that are part of this order.
+        attribute(:outbound_shipments, [OutboundShipment], null: false, from: "outboundShipments")
+
+        # @return [Time] Date on which this outbound order was confirmed.
+        attribute?(:confirmed_on, Time, from: "confirmedOn")
+
+        # @return [Time] Date on which this outbound order was created.
+        attribute?(:created_at, Time, from: "createdAt")
+
+        # @return [Array<DistributionPackageQuantity>] List of packages that are eligible for outbound.
+        attribute?(:eligible_packages_to_outbound, [DistributionPackageQuantity], from: "eligiblePackagesToOutbound")
+
+        # @return [Array<ProductQuantity>] List of product units that are eligible for outbound.
+        attribute?(:eligible_products_to_outbound, [ProductQuantity], from: "eligibleProductsToOutbound")
+
+        # @return [Array<OutboundExecutionError>] Execution errors associated with the outbound order. This field will
+        #   be populated if the order failed validation.
+        attribute?(:execution_errors, [OutboundExecutionError], from: "executionErrors")
+
+        # @return [Array<OrderAttribute>] Order preferences for this outbound order.
+        attribute?(:order_preferences, [OrderAttribute], from: "orderPreferences")
+
+        # @return [Array<DistributionPackageQuantity>] List of packages to be outbound.
+        attribute?(:packages_to_outbound, [DistributionPackageQuantity], from: "packagesToOutbound")
+
+        # @return [Array<ProductQuantity>] List of product units to be outbound.
+        attribute?(:products_to_outbound, [ProductQuantity], from: "productsToOutbound")
+
+        # @return [Array<DistributionPackageQuantity>] Outbound packages that are shipped after the execution has
+        #   completed post confirmation.
+        attribute?(:shipped_outbound_packages, [DistributionPackageQuantity], from: "shippedOutboundPackages")
+
+        # @return [Array<ProductQuantity>] Outbound product units that are shipped after the execution has completed
+        #   post confirmation.
+        attribute?(:shipped_outbound_products, [ProductQuantity], from: "shippedOutboundProducts")
+
+        # @return [Time] Date on which this outbound order was last updated.
+        attribute?(:updated_at, Time, from: "updatedAt")
+      end
+    end
+  end
+end

data/lib/peddler/apis/amazon_warehousing_and_distribution_2024_05_09/outbound_order_creation_data.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+
+module Peddler
+  module APIs
+    class AmazonWarehousingAndDistribution20240509
+      # Payload for creating an outbound order.
+      OutboundOrderCreationData = Structure.new do
+        # @return [Array<OrderAttribute>] Order preferences for the outbound order.
+        attribute?(:order_preferences, [OrderAttribute], from: "orderPreferences")
+
+        # @return [Array<DistributionPackageQuantity>] List of packages to be outbound.
+        attribute?(:packages_to_outbound, [DistributionPackageQuantity], from: "packagesToOutbound")
+
+        # @return [Array<ProductQuantity>] List of product units to be outbound.
+        attribute?(:products_to_outbound, [ProductQuantity], from: "productsToOutbound")
+      end
+    end
+  end
+end

data/lib/peddler/apis/amazon_warehousing_and_distribution_2024_05_09/outbound_order_reference.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+
+module Peddler
+  module APIs
+    class AmazonWarehousingAndDistribution20240509
+      # A response that contains the reference identifier for the newly created or updated outbound order. This includes
+      # an order ID.
+      OutboundOrderReference = Structure.new do
+        # @return [String] outbound order ID.
+        attribute(:order_id, String, null: false, from: "orderId")
+      end
+    end
+  end
+end

data/lib/peddler/apis/amazon_warehousing_and_distribution_2024_05_09/outbound_shipment.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+require "time"
+
+module Peddler
+  module APIs
+    class AmazonWarehousingAndDistribution20240509
+      # Represents an AWD outbound shipment.
+      OutboundShipment = Structure.new do
+        # @return [Address] Destination address for this shipment.
+        attribute(:destination_address, Address, null: false, from: "destinationAddress")
+
+        # @return [String] Outbound order ID this outbound shipment belongs to.
+        attribute(:order_id, String, null: false, from: "orderId")
+
+        # @return [Address] Origin address for this shipment.
+        attribute(:origin_address, Address, null: false, from: "originAddress")
+
+        # @return [String] Unique shipment ID.
+        attribute(:shipment_id, String, null: false, from: "shipmentId")
+
+        # @return [String] Current status of this shipment.
+        attribute(:shipment_status, String, null: false, from: "shipmentStatus")
+
+        # @return [Time] Timestamp when the shipment was created.
+        attribute?(:created_at, Time, from: "createdAt")
+
+        # @return [Array<DistributionPackageQuantity>] Specific distribution packages that are included in the context
+        #   of this shipment.
+        attribute?(:shipment_package_quantities, [DistributionPackageQuantity], from: "shipmentPackageQuantities")
+
+        # @return [Array<ProductQuantity>] Specific product units that are included in the context of this shipment.
+        attribute?(:shipment_product_quantities, [ProductQuantity], from: "shipmentProductQuantities")
+
+        # @return [Time] Timestamp when the shipment was updated.
+        attribute?(:updated_at, Time, from: "updatedAt")
+      end
+    end
+  end
+end

data/lib/peddler/apis/amazon_warehousing_and_distribution_2024_05_09/shipment_label_page_types.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+
+module Peddler
+  module APIs
+    class AmazonWarehousingAndDistribution20240509
+      # Shipment label page types.
+      ShipmentLabelPageTypes = Structure.new do
+        # @return [String] Status of label page types.
+        attribute(:label_status, String, null: false, from: "labelStatus")
+
+        # @return [Array<PageType>] List of available page types.
+        attribute?(:page_types, Array, from: "pageTypes")
+      end
+    end
+  end
+end

data/lib/peddler/apis/amazon_warehousing_and_distribution_2024_05_09.rb

@@ -108,6 +108,19 @@ module Peddler
         get(path, params:, rate_limit:, parser:)
       end
 
+      # Retrieves the available label page types for a shipment ID that you specify. This is an asynchronous operation.
+      # If the label status is `GENERATED`, then the pageTypes are available.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param shipment_id [String] ID for the shipment.
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def get_label_page_types(shipment_id, rate_limit: 1.0)
+        path = "/awd/2024-05-09/inboundShipments/#{percent_encode(shipment_id)}/labelPageTypes"
+        parser = -> { ShipmentLabelPageTypes }
+        get(path, rate_limit:, parser:)
+      end
+
       # Updates transport details for an AWD shipment.
       #
       # @note This operation can make a static sandbox call.
@@ -197,6 +210,93 @@ module Peddler
         get(path, params:, rate_limit:, parser:)
       end
 
+      # Retrieves all outbound AWD orders (with optional filters) that pertain to a merchant. By default, orders are
+      # sorted by the `updatedAt` attribute in descending order.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param updated_after [String] Get the outbound orders updated after a certain time (inclusive). The date must be
+      #   in {https://developer-docs.amazon.com/sp-api/docs/iso-8601 ISO 8601} format.
+      # @param updated_before [String] Get the outbound orders updated before a certain time (inclusive). The date must
+      #   be in {https://developer-docs.amazon.com/sp-api/docs/iso-8601 ISO 8601} format.
+      # @param sort_order [String] Sort the response in `ASCENDING` or `DESCENDING` order.
+      # @param max_results [Integer] Maximum number of results to return.
+      # @param next_token [String] A token that is used to retrieve the next page of results. The response includes
+      #   `nextToken` when the number of results exceeds the specified `maxResults` value. To get the next page of
+      #   results, call the operation with this token and include the same arguments as the call that produced the
+      #   token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can
+      #   return empty pages.
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def list_outbounds(updated_after: nil, updated_before: nil, sort_order: nil, max_results: 25, next_token: nil,
+        rate_limit: 1.0)
+        path = "/awd/2024-05-09/outboundOrders"
+        params = {
+          "updatedAfter" => updated_after,
+          "updatedBefore" => updated_before,
+          "sortOrder" => sort_order,
+          "maxResults" => max_results,
+          "nextToken" => next_token,
+        }.compact
+        parser = -> { OutboundListing }
+        get(path, params:, rate_limit:, parser:)
+      end
+
+      # Creates a draft AWD outbound order with the specified products. The API returns the order ID for the newly
+      # created order and starts an async validation check on the outbound products. After the validation check, the
+      # order status transitions from `VALIDATING` to `ELIGIBLE/INELIGIBLE`.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param body [Hash] Payload for creating an outbound order.
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def create_outbound(body, rate_limit: 1.0)
+        path = "/awd/2024-05-09/outboundOrders"
+        parser = -> { OutboundOrderReference }
+        post(path, body:, rate_limit:, parser:)
+      end
+
+      # Retrieves an AWD outbound order with a set of shipments that contain items that are outbound into a destination
+      # channel. If the order is not eligible, the validation errors field is included in the order response. The API
+      # returns the order ID for the newly created order and starts an async validation check on the outbound products.
+      # After the validation check, the order status transitions from `VALIDATING` to `ELIGIBLE/INELIGIBLE`.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param order_id [String] ID for the outbound order to be retrieved.
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def get_outbound(order_id, rate_limit: 1.0)
+        path = "/awd/2024-05-09/outboundOrders/#{percent_encode(order_id)}"
+        parser = -> { OutboundOrder }
+        get(path, rate_limit:, parser:)
+      end
+
+      # Updates an AWD outbound order that is in `DRAFT`, `ELIGIBLE`, or `INELIGIBLE` status. This API allows updates on
+      # `productsToOutbound` and `orderPreferences` attributes only. Any updates will restart the outbound order
+      # validation.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param order_id [String] ID for the outbound order to be updated.
+      # @param body [Hash] Represents an AWD outbound order.
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def update_outbound(order_id, body, rate_limit: 1.0)
+        path = "/awd/2024-05-09/outboundOrders/#{percent_encode(order_id)}"
+        parser = -> { OutboundOrderReference }
+        put(path, body:, rate_limit:, parser:)
+      end
+
+      # Confirms an AWD outbound order for a set of shipments that contain items that must be outbound to a destination
+      # node. You can confirm the order only if it's in an`ELIGIBLE` state.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param order_id [String] ID for the outbound order you want to confirm.
+      # @param rate_limit [Float] Requests per second
+      # @return [Peddler::Response] The API response
+      def confirm_outbound(order_id, rate_limit: 1.0)
+        path = "/awd/2024-05-09/outboundOrders/#{percent_encode(order_id)}/confirmation"
+        post(path, rate_limit:)
+      end
+
       # Retrieves all the AWD replenishment orders pertaining to a merchant with optional filters.
       # API by default will sort orders by updatedAt attribute in descending order.
       #

data/lib/peddler/apis/external_fulfillment_shipments_2024_09_11/address.rb

@@ -40,7 +40,10 @@ module Peddler
         # @return [String] The email address of the contact associated with the address.
         attribute?(:email, String)
 
-        # @return [String] The municiplaity where the person, business, or institution is located.
+        # @return [Geocodes] The geographic coordinates of the address.
+        attribute?(:geocodes, Geocodes)
+
+        # @return [String] The municipality where the person, business, or institution is located.
         attribute?(:municipality, String)
 
         # @return [String] The name of the person, business or institution at that address.

data/lib/peddler/apis/external_fulfillment_shipments_2024_09_11/distance.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+
+module Peddler
+  module APIs
+    class ExternalFulfillmentShipments20240911
+      # A distance measurement.
+      Distance = Structure.new do
+        # @return [String] The unit of measurement of the distance.
+        attribute(:distance_unit, String, null: false, from: "distanceUnit")
+
+        # @return [String] The numerical value of the distance.
+        attribute(:value, String, null: false)
+      end
+    end
+  end
+end

data/lib/peddler/apis/external_fulfillment_shipments_2024_09_11/geocodes.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+
+module Peddler
+  module APIs
+    class ExternalFulfillmentShipments20240911
+      # Geographic coordinates.
+      Geocodes = Structure.new do
+        # @return [String] The latitude coordinate.
+        attribute(:latitude, String, null: false)
+
+        # @return [String] The longitude coordinate.
+        attribute(:longitude, String, null: false)
+
+        # @return [String] The elevation in meters.
+        attribute?(:elevation, String)
+      end
+    end
+  end
+end

data/lib/peddler/apis/external_fulfillment_shipments_2024_09_11/handover_location.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# This file is generated. Do not edit.
+
+require "structure"
+
+module Peddler
+  module APIs
+    class ExternalFulfillmentShipments20240911
+      # The drop-off location details for package handover.
+      HandoverLocation = Structure.new do
+        # @return [Address] The address of the drop-off location.
+        attribute?(:address, Address)
+
+        # @return [Distance] The distance from the seller's location to the drop-off point.
+        attribute?(:distance, Distance)
+
+        # @return [String] URL to the map that shows the drop-off location.
+        attribute?(:map_url, String, from: "mapUrl")
+      end
+    end
+  end
+end

data/lib/peddler/apis/external_fulfillment_shipments_2024_09_11/ship_label_metadata.rb

@@ -16,6 +16,10 @@ module Peddler
         # @return [String] The tracking number of the package.
         attribute(:tracking_id, String, null: false, from: "trackingId")
 
+        # @return [HandoverLocation] The drop-off location details. This value is populated when `handoverMethod` is
+        #   `DROPOFF`.
+        attribute?(:handover_location, HandoverLocation, from: "handoverLocation")
+
         # @return [TimeWindow] The time window during which the package was picked up.
         attribute?(:pickup_window, TimeWindow, from: "pickupWindow")