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,71 @@
+type: object
+required:
+  - return_items
+properties:
+  return_items:
+    description: The Line Items to return as part of the Swap.
+    type: array
+    items:
+      required:
+        - item_id
+        - quantity
+      properties:
+        item_id:
+          description: The ID of the Line Item that will be claimed.
+          type: string
+        quantity:
+          description: The number of items that will be returned
+          type: integer
+        reason_id:
+          description: The ID of the Return Reason to use.
+          type: string
+        note:
+          description: An optional note with information about the Return.
+          type: string
+  return_shipping:
+    description: How the Swap will be returned.
+    type: object
+    required:
+      - option_id
+    properties:
+      option_id:
+        type: string
+        description: The ID of the Shipping Option to create the Shipping Method from.
+      price:
+        type: integer
+        description: The price to charge for the Shipping Method.
+  additional_items:
+    description: The new items to send to the Customer.
+    type: array
+    items:
+      required:
+        - variant_id
+        - quantity
+      properties:
+        variant_id:
+          description: The ID of the Product Variant to ship.
+          type: string
+        quantity:
+          description: The quantity of the Product Variant to ship.
+          type: integer
+  custom_shipping_options:
+    description: The custom shipping options to potentially create a Shipping Method from.
+    type: array
+    items:
+      required:
+        - option_id
+        - price
+      properties:
+        option_id:
+          description: The ID of the Shipping Option to override with a custom price.
+          type: string
+        price:
+          description: The custom price of the Shipping Option.
+          type: integer
+  no_notification:
+    description: If set to true no notification will be send related to this Swap.
+    type: boolean
+  allow_backorder:
+    description: If true, swaps can be completed with items out of stock
+    type: boolean
+    default: true