@redotech/redo-api-schema 2.2.112 → 2.2.116

package/lib/openapi.d.ts

@@ -70,20 +70,6 @@ export interface paths {
       };
     };
   };
-  "/shipments/buy": {
-    /**
-     * Purchase shipping label
-     * @description Purchase a shipping label based on origin, destination, carrier, service, and parcel information.
-     */
-    post: operations["Shipment buy"];
-  };
-  "/shipments/rates": {
-    /**
-     * Get shipping rates
-     * @description Get available shipping rates based on origin, destination, and parcel information.
-     */
-    post: operations["Shipment rates"];
-  };
   "/stores/{storeId}/admin": {
     /**
      * Navigate to merchant admin
@@ -138,6 +124,42 @@ 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
+     * @description Purchase a shipping label based on origin, destination, carrier, service, and parcel information.
+     */
+    post: operations["Shipment buy"];
+    parameters: {
+      path: {
+        storeId: components["parameters"]["store-id.param"];
+      };
+    };
+  };
+  "/stores/{storeId}/shipments/rates": {
+    /**
+     * Get shipping rates
+     * @description Get available shipping rates based on origin, destination, and parcel information.
+     */
+    post: operations["Shipment rates"];
+    parameters: {
+      path: {
+        storeId: components["parameters"]["store-id.param"];
+      };
+    };
+  };
   "/stores/{storeId}/webhooks": {
     /**
      * List webhooks
@@ -1014,6 +1036,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;
     /**
@@ -1028,6 +1052,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;
     /**
@@ -1246,84 +1272,6 @@ export interface operations {
       };
     };
   };
-  /**
-   * Purchase shipping label
-   * @description Purchase a shipping label based on origin, destination, carrier, service, and parcel information.
-   */
-  "Shipment buy": {
-    requestBody: {
-      content: {
-        "application/json": {
-          carrier: {
-            /**
-             * Carrier Account ID
-             * @description ID for the carrier account that provides the shipping rate.
-             */
-            id: string;
-          };
-          destination: components["schemas"]["shipping-contact.schema"];
-          origin: components["schemas"]["shipping-contact.schema"];
-          parcel: components["schemas"]["parcel.schema"];
-          service: {
-            /** @description Service level name */
-            name: string;
-          };
-        };
-      };
-    };
-    responses: {
-      /** @description Success */
-      200: {
-        content: {
-          "application/json": {
-            shipment: components["schemas"]["shipment.schema"];
-          };
-        };
-      };
-      /** @description Error */
-      default: {
-        content: {
-          "application/problem+json": components["schemas"]["error.schema"];
-        };
-      };
-    };
-  };
-  /**
-   * Get shipping rates
-   * @description Get available shipping rates based on origin, destination, and parcel information.
-   */
-  "Shipment rates": {
-    requestBody: {
-      content: {
-        "application/json": {
-          destination: {
-            address: components["schemas"]["address.schema"];
-          };
-          origin: {
-            address: components["schemas"]["address.schema"];
-          };
-          parcel: components["schemas"]["parcel.schema"];
-        };
-      };
-    };
-    responses: {
-      /** @description Success */
-      200: {
-        content: {
-          "application/json": {
-            /** @description Available shipping rates */
-            rates: components["schemas"]["shipment-rate.schema"][];
-          };
-        };
-      };
-      /** @description Error */
-      default: {
-        content: {
-          "application/problem+json": components["schemas"]["error.schema"];
-        };
-      };
-    };
-  };
   /**
    * Navigate to merchant admin
    * @description Navigate to the merchant admin page.
@@ -1515,6 +1463,122 @@ 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.
+   */
+  "Shipment buy": {
+    parameters: {
+      path: {
+        storeId: components["parameters"]["store-id.param"];
+      };
+    };
+    requestBody: {
+      content: {
+        "application/json": {
+          carrier: {
+            /**
+             * Carrier Account ID
+             * @description ID for the carrier account that provides the shipping rate.
+             */
+            id: string;
+          };
+          destination: components["schemas"]["shipping-contact.schema"];
+          origin: components["schemas"]["shipping-contact.schema"];
+          parcel: components["schemas"]["parcel.schema"];
+          service: {
+            /** @description Service level name */
+            name: string;
+          };
+        };
+      };
+    };
+    responses: {
+      /** @description Success */
+      200: {
+        content: {
+          "application/json": {
+            shipment: components["schemas"]["shipment.schema"];
+          };
+        };
+      };
+      /** @description Error */
+      default: {
+        content: {
+          "application/problem+json": components["schemas"]["error.schema"];
+        };
+      };
+    };
+  };
+  /**
+   * Get shipping rates
+   * @description Get available shipping rates based on origin, destination, and parcel information.
+   */
+  "Shipment rates": {
+    parameters: {
+      path: {
+        storeId: components["parameters"]["store-id.param"];
+      };
+    };
+    requestBody: {
+      content: {
+        "application/json": {
+          destination: {
+            address: components["schemas"]["address.schema"];
+          };
+          origin: {
+            address: components["schemas"]["address.schema"];
+          };
+          parcel: components["schemas"]["parcel.schema"];
+        };
+      };
+    };
+    responses: {
+      /** @description Success */
+      200: {
+        content: {
+          "application/json": {
+            /** @description Available shipping rates */
+            rates: components["schemas"]["shipment-rate.schema"][];
+          };
+        };
+      };
+      /** @description Error */
+      default: {
+        content: {
+          "application/problem+json": components["schemas"]["error.schema"];
+        };
+      };
+    };
+  };
   /**
    * List webhooks
    * @description List webhooks for store.

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
@@ -1357,133 +1372,6 @@ paths:
       tags:
         - Returns
     summary: Return status
-  /shipments/buy:
-    description: Purchase a shipping label.
-    post:
-      description: Purchase a shipping label based on origin, destination, carrier, service, and parcel information.
-      operationId: Shipment buy
-      requestBody:
-        content:
-          application/json:
-            schema:
-              properties:
-                carrier:
-                  properties:
-                    id:
-                      description: ID for the carrier account that provides the shipping rate.
-                      title: Carrier Account ID
-                      type: string
-                  required:
-                    - id
-                  type: object
-                destination:
-                  $ref: '#/components/schemas/shipping-contact.schema'
-                origin:
-                  $ref: '#/components/schemas/shipping-contact.schema'
-                parcel:
-                  $ref: '#/components/schemas/parcel.schema'
-                service:
-                  properties:
-                    name:
-                      description: Service level name
-                      examples:
-                        - Priority
-                        - Ground
-                      type: string
-                  required:
-                    - name
-                  type: object
-              required:
-                - origin
-                - destination
-                - carrier
-                - service
-                - parcel
-              type: object
-        required: true
-      responses:
-        '200':
-          content:
-            application/json:
-              schema:
-                properties:
-                  shipment:
-                    $ref: '#/components/schemas/shipment.schema'
-                required:
-                  - shipment
-                type: object
-          description: Success
-        default:
-          content:
-            application/problem+json:
-              schema:
-                $ref: '#/components/schemas/error.schema'
-          description: Error
-      security:
-        - Bearer: []
-      summary: Purchase shipping label
-      tags:
-        - Shipping
-    summary: Shipment Buy
-  /shipments/rates:
-    description: Fetch available shipping label rates.
-    post:
-      description: Get available shipping rates based on origin, destination, and parcel information.
-      operationId: Shipment rates
-      requestBody:
-        content:
-          application/json:
-            schema:
-              properties:
-                destination:
-                  properties:
-                    address:
-                      $ref: '#/components/schemas/address.schema'
-                  required:
-                    - address
-                  type: object
-                origin:
-                  properties:
-                    address:
-                      $ref: '#/components/schemas/address.schema'
-                  required:
-                    - address
-                  type: object
-                parcel:
-                  $ref: '#/components/schemas/parcel.schema'
-              required:
-                - origin
-                - destination
-                - parcel
-              type: object
-        required: true
-      responses:
-        '200':
-          content:
-            application/json:
-              schema:
-                properties:
-                  rates:
-                    description: Available shipping rates
-                    items:
-                      $ref: '#/components/schemas/shipment-rate.schema'
-                    type: array
-                required:
-                  - rates
-                type: object
-          description: Success
-        default:
-          content:
-            application/problem+json:
-              schema:
-                $ref: '#/components/schemas/error.schema'
-          description: Error
-      security:
-        - Bearer: []
-      summary: Get shipping rates
-      tags:
-        - Shipping
-    summary: Shipment Rates
   /stores/{storeId}/admin:
     description: Navigate to the merchant admin page.
     get:
@@ -1687,6 +1575,171 @@ paths:
     parameters:
       - $ref: '#/components/parameters/store-id.param'
     summary: Returns
+  /stores/{storeId}/shipments/buy:
+    description: Purchase a shipping label.
+    parameters:
+      - $ref: '#/components/parameters/store-id.param'
+    post:
+      description: Purchase a shipping label based on origin, destination, carrier, service, and parcel information.
+      operationId: Shipment buy
+      requestBody:
+        content:
+          application/json:
+            schema:
+              properties:
+                carrier:
+                  properties:
+                    id:
+                      description: ID for the carrier account that provides the shipping rate.
+                      title: Carrier Account ID
+                      type: string
+                  required:
+                    - id
+                  type: object
+                destination:
+                  $ref: '#/components/schemas/shipping-contact.schema'
+                origin:
+                  $ref: '#/components/schemas/shipping-contact.schema'
+                parcel:
+                  $ref: '#/components/schemas/parcel.schema'
+                service:
+                  properties:
+                    name:
+                      description: Service level name
+                      examples:
+                        - Priority
+                        - Ground
+                      type: string
+                  required:
+                    - name
+                  type: object
+              required:
+                - origin
+                - destination
+                - carrier
+                - service
+                - parcel
+              type: object
+        required: true
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                properties:
+                  shipment:
+                    $ref: '#/components/schemas/shipment.schema'
+                required:
+                  - shipment
+                type: object
+          description: Success
+        default:
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/error.schema'
+          description: Error
+      security:
+        - Bearer: []
+      summary: Purchase shipping label
+      tags:
+        - Shipping
+    summary: Shipment Buy
+  /stores/{storeId}/shipments/rates:
+    description: Fetch available shipping label rates.
+    parameters:
+      - $ref: '#/components/parameters/store-id.param'
+    post:
+      description: Get available shipping rates based on origin, destination, and parcel information.
+      operationId: Shipment rates
+      requestBody:
+        content:
+          application/json:
+            schema:
+              properties:
+                destination:
+                  properties:
+                    address:
+                      $ref: '#/components/schemas/address.schema'
+                  required:
+                    - address
+                  type: object
+                origin:
+                  properties:
+                    address:
+                      $ref: '#/components/schemas/address.schema'
+                  required:
+                    - address
+                  type: object
+                parcel:
+                  $ref: '#/components/schemas/parcel.schema'
+              required:
+                - origin
+                - destination
+                - parcel
+              type: object
+        required: true
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                properties:
+                  rates:
+                    description: Available shipping rates
+                    items:
+                      $ref: '#/components/schemas/shipment-rate.schema'
+                    type: array
+                required:
+                  - rates
+                type: object
+          description: Success
+        default:
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/error.schema'
+          description: Error
+      security:
+        - Bearer: []
+      summary: Get shipping rates
+      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.112"
+  "version": "2.2.116"
 }