chore(docs): Generated API Reference (#3061)

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>

docs/api/store/code_samples/JavaScript/product-categories_{id}/getundefined

@@ -0,0 +1,7 @@
+import Medusa from "@medusajs/medusa-js"
+const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
+// must be previously logged in or use api token
+medusa.productCategories.retrieve("pcat-id")
+.then(({ productCategory }) => {
+  console.log(productCategory.id);
+});

docs/api/store/code_samples/JavaScript/product-tags/getundefined

@@ -0,0 +1,6 @@
+import Medusa from "@medusajs/medusa-js"
+const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
+medusa.store.productTags.list()
+.then(({ product_tags }) => {
+  console.log(product_tags.length);
+});

docs/api/store/code_samples/Shell/product-categories/getundefined

@@ -0,0 +1,2 @@
+curl --location --request GET 'https://medusa-url.com/store/product-categories' \
+--header 'Authorization: Bearer {api_token}'

docs/api/store/code_samples/Shell/product-categories_{id}/getundefined

@@ -0,0 +1,2 @@
+curl --location --request GET 'https://medusa-url.com/store/product-categories/{id}' \
+--header 'Authorization: Bearer {api_token}'

docs/api/store/code_samples/Shell/product-tags/getundefined

@@ -0,0 +1 @@
+curl --location --request GET 'https://medusa-url.com/store/product-tags'

docs/api/store/components/schemas/PricedProduct.yaml

@@ -0,0 +1,10 @@
+title: Priced Product
+type: object
+allOf:
+  - $ref: ./Product.yaml
+  - type: object
+    properties:
+      variants:
+        type: array
+        items:
+          $ref: ./PricedVariant.yaml

docs/api/store/components/schemas/PricedVariant.yaml

@@ -0,0 +1,41 @@
+title: Priced Product Variant
+type: object
+allOf:
+  - $ref: ./ProductVariant.yaml
+  - type: object
+    properties:
+      original_price:
+        type: number
+        description: >-
+          The original price of the variant without any discounted prices
+          applied.
+      calculated_price:
+        type: number
+        description: The calculated price of the variant. Can be a discounted price.
+      original_price_incl_tax:
+        type: number
+        description: The original price of the variant including taxes.
+      calculated_price_incl_tax:
+        type: number
+        description: The calculated price of the variant including taxes.
+      original_tax:
+        type: number
+        description: The taxes applied on the original price.
+      calculated_tax:
+        type: number
+        description: The taxes applied on the calculated price.
+      tax_rates:
+        type: array
+        description: An array of applied tax rates
+        items:
+          type: object
+          properties:
+            rate:
+              type: number
+              description: The tax rate value
+            name:
+              type: string
+              description: The name of the tax rate
+            code:
+              type: string
+              description: The code of the tax rate

docs/api/store/components/schemas/ProductVariantInventoryItem.yaml

@@ -0,0 +1,34 @@
+title: Product Variant Inventory Item
+description: >-
+  Product Variant Inventory Items link variants with inventory items and denote
+  the number of inventory items constituting a variant.
+type: object
+properties:
+  id:
+    type: string
+    description: The product variant inventory item's ID
+    example: pvitem_01G8X9A7ESKAJXG2H0E6F1MW7A
+  inventory_item_id:
+    description: The id of the inventory item
+    type: string
+  variant_id:
+    description: The id of the variant.
+    type: string
+  required_quantity:
+    description: >-
+      The quantity of an inventory item required for one quantity of the
+      variant.
+    type: integer
+    default: 1
+  created_at:
+    type: string
+    description: The date with timezone at which the resource was created.
+    format: date-time
+  updated_at:
+    type: string
+    description: The date with timezone at which the resource was updated.
+    format: date-time
+  deleted_at:
+    type: string
+    description: The date with timezone at which the resource was deleted.
+    format: date-time

docs/api/store/components/schemas/ProductVariantPricesFields.yaml

@@ -1,37 +0,0 @@
-title: Product Variant Prices Fields
-description: Product Variants Prices Fields that are only available in some requests.
-type: object
-properties:
-  original_price:
-    type: number
-    description: The original price of the variant without any discounted prices applied.
-  calculated_price:
-    type: number
-    description: The calculated price of the variant. Can be a discounted price.
-  original_price_incl_tax:
-    type: number
-    description: The original price of the variant including taxes.
-  calculated_price_incl_tax:
-    type: number
-    description: The calculated price of the variant including taxes.
-  original_tax:
-    type: number
-    description: The taxes applied on the original price.
-  calculated_tax:
-    type: number
-    description: The taxes applied on the calculated price.
-  tax_rates:
-    type: array
-    description: An array of applied tax rates
-    items:
-      type: object
-      properties:
-        rate:
-          type: number
-          description: The tax rate value
-        name:
-          type: string
-          description: The name of the tax rate
-        code:
-          type: string
-          description: The code of the tax rate

docs/api/store/components/schemas/ReservationItemDTO.yaml

@@ -0,0 +1,38 @@
+title: Reservation item
+description: Represents a reservation of an inventory item at a stock location
+type: object
+required:
+  - id
+  - location_id
+  - inventory_item_id
+  - quantity
+properties:
+  id:
+    description: The id of the reservation item
+    type: string
+  location_id:
+    description: The id of the location of the reservation
+    type: string
+  inventory_item_id:
+    description: The id of the inventory item the reservation relates to
+    type: string
+  quantity:
+    description: The id of the reservation item
+    type: number
+  metadata:
+    type: object
+    description: An optional key-value map with additional details
+    example:
+      car: white
+  created_at:
+    type: string
+    description: The date with timezone at which the resource was created.
+    format: date-time
+  updated_at:
+    type: string
+    description: The date with timezone at which the resource was updated.
+    format: date-time
+  deleted_at:
+    type: string
+    description: The date with timezone at which the resource was deleted.
+    format: date-time

docs/api/store/components/schemas/StoreAuthRes.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  customer:
+    $ref: ./Customer.yaml

docs/api/store/components/schemas/StoreCartsRes.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  cart:
+    $ref: ./Cart.yaml

docs/api/store/components/schemas/StoreCollectionsListRes.yaml

@@ -0,0 +1,15 @@
+type: object
+properties:
+  collections:
+    type: array
+    items:
+      $ref: ./ProductCollection.yaml
+  count:
+    type: integer
+    description: The total number of items available
+  offset:
+    type: integer
+    description: The number of items skipped before these items
+  limit:
+    type: integer
+    description: The number of items per page

docs/api/store/components/schemas/StoreCollectionsRes.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  collection:
+    $ref: ./ProductCollection.yaml

docs/api/store/components/schemas/StoreCompleteCartRes.yaml

@@ -0,0 +1,29 @@
+type: object
+properties:
+  type:
+    type: string
+    description: The type of the data property.
+    enum:
+      - order
+      - cart
+      - swap
+  data:
+    type: object
+    description: The data of the result object. Its type depends on the type field.
+    oneOf:
+      - type: object
+        allOf:
+          - description: >-
+              Cart was successfully authorized and order was placed
+              successfully.
+          - $ref: ./Order.yaml
+      - type: object
+        allOf:
+          - description: Cart was successfully authorized but requires further actions.
+          - $ref: ./Cart.yaml
+      - type: object
+        allOf:
+          - description: >-
+              When cart is used for a swap and it has been completed
+              successfully.
+          - $ref: ./Swap.yaml

docs/api/store/components/schemas/StoreCustomersListOrdersRes.yaml

@@ -0,0 +1,15 @@
+type: object
+properties:
+  orders:
+    type: array
+    items:
+      $ref: ./Order.yaml
+  count:
+    type: integer
+    description: The total number of items available
+  offset:
+    type: integer
+    description: The number of items skipped before these items
+  limit:
+    type: integer
+    description: The number of items per page

docs/api/store/components/schemas/StoreCustomersListPaymentMethodsRes.yaml

@@ -0,0 +1,15 @@
+type: object
+properties:
+  payment_methods:
+    type: array
+    items:
+      type: object
+      properties:
+        provider_id:
+          type: string
+          description: The id of the Payment Provider where the payment method is saved.
+        data:
+          type: object
+          description: >-
+            The data needed for the Payment Provider to use the saved payment
+            method.

docs/api/store/components/schemas/StoreCustomersRes.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  customer:
+    $ref: ./Customer.yaml

docs/api/store/components/schemas/StoreGetAuthEmailRes.yaml

@@ -0,0 +1,5 @@
+type: object
+properties:
+  exists:
+    type: boolean
+    description: Whether email exists or not.

docs/api/store/components/schemas/StoreGetProductCategoryRes.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  product_category:
+    $ref: ./ProductCategory.yaml

docs/api/store/components/schemas/StoreGiftCardsRes.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  gift_card:
+    $ref: ./GiftCard.yaml

docs/api/store/components/schemas/StoreOrderEditsRes.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  order_edit:
+    $ref: ./OrderEdit.yaml

docs/api/store/components/schemas/StoreOrdersRes.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  order:
+    $ref: ./Order.yaml

docs/api/store/components/schemas/StorePaymentCollectionsRes.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  payment_collection:
+    $ref: ./PaymentCollection.yaml

docs/api/store/components/schemas/StorePaymentCollectionsSessionRes.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  payment_session:
+    $ref: ./PaymentSession.yaml

docs/api/store/components/schemas/StorePostSearchRes.yaml

@@ -0,0 +1,7 @@
+type: object
+properties:
+  hits:
+    type: array
+    description: >-
+      Array of results. The format of the items depends on the search engine
+      installed on the server.

docs/api/store/components/schemas/StoreProductTypesListRes.yaml

@@ -0,0 +1,15 @@
+type: object
+properties:
+  product_types:
+    type: array
+    items:
+      $ref: ./ProductType.yaml
+  count:
+    type: integer
+    description: The total number of items available
+  offset:
+    type: integer
+    description: The number of items skipped before these items
+  limit:
+    type: integer
+    description: The number of items per page

docs/api/store/components/schemas/StoreProductsListRes.yaml

@@ -0,0 +1,15 @@
+type: object
+properties:
+  products:
+    type: array
+    items:
+      $ref: ./PricedProduct.yaml
+  count:
+    type: integer
+    description: The total number of items available
+  offset:
+    type: integer
+    description: The number of items skipped before these items
+  limit:
+    type: integer
+    description: The number of items per page

docs/api/store/components/schemas/StoreProductsRes.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  product:
+    $ref: ./PricedProduct.yaml

docs/api/store/components/schemas/StoreRegionsListRes.yaml

@@ -0,0 +1,6 @@
+type: object
+properties:
+  regions:
+    type: array
+    items:
+      $ref: ./Region.yaml

docs/api/store/components/schemas/StoreRegionsRes.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  region:
+    $ref: ./Region.yaml

docs/api/store/components/schemas/StoreReturnReasonsListRes.yaml

@@ -0,0 +1,6 @@
+type: object
+properties:
+  return_reasons:
+    type: array
+    items:
+      $ref: ./ReturnReason.yaml

docs/api/store/components/schemas/StoreReturnReasonsRes.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  return_reason:
+    $ref: ./ReturnReason.yaml

docs/api/store/components/schemas/StoreReturnsRes.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  return:
+    $ref: ./Return.yaml

docs/api/store/components/schemas/StoreShippingOptionsListRes.yaml

@@ -0,0 +1,6 @@
+type: object
+properties:
+  shipping_options:
+    type: array
+    items:
+      $ref: ./ShippingOption.yaml

docs/api/store/components/schemas/StoreSwapsRes.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  swap:
+    $ref: ./Swap.yaml

docs/api/store/components/schemas/StoreVariantsListRes.yaml

@@ -0,0 +1,6 @@
+type: object
+properties:
+  variants:
+    type: array
+    items:
+      $ref: ./PricedVariant.yaml

docs/api/store/components/schemas/StoreVariantsRes.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  variant:
+    $ref: ./PricedVariant.yaml

docs/api/store/openapi.yaml

@@ -209,6 +209,12 @@ paths:
     $ref: paths/payment-collections_{id}_sessions.yaml
   /payment-collections/{id}/sessions/{session_id}:
     $ref: paths/payment-collections_{id}_sessions_{session_id}.yaml
+  /product-categories/{id}:
+    $ref: paths/product-categories_{id}.yaml
+  /product-categories:
+    $ref: paths/product-categories.yaml
+  /product-tags:
+    $ref: paths/product-tags.yaml
   /product-types:
     $ref: paths/product-types.yaml
   /products/{id}:

docs/api/store/paths/auth.yaml

@@ -22,10 +22,7 @@ post:
       content:
         application/json:
           schema:
-            type: object
-            properties:
-              customer:
-                $ref: ../components/schemas/Customer.yaml
+            $ref: ../components/schemas/StoreAuthRes.yaml
     '400':
       $ref: ../components/responses/400_error.yaml
     '401':
@@ -106,10 +103,7 @@ get:
       content:
         application/json:
           schema:
-            type: object
-            properties:
-              customer:
-                $ref: ../components/schemas/Customer.yaml
+            $ref: ../components/schemas/StoreAuthRes.yaml
     '400':
       $ref: ../components/responses/400_error.yaml
     '401':

docs/api/store/paths/auth_{email}.yaml

@@ -27,11 +27,7 @@ get:
       content:
         application/json:
           schema:
-            type: object
-            properties:
-              exists:
-                type: boolean
-                description: Whether email exists or not.
+            $ref: ../components/schemas/StoreGetAuthEmailRes.yaml
     '400':
       $ref: ../components/responses/400_error.yaml
     '404':

docs/api/store/paths/carts.yaml

@@ -28,10 +28,7 @@ post:
       content:
         application/json:
           schema:
-            type: object
-            properties:
-              cart:
-                $ref: ../components/schemas/Cart.yaml
+            $ref: ../components/schemas/StoreCartsRes.yaml
     '400':
       $ref: ../components/responses/400_error.yaml
     '404':

docs/api/store/paths/carts_{id}.yaml

@@ -26,10 +26,7 @@ get:
       content:
         application/json:
           schema:
-            type: object
-            properties:
-              cart:
-                $ref: ../components/schemas/Cart.yaml
+            $ref: ../components/schemas/StoreCartsRes.yaml
     '400':
       $ref: ../components/responses/400_error.yaml
     '404':
@@ -73,10 +70,7 @@ post:
       content:
         application/json:
           schema:
-            type: object
-            properties:
-              cart:
-                $ref: ../components/schemas/Cart.yaml
+            $ref: ../components/schemas/StoreCartsRes.yaml
     '400':
       $ref: ../components/responses/400_error.yaml
     '404':

docs/api/store/paths/carts_{id}_complete.yaml

@@ -36,42 +36,7 @@ post:
       content:
         application/json:
           schema:
-            type: object
-            properties:
-              type:
-                type: string
-                description: The type of the data property.
-                enum:
-                  - order
-                  - cart
-                  - swap
-              data:
-                type: object
-                description: >-
-                  The data of the result object. Its type depends on the type
-                  field.
-                oneOf:
-                  - type: object
-                    description: >-
-                      Cart was successfully authorized and order was placed
-                      successfully.
-                    properties:
-                      order:
-                        $ref: ../components/schemas/Order.yaml
-                  - type: object
-                    description: >-
-                      Cart was successfully authorized but requires further
-                      actions.
-                    properties:
-                      cart:
-                        $ref: ../components/schemas/Cart.yaml
-                  - type: object
-                    description: >-
-                      When cart is used for a swap and it has been completed
-                      successfully.
-                    properties:
-                      cart:
-                        $ref: ../components/schemas/Swap.yaml
+            $ref: ../components/schemas/StoreCompleteCartRes.yaml
     '400':
       $ref: ../components/responses/400_error.yaml
     '404':

docs/api/store/paths/carts_{id}_discounts_{code}.yaml

@@ -32,10 +32,7 @@ delete:
       content:
         application/json:
           schema:
-            type: object
-            properties:
-              cart:
-                $ref: ../components/schemas/Cart.yaml
+            $ref: ../components/schemas/StoreCartsRes.yaml
     '400':
       $ref: ../components/responses/400_error.yaml
     '404':

docs/api/store/paths/carts_{id}_line-items.yaml

@@ -26,10 +26,7 @@ post:
       content:
         application/json:
           schema:
-            type: object
-            properties:
-              cart:
-                $ref: ../components/schemas/Cart.yaml
+            $ref: ../components/schemas/StoreCartsRes.yaml
     '400':
       $ref: ../components/responses/400_error.yaml
     '404':

docs/api/store/paths/carts_{id}_line-items_{line_id}.yaml

@@ -33,10 +33,7 @@ delete:
       content:
         application/json:
           schema:
-            type: object
-            properties:
-              cart:
-                $ref: ../components/schemas/Cart.yaml
+            $ref: ../components/schemas/StoreCartsRes.yaml
     '400':
       $ref: ../components/responses/400_error.yaml
     '404':
@@ -82,10 +79,7 @@ post:
       content:
         application/json:
           schema:
-            type: object
-            properties:
-              cart:
-                $ref: ../components/schemas/Cart.yaml
+            $ref: ../components/schemas/StoreCartsRes.yaml
     '400':
       $ref: ../components/responses/400_error.yaml
     '404':

docs/api/store/paths/carts_{id}_payment-session.yaml

@@ -28,10 +28,7 @@ post:
       content:
         application/json:
           schema:
-            type: object
-            properties:
-              cart:
-                $ref: ../components/schemas/Cart.yaml
+            $ref: ../components/schemas/StoreCartsRes.yaml
     '400':
       $ref: ../components/responses/400_error.yaml
     '404':

docs/api/store/paths/carts_{id}_payment-sessions.yaml

@@ -28,10 +28,7 @@ post:
       content:
         application/json:
           schema:
-            type: object
-            properties:
-              cart:
-                $ref: ../components/schemas/Cart.yaml
+            $ref: ../components/schemas/StoreCartsRes.yaml
     '400':
       $ref: ../components/responses/400_error.yaml
     '404':

docs/api/store/paths/carts_{id}_payment-sessions_{provider_id}.yaml

@@ -36,10 +36,7 @@ delete:
       content:
         application/json:
           schema:
-            type: object
-            properties:
-              cart:
-                $ref: ../components/schemas/Cart.yaml
+            $ref: ../components/schemas/StoreCartsRes.yaml
     '400':
       $ref: ../components/responses/400_error.yaml
     '404':
@@ -86,10 +83,7 @@ post:
       content:
         application/json:
           schema:
-            type: object
-            properties:
-              cart:
-                $ref: ../components/schemas/Cart.yaml
+            $ref: ../components/schemas/StoreCartsRes.yaml
     '400':
       $ref: ../components/responses/400_error.yaml
     '404':

docs/api/store/paths/carts_{id}_payment-sessions_{provider_id}_refresh.yaml

@@ -38,10 +38,7 @@ post:
       content:
         application/json:
           schema:
-            type: object
-            properties:
-              cart:
-                $ref: ../components/schemas/Cart.yaml
+            $ref: ../components/schemas/StoreCartsRes.yaml
     '400':
       $ref: ../components/responses/400_error.yaml
     '404':

docs/api/store/paths/carts_{id}_shipping-methods.yaml

@@ -26,10 +26,7 @@ post:
       content:
         application/json:
           schema:
-            type: object
-            properties:
-              cart:
-                $ref: ../components/schemas/Cart.yaml
+            $ref: ../components/schemas/StoreCartsRes.yaml
     '400':
       $ref: ../components/responses/400_error.yaml
     '404':

docs/api/store/paths/carts_{id}_taxes.yaml

@@ -24,10 +24,7 @@ post:
       content:
         application/json:
           schema:
-            type: object
-            properties:
-              cart:
-                $ref: ../components/schemas/Cart.yaml
+            $ref: ../components/schemas/StoreCartsRes.yaml
     '400':
       $ref: ../components/responses/400_error.yaml
     '404':

docs/api/store/paths/collections.yaml

@@ -78,21 +78,7 @@ get:
       content:
         application/json:
           schema:
-            type: object
-            properties:
-              collections:
-                type: array
-                items:
-                  $ref: ../components/schemas/ProductCollection.yaml
-              count:
-                type: integer
-                description: The total number of items available
-              offset:
-                type: integer
-                description: The number of items skipped before these items
-              limit:
-                type: integer
-                description: The number of items per page
+            $ref: ../components/schemas/StoreCollectionsListRes.yaml
     '400':
       $ref: ../components/responses/400_error.yaml
     '404':

docs/api/store/paths/collections_{id}.yaml

@@ -26,10 +26,7 @@ get:
       content:
         application/json:
           schema:
-            type: object
-            properties:
-              collection:
-                $ref: ../components/schemas/ProductCollection.yaml
+            $ref: ../components/schemas/StoreCollectionsRes.yaml
     '400':
       $ref: ../components/responses/400_error.yaml
     '404':

docs/api/store/paths/customers.yaml

@@ -24,10 +24,7 @@ post:
       content:
         application/json:
           schema:
-            type: object
-            properties:
-              customer:
-                $ref: ../components/schemas/Customer.yaml
+            $ref: ../components/schemas/StoreCustomersRes.yaml
     '400':
       $ref: ../components/responses/400_error.yaml
     '404':

docs/api/store/paths/customers_me.yaml

@@ -24,10 +24,7 @@ get:
       content:
         application/json:
           schema:
-            type: object
-            properties:
-              customer:
-                $ref: ../components/schemas/Customer.yaml
+            $ref: ../components/schemas/StoreCustomersRes.yaml
     '400':
       $ref: ../components/responses/400_error.yaml
     '401':
@@ -69,10 +66,7 @@ post:
       content:
         application/json:
           schema:
-            type: object
-            properties:
-              customer:
-                $ref: ../components/schemas/Customer.yaml
+            $ref: ../components/schemas/StoreCustomersRes.yaml
     '400':
       $ref: ../components/responses/400_error.yaml
     '401':

docs/api/store/paths/customers_me_addresses.yaml

@@ -27,10 +27,7 @@ post:
       content:
         application/json:
           schema:
-            type: object
-            properties:
-              customer:
-                $ref: ../components/schemas/Customer.yaml
+            $ref: ../components/schemas/StoreCustomersRes.yaml
     '400':
       $ref: ../components/responses/400_error.yaml
     '401':

docs/api/store/paths/customers_me_addresses_{address_id}.yaml

@@ -31,10 +31,7 @@ delete:
       content:
         application/json:
           schema:
-            type: object
-            properties:
-              customer:
-                $ref: ../components/schemas/Customer.yaml
+            $ref: ../components/schemas/StoreCustomersRes.yaml
     '400':
       $ref: ../components/responses/400_error.yaml
     '401':
@@ -86,10 +83,7 @@ post:
       content:
         application/json:
           schema:
-            type: object
-            properties:
-              customer:
-                $ref: ../components/schemas/Customer.yaml
+            $ref: ../components/schemas/StoreCustomersRes.yaml
     '400':
       $ref: ../components/responses/400_error.yaml
     '401':

docs/api/store/paths/customers_me_orders.yaml

@@ -187,21 +187,7 @@ get:
       content:
         application/json:
           schema:
-            type: object
-            properties:
-              orders:
-                type: array
-                items:
-                  $ref: ../components/schemas/Order.yaml
-              count:
-                type: integer
-                description: The total number of items available
-              offset:
-                type: integer
-                description: The number of items skipped before these items
-              limit:
-                type: integer
-                description: The number of items per page
+            $ref: ../components/schemas/StoreCustomersListOrdersRes.yaml
     '400':
       $ref: ../components/responses/400_error.yaml
     '401':

docs/api/store/paths/customers_me_payment-methods.yaml

@@ -25,22 +25,7 @@ get:
       content:
         application/json:
           schema:
-            type: object
-            properties:
-              payment_methods:
-                type: array
-                items:
-                  properties:
-                    provider_id:
-                      type: string
-                      description: >-
-                        The id of the Payment Provider where the payment method
-                        is saved.
-                    data:
-                      type: object
-                      description: >-
-                        The data needed for the Payment Provider to use the
-                        saved payment method.
+            $ref: ../components/schemas/StoreCustomersListPaymentMethodsRes.yaml
     '400':
       $ref: ../components/responses/400_error.yaml
     '401':

docs/api/store/paths/customers_password-reset.yaml

@@ -26,10 +26,7 @@ post:
       content:
         application/json:
           schema:
-            type: object
-            properties:
-              customer:
-                $ref: ../components/schemas/Customer.yaml
+            $ref: ../components/schemas/StoreCustomersRes.yaml
     '400':
       $ref: ../components/responses/400_error.yaml
     '401':

docs/api/store/paths/gift-cards_{code}.yaml

@@ -26,10 +26,7 @@ get:
       content:
         application/json:
           schema:
-            type: object
-            properties:
-              gift_card:
-                $ref: ../components/schemas/GiftCard.yaml
+            $ref: ../components/schemas/StoreGiftCardsRes.yaml
     '400':
       $ref: ../components/responses/400_error.yaml
     '404':

docs/api/store/paths/order-edits_{id}.yaml

@@ -26,10 +26,7 @@ get:
       content:
         application/json:
           schema:
-            type: object
-            properties:
-              order_edit:
-                $ref: ../components/schemas/OrderEdit.yaml
+            $ref: ../components/schemas/StoreOrderEditsRes.yaml
     '400':
       $ref: ../components/responses/400_error.yaml
     '401':

docs/api/store/paths/order-edits_{id}_complete.yaml

@@ -26,10 +26,7 @@ post:
       content:
         application/json:
           schema:
-            type: object
-            properties:
-              order_edit:
-                $ref: ../components/schemas/OrderEdit.yaml
+            $ref: ../components/schemas/StoreOrderEditsRes.yaml
     '400':
       $ref: ../components/responses/400_error.yaml
     '401':

docs/api/store/paths/order-edits_{id}_decline.yaml

@@ -31,10 +31,7 @@ post:
       content:
         application/json:
           schema:
-            type: object
-            properties:
-              order_edit:
-                $ref: ../components/schemas/OrderEdit.yaml
+            $ref: ../components/schemas/StoreOrderEditsRes.yaml
     '400':
       $ref: ../components/responses/400_error.yaml
     '401':

docs/api/store/paths/orders.yaml

@@ -46,10 +46,7 @@ get:
       content:
         application/json:
           schema:
-            type: object
-            properties:
-              order:
-                $ref: ../components/schemas/Order.yaml
+            $ref: ../components/schemas/StoreOrdersRes.yaml
     '400':
       $ref: ../components/responses/400_error.yaml
     '404':

docs/api/store/paths/orders_cart_{cart_id}.yaml

@@ -26,10 +26,7 @@ get:
       content:
         application/json:
           schema:
-            type: object
-            properties:
-              order:
-                $ref: ../components/schemas/Order.yaml
+            $ref: ../components/schemas/StoreOrdersRes.yaml
     '400':
       $ref: ../components/responses/400_error.yaml
     '404':

docs/api/store/paths/orders_{id}.yaml

@@ -26,10 +26,7 @@ get:
       content:
         application/json:
           schema:
-            type: object
-            properties:
-              order:
-                $ref: ../components/schemas/Order.yaml
+            $ref: ../components/schemas/StoreOrdersRes.yaml
     '400':
       $ref: ../components/responses/400_error.yaml
     '404':

docs/api/store/paths/payment-collections_{id}.yaml

@@ -40,10 +40,7 @@ get:
       content:
         application/json:
           schema:
-            type: object
-            properties:
-              payment_collection:
-                $ref: ../components/schemas/PaymentCollection.yaml
+            $ref: ../components/schemas/StorePaymentCollectionsRes.yaml
     '400':
       $ref: ../components/responses/400_error.yaml
     '401':

docs/api/store/paths/payment-collections_{id}_sessions.yaml

@@ -36,9 +36,7 @@ post:
       content:
         application/json:
           schema:
-            properties:
-              payment_collection:
-                $ref: ../components/schemas/PaymentCollection.yaml
+            $ref: ../components/schemas/StorePaymentCollectionsRes.yaml
     '400':
       $ref: ../components/responses/400_error.yaml
     '401':

docs/api/store/paths/payment-collections_{id}_sessions_batch.yaml

@@ -38,9 +38,7 @@ post:
       content:
         application/json:
           schema:
-            properties:
-              payment_collection:
-                $ref: ../components/schemas/PaymentCollection.yaml
+            $ref: ../components/schemas/StorePaymentCollectionsRes.yaml
     '400':
       $ref: ../components/responses/400_error.yaml
     '401':

docs/api/store/paths/payment-collections_{id}_sessions_batch_authorize.yaml

@@ -38,9 +38,7 @@ post:
       content:
         application/json:
           schema:
-            properties:
-              payment_collection:
-                $ref: ../components/schemas/PaymentCollection.yaml
+            $ref: ../components/schemas/StorePaymentCollectionsRes.yaml
     '400':
       $ref: ../components/responses/400_error.yaml
     '401':

docs/api/store/paths/payment-collections_{id}_sessions_{session_id}.yaml

@@ -37,10 +37,7 @@ post:
       content:
         application/json:
           schema:
-            type: object
-            properties:
-              payment_session:
-                $ref: ../components/schemas/PaymentSession.yaml
+            $ref: ../components/schemas/StorePaymentCollectionsSessionRes.yaml
     '400':
       $ref: ../components/responses/400_error.yaml
     '404':

docs/api/store/paths/payment-collections_{id}_sessions_{session_id}_authorize.yaml

@@ -38,9 +38,7 @@ post:
       content:
         application/json:
           schema:
-            properties:
-              payment_session:
-                $ref: ../components/schemas/PaymentSession.yaml
+            $ref: ../components/schemas/StorePaymentCollectionsSessionRes.yaml
     '400':
       $ref: ../components/responses/400_error.yaml
     '401':

docs/api/store/paths/product-categories.yaml

@@ -0,0 +1,71 @@
+get:
+  operationId: GetProductCategories
+  summary: List Product Categories
+  description: Retrieve a list of product categories.
+  x-authenticated: false
+  parameters:
+    - in: query
+      name: q
+      description: Query used for searching product category names orhandles.
+      schema:
+        type: string
+    - in: query
+      name: parent_category_id
+      description: Returns categories scoped by parent
+      schema:
+        type: string
+    - in: query
+      name: offset
+      description: How many product categories to skip in the result.
+      schema:
+        type: integer
+        default: 0
+    - in: query
+      name: limit
+      description: Limit the number of product categories returned.
+      schema:
+        type: integer
+        default: 100
+  x-codeSamples:
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/product-categories/getundefined
+  security:
+    - api_token: []
+    - cookie_auth: []
+  tags:
+    - Product Category
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              product_categories:
+                type: array
+                items:
+                  $ref: ../components/schemas/ProductCategory.yaml
+              count:
+                type: integer
+                description: The total number of items available
+              offset:
+                type: integer
+                description: The number of items skipped before these items
+              limit:
+                type: integer
+                description: The number of items per page
+    '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

docs/api/store/paths/product-categories_{id}.yaml

@@ -0,0 +1,59 @@
+get:
+  operationId: GetProductCategoriesCategory
+  summary: Get a Product Category
+  description: Retrieves a Product Category.
+  x-authenticated: false
+  parameters:
+    - in: path
+      name: id
+      required: true
+      description: The ID of the Product Category
+      schema:
+        type: string
+    - in: query
+      name: expand
+      description: >-
+        (Comma separated) Which fields should be expanded in each product
+        category.
+      schema:
+        type: string
+    - in: query
+      name: fields
+      description: >-
+        (Comma separated) Which fields should be retrieved in each product
+        category.
+      schema:
+        type: string
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: ../code_samples/JavaScript/product-categories_{id}/getundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/product-categories_{id}/getundefined
+  security:
+    - api_token: []
+    - cookie_auth: []
+  tags:
+    - Product Category
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            $ref: ../components/schemas/StoreGetProductCategoryRes.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

docs/api/store/paths/product-tags.yaml

@@ -0,0 +1,137 @@
+get:
+  operationId: GetProductTags
+  summary: List Product Tags
+  description: Retrieve a list of Product Tags.
+  x-authenticated: true
+  parameters:
+    - in: query
+      name: limit
+      description: The number of types to return.
+      schema:
+        type: integer
+        default: 20
+    - in: query
+      name: offset
+      description: The number of items to skip before the results.
+      schema:
+        type: integer
+        default: 0
+    - in: query
+      name: order
+      description: The field to sort items by.
+      schema:
+        type: string
+    - in: query
+      name: discount_condition_id
+      description: The discount condition id on which to filter the product tags.
+      schema:
+        type: string
+    - in: query
+      name: value
+      style: form
+      explode: false
+      description: The tag values to search for
+      schema:
+        type: array
+        items:
+          type: string
+    - in: query
+      name: id
+      style: form
+      explode: false
+      description: The tag IDs to search for
+      schema:
+        type: array
+        items:
+          type: string
+    - in: query
+      name: q
+      description: A query string to search values for
+      schema:
+        type: string
+    - in: query
+      name: created_at
+      description: Date comparison for when resulting product tags were created.
+      schema:
+        type: object
+        properties:
+          lt:
+            type: string
+            description: filter by dates less than this date
+            format: date
+          gt:
+            type: string
+            description: filter by dates greater than this date
+            format: date
+          lte:
+            type: string
+            description: filter by dates less than or equal to this date
+            format: date
+          gte:
+            type: string
+            description: filter by dates greater than or equal to this date
+            format: date
+    - in: query
+      name: updated_at
+      description: Date comparison for when resulting product tags were updated.
+      schema:
+        type: object
+        properties:
+          lt:
+            type: string
+            description: filter by dates less than this date
+            format: date
+          gt:
+            type: string
+            description: filter by dates greater than this date
+            format: date
+          lte:
+            type: string
+            description: filter by dates less than or equal to this date
+            format: date
+          gte:
+            type: string
+            description: filter by dates greater than or equal to this date
+            format: date
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: ../code_samples/JavaScript/product-tags/getundefined
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/product-tags/getundefined
+  tags:
+    - Product Tag
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              product_tags:
+                $ref: ../components/schemas/ProductTag.yaml
+              count:
+                type: integer
+                description: The total number of items available
+              offset:
+                type: integer
+                description: The number of items skipped before these items
+              limit:
+                type: integer
+                description: The number of items per page
+    '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

docs/api/store/paths/product-types.yaml

@@ -113,19 +113,7 @@ get:
       content:
         application/json:
           schema:
-            type: object
-            properties:
-              product_types:
-                $ref: ../components/schemas/ProductType.yaml
-              count:
-                type: integer
-                description: The total number of items available
-              offset:
-                type: integer
-                description: The number of items skipped before these items
-              limit:
-                type: integer
-                description: The number of items per page
+            $ref: ../components/schemas/StoreProductTypesListRes.yaml
     '400':
       $ref: ../components/responses/400_error.yaml
     '401':

docs/api/store/paths/products.yaml

@@ -169,31 +169,7 @@ get:
       content:
         application/json:
           schema:
-            type: object
-            properties:
-              products:
-                type: array
-                items:
-                  allOf:
-                    - $ref: ../components/schemas/Product.yaml
-                    - type: object
-                      properties:
-                        variants:
-                          type: array
-                          items:
-                            allOf:
-                              - $ref: ../components/schemas/ProductVariant.yaml
-                              - $ref: >-
-                                  ../components/schemas/ProductVariantPricesFields.yaml
-              count:
-                type: integer
-                description: The total number of items available
-              offset:
-                type: integer
-                description: The number of items skipped before these items
-              limit:
-                type: integer
-                description: The number of items per page
+            $ref: ../components/schemas/StoreProductsListRes.yaml
     '400':
       $ref: ../components/responses/400_error.yaml
     '404':

docs/api/store/paths/products_search.yaml

@@ -36,13 +36,7 @@ post:
       content:
         application/json:
           schema:
-            type: object
-            properties:
-              hits:
-                type: array
-                description: >-
-                  Array of results. The format of the items depends on the
-                  search engine installed on the server.
+            $ref: ../components/schemas/StorePostSearchRes.yaml
     '400':
       $ref: ../components/responses/400_error.yaml
     '404':

docs/api/store/paths/products_{id}.yaml

@@ -50,20 +50,7 @@ get:
       content:
         application/json:
           schema:
-            type: object
-            properties:
-              product:
-                allOf:
-                  - $ref: ../components/schemas/Product.yaml
-                  - type: object
-                    properties:
-                      variants:
-                        type: array
-                        items:
-                          allOf:
-                            - $ref: ../components/schemas/ProductVariant.yaml
-                            - $ref: >-
-                                ../components/schemas/ProductVariantPricesFields.yaml
+            $ref: ../components/schemas/StoreProductsRes.yaml
     '400':
       $ref: ../components/responses/400_error.yaml
     '404':

docs/api/store/paths/regions.yaml

@@ -76,12 +76,7 @@ get:
       content:
         application/json:
           schema:
-            type: object
-            properties:
-              regions:
-                type: array
-                items:
-                  $ref: ../components/schemas/Region.yaml
+            $ref: ../components/schemas/StoreRegionsListRes.yaml
     '400':
       $ref: ../components/responses/400_error.yaml
     '404':

docs/api/store/paths/regions_{id}.yaml

@@ -26,10 +26,7 @@ get:
       content:
         application/json:
           schema:
-            type: object
-            properties:
-              region:
-                $ref: ../components/schemas/Region.yaml
+            $ref: ../components/schemas/StoreRegionsRes.yaml
     '400':
       $ref: ../components/responses/400_error.yaml
     '404':

docs/api/store/paths/return-reasons.yaml

@@ -19,12 +19,7 @@ get:
       content:
         application/json:
           schema:
-            type: object
-            properties:
-              return_reasons:
-                type: array
-                items:
-                  $ref: ../components/schemas/ReturnReason.yaml
+            $ref: ../components/schemas/StoreReturnReasonsListRes.yaml
     '400':
       $ref: ../components/responses/400_error.yaml
     '404':

docs/api/store/paths/return-reasons_{id}.yaml

@@ -26,10 +26,7 @@ get:
       content:
         application/json:
           schema:
-            type: object
-            properties:
-              return_reason:
-                $ref: ../components/schemas/ReturnReason.yaml
+            $ref: ../components/schemas/StoreReturnReasonsRes.yaml
     '400':
       $ref: ../components/responses/400_error.yaml
     '404':

docs/api/store/paths/returns.yaml

@@ -24,10 +24,7 @@ post:
       content:
         application/json:
           schema:
-            type: object
-            properties:
-              return:
-                $ref: ../components/schemas/Return.yaml
+            $ref: ../components/schemas/StoreReturnsRes.yaml
     '400':
       $ref: ../components/responses/400_error.yaml
     '404':

docs/api/store/paths/shipping-options.yaml

@@ -37,12 +37,7 @@ get:
       content:
         application/json:
           schema:
-            type: object
-            properties:
-              shipping_options:
-                type: array
-                items:
-                  $ref: ../components/schemas/ShippingOption.yaml
+            $ref: ../components/schemas/StoreShippingOptionsListRes.yaml
     '400':
       $ref: ../components/responses/400_error.yaml
     '404':

docs/api/store/paths/shipping-options_{cart_id}.yaml

@@ -26,12 +26,7 @@ get:
       content:
         application/json:
           schema:
-            type: object
-            properties:
-              shipping_options:
-                type: array
-                items:
-                  $ref: ../components/schemas/ShippingOption.yaml
+            $ref: ../components/schemas/StoreShippingOptionsListRes.yaml
     '400':
       $ref: ../components/responses/400_error.yaml
     '404':

docs/api/store/paths/swaps.yaml

@@ -26,10 +26,7 @@ post:
       content:
         application/json:
           schema:
-            type: object
-            properties:
-              swap:
-                $ref: ../components/schemas/Swap.yaml
+            $ref: ../components/schemas/StoreSwapsRes.yaml
     '400':
       $ref: ../components/responses/400_error.yaml
     '404':

docs/api/store/paths/swaps_{cart_id}.yaml

@@ -26,10 +26,7 @@ get:
       content:
         application/json:
           schema:
-            type: object
-            properties:
-              swap:
-                $ref: ../components/schemas/Swap.yaml
+            $ref: ../components/schemas/StoreSwapsRes.yaml
     '400':
       $ref: ../components/responses/400_error.yaml
     '404':

docs/api/store/paths/variants.yaml

@@ -75,14 +75,7 @@ get:
       content:
         application/json:
           schema:
-            type: object
-            properties:
-              variants:
-                type: array
-                items:
-                  allOf:
-                    - $ref: ../components/schemas/ProductVariant.yaml
-                    - $ref: ../components/schemas/ProductVariantPricesFields.yaml
+            $ref: ../components/schemas/StoreVariantsListRes.yaml
     '400':
       $ref: ../components/responses/400_error.yaml
     '404':

docs/api/store/paths/variants_{variant_id}.yaml

@@ -42,12 +42,7 @@ get:
       content:
         application/json:
           schema:
-            type: object
-            properties:
-              variant:
-                allOf:
-                  - $ref: ../components/schemas/ProductVariant.yaml
-                  - $ref: ../components/schemas/ProductVariantPricesFields.yaml
+            $ref: ../components/schemas/StoreVariantsRes.yaml
     '400':
       $ref: ../components/responses/400_error.yaml
     '404':