chore(docs): Updated API Reference (automated) (#10641)

Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2024-12-17 17:41:22 +00:00
parent 1232a43fce
commit 4479ecdc7b
9 changed files with 291 additions and 0 deletions
--- a/www/apps/api-reference/specs/admin/components/schemas/StoreShippingOptionResponse.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/StoreShippingOptionResponse.yaml
@@ -0,0 +1,8 @@
+type: object
+description: The shipping option's details.
+x-schemaName: StoreShippingOptionResponse
+required:
+  - shipping_option
+properties:
+  shipping_option:
+    $ref: ./StoreCartShippingOption.yaml
--- a/www/apps/api-reference/specs/admin/openapi.full.yaml
+++ b/www/apps/api-reference/specs/admin/openapi.full.yaml
@@ -69233,6 +69233,15 @@ components:
          description: The shipping option's shipping options.
          items:
            $ref: '#/components/schemas/StoreCartShippingOption'
+    StoreShippingOptionResponse:
+      type: object
+      description: The shipping option's details.
+      x-schemaName: StoreShippingOptionResponse
+      required:
+        - shipping_option
+      properties:
+        shipping_option:
+          $ref: '#/components/schemas/StoreCartShippingOption'
    StoreShippingOptionType:
      type: object
      description: The shipping option type's details.
--- a/www/apps/api-reference/specs/store/code_samples/Shell/store_shipping-options_{id}_calculate/post.sh
+++ b/www/apps/api-reference/specs/store/code_samples/Shell/store_shipping-options_{id}_calculate/post.sh
@@ -0,0 +1,6 @@
+curl -X POST '{backend_url}/store/shipping-options/{id}/calculate' \
+-H 'x-publishable-api-key: {your_publishable_api_key}' \
+-H 'Content-Type: application/json' \
+--data-raw '{
+  "cart_id": "{value}"
+}'
--- a/www/apps/api-reference/specs/store/components/schemas/StoreShippingOptionResponse.yaml
+++ b/www/apps/api-reference/specs/store/components/schemas/StoreShippingOptionResponse.yaml
@@ -0,0 +1,8 @@
+type: object
+description: The shipping option's details.
+x-schemaName: StoreShippingOptionResponse
+required:
+  - shipping_option
+properties:
+  shipping_option:
+    $ref: ./StoreCartShippingOption.yaml
--- a/www/apps/api-reference/specs/store/openapi.full.yaml
+++ b/www/apps/api-reference/specs/store/openapi.full.yaml
@@ -5758,6 +5758,82 @@ paths:
        '500':
          $ref: '#/components/responses/500_error'
      x-workflow: listShippingOptionsForCartWorkflow
+  /store/shipping-options/{id}/calculate:
+    post:
+      operationId: PostShippingOptionsIdCalculate
+      summary: Calculate Shipping Option Price
+      description: Calculate the price of a shipping option in a cart.
+      x-authenticated: false
+      parameters:
+        - name: id
+          in: path
+          description: The shipping option's ID.
+          required: true
+          schema:
+            type: string
+        - name: fields
+          in: query
+          description: |-
+            Comma-separated fields that should be included in the returned data.
+            if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
+            without prefix it will replace the entire default fields.
+          required: false
+          schema:
+            type: string
+            title: fields
+            description: Comma-separated fields that should be included in the returned data. If a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. Without prefix it will replace the entire default fields.
+            externalDocs:
+              url: '#select-fields-and-relations'
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: object
+              description: The calculation's details.
+              required:
+                - cart_id
+              properties:
+                cart_id:
+                  type: string
+                  title: cart_id
+                  description: The ID of the cart the shipping option is used in.
+                data:
+                  type: object
+                  description: Custom data that's useful for the fulfillment provider to calculate the price.
+                  externalDocs:
+                    url: https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
+      x-codeSamples:
+        - lang: Shell
+          label: cURL
+          source: |-
+            curl -X POST '{backend_url}/store/shipping-options/{id}/calculate' \
+            -H 'x-publishable-api-key: {your_publishable_api_key}' \
+            -H 'Content-Type: application/json' \
+            --data-raw '{
+              "cart_id": "{value}"
+            }'
+      tags:
+        - Shipping Options
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/StoreShippingOptionResponse'
+        '400':
+          $ref: '#/components/responses/400_error'
+        '401':
+          $ref: '#/components/responses/unauthorized'
+        '404':
+          $ref: '#/components/responses/not_found_error'
+        '409':
+          $ref: '#/components/responses/invalid_state_error'
+        '422':
+          $ref: '#/components/responses/invalid_request_error'
+        '500':
+          $ref: '#/components/responses/500_error'
+      x-workflow: calculateShippingOptionsPricesWorkflow
 components:
  schemas:
    AdminApiKey:
@@ -31431,6 +31507,15 @@ components:
          description: The shipping option's shipping options.
          items:
            $ref: '#/components/schemas/StoreCartShippingOption'
+    StoreShippingOptionResponse:
+      type: object
+      description: The shipping option's details.
+      x-schemaName: StoreShippingOptionResponse
+      required:
+        - shipping_option
+      properties:
+        shipping_option:
+          $ref: '#/components/schemas/StoreCartShippingOption'
    StoreShippingOptionType:
      type: object
      description: The shipping option type's details.
--- a/www/apps/api-reference/specs/store/openapi.yaml
+++ b/www/apps/api-reference/specs/store/openapi.yaml
@@ -275,6 +275,8 @@ paths:
    $ref: paths/store_return-reasons_{id}.yaml
  /store/shipping-options:
    $ref: paths/store_shipping-options.yaml
+  /store/shipping-options/{id}/calculate:
+    $ref: paths/store_shipping-options_{id}_calculate.yaml
 components:
  securitySchemes:
    jwt_token:
--- a/www/apps/api-reference/specs/store/paths/store_shipping-options_{id}_calculate.yaml
+++ b/www/apps/api-reference/specs/store/paths/store_shipping-options_{id}_calculate.yaml
@@ -0,0 +1,80 @@
+post:
+  operationId: PostShippingOptionsIdCalculate
+  summary: Calculate Shipping Option Price
+  description: Calculate the price of a shipping option in a cart.
+  x-authenticated: false
+  parameters:
+    - name: id
+      in: path
+      description: The shipping option's ID.
+      required: true
+      schema:
+        type: string
+    - name: fields
+      in: query
+      description: >-
+        Comma-separated fields that should be included in the returned data.
+
+        if a field is prefixed with `+` it will be added to the default fields,
+        using `-` will remove it from the default fields.
+
+        without prefix it will replace the entire default fields.
+      required: false
+      schema:
+        type: string
+        title: fields
+        description: >-
+          Comma-separated fields that should be included in the returned data.
+          If a field is prefixed with `+` it will be added to the default
+          fields, using `-` will remove it from the default fields. Without
+          prefix it will replace the entire default fields.
+        externalDocs:
+          url: '#select-fields-and-relations'
+  requestBody:
+    content:
+      application/json:
+        schema:
+          type: object
+          description: The calculation's details.
+          required:
+            - cart_id
+          properties:
+            cart_id:
+              type: string
+              title: cart_id
+              description: The ID of the cart the shipping option is used in.
+            data:
+              type: object
+              description: >-
+                Custom data that's useful for the fulfillment provider to
+                calculate the price.
+              externalDocs:
+                url: >-
+                  https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
+  x-codeSamples:
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/store_shipping-options_{id}_calculate/post.sh
+  tags:
+    - Shipping Options
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            $ref: ../components/schemas/StoreShippingOptionResponse.yaml
+    '400':
+      $ref: ../components/responses/400_error.yaml
+    '401':
+      $ref: ../components/responses/unauthorized.yaml
+    '404':
+      $ref: ../components/responses/not_found_error.yaml
+    '409':
+      $ref: ../components/responses/invalid_state_error.yaml
+    '422':
+      $ref: ../components/responses/invalid_request_error.yaml
+    '500':
+      $ref: ../components/responses/500_error.yaml
+  x-workflow: calculateShippingOptionsPricesWorkflow