@redotech/redo-api-schema 2.2.108 → 2.2.112

package/lib/openapi.d.ts

@@ -70,6 +70,20 @@ 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
@@ -365,6 +379,23 @@ export interface components {
      * @example 1
      */
     "item-quantity.schema": number;
+    /**
+     * Length
+     * @description Length measurement with unit.
+     */
+    "length.schema": {
+      /**
+       * Unit
+       * @description Length unit
+       * @enum {string}
+       */
+      unit: "in" | "cm";
+      /**
+       * Value
+       * @description Numeric length value
+       */
+      value: number;
+    };
     /**
      * Money
      * @description Currency amount
@@ -438,6 +469,23 @@ export interface components {
        */
       name: string;
     };
+    /**
+     * Parcel Type
+     * @description Parcel type enum.
+     * @enum {string}
+     */
+    "parcel-type.schema": "box" | "envelope" | "soft_pack";
+    /**
+     * Parcel
+     * @description Parcel information for shipping.
+     */
+    "parcel.schema": {
+      height: components["schemas"]["length.schema"];
+      length: components["schemas"]["length.schema"];
+      type: components["schemas"]["parcel-type.schema"];
+      weight: components["schemas"]["shipping-weight.schema"];
+      width: components["schemas"]["length.schema"];
+    };
     /**
      * Person name
      * @description Person name.
@@ -690,6 +738,114 @@ export interface components {
      * @enum {string}
      */
     "return-status.schema": "manual_review" | "open" | "transit" | "delivered" | "flagged" | "cancelled" | "closed";
+    /**
+     * Shipment Document Type
+     * @description Type of shipping document.
+     * @enum {string}
+     */
+    "shipment-document-type.schema": "label" | "commercialInvoice";
+    /**
+     * Shipment Document
+     * @description Shipping document information.
+     */
+    "shipment-document.schema": {
+      type: components["schemas"]["shipment-document-type.schema"];
+      /**
+       * URL
+       * Format: uri
+       * @description URL to download the document
+       */
+      url: string;
+    };
+    /**
+     * Shipment Rate
+     * @description Shipping rate information.
+     */
+    "shipment-rate.schema": {
+      carrier: {
+        /**
+         * Carrier Account ID
+         * @description ID for the carrier account that provides the shipping rate.
+         */
+        id: string;
+        /**
+         * Carrier Name
+         * @description Carrier display name
+         */
+        name: string;
+      };
+      price: components["schemas"]["money.schema"];
+      service: {
+        /**
+         * Service Name
+         * @description Service level name
+         */
+        name: string;
+      };
+    };
+    /**
+     * Shipment Tracker
+     * @description Shipment tracking information.
+     */
+    "shipment-tracker.schema": {
+      /**
+       * Tracking Code
+       * @description Carrier tracking code
+       */
+      code: string;
+    };
+    /**
+     * Shipment
+     * @description Shipment information.
+     */
+    "shipment.schema": {
+      /**
+       * Documents
+       * @description Shipping documents
+       */
+      documents: components["schemas"]["shipment-document.schema"][];
+      /**
+       * Shipment ID
+       * @description Shipment identifier
+       */
+      id: string;
+      price: components["schemas"]["money.schema"];
+      tracker: components["schemas"]["shipment-tracker.schema"];
+    };
+    /**
+     * Shipping Contact
+     * @description Contact information for shipping.
+     */
+    "shipping-contact.schema": {
+      address: components["schemas"]["address.schema"];
+      /**
+       * Name
+       * @description Contact name
+       */
+      name: string;
+      /**
+       * Phone Number
+       * @description Contact phone number
+       */
+      phoneNumber: string;
+    };
+    /**
+     * Shipping Weight
+     * @description Weight measurement with unit for shipping.
+     */
+    "shipping-weight.schema": {
+      /**
+       * Unit
+       * @description Weight unit
+       * @enum {string}
+       */
+      unit: "g" | "kg" | "oz" | "lb";
+      /**
+       * Value
+       * @description Numeric weight value
+       */
+      value: number;
+    };
     /**
      * Storefront Cart
      * @description Storefront cart.
@@ -1090,6 +1246,84 @@ 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.

package/lib/openapi.yaml

@@ -283,6 +283,32 @@ components:
       exclusiveMinimum: 0
       title: Item quantity
       type: number
+    length.schema:
+      description: Length measurement with unit.
+      properties:
+        unit:
+          description: Length unit
+          enum:
+            - in
+            - cm
+          examples:
+            - in
+            - cm
+          title: Unit
+          type: string
+        value:
+          description: Numeric length value
+          examples:
+            - 10.5
+            - 30
+          minimum: 0
+          title: Value
+          type: number
+      required:
+        - value
+        - unit
+      title: Length
+      type: object
     money.schema:
       description: Currency amount
       properties:
@@ -383,6 +409,35 @@ components:
         - name
       title: Order
       type: object
+    parcel-type.schema:
+      description: Parcel type enum.
+      enum:
+        - box
+        - envelope
+        - soft_pack
+      title: Parcel Type
+      type: string
+    parcel.schema:
+      description: Parcel information for shipping.
+      properties:
+        height:
+          $ref: '#/components/schemas/length.schema'
+        length:
+          $ref: '#/components/schemas/length.schema'
+        type:
+          $ref: '#/components/schemas/parcel-type.schema'
+        weight:
+          $ref: '#/components/schemas/shipping-weight.schema'
+        width:
+          $ref: '#/components/schemas/length.schema'
+      required:
+        - height
+        - length
+        - width
+        - weight
+        - type
+      title: Parcel
+      type: object
     person-name.schema:
       description: Person name.
       properties:
@@ -707,6 +762,158 @@ components:
       example: open
       title: Return status
       type: string
+    shipment-document-type.schema:
+      description: Type of shipping document.
+      enum:
+        - label
+        - commercialInvoice
+      title: Shipment Document Type
+      type: string
+    shipment-document.schema:
+      description: Shipping document information.
+      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:
+      description: Shipping rate information.
+      properties:
+        carrier:
+          properties:
+            id:
+              description: ID for the carrier account that provides the shipping rate.
+              title: Carrier Account ID
+              type: string
+            name:
+              description: Carrier display name
+              examples:
+                - USPS
+                - FedEx
+              title: Carrier Name
+              type: string
+          required:
+            - id
+            - name
+          type: object
+        price:
+          $ref: '#/components/schemas/money.schema'
+        service:
+          properties:
+            name:
+              description: Service level name
+              examples:
+                - Priority
+                - Ground
+              title: Service Name
+              type: string
+          required:
+            - name
+          type: object
+      required:
+        - carrier
+        - price
+        - service
+      title: Shipment Rate
+      type: object
+    shipment-tracker.schema:
+      description: Shipment tracking information.
+      properties:
+        code:
+          description: Carrier tracking code
+          examples:
+            - '9400100000000000000000'
+          title: Tracking Code
+          type: string
+      required:
+        - code
+      title: Shipment Tracker
+      type: object
+    shipment.schema:
+      description: Shipment information.
+      properties:
+        documents:
+          description: Shipping documents
+          items:
+            $ref: '#/components/schemas/shipment-document.schema'
+          title: Documents
+          type: array
+        id:
+          description: Shipment identifier
+          title: Shipment ID
+          type: string
+        price:
+          $ref: '#/components/schemas/money.schema'
+        tracker:
+          $ref: '#/components/schemas/shipment-tracker.schema'
+      required:
+        - id
+        - documents
+        - tracker
+        - price
+      title: Shipment
+      type: object
+    shipping-contact.schema:
+      description: Contact information for shipping.
+      properties:
+        address:
+          $ref: '#/components/schemas/address.schema'
+        name:
+          description: Contact name
+          examples:
+            - John Doe
+          title: Name
+          type: string
+        phoneNumber:
+          description: Contact phone number
+          examples:
+            - '+12025550123'
+          title: Phone Number
+          type: string
+      required:
+        - name
+        - phoneNumber
+        - address
+      title: Shipping Contact
+      type: object
+    shipping-weight.schema:
+      description: Weight measurement with unit for shipping.
+      properties:
+        unit:
+          description: Weight unit
+          enum:
+            - g
+            - kg
+            - oz
+            - lb
+          examples:
+            - lb
+            - kg
+          title: Unit
+          type: string
+        value:
+          description: Numeric weight value
+          examples:
+            - 1.5
+            - 10
+          minimum: 0
+          title: Value
+          type: number
+      required:
+        - value
+        - unit
+      title: Shipping Weight
+      type: object
     storefront-cart.schema:
       description: Storefront cart.
       properties:
@@ -1150,6 +1357,133 @@ 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:

package/package.json

@@ -31,5 +31,5 @@
       ]
     }
   },
-  "version": "2.2.108"
+  "version": "2.2.112"
 }