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,28 @@
+title: Fulfillment Item
+description: >-
+  Correlates a Line Item with a Fulfillment, keeping track of the quantity of
+  the Line Item.
+x-resourceId: fulfillment_item
+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: ./line_item.yaml
+  quantity:
+    description: The quantity of the Line Item that is included in the Fulfillment.
+    type: integer
+    example: 1