chore(docs): Updated API Reference (v2) (#9437)

Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2024-10-03 07:48:54 +00:00
parent 97c193be1b
commit 21badd069d
894 changed files with 35649 additions and 28168 deletions
@@ -1,3 +1,173 @@
 type: object
 description: The item's cart.
 x-schemaName: BaseCart
+required:
+  - id
+  - currency_code
+  - original_item_total
+  - original_item_subtotal
+  - original_item_tax_total
+  - item_total
+  - item_subtotal
+  - item_tax_total
+  - original_total
+  - original_subtotal
+  - original_tax_total
+  - total
+  - subtotal
+  - tax_total
+  - discount_total
+  - discount_tax_total
+  - gift_card_total
+  - gift_card_tax_total
+  - shipping_total
+  - shipping_subtotal
+  - shipping_tax_total
+  - original_shipping_total
+  - original_shipping_subtotal
+  - original_shipping_tax_total
+properties:
+  id:
+    type: string
+    title: id
+    description: The cart's ID.
+  region:
+    $ref: ./BaseRegion.yaml
+  region_id:
+    type: string
+    title: region_id
+    description: The cart's region id.
+  customer_id:
+    type: string
+    title: customer_id
+    description: The cart's customer id.
+  sales_channel_id:
+    type: string
+    title: sales_channel_id
+    description: The cart's sales channel id.
+  email:
+    type: string
+    title: email
+    description: The cart's email.
+    format: email
+  currency_code:
+    type: string
+    title: currency_code
+    description: The cart's currency code.
+  shipping_address:
+    $ref: ./BaseCartAddress.yaml
+  billing_address:
+    $ref: ./BaseCartAddress.yaml
+  items:
+    type: array
+    description: The cart's items.
+    items:
+      type: object
+  shipping_methods:
+    type: array
+    description: The cart's shipping methods.
+    items:
+      $ref: ./BaseCartShippingMethod.yaml
+  payment_collection:
+    $ref: ./BasePaymentCollection.yaml
+  metadata:
+    type: object
+    description: The cart's metadata.
+  created_at:
+    type: string
+    format: date-time
+    title: created_at
+    description: The cart's created at.
+  updated_at:
+    type: string
+    format: date-time
+    title: updated_at
+    description: The cart's updated at.
+  original_item_total:
+    type: number
+    title: original_item_total
+    description: The cart's original item total.
+  original_item_subtotal:
+    type: number
+    title: original_item_subtotal
+    description: The cart's original item subtotal.
+  original_item_tax_total:
+    type: number
+    title: original_item_tax_total
+    description: The cart's original item tax total.
+  item_total:
+    type: number
+    title: item_total
+    description: The cart's item total.
+  item_subtotal:
+    type: number
+    title: item_subtotal
+    description: The cart's item subtotal.
+  item_tax_total:
+    type: number
+    title: item_tax_total
+    description: The cart's item tax total.
+  original_total:
+    type: number
+    title: original_total
+    description: The cart's original total.
+  original_subtotal:
+    type: number
+    title: original_subtotal
+    description: The cart's original subtotal.
+  original_tax_total:
+    type: number
+    title: original_tax_total
+    description: The cart's original tax total.
+  total:
+    type: number
+    title: total
+    description: The cart's total.
+  subtotal:
+    type: number
+    title: subtotal
+    description: The cart's subtotal.
+  tax_total:
+    type: number
+    title: tax_total
+    description: The cart's tax total.
+  discount_total:
+    type: number
+    title: discount_total
+    description: The cart's discount total.
+  discount_tax_total:
+    type: number
+    title: discount_tax_total
+    description: The cart's discount tax total.
+  gift_card_total:
+    type: number
+    title: gift_card_total
+    description: The cart's gift card total.
+  gift_card_tax_total:
+    type: number
+    title: gift_card_tax_total
+    description: The cart's gift card tax total.
+  shipping_total:
+    type: number
+    title: shipping_total
+    description: The cart's shipping total.
+  shipping_subtotal:
+    type: number
+    title: shipping_subtotal
+    description: The cart's shipping subtotal.
+  shipping_tax_total:
+    type: number
+    title: shipping_tax_total
+    description: The cart's shipping tax total.
+  original_shipping_total:
+    type: number
+    title: original_shipping_total
+    description: The cart's original shipping total.
+  original_shipping_subtotal:
+    type: number
+    title: original_shipping_subtotal
+    description: The cart's original shipping subtotal.
+  original_shipping_tax_total:
+    type: number
+    title: original_shipping_tax_total
+    description: The cart's original shipping tax total.