chore(docs): Generated API Reference (v2) (#8890)

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

www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_inbound_items_{action_id}/delete.sh

@@ -1,2 +1 @@
-curl -X DELETE '{backend_url}/admin/claims/{id}/inbound/items/{action_id}' \
+curl -X DELETE '{backend_url}/admin/claims/{id}/inbound/items/{action_id}' \ -H 'x-medusa-access-token: {api_token}'
--H 'x-medusa-access-token: {api_token}'

www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_inbound_shipping-method_{action_id}/delete.sh

@@ -1,2 +1 @@
-curl -X DELETE '{backend_url}/admin/claims/{id}/inbound/shipping-method/{action_id}' \
+curl -X DELETE '{backend_url}/admin/claims/{id}/inbound/shipping-method/{action_id}' \ -H 'x-medusa-access-token: {api_token}'
--H 'x-medusa-access-token: {api_token}'

www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_outbound_items_{action_id}/delete.sh

@@ -1,2 +1 @@
-curl -X DELETE '{backend_url}/admin/claims/{id}/outbound/items/{action_id}' \
+curl -X DELETE '{backend_url}/admin/claims/{id}/outbound/items/{action_id}' \ -H 'x-medusa-access-token: {api_token}'
--H 'x-medusa-access-token: {api_token}'

www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_outbound_shipping-method_{action_id}/delete.sh

@@ -1,2 +1 @@
-curl -X DELETE '{backend_url}/admin/claims/{id}/outbound/shipping-method/{action_id}' \
+curl -X DELETE '{backend_url}/admin/claims/{id}/outbound/shipping-method/{action_id}' \ -H 'x-medusa-access-token: {api_token}'
--H 'x-medusa-access-token: {api_token}'

www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers_{id}_addresses_{address_id}/delete.sh

@@ -1,2 +1 @@
-curl -X DELETE '{backend_url}/admin/customers/{id}/addresses/{address_id}' \
+curl -X DELETE '{backend_url}/admin/customers/{id}/addresses/{address_id}' \ -H 'x-medusa-access-token: {api_token}'
--H 'x-medusa-access-token: {api_token}'

www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_inbound_items_{action_id}/delete.sh

@@ -1,2 +1 @@
-curl -X DELETE '{backend_url}/admin/exchanges/{id}/inbound/items/{action_id}' \
+curl -X DELETE '{backend_url}/admin/exchanges/{id}/inbound/items/{action_id}' \ -H 'x-medusa-access-token: {api_token}'
--H 'x-medusa-access-token: {api_token}'

www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_inbound_shipping-method_{action_id}/delete.sh

@@ -1,2 +1 @@
-curl -X DELETE '{backend_url}/admin/exchanges/{id}/inbound/shipping-method/{action_id}' \
+curl -X DELETE '{backend_url}/admin/exchanges/{id}/inbound/shipping-method/{action_id}' \ -H 'x-medusa-access-token: {api_token}'
--H 'x-medusa-access-token: {api_token}'

www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_outbound_items_{action_id}/delete.sh

@@ -1,2 +1 @@
-curl -X DELETE '{backend_url}/admin/exchanges/{id}/outbound/items/{action_id}' \
+curl -X DELETE '{backend_url}/admin/exchanges/{id}/outbound/items/{action_id}' \ -H 'x-medusa-access-token: {api_token}'
--H 'x-medusa-access-token: {api_token}'

www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_outbound_shipping-method_{action_id}/delete.sh

@@ -1,2 +1 @@
-curl -X DELETE '{backend_url}/admin/exchanges/{id}/outbound/shipping-method/{action_id}' \
+curl -X DELETE '{backend_url}/admin/exchanges/{id}/outbound/shipping-method/{action_id}'\ -H 'x-medusa-access-token: {api_token}'
--H 'x-medusa-access-token: {api_token}'

www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillment-sets_{id}_service-zones_{zone_id}/delete.sh

@@ -1,2 +1 @@
-curl -X DELETE '{backend_url}/admin/fulfillment-sets/{id}/service-zones/{zone_id}' \
+curl -X DELETE '{backend_url}/admin/fulfillment-sets/{id}/service-zones/{zone_id}' \ -H 'x-medusa-access-token: {api_token}'
--H 'x-medusa-access-token: {api_token}'

www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items_{id}_location-levels_{location_id}/delete.sh

@@ -1,2 +1 @@
-curl -X DELETE '{backend_url}/admin/inventory-items/{id}/location-levels/{location_id}' \
+curl -X DELETE '{backend_url}/admin/inventory-items/{id}/location-levels/{location_id}' \ -H 'x-medusa-access-token: {api_token}'
--H 'x-medusa-access-token: {api_token}'

www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_changes/get.sh

@@ -0,0 +1,2 @@
+curl '{backend_url}/admin/orders/{id}/changes' \
+-H 'x-medusa-access-token: {api_token}'

www/apps/api-reference/specs/admin/components/schemas/AdminApiKey.yaml

@@ -0,0 +1,60 @@
+type: object
+description: The api key's details.
+x-schemaName: AdminApiKey
+required:
+  - id
+  - token
+  - redacted
+  - title
+  - type
+  - last_used_at
+  - created_by
+  - created_at
+  - revoked_by
+  - revoked_at
+properties:
+  id:
+    type: string
+    title: id
+    description: The api key's ID.
+  token:
+    type: string
+    title: token
+    description: The api key's token.
+  redacted:
+    type: string
+    title: redacted
+    description: The api key's redacted.
+  title:
+    type: string
+    title: title
+    description: The api key's title.
+  type:
+    type: string
+    description: The api key's type.
+    enum:
+      - secret
+      - publishable
+  last_used_at:
+    type: string
+    title: last_used_at
+    description: The api key's last used at.
+    format: date-time
+  created_by:
+    type: string
+    title: created_by
+    description: The api key's created by.
+  created_at:
+    type: string
+    format: date-time
+    title: created_at
+    description: The api key's created at.
+  revoked_by:
+    type: string
+    title: revoked_by
+    description: The api key's revoked by.
+  revoked_at:
+    type: string
+    title: revoked_at
+    description: The api key's revoked at.
+    format: date-time

www/apps/api-reference/specs/admin/components/schemas/AdminApiKeyResponse.yaml

@@ -5,4 +5,4 @@ required:
   - api_key
 properties:
   api_key:
-    $ref: ./ApiKeyResponse.yaml
+    $ref: ./AdminApiKey.yaml

www/apps/api-reference/specs/admin/components/schemas/AdminBatchProductResponse.yaml

@@ -18,7 +18,7 @@ properties:
       $ref: ./AdminProduct.yaml
   deleted:
     type: object
-    description: The product's deleted.
+    description: SUMMARY
     required:
       - ids
       - object
@@ -34,8 +34,8 @@ properties:
       object:
         type: string
         title: object
-        description: The deleted's object.
+        description: SUMMARY
       deleted:
         type: boolean
         title: deleted
-        description: The deleted's details.
+        description: SUMMARY

www/apps/api-reference/specs/admin/components/schemas/AdminBatchProductVariantResponse.yaml

@@ -18,7 +18,7 @@ properties:
       $ref: ./AdminProductVariant.yaml
   deleted:
     type: object
-    description: The product's deleted.
+    description: SUMMARY
     required:
       - ids
       - object
@@ -34,8 +34,8 @@ properties:
       object:
         type: string
         title: object
-        description: The deleted's object.
+        description: SUMMARY
       deleted:
         type: boolean
         title: deleted
-        description: The deleted's details.
+        description: SUMMARY

www/apps/api-reference/specs/admin/components/schemas/AdminCampaign.yaml

@@ -0,0 +1,73 @@
+type: object
+description: The campaign's details.
+x-schemaName: AdminCampaign
+required:
+  - id
+  - name
+  - description
+  - currency
+  - campaign_identifier
+  - starts_at
+  - ends_at
+  - budget
+properties:
+  id:
+    type: string
+    title: id
+    description: The campaign's ID.
+  name:
+    type: string
+    title: name
+    description: The campaign's name.
+  description:
+    type: string
+    title: description
+    description: The campaign's description.
+  currency:
+    type: string
+    title: currency
+    description: The campaign's currency.
+  campaign_identifier:
+    type: string
+    title: campaign_identifier
+    description: The campaign's campaign identifier.
+  starts_at:
+    type: string
+    title: starts_at
+    description: The campaign's starts at.
+  ends_at:
+    type: string
+    title: ends_at
+    description: The campaign's ends at.
+  budget:
+    type: object
+    description: The campaign's budget.
+    required:
+      - id
+      - type
+      - currency_code
+      - limit
+      - used
+    properties:
+      id:
+        type: string
+        title: id
+        description: The budget's ID.
+      type:
+        type: string
+        description: The budget's type.
+        enum:
+          - spend
+          - usage
+      currency_code:
+        type: string
+        title: currency_code
+        description: The budget's currency code.
+      limit:
+        type: number
+        title: limit
+        description: The budget's limit.
+      used:
+        type: number
+        title: used
+        description: The budget's used.

www/apps/api-reference/specs/admin/components/schemas/AdminCampaignResponse.yaml

@@ -5,4 +5,4 @@ required:
   - campaign
 properties:
   campaign:
-    $ref: ./CampaignResponse.yaml
+    $ref: ./AdminCampaign.yaml

www/apps/api-reference/specs/admin/components/schemas/AdminClaim.yaml

@@ -113,6 +113,7 @@ properties:
       $ref: ./BasePaymentCollection.yaml
   payment_status:
     type: string
+    description: The claim's payment status.
     enum:
       - canceled
       - not_paid
@@ -131,6 +132,7 @@ properties:
       $ref: ./BaseOrderFulfillment.yaml
   fulfillment_status:
     type: string
+    description: The claim's fulfillment status.
     enum:
       - canceled
       - not_fulfilled

www/apps/api-reference/specs/admin/components/schemas/AdminClaimDeleteResponse.yaml

@@ -13,12 +13,12 @@ properties:
   object:
     type: string
     title: object
-    description: The claim's object.
+    description: The name of the deleted object.
     default: claim
   deleted:
     type: boolean
     title: deleted
-    description: The claim's deleted.
+    description: Whether the Claim was deleted.
   parent:
     type: object
     description: The claim's parent.

www/apps/api-reference/specs/admin/components/schemas/AdminCollectionDeleteResponse.yaml

@@ -13,12 +13,12 @@ properties:
   object:
     type: string
     title: object
-    description: The collection's object.
+    description: The name of the deleted object.
     default: collection
   deleted:
     type: boolean
     title: deleted
-    description: The collection's deleted.
+    description: Whether the Collection was deleted.
   parent:
     type: object
     description: The collection's parent.

www/apps/api-reference/specs/admin/components/schemas/AdminCreateApiKey.yaml

@@ -11,6 +11,7 @@ properties:
     description: The api key's title.
   type:
     type: string
+    description: The api key's type.
     enum:
       - publishable
       - secret

www/apps/api-reference/specs/admin/components/schemas/AdminCreatePriceList.yaml

@@ -25,11 +25,13 @@ properties:
     description: The price list's ends at.
   status:
     type: string
+    description: The price list's status.
     enum:
       - active
       - draft
   type:
     type: string
+    description: The price list's type.
     enum:
       - sale
       - override

www/apps/api-reference/specs/admin/components/schemas/AdminCreateProduct.yaml

@@ -47,6 +47,7 @@ properties:
     description: The create's handle.
   status:
     type: string
+    description: The create's status.
     enum:
       - draft
       - proposed

www/apps/api-reference/specs/admin/components/schemas/AdminCreateWorkflowsAsyncResponse.yaml

@@ -17,6 +17,7 @@ properties:
   compensate_input: {}
   action:
     type: string
+    description: The workflows execution's action.
     enum:
       - invoke
       - compensate

www/apps/api-reference/specs/admin/components/schemas/AdminExchange.yaml

@@ -114,6 +114,7 @@ properties:
       $ref: ./BasePaymentCollection.yaml
   payment_status:
     type: string
+    description: The exchange's payment status.
     enum:
       - canceled
       - not_paid
@@ -132,6 +133,7 @@ properties:
       $ref: ./BaseOrderFulfillment.yaml
   fulfillment_status:
     type: string
+    description: The exchange's fulfillment status.
     enum:
       - canceled
       - not_fulfilled

www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentSetDeleteResponse.yaml

@@ -13,12 +13,12 @@ properties:
   object:
     type: string
     title: object
-    description: The fulfillment set's object.
+    description: The name of the deleted object.
     default: fulfillment_set
   deleted:
     type: boolean
     title: deleted
-    description: The fulfillment set's deleted.
+    description: Whether the Fulfillment Set was deleted.
   parent:
     type: object
     description: The fulfillment set's parent.

www/apps/api-reference/specs/admin/components/schemas/AdminInvite.yaml

@@ -34,11 +34,11 @@ properties:
     description: The invite's metadata.
   created_at:
     type: string
+    format: date-time
     title: created_at
     description: The invite's created at.
-    format: date-time
   updated_at:
     type: string
+    format: date-time
     title: updated_at
     description: The invite's updated at.
-    format: date-time

www/apps/api-reference/specs/admin/components/schemas/AdminOrder.yaml

@@ -100,6 +100,7 @@ properties:
       $ref: ./BaseOrderShippingMethod.yaml
   payment_status:
     type: string
+    description: The order's payment status.
     enum:
       - canceled
       - not_paid
@@ -113,6 +114,7 @@ properties:
       - requires_action
   fulfillment_status:
     type: string
+    description: The order's fulfillment status.
     enum:
       - canceled
       - not_fulfilled

www/apps/api-reference/specs/admin/components/schemas/AdminOrderChangesResponse.yaml

@@ -0,0 +1,11 @@
+type: object
+description: SUMMARY
+x-schemaName: AdminOrderChangesResponse
+required:
+  - order_changes
+properties:
+  order_changes:
+    type: array
+    description: The order's order changes.
+    items:
+      $ref: ./BaseOrderChange.yaml

www/apps/api-reference/specs/admin/components/schemas/AdminOrderPreview.yaml

@@ -200,14 +200,14 @@ properties:
               $ref: ./BaseOrderItemDetail.yaml
             created_at:
               type: string
+              format: date-time
               title: created_at
               description: The item's created at.
-              format: date-time
             updated_at:
               type: string
+              format: date-time
               title: updated_at
               description: The item's updated at.
-              format: date-time
             metadata:
               type: object
               description: The item's metadata.
@@ -505,6 +505,7 @@ properties:
       $ref: ./AdminPaymentCollection.yaml
   payment_status:
     type: string
+    description: The order preview's payment status.
     enum:
       - canceled
       - not_paid
@@ -523,6 +524,7 @@ properties:
       $ref: ./BaseOrderFulfillment.yaml
   fulfillment_status:
     type: string
+    description: The order preview's fulfillment status.
     enum:
       - canceled
       - not_fulfilled

www/apps/api-reference/specs/admin/components/schemas/AdminPaymentCollection.yaml

@@ -93,6 +93,7 @@ properties:
     description: The payment collection's metadata.
   status:
     type: string
+    description: The payment collection's status.
     enum:
       - canceled
       - not_paid

www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimItemsReqSchema.yaml

@@ -22,6 +22,7 @@ properties:
           description: The item's quantity.
         reason:
           type: string
+          description: The item's reason.
           enum:
             - missing_item
             - wrong_item

www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderClaimsReqSchema.yaml

@@ -9,6 +9,7 @@ required:
 properties:
   type:
     type: string
+    description: The claim's type.
     enum:
       - refund
       - replace

www/apps/api-reference/specs/admin/components/schemas/AdminPriceList.yaml

@@ -40,11 +40,13 @@ properties:
     description: The price list's ends at.
   status:
     type: string
+    description: The price list's status.
     enum:
       - draft
       - active
   type:
     type: string
+    description: The price list's type.
     enum:
       - sale
       - override

www/apps/api-reference/specs/admin/components/schemas/AdminPriceListBatchResponse.yaml

@@ -18,7 +18,7 @@ properties:
       $ref: ./AdminPrice.yaml
   deleted:
     type: object
-    description: The price list's deleted.
+    description: SUMMARY
     required:
       - ids
       - object
@@ -34,8 +34,8 @@ properties:
       object:
         type: string
         title: object
-        description: The deleted's object.
+        description: SUMMARY
       deleted:
         type: boolean
         title: deleted
-        description: The deleted's details.
+        description: SUMMARY

www/apps/api-reference/specs/admin/components/schemas/AdminPriceListDeleteResponse.yaml

@@ -13,12 +13,12 @@ properties:
   object:
     type: string
     title: object
-    description: The price list's object.
+    description: The name of the deleted object.
     default: price_list
   deleted:
     type: boolean
     title: deleted
-    description: The price list's deleted.
+    description: Whether the Price List was deleted.
   parent:
     type: object
     description: The price list's parent.

www/apps/api-reference/specs/admin/components/schemas/AdminPricePreferenceDeleteResponse.yaml

@@ -13,12 +13,12 @@ properties:
   object:
     type: string
     title: object
-    description: The price preference's object.
+    description: The name of the deleted object.
     default: price_preference
   deleted:
     type: boolean
     title: deleted
-    description: The price preference's deleted.
+    description: Whether the Price Preference was deleted.
   parent:
     type: object
     description: The price preference's parent.

www/apps/api-reference/specs/admin/components/schemas/AdminProduct.yaml

@@ -47,7 +47,7 @@ properties:
     items:
       $ref: ./AdminProductVariant.yaml
   type:
-    type: object
+    $ref: ./AdminProductType.yaml
   tags:
     type: array
     description: The parent's tags.
@@ -59,6 +59,7 @@ properties:
     description: The parent's title.
   status:
     type: string
+    description: The parent's status.
     enum:
       - draft
       - proposed

www/apps/api-reference/specs/admin/components/schemas/AdminProductCategory.yaml

@@ -40,6 +40,9 @@ properties:
     type: string
     title: id
     description: The category's ID.
+  metadata:
+    type: object
+    description: The category's metadata.
   created_at:
     type: string
     format: date-time

www/apps/api-reference/specs/admin/components/schemas/AdminProductCategoryDeleteResponse.yaml

@@ -13,12 +13,12 @@ properties:
   object:
     type: string
     title: object
-    description: The product category's object.
+    description: The name of the deleted object.
     default: product_category
   deleted:
     type: boolean
     title: deleted
-    description: The product category's deleted.
+    description: Whether the Product Category was deleted.
   parent:
     type: object
     description: The product category's parent.

www/apps/api-reference/specs/admin/components/schemas/AdminProductDeleteResponse.yaml

@@ -13,12 +13,12 @@ properties:
   object:
     type: string
     title: object
-    description: The product's object.
+    description: The name of the deleted object.
     default: product
   deleted:
     type: boolean
     title: deleted
-    description: The product's deleted.
+    description: Whether the Product was deleted.
   parent:
     type: object
     description: The product's parent.

www/apps/api-reference/specs/admin/components/schemas/AdminProductOptionDeleteResponse.yaml

@@ -13,11 +13,11 @@ properties:
   object:
     type: string
     title: object
-    description: The product's object.
+    description: The name of the deleted object.
     default: product_option
   deleted:
     type: boolean
     title: deleted
-    description: The product's deleted.
+    description: Whether the Product was deleted.
   parent:
     $ref: ./AdminProduct.yaml

www/apps/api-reference/specs/admin/components/schemas/AdminProductTagDeleteResponse.yaml

@@ -13,12 +13,12 @@ properties:
   object:
     type: string
     title: object
-    description: The product tag's object.
+    description: The name of the deleted object.
     default: product_tag
   deleted:
     type: boolean
     title: deleted
-    description: The product tag's deleted.
+    description: Whether the Product Tag was deleted.
   parent:
     type: object
     description: The product tag's parent.

www/apps/api-reference/specs/admin/components/schemas/AdminProductType.yaml

@@ -0,0 +1,35 @@
+type: object
+description: The parent's type.
+x-schemaName: AdminProductType
+required:
+  - id
+  - value
+  - created_at
+  - updated_at
+properties:
+  id:
+    type: string
+    title: id
+    description: The type's ID.
+  value:
+    type: string
+    title: value
+    description: The type's value.
+  created_at:
+    type: string
+    format: date-time
+    title: created_at
+    description: The type's created at.
+  updated_at:
+    type: string
+    format: date-time
+    title: updated_at
+    description: The type's updated at.
+  deleted_at:
+    type: string
+    format: date-time
+    title: deleted_at
+    description: The type's deleted at.
+  metadata:
+    type: object
+    description: The type's metadata.

www/apps/api-reference/specs/admin/components/schemas/AdminProductTypeDeleteResponse.yaml

@@ -13,12 +13,12 @@ properties:
   object:
     type: string
     title: object
-    description: The product type's object.
+    description: The name of the deleted object.
     default: product_type
   deleted:
     type: boolean
     title: deleted
-    description: The product type's deleted.
+    description: Whether the Product Type was deleted.
   parent:
     type: object
     description: The product type's parent.

www/apps/api-reference/specs/admin/components/schemas/AdminProductTypeListResponse.yaml

@@ -23,4 +23,4 @@ properties:
     type: array
     description: The product type's product types.
     items:
-      $ref: ./AdminProduct.yaml
+      $ref: ./AdminProductType.yaml

www/apps/api-reference/specs/admin/components/schemas/AdminProductTypeResponse.yaml

@@ -5,4 +5,4 @@ required:
   - product_type
 properties:
   product_type:
-    $ref: ./AdminProduct.yaml
+    $ref: ./AdminProductType.yaml

www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantDeleteResponse.yaml

@@ -13,11 +13,11 @@ properties:
   object:
     type: string
     title: object
-    description: The product's object.
+    description: The name of the deleted object.
     default: variant
   deleted:
     type: boolean
     title: deleted
-    description: The product's deleted.
+    description: Whether the Product was deleted.
   parent:
     $ref: ./AdminProduct.yaml

www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantInventoryBatchResponse.yaml

@@ -76,10 +76,10 @@ properties:
     oneOf:
       - $ref: ./AdminProductVariantInventoryLink.yaml
       - type: array
-        description: The product's deleted.
+        description: SUMMARY
         items:
           type: object
-          description: The deleted's details.
+          description: SUMMARY
           x-schemaName: AdminProductVariantInventoryLink
           required:
             - productService

www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantInventoryLinkDeleteResponse.yaml

@@ -12,10 +12,10 @@ properties:
   object:
     type: string
     title: object
-    description: The product's object.
+    description: The name of the deleted object.
   deleted:
     type: boolean
     title: deleted
-    description: The product's deleted.
+    description: Whether the Product was deleted.
   parent:
     $ref: ./AdminProductVariant.yaml

www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantParams.yaml

@@ -62,17 +62,11 @@ properties:
     type: array
     description: The variant's $and.
     items:
-      type: array
+      type: object
-      description: The $and's details.
+    title: $and
-      items:
-        type: object
-      title: $and
   $or:
     type: array
     description: The variant's $or.
     items:
-      type: array
+      type: object
-      description: The $or's details.
+    title: $or
-      items:
-        type: object
-      title: $or

www/apps/api-reference/specs/admin/components/schemas/AdminPromotion.yaml

@@ -14,6 +14,7 @@ properties:
     description: The promotion's code.
   type:
     type: string
+    description: The promotion's type.
     enum:
       - standard
       - buyget
@@ -33,4 +34,4 @@ properties:
     title: campaign_id
     description: The promotion's campaign id.
   campaign:
-    $ref: ./CampaignResponse.yaml
+    $ref: ./AdminCampaign.yaml

www/apps/api-reference/specs/admin/components/schemas/AdminPromotionRule.yaml

@@ -19,6 +19,7 @@ properties:
     description: The updated's attribute.
   operator:
     type: string
+    description: The updated's operator.
     enum:
       - gt
       - lt

www/apps/api-reference/specs/admin/components/schemas/AdminReservation.yaml

@@ -0,0 +1,66 @@
+type: object
+description: The reservation's details.
+x-schemaName: AdminReservation
+required:
+  - id
+  - line_item_id
+  - location_id
+  - quantity
+  - external_id
+  - description
+  - inventory_item_id
+  - inventory_item
+properties:
+  id:
+    type: string
+    title: id
+    description: The reservation's ID.
+  line_item_id:
+    type: string
+    title: line_item_id
+    description: The reservation's line item id.
+  location_id:
+    type: string
+    title: location_id
+    description: The reservation's location id.
+  quantity:
+    type: string
+    title: quantity
+    description: The reservation's quantity.
+  external_id:
+    type: string
+    title: external_id
+    description: The reservation's external id.
+  description:
+    type: string
+    title: description
+    description: The reservation's description.
+  inventory_item_id:
+    type: string
+    title: inventory_item_id
+    description: The reservation's inventory item id.
+  inventory_item:
+    type: object
+    description: The reservation's inventory item.
+  metadata:
+    type: object
+    description: The reservation's metadata.
+  created_by:
+    type: string
+    title: created_by
+    description: The reservation's created by.
+  deleted_at:
+    type: string
+    format: date-time
+    title: deleted_at
+    description: The reservation's deleted at.
+  created_at:
+    type: string
+    format: date-time
+    title: created_at
+    description: The reservation's created at.
+  updated_at:
+    type: string
+    format: date-time
+    title: updated_at
+    description: The reservation's updated at.

www/apps/api-reference/specs/admin/components/schemas/AdminReservationResponse.yaml

@@ -5,4 +5,4 @@ required:
   - reservation
 properties:
   reservation:
-    $ref: ./ReservationResponse.yaml
+    $ref: ./AdminReservation.yaml

www/apps/api-reference/specs/admin/components/schemas/AdminReturn.yaml

@@ -9,6 +9,7 @@ required:
   - items
   - received_at
   - created_at
+  - canceled_at
 properties:
   id:
     type: string
@@ -64,3 +65,7 @@ properties:
     format: date-time
     title: created_at
     description: The return's created at.
+  canceled_at:
+    type: string
+    title: canceled_at
+    description: The return's canceled at.

www/apps/api-reference/specs/admin/components/schemas/AdminReturnItem.yaml

@@ -5,6 +5,7 @@ required:
   - id
   - quantity
   - received_quantity
+  - damaged_quantity
   - item_id
   - return_id
 properties:
@@ -20,6 +21,10 @@ properties:
     type: number
     title: received_quantity
     description: The return item's received quantity.
+  damaged_quantity:
+    type: number
+    title: damaged_quantity
+    description: The return item's damaged quantity.
   reason_id:
     type: string
     title: reason_id

www/apps/api-reference/specs/admin/components/schemas/AdminSalesChannelDeleteResponse.yaml

@@ -13,12 +13,12 @@ properties:
   object:
     type: string
     title: object
-    description: The sales channel's object.
+    description: The name of the deleted object.
     default: sales-channel
   deleted:
     type: boolean
     title: deleted
-    description: The sales channel's deleted.
+    description: Whether the Sales Channel was deleted.
   parent:
     type: object
     description: The sales channel's parent.

www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionDeleteResponse.yaml

@@ -13,12 +13,12 @@ properties:
   object:
     type: string
     title: object
-    description: The shipping option's object.
+    description: The name of the deleted object.
     default: shipping_option
   deleted:
     type: boolean
     title: deleted
-    description: The shipping option's deleted.
+    description: Whether the Shipping Option was deleted.
   parent:
     type: object
     description: The shipping option's parent.

www/apps/api-reference/specs/admin/components/schemas/AdminShippingProfileDeleteResponse.yaml

@@ -13,12 +13,12 @@ properties:
   object:
     type: string
     title: object
-    description: The shipping profile's object.
+    description: The name of the deleted object.
     default: shipping_profile
   deleted:
     type: boolean
     title: deleted
-    description: The shipping profile's deleted.
+    description: Whether the Shipping Profile was deleted.
   parent:
     type: object
     description: The shipping profile's parent.

www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationDeleteResponse.yaml

@@ -13,12 +13,12 @@ properties:
   object:
     type: string
     title: object
-    description: The stock location's object.
+    description: The name of the deleted object.
     default: stock_location
   deleted:
     type: boolean
     title: deleted
-    description: The stock location's deleted.
+    description: Whether the Stock Location was deleted.
   parent:
     type: object
     description: The stock location's parent.

www/apps/api-reference/specs/admin/components/schemas/AdminTaxRateDeleteResponse.yaml

@@ -13,12 +13,12 @@ properties:
   object:
     type: string
     title: object
-    description: The tax rate's object.
+    description: The name of the deleted object.
     default: tax_rate
   deleted:
     type: boolean
     title: deleted
-    description: The tax rate's deleted.
+    description: Whether the Tax Rate was deleted.
   parent:
     type: object
     description: The tax rate's parent.

www/apps/api-reference/specs/admin/components/schemas/AdminTaxRegionDeleteResponse.yaml

@@ -13,12 +13,12 @@ properties:
   object:
     type: string
     title: object
-    description: The tax region's object.
+    description: The name of the deleted object.
     default: tax_region
   deleted:
     type: boolean
     title: deleted
-    description: The tax region's deleted.
+    description: Whether the Tax Region was deleted.
   parent:
     type: object
     description: The tax region's parent.

www/apps/api-reference/specs/admin/components/schemas/AdminUpdatePriceList.yaml

@@ -24,11 +24,13 @@ properties:
     description: The price list's ends at.
   status:
     type: string
+    description: The price list's status.
     enum:
       - active
       - draft
   type:
     type: string
+    description: The price list's type.
     enum:
       - sale
       - override

www/apps/api-reference/specs/admin/components/schemas/AdminUpdateProduct.yaml

@@ -45,6 +45,7 @@ properties:
     description: The update's handle.
   status:
     type: string
+    description: The update's status.
     enum:
       - draft
       - proposed

www/apps/api-reference/specs/admin/components/schemas/AdminUserDeleteResponse.yaml

@@ -13,12 +13,12 @@ properties:
   object:
     type: string
     title: object
-    description: The user's object.
+    description: The name of the deleted object.
     default: user
   deleted:
     type: boolean
     title: deleted
-    description: The user's deleted.
+    description: Whether the User was deleted.
   parent:
     type: object
     description: The user's parent.

www/apps/api-reference/specs/admin/components/schemas/AdminWorkflowExecution.yaml

@@ -10,7 +10,6 @@ required:
   - state
   - created_at
   - updated_at
-  - deleted_at
 properties:
   id:
     type: string
@@ -25,26 +24,32 @@ properties:
     title: transaction_id
     description: The workflow execution's transaction id.
   execution:
-    type: string
+    $ref: ./AdminWorkflowExecutionExecution.yaml
-    title: execution
-    description: The workflow execution's execution.
   context:
+    $ref: ./WorkflowExecutionContext.yaml
+  state:
     type: string
-    title: context
+    description: The workflow execution's state.
-    description: The workflow execution's context.
+    enum:
-  state: {}
+      - not_started
+      - invoking
+      - waiting_to_compensate
+      - compensating
+      - done
+      - reverted
+      - failed
   created_at:
     type: string
+    format: date-time
     title: created_at
     description: The workflow execution's created at.
-    format: date-time
   updated_at:
     type: string
+    format: date-time
     title: updated_at
     description: The workflow execution's updated at.
-    format: date-time
   deleted_at:
     type: string
+    format: date-time
     title: deleted_at
     description: The workflow execution's deleted at.
-    format: date-time

www/apps/api-reference/specs/admin/components/schemas/AdminWorkflowExecutionExecution.yaml

@@ -0,0 +1,9 @@
+type: object
+description: The workflow execution's execution.
+x-schemaName: AdminWorkflowExecutionExecution
+required:
+  - steps
+properties:
+  steps:
+    type: object
+    description: The execution's steps.

www/apps/api-reference/specs/admin/components/schemas/BaseApplicationMethod.yaml

@@ -10,17 +10,20 @@ properties:
     description: The application method's ID.
   type:
     type: string
+    description: The application method's type.
     enum:
       - fixed
       - percentage
   target_type:
     type: string
+    description: The application method's target type.
     enum:
       - items
       - shipping_methods
       - order
   allocation:
     type: string
+    description: The application method's allocation.
     enum:
       - each
       - across

www/apps/api-reference/specs/admin/components/schemas/BaseCartLineItem.yaml

@@ -159,19 +159,19 @@ properties:
     description: The item's metadata.
   created_at:
     type: string
+    format: date-time
     title: created_at
     description: The item's created at.
-    format: date-time
   updated_at:
     type: string
+    format: date-time
     title: updated_at
     description: The item's updated at.
-    format: date-time
   deleted_at:
     type: string
+    format: date-time
     title: deleted_at
     description: The item's deleted at.
-    format: date-time
   original_total:
     oneOf:
       - type: string

www/apps/api-reference/specs/admin/components/schemas/BaseClaimItem.yaml

@@ -32,6 +32,7 @@ properties:
     description: The claim item's quantity.
   reason:
     type: string
+    description: The claim item's reason.
     enum:
       - missing_item
       - wrong_item

www/apps/api-reference/specs/admin/components/schemas/BaseOrderChange.yaml

@@ -119,6 +119,7 @@ properties:
     description: The order change's version.
   change_type:
     type: string
+    description: The order change's change type.
     enum:
       - return
       - exchange

www/apps/api-reference/specs/admin/components/schemas/BaseOrderFulfillment.yaml

@@ -59,11 +59,11 @@ properties:
     description: The fulfillment's metadata.
   created_at:
     type: string
+    format: date-time
     title: created_at
     description: The fulfillment's created at.
-    format: date-time
   updated_at:
     type: string
+    format: date-time
     title: updated_at
     description: The fulfillment's updated at.
-    format: date-time

www/apps/api-reference/specs/admin/components/schemas/BaseOrderLineItem.yaml

@@ -146,14 +146,14 @@ properties:
     $ref: ./BaseOrderItemDetail.yaml
   created_at:
     type: string
+    format: date-time
     title: created_at
     description: The item's created at.
-    format: date-time
   updated_at:
     type: string
+    format: date-time
     title: updated_at
     description: The item's updated at.
-    format: date-time
   metadata:
     type: object
     description: The item's metadata.

www/apps/api-reference/specs/admin/components/schemas/BasePaymentCollection.yaml

@@ -93,6 +93,7 @@ properties:
     description: The payment collection's metadata.
   status:
     type: string
+    description: The payment collection's status.
     enum:
       - canceled
       - not_paid

www/apps/api-reference/specs/admin/components/schemas/BaseProduct.yaml

@@ -55,6 +55,7 @@ properties:
     description: The product's is giftcard.
   status:
     type: string
+    description: The product's status.
     enum:
       - draft
       - proposed

www/apps/api-reference/specs/admin/components/schemas/BasePromotionRule.yaml

@@ -19,6 +19,7 @@ properties:
     description: The rule's attribute.
   operator:
     type: string
+    description: The rule's operator.
     enum:
       - gt
       - lt

www/apps/api-reference/specs/admin/components/schemas/OrderChange.yaml

@@ -37,6 +37,7 @@ properties:
     description: The order change's version.
   change_type:
     type: string
+    description: The order change's change type.
     enum:
       - return
       - exchange

www/apps/api-reference/specs/admin/components/schemas/OrderPreview.yaml

@@ -212,14 +212,14 @@ properties:
               $ref: ./OrderItem.yaml
             created_at:
               type: string
+              format: date-time
               title: created_at
               description: The item's created at.
-              format: date-time
             updated_at:
               type: string
+              format: date-time
               title: updated_at
               description: The item's updated at.
-              format: date-time
             metadata:
               type: object
               description: The item's metadata.
@@ -659,6 +659,7 @@ properties:
                 x-schemaName: OrderChangeAction
   status:
     type: string
+    description: The order preview's status.
     enum:
       - canceled
       - requires_action

www/apps/api-reference/specs/admin/components/schemas/StoreCartAddress.yaml

@@ -0,0 +1,77 @@
+type: object
+description: The cart's billing address.
+x-schemaName: StoreCartAddress
+required:
+  - id
+  - created_at
+  - updated_at
+properties:
+  id:
+    type: string
+    title: id
+    description: The billing address's ID.
+  customer_id:
+    type: string
+    title: customer_id
+    description: The billing address's customer id.
+  first_name:
+    type: string
+    title: first_name
+    description: The billing address's first name.
+  last_name:
+    type: string
+    title: last_name
+    description: The billing address's last name.
+  phone:
+    type: string
+    title: phone
+    description: The billing address's phone.
+  company:
+    type: string
+    title: company
+    description: The billing address's company.
+  address_1:
+    type: string
+    title: address_1
+    description: The billing address's address 1.
+  address_2:
+    type: string
+    title: address_2
+    description: The billing address's address 2.
+  city:
+    type: string
+    title: city
+    description: The billing address's city.
+  country_code:
+    type: string
+    title: country_code
+    description: The billing address's country code.
+  province:
+    type: string
+    title: province
+    description: The billing address's province.
+  postal_code:
+    type: string
+    title: postal_code
+    description: The billing address's postal code.
+  metadata:
+    type: object
+    description: The billing address's metadata.
+  created_at:
+    oneOf:
+      - type: string
+        title: created_at
+        description: The billing address's created at.
+      - type: string
+        title: created_at
+        description: The billing address's created at.
+        format: date-time
+  updated_at:
+    oneOf:
+      - type: string
+        title: updated_at
+        description: The billing address's updated at.
+      - type: string
+        title: updated_at
+        description: The billing address's updated at.
+        format: date-time

www/apps/api-reference/specs/admin/components/schemas/StoreCartLineItem.yaml

@@ -0,0 +1,306 @@
+type: object
+description: The item's items.
+x-schemaName: StoreCartLineItem
+required:
+  - id
+  - title
+  - quantity
+  - requires_shipping
+  - is_discountable
+  - is_tax_inclusive
+  - unit_price
+  - cart
+  - cart_id
+  - original_total
+  - original_subtotal
+  - original_tax_total
+  - item_total
+  - item_subtotal
+  - item_tax_total
+  - total
+  - subtotal
+  - tax_total
+  - discount_total
+  - discount_tax_total
+properties:
+  id:
+    type: string
+    title: id
+    description: The item's ID.
+  title:
+    type: string
+    title: title
+    description: The item's title.
+  subtitle:
+    type: string
+    title: subtitle
+    description: The item's subtitle.
+  thumbnail:
+    type: string
+    title: thumbnail
+    description: The item's thumbnail.
+  quantity:
+    oneOf:
+      - type: string
+        title: quantity
+        description: The item's quantity.
+      - type: number
+        title: quantity
+        description: The item's quantity.
+      - type: string
+        title: quantity
+        description: The item's quantity.
+      - $ref: ./IBigNumber.yaml
+  product:
+    $ref: ./BaseProduct.yaml
+  product_id:
+    type: string
+    title: product_id
+    description: The item's product id.
+  product_title:
+    type: string
+    title: product_title
+    description: The item's product title.
+  product_description:
+    type: string
+    title: product_description
+    description: The item's product description.
+  product_subtitle:
+    type: string
+    title: product_subtitle
+    description: The item's product subtitle.
+  product_type:
+    type: string
+    title: product_type
+    description: The item's product type.
+  product_collection:
+    type: string
+    title: product_collection
+    description: The item's product collection.
+  product_handle:
+    type: string
+    title: product_handle
+    description: The item's product handle.
+  variant:
+    $ref: ./BaseProductVariant.yaml
+  variant_id:
+    type: string
+    title: variant_id
+    description: The item's variant id.
+  variant_sku:
+    type: string
+    title: variant_sku
+    description: The item's variant sku.
+  variant_barcode:
+    type: string
+    title: variant_barcode
+    description: The item's variant barcode.
+  variant_title:
+    type: string
+    title: variant_title
+    description: The item's variant title.
+  variant_option_values:
+    type: object
+    description: The item's variant option values.
+  requires_shipping:
+    type: boolean
+    title: requires_shipping
+    description: The item's requires shipping.
+  is_discountable:
+    type: boolean
+    title: is_discountable
+    description: The item's is discountable.
+  is_tax_inclusive:
+    type: boolean
+    title: is_tax_inclusive
+    description: The item's is tax inclusive.
+  compare_at_unit_price:
+    oneOf:
+      - type: string
+        title: compare_at_unit_price
+        description: The item's compare at unit price.
+      - type: number
+        title: compare_at_unit_price
+        description: The item's compare at unit price.
+      - type: string
+        title: compare_at_unit_price
+        description: The item's compare at unit price.
+      - $ref: ./IBigNumber.yaml
+  unit_price:
+    oneOf:
+      - type: string
+        title: unit_price
+        description: The item's unit price.
+      - type: number
+        title: unit_price
+        description: The item's unit price.
+      - type: string
+        title: unit_price
+        description: The item's unit price.
+      - $ref: ./IBigNumber.yaml
+  tax_lines:
+    type: array
+    description: The item's tax lines.
+    items:
+      $ref: ./BaseLineItemTaxLine.yaml
+  adjustments:
+    type: array
+    description: The item's adjustments.
+    items:
+      $ref: ./BaseLineItemAdjustment.yaml
+  cart:
+    $ref: ./BaseCart.yaml
+  cart_id:
+    type: string
+    title: cart_id
+    description: The item's cart id.
+  metadata:
+    type: object
+    description: The item's metadata.
+  created_at:
+    type: string
+    title: created_at
+    description: The item's created at.
+    format: date-time
+  updated_at:
+    type: string
+    title: updated_at
+    description: The item's updated at.
+    format: date-time
+  deleted_at:
+    type: string
+    title: deleted_at
+    description: The item's deleted at.
+    format: date-time
+  original_total:
+    oneOf:
+      - type: string
+        title: original_total
+        description: The item's original total.
+      - type: number
+        title: original_total
+        description: The item's original total.
+      - type: string
+        title: original_total
+        description: The item's original total.
+      - $ref: ./IBigNumber.yaml
+  original_subtotal:
+    oneOf:
+      - type: string
+        title: original_subtotal
+        description: The item's original subtotal.
+      - type: number
+        title: original_subtotal
+        description: The item's original subtotal.
+      - type: string
+        title: original_subtotal
+        description: The item's original subtotal.
+      - $ref: ./IBigNumber.yaml
+  original_tax_total:
+    oneOf:
+      - type: string
+        title: original_tax_total
+        description: The item's original tax total.
+      - type: number
+        title: original_tax_total
+        description: The item's original tax total.
+      - type: string
+        title: original_tax_total
+        description: The item's original tax total.
+      - $ref: ./IBigNumber.yaml
+  item_total:
+    oneOf:
+      - type: string
+        title: item_total
+        description: The item's item total.
+      - type: number
+        title: item_total
+        description: The item's item total.
+      - type: string
+        title: item_total
+        description: The item's item total.
+      - $ref: ./IBigNumber.yaml
+  item_subtotal:
+    oneOf:
+      - type: string
+        title: item_subtotal
+        description: The item's item subtotal.
+      - type: number
+        title: item_subtotal
+        description: The item's item subtotal.
+      - type: string
+        title: item_subtotal
+        description: The item's item subtotal.
+      - $ref: ./IBigNumber.yaml
+  item_tax_total:
+    oneOf:
+      - type: string
+        title: item_tax_total
+        description: The item's item tax total.
+      - type: number
+        title: item_tax_total
+        description: The item's item tax total.
+      - type: string
+        title: item_tax_total
+        description: The item's item tax total.
+      - $ref: ./IBigNumber.yaml
+  total:
+    oneOf:
+      - type: string
+        title: total
+        description: The item's total.
+      - type: number
+        title: total
+        description: The item's total.
+      - type: string
+        title: total
+        description: The item's total.
+      - $ref: ./IBigNumber.yaml
+  subtotal:
+    oneOf:
+      - type: string
+        title: subtotal
+        description: The item's subtotal.
+      - type: number
+        title: subtotal
+        description: The item's subtotal.
+      - type: string
+        title: subtotal
+        description: The item's subtotal.
+      - $ref: ./IBigNumber.yaml
+  tax_total:
+    oneOf:
+      - type: string
+        title: tax_total
+        description: The item's tax total.
+      - type: number
+        title: tax_total
+        description: The item's tax total.
+      - type: string
+        title: tax_total
+        description: The item's tax total.
+      - $ref: ./IBigNumber.yaml
+  discount_total:
+    oneOf:
+      - type: string
+        title: discount_total
+        description: The item's discount total.
+      - type: number
+        title: discount_total
+        description: The item's discount total.
+      - type: string
+        title: discount_total
+        description: The item's discount total.
+      - $ref: ./IBigNumber.yaml
+  discount_tax_total:
+    oneOf:
+      - type: string
+        title: discount_tax_total
+        description: The item's discount tax total.
+      - type: number
+        title: discount_tax_total
+        description: The item's discount tax total.
+      - type: string
+        title: discount_tax_total
+        description: The item's discount tax total.
+      - $ref: ./IBigNumber.yaml

www/apps/api-reference/specs/admin/components/schemas/StoreOrder.yaml

@@ -94,6 +94,7 @@ properties:
       $ref: ./BasePaymentCollection.yaml
   payment_status:
     type: string
+    description: The order's payment status.
     enum:
       - canceled
       - not_paid
@@ -112,6 +113,7 @@ properties:
       $ref: ./BaseOrderFulfillment.yaml
   fulfillment_status:
     type: string
+    description: The order's fulfillment status.
     enum:
       - canceled
       - not_fulfilled

www/apps/api-reference/specs/admin/components/schemas/StorePaymentCollection.yaml

@@ -93,6 +93,7 @@ properties:
     description: The payment collection's metadata.
   status:
     type: string
+    description: The payment collection's status.
     enum:
       - canceled
       - not_paid

www/apps/api-reference/specs/admin/components/schemas/StoreProduct.yaml

@@ -42,6 +42,7 @@ properties:
     description: The product's title.
   status:
     type: string
+    description: The product's status.
     enum:
       - draft
       - proposed

www/apps/api-reference/specs/admin/components/schemas/StoreProductCategory.yaml

@@ -60,6 +60,9 @@ properties:
     description: The category's category children.
     items:
       $ref: ./BaseProductCategory.yaml
+  metadata:
+    type: object
+    description: The category's metadata.
   created_at:
     type: string
     format: date-time

www/apps/api-reference/specs/admin/components/schemas/StoreReturn.yaml

@@ -9,6 +9,7 @@ required:
   - items
   - received_at
   - created_at
+  - canceled_at
 properties:
   id:
     type: string
@@ -64,3 +65,7 @@ properties:
     format: date-time
     title: created_at
     description: The return's created at.
+  canceled_at:
+    type: string
+    title: canceled_at
+    description: The return's canceled at.

www/apps/api-reference/specs/admin/components/schemas/StoreShippingOption.yaml

@@ -26,6 +26,7 @@ properties:
     description: The shipping option's name.
   price_type:
     type: string
+    description: The shipping option's price type.
     enum:
       - flat
       - calculated

www/apps/api-reference/specs/admin/components/schemas/WorkflowExecutionContext.yaml

@@ -0,0 +1,19 @@
+type: object
+description: The workflow execution's context.
+x-schemaName: WorkflowExecutionContext
+required:
+  - compensate
+  - errors
+properties:
+  data:
+    type: object
+    description: The context's data.
+  compensate:
+    type: object
+    description: The context's compensate.
+  errors:
+    type: array
+    description: The context's errors.
+    items:
+      type: object
+      description: The error's errors.

www/apps/api-reference/specs/admin/openapi.yaml

@@ -9,12 +9,6 @@ servers:
   - url: http://localhost:9000
   - url: https://api.medusajs.com
 tags:
-  - name: Auth
-    description: |
-      Auth API routes allow you to manage an admin user's authentication.
-    externalDocs:
-      description: Learn more about the Auth Module
-      url: https://docs.medusajs.com/v2/resources/commerce-modules/auth
   - name: Api Keys
     description: >
       API keys can be used for authentication or resource-scoping.
@@ -30,6 +24,8 @@ tags:
     externalDocs:
       description: Learn more about the API Key Module
       url: https://docs.medusajs.com/v2/resources/commerce-modules/api-key
+    x-associatedSchema:
+      $ref: ./components/schemas/AdminApiKey.yaml
   - name: Campaigns
     description: >
       A campaign is a group of promotions that have the same conditions, such as
@@ -42,6 +38,8 @@ tags:
       description: Learn more about campaigns.
       url: >-
         https://docs.medusajs.com/v2/resources/commerce-modules/promotion/campaign
+    x-associatedSchema:
+      $ref: ./components/schemas/AdminCampaign.yaml
   - name: Claims
     description: >
       An admin creates a claim for an order when a customer reports that an item
@@ -118,8 +116,6 @@ tags:
     externalDocs:
       description: Learn more about the Order Module
       url: https://docs.medusajs.com/v2/resources/commerce-modules/order
-    x-associatedSchema:
-      $ref: ./components/schemas/AdminOrder.yaml
   - name: Exchanges
     description: >
       An exchange is the replacement of an item that the customer ordered with
@@ -225,8 +221,6 @@ tags:
     externalDocs:
       description: Learn more about the Order Module
       url: https://docs.medusajs.com/v2/resources/commerce-modules/order
-    x-associatedSchema:
-      $ref: ./components/schemas/OrderChange.yaml
   - name: Orders
     description: |
       An order is a purchase made by a customer through a storefront.
@@ -347,6 +341,8 @@ tags:
     externalDocs:
       description: Learn more about the Product Module
       url: https://docs.medusajs.com/v2/resources/commerce-modules/product
+    x-associatedSchema:
+      $ref: ./components/schemas/AdminProductType.yaml
   - name: Product Variants
     description: >
       A product variant is a saleable form of the product.
@@ -444,6 +440,8 @@ tags:
       description: Learn more about reservations and other inventory concepts.
       url: >-
         https://docs.medusajs.com/v2/resources/commerce-modules/inventory/concepts
+    x-associatedSchema:
+      $ref: ./components/schemas/AdminReservation.yaml
   - name: Return Reasons
     description: >
       A return reason is a possible reason that an item is returned from the
@@ -597,8 +595,6 @@ tags:
     externalDocs:
       description: Check out available file module providers.
       url: https://docs.medusajs.com/v2/resources/architectural-modules/file
-    x-associatedSchema:
-      $ref: ./components/schemas/AdminFile.yaml
   - name: Users
     description: >
       A user is an admin user that can authenticate and perform functionalities
@@ -627,8 +623,6 @@ tags:
       description: Check out available Workflow Engine Modules
       url: >-
         https://docs.medusajs.com/v2/resources/architectural-modules/workflow-engine
-    x-associatedSchema:
-      $ref: ./components/schemas/AdminWorkflowExecution.yaml
 paths:
   /admin/api-keys:
     $ref: paths/admin_api-keys.yaml
@@ -786,6 +780,8 @@ paths:
     $ref: paths/admin_orders_{id}_archive.yaml
   /admin/orders/{id}/cancel:
     $ref: paths/admin_orders_{id}_cancel.yaml
+  /admin/orders/{id}/changes:
+    $ref: paths/admin_orders_{id}_changes.yaml
   /admin/orders/{id}/complete:
     $ref: paths/admin_orders_{id}_complete.yaml
   /admin/orders/{id}/fulfillments:

www/apps/api-reference/specs/admin/paths/admin_api-keys.yaml

@@ -125,62 +125,7 @@ post:
   summary: Create Api Key
   description: Create a api key.
   x-authenticated: true
-  parameters:
+  parameters: []
-    - name: expand
-      in: query
-      description: Comma-separated relations that should be expanded in the returned data.
-      required: false
-      schema:
-        type: string
-        title: expand
-        description: >-
-          Comma-separated relations that should be expanded in the returned
-          data.
-    - 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.
-    - name: offset
-      in: query
-      description: The number of items to skip when retrieving a list.
-      required: false
-      schema:
-        type: number
-        title: offset
-        description: The number of items to skip when retrieving a list.
-    - name: limit
-      in: query
-      description: Limit the number of items returned in the list.
-      required: false
-      schema:
-        type: number
-        title: limit
-        description: Limit the number of items returned in the list.
-    - name: order
-      in: query
-      description: >-
-        The field to sort the data by. By default, the sort order is ascending.
-        To change the order to descending, prefix the field name with `-`.
-      required: false
-      schema:
-        type: string
-        title: order
-        description: >-
-          The field to sort the data by. By default, the sort order is
-          ascending. To change the order to descending, prefix the field name
-          with `-`.
   security:
     - api_token: []
     - cookie_auth: []

www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}.yaml

@@ -199,73 +199,20 @@ post:
       $ref: ../components/responses/invalid_request_error.yaml
     '500':
       $ref: ../components/responses/500_error.yaml
+  x-workflow: updateApiKeysWorkflow
 delete:
   operationId: DeleteApiKeysId
-  summary: Delete a Api Key
+  summary: Delete an Api Key
-  description: Delete a api key.
+  description: |
+    Delete a publishable or secret API key.
   x-authenticated: true
   parameters:
     - name: id
       in: path
-      description: The api key's ID.
+      description: The API key's ID.
       required: true
       schema:
         type: string
-    - name: expand
-      in: query
-      description: Comma-separated relations that should be expanded in the returned data.
-      required: false
-      schema:
-        type: string
-        title: expand
-        description: >-
-          Comma-separated relations that should be expanded in the returned
-          data.
-    - 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.
-    - name: offset
-      in: query
-      description: The number of items to skip when retrieving a list.
-      required: false
-      schema:
-        type: number
-        title: offset
-        description: The number of items to skip when retrieving a list.
-    - name: limit
-      in: query
-      description: Limit the number of items returned in the list.
-      required: false
-      schema:
-        type: number
-        title: limit
-        description: Limit the number of items returned in the list.
-    - name: order
-      in: query
-      description: >-
-        The field to sort the data by. By default, the sort order is ascending.
-        To change the order to descending, prefix the field name with `-`.
-      required: false
-      schema:
-        type: string
-        title: order
-        description: >-
-          The field to sort the data by. By default, the sort order is
-          ascending. To change the order to descending, prefix the field name
-          with `-`.
   security:
     - api_token: []
     - cookie_auth: []
@@ -293,18 +240,19 @@ delete:
               id:
                 type: string
                 title: id
-                description: The api key's ID.
+                description: The API key's ID.
               object:
                 type: string
                 title: object
-                description: The api key's object.
+                description: The name of the object that was deleted.
+                default: api_key
               deleted:
                 type: boolean
                 title: deleted
-                description: The api key's deleted.
+                description: Whether the API key was deleted.
               parent:
                 type: object
-                description: The api key's parent.
+                description: The API key's parent.
     '400':
       $ref: ../components/responses/400_error.yaml
     '401':
@@ -317,3 +265,4 @@ delete:
       $ref: ../components/responses/invalid_request_error.yaml
     '500':
       $ref: ../components/responses/500_error.yaml
+  x-workflow: deleteApiKeysWorkflow

www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}_revoke.yaml

@@ -100,3 +100,4 @@ post:
       $ref: ../components/responses/invalid_request_error.yaml
     '500':
       $ref: ../components/responses/500_error.yaml
+  x-workflow: revokeApiKeysWorkflow

www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}_sales-channels.yaml

@@ -116,3 +116,4 @@ post:
       $ref: ../components/responses/invalid_request_error.yaml
     '500':
       $ref: ../components/responses/500_error.yaml
+  x-workflow: linkSalesChannelsToApiKeyWorkflow

www/apps/api-reference/specs/admin/paths/admin_campaigns.yaml

@@ -292,3 +292,4 @@ post:
       $ref: ../components/responses/invalid_request_error.yaml
     '500':
       $ref: ../components/responses/500_error.yaml
+  x-workflow: createCampaignsWorkflow

www/apps/api-reference/specs/admin/paths/admin_campaigns_{id}.yaml

@@ -261,10 +261,13 @@ post:
       $ref: ../components/responses/invalid_request_error.yaml
     '500':
       $ref: ../components/responses/500_error.yaml
+  x-workflow: updateCampaignsWorkflow
 delete:
   operationId: DeleteCampaignsId
   summary: Delete a Campaign
-  description: Delete a campaign.
+  description: >
+    Delete a campaign by its ID. This doesn't delete promotions that belong to
+    this campaign.
   x-authenticated: true
   parameters:
     - name: id
@@ -273,61 +276,6 @@ delete:
       required: true
       schema:
         type: string
-    - name: expand
-      in: query
-      description: Comma-separated relations that should be expanded in the returned data.
-      required: false
-      schema:
-        type: string
-        title: expand
-        description: >-
-          Comma-separated relations that should be expanded in the returned
-          data.
-    - 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.
-    - name: offset
-      in: query
-      description: The number of items to skip when retrieving a list.
-      required: false
-      schema:
-        type: number
-        title: offset
-        description: The number of items to skip when retrieving a list.
-    - name: limit
-      in: query
-      description: Limit the number of items returned in the list.
-      required: false
-      schema:
-        type: number
-        title: limit
-        description: Limit the number of items returned in the list.
-    - name: order
-      in: query
-      description: >-
-        The field to sort the data by. By default, the sort order is ascending.
-        To change the order to descending, prefix the field name with `-`.
-      required: false
-      schema:
-        type: string
-        title: order
-        description: >-
-          The field to sort the data by. By default, the sort order is
-          ascending. To change the order to descending, prefix the field name
-          with `-`.
   security:
     - api_token: []
     - cookie_auth: []
@@ -359,11 +307,12 @@ delete:
               object:
                 type: string
                 title: object
-                description: The campaign's object.
+                description: The name of the object that was deleted.
+                default: campaign
               deleted:
                 type: boolean
                 title: deleted
-                description: The campaign's deleted.
+                description: Whether the campaign was deleted.
               parent:
                 type: object
                 description: The campaign's parent.
@@ -379,3 +328,4 @@ delete:
       $ref: ../components/responses/invalid_request_error.yaml
     '500':
       $ref: ../components/responses/500_error.yaml
+  x-workflow: deleteCampaignsWorkflow

www/apps/api-reference/specs/admin/paths/admin_campaigns_{id}_promotions.yaml

@@ -116,3 +116,4 @@ post:
       $ref: ../components/responses/invalid_request_error.yaml
     '500':
       $ref: ../components/responses/500_error.yaml
+  x-workflow: addOrRemoveCampaignPromotionsWorkflow

www/apps/api-reference/specs/admin/paths/admin_claims.yaml

@@ -187,3 +187,4 @@ post:
       $ref: ../components/responses/invalid_request_error.yaml
     '500':
       $ref: ../components/responses/500_error.yaml
+  x-workflow: beginClaimOrderWorkflow

www/apps/api-reference/specs/admin/paths/admin_claims_{id}_cancel.yaml

@@ -10,61 +10,6 @@ post:
       required: true
       schema:
         type: string
-    - name: expand
-      in: query
-      description: Comma-separated relations that should be expanded in the returned data.
-      required: false
-      schema:
-        type: string
-        title: expand
-        description: >-
-          Comma-separated relations that should be expanded in the returned
-          data.
-    - 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.
-    - name: offset
-      in: query
-      description: The number of items to skip when retrieving a list.
-      required: false
-      schema:
-        type: number
-        title: offset
-        description: The number of items to skip when retrieving a list.
-    - name: limit
-      in: query
-      description: Limit the number of items returned in the list.
-      required: false
-      schema:
-        type: number
-        title: limit
-        description: Limit the number of items returned in the list.
-    - name: order
-      in: query
-      description: >-
-        The field to sort the data by. By default, the sort order is ascending.
-        To change the order to descending, prefix the field name with `-`.
-      required: false
-      schema:
-        type: string
-        title: order
-        description: >-
-          The field to sort the data by. By default, the sort order is
-          ascending. To change the order to descending, prefix the field name
-          with `-`.
   security:
     - api_token: []
     - cookie_auth: []
@@ -100,3 +45,4 @@ post:
       $ref: ../components/responses/invalid_request_error.yaml
     '500':
       $ref: ../components/responses/500_error.yaml
+  x-workflow: cancelOrderClaimWorkflow