115 lines
3.4 KiB
YAML
115 lines
3.4 KiB
YAML
get:
|
|
operationId: GetOrdersOrder
|
|
summary: Retrieve an Order
|
|
description: Retrieves an Order
|
|
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
|
|
post:
|
|
operationId: PostOrdersOrder
|
|
summary: Update an order
|
|
description: Updates and order
|
|
x-authenticated: true
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
required: true
|
|
description: The ID of the Order.
|
|
schema:
|
|
type: string
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
properties:
|
|
email:
|
|
description: the email for the order
|
|
type: string
|
|
billing_address:
|
|
description: Billing address
|
|
anyOf:
|
|
- $ref: ../components/schemas/address.yaml
|
|
shipping_address:
|
|
description: Shipping address
|
|
anyOf:
|
|
- $ref: ../components/schemas/address.yaml
|
|
items:
|
|
description: The Line Items for the order
|
|
type: array
|
|
items:
|
|
$ref: ../components/schemas/line_item.yaml
|
|
region:
|
|
description: ID of the region where the order belongs
|
|
type: string
|
|
discounts:
|
|
description: Discounts applied to the order
|
|
type: array
|
|
items:
|
|
$ref: ../components/schemas/discount.yaml
|
|
customer_id:
|
|
description: ID of the customer
|
|
type: string
|
|
payment_method:
|
|
description: payment method chosen for the order
|
|
type: object
|
|
properties:
|
|
provider_id:
|
|
type: string
|
|
description: ID of the payment provider
|
|
data:
|
|
description: Data relevant for the given payment method
|
|
type: object
|
|
shipping_method:
|
|
description: The Shipping Method used for shipping the order.
|
|
type: object
|
|
properties:
|
|
provider_id:
|
|
type: string
|
|
description: The ID of the shipping provider.
|
|
profile_id:
|
|
type: string
|
|
description: The ID of the shipping profile.
|
|
price:
|
|
type: integer
|
|
description: The price of the shipping.
|
|
data:
|
|
type: object
|
|
description: Data relevant to the specific shipping method.
|
|
items:
|
|
type: array
|
|
items:
|
|
$ref: ../components/schemas/line_item.yaml
|
|
description: Items to ship
|
|
no_notification:
|
|
description: >-
|
|
A flag to indicate if no notifications should be emitted related
|
|
to the updated order.
|
|
type: boolean
|
|
tags:
|
|
- Order
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
properties:
|
|
order:
|
|
$ref: ../components/schemas/order.yaml
|