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

2022-08-05 14:06:12 +02:00
parent b126ab4dec
commit 73383cc466
625 changed files with 52358 additions and 11660 deletions
@@ -0,0 +1,35 @@
+get:
+  operationId: GetShippingOptions
+  summary: Retrieve Shipping Options
+  description: Retrieves a list of Shipping Options.
+  parameters:
+    - in: query
+      name: is_return
+      description: >-
+        Whether return Shipping Options should be included. By default all
+        Shipping Options are returned.
+      schema:
+        type: boolean
+    - in: query
+      name: product_ids
+      description: A comma separated list of Product ids to filter Shipping Options by.
+      schema:
+        type: string
+    - in: query
+      name: region_id
+      description: the Region to retrieve Shipping Options from.
+      schema:
+        type: string
+  tags:
+    - Shipping Option
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            properties:
+              shipping_options:
+                type: array
+                items:
+                  $ref: ../components/schemas/shipping_option.yaml