81 lines
2.3 KiB
YAML
81 lines
2.3 KiB
YAML
post:
|
|
operationId: PostOrdersOrderFulfillments
|
|
summary: Create a Fulfillment
|
|
description: >-
|
|
Creates a Fulfillment of an Order - will notify Fulfillment Providers to
|
|
prepare a shipment.
|
|
x-authenticated: true
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
required: true
|
|
description: The ID of the Order.
|
|
schema:
|
|
type: string
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
required:
|
|
- items
|
|
properties:
|
|
items:
|
|
description: The Line Items to include in the Fulfillment.
|
|
type: array
|
|
items:
|
|
required:
|
|
- item_id
|
|
- quantity
|
|
properties:
|
|
item_id:
|
|
description: The ID of Line Item to fulfill.
|
|
type: string
|
|
quantity:
|
|
description: The quantity of the Line Item to fulfill.
|
|
type: integer
|
|
no_notification:
|
|
description: >-
|
|
If set to true no notification will be send related to this
|
|
Swap.
|
|
type: boolean
|
|
metadata:
|
|
description: >-
|
|
An optional set of key-value pairs to hold additional
|
|
information.
|
|
type: object
|
|
x-codeSamples:
|
|
- lang: JavaScript
|
|
label: JS Client
|
|
source:
|
|
$ref: ../code_samples/JavaScript/orders_{id}_fulfillment/postundefined
|
|
- lang: Shell
|
|
label: cURL
|
|
source:
|
|
$ref: ../code_samples/Shell/orders_{id}_fulfillment/postundefined
|
|
security:
|
|
- api_token: []
|
|
- cookie_auth: []
|
|
tags:
|
|
- Fulfillment
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
properties:
|
|
order:
|
|
$ref: ../components/schemas/order.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
|