docs: generate OAS with events (#12394)

* docs: generate OAS with events * small change
2025-05-07 14:57:03 +03:00
parent 262064fe96
commit a3bdb3e383
515 changed files with 3808 additions and 189 deletions
@@ -1337,3 +1337,4 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: createApiKeysWorkflow
+  x-events: []
@@ -134,6 +134,7 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: updateApiKeysWorkflow
+  x-events: []
 delete:
  operationId: DeleteApiKeysId
  summary: Delete an Api Key
@@ -201,3 +202,4 @@ delete:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: deleteApiKeysWorkflow
+  x-events: []
@@ -71,3 +71,4 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: revokeApiKeysWorkflow
+  x-events: []
@@ -87,3 +87,4 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: linkSalesChannelsToApiKeyWorkflow
+  x-events: []
@@ -271,3 +271,4 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: createCampaignsWorkflow
+  x-events: []
@@ -196,6 +196,7 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: updateCampaignsWorkflow
+  x-events: []
 delete:
  operationId: DeleteCampaignsId
  summary: Delete a Campaign
@@ -264,3 +265,4 @@ delete:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: deleteCampaignsWorkflow
+  x-events: []
@@ -87,3 +87,4 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: addOrRemoveCampaignPromotionsWorkflow
+  x-events: []
@@ -1084,3 +1084,4 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: beginClaimOrderWorkflow
+  x-events: []
@@ -50,3 +50,4 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: cancelOrderClaimWorkflow
+  x-events: []
@@ -71,3 +71,4 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: orderClaimItemWorkflow
+  x-events: []
@@ -83,6 +83,7 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: updateClaimItemWorkflow
+  x-events: []
 delete:
  operationId: DeleteClaimsIdClaimItemsAction_id
  summary: Remove a Claim Item from a Claim
@@ -164,3 +165,4 @@ delete:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: removeItemClaimActionWorkflow
+  x-events: []
@@ -53,3 +53,4 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: orderClaimRequestItemReturnWorkflow
+  x-events: []
@@ -67,6 +67,7 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: updateRequestItemReturnWorkflow
+  x-events: []
 delete:
  operationId: DeleteClaimsIdInboundItemsAction_id
  summary: Remove an Inbound Item from Claim
@@ -130,3 +131,4 @@ delete:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: removeItemReturnActionWorkflow
+  x-events: []
@@ -55,3 +55,4 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: createClaimShippingMethodWorkflow
+  x-events: []
@@ -84,6 +84,7 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: updateReturnShippingMethodWorkflow
+  x-events: []
 delete:
  operationId: DeleteClaimsIdInboundShippingMethodAction_id
  summary: Remove Inbound Shipping Method from Claim
@@ -147,3 +148,4 @@ delete:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: removeClaimShippingMethodWorkflow
+  x-events: []
@@ -71,3 +71,4 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: orderClaimAddNewItemWorkflow
+  x-events: []
@@ -84,6 +84,7 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: updateClaimAddItemWorkflow
+  x-events: []
 delete:
  operationId: DeleteClaimsIdOutboundItemsAction_id
  summary: Remove an Outbound Item from Claim
@@ -165,3 +166,4 @@ delete:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: removeAddItemClaimActionWorkflow
+  x-events: []
@@ -73,3 +73,4 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: createClaimShippingMethodWorkflow
+  x-events: []
@@ -84,6 +84,7 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: updateClaimShippingMethodWorkflow
+  x-events: []
 delete:
  operationId: DeleteClaimsIdOutboundShippingMethodAction_id
  summary: Remove Outbound Shipping Method from Claim
@@ -165,3 +166,4 @@ delete:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: removeClaimShippingMethodWorkflow
+  x-events: []
@@ -64,6 +64,17 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: confirmClaimRequestWorkflow
+  x-events:
+    - name: order.claim_created
+      payload: |-
+        ```ts
+        {
+          order_id, // The ID of the order
+          claim_id, // The ID of the claim
+        }
+        ```
+      description: Emitted when a claim is created for an order.
+      deprecated: false
 delete:
  operationId: DeleteClaimsIdRequest
  summary: Cancel Claim Request
@@ -111,3 +122,4 @@ delete:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: cancelBeginOrderClaimWorkflow
+  x-events: []
@@ -1040,3 +1040,13 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: createCollectionsWorkflow
+  x-events:
+    - name: product-collection.created
+      payload: |-
+        ```ts
+        [{
+          id, // The ID of the product collection
+        }]
+        ```
+      description: Emitted when product collections are created.
+      deprecated: false
@@ -134,6 +134,16 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: updateCollectionsWorkflow
+  x-events:
+    - name: product-collection.updated
+      payload: |-
+        ```ts
+        [{
+          id, // The ID of the product collection
+        }]
+        ```
+      description: Emitted when product collections are updated.
+      deprecated: false
 delete:
  operationId: DeleteCollectionsId
  summary: Delete a Collection
@@ -181,3 +191,13 @@ delete:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: deleteCollectionsWorkflow
+  x-events:
+    - name: product-collection.deleted
+      payload: |-
+        ```ts
+        [{
+          id, // The ID of the product collection
+        }]
+        ```
+      description: Emitted when product collections are deleted.
+      deprecated: false
@@ -87,3 +87,4 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: batchLinkProductsToCollectionWorkflow
+  x-events: []
@@ -1090,3 +1090,4 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: createCustomerGroupsWorkflow
+  x-events: []
@@ -134,6 +134,7 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: updateCustomerGroupsWorkflow
+  x-events: []
 delete:
  operationId: DeleteCustomerGroupsId
  summary: Delete a Customer Group
@@ -200,3 +201,4 @@ delete:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: deleteCustomerGroupsWorkflow
+  x-events: []
@@ -86,3 +86,4 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: linkCustomersToCustomerGroupWorkflow
+  x-events: []
@@ -4337,3 +4337,13 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: createCustomersWorkflow
+  x-events:
+    - name: customer.created
+      payload: |-
+        ```ts
+        [{
+          id, // The ID of the customer
+        }]
+        ```
+      description: Emitted when a customer is created.
+      deprecated: false
@@ -194,6 +194,16 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: updateCustomersWorkflow
+  x-events:
+    - name: customer.updated
+      payload: |-
+        ```ts
+        [{
+          id, // The ID of the customer
+        }]
+        ```
+      description: Emitted when a customer is updated.
+      deprecated: false
 delete:
  operationId: DeleteCustomersId
  summary: Delete a Customer
@@ -259,3 +269,13 @@ delete:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: removeCustomerAccountWorkflow
+  x-events:
+    - name: customer.deleted
+      payload: |-
+        ```ts
+        [{
+          id, // The ID of the customer
+        }]
+        ```
+      description: Emitted when a customer is deleted.
+      deprecated: false
@@ -128,13 +128,21 @@ get:
        oneOf:
          - type: string
            title: province
-            description: Filter by a province.
+            description: Filter by an ISO 3166-2 province code. Must be lower-case.
+            example: us-ca
+            externalDocs:
+              url: https://en.wikipedia.org/wiki/ISO_3166-2
+              description: Learn more about ISO 3166-2
          - type: array
-            description: Filter by provinces.
+            description: Filter by ISO 3166-2 provinces.
            items:
              type: string
              title: province
-              description: A province code.
+              description: A ISO 3166-2 province code. Must be lower-case.
+              example: us-ca
+              externalDocs:
+                url: https://en.wikipedia.org/wiki/ISO_3166-2
+                description: Learn more about ISO 3166-2
    - name: postal_code
      in: query
      required: false
@@ -353,7 +361,11 @@ post:
                province:
                  type: string
                  title: province
-                  description: The address's province.
+                  description: The address's ISO 3166-2 province code. Must be lower-case.
+                  example: us-ca
+                  externalDocs:
+                    url: https://en.wikipedia.org/wiki/ISO_3166-2
+                    description: Learn more about ISO 3166-2
                postal_code:
                  type: string
                  title: postal_code
@@ -406,3 +418,4 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: createCustomerAddressesWorkflow
+  x-events: []
@@ -197,7 +197,11 @@ post:
                province:
                  type: string
                  title: province
-                  description: The address's province.
+                  description: The address's ISO 3166-2 province code. Must be lower-case.
+                  example: us-ca
+                  externalDocs:
+                    url: https://en.wikipedia.org/wiki/ISO_3166-2
+                    description: Learn more about ISO 3166-2
                postal_code:
                  type: string
                  title: postal_code
@@ -252,6 +256,7 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: updateCustomerAddressesWorkflow
+  x-events: []
 delete:
  operationId: DeleteCustomersIdAddressesAddress_id
  summary: Remove an Address from Customer
@@ -358,3 +363,4 @@ delete:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: deleteCustomerAddressesWorkflow
+  x-events: []
@@ -100,3 +100,4 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: linkCustomerGroupsToCustomerWorkflow
+  x-events: []
@@ -1780,6 +1780,7 @@ get:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: getOrdersListWorkflow
+  x-events: []
 post:
  operationId: PostDraftOrders
  summary: Create Draft Order
@@ -1896,7 +1897,13 @@ post:
                    province:
                      type: string
                      title: province
-                      description: The billing address's province.
+                      description: >-
+                        The billing address's ISO 3166-2 province code. Must be
+                        lower-case.
+                      example: us-ca
+                      externalDocs:
+                        url: https://en.wikipedia.org/wiki/ISO_3166-2
+                        description: Learn more about ISO 3166-2
                    postal_code:
                      type: string
                      title: postal_code
@@ -1955,7 +1962,13 @@ post:
                    province:
                      type: string
                      title: province
-                      description: The shipping address's province.
+                      description: >-
+                        The shipping address's ISO 3166-2 province code. Must be
+                        lower-case.
+                      example: us-ca
+                      externalDocs:
+                        url: https://en.wikipedia.org/wiki/ISO_3166-2
+                        description: Learn more about ISO 3166-2
                    postal_code:
                      type: string
                      title: postal_code
@@ -2141,3 +2154,4 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: createOrderWorkflow
+  x-events: []
@@ -67,6 +67,7 @@ get:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: getOrderDetailWorkflow
+  x-events: []
 post:
  operationId: PostDraftOrdersId
  summary: Update a Draft Order
@@ -142,3 +143,15 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: updateDraftOrderWorkflow
+  x-events:
+    - name: order.updated
+      payload: |-
+        ```ts
+        {
+          id, // The ID of the order
+        }
+        ```
+      description: |-
+        Emitted when the details of an order or draft order is updated. This
+        doesn't include updates made by an edit.
+      deprecated: false
@@ -65,3 +65,17 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: convertDraftOrderWorkflow
+  x-events:
+    - name: order.placed
+      payload: |-
+        ```ts
+        {
+          id, // The ID of the order
+        }
+        ```
+      description: >-
+        Emitted when an order is placed, or when a draft order is converted to
+        an
+
+        order.
+      deprecated: false
@@ -46,6 +46,7 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: beginDraftOrderEditWorkflow
+  x-events: []
 delete:
  operationId: DeleteDraftOrdersIdEdit
  summary: Cancel Edit on Draft Order
@@ -90,3 +91,4 @@ delete:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: cancelDraftOrderEditWorkflow
+  x-events: []
@@ -45,3 +45,4 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: confirmDraftOrderEditWorkflow
+  x-events: []
@@ -47,3 +47,4 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: addDraftOrderItemsWorkflow
+  x-events: []
@@ -55,3 +55,4 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: updateDraftOrderItemWorkflow
+  x-events: []
@@ -62,6 +62,7 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: updateDraftOrderActionItemWorkflow
+  x-events: []
 delete:
  operationId: DeleteDraftOrdersIdEditItemsAction_id
  summary: Remove Item from Draft Order Edit
@@ -121,3 +122,4 @@ delete:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: removeDraftOrderActionItemWorkflow
+  x-events: []
@@ -52,6 +52,7 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: addDraftOrderPromotionWorkflow
+  x-events: []
 delete:
  operationId: DeleteDraftOrdersIdEditPromotions
  summary: Remove Promotions from Draft Order Edit
@@ -107,3 +108,4 @@ delete:
      application/json:
        schema:
          $ref: ../components/schemas/AdminRemoveDraftOrderPromotions.yaml
+  x-events: []
@@ -45,3 +45,4 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: requestDraftOrderEditWorkflow
+  x-events: []
@@ -49,3 +49,4 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: addDraftOrderShippingMethodsWorkflow
+  x-events: []
@@ -55,6 +55,7 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: updateDraftOrderShippingMethodWorkflow
+  x-events: []
 delete:
  operationId: DeleteDraftOrdersIdEditShippingMethodsMethodMethod_id
  summary: Remove Shipping Method from Draft Order Edit
@@ -107,3 +108,4 @@ delete:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: removeDraftOrderShippingMethodWorkflow
+  x-events: []
@@ -62,6 +62,7 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: updateDraftOrderActionShippingMethodWorkflow
+  x-events: []
 delete:
  operationId: DeleteDraftOrdersIdEditShippingMethodsAction_id
  summary: Remove New Shipping Method from Draft Order
@@ -121,3 +122,4 @@ delete:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: removeDraftOrderActionShippingMethodWorkflow
+  x-events: []
@@ -1037,3 +1037,4 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: beginExchangeOrderWorkflow
+  x-events: []
@@ -50,3 +50,4 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: cancelOrderExchangeWorkflow
+  x-events: []
@@ -54,3 +54,4 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: orderExchangeRequestItemReturnWorkflow
+  x-events: []
@@ -67,6 +67,7 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: updateRequestItemReturnWorkflow
+  x-events: []
 delete:
  operationId: DeleteExchangesIdInboundItemsAction_id
  summary: Remove Inbound Item from Exchange
@@ -130,3 +131,4 @@ delete:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: removeItemReturnActionWorkflow
+  x-events: []
@@ -55,3 +55,4 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: createExchangeShippingMethodWorkflow
+  x-events: []
@@ -84,6 +84,7 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: updateReturnShippingMethodWorkflow
+  x-events: []
 delete:
  operationId: DeleteExchangesIdInboundShippingMethodAction_id
  summary: Remove Inbound Shipping Method from Exchange
@@ -147,3 +148,4 @@ delete:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: removeReturnShippingMethodWorkflow
+  x-events: []
@@ -70,3 +70,4 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: orderExchangeAddNewItemWorkflow
+  x-events: []
@@ -84,6 +84,7 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: updateExchangeAddItemWorkflow
+  x-events: []
 delete:
  operationId: DeleteExchangesIdOutboundItemsAction_id
  summary: Remove Outbound Item from Exchange
@@ -165,3 +166,4 @@ delete:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: removeItemExchangeActionWorkflow
+  x-events: []
@@ -73,3 +73,4 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: createExchangeShippingMethodWorkflow
+  x-events: []
@@ -84,6 +84,7 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: updateExchangeShippingMethodWorkflow
+  x-events: []
 delete:
  operationId: DeleteExchangesIdOutboundShippingMethodAction_id
  summary: Remove Outbound Shipping Method from Exchange
@@ -165,3 +166,4 @@ delete:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: removeExchangeShippingMethodWorkflow
+  x-events: []
@@ -63,6 +63,17 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: confirmExchangeRequestWorkflow
+  x-events:
+    - name: order.exchange_created
+      payload: |-
+        ```ts
+        {
+          order_id, // The ID of the order
+          exchange_id, // The ID of the exchange
+        }
+        ```
+      description: Emitted when an exchange is created for an order.
+      deprecated: false
 delete:
  operationId: DeleteExchangesIdRequest
  summary: Cancel Exchange Request
@@ -110,3 +121,4 @@ delete:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: cancelBeginOrderExchangeWorkflow
+  x-events: []
@@ -45,3 +45,4 @@ delete:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: deleteFulfillmentSetsWorkflow
+  x-events: []
@@ -93,7 +93,13 @@ post:
                      province_code:
                        type: string
                        title: province_code
-                        description: The geo zone's province code.
+                        description: >-
+                          The geo zone's ISO 3166-2 province code. Must be
+                          lower-case.
+                        example: us-ca
+                        externalDocs:
+                          url: https://en.wikipedia.org/wiki/ISO_3166-2
+                          description: Learn more about ISO 3166-2
                  - type: object
                    description: A city geo zone
                    required:
@@ -118,7 +124,13 @@ post:
                      province_code:
                        type: string
                        title: province_code
-                        description: The geo zone's province code.
+                        description: >-
+                          The geo zone's ISO 3166-2 province code. Must be
+                          lower-case.
+                        example: us-ca
+                        externalDocs:
+                          url: https://en.wikipedia.org/wiki/ISO_3166-2
+                          description: Learn more about ISO 3166-2
                      city:
                        type: string
                        title: city
@@ -148,7 +160,13 @@ post:
                      province_code:
                        type: string
                        title: province_code
-                        description: The geo zone's province code.
+                        description: >-
+                          The geo zone's ISO 3166-2 province code. Must be
+                          lower-case.
+                        example: us-ca
+                        externalDocs:
+                          url: https://en.wikipedia.org/wiki/ISO_3166-2
+                          description: Learn more about ISO 3166-2
                      city:
                        type: string
                        title: city
@@ -189,3 +207,4 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: createServiceZonesWorkflow
+  x-events: []
@@ -174,7 +174,13 @@ post:
                      province_code:
                        type: string
                        title: province_code
-                        description: The geo zone's province code.
+                        description: >-
+                          The geo zone's ISO 3166-2 province code. Must be
+                          lower-case.
+                        example: us-ca
+                        externalDocs:
+                          url: https://en.wikipedia.org/wiki/ISO_3166-2
+                          description: Learn more about ISO 3166-2
                      id:
                        type: string
                        title: id
@@ -207,7 +213,13 @@ post:
                      province_code:
                        type: string
                        title: province_code
-                        description: The geo zone's province code.
+                        description: >-
+                          The geo zone's ISO 3166-2 province code. Must be
+                          lower-case.
+                        example: us-ca
+                        externalDocs:
+                          url: https://en.wikipedia.org/wiki/ISO_3166-2
+                          description: Learn more about ISO 3166-2
                      id:
                        type: string
                        title: id
@@ -241,7 +253,13 @@ post:
                      province_code:
                        type: string
                        title: province_code
-                        description: The geo zone's province code.
+                        description: >-
+                          The geo zone's ISO 3166-2 province code. Must be
+                          lower-case.
+                        example: us-ca
+                        externalDocs:
+                          url: https://en.wikipedia.org/wiki/ISO_3166-2
+                          description: Learn more about ISO 3166-2
                      postal_expression:
                        type: object
                        description: The geo zone's postal expression or ZIP code.
@@ -282,6 +300,7 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: updateServiceZonesWorkflow
+  x-events: []
 delete:
  operationId: DeleteFulfillmentSetsIdServiceZonesZone_id
  summary: Remove a Service Zone from Fulfillment Set
@@ -338,3 +357,4 @@ delete:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: deleteServiceZonesWorkflow
+  x-events: []
@@ -62,3 +62,4 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: createFulfillmentWorkflow
+  x-events: []
@@ -68,3 +68,4 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: cancelFulfillmentWorkflow
+  x-events: []
@@ -71,3 +71,4 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: createShipmentWorkflow
+  x-events: []
@@ -559,3 +559,4 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: createInventoryItemsWorkflow
+  x-events: []
@@ -46,3 +46,4 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: batchInventoryItemLevelsWorkflow
+  x-events: []
@@ -196,6 +196,7 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: updateInventoryItemsWorkflow
+  x-events: []
 delete:
  operationId: DeleteInventoryItemsId
  summary: Delete Inventory Item
@@ -262,3 +263,4 @@ delete:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: deleteInventoryItemWorkflow
+  x-events: []
@@ -237,3 +237,4 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: createInventoryLevelsWorkflow
+  x-events: []
@@ -49,3 +49,4 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: batchInventoryItemLevelsWorkflow
+  x-events: []
@@ -89,6 +89,7 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: updateInventoryLevelsWorkflow
+  x-events: []
 delete:
  operationId: DeleteInventoryItemsIdLocationLevelsLocation_id
  summary: Remove Inventory Level of Inventory Item
@@ -193,3 +194,4 @@ delete:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: deleteInventoryLevelsWorkflow
+  x-events: []
@@ -673,3 +673,15 @@ post:
    - api_token: []
    - cookie_auth: []
    - jwt_token: []
+  x-events:
+    - name: invite.created
+      payload: |-
+        ```ts
+        [{
+          id, // The ID of the invite
+        }]
+        ```
+      description: |-
+        Emitted when invites are created. You can listen to this event
+        to send an email to the invited users, for example.
+      deprecated: false
@@ -79,3 +79,22 @@ post:
  security:
    - cookie_auth: []
    - jwt_token: []
+  x-events:
+    - name: user.created
+      payload: |-
+        ```ts
+        [{
+          id, // The ID of the user
+        }]
+        ```
+      description: Emitted when users are created.
+      deprecated: false
+    - name: invite.accepted
+      payload: |-
+        ```ts
+        {
+          id, // The ID of the invite
+        }
+        ```
+      description: Emitted when an invite is accepted.
+      deprecated: false
@@ -130,3 +130,13 @@ delete:
    - api_token: []
    - cookie_auth: []
    - jwt_token: []
+  x-events:
+    - name: invite.deleted
+      payload: |-
+        ```ts
+        [{
+          id, // The ID of the invite
+        }]
+        ```
+      description: Emitted when invites are deleted.
+      deprecated: false
@@ -63,3 +63,19 @@ post:
    - api_token: []
    - cookie_auth: []
    - jwt_token: []
+  x-events:
+    - name: invite.resent
+      payload: |-
+        ```ts
+        [{
+          id, // The ID of the invite
+        }]
+        ```
+      description: >-
+        Emitted when invites should be resent because their token was
+
+        refreshed. You can listen to this event to send an email to the invited
+        users,
+
+        for example.
+      deprecated: false
@@ -43,3 +43,4 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: beginOrderEditOrderWorkflow
+  x-events: []
@@ -64,3 +64,14 @@ delete:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: cancelBeginOrderEditWorkflow
+  x-events:
+    - name: order-edit.canceled
+      payload: |-
+        ```ts
+        {
+          order_id, // The ID of the order
+          actions, // (array) The [actions](https://docs.medusajs.com/resources/references/fulfillment/interfaces/fulfillment.OrderChangeActionDTO) to edit the order
+        }
+        ```
+      description: Emitted when an order edit request is canceled.
+      deprecated: false
@@ -45,3 +45,13 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: confirmOrderEditRequestWorkflow
+  x-events:
+    - name: order-edit.confirmed
+      payload: |-
+        ```ts
+        {
+          order_id, // The ID of the order
+          actions, // (array) The [actions](https://docs.medusajs.com/resources/references/fulfillment/interfaces/fulfillment.OrderChangeActionDTO) to edit the order
+        ```
+      description: Emitted when an order edit request is confirmed.
+      deprecated: false
@@ -51,3 +51,4 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: orderEditAddNewItemWorkflow
+  x-events: []
@@ -60,3 +60,4 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: orderEditUpdateItemQuantityWorkflow
+  x-events: []
@@ -65,6 +65,7 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: updateOrderEditAddItemWorkflow
+  x-events: []
 delete:
  operationId: DeleteOrderEditsIdItemsAction_id
  summary: Remove Item from Order Edit
@@ -128,3 +129,4 @@ delete:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: removeItemOrderEditActionWorkflow
+  x-events: []
@@ -45,3 +45,14 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: requestOrderEditRequestWorkflow
+  x-events:
+    - name: order-edit.requested
+      payload: |-
+        ```ts
+        {
+          order_id, // The ID of the order
+          actions, // (array) The [actions](https://docs.medusajs.com/resources/references/fulfillment/interfaces/fulfillment.OrderChangeActionDTO) to edit the order
+        }
+        ```
+      description: Emitted when an order edit is requested.
+      deprecated: false
@@ -49,3 +49,4 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: createOrderEditShippingMethodWorkflow
+  x-events: []
@@ -62,6 +62,7 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: updateOrderEditShippingMethodWorkflow
+  x-events: []
 delete:
  operationId: DeleteOrderEditsIdShippingMethodAction_id
  summary: Remove Shipping Method from Order Edit
@@ -120,3 +121,4 @@ delete:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: removeOrderEditShippingMethodWorkflow
+  x-events: []
@@ -765,3 +765,4 @@ get:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: getOrdersListWorkflow
+  x-events: []
@@ -113,6 +113,7 @@ get:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: getOrderDetailWorkflow
+  x-events: []
 post:
  operationId: PostOrdersId
  summary: Update Order
@@ -185,3 +186,15 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: updateOrderWorkflow
+  x-events:
+    - name: order.updated
+      payload: |-
+        ```ts
+        {
+          id, // The ID of the order
+        }
+        ```
+      description: |-
+        Emitted when the details of an order or draft order is updated. This
+        doesn't include updates made by an edit.
+      deprecated: false
@@ -59,3 +59,13 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: archiveOrderWorkflow
+  x-events:
+    - name: order.archived
+      payload: |-
+        ```ts
+        [{
+          id, // The ID of the order
+        }]
+        ```
+      description: Emitted when an order is archived.
+      deprecated: false
@@ -71,3 +71,13 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: cancelOrderWorkflow
+  x-events:
+    - name: order.canceled
+      payload: |-
+        ```ts
+        {
+          id, // The ID of the order
+        }
+        ```
+      description: Emitted when an order is canceld.
+      deprecated: false
@@ -74,3 +74,13 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: completeOrderWorkflow
+  x-events:
+    - name: order.completed
+      payload: |-
+        ```ts
+        [{
+          id, // The ID of the order
+        }]
+        ```
+      description: Emitted when orders are completed.
+      deprecated: false
@@ -71,3 +71,4 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: createOrderCreditLinesWorkflow
+  x-events: []
@@ -122,3 +122,15 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: createOrderFulfillmentWorkflow
+  x-events:
+    - name: order.fulfillment_created
+      payload: |-
+        ```ts
+        {
+          order_id, // The ID of the order
+          fulfillment_id, // The ID of the fulfillment
+          no_notification, // (boolean) Whether to notify the customer
+        }
+        ```
+      description: Emitted when a fulfillment is created for an order.
+      deprecated: false
@@ -97,3 +97,15 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: cancelOrderFulfillmentWorkflow
+  x-events:
+    - name: order.fulfillment_canceled
+      payload: |-
+        ```ts
+        {
+          order_id, // The ID of the order
+          fulfillment_id, // The ID of the fulfillment
+          no_notification, // (boolean) Whether to notify the customer
+        }
+        ```
+      description: Emitted when an order's fulfillment is canceled.
+      deprecated: false
@@ -72,3 +72,13 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: markOrderFulfillmentAsDeliveredWorkflow
+  x-events:
+    - name: delivery.created
+      payload: |-
+        ```ts
+        {
+          id, // the ID of the fulfillment
+        }
+        ```
+      description: Emitted when a fulfillment is marked as delivered.
+      deprecated: false
@@ -143,3 +143,14 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: createOrderShipmentWorkflow
+  x-events:
+    - name: shipment.created
+      payload: |-
+        ```ts
+        {
+          id, // the ID of the shipment
+          no_notification, // (boolean) whether to notify the customer
+        }
+        ```
+      description: Emitted when a shipment is created for an order.
+      deprecated: false
@@ -75,3 +75,16 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: requestOrderTransferWorkflow
+  x-events:
+    - name: order.transfer_requested
+      payload: |-
+        ```ts
+        {
+          id, // The ID of the order
+          order_change_id, // The ID of the order change created for the transfer
+        }
+        ```
+      description: |-
+        Emitted when an order is requested to be transferred to
+        another customer.
+      deprecated: false
@@ -66,3 +66,4 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: cancelOrderTransferRequestWorkflow
+  x-events: []
@@ -75,3 +75,4 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: createOrderPaymentCollectionWorkflow
+  x-events: []
@@ -45,3 +45,4 @@ delete:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: deleteOrderPaymentCollections
+  x-events: []
@@ -81,3 +81,4 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: markPaymentCollectionAsPaid
+  x-events: []
@@ -76,3 +76,4 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: capturePaymentWorkflow
+  x-events: []
@@ -84,3 +84,4 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: refundPaymentWorkflow
+  x-events: []
@@ -507,3 +507,4 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: createPriceListsWorkflow
+  x-events: []
@@ -134,6 +134,7 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: updatePriceListsWorkflow
+  x-events: []
 delete:
  operationId: DeletePriceListsId
  summary: Delete a Price List
@@ -181,3 +182,4 @@ delete:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: deletePriceListsWorkflow
+  x-events: []
@@ -145,3 +145,4 @@ post:
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: batchPriceListPricesWorkflow
+  x-events: []
--- a/Show More
+++ b/Show More