@redotech/redo-api-schema 2.2.114 → 2.2.122

package/lib/openapi.d.ts

@@ -124,6 +124,18 @@ export interface paths {
       };
     };
   };
+  "/stores/{storeId}/shipments/{shipmentId}/documents/{documentType}": {
+    /**
+     * Download shipment document
+     * @description Get a shipment document (label, commercial invoice, etc).
+     */
+    get: operations["Shipment document download"];
+    parameters: {
+      path: {
+        storeId: components["parameters"]["store-id.param"];
+      };
+    };
+  };
   "/stores/{storeId}/shipments/buy": {
     /**
      * Purchase shipping label
@@ -760,12 +772,6 @@ export interface components {
      */
     "shipment-document.schema": {
       type: components["schemas"]["shipment-document-type.schema"];
-      /**
-       * URL
-       * Format: uri
-       * @description URL to download the document
-       */
-      url: string;
     };
     /**
      * Shipment Rate
@@ -811,7 +817,7 @@ export interface components {
     "shipment.schema": {
       /**
        * Documents
-       * @description Shipping documents
+       * @description Available shipping documents. You can access these documents using the GET Shipment document endpoint.
        */
       documents: components["schemas"]["shipment-document.schema"][];
       /**
@@ -1024,6 +1030,8 @@ export interface components {
   };
   responses: never;
   parameters: {
+    /** @description Type of document to download */
+    "document-type.param": components["schemas"]["shipment-document-type.schema"];
     /** @description Invoice ID */
     "invoice-id.param": string;
     /**
@@ -1038,6 +1046,8 @@ export interface components {
     "page-size.param"?: number;
     /** @description Return ID */
     "return-id.param": string;
+    /** @description Shipment ID */
+    "shipment-id.param": string;
     /** @description Store ID */
     "store-id.param": string;
     /**
@@ -1447,6 +1457,34 @@ export interface operations {
       };
     };
   };
+  /**
+   * Download shipment document
+   * @description Get a shipment document (label, commercial invoice, etc).
+   */
+  "Shipment document download": {
+    parameters: {
+      path: {
+        storeId: components["parameters"]["store-id.param"];
+        shipmentId: components["parameters"]["shipment-id.param"];
+        documentType: components["parameters"]["document-type.param"];
+      };
+    };
+    responses: {
+      /** @description Success */
+      200: {
+        content: {
+          "application/pdf": string;
+          "image/png": string;
+        };
+      };
+      /** @description Error */
+      default: {
+        content: {
+          "application/problem+json": components["schemas"]["error.schema"];
+        };
+      };
+    };
+  };
   /**
    * Purchase shipping label
    * @description Purchase a shipping label based on origin, destination, carrier, service, and parcel information.

package/lib/openapi.yaml

@@ -5,6 +5,13 @@ components:
       schema:
         type: string
   parameters:
+    document-type.param:
+      description: Type of document to download
+      in: path
+      name: documentType
+      required: true
+      schema:
+        $ref: '#/components/schemas/shipment-document-type.schema'
     invoice-id.param:
       description: Invoice ID
       in: path
@@ -35,6 +42,14 @@ components:
       schema:
         example: 64e4d5e837572a4813b73e40
         type: string
+    shipment-id.param:
+      description: Shipment ID
+      in: path
+      name: shipmentId
+      required: true
+      schema:
+        example: 67c7e87a2c8c262c0ddc9861
+        type: string
     store-id.param:
       description: Store ID
       in: path
@@ -774,16 +789,8 @@ components:
       properties:
         type:
           $ref: '#/components/schemas/shipment-document-type.schema'
-        url:
-          description: URL to download the document
-          examples:
-            - https://example.com/labels/123.pdf
-          format: uri
-          title: URL
-          type: string
       required:
         - type
-        - url
       title: Shipment Document
       type: object
     shipment-rate.schema:
@@ -843,7 +850,7 @@ components:
       description: Shipment information.
       properties:
         documents:
-          description: Shipping documents
+          description: Available shipping documents. You can access these documents using the GET Shipment document endpoint.
           items:
             $ref: '#/components/schemas/shipment-document.schema'
           title: Documents
@@ -1691,6 +1698,40 @@ paths:
       tags:
         - Shipping
     summary: Shipment Rates
+  /stores/{storeId}/shipments/{shipmentId}/documents/{documentType}:
+    description: Download shipment document.
+    get:
+      description: Get a shipment document (label, commercial invoice, etc).
+      operationId: Shipment document download
+      parameters:
+        - $ref: '#/components/parameters/shipment-id.param'
+        - $ref: '#/components/parameters/document-type.param'
+      responses:
+        '200':
+          content:
+            application/pdf:
+              schema:
+                format: binary
+                type: string
+            image/png:
+              schema:
+                format: binary
+                type: string
+          description: Success
+        default:
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/error.schema'
+          description: Error
+      security:
+        - Bearer: []
+      summary: Download shipment document
+      tags:
+        - Shipping
+    parameters:
+      - $ref: '#/components/parameters/store-id.param'
+    summary: Shipment Document
   /stores/{storeId}/webhooks:
     description: Webhooks.
     get:

package/package.json

@@ -31,5 +31,5 @@
       ]
     }
   },
-  "version": "2.2.114"
+  "version": "2.2.122"
 }