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:
committed by
GitHub
parent
f8c0bd887e
commit
b456044060
+14
@@ -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)
|
||||
})
|
||||
+2
@@ -0,0 +1,2 @@
|
||||
curl -X DELETE '{backend_url}/admin/draft-orders/{id}' \
|
||||
-H 'Authorization: Bearer {access_token}'
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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
|
||||
|
||||
Reference in New Issue
Block a user