72 lines
2.1 KiB
YAML
72 lines
2.1 KiB
YAML
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
|
|
x-codeSamples:
|
|
- lang: JavaScript
|
|
label: JS Client
|
|
source:
|
|
$ref: ../code_samples/JavaScript/orders_{id}_shipping-methods/postundefined
|
|
- lang: Shell
|
|
label: cURL
|
|
source:
|
|
$ref: ../code_samples/Shell/orders_{id}_shipping-methods/postundefined
|
|
security:
|
|
- api_token: []
|
|
- cookie_auth: []
|
|
tags:
|
|
- Order
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: ../components/schemas/AdminOrdersRes.yaml
|
|
'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
|
|
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.
|