chore(docs): Refactor API Reference (#1883)
This commit is contained in:
49
docs/api/admin/paths/orders_{id}_shipping-methods.yaml
Normal file
49
docs/api/admin/paths/orders_{id}_shipping-methods.yaml
Normal file
@@ -0,0 +1,49 @@
|
||||
post:
|
||||
operationId: PostOrdersOrderShippingMethods
|
||||
summary: Add a Shipping Method
|
||||
description: >-
|
||||
Adds a Shipping Method to an Order. If another Shipping Method exists with
|
||||
the same Shipping Profile, the previous Shipping Method will be replaced.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
required: true
|
||||
description: The ID of the Order.
|
||||
schema:
|
||||
type: string
|
||||
tags:
|
||||
- Order
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
properties:
|
||||
order:
|
||||
$ref: ../components/schemas/order.yaml
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
required:
|
||||
- price
|
||||
- option_id
|
||||
properties:
|
||||
price:
|
||||
type: integer
|
||||
description: >-
|
||||
The price (excluding VAT) that should be charged for the
|
||||
Shipping Method
|
||||
option_id:
|
||||
type: string
|
||||
description: >-
|
||||
The ID of the Shipping Option to create the Shipping Method
|
||||
from.
|
||||
data:
|
||||
type: object
|
||||
description: >-
|
||||
The data required for the Shipping Option to create a Shipping
|
||||
Method. This will depend on the Fulfillment Provider.
|
||||
Reference in New Issue
Block a user