chore(docs): Updated API Reference (automated) (#12673)

Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2025-06-10 07:21:44 +00:00
committed by GitHub
co-authored by Oli Juhl Shahed Nasser
parent f8c0bd887e
commit b456044060
11 changed files with 211 additions and 2 deletions
+1 -2
View File
@@ -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
},
@@ -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
*/
@@ -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.
*
*/
@@ -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})"
},