Add Delivery by Amazon API (v2022-07-01)

Author: jlevers

README.md

@@ -25,8 +25,6 @@ A PHP library for connecting to Amazon's [Selling Partner API](https://github.co
 
 ---
 
-**I'm available for consulting work!** If you need support designing and building applications with Amazon, Walmart, or other e-commerce APIs, or building SDKs in PHP, I can help. Shoot me an email at [jesse@highsidelabs.co](mailto:jesse@highsidelabs.co).
-
 If you've found any of my packages useful, please consider [becoming a Sponsor](https://github.com/sponsors/jlevers), or making a one-time donation via the button below. I appreciate any and all support! Keeping open source projects alive is a community effort.
 
 <p align="center">
@@ -35,14 +33,16 @@ If you've found any of my packages useful, please consider [becoming a Sponsor](
 
 ### Sponsored by **[Tesmo](https://tesmollc.com)**.
 
+### Sponsored by **[Highside Labs](https://tools.highsidelabs.co/starter-kit)**. Get started with SP API development on Laravel in minutes.
+
 ---
 
 > [!NOTE]
 > If you're looking for the documentation for v5 of this package, you can find it [here](https://github.com/jlevers/selling-partner-api/tree/v5.0).
 
 ## Features
 
-* Supports all Selling Partner API operations (for Sellers and Vendors) as of 10/27/2025
+* Supports all Selling Partner API operations (for Sellers and Vendors) as of 12/6/2025
 * Automatically generates Restricted Data Tokens for all calls that require them -- no extra calls to the Tokens API needed
 * Includes a [`Document` helper class](#uploading-and-downloading-documents) for uploading and downloading feed/report documents
 * Can handle the end-to-end OAuth flow, from building authorization URLs to converting authorization codes into refresh tokens
@@ -259,6 +259,10 @@ $sellerConnector = SellingPartnerApi::seller(/* ... */);
     ```php
     $dataKioskApi = $sellerConnector->dataKioskV20231115();
     ```
+* **Delivery by Amazon API (v2022-07-01)** ([docs](https://developer-docs.amazon.com/sp-api/reference/delivery-by-amazon-v2022-07-01))
+    ```php
+    $deliveryByAmazonApi = $sellerConnector->deliveryByAmazonV20220701();
+    ```
 * **EasyShip API (v2022-03-23)** ([docs](https://developer-docs.amazon.com/sp-api/docs/easy-ship-api-v2022-03-23-reference))
     ```php
     $easyShipApi = $sellerConnector->easyShipV20220323();

resources/apis.json

@@ -71,6 +71,15 @@
                 }
             ]
         },
+        "delivery-by-amazon": {
+            "name": "Delivery by Amazon",
+            "versions": [
+                {
+                    "version": "2022-07-01",
+                    "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/refs/heads/main/models/delivery-by-amazon/deliveryShipmentInvoiceV2022-07-01.json"
+                }
+            ]
+        },
         "easy-ship": {
             "name": "Easy Ship",
             "versions": [

resources/models/raw/seller/delivery-by-amazon/v2022-07-01.json

@@ -0,0 +1,46 @@
+<?php
+
+namespace SellingPartnerApi\Seller\DeliveryByAmazonV20220701;
+
+use Saloon\Http\Response;
+use SellingPartnerApi\BaseResource;
+use SellingPartnerApi\Seller\DeliveryByAmazonV20220701\Dto\SubmitInvoiceRequest;
+use SellingPartnerApi\Seller\DeliveryByAmazonV20220701\Requests\GetInvoiceStatus;
+use SellingPartnerApi\Seller\DeliveryByAmazonV20220701\Requests\SubmitInvoice;
+
+class Api extends BaseResource
+{
+    /**
+     * @param  SubmitInvoiceRequest  $submitInvoiceRequest  The request schema for the `submitInvoice` operation.
+     * @param  ?string  $orderId  The identifier for the order.
+     * @param  ?string  $shipmentId  The identifier for the shipment.
+     */
+    public function submitInvoice(
+        SubmitInvoiceRequest $submitInvoiceRequest,
+        ?string $orderId = null,
+        ?string $shipmentId = null,
+    ): Response {
+        $request = new SubmitInvoice($submitInvoiceRequest, $orderId, $shipmentId);
+
+        return $this->connector->send($request);
+    }
+
+    /**
+     * @param  string  $marketplaceId  The marketplace identifier.
+     * @param  string  $invoiceType  The invoice's type.
+     * @param  string  $programType  The Amazon program that seller is currently enrolled.
+     * @param  ?string  $orderId  The order identifier.
+     * @param  ?string  $shipmentId  The shipment identifier.
+     */
+    public function getInvoiceStatus(
+        string $marketplaceId,
+        string $invoiceType,
+        string $programType,
+        ?string $orderId = null,
+        ?string $shipmentId = null,
+    ): Response {
+        $request = new GetInvoiceStatus($marketplaceId, $invoiceType, $programType, $orderId, $shipmentId);
+
+        return $this->connector->send($request);
+    }
+}

resources/models/seller/delivery-by-amazon/v2022-07-01.json

@@ -0,0 +1,27 @@
+<?php
+
+/**
+ * This file is auto-generated by Saloon SDK Generator
+ * Generator: Crescat\SaloonSdkGenerator\Generators\DtoGenerator
+ * Do not modify it directly.
+ */
+
+declare(strict_types=1);
+
+namespace SellingPartnerApi\Seller\DeliveryByAmazonV20220701\Dto;
+
+use SellingPartnerApi\Dto;
+
+final class Error extends Dto
+{
+    /**
+     * @param  string  $code  An error code that identifies the type of error that occurred.
+     * @param  string  $message  A message that describes the error condition.
+     * @param  ?string  $details  Additional details that can help the caller understand or fix the issue.
+     */
+    public function __construct(
+        public string $code,
+        public string $message,
+        public ?string $details = null,
+    ) {}
+}

src/Seller/DeliveryByAmazonV20220701/Api.php

@@ -0,0 +1,33 @@
+<?php
+
+/**
+ * This file is auto-generated by Saloon SDK Generator
+ * Generator: Crescat\SaloonSdkGenerator\Generators\DtoGenerator
+ * Do not modify it directly.
+ */
+
+declare(strict_types=1);
+
+namespace SellingPartnerApi\Seller\DeliveryByAmazonV20220701\Dto;
+
+use SellingPartnerApi\Dto;
+
+final class SubmitInvoiceRequest extends Dto
+{
+    protected static array $attributeMap = ['contentMd5value' => 'contentMD5Value'];
+
+    /**
+     * @param  string  $invoiceContent  Shipment invoice document content.
+     * @param  string  $marketplaceId  An Amazon marketplace identifier.
+     * @param  string  $contentMd5value  MD5 sum for validating the invoice data. For more information about calculating this value, see [Working with Content-MD5 Checksums](https://docs.developer.amazonservices.com/en_US/dev_guide/DG_MD5.html).
+     * @param  string  $invoiceType  The invoice type.
+     * @param  string  $programType  The Amazon program type.
+     */
+    public function __construct(
+        public string $invoiceContent,
+        public string $marketplaceId,
+        public string $contentMd5value,
+        public string $invoiceType,
+        public string $programType,
+    ) {}
+}

src/Seller/DeliveryByAmazonV20220701/Dto/Error.php

@@ -0,0 +1,69 @@
+<?php
+
+/**
+ * This file is auto-generated by Saloon SDK Generator
+ * Generator: SellingPartnerApi\Generator\Generators\RequestGenerator
+ * Do not modify it directly.
+ */
+
+declare(strict_types=1);
+
+namespace SellingPartnerApi\Seller\DeliveryByAmazonV20220701\Requests;
+
+use Exception;
+use Saloon\Enums\Method;
+use Saloon\Http\Response;
+use SellingPartnerApi\Request;
+use SellingPartnerApi\Seller\DeliveryByAmazonV20220701\Responses\ErrorList;
+use SellingPartnerApi\Seller\DeliveryByAmazonV20220701\Responses\GetInvoiceStatusResponse;
+
+/**
+ * getInvoiceStatus
+ */
+class GetInvoiceStatus extends Request
+{
+    protected Method $method = Method::GET;
+
+    /**
+     * @param  string  $marketplaceId  The marketplace identifier.
+     * @param  string  $invoiceType  The invoice's type.
+     * @param  string  $programType  The Amazon program that seller is currently enrolled.
+     * @param  ?string  $orderId  The order identifier.
+     * @param  ?string  $shipmentId  The shipment identifier.
+     */
+    public function __construct(
+        protected string $marketplaceId,
+        protected string $invoiceType,
+        protected string $programType,
+        protected ?string $orderId = null,
+        protected ?string $shipmentId = null,
+    ) {}
+
+    public function resolveEndpoint(): string
+    {
+        return '/delivery/2022-07-01/invoice/status';
+    }
+
+    public function createDtoFromResponse(Response $response): GetInvoiceStatusResponse|ErrorList
+    {
+        $status = $response->status();
+        $responseCls = match ($status) {
+            200, 400, 401, 403, 404, 415, 429, 500, 503 => GetInvoiceStatusResponse::class,
+            413 => ErrorList::class,
+            default => throw new Exception("Unhandled response status: {$status}")
+        };
+
+        return $responseCls::deserialize($response->json());
+    }
+
+    public function defaultQuery(): array
+    {
+        return array_filter([
+            'marketplaceId' => $this->marketplaceId,
+            'invoiceType' => $this->invoiceType,
+            'programType' => $this->programType,
+            'orderId' => $this->orderId,
+            'shipmentId' => $this->shipmentId,
+        ]);
+    }
+}

src/Seller/DeliveryByAmazonV20220701/Dto/SubmitInvoiceRequest.php

@@ -0,0 +1,69 @@
+<?php
+
+/**
+ * This file is auto-generated by Saloon SDK Generator
+ * Generator: SellingPartnerApi\Generator\Generators\RequestGenerator
+ * Do not modify it directly.
+ */
+
+declare(strict_types=1);
+
+namespace SellingPartnerApi\Seller\DeliveryByAmazonV20220701\Requests;
+
+use Exception;
+use Saloon\Contracts\Body\HasBody;
+use Saloon\Enums\Method;
+use Saloon\Http\Response;
+use Saloon\Traits\Body\HasJsonBody;
+use SellingPartnerApi\Request;
+use SellingPartnerApi\Seller\DeliveryByAmazonV20220701\Dto\SubmitInvoiceRequest;
+use SellingPartnerApi\Seller\DeliveryByAmazonV20220701\Responses\ErrorList;
+use SellingPartnerApi\Seller\DeliveryByAmazonV20220701\Responses\SubmitInvoiceResponse;
+
+/**
+ * submitInvoice
+ */
+class SubmitInvoice extends Request implements HasBody
+{
+    use HasJsonBody;
+
+    protected Method $method = Method::POST;
+
+    /**
+     * @param  SubmitInvoiceRequest  $submitInvoiceRequest  The request schema for the `submitInvoice` operation.
+     * @param  ?string  $orderId  The identifier for the order.
+     * @param  ?string  $shipmentId  The identifier for the shipment.
+     */
+    public function __construct(
+        public SubmitInvoiceRequest $submitInvoiceRequest,
+        protected ?string $orderId = null,
+        protected ?string $shipmentId = null,
+    ) {}
+
+    public function resolveEndpoint(): string
+    {
+        return '/delivery/2022-07-01/invoice';
+    }
+
+    public function createDtoFromResponse(Response $response): SubmitInvoiceResponse|ErrorList
+    {
+        $status = $response->status();
+        $responseCls = match ($status) {
+            200, 400, 401, 403, 404, 415, 429, 500, 503 => SubmitInvoiceResponse::class,
+            413 => ErrorList::class,
+            default => throw new Exception("Unhandled response status: {$status}")
+        };
+
+        return $responseCls::deserialize($response->json());
+    }
+
+    public function defaultBody(): array
+    {
+        return $this->submitInvoiceRequest->toArray();
+    }
+
+    public function defaultQuery(): array
+    {
+        return array_filter(['orderId' => $this->orderId, 'shipmentId' => $this->shipmentId]);
+    }
+}

src/Seller/DeliveryByAmazonV20220701/Requests/GetInvoiceStatus.php

@@ -0,0 +1,26 @@
+<?php
+
+/**
+ * This file is auto-generated by Saloon SDK Generator
+ * Generator: SellingPartnerApi\Generator\Generators\ResponseGenerator
+ * Do not modify it directly.
+ */
+
+declare(strict_types=1);
+
+namespace SellingPartnerApi\Seller\DeliveryByAmazonV20220701\Responses;
+
+use SellingPartnerApi\Response;
+use SellingPartnerApi\Seller\DeliveryByAmazonV20220701\Dto\Error;
+
+final class ErrorList extends Response
+{
+    protected static array $complexArrayTypes = ['errors' => Error::class];
+
+    /**
+     * @param  Error[]  $errors  A list of error responses returned when a request is unsuccessful.
+     */
+    public function __construct(
+        public readonly array $errors,
+    ) {}
+}