diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_draft-orders_{id}/delete.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_draft-orders_{id}/delete.js new file mode 100644 index 0000000000..e23934c44d --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_draft-orders_{id}/delete.js @@ -0,0 +1,14 @@ +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.draftOrder.delete("order_123") +.then(({ id, object, deleted }) => { + console.log(id, object, deleted) +}) \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_draft-orders_{id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_draft-orders_{id}/delete.sh new file mode 100644 index 0000000000..e14befd0b7 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_draft-orders_{id}/delete.sh @@ -0,0 +1,2 @@ +curl -X DELETE '{backend_url}/admin/draft-orders/{id}' \ +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/components/schemas/Order.yaml b/www/apps/api-reference/specs/admin/components/schemas/Order.yaml index 5be6266d54..4a07709e36 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/Order.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/Order.yaml @@ -298,3 +298,8 @@ properties: type: boolean title: is_draft_order description: Whether the order is a draft order. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the order was deleted. diff --git a/www/apps/api-reference/specs/admin/openapi.full.yaml b/www/apps/api-reference/specs/admin/openapi.full.yaml index 022f94f83a..b3be9d4051 100644 --- a/www/apps/api-reference/specs/admin/openapi.full.yaml +++ b/www/apps/api-reference/specs/admin/openapi.full.yaml @@ -14865,6 +14865,65 @@ paths: Emitted when the details of an order or draft order is updated. This doesn't include updates made by an edit. deprecated: false + delete: + operationId: DeleteDraftOrdersId + summary: Delete a Draft Order + description: Delete a draft order. + x-authenticated: true + parameters: + - name: id + in: path + description: The draft order's ID. + required: true + schema: + type: string + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + 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.draftOrder.delete("order_123") + .then(({ id, object, deleted }) => { + console.log(id, object, deleted) + }) + - lang: Shell + label: cURL + source: |- + curl -X DELETE '{backend_url}/admin/draft-orders/{id}' \ + -H 'Authorization: Bearer {access_token}' + tags: + - Draft Orders + responses: + '200': + description: OK + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + x-workflow: deleteDraftOrdersWorkflow + x-events: [] + x-version: 2.8.4 /admin/draft-orders/{id}/convert-to-order: post: operationId: PostDraftOrdersIdConvertToOrder @@ -68822,6 +68881,11 @@ components: type: boolean title: is_draft_order description: Whether the order is a draft order. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the order was deleted. OrderAddress: type: object description: The address's details. 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 3737bf1a7b..4ebfa8884d 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 @@ -155,3 +155,48 @@ post: Emitted when the details of an order or draft order is updated. This doesn't include updates made by an edit. deprecated: false +delete: + operationId: DeleteDraftOrdersId + summary: Delete a Draft Order + description: Delete a draft order. + x-authenticated: true + parameters: + - name: id + in: path + description: The draft order's ID. + required: true + schema: + type: string + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: JavaScript + label: JS SDK + source: + $ref: ../code_samples/JavaScript/admin_draft-orders_{id}/delete.js + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_draft-orders_{id}/delete.sh + tags: + - Draft Orders + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml + x-workflow: deleteDraftOrdersWorkflow + x-events: [] + x-version: 2.8.4 diff --git a/www/apps/api-reference/specs/store/components/schemas/Order.yaml b/www/apps/api-reference/specs/store/components/schemas/Order.yaml index 5be6266d54..4a07709e36 100644 --- a/www/apps/api-reference/specs/store/components/schemas/Order.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/Order.yaml @@ -298,3 +298,8 @@ properties: type: boolean title: is_draft_order description: Whether the order is a draft order. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the order was deleted. diff --git a/www/apps/api-reference/specs/store/openapi.full.yaml b/www/apps/api-reference/specs/store/openapi.full.yaml index d0c5202958..e75e55dd27 100644 --- a/www/apps/api-reference/specs/store/openapi.full.yaml +++ b/www/apps/api-reference/specs/store/openapi.full.yaml @@ -25845,6 +25845,11 @@ components: type: boolean title: is_draft_order description: Whether the order is a draft order. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the order was deleted. OrderAddress: type: object description: The address's details. diff --git a/www/utils/generated/events-output.json b/www/utils/generated/events-output.json index 5e9cd4d955..fd6839dc9c 100644 --- a/www/utils/generated/events-output.json +++ b/www/utils/generated/events-output.json @@ -102,8 +102,7 @@ "description": "Emitted when an order is placed, or when a draft order is converted to an\norder.", "workflows": [ "convertDraftOrderWorkflow", - "completeCartWorkflow", - "processPaymentWorkflow" + "completeCartWorkflow" ], "deprecated": false }, diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_draft-orders_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_draft-orders_[id].ts new file mode 100644 index 0000000000..8c4c5b61ec --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_draft-orders_[id].ts @@ -0,0 +1,62 @@ +/** + * @oas [delete] /admin/draft-orders/{id} + * operationId: DeleteDraftOrdersId + * summary: Delete a Draft Order + * description: Delete a draft order. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The draft order's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * 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.draftOrder.delete("order_123") + * .then(({ id, object, deleted }) => { + * console.log(id, object, deleted) + * }) + * - lang: Shell + * label: cURL + * source: |- + * curl -X DELETE '{backend_url}/admin/draft-orders/{id}' \ + * -H 'Authorization: Bearer {access_token}' + * tags: + * - Draft Orders + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * x-workflow: deleteDraftOrdersWorkflow + * x-events: [] + * x-version: 2.8.4 +*/ + diff --git a/www/utils/generated/oas-output/schemas/Order.ts b/www/utils/generated/oas-output/schemas/Order.ts index 04e77757af..77e24c4403 100644 --- a/www/utils/generated/oas-output/schemas/Order.ts +++ b/www/utils/generated/oas-output/schemas/Order.ts @@ -296,6 +296,11 @@ * type: boolean * title: is_draft_order * description: Whether the order is a draft order. + * deleted_at: + * type: string + * format: date-time + * title: deleted_at + * description: The date the order was deleted. * */ diff --git a/www/utils/generated/route-examples-output/route-examples.json b/www/utils/generated/route-examples-output/route-examples.json index da755367c7..d475ebb62a 100644 --- a/www/utils/generated/route-examples-output/route-examples.json +++ b/www/utils/generated/route-examples-output/route-examples.json @@ -167,6 +167,9 @@ "POST /admin/draft-orders": { "js-sdk": "sdk.admin.draftOrder.create({\n email: \"test@test.com\",\n items: [\n {\n variant_id: \"variant_123\",\n quantity: 1,\n },\n ],\n region_id: \"region_123\",\n sales_channel_id: \"sc_123\",\n})\n.then(({ draft_order }) => {\n console.log(draft_order)\n})" }, + "DELETE /admin/draft-orders/{id}": { + "js-sdk": "sdk.admin.draftOrder.delete(\"order_123\")\n.then(({ id, object, deleted }) => {\n console.log(id, object, deleted)\n})" + }, "POST /admin/draft-orders/{id}": { "js-sdk": "sdk.admin.draftOrder.update(\"order_123\", {\n email: \"test@test.com\",\n})\n.then(({ draft_order }) => {\n console.log(draft_order)\n})" },