diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_{id}_options/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_{id}_options/post.js index 4d470b36d8..6a7b4ff6bc 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_{id}_options/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_{id}_options/post.js @@ -9,7 +9,7 @@ export const sdk = new Medusa({ }) sdk.admin.product.createOption( - "prod_123", + "prod_123", { title: "Color", values: ["Green", "Blue"] diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_{id}_options_{option_id}/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_{id}_options_{option_id}/post.js index 297d141eb1..49f02de755 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_{id}_options_{option_id}/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_{id}_options_{option_id}/post.js @@ -9,7 +9,7 @@ export const sdk = new Medusa({ }) sdk.admin.product.updateOption( - "prod_123", + "prod_123", "prodopt_123", { title: "Color" diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_{id}_variants_inventory-items_batch/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_{id}_variants_inventory-items_batch/post.js index aba2bfa878..18f2b57b00 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_{id}_variants_inventory-items_batch/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_{id}_variants_inventory-items_batch/post.js @@ -9,7 +9,7 @@ export const sdk = new Medusa({ }) sdk.admin.product.batchVariantInventoryItems( - "prod_123", + "prod_123", { create: [ { diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_{id}_variants_{variant_id}/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_{id}_variants_{variant_id}/post.js index 8672481c6f..b2bfd20f4e 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_{id}_variants_{variant_id}/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_{id}_variants_{variant_id}/post.js @@ -9,7 +9,7 @@ export const sdk = new Medusa({ }) sdk.admin.product.updateVariant( - "prod_123", + "prod_123", "variant_123", { title: "Blue Shirt", diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_tax-regions_{id}/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_tax-regions_{id}/post.js new file mode 100644 index 0000000000..eb03a8b532 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_tax-regions_{id}/post.js @@ -0,0 +1,16 @@ +import Medusa from "@medusajs/js-sdk" + +export const sdk = new Medusa({ + baseUrl: import.meta.env.VITE_BACKEND_URL || "/", + debug: import.meta.env.DEV, + auth: { + type: "session", + }, +}) + +sdk.admin.taxRegion.update("txreg_123", { + province_code: "ca", +}) +.then(({ tax_region }) => { + console.log(tax_region) +}) \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers_{id}_addresses/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers_{id}_addresses/post.sh index e6e0230bf5..3e73c16ab6 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers_{id}_addresses/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers_{id}_addresses/post.sh @@ -10,7 +10,7 @@ curl -X POST '{backend_url}/admin/customers/{id}/addresses' \ "address_2": "{value}", "city": "{value}", "country_code": "{value}", - "province": "{value}", + "province": "us-ca", "postal_code": "{value}", "phone": "{value}", "metadata": {} diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillments/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillments/post.sh index 1f12b18d9b..121405a319 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillments/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillments/post.sh @@ -13,7 +13,7 @@ curl -X POST '{backend_url}/admin/fulfillments' \ "address_2": "{value}", "city": "{value}", "country_code": "{value}", - "province": "{value}", + "province": "us-ca", "postal_code": "{value}", "metadata": {} }, diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-regions/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-regions/post.sh index d62db2eeb4..5ee2b96124 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-regions/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-regions/post.sh @@ -3,7 +3,7 @@ curl -X POST '{backend_url}/admin/tax-regions' \ -H 'Content-Type: application/json' \ --data-raw '{ "country_code": "{value}", - "province_code": "{value}", + "province_code": "us-ca", "parent_id": "{value}", "metadata": {} }' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateFulfillment.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateFulfillment.yaml index 1a0af19c8f..6359d75d4c 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateFulfillment.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateFulfillment.yaml @@ -58,7 +58,11 @@ properties: province: type: string title: province - description: The delivery address's province. + description: The delivery 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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateTaxRegion.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateTaxRegion.yaml index 261472a2de..e1b10b47c9 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateTaxRegion.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateTaxRegion.yaml @@ -12,7 +12,11 @@ properties: province_code: type: string title: province_code - description: The tax region's province code. + description: The tax region'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 parent_id: type: string title: parent_id diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCustomerAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCustomerAddress.yaml index de369d541a..9cce8725ae 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCustomerAddress.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCustomerAddress.yaml @@ -73,7 +73,11 @@ properties: province: type: string title: province - description: The address's province. + description: The address's lower-case ISO 3166-2 province code. + 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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentAddress.yaml index 37df664f0e..67f9793026 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentAddress.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentAddress.yaml @@ -58,7 +58,11 @@ properties: province: type: string title: province - description: The address's province. + description: The address's lower-case ISO 3166-2 province code. + 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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminGeoZone.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminGeoZone.yaml index c7d0be5d77..bf81d83be0 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminGeoZone.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminGeoZone.yaml @@ -31,7 +31,11 @@ properties: province_code: type: string title: province_code - description: The geo zone's province code. + description: The geo zone's lower-case ISO 3166-2 province code. + 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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderAddress.yaml index 6a69c1a244..fad010e48b 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderAddress.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderAddress.yaml @@ -53,7 +53,11 @@ properties: province: type: string title: province - description: The address's province. + description: The address's lower-case ISO 3166-2 province code. + 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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationAddress.yaml index 22dc78b1d4..c2517adeef 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationAddress.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationAddress.yaml @@ -38,7 +38,11 @@ properties: province: type: string title: province - description: The address's province. + description: The address's lower-case ISO 3166-2 province code. + example: us-ca + externalDocs: + url: https://en.wikipedia.org/wiki/ISO_3166-2 + description: Learn more about ISO 3166-2 required: - id - address_1 diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRegion.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRegion.yaml index 0c5867f445..f75bb9af92 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRegion.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRegion.yaml @@ -27,7 +27,11 @@ properties: province_code: type: string title: province_code - description: The tax region's province code. + description: The tax region's lower-case ISO 3166-2 province code. + example: us-ca + externalDocs: + url: https://en.wikipedia.org/wiki/ISO_3166-2 + description: Learn more about ISO 3166-2 metadata: type: object description: The tax region's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateDraftOrder.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateDraftOrder.yaml index b8a6ad7759..e4e0c8a5ee 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateDraftOrder.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateDraftOrder.yaml @@ -47,7 +47,11 @@ properties: 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 @@ -95,7 +99,11 @@ properties: 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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateOrder.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateOrder.yaml index 198a1866bd..78280d8e76 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateOrder.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateOrder.yaml @@ -47,7 +47,11 @@ properties: 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 @@ -95,7 +99,11 @@ properties: 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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateStockLocation.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateStockLocation.yaml index 936fe6f522..9d47328396 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateStockLocation.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateStockLocation.yaml @@ -47,7 +47,11 @@ properties: 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 address_id: type: string title: address_id diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateTaxRegion.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateTaxRegion.yaml index d599385b83..a66fb3835b 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateTaxRegion.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateTaxRegion.yaml @@ -5,7 +5,11 @@ properties: province_code: type: string title: province_code - description: The tax region's province code. + description: The tax region'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 metadata: type: object description: The tax region's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpsertStockLocationAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpsertStockLocationAddress.yaml index 5c265c5e0e..4886fe1878 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpsertStockLocationAddress.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpsertStockLocationAddress.yaml @@ -37,4 +37,8 @@ properties: 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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderAddress.yaml index e3d3b54635..e1aafdc8fb 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderAddress.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderAddress.yaml @@ -51,7 +51,11 @@ properties: province: type: string title: province - description: The address's province. + description: The address's lower-case ISO 3166-2 province code. + 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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/CreateAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/CreateAddress.yaml index 14de28c42e..a610a042be 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/CreateAddress.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/CreateAddress.yaml @@ -38,7 +38,11 @@ properties: 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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/OrderAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/OrderAddress.yaml index 3108787026..f2ca629923 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/OrderAddress.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/OrderAddress.yaml @@ -50,7 +50,11 @@ properties: province: type: string title: province - description: The address's province. + description: The address's lower-case ISO 3166-2 province code. + 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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreCartAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreCartAddress.yaml index 15aa12c9eb..89963e7b4c 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreCartAddress.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCartAddress.yaml @@ -50,7 +50,11 @@ properties: province: type: string title: province - description: The address's province. + description: The address's lower-case ISO 3166-2 province code. + 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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreCustomerAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreCustomerAddress.yaml index 4d3108e25f..7c24514a35 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreCustomerAddress.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCustomerAddress.yaml @@ -73,7 +73,11 @@ properties: province: type: string title: province - description: The address's province. + description: The address's lower-case ISO 3166-2 province code. + 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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreOrderAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreOrderAddress.yaml index 54ec49cf34..8c24ea8e12 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreOrderAddress.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreOrderAddress.yaml @@ -53,7 +53,11 @@ properties: province: type: string title: province - description: The address's province. + description: The address's lower-case ISO 3166-2 province code. + 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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/UpdateAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/UpdateAddress.yaml index 22025cb22d..6968ed3b46 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/UpdateAddress.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/UpdateAddress.yaml @@ -44,7 +44,11 @@ properties: 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 diff --git a/www/apps/api-reference/specs/admin/openapi.full.yaml b/www/apps/api-reference/specs/admin/openapi.full.yaml index fcbc208782..73e82bb769 100644 --- a/www/apps/api-reference/specs/admin/openapi.full.yaml +++ b/www/apps/api-reference/specs/admin/openapi.full.yaml @@ -1679,6 +1679,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: createApiKeysWorkflow + x-events: [] /admin/api-keys/{id}: get: operationId: GetApiKeysId @@ -1832,6 +1833,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: updateApiKeysWorkflow + x-events: [] delete: operationId: DeleteApiKeysId summary: Delete an Api Key @@ -1913,6 +1915,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: deleteApiKeysWorkflow + x-events: [] /admin/api-keys/{id}/revoke: post: operationId: PostApiKeysIdRevoke @@ -1991,6 +1994,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: revokeApiKeysWorkflow + x-events: [] /admin/api-keys/{id}/sales-channels: post: operationId: PostApiKeysIdSalesChannels @@ -2088,6 +2092,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: linkSalesChannelsToApiKeyWorkflow + x-events: [] /admin/campaigns: get: operationId: GetCampaigns @@ -2366,6 +2371,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: createCampaignsWorkflow + x-events: [] /admin/campaigns/{id}: get: operationId: GetCampaignsId @@ -2580,6 +2586,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: updateCampaignsWorkflow + x-events: [] delete: operationId: DeleteCampaignsId summary: Delete a Campaign @@ -2661,6 +2668,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: deleteCampaignsWorkflow + x-events: [] /admin/campaigns/{id}/promotions: post: operationId: PostCampaignsIdPromotions @@ -2758,6 +2766,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: addOrRemoveCampaignPromotionsWorkflow + x-events: [] /admin/claims: get: operationId: GetClaims @@ -3693,6 +3702,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: beginClaimOrderWorkflow + x-events: [] /admin/claims/{id}: get: operationId: GetClaimsId @@ -3831,6 +3841,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: cancelOrderClaimWorkflow + x-events: [] /admin/claims/{id}/claim-items: post: operationId: PostClaimsIdClaimItems @@ -3916,6 +3927,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: orderClaimItemWorkflow + x-events: [] /admin/claims/{id}/claim-items/{action_id}: post: operationId: PostClaimsIdClaimItemsAction_id @@ -4008,6 +4020,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: updateClaimItemWorkflow + x-events: [] delete: operationId: DeleteClaimsIdClaimItemsAction_id summary: Remove a Claim Item from a Claim @@ -4092,6 +4105,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: removeItemClaimActionWorkflow + x-events: [] /admin/claims/{id}/inbound/items: post: operationId: PostClaimsIdInboundItems @@ -4171,6 +4185,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: orderClaimRequestItemReturnWorkflow + x-events: [] /admin/claims/{id}/inbound/items/{action_id}: post: operationId: PostClaimsIdInboundItemsAction_id @@ -4254,6 +4269,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: updateRequestItemReturnWorkflow + x-events: [] delete: operationId: DeleteClaimsIdInboundItemsAction_id summary: Remove an Inbound Item from Claim @@ -4326,6 +4342,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: removeItemReturnActionWorkflow + x-events: [] /admin/claims/{id}/inbound/shipping-method: post: operationId: PostClaimsIdInboundShippingMethod @@ -4405,6 +4422,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: createClaimShippingMethodWorkflow + x-events: [] /admin/claims/{id}/inbound/shipping-method/{action_id}: post: operationId: PostClaimsIdInboundShippingMethodAction_id @@ -4498,6 +4516,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: updateReturnShippingMethodWorkflow + x-events: [] delete: operationId: DeleteClaimsIdInboundShippingMethodAction_id summary: Remove Inbound Shipping Method from Claim @@ -4570,6 +4589,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: removeClaimShippingMethodWorkflow + x-events: [] /admin/claims/{id}/outbound/items: post: operationId: PostClaimsIdOutboundItems @@ -4657,6 +4677,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: orderClaimAddNewItemWorkflow + x-events: [] /admin/claims/{id}/outbound/items/{action_id}: post: operationId: PostClaimsIdOutboundItemsAction_id @@ -4750,6 +4771,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: updateClaimAddItemWorkflow + x-events: [] delete: operationId: DeleteClaimsIdOutboundItemsAction_id summary: Remove an Outbound Item from Claim @@ -4832,6 +4854,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: removeAddItemClaimActionWorkflow + x-events: [] /admin/claims/{id}/outbound/shipping-method: post: operationId: PostClaimsIdOutboundShippingMethod @@ -4921,6 +4944,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: createClaimShippingMethodWorkflow + x-events: [] /admin/claims/{id}/outbound/shipping-method/{action_id}: post: operationId: PostClaimsIdOutboundShippingMethodAction_id @@ -5014,6 +5038,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: updateClaimShippingMethodWorkflow + x-events: [] delete: operationId: DeleteClaimsIdOutboundShippingMethodAction_id summary: Remove Outbound Shipping Method from Claim @@ -5096,6 +5121,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: removeClaimShippingMethodWorkflow + x-events: [] /admin/claims/{id}/request: post: operationId: PostClaimsIdRequest @@ -5172,6 +5198,17 @@ paths: '500': $ref: '#/components/responses/500_error' 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 @@ -5235,6 +5272,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: cancelBeginOrderClaimWorkflow + x-events: [] /admin/collections: get: operationId: GetCollections @@ -6168,6 +6206,16 @@ paths: '500': $ref: '#/components/responses/500_error' 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 /admin/collections/{id}: get: operationId: GetCollectionsId @@ -6321,6 +6369,16 @@ paths: '500': $ref: '#/components/responses/500_error' 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 @@ -6382,6 +6440,16 @@ paths: '500': $ref: '#/components/responses/500_error' 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 /admin/collections/{id}/products: post: operationId: PostCollectionsIdProducts @@ -6479,6 +6547,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: batchLinkProductsToCollectionWorkflow + x-events: [] /admin/currencies: get: operationId: GetCurrencies @@ -7662,6 +7731,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: createCustomerGroupsWorkflow + x-events: [] /admin/customer-groups/{id}: get: operationId: GetCustomerGroupsId @@ -7816,6 +7886,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: updateCustomerGroupsWorkflow + x-events: [] delete: operationId: DeleteCustomerGroupsId summary: Delete a Customer Group @@ -7896,6 +7967,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: deleteCustomerGroupsWorkflow + x-events: [] /admin/customer-groups/{id}/customers: post: operationId: PostCustomerGroupsIdCustomers @@ -7993,6 +8065,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: linkCustomersToCustomerGroupWorkflow + x-events: [] /admin/customers: get: operationId: GetCustomers @@ -11518,6 +11591,16 @@ paths: '500': $ref: '#/components/responses/500_error' 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 /admin/customers/{id}: get: operationId: GetCustomersId @@ -11717,6 +11800,16 @@ paths: '500': $ref: '#/components/responses/500_error' 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 @@ -11796,6 +11889,16 @@ paths: '500': $ref: '#/components/responses/500_error' 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 /admin/customers/{id}/addresses: get: operationId: GetCustomersIdAddresses @@ -11904,13 +12007,21 @@ paths: 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 @@ -12113,7 +12224,11 @@ paths: 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 @@ -12170,7 +12285,7 @@ paths: "address_2": "{value}", "city": "{value}", "country_code": "{value}", - "province": "{value}", + "province": "us-ca", "postal_code": "{value}", "phone": "{value}", "metadata": {} @@ -12197,6 +12312,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: createCustomerAddressesWorkflow + x-events: [] /admin/customers/{id}/addresses/{address_id}: get: operationId: GetCustomersIdAddressesAddress_id @@ -12371,7 +12487,11 @@ paths: 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 @@ -12455,6 +12575,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: updateCustomerAddressesWorkflow + x-events: [] delete: operationId: DeleteCustomersIdAddressesAddress_id summary: Remove an Address from Customer @@ -12555,6 +12676,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: deleteCustomerAddressesWorkflow + x-events: [] /admin/customers/{id}/customer-groups: post: operationId: PostCustomersIdCustomerGroups @@ -12656,6 +12778,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: linkCustomerGroupsToCustomerWorkflow + x-events: [] /admin/draft-orders: get: operationId: GetDraftOrders @@ -14126,6 +14249,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: getOrdersListWorkflow + x-events: [] post: operationId: PostDraftOrders summary: Create Draft Order @@ -14232,7 +14356,11 @@ paths: 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 @@ -14291,7 +14419,11 @@ paths: 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 @@ -14510,6 +14642,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: createOrderWorkflow + x-events: [] /admin/draft-orders/{id}: get: operationId: GetDraftOrdersId @@ -14585,6 +14718,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: getOrderDetailWorkflow + x-events: [] post: operationId: PostDraftOrdersId summary: Update a Draft Order @@ -14666,6 +14800,18 @@ paths: '500': $ref: '#/components/responses/500_error' 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 /admin/draft-orders/{id}/convert-to-order: post: operationId: PostDraftOrdersIdConvertToOrder @@ -14738,6 +14884,18 @@ paths: '500': $ref: '#/components/responses/500_error' 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 /admin/draft-orders/{id}/edit: post: operationId: PostDraftOrdersIdEdit @@ -14797,6 +14955,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: beginDraftOrderEditWorkflow + x-events: [] delete: operationId: DeleteDraftOrdersIdEdit summary: Cancel Edit on Draft Order @@ -14855,6 +15014,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: cancelDraftOrderEditWorkflow + x-events: [] /admin/draft-orders/{id}/edit/confirm: post: operationId: PostDraftOrdersIdEditConfirm @@ -14914,6 +15074,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: confirmDraftOrderEditWorkflow + x-events: [] /admin/draft-orders/{id}/edit/items: post: operationId: PostDraftOrdersIdEditItems @@ -14985,6 +15146,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: addDraftOrderItemsWorkflow + x-events: [] /admin/draft-orders/{id}/edit/items/item/{item_id}: post: operationId: PostDraftOrdersIdEditItemsItemItem_id @@ -15061,6 +15223,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: updateDraftOrderItemWorkflow + x-events: [] /admin/draft-orders/{id}/edit/items/{action_id}: post: operationId: PostDraftOrdersIdEditItemsAction_id @@ -15140,6 +15303,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: updateDraftOrderActionItemWorkflow + x-events: [] delete: operationId: DeleteDraftOrdersIdEditItemsAction_id summary: Remove Item from Draft Order Edit @@ -15207,6 +15371,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: removeDraftOrderActionItemWorkflow + x-events: [] /admin/draft-orders/{id}/edit/promotions: post: operationId: PostDraftOrdersIdEditPromotions @@ -15283,6 +15448,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: addDraftOrderPromotionWorkflow + x-events: [] delete: operationId: DeleteDraftOrdersIdEditPromotions summary: Remove Promotions from Draft Order Edit @@ -15349,6 +15515,7 @@ paths: application/json: schema: $ref: '#/components/schemas/AdminRemoveDraftOrderPromotions' + x-events: [] /admin/draft-orders/{id}/edit/request: post: operationId: PostDraftOrdersIdEditRequest @@ -15408,6 +15575,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: requestDraftOrderEditWorkflow + x-events: [] /admin/draft-orders/{id}/edit/shipping-methods: post: operationId: PostDraftOrdersIdEditShippingMethods @@ -15478,6 +15646,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: addDraftOrderShippingMethodsWorkflow + x-events: [] /admin/draft-orders/{id}/edit/shipping-methods/method/{method_id}: post: operationId: PostDraftOrdersIdEditShippingMethodsMethodMethod_id @@ -15550,6 +15719,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: updateDraftOrderShippingMethodWorkflow + x-events: [] delete: operationId: DeleteDraftOrdersIdEditShippingMethodsMethodMethod_id summary: Remove Shipping Method from Draft Order Edit @@ -15617,6 +15787,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: removeDraftOrderShippingMethodWorkflow + x-events: [] /admin/draft-orders/{id}/edit/shipping-methods/{action_id}: post: operationId: PostDraftOrdersIdEditShippingMethodsAction_id @@ -15696,6 +15867,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: updateDraftOrderActionShippingMethodWorkflow + x-events: [] delete: operationId: DeleteDraftOrdersIdEditShippingMethodsAction_id summary: Remove New Shipping Method from Draft Order @@ -15763,6 +15935,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: removeDraftOrderActionShippingMethodWorkflow + x-events: [] /admin/exchanges: get: operationId: GetExchanges @@ -16697,6 +16870,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: beginExchangeOrderWorkflow + x-events: [] /admin/exchanges/{id}: get: operationId: GetExchangesId @@ -16835,6 +17009,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: cancelOrderExchangeWorkflow + x-events: [] /admin/exchanges/{id}/inbound/items: post: operationId: PostExchangesIdInboundItems @@ -16908,6 +17083,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: orderExchangeRequestItemReturnWorkflow + x-events: [] /admin/exchanges/{id}/inbound/items/{action_id}: post: operationId: PostExchangesIdInboundItemsAction_id @@ -16991,6 +17167,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: updateRequestItemReturnWorkflow + x-events: [] delete: operationId: DeleteExchangesIdInboundItemsAction_id summary: Remove Inbound Item from Exchange @@ -17063,6 +17240,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: removeItemReturnActionWorkflow + x-events: [] /admin/exchanges/{id}/inbound/shipping-method: post: operationId: PostExchangesIdInboundShippingMethod @@ -17137,6 +17315,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: createExchangeShippingMethodWorkflow + x-events: [] /admin/exchanges/{id}/inbound/shipping-method/{action_id}: post: operationId: PostExchangesIdInboundShippingMethodAction_id @@ -17230,6 +17409,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: updateReturnShippingMethodWorkflow + x-events: [] delete: operationId: DeleteExchangesIdInboundShippingMethodAction_id summary: Remove Inbound Shipping Method from Exchange @@ -17302,6 +17482,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: removeReturnShippingMethodWorkflow + x-events: [] /admin/exchanges/{id}/outbound/items: post: operationId: PostExchangesIdOutboundItems @@ -17384,6 +17565,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: orderExchangeAddNewItemWorkflow + x-events: [] /admin/exchanges/{id}/outbound/items/{action_id}: post: operationId: PostExchangesIdOutboundItemsAction_id @@ -17477,6 +17659,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: updateExchangeAddItemWorkflow + x-events: [] delete: operationId: DeleteExchangesIdOutboundItemsAction_id summary: Remove Outbound Item from Exchange @@ -17559,6 +17742,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: removeItemExchangeActionWorkflow + x-events: [] /admin/exchanges/{id}/outbound/shipping-method: post: operationId: PostExchangesIdOutboundShippingMethod @@ -17643,6 +17827,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: createExchangeShippingMethodWorkflow + x-events: [] /admin/exchanges/{id}/outbound/shipping-method/{action_id}: post: operationId: PostExchangesIdOutboundShippingMethodAction_id @@ -17736,6 +17921,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: updateExchangeShippingMethodWorkflow + x-events: [] delete: operationId: DeleteExchangesIdOutboundShippingMethodAction_id summary: Remove Outbound Shipping Method from Exchange @@ -17818,6 +18004,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: removeExchangeShippingMethodWorkflow + x-events: [] /admin/exchanges/{id}/request: post: operationId: PostExchangesIdRequest @@ -17890,6 +18077,17 @@ paths: '500': $ref: '#/components/responses/500_error' 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 @@ -17951,6 +18149,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: cancelBeginOrderExchangeWorkflow + x-events: [] /admin/fulfillment-providers: get: operationId: GetFulfillmentProviders @@ -18211,6 +18410,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: deleteFulfillmentSetsWorkflow + x-events: [] /admin/fulfillment-sets/{id}/service-zones: post: operationId: PostFulfillmentSetsIdServiceZones @@ -18299,7 +18499,11 @@ paths: 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: @@ -18324,7 +18528,11 @@ paths: 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 @@ -18354,7 +18562,11 @@ paths: 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 @@ -18417,6 +18629,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: createServiceZonesWorkflow + x-events: [] /admin/fulfillment-sets/{id}/service-zones/{zone_id}: get: operationId: GetFulfillmentSetsIdServiceZonesZone_id @@ -18593,7 +18806,11 @@ paths: 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 @@ -18626,7 +18843,11 @@ paths: 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 @@ -18660,7 +18881,11 @@ paths: 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. @@ -18723,6 +18948,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: updateServiceZonesWorkflow + x-events: [] delete: operationId: DeleteFulfillmentSetsIdServiceZonesZone_id summary: Remove a Service Zone from Fulfillment Set @@ -18792,6 +19018,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: deleteServiceZonesWorkflow + x-events: [] /admin/fulfillments: post: operationId: PostFulfillments @@ -18871,7 +19098,7 @@ paths: "address_2": "{value}", "city": "{value}", "country_code": "{value}", - "province": "{value}", + "province": "us-ca", "postal_code": "{value}", "metadata": {} }, @@ -18924,6 +19151,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: createFulfillmentWorkflow + x-events: [] /admin/fulfillments/{id}/cancel: post: operationId: PostFulfillmentsIdCancel @@ -18999,6 +19227,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: cancelFulfillmentWorkflow + x-events: [] /admin/fulfillments/{id}/shipment: post: operationId: PostFulfillmentsIdShipment @@ -19095,6 +19324,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: createShipmentWorkflow + x-events: [] /admin/inventory-items: get: operationId: GetInventoryItems @@ -19640,6 +19870,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: createInventoryItemsWorkflow + x-events: [] /admin/inventory-items/location-levels/batch: post: operationId: PostInventoryItemsLocationLevelsBatch @@ -19729,6 +19960,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: batchInventoryItemLevelsWorkflow + x-events: [] /admin/inventory-items/{id}: get: operationId: GetInventoryItemsId @@ -19951,6 +20183,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: updateInventoryItemsWorkflow + x-events: [] delete: operationId: DeleteInventoryItemsId summary: Delete Inventory Item @@ -20031,6 +20264,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: deleteInventoryItemWorkflow + x-events: [] /admin/inventory-items/{id}/location-levels: get: operationId: GetInventoryItemsIdLocationLevels @@ -20257,6 +20491,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: createInventoryLevelsWorkflow + x-events: [] /admin/inventory-items/{id}/location-levels/batch: post: operationId: PostInventoryItemsIdLocationLevelsBatch @@ -20327,6 +20562,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: batchInventoryItemLevelsWorkflow + x-events: [] /admin/inventory-items/{id}/location-levels/{location_id}: post: operationId: PostInventoryItemsIdLocationLevelsLocation_id @@ -20427,6 +20663,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: updateInventoryLevelsWorkflow + x-events: [] delete: operationId: DeleteInventoryItemsIdLocationLevelsLocation_id summary: Remove Inventory Level of Inventory Item @@ -20534,6 +20771,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: deleteInventoryLevelsWorkflow + x-events: [] /admin/invites: get: operationId: GetInvites @@ -21154,6 +21392,18 @@ paths: - 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 /admin/invites/accept: post: operationId: PostInvitesAccept @@ -21261,6 +21511,25 @@ paths: 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 /admin/invites/{id}: get: operationId: GetInvitesId @@ -21408,6 +21677,16 @@ paths: - 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 /admin/invites/{id}/resend: post: operationId: PostInvitesIdResend @@ -21478,6 +21757,19 @@ paths: - 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 /admin/notifications: get: operationId: GetNotifications @@ -21765,6 +22057,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: beginOrderEditOrderWorkflow + x-events: [] /admin/order-edits/{id}: delete: operationId: DeleteOrderEditsId @@ -21846,6 +22139,17 @@ paths: '500': $ref: '#/components/responses/500_error' 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 /admin/order-edits/{id}/confirm: post: operationId: PostOrderEditsIdConfirm @@ -21908,6 +22212,16 @@ paths: '500': $ref: '#/components/responses/500_error' 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 /admin/order-edits/{id}/items: post: operationId: PostOrderEditsIdItems @@ -21983,6 +22297,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: orderEditAddNewItemWorkflow + x-events: [] /admin/order-edits/{id}/items/item/{item_id}: post: operationId: PostOrderEditsIdItemsItemItem_id @@ -22067,6 +22382,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: orderEditUpdateItemQuantityWorkflow + x-events: [] /admin/order-edits/{id}/items/{action_id}: post: operationId: PostOrderEditsIdItemsAction_id @@ -22150,6 +22466,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: updateOrderEditAddItemWorkflow + x-events: [] delete: operationId: DeleteOrderEditsIdItemsAction_id summary: Remove Item from Order Edit @@ -22224,6 +22541,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: removeItemOrderEditActionWorkflow + x-events: [] /admin/order-edits/{id}/request: post: operationId: PostOrderEditsIdRequest @@ -22286,6 +22604,17 @@ paths: '500': $ref: '#/components/responses/500_error' 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 /admin/order-edits/{id}/shipping-method: post: operationId: PostOrderEditsIdShippingMethod @@ -22341,6 +22670,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: createOrderEditShippingMethodWorkflow + x-events: [] /admin/order-edits/{id}/shipping-method/{action_id}: post: operationId: PostOrderEditsIdShippingMethodAction_id @@ -22401,6 +22731,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: updateOrderEditShippingMethodWorkflow + x-events: [] delete: operationId: DeleteOrderEditsIdShippingMethodAction_id summary: Remove Shipping Method from Order Edit @@ -22455,6 +22786,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: removeOrderEditShippingMethodWorkflow + x-events: [] /admin/orders: get: operationId: GetOrders @@ -23136,6 +23468,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: getOrdersListWorkflow + x-events: [] /admin/orders/{id}: get: operationId: GetOrdersId @@ -23256,6 +23589,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: getOrderDetailWorkflow + x-events: [] post: operationId: PostOrdersId summary: Update Order @@ -23345,6 +23679,18 @@ paths: '500': $ref: '#/components/responses/500_error' 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 /admin/orders/{id}/archive: post: operationId: PostOrdersIdArchive @@ -23404,6 +23750,16 @@ paths: '500': $ref: '#/components/responses/500_error' 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 /admin/orders/{id}/cancel: post: operationId: PostOrdersIdCancel @@ -23484,6 +23840,16 @@ paths: '500': $ref: '#/components/responses/500_error' 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 /admin/orders/{id}/changes: get: operationId: GetOrdersIdChanges @@ -23632,6 +23998,16 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: completeOrderWorkflow + x-events: + - name: order.completed + payload: |- + ```ts + [{ + id, // The ID of the order + }] + ``` + description: Emitted when orders are completed. + deprecated: false /admin/orders/{id}/credit-lines: post: operationId: PostOrdersIdCreditLines @@ -23726,6 +24102,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: createOrderCreditLinesWorkflow + x-events: [] /admin/orders/{id}/fulfillments: post: operationId: PostOrdersIdFulfillments @@ -23865,6 +24242,18 @@ paths: '500': $ref: '#/components/responses/500_error' 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 /admin/orders/{id}/fulfillments/{fulfillment_id}/cancel: post: operationId: PostOrdersIdFulfillmentsFulfillment_idCancel @@ -23968,6 +24357,18 @@ paths: '500': $ref: '#/components/responses/500_error' 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 /admin/orders/{id}/fulfillments/{fulfillment_id}/mark-as-delivered: post: operationId: PostOrdersIdFulfillmentsFulfillment_idMarkAsDelivered @@ -24051,6 +24452,16 @@ paths: '500': $ref: '#/components/responses/500_error' 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 /admin/orders/{id}/fulfillments/{fulfillment_id}/shipments: post: operationId: PostOrdersIdFulfillmentsFulfillment_idShipments @@ -24217,6 +24628,17 @@ paths: '500': $ref: '#/components/responses/500_error' 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 /admin/orders/{id}/line-items: get: operationId: GetOrdersIdLineItems @@ -24535,6 +24957,19 @@ paths: '500': $ref: '#/components/responses/500_error' 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 /admin/orders/{id}/transfer/cancel: post: operationId: PostOrdersIdTransferCancel @@ -24611,6 +25046,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: cancelOrderTransferRequestWorkflow + x-events: [] /admin/payment-collections: post: operationId: PostPaymentCollections @@ -24701,6 +25137,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: createOrderPaymentCollectionWorkflow + x-events: [] /admin/payment-collections/{id}: delete: operationId: DeletePaymentCollectionsId @@ -24763,6 +25200,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: deleteOrderPaymentCollections + x-events: [] /admin/payment-collections/{id}/mark-as-paid: post: operationId: PostPaymentCollectionsIdMarkAsPaid @@ -24855,6 +25293,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: markPaymentCollectionAsPaid + x-events: [] /admin/payments: get: operationId: GetPayments @@ -25704,6 +26143,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: capturePaymentWorkflow + x-events: [] /admin/payments/{id}/refund: post: operationId: PostPaymentsIdRefund @@ -25795,6 +26235,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: refundPaymentWorkflow + x-events: [] /admin/plugins: get: operationId: GetPlugins @@ -26337,6 +26778,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: createPriceListsWorkflow + x-events: [] /admin/price-lists/{id}: get: operationId: GetPriceListsId @@ -26492,6 +26934,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: updatePriceListsWorkflow + x-events: [] delete: operationId: DeletePriceListsId summary: Delete a Price List @@ -26553,6 +26996,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: deletePriceListsWorkflow + x-events: [] /admin/price-lists/{id}/prices/batch: post: operationId: PostPriceListsIdPricesBatch @@ -26720,6 +27164,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: batchPriceListPricesWorkflow + x-events: [] /admin/price-lists/{id}/products: post: operationId: PostPriceListsIdProducts @@ -26799,6 +27244,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: batchPriceListPricesWorkflow + x-events: [] /admin/price-preferences: get: operationId: GetPricePreferences @@ -27036,6 +27482,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: createPricePreferencesWorkflow + x-events: [] /admin/price-preferences/{id}: get: operationId: GetPricePreferencesId @@ -27185,6 +27632,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: updatePricePreferencesWorkflow + x-events: [] delete: operationId: DeletePricePreferencesId summary: Delete a Price Preference @@ -27246,6 +27694,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: deletePricePreferencesWorkflow + x-events: [] /admin/product-categories: get: operationId: GetProductCategories @@ -27902,6 +28351,16 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: createProductCategoriesWorkflow + x-events: + - name: product-category.created + payload: |- + ```ts + [{ + id, // The ID of the product category + }] + ``` + description: Emitted when product categories are created. + deprecated: false /admin/product-categories/{id}: get: operationId: GetProductCategoriesId @@ -28105,6 +28564,16 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: updateProductCategoriesWorkflow + x-events: + - name: product-category.updated + payload: |- + ```ts + [{ + id, // The ID of the product category + }] + ``` + description: Emitted when product categories are updated. + deprecated: false delete: operationId: DeleteProductCategoriesId summary: Delete a Product Category @@ -28166,6 +28635,16 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: deleteProductCategoriesWorkflow + x-events: + - name: product-category.deleted + payload: |- + ```ts + [{ + id, // The ID of the product category + }] + ``` + description: Emitted when product categories are deleted. + deprecated: false /admin/product-categories/{id}/products: post: operationId: PostProductCategoriesIdProducts @@ -28263,6 +28742,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: batchLinkProductsToCategoryWorkflow + x-events: [] /admin/product-tags: get: operationId: GetProductTags @@ -28844,6 +29324,16 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: createProductTagsWorkflow + x-events: + - name: product-tag.created + payload: |- + ```ts + [{ + id, // The ID of the product tag + }] + ``` + description: Emitted when product tags are created. + deprecated: false /admin/product-tags/{id}: get: operationId: GetProductTagsId @@ -29006,6 +29496,16 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: updateProductTagsWorkflow + x-events: + - name: product-tag.updated + payload: |- + ```ts + [{ + id, // The ID of the product tag + }] + ``` + description: Emitted when product tags are updated. + deprecated: false delete: operationId: DeleteProductTagsId summary: Delete a Product Tag @@ -29067,6 +29567,16 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: deleteProductTagsWorkflow + x-events: + - name: product-tag.deleted + payload: |- + ```ts + [{ + id, // The ID of the product tag + }] + ``` + description: Emitted when product tags are deleted. + deprecated: false /admin/product-types: get: operationId: GetProductTypes @@ -29648,6 +30158,16 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: createProductTypesWorkflow + x-events: + - name: product-type.created + payload: |- + ```ts + [{ + id, // The ID of the product type + }] + ``` + description: Emitted when product types are created. + deprecated: false /admin/product-types/{id}: get: operationId: GetProductTypesId @@ -29810,6 +30330,16 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: updateProductTypesWorkflow + x-events: + - name: product-type.updated + payload: |- + ```ts + [{ + id, // The ID of the product type + }] + ``` + description: Emitted when product types are updated. + deprecated: false delete: operationId: DeleteProductTypesId summary: Delete a Product Type @@ -29871,6 +30401,16 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: deleteProductTypesWorkflow + x-events: + - name: product-type.deleted + payload: |- + ```ts + [{ + id, // The ID of the product type + }] + ``` + description: Emitted when product types are deleted. + deprecated: false /admin/product-variants: get: operationId: GetProductVariants @@ -31573,6 +32113,25 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: createProductsWorkflow + x-events: + - name: product-variant.created + payload: |- + ```ts + [{ + id, // The ID of the product variant + }] + ``` + description: Emitted when product variants are created. + deprecated: false + - name: product.created + payload: |- + ```ts + [{ + id, // The ID of the product + }] + ``` + description: Emitted when products are created. + deprecated: false /admin/products/batch: post: operationId: PostProductsBatch @@ -31673,6 +32232,43 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: batchProductsWorkflow + x-events: + - name: product-variant.created + payload: |- + ```ts + [{ + id, // The ID of the product variant + }] + ``` + description: Emitted when product variants are created. + deprecated: false + - name: product.updated + payload: |- + ```ts + [{ + id, // The ID of the product + }] + ``` + description: Emitted when products are updated. + deprecated: false + - name: product.created + payload: |- + ```ts + [{ + id, // The ID of the product + }] + ``` + description: Emitted when products are created. + deprecated: false + - name: product.deleted + payload: |- + ```ts + [{ + id, // The ID of the product + }] + ``` + description: Emitted when products are deleted. + deprecated: false /admin/products/export: post: operationId: PostProductsExport @@ -31743,6 +32339,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: exportProductsWorkflow + x-events: [] /admin/products/import: post: operationId: PostProductsImport @@ -31805,6 +32402,43 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: importProductsWorkflow + x-events: + - name: product-variant.created + payload: |- + ```ts + [{ + id, // The ID of the product variant + }] + ``` + description: Emitted when product variants are created. + deprecated: false + - name: product.updated + payload: |- + ```ts + [{ + id, // The ID of the product + }] + ``` + description: Emitted when products are updated. + deprecated: false + - name: product.created + payload: |- + ```ts + [{ + id, // The ID of the product + }] + ``` + description: Emitted when products are created. + deprecated: false + - name: product.deleted + payload: |- + ```ts + [{ + id, // The ID of the product + }] + ``` + description: Emitted when products are deleted. + deprecated: false /admin/products/import/{transaction_id}/confirm: post: operationId: PostProductsImportTransaction_idConfirm @@ -32019,6 +32653,16 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: updateProductsWorkflow + x-events: + - name: product.updated + payload: |- + ```ts + [{ + id, // The ID of the product + }] + ``` + description: Emitted when products are updated. + deprecated: false delete: operationId: DeleteProductsId summary: Delete a Product @@ -32080,6 +32724,16 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: deleteProductsWorkflow + x-events: + - name: product.deleted + payload: |- + ```ts + [{ + id, // The ID of the product + }] + ``` + description: Emitted when products are deleted. + deprecated: false /admin/products/{id}/options: get: operationId: GetProductsIdOptions @@ -32320,7 +32974,7 @@ paths: }) sdk.admin.product.createOption( - "prod_123", + "prod_123", { title: "Color", values: ["Green", "Blue"] @@ -32363,6 +33017,16 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: createProductOptionsWorkflow + x-events: + - name: product-option.created + payload: |- + ```ts + [{ + id, // The ID of the product option + }] + ``` + description: Emitted when product options are created. + deprecated: false /admin/products/{id}/options/{option_id}: get: operationId: GetProductsIdOptionsOption_id @@ -32505,7 +33169,7 @@ paths: }) sdk.admin.product.updateOption( - "prod_123", + "prod_123", "prodopt_123", { title: "Color" @@ -32541,6 +33205,16 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: updateProductOptionsWorkflow + x-events: + - name: product-option.updated + payload: |- + ```ts + [{ + id, // The ID of the product option + }] + ``` + description: Emitted when product options are updated. + deprecated: false delete: operationId: DeleteProductsIdOptionsOption_id summary: Delete an Option from Product @@ -32622,6 +33296,16 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: deleteProductOptionsWorkflow + x-events: + - name: product-option.deleted + payload: |- + ```ts + [{ + id, // The ID of the product option + }] + ``` + description: Emitted when product options are deleted. + deprecated: false /admin/products/{id}/variants: get: operationId: GetProductsIdVariants @@ -33267,6 +33951,16 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: createProductVariantsWorkflow + x-events: + - name: product-variant.created + payload: |- + ```ts + [{ + id, // The ID of the product variant + }] + ``` + description: Emitted when product variants are created. + deprecated: false /admin/products/{id}/variants/batch: post: operationId: PostProductsIdVariantsBatch @@ -33362,6 +34056,34 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: batchProductVariantsWorkflow + x-events: + - name: product-variant.updated + payload: |- + ```ts + [{ + id, // The ID of the product variant + }] + ``` + description: Emitted when product variants are updated. + deprecated: false + - name: product-variant.created + payload: |- + ```ts + [{ + id, // The ID of the product variant + }] + ``` + description: Emitted when product variants are created. + deprecated: false + - name: product-variant.deleted + payload: |- + ```ts + [{ + id, // The ID of the product variant + }] + ``` + description: Emitted when product variants are deleted. + deprecated: false /admin/products/{id}/variants/inventory-items/batch: post: operationId: PostProductsIdVariantsInventoryItemsBatch @@ -33466,7 +34188,7 @@ paths: }) sdk.admin.product.batchVariantInventoryItems( - "prod_123", + "prod_123", { create: [ { @@ -33520,6 +34242,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: batchLinksWorkflow + x-events: [] /admin/products/{id}/variants/{variant_id}: get: operationId: GetProductsIdVariantsVariant_id @@ -33662,7 +34385,7 @@ paths: }) sdk.admin.product.updateVariant( - "prod_123", + "prod_123", "variant_123", { title: "Blue Shirt", @@ -33698,6 +34421,16 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: updateProductVariantsWorkflow + x-events: + - name: product-variant.updated + payload: |- + ```ts + [{ + id, // The ID of the product variant + }] + ``` + description: Emitted when product variants are updated. + deprecated: false delete: operationId: DeleteProductsIdVariantsVariant_id summary: Delete Product Variant @@ -33776,6 +34509,16 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: deleteProductVariantsWorkflow + x-events: + - name: product-variant.deleted + payload: |- + ```ts + [{ + id, // The ID of the product variant + }] + ``` + description: Emitted when product variants are deleted. + deprecated: false /admin/products/{id}/variants/{variant_id}/inventory-items: post: operationId: PostProductsIdVariantsVariant_idInventoryItems @@ -33848,6 +34591,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: createLinksWorkflow + x-events: [] /admin/products/{id}/variants/{variant_id}/inventory-items/{inventory_item_id}: post: operationId: PostProductsIdVariantsVariant_idInventoryItemsInventory_item_id @@ -33925,6 +34669,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: updateLinksWorkflow + x-events: [] delete: operationId: DeleteProductsIdVariantsVariant_idInventoryItemsInventory_item_id summary: Remove Inventory Item Association with Product Variant @@ -33992,6 +34737,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: dismissLinksWorkflow + x-events: [] /admin/promotions: get: operationId: GetPromotions @@ -34949,6 +35695,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: createPromotionsWorkflow + x-events: [] /admin/promotions/rule-attribute-options/{rule_type}: get: operationId: GetPromotionsRuleAttributeOptionsRule_type @@ -35450,6 +36197,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: updatePromotionsWorkflow + x-events: [] delete: operationId: DeletePromotionsId summary: Delete a Promotion @@ -35530,6 +36278,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: deletePromotionsWorkflow + x-events: [] /admin/promotions/{id}/buy-rules/batch: post: operationId: PostPromotionsIdBuyRulesBatch @@ -35650,6 +36399,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: batchPromotionRulesWorkflow + x-events: [] /admin/promotions/{id}/rules/batch: post: operationId: PostPromotionsIdRulesBatch @@ -35770,6 +36520,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: batchPromotionRulesWorkflow + x-events: [] /admin/promotions/{id}/target-rules/batch: post: operationId: PostPromotionsIdTargetRulesBatch @@ -35890,6 +36641,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: batchPromotionRulesWorkflow + x-events: [] /admin/promotions/{id}/{rule_type}: get: operationId: GetPromotionsIdRule_type @@ -36207,6 +36959,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: createRefundReasonsWorkflow + x-events: [] /admin/refund-reasons/{id}: get: operationId: GetRefundReasonsId @@ -36334,6 +37087,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: updateRefundReasonsWorkflow + x-events: [] delete: operationId: DeleteRefundReasonsId summary: Delete a Refund Reason @@ -36397,6 +37151,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: deleteRefundReasonsWorkflow + x-events: [] /admin/regions: get: operationId: GetRegions @@ -37023,6 +37778,16 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: createRegionsWorkflow + x-events: + - name: region.created + payload: |- + ```ts + [{ + id, // The ID of the region + }] + ``` + description: Emitted when regions are created. + deprecated: false /admin/regions/{id}: get: operationId: GetRegionsId @@ -37211,6 +37976,16 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: updateRegionsWorkflow + x-events: + - name: region.updated + payload: |- + ```ts + [{ + id, // The ID of the region + }] + ``` + description: Emitted when regions are updated. + deprecated: false delete: operationId: DeleteRegionsId summary: Delete a Region @@ -37291,6 +38066,16 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: deleteRegionsWorkflow + x-events: + - name: region.deleted + payload: |- + ```ts + [{ + id, // The ID of the region + }] + ``` + description: Emitted when regions are deleted. + deprecated: false /admin/reservations: get: operationId: GetReservations @@ -37962,6 +38747,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: createReservationsWorkflow + x-events: [] /admin/reservations/{id}: get: operationId: GetReservationsId @@ -38133,6 +38919,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: updateReservationsWorkflow + x-events: [] delete: operationId: DeleteReservationsId summary: Delete a Reservation @@ -38213,6 +39000,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: deleteReservationsWorkflow + x-events: [] /admin/return-reasons: get: operationId: GetReturnReasons @@ -38839,6 +39627,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: createReturnReasonsWorkflow + x-events: [] /admin/return-reasons/{id}: get: operationId: GetReturnReasonsId @@ -38989,6 +39778,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: updateReturnReasonsWorkflow + x-events: [] delete: operationId: DeleteReturnReasonsId summary: Delete a Return Reason @@ -39050,6 +39840,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: deleteReturnReasonsWorkflow + x-events: [] /admin/returns: get: operationId: GetReturns @@ -39820,6 +40611,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: beginReturnOrderWorkflow + x-events: [] /admin/returns/{id}: get: operationId: GetReturnsId @@ -39973,6 +40765,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: updateReturnWorkflow + x-events: [] /admin/returns/{id}/cancel: post: operationId: PostReturnsIdCancel @@ -40040,6 +40833,7 @@ paths: schema: $ref: '#/components/schemas/AdminPostCancelReturnReqSchema' x-workflow: cancelReturnWorkflow + x-events: [] /admin/returns/{id}/dismiss-items: post: operationId: PostReturnsIdDismissItems @@ -40122,6 +40916,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: dismissItemReturnRequestWorkflow + x-events: [] /admin/returns/{id}/dismiss-items/{action_id}: post: operationId: PostReturnsIdDismissItemsAction_id @@ -40211,6 +41006,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: updateReceiveItemReturnRequestWorkflow + x-events: [] delete: operationId: DeleteReturnsIdDismissItemsAction_id summary: Remove Damaged Item from Return @@ -40292,6 +41088,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: removeItemReturnActionWorkflow + x-events: [] /admin/returns/{id}/receive: post: operationId: PostReturnsIdReceive @@ -40384,6 +41181,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: beginReceiveReturnWorkflow + x-events: [] delete: operationId: DeleteReturnsIdReceive summary: Cancel Return Receival @@ -40464,6 +41262,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: cancelReturnReceiveWorkflow + x-events: [] /admin/returns/{id}/receive-items: post: operationId: PostReturnsIdReceiveItems @@ -40546,6 +41345,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: receiveItemReturnRequestWorkflow + x-events: [] /admin/returns/{id}/receive-items/{action_id}: post: operationId: PostReturnsIdReceiveItemsAction_id @@ -40635,6 +41435,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: updateReceiveItemReturnRequestWorkflow + x-events: [] delete: operationId: DeleteReturnsIdReceiveItemsAction_id summary: Remove a Received Item from Return @@ -40716,6 +41517,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: removeItemReceiveReturnActionWorkflow + x-events: [] /admin/returns/{id}/receive/confirm: post: operationId: PostReturnsIdReceiveConfirm @@ -40796,6 +41598,17 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: confirmReturnReceiveWorkflow + x-events: + - name: order.return_received + payload: |- + ```ts + { + order_id, // The ID of the order + return_id, // The ID of the return + } + ``` + description: Emitted when a return is marked as received. + deprecated: false /admin/returns/{id}/request: post: operationId: PostReturnsIdRequest @@ -40876,6 +41689,17 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: confirmReturnRequestWorkflow + x-events: + - name: order.return_requested + payload: |- + ```ts + { + order_id, // The ID of the order + return_id, // The ID of the return + } + ``` + description: Emitted when a return request is confirmed. + deprecated: false delete: operationId: DeleteReturnsIdRequest summary: Cancel Return Request @@ -40956,6 +41780,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: cancelReturnRequestWorkflow + x-events: [] /admin/returns/{id}/request-items: post: operationId: PostReturnsIdRequestItems @@ -41037,6 +41862,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: requestItemReturnWorkflow + x-events: [] /admin/returns/{id}/request-items/{action_id}: post: operationId: PostReturnsIdRequestItemsAction_id @@ -41126,6 +41952,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: updateRequestItemReturnWorkflow + x-events: [] delete: operationId: DeleteReturnsIdRequestItemsAction_id summary: Remove Item from Return @@ -41207,6 +42034,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: removeItemReturnActionWorkflow + x-events: [] /admin/returns/{id}/shipping-method: post: operationId: PostReturnsIdShippingMethod @@ -41291,6 +42119,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: createReturnShippingMethodWorkflow + x-events: [] /admin/returns/{id}/shipping-method/{action_id}: post: operationId: PostReturnsIdShippingMethodAction_id @@ -41380,6 +42209,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: updateReturnShippingMethodWorkflow + x-events: [] delete: operationId: DeleteReturnsIdShippingMethodAction_id summary: Remove Shipping Method from Return @@ -41461,6 +42291,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: removeReturnShippingMethodWorkflow + x-events: [] /admin/sales-channels: get: operationId: GetSalesChannels @@ -42116,6 +42947,16 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: createSalesChannelsWorkflow + x-events: + - name: sales-channel.created + payload: |- + ```ts + [{ + id, // The ID of the sales channel + }] + ``` + description: Emitted when sales channels are created. + deprecated: false /admin/sales-channels/{id}: get: operationId: GetSalesChannelsId @@ -42273,6 +43114,16 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: updateSalesChannelsWorkflow + x-events: + - name: sales-channel.updated + payload: |- + ```ts + [{ + id, // The ID of the sales channel + }] + ``` + description: Emitted when sales channels are updated. + deprecated: false delete: operationId: DeleteSalesChannelsId summary: Delete a Sales Channel @@ -42334,6 +43185,16 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: deleteSalesChannelsWorkflow + x-events: + - name: sales-channel.deleted + payload: |- + ```ts + [{ + id, // The ID of the sales channel + }] + ``` + description: Emitted when sales channels are deleted. + deprecated: false /admin/sales-channels/{id}/products: post: operationId: PostSalesChannelsIdProducts @@ -42431,6 +43292,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: linkProductsToSalesChannelWorkflow + x-events: [] /admin/shipping-options: get: operationId: GetShippingOptions @@ -43105,6 +43967,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: createShippingOptionsWorkflow + x-events: [] /admin/shipping-options/{id}: get: operationId: GetShippingOptionsId @@ -43422,6 +44285,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: updateShippingOptionsWorkflow + x-events: [] delete: operationId: DeleteShippingOptionsId summary: Delete a Shipping Option @@ -43483,6 +44347,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: deleteShippingOptionsWorkflow + x-events: [] /admin/shipping-options/{id}/rules/batch: post: operationId: PostShippingOptionsIdRulesBatch @@ -43622,6 +44487,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: batchShippingOptionRulesWorkflow + x-events: [] /admin/shipping-profiles: get: operationId: GetShippingProfiles @@ -44235,6 +45101,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: createShippingProfilesWorkflow + x-events: [] /admin/shipping-profiles/{id}: get: operationId: GetShippingProfilesId @@ -44401,6 +45268,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: updateShippingProfilesWorkflow + x-events: [] delete: operationId: DeleteShippingProfilesId summary: Delete a Shipping Profile @@ -44462,6 +45330,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: deleteShippingProfileWorkflow + x-events: [] /admin/stock-locations: get: operationId: GetStockLocations @@ -45073,6 +45942,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: createStockLocationsWorkflow + x-events: [] /admin/stock-locations/{id}: get: operationId: GetStockLocationsId @@ -45227,6 +46097,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: updateStockLocationsWorkflow + x-events: [] delete: operationId: DeleteStockLocationsId summary: Delete a Stock Location @@ -45288,6 +46159,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: deleteStockLocationsWorkflow + x-events: [] /admin/stock-locations/{id}/fulfillment-providers: post: operationId: PostStockLocationsIdFulfillmentProviders @@ -45385,6 +46257,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: batchLinksWorkflow + x-events: [] /admin/stock-locations/{id}/fulfillment-sets: post: operationId: PostStockLocationsIdFulfillmentSets @@ -45484,6 +46357,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: createLocationFulfillmentSetWorkflow + x-events: [] /admin/stock-locations/{id}/sales-channels: post: operationId: PostStockLocationsIdSalesChannels @@ -45581,6 +46455,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: linkSalesChannelsToStockLocationWorkflow + x-events: [] /admin/stores: get: operationId: GetStores @@ -45885,6 +46760,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: updateStoresWorkflow + x-events: [] /admin/tax-rates: get: operationId: GetTaxRates @@ -46571,6 +47447,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: createTaxRatesWorkflow + x-events: [] /admin/tax-rates/{id}: get: operationId: GetTaxRatesId @@ -46725,6 +47602,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: updateTaxRatesWorkflow + x-events: [] delete: operationId: DeleteTaxRatesId summary: Delete a Tax Rate @@ -46786,6 +47664,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: deleteTaxRatesWorkflow + x-events: [] /admin/tax-rates/{id}/rules: post: operationId: PostTaxRatesIdRules @@ -46852,6 +47731,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: createTaxRateRulesWorkflow + x-events: [] /admin/tax-rates/{id}/rules/{rule_id}: delete: operationId: DeleteTaxRatesIdRulesRule_id @@ -46939,6 +47819,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: deleteTaxRateRulesWorkflow + x-events: [] /admin/tax-regions: get: operationId: GetTaxRegions @@ -47072,13 +47953,21 @@ paths: oneOf: - type: string title: province_code - description: Filter by a province code. + description: Filter by 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 - type: array - description: Filter by province codes. + description: Filter by ISO 3166-2 province codes. items: type: string title: province_code - description: A province code. + description: A ISO 3166-2 province code. + example: us-ca + externalDocs: + url: https://en.wikipedia.org/wiki/ISO_3166-2 + description: Learn more about ISO 3166-2 - type: object description: Apply filters on the province code. properties: @@ -48057,7 +48946,7 @@ paths: -H 'Content-Type: application/json' \ --data-raw '{ "country_code": "{value}", - "province_code": "{value}", + "province_code": "us-ca", "parent_id": "{value}", "metadata": {} }' @@ -48083,6 +48972,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: createTaxRegionsWorkflow + x-events: [] /admin/tax-regions/{id}: get: operationId: GetTaxRegionsId @@ -48189,6 +49079,25 @@ paths: schema: $ref: '#/components/schemas/AdminUpdateTaxRegion' x-codeSamples: + - lang: JavaScript + label: JS SDK + source: |- + import Medusa from "@medusajs/js-sdk" + + export const sdk = new Medusa({ + baseUrl: import.meta.env.VITE_BACKEND_URL || "/", + debug: import.meta.env.DEV, + auth: { + type: "session", + }, + }) + + sdk.admin.taxRegion.update("txreg_123", { + province_code: "ca", + }) + .then(({ tax_region }) => { + console.log(tax_region) + }) - lang: Shell label: cURL source: |- @@ -48216,6 +49125,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: updateTaxRegionsWorkflow + x-events: [] delete: operationId: DeleteTaxRegionsId summary: Delete a Tax Region @@ -48277,6 +49187,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: deleteTaxRegionsWorkflow + x-events: [] /admin/uploads: post: operationId: PostUploads @@ -48389,6 +49300,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: uploadFilesWorkflow + x-events: [] /admin/uploads/{id}: get: operationId: GetUploadsId @@ -48540,6 +49452,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: deleteFilesWorkflow + x-events: [] /admin/users: get: operationId: GetUsers @@ -49247,6 +50160,16 @@ paths: security: - cookie_auth: [] - jwt_token: [] + x-events: + - name: user.updated + payload: |- + ```ts + [{ + id, // The ID of the user + }] + ``` + description: Emitted when users are updated. + deprecated: false delete: operationId: DeleteUsersId summary: Delete a User @@ -49305,6 +50228,16 @@ paths: security: - cookie_auth: [] - jwt_token: [] + x-events: + - name: user.deleted + payload: |- + ```ts + [{ + id, // The ID of the user + }] + ``` + description: Emitted when users are deleted. + deprecated: false /admin/workflows-executions: get: operationId: GetWorkflowsExecutions @@ -50418,6 +51351,20 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: generateResetPasswordTokenWorkflow + x-events: + - name: auth.password_reset + payload: |- + ```ts + { + entity_id, // The identifier of the user or customer. For example, an email address. + actor_type, // The type of actor. For example, "customer", "user", or custom. + token, // The generated token. + } + ``` + description: |- + Emitted when a reset password token is generated. You can listen to this event + to send a reset password email to the user or customer, for example. + deprecated: false /auth/user/{auth_provider}/update: post: operationId: PostActor_typeAuth_providerUpdate @@ -51824,7 +52771,11 @@ components: province: type: string title: province - description: The delivery address's province. + description: The delivery 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 @@ -52968,7 +53919,11 @@ components: province_code: type: string title: province_code - description: The tax region's province code. + description: The tax region'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 parent_id: type: string title: parent_id @@ -53311,7 +54266,11 @@ components: province: type: string title: province - description: The address's province. + description: The address's lower-case ISO 3166-2 province code. + 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 @@ -55282,7 +56241,11 @@ components: province: type: string title: province - description: The address's province. + description: The address's lower-case ISO 3166-2 province code. + 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 @@ -55630,7 +56593,11 @@ components: province_code: type: string title: province_code - description: The geo zone's province code. + description: The geo zone's lower-case ISO 3166-2 province code. + 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 @@ -56318,7 +57285,11 @@ components: province: type: string title: province - description: The address's province. + description: The address's lower-case ISO 3166-2 province code. + 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 @@ -61551,7 +62522,11 @@ components: province: type: string title: province - description: The address's province. + description: The address's lower-case ISO 3166-2 province code. + example: us-ca + externalDocs: + url: https://en.wikipedia.org/wiki/ISO_3166-2 + description: Learn more about ISO 3166-2 required: - id - address_1 @@ -61916,7 +62891,11 @@ components: province_code: type: string title: province_code - description: The tax region's province code. + description: The tax region's lower-case ISO 3166-2 province code. + example: us-ca + externalDocs: + url: https://en.wikipedia.org/wiki/ISO_3166-2 + description: Learn more about ISO 3166-2 metadata: type: object description: The tax region's metadata, can hold custom key-value pairs. @@ -62094,7 +63073,11 @@ components: 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 @@ -62142,7 +63125,11 @@ components: 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 @@ -62277,7 +63264,11 @@ components: 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 @@ -62325,7 +63316,11 @@ components: 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 @@ -62822,7 +63817,11 @@ components: 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 address_id: type: string title: address_id @@ -62934,7 +63933,11 @@ components: province_code: type: string title: province_code - description: The tax region's province code. + description: The tax region'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 metadata: type: object description: The tax region's metadata, can hold custom key-value pairs. @@ -63009,7 +64012,11 @@ components: 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 AdminUser: type: object description: The user's details. @@ -64608,7 +65615,11 @@ components: province: type: string title: province - description: The address's province. + description: The address's lower-case ISO 3166-2 province code. + 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 @@ -66681,7 +67692,11 @@ components: 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 @@ -67499,7 +68514,11 @@ components: province: type: string title: province - description: The address's province. + description: The address's lower-case ISO 3166-2 province code. + 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 @@ -69346,7 +70365,11 @@ components: province: type: string title: province - description: The address's province. + description: The address's lower-case ISO 3166-2 province code. + 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 @@ -70561,7 +71584,11 @@ components: province: type: string title: province - description: The address's province. + description: The address's lower-case ISO 3166-2 province code. + 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 @@ -70949,7 +71976,11 @@ components: province: type: string title: province - description: The address's province. + description: The address's lower-case ISO 3166-2 province code. + 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 @@ -78172,7 +79203,11 @@ components: 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 diff --git a/www/apps/api-reference/specs/admin/paths/admin_api-keys.yaml b/www/apps/api-reference/specs/admin/paths/admin_api-keys.yaml index 858dcc21f2..74aa3e57cc 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_api-keys.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_api-keys.yaml @@ -1337,3 +1337,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: createApiKeysWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}.yaml index 2c294f1620..ad4ede2228 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}.yaml @@ -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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}_revoke.yaml b/www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}_revoke.yaml index 148a774f99..4fbf9e3b59 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}_revoke.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}_revoke.yaml @@ -71,3 +71,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: revokeApiKeysWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}_sales-channels.yaml b/www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}_sales-channels.yaml index 6080353618..89c59dddb9 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}_sales-channels.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}_sales-channels.yaml @@ -87,3 +87,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: linkSalesChannelsToApiKeyWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_campaigns.yaml b/www/apps/api-reference/specs/admin/paths/admin_campaigns.yaml index 00236b47c8..036acd0d9b 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_campaigns.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_campaigns.yaml @@ -271,3 +271,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: createCampaignsWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_campaigns_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_campaigns_{id}.yaml index 0162ce0f95..76c9d86cc6 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_campaigns_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_campaigns_{id}.yaml @@ -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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_campaigns_{id}_promotions.yaml b/www/apps/api-reference/specs/admin/paths/admin_campaigns_{id}_promotions.yaml index 3106892ec8..c20d22ab3c 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_campaigns_{id}_promotions.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_campaigns_{id}_promotions.yaml @@ -87,3 +87,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: addOrRemoveCampaignPromotionsWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims.yaml index cf06f4fae2..af81fc7ca6 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_claims.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_claims.yaml @@ -1084,3 +1084,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: beginClaimOrderWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_cancel.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_cancel.yaml index 756d001d2f..f5d1f71b6e 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_cancel.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_cancel.yaml @@ -50,3 +50,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: cancelOrderClaimWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_claim-items.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_claim-items.yaml index bd09408dda..e976f2ea69 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_claim-items.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_claim-items.yaml @@ -71,3 +71,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: orderClaimItemWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_claim-items_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_claim-items_{action_id}.yaml index e1a8c149e0..6cf2d09271 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_claim-items_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_claim-items_{action_id}.yaml @@ -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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_items.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_items.yaml index 40db0c72ab..66f25d8354 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_items.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_items.yaml @@ -53,3 +53,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: orderClaimRequestItemReturnWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_items_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_items_{action_id}.yaml index 9026fcbb53..24c02f5eaa 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_items_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_items_{action_id}.yaml @@ -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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_shipping-method.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_shipping-method.yaml index 6327a13ffb..f412d5def0 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_shipping-method.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_shipping-method.yaml @@ -55,3 +55,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: createClaimShippingMethodWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_shipping-method_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_shipping-method_{action_id}.yaml index b4d7e3f82a..b5e01b8964 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_shipping-method_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_shipping-method_{action_id}.yaml @@ -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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_items.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_items.yaml index e384123a4b..d9d147390c 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_items.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_items.yaml @@ -71,3 +71,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: orderClaimAddNewItemWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_items_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_items_{action_id}.yaml index 5b63f8eb3c..e1c2f08ce7 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_items_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_items_{action_id}.yaml @@ -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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_shipping-method.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_shipping-method.yaml index 4fcc75f067..5327b9d333 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_shipping-method.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_shipping-method.yaml @@ -73,3 +73,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: createClaimShippingMethodWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_shipping-method_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_shipping-method_{action_id}.yaml index c893599a43..1a66873944 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_shipping-method_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_shipping-method_{action_id}.yaml @@ -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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_request.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_request.yaml index 19258779d0..23f305f634 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_request.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_request.yaml @@ -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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_collections.yaml b/www/apps/api-reference/specs/admin/paths/admin_collections.yaml index 8896bc5e10..af434edbbc 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_collections.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_collections.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/paths/admin_collections_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_collections_{id}.yaml index 7668f30966..27d604bbf3 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_collections_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_collections_{id}.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/paths/admin_collections_{id}_products.yaml b/www/apps/api-reference/specs/admin/paths/admin_collections_{id}_products.yaml index 9233e2e7b2..e0cca246cc 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_collections_{id}_products.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_collections_{id}_products.yaml @@ -87,3 +87,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: batchLinkProductsToCollectionWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_customer-groups.yaml b/www/apps/api-reference/specs/admin/paths/admin_customer-groups.yaml index 3068c72ad2..0412dd9c26 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customer-groups.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customer-groups.yaml @@ -1090,3 +1090,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: createCustomerGroupsWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}.yaml index 0a1d8c510e..ba8db4ee51 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}.yaml @@ -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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}_customers.yaml b/www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}_customers.yaml index 60842a8289..1d301dab93 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}_customers.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}_customers.yaml @@ -86,3 +86,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: linkCustomersToCustomerGroupWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_customers.yaml b/www/apps/api-reference/specs/admin/paths/admin_customers.yaml index c74399346d..eae1b1111e 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customers.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customers.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/paths/admin_customers_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_customers_{id}.yaml index 3c9cf1350b..7b592acff9 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customers_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customers_{id}.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses.yaml b/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses.yaml index 9531b773b2..88eb6bf087 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses.yaml @@ -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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses_{address_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses_{address_id}.yaml index 173b3c271a..c9efc837ce 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses_{address_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses_{address_id}.yaml @@ -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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_customer-groups.yaml b/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_customer-groups.yaml index b6d2bd1f6a..a0f0f81423 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_customer-groups.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_customer-groups.yaml @@ -100,3 +100,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: linkCustomerGroupsToCustomerWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_draft-orders.yaml b/www/apps/api-reference/specs/admin/paths/admin_draft-orders.yaml index 4d42589c0d..f02c22b93e 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_draft-orders.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_draft-orders.yaml @@ -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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}.yaml index 63a3365a82..3737bf1a7b 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_convert-to-order.yaml b/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_convert-to-order.yaml index 57dc429120..5375db6df1 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_convert-to-order.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_convert-to-order.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_edit.yaml b/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_edit.yaml index ebdcaa1255..df26bf9d0b 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_edit.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_edit.yaml @@ -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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_edit_confirm.yaml b/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_edit_confirm.yaml index a7be2308e2..857ca2c758 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_edit_confirm.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_edit_confirm.yaml @@ -45,3 +45,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: confirmDraftOrderEditWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_edit_items.yaml b/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_edit_items.yaml index 53b1e6bafe..dcff492ae7 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_edit_items.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_edit_items.yaml @@ -47,3 +47,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: addDraftOrderItemsWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_edit_items_item_{item_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_edit_items_item_{item_id}.yaml index 6cd49a36ff..ead2009170 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_edit_items_item_{item_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_edit_items_item_{item_id}.yaml @@ -55,3 +55,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: updateDraftOrderItemWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_edit_items_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_edit_items_{action_id}.yaml index d8aef1b408..fc31c30622 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_edit_items_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_edit_items_{action_id}.yaml @@ -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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_edit_promotions.yaml b/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_edit_promotions.yaml index d81a805239..cccc4d2b76 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_edit_promotions.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_edit_promotions.yaml @@ -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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_edit_request.yaml b/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_edit_request.yaml index 72077df5b5..0df5734b38 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_edit_request.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_edit_request.yaml @@ -45,3 +45,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: requestDraftOrderEditWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_edit_shipping-methods.yaml b/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_edit_shipping-methods.yaml index 0cfaa57dc4..a395bc79f7 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_edit_shipping-methods.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_edit_shipping-methods.yaml @@ -49,3 +49,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: addDraftOrderShippingMethodsWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_edit_shipping-methods_method_{method_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_edit_shipping-methods_method_{method_id}.yaml index 4de6f57c5a..b81ca7abe9 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_edit_shipping-methods_method_{method_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_edit_shipping-methods_method_{method_id}.yaml @@ -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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_edit_shipping-methods_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_edit_shipping-methods_{action_id}.yaml index 3d52969071..ef2df5535e 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_edit_shipping-methods_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_edit_shipping-methods_{action_id}.yaml @@ -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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_exchanges.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges.yaml index cae9a9af0c..f3518c8121 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_exchanges.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges.yaml @@ -1037,3 +1037,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: beginExchangeOrderWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_cancel.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_cancel.yaml index 4748f94287..5e311f5246 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_cancel.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_cancel.yaml @@ -50,3 +50,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: cancelOrderExchangeWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_items.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_items.yaml index 488006534b..d5f26c541f 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_items.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_items.yaml @@ -54,3 +54,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: orderExchangeRequestItemReturnWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_items_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_items_{action_id}.yaml index f9bade489f..5a413a94b3 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_items_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_items_{action_id}.yaml @@ -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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_shipping-method.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_shipping-method.yaml index 0f64e24af8..1225231b6c 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_shipping-method.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_shipping-method.yaml @@ -55,3 +55,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: createExchangeShippingMethodWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_shipping-method_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_shipping-method_{action_id}.yaml index 710a25d538..38f5f896fd 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_shipping-method_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_shipping-method_{action_id}.yaml @@ -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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_items.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_items.yaml index 9f2db09a05..1975721281 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_items.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_items.yaml @@ -70,3 +70,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: orderExchangeAddNewItemWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_items_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_items_{action_id}.yaml index af8fca5751..f5d00dc892 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_items_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_items_{action_id}.yaml @@ -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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_shipping-method.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_shipping-method.yaml index 9a75c2004f..c59c8f8205 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_shipping-method.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_shipping-method.yaml @@ -73,3 +73,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: createExchangeShippingMethodWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_shipping-method_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_shipping-method_{action_id}.yaml index 7420700601..499e5e099c 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_shipping-method_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_shipping-method_{action_id}.yaml @@ -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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_request.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_request.yaml index f6ae002cdc..3d5ddbca9d 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_request.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_request.yaml @@ -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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}.yaml index 5a8bc41dbd..4a17aa15ef 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}.yaml @@ -45,3 +45,4 @@ delete: '500': $ref: ../components/responses/500_error.yaml x-workflow: deleteFulfillmentSetsWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}_service-zones.yaml b/www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}_service-zones.yaml index 15de3c5edd..3da6aa1e26 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}_service-zones.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}_service-zones.yaml @@ -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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}_service-zones_{zone_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}_service-zones_{zone_id}.yaml index d3327b598b..019ccd54fd 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}_service-zones_{zone_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}_service-zones_{zone_id}.yaml @@ -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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_fulfillments.yaml b/www/apps/api-reference/specs/admin/paths/admin_fulfillments.yaml index b4d1050229..43f29f6a08 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_fulfillments.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_fulfillments.yaml @@ -62,3 +62,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: createFulfillmentWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_fulfillments_{id}_cancel.yaml b/www/apps/api-reference/specs/admin/paths/admin_fulfillments_{id}_cancel.yaml index 25353014a6..d9efe44845 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_fulfillments_{id}_cancel.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_fulfillments_{id}_cancel.yaml @@ -68,3 +68,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: cancelFulfillmentWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_fulfillments_{id}_shipment.yaml b/www/apps/api-reference/specs/admin/paths/admin_fulfillments_{id}_shipment.yaml index afeeff2fe1..b32fb98761 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_fulfillments_{id}_shipment.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_fulfillments_{id}_shipment.yaml @@ -71,3 +71,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: createShipmentWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_inventory-items.yaml b/www/apps/api-reference/specs/admin/paths/admin_inventory-items.yaml index a959abec01..82f81d397e 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_inventory-items.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_inventory-items.yaml @@ -559,3 +559,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: createInventoryItemsWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_inventory-items_location-levels_batch.yaml b/www/apps/api-reference/specs/admin/paths/admin_inventory-items_location-levels_batch.yaml index 57deda3888..edb486324b 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_inventory-items_location-levels_batch.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_inventory-items_location-levels_batch.yaml @@ -46,3 +46,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: batchInventoryItemLevelsWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}.yaml index e43c8b9736..8d83535eeb 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}.yaml @@ -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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels.yaml b/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels.yaml index 49c099b73b..ef8e75fadf 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels.yaml @@ -237,3 +237,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: createInventoryLevelsWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels_batch.yaml b/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels_batch.yaml index f786691469..46728309bc 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels_batch.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels_batch.yaml @@ -49,3 +49,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: batchInventoryItemLevelsWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels_{location_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels_{location_id}.yaml index 79ec142b25..bd364f4e45 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels_{location_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels_{location_id}.yaml @@ -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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_invites.yaml b/www/apps/api-reference/specs/admin/paths/admin_invites.yaml index c994e0eac2..73abc3bb86 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_invites.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_invites.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/paths/admin_invites_accept.yaml b/www/apps/api-reference/specs/admin/paths/admin_invites_accept.yaml index 43d0cc68c9..135ff93939 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_invites_accept.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_invites_accept.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/paths/admin_invites_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_invites_{id}.yaml index 3d65f1b136..d22f313b16 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_invites_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_invites_{id}.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/paths/admin_invites_{id}_resend.yaml b/www/apps/api-reference/specs/admin/paths/admin_invites_{id}_resend.yaml index 7a235dd074..462c148c30 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_invites_{id}_resend.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_invites_{id}_resend.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/paths/admin_order-edits.yaml b/www/apps/api-reference/specs/admin/paths/admin_order-edits.yaml index af5b22041f..f1a1c1e4ce 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_order-edits.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_order-edits.yaml @@ -43,3 +43,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: beginOrderEditOrderWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}.yaml index e9953f152d..d6de804002 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_confirm.yaml b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_confirm.yaml index 100f2ed2ad..c0f2b10d1a 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_confirm.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_confirm.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items.yaml b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items.yaml index 861bacd635..5eb8b23b60 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items.yaml @@ -51,3 +51,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: orderEditAddNewItemWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items_item_{item_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items_item_{item_id}.yaml index 5575b81233..6babc1f0c9 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items_item_{item_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items_item_{item_id}.yaml @@ -60,3 +60,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: orderEditUpdateItemQuantityWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items_{action_id}.yaml index e4ad568609..dfc0bbf631 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items_{action_id}.yaml @@ -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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_request.yaml b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_request.yaml index 853d4bb4fc..cca9a2abd2 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_request.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_request.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_shipping-method.yaml b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_shipping-method.yaml index 2ddbd5453a..36c877a8a3 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_shipping-method.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_shipping-method.yaml @@ -49,3 +49,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: createOrderEditShippingMethodWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_shipping-method_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_shipping-method_{action_id}.yaml index ae82ca5f04..24c4fe1637 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_shipping-method_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_shipping-method_{action_id}.yaml @@ -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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders.yaml index 91414d675c..1981297f63 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders.yaml @@ -765,3 +765,4 @@ get: '500': $ref: ../components/responses/500_error.yaml x-workflow: getOrdersListWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}.yaml index 898bb04d61..3e9900d87c 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_archive.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_archive.yaml index 4f86e4fd21..0c08fae18a 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_archive.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_archive.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_cancel.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_cancel.yaml index f01e2f832f..d895dd7ab0 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_cancel.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_cancel.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_complete.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_complete.yaml index 6231ae54ae..6725b18ee8 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_complete.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_complete.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_credit-lines.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_credit-lines.yaml index 37ec73561f..b740a29d1e 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_credit-lines.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_credit-lines.yaml @@ -71,3 +71,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: createOrderCreditLinesWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments.yaml index 5bf5e6b42d..95161e279c 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel.yaml index 1fecf1a830..7c15d6de07 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_mark-as-delivered.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_mark-as-delivered.yaml index 9892af5d50..cfd03c015a 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_mark-as-delivered.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_mark-as-delivered.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_shipments.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_shipments.yaml index 7dd85a1fb5..82a142e520 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_shipments.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_shipments.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_transfer.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_transfer.yaml index 486dc23e14..bc27ad20e3 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_transfer.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_transfer.yaml @@ -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 diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_transfer_cancel.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_transfer_cancel.yaml index 29ca12da78..60d712f1fb 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_transfer_cancel.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_transfer_cancel.yaml @@ -66,3 +66,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: cancelOrderTransferRequestWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_payment-collections.yaml b/www/apps/api-reference/specs/admin/paths/admin_payment-collections.yaml index 78e36f9055..f74971b754 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_payment-collections.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_payment-collections.yaml @@ -75,3 +75,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: createOrderPaymentCollectionWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_payment-collections_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_payment-collections_{id}.yaml index 196e3c8db8..28908399a6 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_payment-collections_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_payment-collections_{id}.yaml @@ -45,3 +45,4 @@ delete: '500': $ref: ../components/responses/500_error.yaml x-workflow: deleteOrderPaymentCollections + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_payment-collections_{id}_mark-as-paid.yaml b/www/apps/api-reference/specs/admin/paths/admin_payment-collections_{id}_mark-as-paid.yaml index 3dfd8cee23..db62cad79a 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_payment-collections_{id}_mark-as-paid.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_payment-collections_{id}_mark-as-paid.yaml @@ -81,3 +81,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: markPaymentCollectionAsPaid + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_payments_{id}_capture.yaml b/www/apps/api-reference/specs/admin/paths/admin_payments_{id}_capture.yaml index c5fd4a2ceb..8fe561850f 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_payments_{id}_capture.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_payments_{id}_capture.yaml @@ -76,3 +76,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: capturePaymentWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_payments_{id}_refund.yaml b/www/apps/api-reference/specs/admin/paths/admin_payments_{id}_refund.yaml index fbb21b158e..47b77b9986 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_payments_{id}_refund.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_payments_{id}_refund.yaml @@ -84,3 +84,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: refundPaymentWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_price-lists.yaml b/www/apps/api-reference/specs/admin/paths/admin_price-lists.yaml index e18eab36f2..9dfe6a479e 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_price-lists.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_price-lists.yaml @@ -507,3 +507,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: createPriceListsWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}.yaml index c777861017..bb7ba9d915 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}.yaml @@ -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: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_prices_batch.yaml b/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_prices_batch.yaml index 063c58f8d4..55ce75ffdd 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_prices_batch.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_prices_batch.yaml @@ -145,3 +145,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: batchPriceListPricesWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_products.yaml b/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_products.yaml index b59a856ab9..ce31ccc3de 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_products.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_products.yaml @@ -68,3 +68,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: batchPriceListPricesWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_price-preferences.yaml b/www/apps/api-reference/specs/admin/paths/admin_price-preferences.yaml index 46039b7844..346c718cec 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_price-preferences.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_price-preferences.yaml @@ -234,3 +234,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: createPricePreferencesWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_price-preferences_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_price-preferences_{id}.yaml index 4294aef139..90b18134c5 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_price-preferences_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_price-preferences_{id}.yaml @@ -134,6 +134,7 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: updatePricePreferencesWorkflow + x-events: [] delete: operationId: DeletePricePreferencesId summary: Delete a Price Preference @@ -181,3 +182,4 @@ delete: '500': $ref: ../components/responses/500_error.yaml x-workflow: deletePricePreferencesWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_product-categories.yaml b/www/apps/api-reference/specs/admin/paths/admin_product-categories.yaml index fc45e50ac0..9bbebdce0b 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_product-categories.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_product-categories.yaml @@ -749,3 +749,13 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: createProductCategoriesWorkflow + x-events: + - name: product-category.created + payload: |- + ```ts + [{ + id, // The ID of the product category + }] + ``` + description: Emitted when product categories are created. + deprecated: false diff --git a/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}.yaml index 36a0b82125..637ef1e5dc 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}.yaml @@ -227,6 +227,16 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: updateProductCategoriesWorkflow + x-events: + - name: product-category.updated + payload: |- + ```ts + [{ + id, // The ID of the product category + }] + ``` + description: Emitted when product categories are updated. + deprecated: false delete: operationId: DeleteProductCategoriesId summary: Delete a Product Category @@ -274,3 +284,13 @@ delete: '500': $ref: ../components/responses/500_error.yaml x-workflow: deleteProductCategoriesWorkflow + x-events: + - name: product-category.deleted + payload: |- + ```ts + [{ + id, // The ID of the product category + }] + ``` + description: Emitted when product categories are deleted. + deprecated: false diff --git a/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}_products.yaml b/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}_products.yaml index 1a13e4d9de..a9e5360c92 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}_products.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}_products.yaml @@ -94,3 +94,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: batchLinkProductsToCategoryWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_product-tags.yaml b/www/apps/api-reference/specs/admin/paths/admin_product-tags.yaml index be3c1e5a93..2eeac85cdb 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_product-tags.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_product-tags.yaml @@ -630,3 +630,13 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: createProductTagsWorkflow + x-events: + - name: product-tag.created + payload: |- + ```ts + [{ + id, // The ID of the product tag + }] + ``` + description: Emitted when product tags are created. + deprecated: false diff --git a/www/apps/api-reference/specs/admin/paths/admin_product-tags_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_product-tags_{id}.yaml index 5dc0a4e1d1..2fdce9541e 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_product-tags_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_product-tags_{id}.yaml @@ -143,6 +143,16 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: updateProductTagsWorkflow + x-events: + - name: product-tag.updated + payload: |- + ```ts + [{ + id, // The ID of the product tag + }] + ``` + description: Emitted when product tags are updated. + deprecated: false delete: operationId: DeleteProductTagsId summary: Delete a Product Tag @@ -190,3 +200,13 @@ delete: '500': $ref: ../components/responses/500_error.yaml x-workflow: deleteProductTagsWorkflow + x-events: + - name: product-tag.deleted + payload: |- + ```ts + [{ + id, // The ID of the product tag + }] + ``` + description: Emitted when product tags are deleted. + deprecated: false diff --git a/www/apps/api-reference/specs/admin/paths/admin_product-types.yaml b/www/apps/api-reference/specs/admin/paths/admin_product-types.yaml index a6edcace6a..8d17b00fc5 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_product-types.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_product-types.yaml @@ -630,3 +630,13 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: createProductTypesWorkflow + x-events: + - name: product-type.created + payload: |- + ```ts + [{ + id, // The ID of the product type + }] + ``` + description: Emitted when product types are created. + deprecated: false diff --git a/www/apps/api-reference/specs/admin/paths/admin_product-types_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_product-types_{id}.yaml index fb82434eb9..ec42e03631 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_product-types_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_product-types_{id}.yaml @@ -143,6 +143,16 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: updateProductTypesWorkflow + x-events: + - name: product-type.updated + payload: |- + ```ts + [{ + id, // The ID of the product type + }] + ``` + description: Emitted when product types are updated. + deprecated: false delete: operationId: DeleteProductTypesId summary: Delete a Product Type @@ -190,3 +200,13 @@ delete: '500': $ref: ../components/responses/500_error.yaml x-workflow: deleteProductTypesWorkflow + x-events: + - name: product-type.deleted + payload: |- + ```ts + [{ + id, // The ID of the product type + }] + ``` + description: Emitted when product types are deleted. + deprecated: false diff --git a/www/apps/api-reference/specs/admin/paths/admin_products.yaml b/www/apps/api-reference/specs/admin/paths/admin_products.yaml index 37af38eb2d..49e87cf28a 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products.yaml @@ -1323,3 +1323,22 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: createProductsWorkflow + x-events: + - name: product-variant.created + payload: |- + ```ts + [{ + id, // The ID of the product variant + }] + ``` + description: Emitted when product variants are created. + deprecated: false + - name: product.created + payload: |- + ```ts + [{ + id, // The ID of the product + }] + ``` + description: Emitted when products are created. + deprecated: false diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_batch.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_batch.yaml index f846a37f18..3eda05830b 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_batch.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_batch.yaml @@ -62,3 +62,40 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: batchProductsWorkflow + x-events: + - name: product-variant.created + payload: |- + ```ts + [{ + id, // The ID of the product variant + }] + ``` + description: Emitted when product variants are created. + deprecated: false + - name: product.updated + payload: |- + ```ts + [{ + id, // The ID of the product + }] + ``` + description: Emitted when products are updated. + deprecated: false + - name: product.created + payload: |- + ```ts + [{ + id, // The ID of the product + }] + ``` + description: Emitted when products are created. + deprecated: false + - name: product.deleted + payload: |- + ```ts + [{ + id, // The ID of the product + }] + ``` + description: Emitted when products are deleted. + deprecated: false diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_export.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_export.yaml index a3d146bb00..198c62cac6 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_export.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_export.yaml @@ -67,3 +67,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: exportProductsWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_import.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_import.yaml index 1558793039..3424605392 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_import.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_import.yaml @@ -46,3 +46,40 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: importProductsWorkflow + x-events: + - name: product-variant.created + payload: |- + ```ts + [{ + id, // The ID of the product variant + }] + ``` + description: Emitted when product variants are created. + deprecated: false + - name: product.updated + payload: |- + ```ts + [{ + id, // The ID of the product + }] + ``` + description: Emitted when products are updated. + deprecated: false + - name: product.created + payload: |- + ```ts + [{ + id, // The ID of the product + }] + ``` + description: Emitted when products are created. + deprecated: false + - name: product.deleted + payload: |- + ```ts + [{ + id, // The ID of the product + }] + ``` + description: Emitted when products are deleted. + deprecated: false diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_{id}.yaml index 8f0ec2aa2d..0621b8b6b7 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_{id}.yaml @@ -145,6 +145,16 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: updateProductsWorkflow + x-events: + - name: product.updated + payload: |- + ```ts + [{ + id, // The ID of the product + }] + ``` + description: Emitted when products are updated. + deprecated: false delete: operationId: DeleteProductsId summary: Delete a Product @@ -192,3 +202,13 @@ delete: '500': $ref: ../components/responses/500_error.yaml x-workflow: deleteProductsWorkflow + x-events: + - name: product.deleted + payload: |- + ```ts + [{ + id, // The ID of the product + }] + ``` + description: Emitted when products are deleted. + deprecated: false diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options.yaml index 4e2aa36bbc..c651b4a343 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options.yaml @@ -273,3 +273,13 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: createProductOptionsWorkflow + x-events: + - name: product-option.created + payload: |- + ```ts + [{ + id, // The ID of the product option + }] + ``` + description: Emitted when product options are created. + deprecated: false diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options_{option_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options_{option_id}.yaml index 81c5e0f3a0..f9f376f286 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options_{option_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options_{option_id}.yaml @@ -159,6 +159,16 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: updateProductOptionsWorkflow + x-events: + - name: product-option.updated + payload: |- + ```ts + [{ + id, // The ID of the product option + }] + ``` + description: Emitted when product options are updated. + deprecated: false delete: operationId: DeleteProductsIdOptionsOption_id summary: Delete an Option from Product @@ -236,3 +246,13 @@ delete: '500': $ref: ../components/responses/500_error.yaml x-workflow: deleteProductOptionsWorkflow + x-events: + - name: product-option.deleted + payload: |- + ```ts + [{ + id, // The ID of the product option + }] + ``` + description: Emitted when product options are deleted. + deprecated: false diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants.yaml index 12a43e3707..4c02f89be6 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants.yaml @@ -692,3 +692,13 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: createProductVariantsWorkflow + x-events: + - name: product-variant.created + payload: |- + ```ts + [{ + id, // The ID of the product variant + }] + ``` + description: Emitted when product variants are created. + deprecated: false diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_batch.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_batch.yaml index 079f05e13d..a74f7d3b20 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_batch.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_batch.yaml @@ -69,3 +69,31 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: batchProductVariantsWorkflow + x-events: + - name: product-variant.updated + payload: |- + ```ts + [{ + id, // The ID of the product variant + }] + ``` + description: Emitted when product variants are updated. + deprecated: false + - name: product-variant.created + payload: |- + ```ts + [{ + id, // The ID of the product variant + }] + ``` + description: Emitted when product variants are created. + deprecated: false + - name: product-variant.deleted + payload: |- + ```ts + [{ + id, // The ID of the product variant + }] + ``` + description: Emitted when product variants are deleted. + deprecated: false diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_inventory-items_batch.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_inventory-items_batch.yaml index d24542af8f..bc0310181e 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_inventory-items_batch.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_inventory-items_batch.yaml @@ -149,3 +149,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: batchLinksWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}.yaml index fb75cc1c24..82b12dab2e 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}.yaml @@ -160,6 +160,16 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: updateProductVariantsWorkflow + x-events: + - name: product-variant.updated + payload: |- + ```ts + [{ + id, // The ID of the product variant + }] + ``` + description: Emitted when product variants are updated. + deprecated: false delete: operationId: DeleteProductsIdVariantsVariant_id summary: Delete Product Variant @@ -234,3 +244,13 @@ delete: '500': $ref: ../components/responses/500_error.yaml x-workflow: deleteProductVariantsWorkflow + x-events: + - name: product-variant.deleted + payload: |- + ```ts + [{ + id, // The ID of the product variant + }] + ``` + description: Emitted when product variants are deleted. + deprecated: false diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}_inventory-items.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}_inventory-items.yaml index dc1ba67e5e..85755d92ae 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}_inventory-items.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}_inventory-items.yaml @@ -74,3 +74,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: createLinksWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}_inventory-items_{inventory_item_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}_inventory-items_{inventory_item_id}.yaml index aafdc64d1c..61067f96a5 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}_inventory-items_{inventory_item_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}_inventory-items_{inventory_item_id}.yaml @@ -80,6 +80,7 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: updateLinksWorkflow + x-events: [] delete: operationId: DeleteProductsIdVariantsVariant_idInventoryItemsInventory_item_id summary: Remove Inventory Item Association with Product Variant @@ -156,3 +157,4 @@ delete: '500': $ref: ../components/responses/500_error.yaml x-workflow: dismissLinksWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_promotions.yaml b/www/apps/api-reference/specs/admin/paths/admin_promotions.yaml index cc5c3a17a6..7f4d05b9b9 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_promotions.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_promotions.yaml @@ -1053,3 +1053,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: createPromotionsWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}.yaml index acd5c5ce3a..677f621906 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}.yaml @@ -247,6 +247,7 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: updatePromotionsWorkflow + x-events: [] delete: operationId: DeletePromotionsId summary: Delete a Promotion @@ -313,3 +314,4 @@ delete: '500': $ref: ../components/responses/500_error.yaml x-workflow: deletePromotionsWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_buy-rules_batch.yaml b/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_buy-rules_batch.yaml index f630629910..5afc419b9b 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_buy-rules_batch.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_buy-rules_batch.yaml @@ -126,3 +126,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: batchPromotionRulesWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_rules_batch.yaml b/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_rules_batch.yaml index 156fcb548a..8f07440787 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_rules_batch.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_rules_batch.yaml @@ -124,3 +124,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: batchPromotionRulesWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_target-rules_batch.yaml b/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_target-rules_batch.yaml index 274dcdf2a2..5cf6c32e00 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_target-rules_batch.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_target-rules_batch.yaml @@ -124,3 +124,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: batchPromotionRulesWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_refund-reasons.yaml b/www/apps/api-reference/specs/admin/paths/admin_refund-reasons.yaml index 8c5a905562..8be2706c7a 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_refund-reasons.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_refund-reasons.yaml @@ -232,3 +232,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: createRefundReasonsWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_refund-reasons_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_refund-reasons_{id}.yaml index a2708bc3cc..d216aa377d 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_refund-reasons_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_refund-reasons_{id}.yaml @@ -136,6 +136,7 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: updateRefundReasonsWorkflow + x-events: [] delete: operationId: DeleteRefundReasonsId summary: Delete a Refund Reason @@ -198,3 +199,4 @@ delete: '500': $ref: ../components/responses/500_error.yaml x-workflow: deleteRefundReasonsWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_regions.yaml b/www/apps/api-reference/specs/admin/paths/admin_regions.yaml index ea43e27e07..431c14e15a 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_regions.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_regions.yaml @@ -675,3 +675,13 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: createRegionsWorkflow + x-events: + - name: region.created + payload: |- + ```ts + [{ + id, // The ID of the region + }] + ``` + description: Emitted when regions are created. + deprecated: false diff --git a/www/apps/api-reference/specs/admin/paths/admin_regions_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_regions_{id}.yaml index b28b3547e1..6f0c64fd47 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_regions_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_regions_{id}.yaml @@ -171,6 +171,16 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: updateRegionsWorkflow + x-events: + - name: region.updated + payload: |- + ```ts + [{ + id, // The ID of the region + }] + ``` + description: Emitted when regions are updated. + deprecated: false delete: operationId: DeleteRegionsId summary: Delete a Region @@ -237,3 +247,13 @@ delete: '500': $ref: ../components/responses/500_error.yaml x-workflow: deleteRegionsWorkflow + x-events: + - name: region.deleted + payload: |- + ```ts + [{ + id, // The ID of the region + }] + ``` + description: Emitted when regions are deleted. + deprecated: false diff --git a/www/apps/api-reference/specs/admin/paths/admin_reservations.yaml b/www/apps/api-reference/specs/admin/paths/admin_reservations.yaml index 05a696f5cf..c0de085694 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_reservations.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_reservations.yaml @@ -735,3 +735,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: createReservationsWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_reservations_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_reservations_{id}.yaml index 2c80486978..6d2ae3d7ce 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_reservations_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_reservations_{id}.yaml @@ -151,6 +151,7 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: updateReservationsWorkflow + x-events: [] delete: operationId: DeleteReservationsId summary: Delete a Reservation @@ -217,3 +218,4 @@ delete: '500': $ref: ../components/responses/500_error.yaml x-workflow: deleteReservationsWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_return-reasons.yaml b/www/apps/api-reference/specs/admin/paths/admin_return-reasons.yaml index 410a3bf059..5b66d9c24b 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_return-reasons.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_return-reasons.yaml @@ -688,3 +688,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: createReturnReasonsWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_return-reasons_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_return-reasons_{id}.yaml index 103286d181..d5645ddd98 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_return-reasons_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_return-reasons_{id}.yaml @@ -134,6 +134,7 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: updateReturnReasonsWorkflow + x-events: [] delete: operationId: DeleteReturnReasonsId summary: Delete a Return Reason @@ -181,3 +182,4 @@ delete: '500': $ref: ../components/responses/500_error.yaml x-workflow: deleteReturnReasonsWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns.yaml index 73a3b48d99..5a6cf52362 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns.yaml @@ -828,3 +828,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: beginReturnOrderWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}.yaml index eed237a60f..e5e120cf79 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}.yaml @@ -134,3 +134,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: updateReturnWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_cancel.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_cancel.yaml index 151963d939..4d5abff4f8 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_cancel.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_cancel.yaml @@ -50,3 +50,4 @@ post: schema: $ref: ../components/schemas/AdminPostCancelReturnReqSchema.yaml x-workflow: cancelReturnWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_dismiss-items.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_dismiss-items.yaml index e76c80e0b1..79f015bf15 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_dismiss-items.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_dismiss-items.yaml @@ -71,3 +71,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: dismissItemReturnRequestWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_dismiss-items_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_dismiss-items_{action_id}.yaml index 0dacc5eb59..0477bd2270 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_dismiss-items_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_dismiss-items_{action_id}.yaml @@ -85,6 +85,7 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: updateReceiveItemReturnRequestWorkflow + x-events: [] delete: operationId: DeleteReturnsIdDismissItemsAction_id summary: Remove Damaged Item from Return @@ -166,3 +167,4 @@ delete: '500': $ref: ../components/responses/500_error.yaml x-workflow: removeItemReturnActionWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive-items.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive-items.yaml index e5ca29f568..20e4a9c1fc 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive-items.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive-items.yaml @@ -71,3 +71,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: receiveItemReturnRequestWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive-items_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive-items_{action_id}.yaml index 226581d9a4..fe4b763904 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive-items_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive-items_{action_id}.yaml @@ -85,6 +85,7 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: updateReceiveItemReturnRequestWorkflow + x-events: [] delete: operationId: DeleteReturnsIdReceiveItemsAction_id summary: Remove a Received Item from Return @@ -166,3 +167,4 @@ delete: '500': $ref: ../components/responses/500_error.yaml x-workflow: removeItemReceiveReturnActionWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive.yaml index b733f001c9..7c93cd559b 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive.yaml @@ -70,6 +70,7 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: beginReceiveReturnWorkflow + x-events: [] delete: operationId: DeleteReturnsIdReceive summary: Cancel Return Receival @@ -138,3 +139,4 @@ delete: '500': $ref: ../components/responses/500_error.yaml x-workflow: cancelReturnReceiveWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive_confirm.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive_confirm.yaml index 623e075aad..61c8fb8a64 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive_confirm.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive_confirm.yaml @@ -70,3 +70,14 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: confirmReturnReceiveWorkflow + x-events: + - name: order.return_received + payload: |- + ```ts + { + order_id, // The ID of the order + return_id, // The ID of the return + } + ``` + description: Emitted when a return is marked as received. + deprecated: false diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_request-items.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_request-items.yaml index ac28ceef85..fd52f968be 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_request-items.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_request-items.yaml @@ -71,3 +71,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: requestItemReturnWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_request-items_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_request-items_{action_id}.yaml index c839550cf2..5889bb9d79 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_request-items_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_request-items_{action_id}.yaml @@ -85,6 +85,7 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: updateRequestItemReturnWorkflow + x-events: [] delete: operationId: DeleteReturnsIdRequestItemsAction_id summary: Remove Item from Return @@ -166,3 +167,4 @@ delete: '500': $ref: ../components/responses/500_error.yaml x-workflow: removeItemReturnActionWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_request.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_request.yaml index 48ee733ce4..c15ed5eb05 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_request.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_request.yaml @@ -71,6 +71,17 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: confirmReturnRequestWorkflow + x-events: + - name: order.return_requested + payload: |- + ```ts + { + order_id, // The ID of the order + return_id, // The ID of the return + } + ``` + description: Emitted when a return request is confirmed. + deprecated: false delete: operationId: DeleteReturnsIdRequest summary: Cancel Return Request @@ -137,3 +148,4 @@ delete: '500': $ref: ../components/responses/500_error.yaml x-workflow: cancelReturnRequestWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_shipping-method.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_shipping-method.yaml index 48ffd8ef5f..993729b04e 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_shipping-method.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_shipping-method.yaml @@ -71,3 +71,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: createReturnShippingMethodWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_shipping-method_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_shipping-method_{action_id}.yaml index 8de8919078..a4dfac6806 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_shipping-method_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_shipping-method_{action_id}.yaml @@ -84,6 +84,7 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: updateReturnShippingMethodWorkflow + x-events: [] delete: operationId: DeleteReturnsIdShippingMethodAction_id summary: Remove Shipping Method from Return @@ -165,3 +166,4 @@ delete: '500': $ref: ../components/responses/500_error.yaml x-workflow: removeReturnShippingMethodWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_sales-channels.yaml b/www/apps/api-reference/specs/admin/paths/admin_sales-channels.yaml index d7ca5e8207..120b7d6471 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_sales-channels.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_sales-channels.yaml @@ -713,3 +713,13 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: createSalesChannelsWorkflow + x-events: + - name: sales-channel.created + payload: |- + ```ts + [{ + id, // The ID of the sales channel + }] + ``` + description: Emitted when sales channels are created. + deprecated: false diff --git a/www/apps/api-reference/specs/admin/paths/admin_sales-channels_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_sales-channels_{id}.yaml index d2166bc64b..dcbacc2878 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_sales-channels_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_sales-channels_{id}.yaml @@ -134,6 +134,16 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: updateSalesChannelsWorkflow + x-events: + - name: sales-channel.updated + payload: |- + ```ts + [{ + id, // The ID of the sales channel + }] + ``` + description: Emitted when sales channels are updated. + deprecated: false delete: operationId: DeleteSalesChannelsId summary: Delete a Sales Channel @@ -181,3 +191,13 @@ delete: '500': $ref: ../components/responses/500_error.yaml x-workflow: deleteSalesChannelsWorkflow + x-events: + - name: sales-channel.deleted + payload: |- + ```ts + [{ + id, // The ID of the sales channel + }] + ``` + description: Emitted when sales channels are deleted. + deprecated: false diff --git a/www/apps/api-reference/specs/admin/paths/admin_sales-channels_{id}_products.yaml b/www/apps/api-reference/specs/admin/paths/admin_sales-channels_{id}_products.yaml index e647b88061..42ddd04df8 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_sales-channels_{id}_products.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_sales-channels_{id}_products.yaml @@ -85,3 +85,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: linkProductsToSalesChannelWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_shipping-options.yaml b/www/apps/api-reference/specs/admin/paths/admin_shipping-options.yaml index 5a73766e6a..c55d8d1dbc 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_shipping-options.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_shipping-options.yaml @@ -731,3 +731,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: createShippingOptionsWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_shipping-options_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_shipping-options_{id}.yaml index f10ca2908f..e7ffa03c09 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_shipping-options_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_shipping-options_{id}.yaml @@ -315,6 +315,7 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: updateShippingOptionsWorkflow + x-events: [] delete: operationId: DeleteShippingOptionsId summary: Delete a Shipping Option @@ -362,3 +363,4 @@ delete: '500': $ref: ../components/responses/500_error.yaml x-workflow: deleteShippingOptionsWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_shipping-options_{id}_rules_batch.yaml b/www/apps/api-reference/specs/admin/paths/admin_shipping-options_{id}_rules_batch.yaml index b70d04f955..d337d37a9d 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_shipping-options_{id}_rules_batch.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_shipping-options_{id}_rules_batch.yaml @@ -129,3 +129,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: batchShippingOptionRulesWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_shipping-profiles.yaml b/www/apps/api-reference/specs/admin/paths/admin_shipping-profiles.yaml index e83c4e29de..5b78405b47 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_shipping-profiles.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_shipping-profiles.yaml @@ -664,3 +664,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: createShippingProfilesWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_shipping-profiles_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_shipping-profiles_{id}.yaml index 6ea25d8364..41f131b448 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_shipping-profiles_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_shipping-profiles_{id}.yaml @@ -147,6 +147,7 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: updateShippingProfilesWorkflow + x-events: [] delete: operationId: DeleteShippingProfilesId summary: Delete a Shipping Profile @@ -194,3 +195,4 @@ delete: '500': $ref: ../components/responses/500_error.yaml x-workflow: deleteShippingProfileWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_stock-locations.yaml b/www/apps/api-reference/specs/admin/paths/admin_stock-locations.yaml index de2a053acd..c597ddee63 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_stock-locations.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_stock-locations.yaml @@ -660,3 +660,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: createStockLocationsWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}.yaml index f4ed982ae8..3dd7c98688 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}.yaml @@ -134,6 +134,7 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: updateStockLocationsWorkflow + x-events: [] delete: operationId: DeleteStockLocationsId summary: Delete a Stock Location @@ -181,3 +182,4 @@ delete: '500': $ref: ../components/responses/500_error.yaml x-workflow: deleteStockLocationsWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}_fulfillment-providers.yaml b/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}_fulfillment-providers.yaml index 92f83ce19d..5462595df8 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}_fulfillment-providers.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}_fulfillment-providers.yaml @@ -89,3 +89,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: batchLinksWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}_fulfillment-sets.yaml b/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}_fulfillment-sets.yaml index 11999a6529..0345a07c99 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}_fulfillment-sets.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}_fulfillment-sets.yaml @@ -84,3 +84,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: createLocationFulfillmentSetWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}_sales-channels.yaml b/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}_sales-channels.yaml index 45f87a389b..e491ca34b4 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}_sales-channels.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}_sales-channels.yaml @@ -87,3 +87,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: linkSalesChannelsToStockLocationWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_stores_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_stores_{id}.yaml index 32041d6a7a..eef78781ed 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_stores_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_stores_{id}.yaml @@ -134,3 +134,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: updateStoresWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_tax-rates.yaml b/www/apps/api-reference/specs/admin/paths/admin_tax-rates.yaml index 8ef0a91929..3551bc1247 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_tax-rates.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_tax-rates.yaml @@ -757,3 +757,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: createTaxRatesWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}.yaml index 9ddb8a8a91..247a2fb0bb 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}.yaml @@ -134,6 +134,7 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: updateTaxRatesWorkflow + x-events: [] delete: operationId: DeleteTaxRatesId summary: Delete a Tax Rate @@ -181,3 +182,4 @@ delete: '500': $ref: ../components/responses/500_error.yaml x-workflow: deleteTaxRatesWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}_rules.yaml b/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}_rules.yaml index 2e8b3d5206..8c3a29bcde 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}_rules.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}_rules.yaml @@ -65,3 +65,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: createTaxRateRulesWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}_rules_{rule_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}_rules_{rule_id}.yaml index 4cb382a4d0..67baad8c4d 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}_rules_{rule_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}_rules_{rule_id}.yaml @@ -91,3 +91,4 @@ delete: '500': $ref: ../components/responses/500_error.yaml x-workflow: deleteTaxRateRulesWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_tax-regions.yaml b/www/apps/api-reference/specs/admin/paths/admin_tax-regions.yaml index 4e630b97b1..a49e9496fb 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_tax-regions.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_tax-regions.yaml @@ -157,13 +157,21 @@ get: oneOf: - type: string title: province_code - description: Filter by a province code. + description: Filter by 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 - type: array - description: Filter by province codes. + description: Filter by ISO 3166-2 province codes. items: type: string title: province_code - description: A province code. + description: A ISO 3166-2 province code. + example: us-ca + externalDocs: + url: https://en.wikipedia.org/wiki/ISO_3166-2 + description: Learn more about ISO 3166-2 - type: object description: Apply filters on the province code. properties: @@ -1380,3 +1388,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: createTaxRegionsWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_tax-regions_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_tax-regions_{id}.yaml index 1886827f71..1c0f9880b6 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_tax-regions_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_tax-regions_{id}.yaml @@ -106,6 +106,10 @@ post: schema: $ref: ../components/schemas/AdminUpdateTaxRegion.yaml x-codeSamples: + - lang: JavaScript + label: JS SDK + source: + $ref: ../code_samples/JavaScript/admin_tax-regions_{id}/post.js - lang: Shell label: cURL source: @@ -132,6 +136,7 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: updateTaxRegionsWorkflow + x-events: [] delete: operationId: DeleteTaxRegionsId summary: Delete a Tax Region @@ -179,3 +184,4 @@ delete: '500': $ref: ../components/responses/500_error.yaml x-workflow: deleteTaxRegionsWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_uploads.yaml b/www/apps/api-reference/specs/admin/paths/admin_uploads.yaml index 2bed219b7f..ca5d3ddc97 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_uploads.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_uploads.yaml @@ -84,3 +84,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: uploadFilesWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_uploads_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_uploads_{id}.yaml index 312407d9e7..a17fdd79f1 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_uploads_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_uploads_{id}.yaml @@ -130,3 +130,4 @@ delete: '500': $ref: ../components/responses/500_error.yaml x-workflow: deleteFilesWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_users_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_users_{id}.yaml index f1b65f96e1..fe7377e0bc 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_users_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_users_{id}.yaml @@ -132,6 +132,16 @@ post: security: - cookie_auth: [] - jwt_token: [] + x-events: + - name: user.updated + payload: |- + ```ts + [{ + id, // The ID of the user + }] + ``` + description: Emitted when users are updated. + deprecated: false delete: operationId: DeleteUsersId summary: Delete a User @@ -178,3 +188,13 @@ delete: security: - cookie_auth: [] - jwt_token: [] + x-events: + - name: user.deleted + payload: |- + ```ts + [{ + id, // The ID of the user + }] + ``` + description: Emitted when users are deleted. + deprecated: false diff --git a/www/apps/api-reference/specs/admin/paths/auth_user_{auth_provider}_reset-password.yaml b/www/apps/api-reference/specs/admin/paths/auth_user_{auth_provider}_reset-password.yaml index 6c7a2e1df8..8e0df866d4 100644 --- a/www/apps/api-reference/specs/admin/paths/auth_user_{auth_provider}_reset-password.yaml +++ b/www/apps/api-reference/specs/admin/paths/auth_user_{auth_provider}_reset-password.yaml @@ -71,3 +71,19 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: generateResetPasswordTokenWorkflow + x-events: + - name: auth.password_reset + payload: |- + ```ts + { + entity_id, // The identifier of the user or customer. For example, an email address. + actor_type, // The type of actor. For example, "customer", "user", or custom. + token, // The generated token. + } + ``` + description: >- + Emitted when a reset password token is generated. You can listen to this + event + + to send a reset password email to the user or customer, for example. + deprecated: false diff --git a/www/apps/api-reference/specs/store/code_samples/Shell/store_customers_me_addresses/post.sh b/www/apps/api-reference/specs/store/code_samples/Shell/store_customers_me_addresses/post.sh index 9a1d35eb15..edf14fb1aa 100644 --- a/www/apps/api-reference/specs/store/code_samples/Shell/store_customers_me_addresses/post.sh +++ b/www/apps/api-reference/specs/store/code_samples/Shell/store_customers_me_addresses/post.sh @@ -12,7 +12,7 @@ curl -X POST '{backend_url}/store/customers/me/addresses' \ "address_2": "{value}", "city": "{value}", "country_code": "{value}", - "province": "{value}", + "province": "us-ca", "postal_code": "{value}", "address_name": "{value}" }' \ No newline at end of file diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateFulfillment.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateFulfillment.yaml index 1a0af19c8f..6359d75d4c 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateFulfillment.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateFulfillment.yaml @@ -58,7 +58,11 @@ properties: province: type: string title: province - description: The delivery address's province. + description: The delivery 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 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateTaxRegion.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateTaxRegion.yaml index 261472a2de..e1b10b47c9 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateTaxRegion.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateTaxRegion.yaml @@ -12,7 +12,11 @@ properties: province_code: type: string title: province_code - description: The tax region's province code. + description: The tax region'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 parent_id: type: string title: parent_id diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCustomerAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCustomerAddress.yaml index de369d541a..9cce8725ae 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCustomerAddress.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCustomerAddress.yaml @@ -73,7 +73,11 @@ properties: province: type: string title: province - description: The address's province. + description: The address's lower-case ISO 3166-2 province code. + 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 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentAddress.yaml index 37df664f0e..67f9793026 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentAddress.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentAddress.yaml @@ -58,7 +58,11 @@ properties: province: type: string title: province - description: The address's province. + description: The address's lower-case ISO 3166-2 province code. + 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 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminGeoZone.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminGeoZone.yaml index c7d0be5d77..bf81d83be0 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminGeoZone.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminGeoZone.yaml @@ -31,7 +31,11 @@ properties: province_code: type: string title: province_code - description: The geo zone's province code. + description: The geo zone's lower-case ISO 3166-2 province code. + 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 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminOrderAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminOrderAddress.yaml index 6a69c1a244..fad010e48b 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminOrderAddress.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminOrderAddress.yaml @@ -53,7 +53,11 @@ properties: province: type: string title: province - description: The address's province. + description: The address's lower-case ISO 3166-2 province code. + 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 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminStockLocationAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminStockLocationAddress.yaml index 22dc78b1d4..c2517adeef 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminStockLocationAddress.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminStockLocationAddress.yaml @@ -38,7 +38,11 @@ properties: province: type: string title: province - description: The address's province. + description: The address's lower-case ISO 3166-2 province code. + example: us-ca + externalDocs: + url: https://en.wikipedia.org/wiki/ISO_3166-2 + description: Learn more about ISO 3166-2 required: - id - address_1 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminTaxRegion.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminTaxRegion.yaml index 0c5867f445..f75bb9af92 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminTaxRegion.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminTaxRegion.yaml @@ -27,7 +27,11 @@ properties: province_code: type: string title: province_code - description: The tax region's province code. + description: The tax region's lower-case ISO 3166-2 province code. + example: us-ca + externalDocs: + url: https://en.wikipedia.org/wiki/ISO_3166-2 + description: Learn more about ISO 3166-2 metadata: type: object description: The tax region's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateDraftOrder.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateDraftOrder.yaml index b8a6ad7759..e4e0c8a5ee 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateDraftOrder.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateDraftOrder.yaml @@ -47,7 +47,11 @@ properties: 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 @@ -95,7 +99,11 @@ properties: 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 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateOrder.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateOrder.yaml index 198a1866bd..78280d8e76 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateOrder.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateOrder.yaml @@ -47,7 +47,11 @@ properties: 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 @@ -95,7 +99,11 @@ properties: 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 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateStockLocation.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateStockLocation.yaml index 936fe6f522..9d47328396 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateStockLocation.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateStockLocation.yaml @@ -47,7 +47,11 @@ properties: 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 address_id: type: string title: address_id diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateTaxRegion.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateTaxRegion.yaml index d599385b83..a66fb3835b 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateTaxRegion.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateTaxRegion.yaml @@ -5,7 +5,11 @@ properties: province_code: type: string title: province_code - description: The tax region's province code. + description: The tax region'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 metadata: type: object description: The tax region's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpsertStockLocationAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpsertStockLocationAddress.yaml index 5c265c5e0e..4886fe1878 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpsertStockLocationAddress.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpsertStockLocationAddress.yaml @@ -37,4 +37,8 @@ properties: 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 diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseOrderAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseOrderAddress.yaml index e3d3b54635..e1aafdc8fb 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseOrderAddress.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseOrderAddress.yaml @@ -51,7 +51,11 @@ properties: province: type: string title: province - description: The address's province. + description: The address's lower-case ISO 3166-2 province code. + 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 diff --git a/www/apps/api-reference/specs/store/components/schemas/CreateAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/CreateAddress.yaml index 14de28c42e..a610a042be 100644 --- a/www/apps/api-reference/specs/store/components/schemas/CreateAddress.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/CreateAddress.yaml @@ -38,7 +38,11 @@ properties: 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 diff --git a/www/apps/api-reference/specs/store/components/schemas/OrderAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/OrderAddress.yaml index 3108787026..f2ca629923 100644 --- a/www/apps/api-reference/specs/store/components/schemas/OrderAddress.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/OrderAddress.yaml @@ -50,7 +50,11 @@ properties: province: type: string title: province - description: The address's province. + description: The address's lower-case ISO 3166-2 province code. + 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 diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCartAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCartAddress.yaml index 15aa12c9eb..89963e7b4c 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreCartAddress.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCartAddress.yaml @@ -50,7 +50,11 @@ properties: province: type: string title: province - description: The address's province. + description: The address's lower-case ISO 3166-2 province code. + 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 diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCustomerAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCustomerAddress.yaml index 4d3108e25f..7c24514a35 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreCustomerAddress.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCustomerAddress.yaml @@ -73,7 +73,11 @@ properties: province: type: string title: province - description: The address's province. + description: The address's lower-case ISO 3166-2 province code. + 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 diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreOrderAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreOrderAddress.yaml index 54ec49cf34..8c24ea8e12 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreOrderAddress.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreOrderAddress.yaml @@ -53,7 +53,11 @@ properties: province: type: string title: province - description: The address's province. + description: The address's lower-case ISO 3166-2 province code. + 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 diff --git a/www/apps/api-reference/specs/store/components/schemas/UpdateAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/UpdateAddress.yaml index 22025cb22d..6968ed3b46 100644 --- a/www/apps/api-reference/specs/store/components/schemas/UpdateAddress.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/UpdateAddress.yaml @@ -44,7 +44,11 @@ properties: 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 diff --git a/www/apps/api-reference/specs/store/openapi.full.yaml b/www/apps/api-reference/specs/store/openapi.full.yaml index b1e807a16e..63365c4554 100644 --- a/www/apps/api-reference/specs/store/openapi.full.yaml +++ b/www/apps/api-reference/specs/store/openapi.full.yaml @@ -525,6 +525,20 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: generateResetPasswordTokenWorkflow + x-events: + - name: auth.password_reset + payload: |- + ```ts + { + entity_id, // The identifier of the user or customer. For example, an email address. + actor_type, // The type of actor. For example, "customer", "user", or custom. + token, // The generated token. + } + ``` + description: |- + Emitted when a reset password token is generated. You can listen to this event + to send a reset password email to the user or customer, for example. + deprecated: false /auth/customer/{auth_provider}/update: post: operationId: PostActor_typeAuth_providerUpdate @@ -866,6 +880,16 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: createCartWorkflow + x-events: + - name: cart.created + payload: |- + ```ts + { + id, // The ID of the cart + } + ``` + description: Emitted when a cart is created. + deprecated: false /store/carts/{id}: get: operationId: GetCartsId @@ -1045,6 +1069,36 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: updateCartWorkflow + x-events: + - name: cart.updated + payload: |- + ```ts + { + id, // The ID of the cart + } + ``` + description: Emitted when a cart's details are updated. + deprecated: false + - name: cart.customer_updated + payload: |- + ```ts + { + id, // The ID of the cart + } + ``` + description: Emitted when the customer in the cart is updated. + deprecated: false + - name: cart.region_updated + payload: |- + ```ts + { + id, // The ID of the cart + } + ``` + description: |- + Emitted when the cart's region is updated. This + event is emitted alongside the `cart.updated` event. + deprecated: false /store/carts/{id}/complete: post: operationId: PostCartsIdComplete @@ -1182,6 +1236,18 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: completeCartWorkflow + 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 /store/carts/{id}/customer: post: operationId: PostCartsIdCustomer @@ -1269,6 +1335,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: transferCartCustomerWorkflow + x-events: [] /store/carts/{id}/line-items: post: operationId: PostCartsIdLineItems @@ -1367,6 +1434,16 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: addToCartWorkflow + x-events: + - name: cart.updated + payload: |- + ```ts + { + id, // The ID of the cart + } + ``` + description: Emitted when a cart's details are updated. + deprecated: false /store/carts/{id}/line-items/{line_id}: post: operationId: PostCartsIdLineItemsLine_id @@ -1473,6 +1550,16 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: updateLineItemInCartWorkflow + x-events: + - name: cart.updated + payload: |- + ```ts + { + id, // The ID of the cart + } + ``` + description: Emitted when a cart's details are updated. + deprecated: false delete: operationId: DeleteCartsIdLineItemsLine_id summary: Remove Line Item from Cart @@ -1592,6 +1679,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: deleteLineItemsWorkflow + x-events: [] /store/carts/{id}/promotions: post: operationId: PostCartsIdPromotions @@ -1663,6 +1751,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: updateCartPromotionsWorkflow + x-events: [] delete: operationId: DeleteCartsIdPromotions summary: Remove Promotions from Cart @@ -1732,6 +1821,7 @@ paths: application/json: schema: $ref: '#/components/schemas/StoreCartRemovePromotion' + x-events: [] /store/carts/{id}/shipping-methods: post: operationId: PostCartsIdShippingMethods @@ -1844,6 +1934,16 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: addShippingMethodToCartWorkflow + x-events: + - name: cart.updated + payload: |- + ```ts + { + id, // The ID of the cart + } + ``` + description: Emitted when a cart's details are updated. + deprecated: false /store/carts/{id}/taxes: post: operationId: PostCartsIdTaxes @@ -1904,6 +2004,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: updateTaxLinesWorkflow + x-events: [] /store/collections: get: operationId: GetCollections @@ -2924,6 +3025,16 @@ paths: security: - cookie_auth: [] - jwt_token: [] + x-events: + - name: customer.created + payload: |- + ```ts + [{ + id, // The ID of the customer + }] + ``` + description: Emitted when a customer is created. + deprecated: false /store/customers/me: get: operationId: GetCustomersMe @@ -3099,6 +3210,16 @@ paths: '500': $ref: '#/components/responses/500_error' 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 /store/customers/me/addresses: get: operationId: GetCustomersMeAddresses @@ -3334,7 +3455,11 @@ paths: 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 @@ -3395,7 +3520,7 @@ paths: "address_2": "{value}", "city": "{value}", "country_code": "{value}", - "province": "{value}", + "province": "us-ca", "postal_code": "{value}", "address_name": "{value}" }' @@ -3421,6 +3546,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: createCustomerAddressesWorkflow + x-events: [] /store/customers/me/addresses/{address_id}: get: operationId: GetCustomersMeAddressesAddress_id @@ -3586,7 +3712,11 @@ paths: 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 @@ -3665,6 +3795,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: updateCustomerAddressesWorkflow + x-events: [] delete: operationId: DeleteCustomersMeAddressesAddress_id summary: Remove Customer's Address @@ -3779,6 +3910,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: deleteCustomerAddressesWorkflow + x-events: [] /store/orders: get: operationId: GetOrders @@ -3981,6 +4113,7 @@ paths: - cookie_auth: [] - jwt_token: [] x-workflow: getOrdersListWorkflow + x-events: [] /store/orders/{id}: get: operationId: GetOrdersId @@ -4061,6 +4194,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: getOrderDetailWorkflow + x-events: [] /store/orders/{id}/transfer/accept: post: operationId: PostOrdersIdTransferAccept @@ -4162,6 +4296,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: acceptOrderTransferWorkflow + x-events: [] /store/orders/{id}/transfer/cancel: post: operationId: PostOrdersIdTransferCancel @@ -4255,6 +4390,7 @@ paths: security: - cookie_auth: [] - jwt_token: [] + x-events: [] /store/orders/{id}/transfer/decline: post: operationId: PostOrdersIdTransferDecline @@ -4356,6 +4492,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: declineOrderTransferRequestWorkflow + x-events: [] /store/orders/{id}/transfer/request: post: operationId: PostOrdersIdTransferRequest @@ -4457,6 +4594,7 @@ paths: security: - cookie_auth: [] - jwt_token: [] + x-events: [] /store/payment-collections: post: operationId: PostPaymentCollections @@ -4551,6 +4689,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: createPaymentCollectionForCartWorkflow + x-events: [] /store/payment-collections/{id}/payment-sessions: post: operationId: PostPaymentCollectionsIdPaymentSessions @@ -4623,6 +4762,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: createPaymentSessionsWorkflow + x-events: [] /store/payment-providers: get: operationId: GetPaymentProviders @@ -7524,12 +7664,16 @@ paths: description: 'Storefront guide: How to show product variants'' prices with taxes.' - name: province in: query - description: The province the products are being viewed from. This is useful to narrow down the tax context when calculating product variant prices with taxes. + description: The lower-case ISO 3166-2 province code the products are being viewed from. This is useful to narrow down the tax context when calculating product variant prices with taxes. required: false schema: type: string title: province - description: The province the products are being viewed from. This is useful to narrow down the tax context when calculating product variant prices with taxes. + description: The lower-case ISO 3166-2 province code the products are being viewed from. This is useful to narrow down the tax context when calculating product variant prices with taxes. + example: us-ca + externalDocs: + url: https://en.wikipedia.org/wiki/ISO_3166-2 + description: Learn more about ISO 3166-2 - name: sales_channel_id in: query required: false @@ -7730,12 +7874,16 @@ paths: description: The country code the product is being viewed from. This is required if you're retrieving product variant prices with taxes. - name: province in: query - description: The province the product is being viewed from. This is useful to narrow down the tax context when calculating product variant prices with taxes. + description: The lower-case ISO 3166-2 province code the product is being viewed from. This is useful to narrow down the tax context when calculating product variant prices with taxes. required: false schema: type: string title: province - description: The province the product is being viewed from. This is useful to narrow down the tax context when calculating product variant prices with taxes. + description: The lower-case ISO 3166-2 province code the product is being viewed from. This is useful to narrow down the tax context when calculating product variant prices with taxes. + example: us-ca + externalDocs: + url: https://en.wikipedia.org/wiki/ISO_3166-2 + description: Learn more about ISO 3166-2 - name: cart_id in: query description: The ID of the customer's cart. If set, the cart's region and shipping address's country code and province are used instead of the `region_id`, `country_code`, and `province` properties. @@ -8487,6 +8635,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: listShippingOptionsForCartWorkflow + x-events: [] /store/shipping-options/{id}/calculate: post: operationId: PostShippingOptionsIdCalculate @@ -8594,6 +8743,7 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: calculateShippingOptionsPricesWorkflow + x-events: [] components: schemas: AdminAddDraftOrderItems: @@ -9906,7 +10056,11 @@ components: province: type: string title: province - description: The delivery address's province. + description: The delivery 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 @@ -11050,7 +11204,11 @@ components: province_code: type: string title: province_code - description: The tax region's province code. + description: The tax region'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 parent_id: type: string title: parent_id @@ -11393,7 +11551,11 @@ components: province: type: string title: province - description: The address's province. + description: The address's lower-case ISO 3166-2 province code. + 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 @@ -13364,7 +13526,11 @@ components: province: type: string title: province - description: The address's province. + description: The address's lower-case ISO 3166-2 province code. + 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 @@ -13712,7 +13878,11 @@ components: province_code: type: string title: province_code - description: The geo zone's province code. + description: The geo zone's lower-case ISO 3166-2 province code. + 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 @@ -14400,7 +14570,11 @@ components: province: type: string title: province - description: The address's province. + description: The address's lower-case ISO 3166-2 province code. + 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 @@ -19633,7 +19807,11 @@ components: province: type: string title: province - description: The address's province. + description: The address's lower-case ISO 3166-2 province code. + example: us-ca + externalDocs: + url: https://en.wikipedia.org/wiki/ISO_3166-2 + description: Learn more about ISO 3166-2 required: - id - address_1 @@ -19998,7 +20176,11 @@ components: province_code: type: string title: province_code - description: The tax region's province code. + description: The tax region's lower-case ISO 3166-2 province code. + example: us-ca + externalDocs: + url: https://en.wikipedia.org/wiki/ISO_3166-2 + description: Learn more about ISO 3166-2 metadata: type: object description: The tax region's metadata, can hold custom key-value pairs. @@ -20176,7 +20358,11 @@ components: 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 @@ -20224,7 +20410,11 @@ components: 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 @@ -20359,7 +20549,11 @@ components: 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 @@ -20407,7 +20601,11 @@ components: 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 @@ -20904,7 +21102,11 @@ components: 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 address_id: type: string title: address_id @@ -21016,7 +21218,11 @@ components: province_code: type: string title: province_code - description: The tax region's province code. + description: The tax region'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 metadata: type: object description: The tax region's metadata, can hold custom key-value pairs. @@ -21091,7 +21297,11 @@ components: 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 AdminUser: type: object description: The user's details. @@ -22690,7 +22900,11 @@ components: province: type: string title: province - description: The address's province. + description: The address's lower-case ISO 3166-2 province code. + 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 @@ -24763,7 +24977,11 @@ components: 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 @@ -25581,7 +25799,11 @@ components: province: type: string title: province - description: The address's province. + description: The address's lower-case ISO 3166-2 province code. + 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 @@ -27428,7 +27650,11 @@ components: province: type: string title: province - description: The address's province. + description: The address's lower-case ISO 3166-2 province code. + 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 @@ -28643,7 +28869,11 @@ components: province: type: string title: province - description: The address's province. + description: The address's lower-case ISO 3166-2 province code. + 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 @@ -29031,7 +29261,11 @@ components: province: type: string title: province - description: The address's province. + description: The address's lower-case ISO 3166-2 province code. + 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 @@ -36254,7 +36488,11 @@ components: 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 diff --git a/www/apps/api-reference/specs/store/paths/auth_customer_{auth_provider}_reset-password.yaml b/www/apps/api-reference/specs/store/paths/auth_customer_{auth_provider}_reset-password.yaml index 77174b36cb..f0b04825c6 100644 --- a/www/apps/api-reference/specs/store/paths/auth_customer_{auth_provider}_reset-password.yaml +++ b/www/apps/api-reference/specs/store/paths/auth_customer_{auth_provider}_reset-password.yaml @@ -72,3 +72,19 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: generateResetPasswordTokenWorkflow + x-events: + - name: auth.password_reset + payload: |- + ```ts + { + entity_id, // The identifier of the user or customer. For example, an email address. + actor_type, // The type of actor. For example, "customer", "user", or custom. + token, // The generated token. + } + ``` + description: >- + Emitted when a reset password token is generated. You can listen to this + event + + to send a reset password email to the user or customer, for example. + deprecated: false diff --git a/www/apps/api-reference/specs/store/paths/store_carts.yaml b/www/apps/api-reference/specs/store/paths/store_carts.yaml index 12d9d1dc8e..287367a2ed 100644 --- a/www/apps/api-reference/specs/store/paths/store_carts.yaml +++ b/www/apps/api-reference/specs/store/paths/store_carts.yaml @@ -77,3 +77,13 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: createCartWorkflow + x-events: + - name: cart.created + payload: |- + ```ts + { + id, // The ID of the cart + } + ``` + description: Emitted when a cart is created. + deprecated: false diff --git a/www/apps/api-reference/specs/store/paths/store_carts_{id}.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}.yaml index 105c8a2403..e38f822a38 100644 --- a/www/apps/api-reference/specs/store/paths/store_carts_{id}.yaml +++ b/www/apps/api-reference/specs/store/paths/store_carts_{id}.yaml @@ -165,3 +165,33 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: updateCartWorkflow + x-events: + - name: cart.updated + payload: |- + ```ts + { + id, // The ID of the cart + } + ``` + description: Emitted when a cart's details are updated. + deprecated: false + - name: cart.customer_updated + payload: |- + ```ts + { + id, // The ID of the cart + } + ``` + description: Emitted when the customer in the cart is updated. + deprecated: false + - name: cart.region_updated + payload: |- + ```ts + { + id, // The ID of the cart + } + ``` + description: |- + Emitted when the cart's region is updated. This + event is emitted alongside the `cart.updated` event. + deprecated: false diff --git a/www/apps/api-reference/specs/store/paths/store_carts_{id}_complete.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}_complete.yaml index a66ea71ab9..973a95e1d2 100644 --- a/www/apps/api-reference/specs/store/paths/store_carts_{id}_complete.yaml +++ b/www/apps/api-reference/specs/store/paths/store_carts_{id}_complete.yaml @@ -127,3 +127,17 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: completeCartWorkflow + 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 diff --git a/www/apps/api-reference/specs/store/paths/store_carts_{id}_customer.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}_customer.yaml index 289ec6ad87..c6d771b002 100644 --- a/www/apps/api-reference/specs/store/paths/store_carts_{id}_customer.yaml +++ b/www/apps/api-reference/specs/store/paths/store_carts_{id}_customer.yaml @@ -76,3 +76,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: transferCartCustomerWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items.yaml index 5a8698812d..f224c39520 100644 --- a/www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items.yaml +++ b/www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items.yaml @@ -77,3 +77,13 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: addToCartWorkflow + x-events: + - name: cart.updated + payload: |- + ```ts + { + id, // The ID of the cart + } + ``` + description: Emitted when a cart's details are updated. + deprecated: false diff --git a/www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items_{line_id}.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items_{line_id}.yaml index abf4851c91..a34e20f595 100644 --- a/www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items_{line_id}.yaml +++ b/www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items_{line_id}.yaml @@ -84,6 +84,16 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: updateLineItemInCartWorkflow + x-events: + - name: cart.updated + payload: |- + ```ts + { + id, // The ID of the cart + } + ``` + description: Emitted when a cart's details are updated. + deprecated: false delete: operationId: DeleteCartsIdLineItemsLine_id summary: Remove Line Item from Cart @@ -192,3 +202,4 @@ delete: '500': $ref: ../components/responses/500_error.yaml x-workflow: deleteLineItemsWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/store/paths/store_carts_{id}_promotions.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}_promotions.yaml index 119fe5a1cb..450c4662ec 100644 --- a/www/apps/api-reference/specs/store/paths/store_carts_{id}_promotions.yaml +++ b/www/apps/api-reference/specs/store/paths/store_carts_{id}_promotions.yaml @@ -69,6 +69,7 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: updateCartPromotionsWorkflow + x-events: [] delete: operationId: DeleteCartsIdPromotions summary: Remove Promotions from Cart @@ -145,3 +146,4 @@ delete: application/json: schema: $ref: ../components/schemas/StoreCartRemovePromotion.yaml + x-events: [] diff --git a/www/apps/api-reference/specs/store/paths/store_carts_{id}_shipping-methods.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}_shipping-methods.yaml index 85d3b5e5f2..441aba7d3f 100644 --- a/www/apps/api-reference/specs/store/paths/store_carts_{id}_shipping-methods.yaml +++ b/www/apps/api-reference/specs/store/paths/store_carts_{id}_shipping-methods.yaml @@ -96,3 +96,13 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: addShippingMethodToCartWorkflow + x-events: + - name: cart.updated + payload: |- + ```ts + { + id, // The ID of the cart + } + ``` + description: Emitted when a cart's details are updated. + deprecated: false diff --git a/www/apps/api-reference/specs/store/paths/store_carts_{id}_taxes.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}_taxes.yaml index f3e718695d..f124b8d2fb 100644 --- a/www/apps/api-reference/specs/store/paths/store_carts_{id}_taxes.yaml +++ b/www/apps/api-reference/specs/store/paths/store_carts_{id}_taxes.yaml @@ -64,3 +64,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: updateTaxLinesWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/store/paths/store_customers.yaml b/www/apps/api-reference/specs/store/paths/store_customers.yaml index 1588de0dd6..f420b3facb 100644 --- a/www/apps/api-reference/specs/store/paths/store_customers.yaml +++ b/www/apps/api-reference/specs/store/paths/store_customers.yaml @@ -80,3 +80,13 @@ post: security: - cookie_auth: [] - jwt_token: [] + x-events: + - name: customer.created + payload: |- + ```ts + [{ + id, // The ID of the customer + }] + ``` + description: Emitted when a customer is created. + deprecated: false diff --git a/www/apps/api-reference/specs/store/paths/store_customers_me.yaml b/www/apps/api-reference/specs/store/paths/store_customers_me.yaml index 1a1ec443f2..d02ec58ca9 100644 --- a/www/apps/api-reference/specs/store/paths/store_customers_me.yaml +++ b/www/apps/api-reference/specs/store/paths/store_customers_me.yaml @@ -157,3 +157,13 @@ 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 diff --git a/www/apps/api-reference/specs/store/paths/store_customers_me_addresses.yaml b/www/apps/api-reference/specs/store/paths/store_customers_me_addresses.yaml index 2c4c6b38b6..baee0aa0a5 100644 --- a/www/apps/api-reference/specs/store/paths/store_customers_me_addresses.yaml +++ b/www/apps/api-reference/specs/store/paths/store_customers_me_addresses.yaml @@ -255,7 +255,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 @@ -310,3 +314,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: createCustomerAddressesWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/store/paths/store_customers_me_addresses_{address_id}.yaml b/www/apps/api-reference/specs/store/paths/store_customers_me_addresses_{address_id}.yaml index ec31f199c1..dd98c7af31 100644 --- a/www/apps/api-reference/specs/store/paths/store_customers_me_addresses_{address_id}.yaml +++ b/www/apps/api-reference/specs/store/paths/store_customers_me_addresses_{address_id}.yaml @@ -177,7 +177,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 @@ -234,6 +238,7 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: updateCustomerAddressesWorkflow + x-events: [] delete: operationId: DeleteCustomersMeAddressesAddress_id summary: Remove Customer's Address @@ -348,3 +353,4 @@ delete: '500': $ref: ../components/responses/500_error.yaml x-workflow: deleteCustomerAddressesWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/store/paths/store_orders.yaml b/www/apps/api-reference/specs/store/paths/store_orders.yaml index fbab819c9a..d6f35a2a69 100644 --- a/www/apps/api-reference/specs/store/paths/store_orders.yaml +++ b/www/apps/api-reference/specs/store/paths/store_orders.yaml @@ -198,3 +198,4 @@ get: - cookie_auth: [] - jwt_token: [] x-workflow: getOrdersListWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/store/paths/store_orders_{id}.yaml b/www/apps/api-reference/specs/store/paths/store_orders_{id}.yaml index 212b812f49..b96900469a 100644 --- a/www/apps/api-reference/specs/store/paths/store_orders_{id}.yaml +++ b/www/apps/api-reference/specs/store/paths/store_orders_{id}.yaml @@ -69,3 +69,4 @@ get: '500': $ref: ../components/responses/500_error.yaml x-workflow: getOrderDetailWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/store/paths/store_orders_{id}_transfer_accept.yaml b/www/apps/api-reference/specs/store/paths/store_orders_{id}_transfer_accept.yaml index 899084e429..a71d02b31e 100644 --- a/www/apps/api-reference/specs/store/paths/store_orders_{id}_transfer_accept.yaml +++ b/www/apps/api-reference/specs/store/paths/store_orders_{id}_transfer_accept.yaml @@ -82,3 +82,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: acceptOrderTransferWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/store/paths/store_orders_{id}_transfer_cancel.yaml b/www/apps/api-reference/specs/store/paths/store_orders_{id}_transfer_cancel.yaml index 0291d4db0f..117867da36 100644 --- a/www/apps/api-reference/specs/store/paths/store_orders_{id}_transfer_cancel.yaml +++ b/www/apps/api-reference/specs/store/paths/store_orders_{id}_transfer_cancel.yaml @@ -77,3 +77,4 @@ post: security: - cookie_auth: [] - jwt_token: [] + x-events: [] diff --git a/www/apps/api-reference/specs/store/paths/store_orders_{id}_transfer_decline.yaml b/www/apps/api-reference/specs/store/paths/store_orders_{id}_transfer_decline.yaml index 599e5e4e6b..664381d834 100644 --- a/www/apps/api-reference/specs/store/paths/store_orders_{id}_transfer_decline.yaml +++ b/www/apps/api-reference/specs/store/paths/store_orders_{id}_transfer_decline.yaml @@ -78,3 +78,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: declineOrderTransferRequestWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/store/paths/store_orders_{id}_transfer_request.yaml b/www/apps/api-reference/specs/store/paths/store_orders_{id}_transfer_request.yaml index a1e0ec0f66..184e39efb8 100644 --- a/www/apps/api-reference/specs/store/paths/store_orders_{id}_transfer_request.yaml +++ b/www/apps/api-reference/specs/store/paths/store_orders_{id}_transfer_request.yaml @@ -82,3 +82,4 @@ post: security: - cookie_auth: [] - jwt_token: [] + x-events: [] diff --git a/www/apps/api-reference/specs/store/paths/store_payment-collections.yaml b/www/apps/api-reference/specs/store/paths/store_payment-collections.yaml index 092b1cb438..382fa52b19 100644 --- a/www/apps/api-reference/specs/store/paths/store_payment-collections.yaml +++ b/www/apps/api-reference/specs/store/paths/store_payment-collections.yaml @@ -72,3 +72,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: createPaymentCollectionForCartWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_payment-sessions.yaml b/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_payment-sessions.yaml index 97dea219e8..39c8f7fc80 100644 --- a/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_payment-sessions.yaml +++ b/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_payment-sessions.yaml @@ -78,3 +78,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: createPaymentSessionsWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/store/paths/store_products.yaml b/www/apps/api-reference/specs/store/paths/store_products.yaml index 60b24e8695..8095964653 100644 --- a/www/apps/api-reference/specs/store/paths/store_products.yaml +++ b/www/apps/api-reference/specs/store/paths/store_products.yaml @@ -758,17 +758,21 @@ get: - name: province in: query description: >- - The province the products are being viewed from. This is useful to - narrow down the tax context when calculating product variant prices with - taxes. + The lower-case ISO 3166-2 province code the products are being viewed + from. This is useful to narrow down the tax context when calculating + product variant prices with taxes. required: false schema: type: string title: province description: >- - The province the products are being viewed from. This is useful to - narrow down the tax context when calculating product variant prices - with taxes. + The lower-case ISO 3166-2 province code the products are being viewed + from. This is useful to narrow down the tax context when calculating + product variant prices with taxes. + example: us-ca + externalDocs: + url: https://en.wikipedia.org/wiki/ISO_3166-2 + description: Learn more about ISO 3166-2 - name: sales_channel_id in: query required: false diff --git a/www/apps/api-reference/specs/store/paths/store_products_{id}.yaml b/www/apps/api-reference/specs/store/paths/store_products_{id}.yaml index f5e3e16314..54b4e1d9bb 100644 --- a/www/apps/api-reference/specs/store/paths/store_products_{id}.yaml +++ b/www/apps/api-reference/specs/store/paths/store_products_{id}.yaml @@ -73,16 +73,21 @@ get: - name: province in: query description: >- - The province the product is being viewed from. This is useful to narrow - down the tax context when calculating product variant prices with taxes. + The lower-case ISO 3166-2 province code the product is being viewed + from. This is useful to narrow down the tax context when calculating + product variant prices with taxes. required: false schema: type: string title: province description: >- - The province the product is being viewed from. This is useful to - narrow down the tax context when calculating product variant prices - with taxes. + The lower-case ISO 3166-2 province code the product is being viewed + from. This is useful to narrow down the tax context when calculating + product variant prices with taxes. + example: us-ca + externalDocs: + url: https://en.wikipedia.org/wiki/ISO_3166-2 + description: Learn more about ISO 3166-2 - name: cart_id in: query description: >- diff --git a/www/apps/api-reference/specs/store/paths/store_shipping-options.yaml b/www/apps/api-reference/specs/store/paths/store_shipping-options.yaml index 89554ee0f9..ff26d18ce6 100644 --- a/www/apps/api-reference/specs/store/paths/store_shipping-options.yaml +++ b/www/apps/api-reference/specs/store/paths/store_shipping-options.yaml @@ -147,3 +147,4 @@ get: '500': $ref: ../components/responses/500_error.yaml x-workflow: listShippingOptionsForCartWorkflow + x-events: [] diff --git a/www/apps/api-reference/specs/store/paths/store_shipping-options_{id}_calculate.yaml b/www/apps/api-reference/specs/store/paths/store_shipping-options_{id}_calculate.yaml index 6492ae49e6..082b7bf319 100644 --- a/www/apps/api-reference/specs/store/paths/store_shipping-options_{id}_calculate.yaml +++ b/www/apps/api-reference/specs/store/paths/store_shipping-options_{id}_calculate.yaml @@ -91,3 +91,4 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: calculateShippingOptionsPricesWorkflow + x-events: [] diff --git a/www/utils/generated/events-output.json b/www/utils/generated/events-output.json index 37ae0a9501..0533cf96c9 100644 --- a/www/utils/generated/events-output.json +++ b/www/utils/generated/events-output.json @@ -100,8 +100,8 @@ "payload": "```ts\n{\n id, // The ID of the order\n}\n```", "description": "Emitted when an order is placed, or when a draft order is converted to an\norder.", "workflows": [ - "completeCartWorkflow", "convertDraftOrderWorkflow", + "completeCartWorkflow", "processPaymentWorkflow" ], "deprecated": false @@ -143,7 +143,7 @@ "name": "order.fulfillment_created", "parentName": "OrderWorkflowEvents", "propertyName": "FULFILLMENT_CREATED", - "payload": "```ts\n{\n order_id, // The ID of the order\n fulfillment_id, // The ID of the fulfillment\n no_notification, // Whether to notify the customer\n}\n```", + "payload": "```ts\n{\n order_id, // The ID of the order\n fulfillment_id, // The ID of the fulfillment\n no_notification, // (boolean) Whether to notify the customer\n}\n```", "description": "Emitted when a fulfillment is created for an order.", "workflows": [ "createOrderFulfillmentWorkflow" @@ -154,7 +154,7 @@ "name": "order.fulfillment_canceled", "parentName": "OrderWorkflowEvents", "propertyName": "FULFILLMENT_CANCELED", - "payload": "```ts\n{\n order_id, // The ID of the order\n fulfillment_id, // The ID of the fulfillment\n no_notification, // Whether to notify the customer\n}\n```", + "payload": "```ts\n{\n order_id, // The ID of the order\n fulfillment_id, // The ID of the fulfillment\n no_notification, // (boolean) Whether to notify the customer\n}\n```", "description": "Emitted when an order's fulfillment is canceled.", "workflows": [ "cancelOrderFulfillmentWorkflow" @@ -222,7 +222,7 @@ "name": "order-edit.requested", "parentName": "OrderEditWorkflowEvents", "propertyName": "REQUESTED", - "payload": "```ts\n{\n order_id, // The ID of the order\n actions, // The actions to edit the order\n}\n```", + "payload": "```ts\n{\n order_id, // The ID of the order\n actions, // (array) The [actions](https://docs.medusajs.com/resources/references/fulfillment/interfaces/fulfillment.OrderChangeActionDTO) to edit the order\n}\n```", "description": "Emitted when an order edit is requested.", "workflows": [ "requestOrderEditRequestWorkflow" @@ -233,7 +233,7 @@ "name": "order-edit.confirmed", "parentName": "OrderEditWorkflowEvents", "propertyName": "CONFIRMED", - "payload": "```ts\n{\n order_id, // The ID of the order\n actions, // The actions to edit the order\n}\n```", + "payload": "```ts\n{\n order_id, // The ID of the order\n actions, // (array) The [actions](https://docs.medusajs.com/resources/references/fulfillment/interfaces/fulfillment.OrderChangeActionDTO) to edit the order\n```", "description": "Emitted when an order edit request is confirmed.", "workflows": [ "confirmOrderEditRequestWorkflow" @@ -244,7 +244,7 @@ "name": "order-edit.canceled", "parentName": "OrderEditWorkflowEvents", "propertyName": "CANCELED", - "payload": "```ts\n{\n order_id, // The ID of the order\n actions, // The actions to edit the order\n}\n```", + "payload": "```ts\n{\n order_id, // The ID of the order\n actions, // (array) The [actions](https://docs.medusajs.com/resources/references/fulfillment/interfaces/fulfillment.OrderChangeActionDTO) to edit the order\n}\n```", "description": "Emitted when an order edit request is canceled.", "workflows": [ "cancelBeginOrderEditWorkflow" @@ -655,7 +655,7 @@ "name": "shipment.created", "parentName": "FulfillmentWorkflowEvents", "propertyName": "SHIPMENT_CREATED", - "payload": "```ts\n{\n id, // the ID of the shipment\n no_notification, // whether to notify the customer\n}\n```", + "payload": "```ts\n{\n id, // the ID of the shipment\n no_notification, // (boolean) whether to notify the customer\n}\n```", "description": "Emitted when a shipment is created for an order.", "workflows": [ "createOrderShipmentWorkflow" diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_api-keys_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_api-keys_[id].ts index cc5b395171..c21591c2fb 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_api-keys_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_api-keys_[id].ts @@ -80,6 +80,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: deleteApiKeysWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_campaigns_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_campaigns_[id].ts index fd0ee1d658..4ec98d25bb 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_campaigns_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_campaigns_[id].ts @@ -80,6 +80,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: deleteCampaignsWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_claim-items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_claim-items_[action_id].ts index 3fb9e2b13b..38cf69af8c 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_claim-items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_claim-items_[action_id].ts @@ -85,6 +85,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: removeItemClaimActionWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_inbound_items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_inbound_items_[action_id].ts index 23265055b9..4040327f7a 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_inbound_items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_inbound_items_[action_id].ts @@ -71,6 +71,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: removeItemReturnActionWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_inbound_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_inbound_shipping-method_[action_id].ts index 5f478bd576..e6b7b7bf51 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_inbound_shipping-method_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_inbound_shipping-method_[action_id].ts @@ -71,6 +71,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: removeClaimShippingMethodWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_outbound_items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_outbound_items_[action_id].ts index ddb59004b6..e1ac7591e2 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_outbound_items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_outbound_items_[action_id].ts @@ -83,6 +83,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: removeAddItemClaimActionWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_outbound_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_outbound_shipping-method_[action_id].ts index 7b40dd11ca..b3c58734f6 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_outbound_shipping-method_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_outbound_shipping-method_[action_id].ts @@ -83,6 +83,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: removeClaimShippingMethodWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_request.ts b/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_request.ts index c1c9faa8ea..ee17b7f547 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_request.ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_request.ts @@ -62,6 +62,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: cancelBeginOrderClaimWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_collections_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_collections_[id].ts index c528e6bb94..a11d26ac22 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_collections_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_collections_[id].ts @@ -60,6 +60,16 @@ * "500": * $ref: "#/components/responses/500_error" * 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 * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_customer-groups_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_customer-groups_[id].ts index 02485e0363..bb11c3d2c9 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_customer-groups_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_customer-groups_[id].ts @@ -79,6 +79,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: deleteCustomerGroupsWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_customers_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_customers_[id].ts index 35dfbb8ac9..2c08a71ec9 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_customers_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_customers_[id].ts @@ -78,6 +78,16 @@ * "500": * $ref: "#/components/responses/500_error" * 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 * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_customers_[id]_addresses_[address_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_customers_[id]_addresses_[address_id].ts index 722beaca2b..aad6629527 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_customers_[id]_addresses_[address_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_customers_[id]_addresses_[address_id].ts @@ -103,6 +103,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: deleteCustomerAddressesWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_draft-orders_[id]_edit.ts b/www/utils/generated/oas-output/operations/admin/delete_admin_draft-orders_[id]_edit.ts index 226a2a3b32..5a1b4119f3 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_draft-orders_[id]_edit.ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_draft-orders_[id]_edit.ts @@ -57,6 +57,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: cancelDraftOrderEditWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_draft-orders_[id]_edit_items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_draft-orders_[id]_edit_items_[action_id].ts index 1505c4a7d9..0cc16e2f19 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_draft-orders_[id]_edit_items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_draft-orders_[id]_edit_items_[action_id].ts @@ -66,6 +66,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: removeDraftOrderActionItemWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_draft-orders_[id]_edit_promotions.ts b/www/utils/generated/oas-output/operations/admin/delete_admin_draft-orders_[id]_edit_promotions.ts index 34f1501923..1f3be33378 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_draft-orders_[id]_edit_promotions.ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_draft-orders_[id]_edit_promotions.ts @@ -65,6 +65,7 @@ * application/json: * schema: * $ref: "#/components/schemas/AdminRemoveDraftOrderPromotions" + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_draft-orders_[id]_edit_shipping-methods_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_draft-orders_[id]_edit_shipping-methods_[action_id].ts index 0ee716f053..b34db8ee24 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_draft-orders_[id]_edit_shipping-methods_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_draft-orders_[id]_edit_shipping-methods_[action_id].ts @@ -66,6 +66,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: removeDraftOrderActionShippingMethodWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_draft-orders_[id]_edit_shipping-methods_method_[method_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_draft-orders_[id]_edit_shipping-methods_method_[method_id].ts index 7338f09e10..70de706ed8 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_draft-orders_[id]_edit_shipping-methods_method_[method_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_draft-orders_[id]_edit_shipping-methods_method_[method_id].ts @@ -66,6 +66,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: removeDraftOrderShippingMethodWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_inbound_items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_inbound_items_[action_id].ts index 2875f15eed..dc9a1afdb4 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_inbound_items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_inbound_items_[action_id].ts @@ -71,6 +71,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: removeItemReturnActionWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_inbound_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_inbound_shipping-method_[action_id].ts index 4328efd403..e572e64c98 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_inbound_shipping-method_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_inbound_shipping-method_[action_id].ts @@ -71,6 +71,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: removeReturnShippingMethodWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_outbound_items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_outbound_items_[action_id].ts index 69899f6dc7..e06405058d 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_outbound_items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_outbound_items_[action_id].ts @@ -83,6 +83,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: removeItemExchangeActionWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_outbound_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_outbound_shipping-method_[action_id].ts index b826e1cf99..ed6621207a 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_outbound_shipping-method_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_outbound_shipping-method_[action_id].ts @@ -83,6 +83,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: removeExchangeShippingMethodWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_request.ts b/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_request.ts index a9d80986a8..c359df79ce 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_request.ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_request.ts @@ -60,6 +60,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: cancelBeginOrderExchangeWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_fulfillment-sets_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_fulfillment-sets_[id].ts index fd1390f0c6..ea65f09bd2 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_fulfillment-sets_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_fulfillment-sets_[id].ts @@ -60,6 +60,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: deleteFulfillmentSetsWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts index 0c951943ce..98abd16189 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts @@ -68,6 +68,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: deleteServiceZonesWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_inventory-items_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_inventory-items_[id].ts index e860cd66bb..d55fe87d68 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_inventory-items_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_inventory-items_[id].ts @@ -79,6 +79,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: deleteInventoryItemWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_inventory-items_[id]_location-levels_[location_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_inventory-items_[id]_location-levels_[location_id].ts index 92acef7bc8..2542612d56 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_inventory-items_[id]_location-levels_[location_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_inventory-items_[id]_location-levels_[location_id].ts @@ -108,6 +108,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: deleteInventoryLevelsWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_invites_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_invites_[id].ts index 2d9f7b9c82..3c85cf23ec 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_invites_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_invites_[id].ts @@ -77,6 +77,16 @@ * - 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 * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_order-edits_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_order-edits_[id].ts index bf069cd9a6..8ecee255a4 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_order-edits_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_order-edits_[id].ts @@ -79,6 +79,17 @@ * "500": * $ref: "#/components/responses/500_error" * 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 * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_order-edits_[id]_items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_order-edits_[id]_items_[action_id].ts index c602bb84e8..bb79a06110 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_order-edits_[id]_items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_order-edits_[id]_items_[action_id].ts @@ -73,6 +73,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: removeItemOrderEditActionWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_order-edits_[id]_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_order-edits_[id]_shipping-method_[action_id].ts index 9eb240e708..38b514fa33 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_order-edits_[id]_shipping-method_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_order-edits_[id]_shipping-method_[action_id].ts @@ -53,6 +53,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: removeOrderEditShippingMethodWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_payment-collections_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_payment-collections_[id].ts index 439457465d..baa71250e9 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_payment-collections_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_payment-collections_[id].ts @@ -60,6 +60,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: deleteOrderPaymentCollections + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_price-lists_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_price-lists_[id].ts index f8e9ecff45..af98fcc7b4 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_price-lists_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_price-lists_[id].ts @@ -60,6 +60,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: deletePriceListsWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_price-preferences_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_price-preferences_[id].ts index 0bb194a480..30dab1bf47 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_price-preferences_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_price-preferences_[id].ts @@ -60,6 +60,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: deletePricePreferencesWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_product-categories_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_product-categories_[id].ts index 5abd7e17a3..ad74513f27 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_product-categories_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_product-categories_[id].ts @@ -60,6 +60,16 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: deleteProductCategoriesWorkflow + * x-events: + * - name: product-category.deleted + * payload: |- + * ```ts + * [{ + * id, // The ID of the product category + * }] + * ``` + * description: Emitted when product categories are deleted. + * deprecated: false * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_product-tags_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_product-tags_[id].ts index 75c5380153..d2d92356b6 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_product-tags_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_product-tags_[id].ts @@ -60,6 +60,16 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: deleteProductTagsWorkflow + * x-events: + * - name: product-tag.deleted + * payload: |- + * ```ts + * [{ + * id, // The ID of the product tag + * }] + * ``` + * description: Emitted when product tags are deleted. + * deprecated: false * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_product-types_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_product-types_[id].ts index 16712c4797..cb16ce52dc 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_product-types_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_product-types_[id].ts @@ -60,6 +60,16 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: deleteProductTypesWorkflow + * x-events: + * - name: product-type.deleted + * payload: |- + * ```ts + * [{ + * id, // The ID of the product type + * }] + * ``` + * description: Emitted when product types are deleted. + * deprecated: false * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id].ts index 19767978d7..76d86bf2a4 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id].ts @@ -60,6 +60,16 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: deleteProductsWorkflow + * x-events: + * - name: product.deleted + * payload: |- + * ```ts + * [{ + * id, // The ID of the product + * }] + * ``` + * description: Emitted when products are deleted. + * deprecated: false * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id]_options_[option_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id]_options_[option_id].ts index b2af5d2541..cfb0360b3b 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id]_options_[option_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id]_options_[option_id].ts @@ -82,6 +82,16 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: deleteProductOptionsWorkflow + * x-events: + * - name: product-option.deleted + * payload: |- + * ```ts + * [{ + * id, // The ID of the product option + * }] + * ``` + * description: Emitted when product options are deleted. + * deprecated: false * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id]_variants_[variant_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id]_variants_[variant_id].ts index 18ac2ba53a..b3c42457a3 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id]_variants_[variant_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id]_variants_[variant_id].ts @@ -79,6 +79,16 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: deleteProductVariantsWorkflow + * x-events: + * - name: product-variant.deleted + * payload: |- + * ```ts + * [{ + * id, // The ID of the product variant + * }] + * ``` + * description: Emitted when product variants are deleted. + * deprecated: false * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id]_variants_[variant_id]_inventory-items_[inventory_item_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id]_variants_[variant_id]_inventory-items_[inventory_item_id].ts index 80a9b725ea..b26ee9e920 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id]_variants_[variant_id]_inventory-items_[inventory_item_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id]_variants_[variant_id]_inventory-items_[inventory_item_id].ts @@ -68,6 +68,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: dismissLinksWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_promotions_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_promotions_[id].ts index c3e02d9bcb..98e54016bd 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_promotions_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_promotions_[id].ts @@ -79,6 +79,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: deletePromotionsWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_refund-reasons_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_refund-reasons_[id].ts index 7b4bea09b9..29b6400b4b 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_refund-reasons_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_refund-reasons_[id].ts @@ -62,6 +62,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: deleteRefundReasonsWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_regions_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_regions_[id].ts index 059afe2f76..8d42825545 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_regions_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_regions_[id].ts @@ -79,6 +79,16 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: deleteRegionsWorkflow + * x-events: + * - name: region.deleted + * payload: |- + * ```ts + * [{ + * id, // The ID of the region + * }] + * ``` + * description: Emitted when regions are deleted. + * deprecated: false * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_reservations_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_reservations_[id].ts index 1b90fbbf6b..b2cf3d31e3 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_reservations_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_reservations_[id].ts @@ -79,6 +79,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: deleteReservationsWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_return-reasons_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_return-reasons_[id].ts index bb585e4770..bfc0ebfab5 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_return-reasons_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_return-reasons_[id].ts @@ -60,6 +60,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: deleteReturnReasonsWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_dismiss-items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_dismiss-items_[action_id].ts index 4b292fcf3b..52594eb918 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_dismiss-items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_dismiss-items_[action_id].ts @@ -82,6 +82,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: removeItemReturnActionWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_receive-items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_receive-items_[action_id].ts index 5ea879c454..36d9b0cda9 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_receive-items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_receive-items_[action_id].ts @@ -82,6 +82,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: removeItemReceiveReturnActionWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_receive.ts b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_receive.ts index bbe82b60af..96030afec8 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_receive.ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_receive.ts @@ -79,6 +79,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: cancelReturnReceiveWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_request-items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_request-items_[action_id].ts index 5853cbc281..e3244ea144 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_request-items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_request-items_[action_id].ts @@ -82,6 +82,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: removeItemReturnActionWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_request.ts b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_request.ts index 579aa2066c..40f826bf8b 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_request.ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_request.ts @@ -79,6 +79,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: cancelReturnRequestWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_shipping-method_[action_id].ts index 99032d1988..d89552c4c0 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_shipping-method_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_shipping-method_[action_id].ts @@ -82,6 +82,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: removeReturnShippingMethodWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_sales-channels_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_sales-channels_[id].ts index a954a2bf86..d56ca2b805 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_sales-channels_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_sales-channels_[id].ts @@ -60,6 +60,16 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: deleteSalesChannelsWorkflow + * x-events: + * - name: sales-channel.deleted + * payload: |- + * ```ts + * [{ + * id, // The ID of the sales channel + * }] + * ``` + * description: Emitted when sales channels are deleted. + * deprecated: false * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_shipping-options_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_shipping-options_[id].ts index ccd0081bd5..ac39aad1d7 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_shipping-options_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_shipping-options_[id].ts @@ -60,6 +60,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: deleteShippingOptionsWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_shipping-profiles_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_shipping-profiles_[id].ts index 9cf24e4131..486028b2c4 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_shipping-profiles_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_shipping-profiles_[id].ts @@ -60,6 +60,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: deleteShippingProfileWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_stock-locations_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_stock-locations_[id].ts index b0514b630f..1efb59f653 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_stock-locations_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_stock-locations_[id].ts @@ -60,6 +60,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: deleteStockLocationsWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_tax-rates_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_tax-rates_[id].ts index 49abff3129..5808d5a8c1 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_tax-rates_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_tax-rates_[id].ts @@ -60,6 +60,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: deleteTaxRatesWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_tax-rates_[id]_rules_[rule_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_tax-rates_[id]_rules_[rule_id].ts index 3099453cfb..d85f45e0d2 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_tax-rates_[id]_rules_[rule_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_tax-rates_[id]_rules_[rule_id].ts @@ -87,6 +87,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: deleteTaxRateRulesWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_tax-regions_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_tax-regions_[id].ts index e4ad95a629..5a4e52fb1e 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_tax-regions_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_tax-regions_[id].ts @@ -60,6 +60,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: deleteTaxRegionsWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_uploads_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_uploads_[id].ts index cc7adb896c..4f6fa0ae2b 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_uploads_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_uploads_[id].ts @@ -79,6 +79,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: deleteFilesWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_users_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_users_[id].ts index 7a0bafe8ed..3b61f99198 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_users_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_users_[id].ts @@ -57,6 +57,16 @@ * security: * - cookie_auth: [] * - jwt_token: [] + * x-events: + * - name: user.deleted + * payload: |- + * ```ts + * [{ + * id, // The ID of the user + * }] + * ``` + * description: Emitted when users are deleted. + * deprecated: false * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses.ts b/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses.ts index 98b5a46517..08b070a23f 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses.ts @@ -111,7 +111,7 @@ * - type: string * title: province * description: Filter by an ISO 3166-2 province code. Must be lower-case. - * example: "us-ca" + * example: us-ca * externalDocs: * url: https://en.wikipedia.org/wiki/ISO_3166-2 * description: Learn more about ISO 3166-2 @@ -121,7 +121,7 @@ * type: string * title: province * description: A ISO 3166-2 province code. Must be lower-case. - * example: "us-ca" + * example: us-ca * externalDocs: * url: https://en.wikipedia.org/wiki/ISO_3166-2 * description: Learn more about ISO 3166-2 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_draft-orders.ts b/www/utils/generated/oas-output/operations/admin/get_admin_draft-orders.ts index 727d8943a4..d24a096890 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_draft-orders.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_draft-orders.ts @@ -1470,6 +1470,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: getOrdersListWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_draft-orders_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_draft-orders_[id].ts index f32a6d3c14..bc35bbed63 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_draft-orders_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_draft-orders_[id].ts @@ -74,6 +74,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: getOrderDetailWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_orders.ts b/www/utils/generated/oas-output/operations/admin/get_admin_orders.ts index 05670faba2..9c69330550 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_orders.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_orders.ts @@ -681,6 +681,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: getOrdersListWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_orders_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_orders_[id].ts index b2eeebb78b..f387df09eb 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_orders_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_orders_[id].ts @@ -120,6 +120,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: getOrderDetailWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_tax-regions.ts b/www/utils/generated/oas-output/operations/admin/get_admin_tax-regions.ts index 67dfc83033..67ecec5f96 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_tax-regions.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_tax-regions.ts @@ -134,7 +134,7 @@ * - type: string * title: province_code * description: Filter by a ISO 3166-2 province code. Must be lower-case. - * example: "us-ca" + * example: us-ca * externalDocs: * url: https://en.wikipedia.org/wiki/ISO_3166-2 * description: Learn more about ISO 3166-2 @@ -144,7 +144,7 @@ * type: string * title: province_code * description: A ISO 3166-2 province code. - * example: "us-ca" + * example: us-ca * externalDocs: * url: https://en.wikipedia.org/wiki/ISO_3166-2 * description: Learn more about ISO 3166-2 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_api-keys.ts b/www/utils/generated/oas-output/operations/admin/post_admin_api-keys.ts index 7907dbc946..3e0a35de9b 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_api-keys.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_api-keys.ts @@ -70,6 +70,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: createApiKeysWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id].ts index 0f9347a08d..a5c7d6a545 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id].ts @@ -83,6 +83,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: updateApiKeysWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id]_revoke.ts b/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id]_revoke.ts index 85d9b91c0c..cf72b726ca 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id]_revoke.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id]_revoke.ts @@ -78,6 +78,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: revokeApiKeysWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id]_sales-channels.ts b/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id]_sales-channels.ts index 361816b9ed..bfdfcfc00d 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id]_sales-channels.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id]_sales-channels.ts @@ -97,6 +97,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: linkSalesChannelsToApiKeyWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_campaigns.ts b/www/utils/generated/oas-output/operations/admin/post_admin_campaigns.ts index 1d2d854a48..f07a4e82f6 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_campaigns.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_campaigns.ts @@ -158,6 +158,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: createCampaignsWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_campaigns_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_campaigns_[id].ts index 07c4a4b1cc..73baf38a6b 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_campaigns_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_campaigns_[id].ts @@ -144,6 +144,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: updateCampaignsWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_campaigns_[id]_promotions.ts b/www/utils/generated/oas-output/operations/admin/post_admin_campaigns_[id]_promotions.ts index 95e894e142..7e37e264ee 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_campaigns_[id]_promotions.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_campaigns_[id]_promotions.ts @@ -97,6 +97,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: addOrRemoveCampaignPromotionsWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims.ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims.ts index 84ccf8db59..0415bca930 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims.ts @@ -80,6 +80,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: beginClaimOrderWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_cancel.ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_cancel.ts index 8fcf17900e..fc0d99393d 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_cancel.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_cancel.ts @@ -65,6 +65,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: cancelOrderClaimWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_claim-items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_claim-items.ts index b6391f6b84..193de3a3b9 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_claim-items.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_claim-items.ts @@ -85,6 +85,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: orderClaimItemWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_claim-items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_claim-items_[action_id].ts index 172a0b1b71..28a58e97e3 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_claim-items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_claim-items_[action_id].ts @@ -92,6 +92,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: updateClaimItemWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_items.ts index 4f529722a4..04f38d4cdd 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_items.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_items.ts @@ -77,6 +77,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: orderClaimRequestItemReturnWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_items_[action_id].ts index 37a85835be..41acf8543c 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_items_[action_id].ts @@ -81,6 +81,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: updateRequestItemReturnWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_shipping-method.ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_shipping-method.ts index 4930925915..004198393b 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_shipping-method.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_shipping-method.ts @@ -77,6 +77,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: createClaimShippingMethodWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_shipping-method_[action_id].ts index 55c1014c8b..733813fca4 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_shipping-method_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_shipping-method_[action_id].ts @@ -93,6 +93,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: updateReturnShippingMethodWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_items.ts index 2404c45c37..f44b227ee5 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_items.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_items.ts @@ -87,6 +87,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: orderClaimAddNewItemWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_items_[action_id].ts index bab7b98fb9..1f622a44a8 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_items_[action_id].ts @@ -93,6 +93,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: updateClaimAddItemWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_shipping-method.ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_shipping-method.ts index fc924f6585..592432b417 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_shipping-method.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_shipping-method.ts @@ -89,6 +89,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: createClaimShippingMethodWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_shipping-method_[action_id].ts index 1fb2a334d8..9aa46029a6 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_shipping-method_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_shipping-method_[action_id].ts @@ -93,6 +93,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: updateClaimShippingMethodWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_request.ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_request.ts index b37e776a13..c0ee80caca 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_request.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_request.ts @@ -76,6 +76,17 @@ * "500": * $ref: "#/components/responses/500_error" * 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 * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_collections.ts b/www/utils/generated/oas-output/operations/admin/post_admin_collections.ts index 38b0967a70..73edcba80a 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_collections.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_collections.ts @@ -78,6 +78,16 @@ * "500": * $ref: "#/components/responses/500_error" * 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 * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_collections_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_collections_[id].ts index 7a11fc59b4..171d87e1b5 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_collections_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_collections_[id].ts @@ -83,6 +83,16 @@ * "500": * $ref: "#/components/responses/500_error" * 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 * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_collections_[id]_products.ts b/www/utils/generated/oas-output/operations/admin/post_admin_collections_[id]_products.ts index 09597d9ded..a80e5bd0a4 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_collections_[id]_products.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_collections_[id]_products.ts @@ -97,6 +97,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: batchLinkProductsToCollectionWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups.ts b/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups.ts index 7a96624a22..764a7c877b 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups.ts @@ -78,6 +78,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: createCustomerGroupsWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups_[id].ts index da883ff5aa..183371150a 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups_[id].ts @@ -84,6 +84,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: updateCustomerGroupsWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups_[id]_customers.ts b/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups_[id]_customers.ts index e69700c66f..5f1bcbaaaf 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups_[id]_customers.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups_[id]_customers.ts @@ -97,6 +97,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: linkCustomersToCustomerGroupWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_customers.ts b/www/utils/generated/oas-output/operations/admin/post_admin_customers.ts index 31cd490a87..60709665c3 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_customers.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_customers.ts @@ -125,6 +125,16 @@ * "500": * $ref: "#/components/responses/500_error" * 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 * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id].ts index db157864b2..4448508c21 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id].ts @@ -131,6 +131,16 @@ * "500": * $ref: "#/components/responses/500_error" * 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 * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses.ts b/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses.ts index af25f9f126..4f16f9dcc7 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses.ts @@ -95,7 +95,7 @@ * type: string * title: province * description: The address's ISO 3166-2 province code. Must be lower-case. - * example: "us-ca" + * example: us-ca * externalDocs: * url: https://en.wikipedia.org/wiki/ISO_3166-2 * description: Learn more about ISO 3166-2 @@ -182,6 +182,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: createCustomerAddressesWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses_[address_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses_[address_id].ts index 2e5f168a7a..bd70e9cc40 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses_[address_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses_[address_id].ts @@ -101,7 +101,7 @@ * type: string * title: province * description: The address's ISO 3166-2 province code. Must be lower-case. - * example: "us-ca" + * example: us-ca * externalDocs: * url: https://en.wikipedia.org/wiki/ISO_3166-2 * description: Learn more about ISO 3166-2 @@ -188,6 +188,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: updateCustomerAddressesWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_customer-groups.ts b/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_customer-groups.ts index b57fd14150..4a7ea9e370 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_customer-groups.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_customer-groups.ts @@ -101,6 +101,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: linkCustomerGroupsToCustomerWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders.ts b/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders.ts index 00c386aab3..c0c15940d0 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders.ts @@ -108,7 +108,7 @@ * type: string * title: province * description: The billing address's ISO 3166-2 province code. Must be lower-case. - * example: "us-ca" + * example: us-ca * externalDocs: * url: https://en.wikipedia.org/wiki/ISO_3166-2 * description: Learn more about ISO 3166-2 @@ -171,7 +171,7 @@ * type: string * title: province * description: The shipping address's ISO 3166-2 province code. Must be lower-case. - * example: "us-ca" + * example: us-ca * externalDocs: * url: https://en.wikipedia.org/wiki/ISO_3166-2 * description: Learn more about ISO 3166-2 @@ -393,6 +393,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: createOrderWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id].ts index 7b0f2f103c..e639cf4dc9 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id].ts @@ -2,7 +2,8 @@ * @oas [post] /admin/draft-orders/{id} * operationId: PostDraftOrdersId * summary: Update a Draft Order - * description: Update a draft order's details. This doesn't include updating the draft order's items, shipping methods, or promotions. To update those, you need to create an edit that you can later request or confirm. + * description: Update a draft order's details. This doesn't include updating the draft order's items, shipping methods, or promotions. To update those, you need to create an edit that you can later + * request or confirm. * x-authenticated: true * parameters: * - name: id @@ -81,6 +82,18 @@ * "500": * $ref: "#/components/responses/500_error" * 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 * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id]_convert-to-order.ts b/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id]_convert-to-order.ts index dcc17bfdd6..ca2b50672b 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id]_convert-to-order.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id]_convert-to-order.ts @@ -71,6 +71,18 @@ * "500": * $ref: "#/components/responses/500_error" * 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 * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id]_edit.ts b/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id]_edit.ts index 2dfbe50c37..1433c8167b 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id]_edit.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id]_edit.ts @@ -3,7 +3,8 @@ * operationId: PostDraftOrdersIdEdit * summary: Create a Draft Order Edit * x-sidebar-summary: Create Edit - * description: Create an edit on a draft order. This will allow you to make changes to the draft order's items, shipping methods, or promotions. Once you've made the necessar changes, you can later either request the edit (which requires a confirmation from the customer), or force-confirm the edit. + * description: Create an edit on a draft order. This will allow you to make changes to the draft order's items, shipping methods, or promotions. Once you've made the necessar changes, you can later + * either request the edit (which requires a confirmation from the customer), or force-confirm the edit. * x-authenticated: true * parameters: * - name: id @@ -57,6 +58,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: beginDraftOrderEditWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id]_edit_confirm.ts b/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id]_edit_confirm.ts index f20c245efa..33ee4d02aa 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id]_edit_confirm.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id]_edit_confirm.ts @@ -57,6 +57,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: confirmDraftOrderEditWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id]_edit_items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id]_edit_items.ts index 439570dcb6..cb8d6213b0 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id]_edit_items.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id]_edit_items.ts @@ -69,6 +69,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: addDraftOrderItemsWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id]_edit_items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id]_edit_items_[action_id].ts index b437374625..401bc6f569 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id]_edit_items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id]_edit_items_[action_id].ts @@ -77,6 +77,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: updateDraftOrderActionItemWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id]_edit_items_item_[item_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id]_edit_items_item_[item_id].ts index ed28a8c3dc..b21f222dd7 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id]_edit_items_item_[item_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id]_edit_items_item_[item_id].ts @@ -74,6 +74,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: updateDraftOrderItemWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id]_edit_promotions.ts b/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id]_edit_promotions.ts index d317bb7f58..188f7f6130 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id]_edit_promotions.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id]_edit_promotions.ts @@ -74,6 +74,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: addDraftOrderPromotionWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id]_edit_request.ts b/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id]_edit_request.ts index 196f8eeef1..5431ff422f 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id]_edit_request.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id]_edit_request.ts @@ -57,6 +57,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: requestDraftOrderEditWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id]_edit_shipping-methods.ts b/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id]_edit_shipping-methods.ts index 77d5baaaaa..abd68fb43e 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id]_edit_shipping-methods.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id]_edit_shipping-methods.ts @@ -68,6 +68,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: addDraftOrderShippingMethodsWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id]_edit_shipping-methods_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id]_edit_shipping-methods_[action_id].ts index 074020368d..fbefccc9c8 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id]_edit_shipping-methods_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id]_edit_shipping-methods_[action_id].ts @@ -77,6 +77,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: updateDraftOrderActionShippingMethodWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id]_edit_shipping-methods_method_[method_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id]_edit_shipping-methods_method_[method_id].ts index 04ec4d89e6..12dbbbf3f3 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id]_edit_shipping-methods_method_[method_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id]_edit_shipping-methods_method_[method_id].ts @@ -70,6 +70,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: updateDraftOrderShippingMethodWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges.ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges.ts index b628d2644b..626c94a5ac 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges.ts @@ -78,6 +78,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: beginExchangeOrderWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_cancel.ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_cancel.ts index d586f3ef8d..c7b03b3a4f 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_cancel.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_cancel.ts @@ -65,6 +65,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: cancelOrderExchangeWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_items.ts index 81e8e24aca..4b9f8a64ce 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_items.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_items.ts @@ -71,6 +71,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: orderExchangeRequestItemReturnWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_items_[action_id].ts index 3ed653db39..a0d4111d4f 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_items_[action_id].ts @@ -81,6 +81,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: updateRequestItemReturnWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_shipping-method.ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_shipping-method.ts index 3c2fb5f0d4..3df35965ab 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_shipping-method.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_shipping-method.ts @@ -72,6 +72,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: createExchangeShippingMethodWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_shipping-method_[action_id].ts index 22e358c50d..b1ecda94e1 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_shipping-method_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_shipping-method_[action_id].ts @@ -93,6 +93,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: updateReturnShippingMethodWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_items.ts index c6edaf3891..76affc5037 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_items.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_items.ts @@ -82,6 +82,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: orderExchangeAddNewItemWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_items_[action_id].ts index 45b9975f01..08bfa47c25 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_items_[action_id].ts @@ -93,6 +93,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: updateExchangeAddItemWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_shipping-method.ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_shipping-method.ts index 0be11a5090..d3084a43d3 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_shipping-method.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_shipping-method.ts @@ -84,6 +84,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: createExchangeShippingMethodWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_shipping-method_[action_id].ts index 2da4b5e600..abc991a09d 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_shipping-method_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_shipping-method_[action_id].ts @@ -93,6 +93,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: updateExchangeShippingMethodWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_request.ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_request.ts index 7a083038d9..0fd2844864 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_request.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_request.ts @@ -72,6 +72,17 @@ * "500": * $ref: "#/components/responses/500_error" * 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 * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_fulfillment-sets_[id]_service-zones.ts b/www/utils/generated/oas-output/operations/admin/post_admin_fulfillment-sets_[id]_service-zones.ts index a8b4fec005..bb0bc95f5a 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_fulfillment-sets_[id]_service-zones.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_fulfillment-sets_[id]_service-zones.ts @@ -89,7 +89,7 @@ * type: string * title: province_code * description: The geo zone's ISO 3166-2 province code. Must be lower-case. - * example: "us-ca" + * example: us-ca * externalDocs: * url: https://en.wikipedia.org/wiki/ISO_3166-2 * description: Learn more about ISO 3166-2 @@ -118,7 +118,7 @@ * type: string * title: province_code * description: The geo zone's ISO 3166-2 province code. Must be lower-case. - * example: "us-ca" + * example: us-ca * externalDocs: * url: https://en.wikipedia.org/wiki/ISO_3166-2 * description: Learn more about ISO 3166-2 @@ -152,7 +152,7 @@ * type: string * title: province_code * description: The geo zone's ISO 3166-2 province code. Must be lower-case. - * example: "us-ca" + * example: us-ca * externalDocs: * url: https://en.wikipedia.org/wiki/ISO_3166-2 * description: Learn more about ISO 3166-2 @@ -218,6 +218,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: createServiceZonesWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts index 144756db6f..f5db41e208 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts @@ -97,7 +97,7 @@ * type: string * title: province_code * description: The geo zone's ISO 3166-2 province code. Must be lower-case. - * example: "us-ca" + * example: us-ca * externalDocs: * url: https://en.wikipedia.org/wiki/ISO_3166-2 * description: Learn more about ISO 3166-2 @@ -134,7 +134,7 @@ * type: string * title: province_code * description: The geo zone's ISO 3166-2 province code. Must be lower-case. - * example: "us-ca" + * example: us-ca * externalDocs: * url: https://en.wikipedia.org/wiki/ISO_3166-2 * description: Learn more about ISO 3166-2 @@ -172,7 +172,7 @@ * type: string * title: province_code * description: The geo zone's ISO 3166-2 province code. Must be lower-case. - * example: "us-ca" + * example: us-ca * externalDocs: * url: https://en.wikipedia.org/wiki/ISO_3166-2 * description: Learn more about ISO 3166-2 @@ -238,6 +238,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: updateServiceZonesWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments.ts b/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments.ts index d898f73ae9..054c9c1585 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments.ts @@ -132,6 +132,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: createFulfillmentWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments_[id]_cancel.ts b/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments_[id]_cancel.ts index 018d663fa5..914921a908 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments_[id]_cancel.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments_[id]_cancel.ts @@ -75,6 +75,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: cancelFulfillmentWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments_[id]_shipment.ts b/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments_[id]_shipment.ts index ce74a48287..05e119873d 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments_[id]_shipment.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments_[id]_shipment.ts @@ -96,6 +96,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: createShipmentWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items.ts index abdca1bedb..0e655890bb 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items.ts @@ -89,6 +89,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: createInventoryItemsWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id].ts index 0dfa3b0aae..17c2483d62 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id].ts @@ -152,6 +152,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: updateInventoryItemsWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels.ts b/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels.ts index 31424d0304..43bb548fec 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels.ts @@ -81,6 +81,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: createInventoryLevelsWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels_[location_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels_[location_id].ts index 8a325bac89..2a90b3ca40 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels_[location_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels_[location_id].ts @@ -100,6 +100,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: updateInventoryLevelsWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels_batch.ts b/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels_batch.ts index e9c12ae38f..07f1734853 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels_batch.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels_batch.ts @@ -68,6 +68,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: batchInventoryItemLevelsWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_location-levels_batch.ts b/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_location-levels_batch.ts index a3b1f98e3c..a317d74122 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_location-levels_batch.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_location-levels_batch.ts @@ -87,6 +87,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: batchInventoryItemLevelsWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_invites.ts b/www/utils/generated/oas-output/operations/admin/post_admin_invites.ts index bb1539d93f..646fc6c61e 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_invites.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_invites.ts @@ -88,6 +88,18 @@ * - 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 * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_invites_[id]_resend.ts b/www/utils/generated/oas-output/operations/admin/post_admin_invites_[id]_resend.ts index c4939a3685..dac831b4ed 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_invites_[id]_resend.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_invites_[id]_resend.ts @@ -70,6 +70,19 @@ * - 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 * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_invites_accept.ts b/www/utils/generated/oas-output/operations/admin/post_admin_invites_accept.ts index 93d68d5496..105e74ba69 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_invites_accept.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_invites_accept.ts @@ -106,6 +106,25 @@ * 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 * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_order-edits.ts b/www/utils/generated/oas-output/operations/admin/post_admin_order-edits.ts index 844ce8c004..f2ae3be345 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_order-edits.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_order-edits.ts @@ -65,6 +65,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: beginOrderEditOrderWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_confirm.ts b/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_confirm.ts index 4f05531f18..d79ea43caa 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_confirm.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_confirm.ts @@ -60,6 +60,16 @@ * "500": * $ref: "#/components/responses/500_error" * 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 * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_items.ts index 8a382431d8..96db933d25 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_items.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_items.ts @@ -73,6 +73,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: orderEditAddNewItemWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_items_[action_id].ts index e5ca36ffb8..c7fa0c695c 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_items_[action_id].ts @@ -81,6 +81,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: updateOrderEditAddItemWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_items_item_[item_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_items_item_[item_id].ts index 50da738012..07a65c9ed6 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_items_item_[item_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_items_item_[item_id].ts @@ -82,6 +82,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: orderEditUpdateItemQuantityWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_request.ts b/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_request.ts index 6838cea330..3cdd58e3d7 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_request.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_request.ts @@ -60,6 +60,17 @@ * "500": * $ref: "#/components/responses/500_error" * 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 * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_shipping-method.ts b/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_shipping-method.ts index b51410d791..cdfb2c6821 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_shipping-method.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_shipping-method.ts @@ -53,6 +53,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: createOrderEditShippingMethodWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_shipping-method_[action_id].ts index 9fa6c6aff6..8d97ddac38 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_shipping-method_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_shipping-method_[action_id].ts @@ -58,6 +58,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: updateOrderEditShippingMethodWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id].ts index c3f73533d9..e3ee713cf9 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id].ts @@ -89,6 +89,18 @@ * "500": * $ref: "#/components/responses/500_error" * 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 * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_archive.ts b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_archive.ts index 07f1b531f7..e2c5e555aa 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_archive.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_archive.ts @@ -59,6 +59,16 @@ * "500": * $ref: "#/components/responses/500_error" * 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 * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_cancel.ts b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_cancel.ts index 40b3c57e40..fe59258fed 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_cancel.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_cancel.ts @@ -80,6 +80,16 @@ * "500": * $ref: "#/components/responses/500_error" * 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 * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_complete.ts b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_complete.ts index 146300b28f..1e34513f38 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_complete.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_complete.ts @@ -69,6 +69,16 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: completeOrderWorkflow + * x-events: + * - name: order.completed + * payload: |- + * ```ts + * [{ + * id, // The ID of the order + * }] + * ``` + * description: Emitted when orders are completed. + * deprecated: false * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_credit-lines.ts b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_credit-lines.ts index ba6da0228d..267386fbcc 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_credit-lines.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_credit-lines.ts @@ -93,6 +93,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: createOrderCreditLinesWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments.ts b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments.ts index 6f4013d015..ffe4e1ab9b 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments.ts @@ -139,6 +139,18 @@ * "500": * $ref: "#/components/responses/500_error" * 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 * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments_[fulfillment_id]_cancel.ts b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments_[fulfillment_id]_cancel.ts index 51a64dc457..6c6f50ad02 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments_[fulfillment_id]_cancel.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments_[fulfillment_id]_cancel.ts @@ -103,6 +103,18 @@ * "500": * $ref: "#/components/responses/500_error" * 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 * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments_[fulfillment_id]_mark-as-delivered.ts b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments_[fulfillment_id]_mark-as-delivered.ts index d3940ec4ec..aa65eefe64 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments_[fulfillment_id]_mark-as-delivered.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments_[fulfillment_id]_mark-as-delivered.ts @@ -82,6 +82,16 @@ * "500": * $ref: "#/components/responses/500_error" * 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 * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments_[fulfillment_id]_shipments.ts b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments_[fulfillment_id]_shipments.ts index b8c7eef293..6b4e5a8b06 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments_[fulfillment_id]_shipments.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments_[fulfillment_id]_shipments.ts @@ -166,6 +166,17 @@ * "500": * $ref: "#/components/responses/500_error" * 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 * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_transfer.ts b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_transfer.ts index 31326e1561..cedbcb45fa 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_transfer.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_transfer.ts @@ -88,6 +88,19 @@ * "500": * $ref: "#/components/responses/500_error" * 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 * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_transfer_cancel.ts b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_transfer_cancel.ts index 4797cbe0ab..4d0aad00cd 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_transfer_cancel.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_transfer_cancel.ts @@ -75,6 +75,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: cancelOrderTransferRequestWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_payment-collections.ts b/www/utils/generated/oas-output/operations/admin/post_admin_payment-collections.ts index 80b1bbf8c0..32c83d9fdc 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_payment-collections.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_payment-collections.ts @@ -90,6 +90,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: createOrderPaymentCollectionWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_payment-collections_[id]_mark-as-paid.ts b/www/utils/generated/oas-output/operations/admin/post_admin_payment-collections_[id]_mark-as-paid.ts index ff48f77386..94a5c5db27 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_payment-collections_[id]_mark-as-paid.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_payment-collections_[id]_mark-as-paid.ts @@ -92,6 +92,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: markPaymentCollectionAsPaid + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_payments_[id]_capture.ts b/www/utils/generated/oas-output/operations/admin/post_admin_payments_[id]_capture.ts index f0f7873651..3dc1a81a72 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_payments_[id]_capture.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_payments_[id]_capture.ts @@ -83,6 +83,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: capturePaymentWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_payments_[id]_refund.ts b/www/utils/generated/oas-output/operations/admin/post_admin_payments_[id]_refund.ts index 9f3011f8c1..aa71242c57 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_payments_[id]_refund.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_payments_[id]_refund.ts @@ -91,6 +91,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: refundPaymentWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_price-lists.ts b/www/utils/generated/oas-output/operations/admin/post_admin_price-lists.ts index 33d606e97e..0c2cd7d3b5 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_price-lists.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_price-lists.ts @@ -92,6 +92,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: createPriceListsWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_price-lists_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_price-lists_[id].ts index 74dab74c52..0fb10120e7 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_price-lists_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_price-lists_[id].ts @@ -85,6 +85,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: updatePriceListsWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_price-lists_[id]_prices_batch.ts b/www/utils/generated/oas-output/operations/admin/post_admin_price-lists_[id]_prices_batch.ts index de070668af..1fa028f34b 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_price-lists_[id]_prices_batch.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_price-lists_[id]_prices_batch.ts @@ -165,6 +165,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: batchPriceListPricesWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_price-lists_[id]_products.ts b/www/utils/generated/oas-output/operations/admin/post_admin_price-lists_[id]_products.ts index 92f1b4a2fb..2364a203aa 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_price-lists_[id]_products.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_price-lists_[id]_products.ts @@ -79,6 +79,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: batchPriceListPricesWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_price-preferences.ts b/www/utils/generated/oas-output/operations/admin/post_admin_price-preferences.ts index 0c17b781f2..3b0f5a9c5f 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_price-preferences.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_price-preferences.ts @@ -75,6 +75,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: createPricePreferencesWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_price-preferences_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_price-preferences_[id].ts index fc240aa8e2..7514677a5a 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_price-preferences_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_price-preferences_[id].ts @@ -79,6 +79,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: updatePricePreferencesWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_product-categories.ts b/www/utils/generated/oas-output/operations/admin/post_admin_product-categories.ts index 719a78114a..f391dffaf7 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_product-categories.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_product-categories.ts @@ -81,6 +81,16 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: createProductCategoriesWorkflow + * x-events: + * - name: product-category.created + * payload: |- + * ```ts + * [{ + * id, // The ID of the product category + * }] + * ``` + * description: Emitted when product categories are created. + * deprecated: false * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_product-categories_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_product-categories_[id].ts index 949c1b34c2..fc9b5d760a 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_product-categories_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_product-categories_[id].ts @@ -119,6 +119,16 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: updateProductCategoriesWorkflow + * x-events: + * - name: product-category.updated + * payload: |- + * ```ts + * [{ + * id, // The ID of the product category + * }] + * ``` + * description: Emitted when product categories are updated. + * deprecated: false * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_product-categories_[id]_products.ts b/www/utils/generated/oas-output/operations/admin/post_admin_product-categories_[id]_products.ts index cb4cb98d21..083934fa7e 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_product-categories_[id]_products.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_product-categories_[id]_products.ts @@ -99,6 +99,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: batchLinkProductsToCategoryWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_product-tags.ts b/www/utils/generated/oas-output/operations/admin/post_admin_product-tags.ts index 32f1b91d5b..f1a896c305 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_product-tags.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_product-tags.ts @@ -78,6 +78,16 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: createProductTagsWorkflow + * x-events: + * - name: product-tag.created + * payload: |- + * ```ts + * [{ + * id, // The ID of the product tag + * }] + * ``` + * description: Emitted when product tags are created. + * deprecated: false * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_product-tags_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_product-tags_[id].ts index 6d34225d3f..94269a1fea 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_product-tags_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_product-tags_[id].ts @@ -92,6 +92,16 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: updateProductTagsWorkflow + * x-events: + * - name: product-tag.updated + * payload: |- + * ```ts + * [{ + * id, // The ID of the product tag + * }] + * ``` + * description: Emitted when product tags are updated. + * deprecated: false * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_product-types.ts b/www/utils/generated/oas-output/operations/admin/post_admin_product-types.ts index a443a42ca9..80cf4ae0e9 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_product-types.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_product-types.ts @@ -78,6 +78,16 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: createProductTypesWorkflow + * x-events: + * - name: product-type.created + * payload: |- + * ```ts + * [{ + * id, // The ID of the product type + * }] + * ``` + * description: Emitted when product types are created. + * deprecated: false * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_product-types_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_product-types_[id].ts index 5d9097588e..bb433ddeba 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_product-types_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_product-types_[id].ts @@ -92,6 +92,16 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: updateProductTypesWorkflow + * x-events: + * - name: product-type.updated + * payload: |- + * ```ts + * [{ + * id, // The ID of the product type + * }] + * ``` + * description: Emitted when product types are updated. + * deprecated: false * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products.ts b/www/utils/generated/oas-output/operations/admin/post_admin_products.ts index 18793be1ed..d61a9e48f8 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products.ts @@ -105,6 +105,25 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: createProductsWorkflow + * x-events: + * - name: product-variant.created + * payload: |- + * ```ts + * [{ + * id, // The ID of the product variant + * }] + * ``` + * description: Emitted when product variants are created. + * deprecated: false + * - name: product.created + * payload: |- + * ```ts + * [{ + * id, // The ID of the product + * }] + * ``` + * description: Emitted when products are created. + * deprecated: false * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id].ts index 862fe2458d..e9ecfcec29 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id].ts @@ -87,6 +87,16 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: updateProductsWorkflow + * x-events: + * - name: product.updated + * payload: |- + * ```ts + * [{ + * id, // The ID of the product + * }] + * ``` + * description: Emitted when products are updated. + * deprecated: false * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_options.ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_options.ts index 3a9e679356..d6e3670291 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_options.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_options.ts @@ -56,7 +56,7 @@ * }) * * sdk.admin.product.createOption( - * "prod_123", + * "prod_123", * { * title: "Color", * values: ["Green", "Blue"] @@ -99,6 +99,16 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: createProductOptionsWorkflow + * x-events: + * - name: product-option.created + * payload: |- + * ```ts + * [{ + * id, // The ID of the product option + * }] + * ``` + * description: Emitted when product options are created. + * deprecated: false * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_options_[option_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_options_[option_id].ts index cc7c990ca3..710926640f 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_options_[option_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_options_[option_id].ts @@ -62,7 +62,7 @@ * }) * * sdk.admin.product.updateOption( - * "prod_123", + * "prod_123", * "prodopt_123", * { * title: "Color" @@ -98,6 +98,16 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: updateProductOptionsWorkflow + * x-events: + * - name: product-option.updated + * payload: |- + * ```ts + * [{ + * id, // The ID of the product option + * }] + * ``` + * description: Emitted when product options are updated. + * deprecated: false * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants.ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants.ts index f1db7865ae..f0efc53607 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants.ts @@ -102,6 +102,16 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: createProductVariantsWorkflow + * x-events: + * - name: product-variant.created + * payload: |- + * ```ts + * [{ + * id, // The ID of the product variant + * }] + * ``` + * description: Emitted when product variants are created. + * deprecated: false * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id].ts index 99fc38a653..698a8951a1 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id].ts @@ -62,7 +62,7 @@ * }) * * sdk.admin.product.updateVariant( - * "prod_123", + * "prod_123", * "variant_123", * { * title: "Blue Shirt", @@ -98,6 +98,16 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: updateProductVariantsWorkflow + * x-events: + * - name: product-variant.updated + * payload: |- + * ```ts + * [{ + * id, // The ID of the product variant + * }] + * ``` + * description: Emitted when product variants are updated. + * deprecated: false * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id]_inventory-items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id]_inventory-items.ts index ec5f09f499..daf46bb541 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id]_inventory-items.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id]_inventory-items.ts @@ -72,6 +72,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: createLinksWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id]_inventory-items_[inventory_item_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id]_inventory-items_[inventory_item_id].ts index b1deec9d98..0e6cdadce3 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id]_inventory-items_[inventory_item_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id]_inventory-items_[inventory_item_id].ts @@ -77,6 +77,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: updateLinksWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_batch.ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_batch.ts index a175a1bc02..26bc902fb8 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_batch.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_batch.ts @@ -95,6 +95,34 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: batchProductVariantsWorkflow + * x-events: + * - name: product-variant.updated + * payload: |- + * ```ts + * [{ + * id, // The ID of the product variant + * }] + * ``` + * description: Emitted when product variants are updated. + * deprecated: false + * - name: product-variant.created + * payload: |- + * ```ts + * [{ + * id, // The ID of the product variant + * }] + * ``` + * description: Emitted when product variants are created. + * deprecated: false + * - name: product-variant.deleted + * payload: |- + * ```ts + * [{ + * id, // The ID of the product variant + * }] + * ``` + * description: Emitted when product variants are deleted. + * deprecated: false * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_inventory-items_batch.ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_inventory-items_batch.ts index aea4b3a658..97eede9318 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_inventory-items_batch.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_inventory-items_batch.ts @@ -104,7 +104,7 @@ * }) * * sdk.admin.product.batchVariantInventoryItems( - * "prod_123", + * "prod_123", * { * create: [ * { @@ -158,6 +158,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: batchLinksWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_batch.ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_batch.ts index d6257f8a99..96b4ce927f 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_batch.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_batch.ts @@ -100,6 +100,43 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: batchProductsWorkflow + * x-events: + * - name: product-variant.created + * payload: |- + * ```ts + * [{ + * id, // The ID of the product variant + * }] + * ``` + * description: Emitted when product variants are created. + * deprecated: false + * - name: product.updated + * payload: |- + * ```ts + * [{ + * id, // The ID of the product + * }] + * ``` + * description: Emitted when products are updated. + * deprecated: false + * - name: product.created + * payload: |- + * ```ts + * [{ + * id, // The ID of the product + * }] + * ``` + * description: Emitted when products are created. + * deprecated: false + * - name: product.deleted + * payload: |- + * ```ts + * [{ + * id, // The ID of the product + * }] + * ``` + * description: Emitted when products are deleted. + * deprecated: false * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_export.ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_export.ts index 0991c6f6ef..a3f204b65b 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_export.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_export.ts @@ -72,6 +72,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: exportProductsWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_import.ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_import.ts index 30cde6296c..5b702745ea 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_import.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_import.ts @@ -60,6 +60,43 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: importProductsWorkflow + * x-events: + * - name: product-variant.created + * payload: |- + * ```ts + * [{ + * id, // The ID of the product variant + * }] + * ``` + * description: Emitted when product variants are created. + * deprecated: false + * - name: product.updated + * payload: |- + * ```ts + * [{ + * id, // The ID of the product + * }] + * ``` + * description: Emitted when products are updated. + * deprecated: false + * - name: product.created + * payload: |- + * ```ts + * [{ + * id, // The ID of the product + * }] + * ``` + * description: Emitted when products are created. + * deprecated: false + * - name: product.deleted + * payload: |- + * ```ts + * [{ + * id, // The ID of the product + * }] + * ``` + * description: Emitted when products are deleted. + * deprecated: false * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_promotions.ts b/www/utils/generated/oas-output/operations/admin/post_admin_promotions.ts index b93ee9dd6d..0a7737cc02 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_promotions.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_promotions.ts @@ -379,6 +379,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: createPromotionsWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id].ts index 5451b07a8a..7f606edbd1 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id].ts @@ -173,6 +173,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: updatePromotionsWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_buy-rules_batch.ts b/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_buy-rules_batch.ts index 34146a8342..6210110300 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_buy-rules_batch.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_buy-rules_batch.ts @@ -120,6 +120,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: batchPromotionRulesWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_rules_batch.ts b/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_rules_batch.ts index 7786cfef60..0f09673e10 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_rules_batch.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_rules_batch.ts @@ -120,6 +120,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: batchPromotionRulesWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_target-rules_batch.ts b/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_target-rules_batch.ts index ee4c5af341..68b3e025df 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_target-rules_batch.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_target-rules_batch.ts @@ -120,6 +120,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: batchPromotionRulesWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_refund-reasons.ts b/www/utils/generated/oas-output/operations/admin/post_admin_refund-reasons.ts index 80266690a0..5f81bf483f 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_refund-reasons.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_refund-reasons.ts @@ -59,6 +59,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: createRefundReasonsWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_refund-reasons_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_refund-reasons_[id].ts index 4ef8f04d25..9b8013d148 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_refund-reasons_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_refund-reasons_[id].ts @@ -74,6 +74,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: updateRefundReasonsWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_regions.ts b/www/utils/generated/oas-output/operations/admin/post_admin_regions.ts index ba0efb922a..43c3ee791f 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_regions.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_regions.ts @@ -80,6 +80,16 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: createRegionsWorkflow + * x-events: + * - name: region.created + * payload: |- + * ```ts + * [{ + * id, // The ID of the region + * }] + * ``` + * description: Emitted when regions are created. + * deprecated: false * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_regions_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_regions_[id].ts index 804bebba1e..f950abb283 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_regions_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_regions_[id].ts @@ -118,6 +118,16 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: updateRegionsWorkflow + * x-events: + * - name: region.updated + * payload: |- + * ```ts + * [{ + * id, // The ID of the region + * }] + * ``` + * description: Emitted when regions are updated. + * deprecated: false * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_reservations.ts b/www/utils/generated/oas-output/operations/admin/post_admin_reservations.ts index 5de70260bf..fb3f6305aa 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_reservations.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_reservations.ts @@ -84,6 +84,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: createReservationsWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_reservations_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_reservations_[id].ts index f18d8e75df..304ecdf4c3 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_reservations_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_reservations_[id].ts @@ -101,6 +101,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: updateReservationsWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_return-reasons.ts b/www/utils/generated/oas-output/operations/admin/post_admin_return-reasons.ts index 71a56097cb..8975c5833a 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_return-reasons.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_return-reasons.ts @@ -79,6 +79,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: createReturnReasonsWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_return-reasons_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_return-reasons_[id].ts index db0f87a908..d05d4323e2 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_return-reasons_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_return-reasons_[id].ts @@ -80,6 +80,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: updateReturnReasonsWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns.ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns.ts index 10a6e4bad3..f61d33f9a2 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns.ts @@ -91,6 +91,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: beginReturnOrderWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id].ts index a185d5d8a0..576ab0cdbb 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id].ts @@ -83,6 +83,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: updateReturnWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_cancel.ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_cancel.ts index 7a8b2cbc98..d9615bd86f 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_cancel.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_cancel.ts @@ -65,6 +65,7 @@ * schema: * $ref: "#/components/schemas/AdminPostCancelReturnReqSchema" * x-workflow: cancelReturnWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_dismiss-items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_dismiss-items.ts index ac62b647ef..e50bf6e95d 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_dismiss-items.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_dismiss-items.ts @@ -82,6 +82,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: dismissItemReturnRequestWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_dismiss-items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_dismiss-items_[action_id].ts index 8ba6de6116..14a9bcabbe 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_dismiss-items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_dismiss-items_[action_id].ts @@ -89,6 +89,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: updateReceiveItemReturnRequestWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive-items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive-items.ts index 81caeb5045..e82be1b041 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive-items.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive-items.ts @@ -82,6 +82,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: receiveItemReturnRequestWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive-items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive-items_[action_id].ts index 302d84f1f5..9e22eff154 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive-items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive-items_[action_id].ts @@ -89,6 +89,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: updateReceiveItemReturnRequestWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive.ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive.ts index 9af495c483..f845f516fb 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive.ts @@ -92,6 +92,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: beginReceiveReturnWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive_confirm.ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive_confirm.ts index a1dc6d2c7d..d611f469d4 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive_confirm.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive_confirm.ts @@ -80,6 +80,17 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: confirmReturnReceiveWorkflow + * x-events: + * - name: order.return_received + * payload: |- + * ```ts + * { + * order_id, // The ID of the order + * return_id, // The ID of the return + * } + * ``` + * description: Emitted when a return is marked as received. + * deprecated: false * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_request-items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_request-items.ts index 43cf44f8d9..10cf8c0ab6 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_request-items.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_request-items.ts @@ -81,6 +81,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: requestItemReturnWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_request-items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_request-items_[action_id].ts index 5ef377d7fe..33214ce880 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_request-items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_request-items_[action_id].ts @@ -89,6 +89,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: updateRequestItemReturnWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_request.ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_request.ts index ae89201de1..3102ad2e36 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_request.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_request.ts @@ -80,6 +80,17 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: confirmReturnRequestWorkflow + * x-events: + * - name: order.return_requested + * payload: |- + * ```ts + * { + * order_id, // The ID of the order + * return_id, // The ID of the return + * } + * ``` + * description: Emitted when a return request is confirmed. + * deprecated: false * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_shipping-method.ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_shipping-method.ts index 9181b42b8a..97bb2a7181 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_shipping-method.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_shipping-method.ts @@ -84,6 +84,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: createReturnShippingMethodWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_shipping-method_[action_id].ts index 542a975a88..d00bd5b36b 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_shipping-method_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_shipping-method_[action_id].ts @@ -89,6 +89,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: updateReturnShippingMethodWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels.ts b/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels.ts index 114a06dd78..f9087d76a9 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels.ts @@ -79,6 +79,16 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: createSalesChannelsWorkflow + * x-events: + * - name: sales-channel.created + * payload: |- + * ```ts + * [{ + * id, // The ID of the sales channel + * }] + * ``` + * description: Emitted when sales channels are created. + * deprecated: false * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels_[id].ts index 921e338ce6..3bde41f01e 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels_[id].ts @@ -87,6 +87,16 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: updateSalesChannelsWorkflow + * x-events: + * - name: sales-channel.updated + * payload: |- + * ```ts + * [{ + * id, // The ID of the sales channel + * }] + * ``` + * description: Emitted when sales channels are updated. + * deprecated: false * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels_[id]_products.ts b/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels_[id]_products.ts index f397a5af41..c9c590d8e9 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels_[id]_products.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels_[id]_products.ts @@ -97,6 +97,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: linkProductsToSalesChannelWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_shipping-options.ts b/www/utils/generated/oas-output/operations/admin/post_admin_shipping-options.ts index 181d6982ae..9b62729dc6 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_shipping-options.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_shipping-options.ts @@ -88,6 +88,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: createShippingOptionsWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_shipping-options_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_shipping-options_[id].ts index 3928dee186..7ca6c691f6 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_shipping-options_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_shipping-options_[id].ts @@ -245,6 +245,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: updateShippingOptionsWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_shipping-options_[id]_rules_batch.ts b/www/utils/generated/oas-output/operations/admin/post_admin_shipping-options_[id]_rules_batch.ts index c2a1a4fa5c..fd5f7cee11 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_shipping-options_[id]_rules_batch.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_shipping-options_[id]_rules_batch.ts @@ -139,6 +139,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: batchShippingOptionRulesWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_shipping-profiles.ts b/www/utils/generated/oas-output/operations/admin/post_admin_shipping-profiles.ts index 28f09dee77..82efce1ad0 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_shipping-profiles.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_shipping-profiles.ts @@ -79,6 +79,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: createShippingProfilesWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_shipping-profiles_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_shipping-profiles_[id].ts index 8adb5ed11d..2e853535b9 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_shipping-profiles_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_shipping-profiles_[id].ts @@ -96,6 +96,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: updateShippingProfilesWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations.ts b/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations.ts index baf371bbf7..743af535cc 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations.ts @@ -80,6 +80,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: createStockLocationsWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id].ts index 5a906db2c8..9e64fd9a63 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id].ts @@ -84,6 +84,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: updateStockLocationsWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_fulfillment-providers.ts b/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_fulfillment-providers.ts index 34bd703ea4..52fb5409ec 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_fulfillment-providers.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_fulfillment-providers.ts @@ -97,6 +97,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: batchLinksWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_fulfillment-sets.ts b/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_fulfillment-sets.ts index 32fb6828af..ed00b46fb6 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_fulfillment-sets.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_fulfillment-sets.ts @@ -99,6 +99,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: createLocationFulfillmentSetWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_sales-channels.ts b/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_sales-channels.ts index 526035c133..872cac1889 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_sales-channels.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_sales-channels.ts @@ -97,6 +97,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: linkSalesChannelsToStockLocationWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_stores_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_stores_[id].ts index 5d7d9410b1..c6369eefea 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_stores_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_stores_[id].ts @@ -87,6 +87,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: updateStoresWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_tax-rates.ts b/www/utils/generated/oas-output/operations/admin/post_admin_tax-rates.ts index 4e2565fb0f..93c58125d5 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_tax-rates.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_tax-rates.ts @@ -82,6 +82,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: createTaxRatesWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_tax-rates_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_tax-rates_[id].ts index 90ecf4ad13..12bc5ffbf5 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_tax-rates_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_tax-rates_[id].ts @@ -84,6 +84,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: updateTaxRatesWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_tax-rates_[id]_rules.ts b/www/utils/generated/oas-output/operations/admin/post_admin_tax-rates_[id]_rules.ts index d885226dfe..5236e280ad 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_tax-rates_[id]_rules.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_tax-rates_[id]_rules.ts @@ -66,6 +66,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: createTaxRateRulesWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_tax-regions.ts b/www/utils/generated/oas-output/operations/admin/post_admin_tax-regions.ts index faea50b653..a876694915 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_tax-regions.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_tax-regions.ts @@ -42,7 +42,7 @@ * * sdk.admin.taxRegion.create({ * country_code: "us", - * province_code: "us-ca", + * province_code: "ca", * default_tax_rate: { * code: "VAT", * name: "VAT", @@ -87,6 +87,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: createTaxRegionsWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_tax-regions_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_tax-regions_[id].ts index 29acf12f69..e09252092d 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_tax-regions_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_tax-regions_[id].ts @@ -35,6 +35,25 @@ * schema: * $ref: "#/components/schemas/AdminUpdateTaxRegion" * x-codeSamples: + * - lang: JavaScript + * label: JS SDK + * source: |- + * import Medusa from "@medusajs/js-sdk" + * + * export const sdk = new Medusa({ + * baseUrl: import.meta.env.VITE_BACKEND_URL || "/", + * debug: import.meta.env.DEV, + * auth: { + * type: "session", + * }, + * }) + * + * sdk.admin.taxRegion.update("txreg_123", { + * province_code: "ca", + * }) + * .then(({ tax_region }) => { + * console.log(tax_region) + * }) * - lang: Shell * label: cURL * source: |- @@ -62,6 +81,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: updateTaxRegionsWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_uploads.ts b/www/utils/generated/oas-output/operations/admin/post_admin_uploads.ts index 605eeaf208..a931f7a616 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_uploads.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_uploads.ts @@ -110,6 +110,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: uploadFilesWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_users_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_users_[id].ts index b7a502ee7a..1725d5b7da 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_users_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_users_[id].ts @@ -84,6 +84,16 @@ * security: * - cookie_auth: [] * - jwt_token: [] + * x-events: + * - name: user.updated + * payload: |- + * ```ts + * [{ + * id, // The ID of the user + * }] + * ``` + * description: Emitted when users are updated. + * deprecated: false * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_auth_[actor_type]_[auth_provider]_reset-password.ts b/www/utils/generated/oas-output/operations/admin/post_auth_[actor_type]_[auth_provider]_reset-password.ts index 70e25c1a4d..75d1d009bf 100644 --- a/www/utils/generated/oas-output/operations/admin/post_auth_[actor_type]_[auth_provider]_reset-password.ts +++ b/www/utils/generated/oas-output/operations/admin/post_auth_[actor_type]_[auth_provider]_reset-password.ts @@ -81,6 +81,19 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: generateResetPasswordTokenWorkflow - * + * x-events: + * - name: auth.password_reset + * payload: |- + * ```ts + * { + * entity_id, // The identifier of the user or customer. For example, an email address. + * actor_type, // The type of actor. For example, "customer", "user", or custom. + * token, // The generated token. + * } + * ``` + * description: |- + * Emitted when a reset password token is generated. You can listen to this event + * to send a reset password email to the user or customer, for example. + * deprecated: false */ diff --git a/www/utils/generated/oas-output/operations/auth/post_auth_[actor_type]_[auth_provider]_reset-password.ts b/www/utils/generated/oas-output/operations/auth/post_auth_[actor_type]_[auth_provider]_reset-password.ts index 752b17a139..fb95f1a18f 100644 --- a/www/utils/generated/oas-output/operations/auth/post_auth_[actor_type]_[auth_provider]_reset-password.ts +++ b/www/utils/generated/oas-output/operations/auth/post_auth_[actor_type]_[auth_provider]_reset-password.ts @@ -67,6 +67,20 @@ * application/json: * schema: * $ref: "#/components/schemas/ResetPasswordRequest" + * x-events: + * - name: auth.password_reset + * payload: |- + * ```ts + * { + * entity_id, // The identifier of the user or customer. For example, an email address. + * actor_type, // The type of actor. For example, "customer", "user", or custom. + * token, // The generated token. + * } + * ``` + * description: |- + * Emitted when a reset password token is generated. You can listen to this event + * to send a reset password email to the user or customer, for example. + * deprecated: false * */ diff --git a/www/utils/generated/oas-output/operations/store/delete_store_carts_[id]_line-items_[line_id].ts b/www/utils/generated/oas-output/operations/store/delete_store_carts_[id]_line-items_[line_id].ts index 5366fc7cb8..16ab7e2e24 100644 --- a/www/utils/generated/oas-output/operations/store/delete_store_carts_[id]_line-items_[line_id].ts +++ b/www/utils/generated/oas-output/operations/store/delete_store_carts_[id]_line-items_[line_id].ts @@ -120,6 +120,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: deleteLineItemsWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/store/delete_store_carts_[id]_promotions.ts b/www/utils/generated/oas-output/operations/store/delete_store_carts_[id]_promotions.ts index 147ebf818e..a903890be3 100644 --- a/www/utils/generated/oas-output/operations/store/delete_store_carts_[id]_promotions.ts +++ b/www/utils/generated/oas-output/operations/store/delete_store_carts_[id]_promotions.ts @@ -70,6 +70,7 @@ * application/json: * schema: * $ref: "#/components/schemas/StoreCartRemovePromotion" + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/store/delete_store_customers_me_addresses_[address_id].ts b/www/utils/generated/oas-output/operations/store/delete_store_customers_me_addresses_[address_id].ts index 04652c25ce..a30caf66f9 100644 --- a/www/utils/generated/oas-output/operations/store/delete_store_customers_me_addresses_[address_id].ts +++ b/www/utils/generated/oas-output/operations/store/delete_store_customers_me_addresses_[address_id].ts @@ -117,6 +117,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: deleteCustomerAddressesWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/store/get_store_orders.ts b/www/utils/generated/oas-output/operations/store/get_store_orders.ts index 2e0a6ae789..2dd35f2311 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_orders.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_orders.ts @@ -202,6 +202,7 @@ * - cookie_auth: [] * - jwt_token: [] * x-workflow: getOrdersListWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/store/get_store_orders_[id].ts b/www/utils/generated/oas-output/operations/store/get_store_orders_[id].ts index fd9e70bc4a..83c25f2542 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_orders_[id].ts +++ b/www/utils/generated/oas-output/operations/store/get_store_orders_[id].ts @@ -80,6 +80,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: getOrderDetailWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/store/get_store_products.ts b/www/utils/generated/oas-output/operations/store/get_store_products.ts index d687731019..71e61f0cac 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_products.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_products.ts @@ -660,7 +660,7 @@ * type: string * title: province * description: The lower-case ISO 3166-2 province code the products are being viewed from. This is useful to narrow down the tax context when calculating product variant prices with taxes. - * example: "us-ca" + * example: us-ca * externalDocs: * url: https://en.wikipedia.org/wiki/ISO_3166-2 * description: Learn more about ISO 3166-2 diff --git a/www/utils/generated/oas-output/operations/store/get_store_products_[id].ts b/www/utils/generated/oas-output/operations/store/get_store_products_[id].ts index b3d5e52dba..4275ed26ee 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_products_[id].ts +++ b/www/utils/generated/oas-output/operations/store/get_store_products_[id].ts @@ -61,7 +61,7 @@ * type: string * title: province * description: The lower-case ISO 3166-2 province code the product is being viewed from. This is useful to narrow down the tax context when calculating product variant prices with taxes. - * example: "us-ca" + * example: us-ca * externalDocs: * url: https://en.wikipedia.org/wiki/ISO_3166-2 * description: Learn more about ISO 3166-2 diff --git a/www/utils/generated/oas-output/operations/store/get_store_shipping-options.ts b/www/utils/generated/oas-output/operations/store/get_store_shipping-options.ts index 70cf589a19..67b9356491 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_shipping-options.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_shipping-options.ts @@ -146,6 +146,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: listShippingOptionsForCartWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/store/post_auth_[actor_type]_[auth_provider]_reset-password.ts b/www/utils/generated/oas-output/operations/store/post_auth_[actor_type]_[auth_provider]_reset-password.ts index 1a6a8545a2..2f381a3dcd 100644 --- a/www/utils/generated/oas-output/operations/store/post_auth_[actor_type]_[auth_provider]_reset-password.ts +++ b/www/utils/generated/oas-output/operations/store/post_auth_[actor_type]_[auth_provider]_reset-password.ts @@ -85,6 +85,20 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: generateResetPasswordTokenWorkflow + * x-events: + * - name: auth.password_reset + * payload: |- + * ```ts + * { + * entity_id, // The identifier of the user or customer. For example, an email address. + * actor_type, // The type of actor. For example, "customer", "user", or custom. + * token, // The generated token. + * } + * ``` + * description: |- + * Emitted when a reset password token is generated. You can listen to this event + * to send a reset password email to the user or customer, for example. + * deprecated: false * */ diff --git a/www/utils/generated/oas-output/operations/store/post_store_carts.ts b/www/utils/generated/oas-output/operations/store/post_store_carts.ts index 432f5ff6f0..69dc08b523 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_carts.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_carts.ts @@ -66,7 +66,11 @@ * label: cURL * source: |- * curl -X POST '{backend_url}/store/carts' \ - * -H 'x-publishable-api-key: {your_publishable_api_key}' + * -H 'Content-Type: application/json' \ + * -H 'x-publishable-api-key: {your_publishable_api_key}' \ + * --data-raw '{ + * "region_id": "reg_123" + * }' * tags: * - Carts * responses: @@ -89,6 +93,16 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: createCartWorkflow + * x-events: + * - name: cart.created + * payload: |- + * ```ts + * { + * id, // The ID of the cart + * } + * ``` + * description: Emitted when a cart is created. + * deprecated: false * */ diff --git a/www/utils/generated/oas-output/operations/store/post_store_carts_[id].ts b/www/utils/generated/oas-output/operations/store/post_store_carts_[id].ts index 7564b4b3ad..7ee23af8e7 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_carts_[id].ts +++ b/www/utils/generated/oas-output/operations/store/post_store_carts_[id].ts @@ -103,6 +103,36 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: updateCartWorkflow + * x-events: + * - name: cart.updated + * payload: |- + * ```ts + * { + * id, // The ID of the cart + * } + * ``` + * description: Emitted when a cart's details are updated. + * deprecated: false + * - name: cart.customer_updated + * payload: |- + * ```ts + * { + * id, // The ID of the cart + * } + * ``` + * description: Emitted when the customer in the cart is updated. + * deprecated: false + * - name: cart.region_updated + * payload: |- + * ```ts + * { + * id, // The ID of the cart + * } + * ``` + * description: |- + * Emitted when the cart's region is updated. This + * event is emitted alongside the `cart.updated` event. + * deprecated: false * */ diff --git a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_complete.ts b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_complete.ts index 8f117519df..f96663b5de 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_complete.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_complete.ts @@ -138,6 +138,18 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: completeCartWorkflow + * 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 * */ diff --git a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_customer.ts b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_customer.ts index cf1c947ea8..b6f4c1cdb2 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_customer.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_customer.ts @@ -86,6 +86,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: transferCartCustomerWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_line-items.ts b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_line-items.ts index e8a7781277..92609a39ea 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_line-items.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_line-items.ts @@ -98,6 +98,16 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: addToCartWorkflow + * x-events: + * - name: cart.updated + * payload: |- + * ```ts + * { + * id, // The ID of the cart + * } + * ``` + * description: Emitted when a cart's details are updated. + * deprecated: false * */ diff --git a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_line-items_[line_id].ts b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_line-items_[line_id].ts index 04587b36a8..699e0f398c 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_line-items_[line_id].ts +++ b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_line-items_[line_id].ts @@ -106,6 +106,16 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: updateLineItemInCartWorkflow + * x-events: + * - name: cart.updated + * payload: |- + * ```ts + * { + * id, // The ID of the cart + * } + * ``` + * description: Emitted when a cart's details are updated. + * deprecated: false * */ diff --git a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_promotions.ts b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_promotions.ts index 9c53a52b63..f591993946 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_promotions.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_promotions.ts @@ -71,6 +71,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: updateCartPromotionsWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_shipping-methods.ts b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_shipping-methods.ts index 1553c31eac..d32dd5a7cc 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_shipping-methods.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_shipping-methods.ts @@ -112,6 +112,16 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: addShippingMethodToCartWorkflow + * x-events: + * - name: cart.updated + * payload: |- + * ```ts + * { + * id, // The ID of the cart + * } + * ``` + * description: Emitted when a cart's details are updated. + * deprecated: false * */ diff --git a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_taxes.ts b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_taxes.ts index d89ca12c07..c1716cabb8 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_taxes.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_taxes.ts @@ -60,6 +60,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: updateTaxLinesWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/store/post_store_customers.ts b/www/utils/generated/oas-output/operations/store/post_store_customers.ts index f449c1cb8a..dab7276e4b 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_customers.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_customers.ts @@ -108,6 +108,16 @@ * security: * - cookie_auth: [] * - jwt_token: [] + * x-events: + * - name: customer.created + * payload: |- + * ```ts + * [{ + * id, // The ID of the customer + * }] + * ``` + * description: Emitted when a customer is created. + * deprecated: false * */ diff --git a/www/utils/generated/oas-output/operations/store/post_store_customers_me.ts b/www/utils/generated/oas-output/operations/store/post_store_customers_me.ts index 048aef046e..f79a3d67f5 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_customers_me.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_customers_me.ts @@ -96,6 +96,16 @@ * "500": * $ref: "#/components/responses/500_error" * 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 * */ diff --git a/www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses.ts b/www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses.ts index adf56a1fcb..48fb60242a 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses.ts @@ -77,7 +77,7 @@ * type: string * title: province * description: The address's ISO 3166-2 province code. Must be lower-case. - * example: "us-ca" + * example: us-ca * externalDocs: * url: https://en.wikipedia.org/wiki/ISO_3166-2 * description: Learn more about ISO 3166-2 @@ -167,6 +167,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: createCustomerAddressesWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses_[address_id].ts b/www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses_[address_id].ts index 1db9459fef..7c8cc1e4cf 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses_[address_id].ts +++ b/www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses_[address_id].ts @@ -83,7 +83,7 @@ * type: string * title: province * description: The address's ISO 3166-2 province code. Must be lower-case. - * example: "us-ca" + * example: us-ca * externalDocs: * url: https://en.wikipedia.org/wiki/ISO_3166-2 * description: Learn more about ISO 3166-2 @@ -165,6 +165,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: updateCustomerAddressesWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/store/post_store_orders_[id]_transfer_accept.ts b/www/utils/generated/oas-output/operations/store/post_store_orders_[id]_transfer_accept.ts index 237a29fdde..4b30b71f1f 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_orders_[id]_transfer_accept.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_orders_[id]_transfer_accept.ts @@ -102,6 +102,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: acceptOrderTransferWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/store/post_store_orders_[id]_transfer_cancel.ts b/www/utils/generated/oas-output/operations/store/post_store_orders_[id]_transfer_cancel.ts index 98ab95c0c1..51ed68b64a 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_orders_[id]_transfer_cancel.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_orders_[id]_transfer_cancel.ts @@ -92,6 +92,7 @@ * security: * - cookie_auth: [] * - jwt_token: [] + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/store/post_store_orders_[id]_transfer_decline.ts b/www/utils/generated/oas-output/operations/store/post_store_orders_[id]_transfer_decline.ts index a6c33c8605..148f83faea 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_orders_[id]_transfer_decline.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_orders_[id]_transfer_decline.ts @@ -100,6 +100,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: declineOrderTransferRequestWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/store/post_store_orders_[id]_transfer_request.ts b/www/utils/generated/oas-output/operations/store/post_store_orders_[id]_transfer_request.ts index 1536f4574a..76c4cf27d8 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_orders_[id]_transfer_request.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_orders_[id]_transfer_request.ts @@ -101,6 +101,7 @@ * security: * - cookie_auth: [] * - jwt_token: [] + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/store/post_store_payment-collections.ts b/www/utils/generated/oas-output/operations/store/post_store_payment-collections.ts index 82206b62cf..42881f139e 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_payment-collections.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_payment-collections.ts @@ -94,6 +94,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: createPaymentCollectionForCartWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/store/post_store_payment-collections_[id]_payment-sessions.ts b/www/utils/generated/oas-output/operations/store/post_store_payment-collections_[id]_payment-sessions.ts index 4baa37496d..1fe83bad56 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_payment-collections_[id]_payment-sessions.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_payment-collections_[id]_payment-sessions.ts @@ -73,6 +73,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: createPaymentSessionsWorkflow + * x-events: [] * */ diff --git a/www/utils/generated/oas-output/operations/store/post_store_shipping-options_[id]_calculate.ts b/www/utils/generated/oas-output/operations/store/post_store_shipping-options_[id]_calculate.ts index 8fd6c95bf0..b42efcf201 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_shipping-options_[id]_calculate.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_shipping-options_[id]_calculate.ts @@ -106,6 +106,7 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: calculateShippingOptionsPricesWorkflow + * x-events: [] * */