chore(docs): Refactor API Reference (#1883)

2022-08-05 15:06:12 +03:00
parent b126ab4dec
commit 73383cc466
625 changed files with 52358 additions and 11660 deletions
@@ -0,0 +1,43 @@
+post:
+  operationId: PostOrdersOrderShipment
+  summary: Create a Shipment
+  description: Registers a Fulfillment as shipped.
+  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:
+            - fulfillment_id
+          properties:
+            fulfillment_id:
+              description: The ID of the Fulfillment.
+              type: string
+            tracking_numbers:
+              description: The tracking numbers for the shipment.
+              type: array
+              items:
+                type: string
+            no_notification:
+              description: >-
+                If set to true no notification will be send related to this
+                Shipment.
+              type: boolean
+  tags:
+    - Order
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            properties:
+              order:
+                $ref: ../components/schemas/order.yaml