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,28 @@
+title: Fulfillment Item
+description: >-
+  Correlates a Line Item with a Fulfillment, keeping track of the quantity of
+  the Line Item.
+type: object
+required:
+  - fulfillment_id
+  - item_id
+  - quantity
+properties:
+  fulfillment_id:
+    description: The id of the Fulfillment that the Fulfillment Item belongs to.
+    type: string
+    example: ful_01G8ZRTMQCA76TXNAT81KPJZRF
+  item_id:
+    description: The id of the Line Item that the Fulfillment Item references.
+    type: string
+    example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN
+  fulfillment:
+    description: A fulfillment object. Available if the relation `fulfillment` is expanded.
+    type: object
+  item:
+    description: Available if the relation `item` is expanded.
+    $ref: ./LineItem.yaml
+  quantity:
+    description: The quantity of the Line Item that is included in the Fulfillment.
+    type: integer
+    example: 1