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

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-04-23 08:50:17 +00:00
committed by GitHub
parent cb53b8a529
commit c7065fcd2b
37 changed files with 392 additions and 156 deletions

View File

@@ -55,3 +55,55 @@ post:
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: updateDraftOrderShippingMethodWorkflow
delete:
operationId: DeleteDraftOrdersIdEditShippingMethodsMethodMethod_id
summary: Remove Shipping Method from Draft Order
x-sidebar-summary: Remove Shipping Method
description: Remove the shipping method in a draft order that is being edited.
x-authenticated: true
parameters:
- name: id
in: path
description: The draft order's ID.
required: true
schema:
type: string
- name: method_id
in: path
description: The shipping method'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}_edit_shipping-methods_method_{method_id}/delete.js
- lang: Shell
label: cURL
source:
$ref: >-
../code_samples/Shell/admin_draft-orders_{id}_edit_shipping-methods_method_{method_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: removeDraftOrderShippingMethodWorkflow

View File

@@ -67,8 +67,8 @@ post:
x-workflow: updateDraftOrderActionShippingMethodWorkflow
delete:
operationId: DeleteDraftOrdersIdEditShippingMethodsAction_id
summary: Remove Shipping Method from Draft Order
x-sidebar-summary: Remove Shipping Method
summary: Remove New Shipping Method from Draft Order
x-sidebar-summary: Remove New Shipping Method
description: >
Remove the shipping method in a draft order using the `ID` of the method's
`SHIPPING_ADD` action.