chore(docs): Generated API Reference (#2882)

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
2022-12-22 17:09:49 +02:00
parent 233d6904f8
commit 4814045036
477 changed files with 17312 additions and 17713 deletions
@@ -0,0 +1,65 @@
+type: object
+properties:
+  email:
+    description: the email for the order
+    type: string
+  billing_address:
+    description: Billing address
+    anyOf:
+      - $ref: ./AddressFields.yaml
+  shipping_address:
+    description: Shipping address
+    anyOf:
+      - $ref: ./AddressFields.yaml
+  items:
+    description: The Line Items for the order
+    type: array
+    items:
+      $ref: ./LineItem.yaml
+  region:
+    description: ID of the region where the order belongs
+    type: string
+  discounts:
+    description: Discounts applied to the order
+    type: array
+    items:
+      $ref: ./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: ./LineItem.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