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

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>

docs/api/admin/code_samples/JavaScript/orders_{id}_line-items_{line_item_id}_reserve/postundefined

@@ -0,0 +1,9 @@
+import Medusa from "@medusajs/medusa-js"
+const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
+// must be previously logged in or use api token
+medusa.admin.orders.createReservation(order_id, line_item_id, {
+  location_id
+})
+.then(({ reservation }) => {
+  console.log(reservation.id);
+});

docs/api/admin/code_samples/JavaScript/orders_{id}_reservations/getundefined

@@ -0,0 +1,7 @@
+import Medusa from "@medusajs/medusa-js"
+const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
+// must be previously logged in or use api token
+medusa.admin.orders.retrieveReservations(order_id)
+.then(({ reservations }) => {
+  console.log(reservations[0].id);
+});

docs/api/admin/code_samples/JavaScript/reservations/postundefined

@@ -0,0 +1,8 @@
+import Medusa from "@medusajs/medusa-js"
+const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
+// must be previously logged in or use api token
+medusa.admin.reservations.create({
+})
+.then(({ reservations }) => {
+  console.log(reservations.id);
+});

docs/api/admin/code_samples/JavaScript/reservations_{id}/deleteundefined

@@ -0,0 +1,7 @@
+import Medusa from "@medusajs/medusa-js"
+const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
+// must be previously logged in or use api token
+medusa.admin.reservations.delete(reservation.id)
+.then(({ id, object, deleted }) => {
+  console.log(id);
+});

docs/api/admin/code_samples/JavaScript/reservations_{id}/getundefined

@@ -0,0 +1,7 @@
+import Medusa from "@medusajs/medusa-js"
+const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
+// must be previously logged in or use api token
+medusa.admin.reservations.retrieve(reservation_id)
+.then(({ reservation }) => {
+  console.log(reservation.id);
+});

docs/api/admin/code_samples/JavaScript/reservations_{id}/postundefined

@@ -0,0 +1,9 @@
+import Medusa from "@medusajs/medusa-js"
+const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
+// must be previously logged in or use api token
+medusa.admin.reservations.update(reservation.id, {
+  quantity: 3
+})
+.then(({ reservations }) => {
+  console.log(reservations.id);
+});

docs/api/admin/code_samples/Shell/orders_{id}_line-items_{line_item_id}_reserve/postundefined

@@ -0,0 +1,6 @@
+curl --location --request POST 'https://medusa-url.com/admin/orders/{id}/line-items/{line_item_id}/reservations' \
+--header 'Authorization: Bearer {api_token}' \
+--header 'Content-Type: application/json' \
+--data-raw '{
+    "location_id": "loc_1"
+}'

docs/api/admin/code_samples/Shell/orders_{id}_reservations/getundefined

@@ -0,0 +1,2 @@
+curl --location --request GET 'https://medusa-url.com/admin/orders/{id}/reservations' \
+--header 'Authorization: Bearer {api_token}'

docs/api/admin/code_samples/Shell/product-categories_{id}/postundefined

@@ -0,0 +1,6 @@
+curl --location --request POST 'https://medusa-url.com/admin/product-categories/{id}' \
+--header 'Authorization: Bearer {api_token}' \
+--header 'Content-Type: application/json' \
+--data-raw '{
+    "name": "Skinny Jeans"
+}'

docs/api/admin/code_samples/Shell/reservations/getundefined

@@ -0,0 +1,2 @@
+curl --location --request GET 'https://medusa-url.com/admin/product-categories' \
+--header 'Authorization: Bearer {api_token}'

docs/api/admin/code_samples/Shell/reservations/postundefined

@@ -0,0 +1,8 @@
+curl --location --request POST 'https://medusa-url.com/admin/reservations' \
+--header 'Authorization: Bearer {api_token}' \
+--header 'Content-Type: application/json' \
+--data-raw '{
+    "resource_id": "{resource_id}",
+    "resource_type": "order",
+    "value": "We delivered this order"
+}'

docs/api/admin/code_samples/Shell/reservations_{id}/deleteundefined

@@ -0,0 +1,2 @@
+curl --location --request DELETE 'https://medusa-url.com/admin/reservations/{id}' \
+--header 'Authorization: Bearer {api_token}'

docs/api/admin/code_samples/Shell/reservations_{id}/getundefined

@@ -0,0 +1,2 @@
+curl --location --request GET 'https://medusa-url.com/admin/reservations/{id}' \
+--header 'Authorization: Bearer {api_token}'

docs/api/admin/code_samples/Shell/reservations_{id}/postundefined

@@ -0,0 +1,6 @@
+curl --location --request POST 'https://medusa-url.com/admin/reservations/{id}' \
+--header 'Authorization: Bearer {api_token}' \
+--header 'Content-Type: application/json' \
+--data-raw '{
+   "quantity": 3,
+}'

docs/api/admin/components/schemas/AdminAppsListRes.yaml

@@ -0,0 +1,6 @@
+type: object
+properties:
+  apps:
+    type: array
+    items:
+      $ref: ./OAuth.yaml

docs/api/admin/components/schemas/AdminAppsRes.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  apps:
+    $ref: ./OAuth.yaml

docs/api/admin/components/schemas/AdminAuthRes.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  user:
+    $ref: ./User.yaml

docs/api/admin/components/schemas/AdminBatchJobListRes.yaml

@@ -0,0 +1,15 @@
+type: object
+properties:
+  batch_jobs:
+    type: array
+    items:
+      $ref: ./BatchJob.yaml
+  count:
+    type: integer
+    description: The total number of items available
+  offset:
+    type: integer
+    description: The number of items skipped before these items
+  limit:
+    type: integer
+    description: The number of items per page

docs/api/admin/components/schemas/AdminBatchJobRes.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  batch_job:
+    $ref: ./BatchJob.yaml

docs/api/admin/components/schemas/AdminCollectionsDeleteRes.yaml

@@ -0,0 +1,13 @@
+type: object
+properties:
+  id:
+    type: string
+    description: The ID of the deleted Collection
+  object:
+    type: string
+    description: The type of the object that was deleted.
+    default: product-collection
+  deleted:
+    type: boolean
+    description: Whether the collection was deleted successfully or not.
+    default: true

docs/api/admin/components/schemas/AdminCollectionsListRes.yaml

@@ -0,0 +1,15 @@
+type: object
+properties:
+  collections:
+    type: array
+    items:
+      $ref: ./ProductCollection.yaml
+  count:
+    type: integer
+    description: The total number of items available
+  offset:
+    type: integer
+    description: The number of items skipped before these items
+  limit:
+    type: integer
+    description: The number of items per page

docs/api/admin/components/schemas/AdminCollectionsRes.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  collection:
+    $ref: ./ProductCollection.yaml

docs/api/admin/components/schemas/AdminCurrenciesListRes.yaml

@@ -0,0 +1,15 @@
+type: object
+properties:
+  currencies:
+    type: array
+    items:
+      $ref: ./Currency.yaml
+  count:
+    type: integer
+    description: The total number of items available
+  offset:
+    type: integer
+    description: The number of items skipped before these items
+  limit:
+    type: integer
+    description: The number of items per page

docs/api/admin/components/schemas/AdminCurrenciesRes.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  currency:
+    $ref: ./Currency.yaml

docs/api/admin/components/schemas/AdminCustomerGroupsDeleteRes.yaml

@@ -0,0 +1,13 @@
+type: object
+properties:
+  id:
+    type: string
+    description: The ID of the deleted customer group.
+  object:
+    type: string
+    description: The type of the object that was deleted.
+    default: customer_group
+  deleted:
+    type: boolean
+    description: Whether the customer group was deleted successfully or not.
+    default: true

docs/api/admin/components/schemas/AdminCustomerGroupsListRes.yaml

@@ -0,0 +1,15 @@
+type: object
+properties:
+  customer_groups:
+    type: array
+    items:
+      $ref: ./CustomerGroup.yaml
+  count:
+    type: integer
+    description: The total number of items available
+  offset:
+    type: integer
+    description: The number of items skipped before these items
+  limit:
+    type: integer
+    description: The number of items per page

docs/api/admin/components/schemas/AdminCustomerGroupsRes.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  customer_group:
+    $ref: ./CustomerGroup.yaml

docs/api/admin/components/schemas/AdminCustomersListRes.yaml

@@ -0,0 +1,15 @@
+type: object
+properties:
+  customers:
+    type: array
+    items:
+      $ref: ./Customer.yaml
+  count:
+    type: integer
+    description: The total number of items available
+  offset:
+    type: integer
+    description: The number of items skipped before these items
+  limit:
+    type: integer
+    description: The number of items per page

docs/api/admin/components/schemas/AdminCustomersRes.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  customer:
+    $ref: ./Customer.yaml

docs/api/admin/components/schemas/AdminDeleteProductsFromCollectionRes.yaml

@@ -0,0 +1,15 @@
+type: object
+properties:
+  id:
+    type: string
+    description: The ID of the collection
+  object:
+    type: string
+    description: The type of object the removal was executed on
+    default: product-collection
+  removed_products:
+    description: The IDs of the products removed from the collection
+    type: array
+    items:
+      description: The ID of a Product to add to the Product Collection.
+      type: string

docs/api/admin/components/schemas/AdminDeleteShippingProfileRes.yaml

@@ -0,0 +1,13 @@
+type: object
+properties:
+  id:
+    type: string
+    description: The ID of the deleted Shipping Profile.
+  object:
+    type: string
+    description: The type of the object that was deleted.
+    default: shipping_profile
+  deleted:
+    type: boolean
+    description: Whether or not the items were deleted.
+    default: true

docs/api/admin/components/schemas/AdminDeleteUploadsRes.yaml

@@ -0,0 +1,13 @@
+type: object
+properties:
+  id:
+    type: string
+    description: The file key of the upload deleted
+  object:
+    type: string
+    description: The type of the object that was deleted.
+    default: file
+  deleted:
+    type: boolean
+    description: Whether or not the items were deleted.
+    default: true

docs/api/admin/components/schemas/AdminDeleteUserRes.yaml

@@ -0,0 +1,13 @@
+type: object
+properties:
+  id:
+    type: string
+    description: The ID of the deleted user.
+  object:
+    type: string
+    description: The type of the object that was deleted.
+    default: user
+  deleted:
+    type: boolean
+    description: Whether or not the items were deleted.
+    default: true

docs/api/admin/components/schemas/AdminDiscountConditionsDeleteRes.yaml

@@ -0,0 +1,16 @@
+type: object
+properties:
+  id:
+    type: string
+    description: The ID of the deleted DiscountCondition
+  object:
+    type: string
+    description: The type of the object that was deleted.
+    default: discount-condition
+  deleted:
+    type: boolean
+    description: Whether the discount condition was deleted successfully or not.
+    default: true
+  discount:
+    description: The Discount to which the condition used to belong
+    $ref: ./Discount.yaml

docs/api/admin/components/schemas/AdminDiscountConditionsRes.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  discount_condition:
+    $ref: ./DiscountCondition.yaml

docs/api/admin/components/schemas/AdminDiscountsDeleteRes.yaml

@@ -0,0 +1,13 @@
+type: object
+properties:
+  id:
+    type: string
+    description: The ID of the deleted Discount
+  object:
+    type: string
+    description: The type of the object that was deleted.
+    default: discount
+  deleted:
+    type: boolean
+    description: Whether the discount was deleted successfully or not.
+    default: true

docs/api/admin/components/schemas/AdminDiscountsListRes.yaml

@@ -0,0 +1,15 @@
+type: object
+properties:
+  discounts:
+    type: array
+    items:
+      $ref: ./Discount.yaml
+  count:
+    type: integer
+    description: The total number of items available
+  offset:
+    type: integer
+    description: The number of items skipped before these items
+  limit:
+    type: integer
+    description: The number of items per page

docs/api/admin/components/schemas/AdminDiscountsRes.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  discount:
+    $ref: ./Discount.yaml

docs/api/admin/components/schemas/AdminDraftOrdersDeleteRes.yaml

@@ -0,0 +1,13 @@
+type: object
+properties:
+  id:
+    type: string
+    description: The ID of the deleted Draft Order.
+  object:
+    type: string
+    description: The type of the object that was deleted.
+    default: draft-order
+  deleted:
+    type: boolean
+    description: Whether the draft order was deleted successfully or not.
+    default: true

docs/api/admin/components/schemas/AdminDraftOrdersListRes.yaml

@@ -0,0 +1,15 @@
+type: object
+properties:
+  draft_orders:
+    type: array
+    items:
+      $ref: ./DraftOrder.yaml
+  count:
+    type: integer
+    description: The total number of items available
+  offset:
+    type: integer
+    description: The number of items skipped before these items
+  limit:
+    type: integer
+    description: The number of items per page

docs/api/admin/components/schemas/AdminDraftOrdersRes.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  draft_order:
+    $ref: ./DraftOrder.yaml

docs/api/admin/components/schemas/AdminGetRegionsRegionFulfillmentOptionsRes.yaml

@@ -0,0 +1,17 @@
+type: object
+properties:
+  fulfillment_options:
+    type: array
+    items:
+      type: object
+      properties:
+        provider_id:
+          type: string
+          description: ID of the fulfillment provider
+        options:
+          type: array
+          description: fulfillment provider options
+          example:
+            - id: manual-fulfillment
+            - id: manual-fulfillment-return
+              is_return: true

docs/api/admin/components/schemas/AdminGetReservationReservationsReq.yaml

@@ -0,0 +1,15 @@
+type: object
+properties:
+  reservations:
+    type: array
+    items:
+      $ref: ./ReservationItemDTO.yaml
+  count:
+    type: integer
+    description: The total number of items available
+  offset:
+    type: integer
+    description: The number of items skipped before these items
+  limit:
+    type: integer
+    description: The number of items per page

docs/api/admin/components/schemas/AdminGiftCardsDeleteRes.yaml

@@ -0,0 +1,13 @@
+type: object
+properties:
+  id:
+    type: string
+    description: The ID of the deleted Gift Card
+  object:
+    type: string
+    description: The type of the object that was deleted.
+    default: gift-card
+  deleted:
+    type: boolean
+    description: Whether the gift card was deleted successfully or not.
+    default: true

docs/api/admin/components/schemas/AdminGiftCardsListRes.yaml

@@ -0,0 +1,15 @@
+type: object
+properties:
+  gift_cards:
+    type: array
+    items:
+      $ref: ./GiftCard.yaml
+  count:
+    type: integer
+    description: The total number of items available
+  offset:
+    type: integer
+    description: The number of items skipped before these items
+  limit:
+    type: integer
+    description: The number of items per page

docs/api/admin/components/schemas/AdminGiftCardsRes.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  gift_card:
+    $ref: ./GiftCard.yaml

docs/api/admin/components/schemas/AdminInviteDeleteRes.yaml

@@ -0,0 +1,13 @@
+type: object
+properties:
+  id:
+    type: string
+    description: The ID of the deleted Invite.
+  object:
+    type: string
+    description: The type of the object that was deleted.
+    default: invite
+  deleted:
+    type: boolean
+    description: Whether or not the Invite was deleted.
+    default: true

docs/api/admin/components/schemas/AdminListInvitesRes.yaml

@@ -0,0 +1,6 @@
+type: object
+properties:
+  invites:
+    type: array
+    items:
+      $ref: ./Invite.yaml

docs/api/admin/components/schemas/AdminNotesDeleteRes.yaml

@@ -0,0 +1,13 @@
+type: object
+properties:
+  id:
+    type: string
+    description: The ID of the deleted Note.
+  object:
+    type: string
+    description: The type of the object that was deleted.
+    default: note
+  deleted:
+    type: boolean
+    description: Whether or not the Note was deleted.
+    default: true

docs/api/admin/components/schemas/AdminNotesListRes.yaml

@@ -0,0 +1,15 @@
+type: object
+properties:
+  notes:
+    type: array
+    items:
+      $ref: ./Note.yaml
+  count:
+    type: integer
+    description: The total number of items available
+  offset:
+    type: integer
+    description: The number of items skipped before these items
+  limit:
+    type: integer
+    description: The number of items per page

docs/api/admin/components/schemas/AdminNotesRes.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  note:
+    $ref: ./Note.yaml

docs/api/admin/components/schemas/AdminNotificationsListRes.yaml

@@ -0,0 +1,6 @@
+type: object
+properties:
+  notifications:
+    type: array
+    items:
+      $ref: ./Notification.yaml

docs/api/admin/components/schemas/AdminNotificationsRes.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  notification:
+    $ref: ./Notification.yaml

docs/api/admin/components/schemas/AdminOrderEditDeleteRes.yaml

@@ -0,0 +1,13 @@
+type: object
+properties:
+  id:
+    type: string
+    description: The ID of the deleted Order Edit.
+  object:
+    type: string
+    description: The type of the object that was deleted.
+    default: order_edit
+  deleted:
+    type: boolean
+    description: Whether or not the Order Edit was deleted.
+    default: true

docs/api/admin/components/schemas/AdminOrderEditItemChangeDeleteRes.yaml

@@ -0,0 +1,13 @@
+type: object
+properties:
+  id:
+    type: string
+    description: The ID of the deleted Order Edit Item Change.
+  object:
+    type: string
+    description: The type of the object that was deleted.
+    default: item_change
+  deleted:
+    type: boolean
+    description: Whether or not the Order Edit Item Change was deleted.
+    default: true

docs/api/admin/components/schemas/AdminOrderEditsListRes.yaml

@@ -0,0 +1,15 @@
+type: object
+properties:
+  order_edits:
+    type: array
+    items:
+      $ref: ./OrderEdit.yaml
+  count:
+    type: integer
+    description: The total number of items available
+  offset:
+    type: integer
+    description: The number of items skipped before these items
+  limit:
+    type: integer
+    description: The number of items per page

docs/api/admin/components/schemas/AdminOrderEditsRes.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  order_edit:
+    $ref: ./OrderEdit.yaml

docs/api/admin/components/schemas/AdminOrdersListRes.yaml

@@ -0,0 +1,15 @@
+type: object
+properties:
+  orders:
+    type: array
+    items:
+      $ref: ./Order.yaml
+  count:
+    type: integer
+    description: The total number of items available
+  offset:
+    type: integer
+    description: The number of items skipped before these items
+  limit:
+    type: integer
+    description: The number of items per page

docs/api/admin/components/schemas/AdminOrdersOrderLineItemReservationReq.yaml

@@ -0,0 +1,10 @@
+type: object
+required:
+  - location_id
+properties:
+  location_id:
+    description: The id of the location of the reservation
+    type: string
+  quantity:
+    description: The quantity to reserve
+    type: number

docs/api/admin/components/schemas/AdminOrdersRes.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  order:
+    $ref: ./Order.yaml

docs/api/admin/components/schemas/AdminPaymentCollectionDeleteRes.yaml

@@ -0,0 +1,13 @@
+type: object
+properties:
+  id:
+    type: string
+    description: The ID of the deleted Payment Collection.
+  object:
+    type: string
+    description: The type of the object that was deleted.
+    default: payment_collection
+  deleted:
+    type: boolean
+    description: Whether or not the Payment Collection was deleted.
+    default: true

docs/api/admin/components/schemas/AdminPaymentCollectionsRes.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  payment_collection:
+    $ref: ./PaymentCollection.yaml

docs/api/admin/components/schemas/AdminPaymentProvidersList.yaml

@@ -0,0 +1,6 @@
+type: object
+properties:
+  payment_providers:
+    type: array
+    items:
+      $ref: ./PaymentProvider.yaml

docs/api/admin/components/schemas/AdminPaymentRes.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  payment:
+    $ref: ./Payment.yaml

docs/api/admin/components/schemas/AdminPostDraftOrdersDraftOrderRegisterPaymentRes.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  order:
+    $ref: ./Order.yaml

docs/api/admin/components/schemas/AdminPostProductCategoriesCategoryReq.yaml

@@ -0,0 +1,17 @@
+type: object
+properties:
+  name:
+    type: string
+    description: The name to identify the Product Category by.
+  handle:
+    type: string
+    description: A handle to be used in slugs.
+  is_internal:
+    type: boolean
+    description: A flag to make product category an internal category for admins
+  is_active:
+    type: boolean
+    description: A flag to make product category visible/hidden in the store front
+  parent_category_id:
+    type: string
+    description: The ID of the parent product category

docs/api/admin/components/schemas/AdminPostProductsProductVariantsReq.yaml

@@ -34,6 +34,7 @@ properties:
       Whether Medusa should keep track of the inventory for this Product
       Variant.
     type: boolean
+    default: true
   weight:
     description: The wieght of the Product Variant.
     type: number

docs/api/admin/components/schemas/AdminPostReservationsReq.yaml

@@ -0,0 +1,6 @@
+type: object
+required:
+  - reservation
+properties:
+  reservation:
+    $ref: ./ReservationItemDTO.yaml

docs/api/admin/components/schemas/AdminPostReservationsReservationReq.yaml

@@ -0,0 +1,11 @@
+type: object
+properties:
+  location_id:
+    description: The id of the location of the reservation
+    type: string
+  quantity:
+    description: The id of the reservation item
+    type: number
+  metadata:
+    description: An optional set of key-value pairs with additional information.
+    type: object

docs/api/admin/components/schemas/AdminPriceListDeleteBatchRes.yaml

@@ -0,0 +1,15 @@
+type: object
+properties:
+  ids:
+    type: array
+    items:
+      type: string
+      description: The IDs of the deleted Money Amounts (Prices).
+  object:
+    type: string
+    description: The type of the object that was deleted.
+    default: money-amount
+  deleted:
+    type: boolean
+    description: Whether or not the items were deleted.
+    default: true

docs/api/admin/components/schemas/AdminPriceListDeleteProductPricesRes.yaml

@@ -0,0 +1,15 @@
+type: object
+properties:
+  ids:
+    type: array
+    description: The price ids that have been deleted.
+    items:
+      type: string
+  object:
+    type: string
+    description: The type of the object that was deleted.
+    default: money-amount
+  deleted:
+    type: boolean
+    description: Whether or not the items were deleted.
+    default: true

docs/api/admin/components/schemas/AdminPriceListDeleteRes.yaml

@@ -0,0 +1,13 @@
+type: object
+properties:
+  id:
+    type: string
+    description: The ID of the deleted Price List.
+  object:
+    type: string
+    description: The type of the object that was deleted.
+    default: price-list
+  deleted:
+    type: boolean
+    description: Whether or not the items were deleted.
+    default: true

docs/api/admin/components/schemas/AdminPriceListDeleteVariantPricesRes.yaml

@@ -0,0 +1,15 @@
+type: object
+properties:
+  ids:
+    type: array
+    description: The price ids that have been deleted.
+    items:
+      type: string
+  object:
+    type: string
+    description: The type of the object that was deleted.
+    default: money-amount
+  deleted:
+    type: boolean
+    description: Whether or not the items were deleted.
+    default: true

docs/api/admin/components/schemas/AdminPriceListRes.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  price_list:
+    $ref: ./PriceList.yaml

docs/api/admin/components/schemas/AdminPriceListsListRes.yaml

@@ -0,0 +1,15 @@
+type: object
+properties:
+  price_lists:
+    type: array
+    items:
+      $ref: ./PriceList.yaml
+  count:
+    type: integer
+    description: The total number of items available
+  offset:
+    type: integer
+    description: The number of items skipped before these items
+  limit:
+    type: integer
+    description: The number of items per page

docs/api/admin/components/schemas/AdminPriceListsProductsListRes.yaml

@@ -0,0 +1,15 @@
+type: object
+properties:
+  products:
+    type: array
+    items:
+      $ref: ./Product.yaml
+  count:
+    type: integer
+    description: The total number of items available
+  offset:
+    type: integer
+    description: The number of items skipped before these items
+  limit:
+    type: integer
+    description: The number of items per page

docs/api/admin/components/schemas/AdminProductTagsListRes.yaml

@@ -0,0 +1,15 @@
+type: object
+properties:
+  product_tags:
+    type: array
+    items:
+      $ref: ./ProductTag.yaml
+  count:
+    type: integer
+    description: The total number of items available
+  offset:
+    type: integer
+    description: The number of items skipped before these items
+  limit:
+    type: integer
+    description: The number of items per page

docs/api/admin/components/schemas/AdminProductTypesListRes.yaml

@@ -0,0 +1,15 @@
+type: object
+properties:
+  product_types:
+    type: array
+    items:
+      $ref: ./ProductType.yaml
+  count:
+    type: integer
+    description: The total number of items available
+  offset:
+    type: integer
+    description: The number of items skipped before these items
+  limit:
+    type: integer
+    description: The number of items per page

docs/api/admin/components/schemas/AdminProductsDeleteOptionRes.yaml

@@ -0,0 +1,15 @@
+type: object
+properties:
+  option_id:
+    type: string
+    description: The ID of the deleted Product Option
+  object:
+    type: string
+    description: The type of the object that was deleted.
+    default: option
+  deleted:
+    type: boolean
+    description: Whether or not the items were deleted.
+    default: true
+  product:
+    $ref: ./Product.yaml

docs/api/admin/components/schemas/AdminProductsDeleteRes.yaml

@@ -0,0 +1,13 @@
+type: object
+properties:
+  id:
+    type: string
+    description: The ID of the deleted Product.
+  object:
+    type: string
+    description: The type of the object that was deleted.
+    default: product
+  deleted:
+    type: boolean
+    description: Whether or not the items were deleted.
+    default: true

docs/api/admin/components/schemas/AdminProductsDeleteVariantRes.yaml

@@ -0,0 +1,15 @@
+type: object
+properties:
+  variant_id:
+    type: string
+    description: The ID of the deleted Product Variant.
+  object:
+    type: string
+    description: The type of the object that was deleted.
+    default: product-variant
+  deleted:
+    type: boolean
+    description: Whether or not the items were deleted.
+    default: true
+  product:
+    $ref: ./Product.yaml

docs/api/admin/components/schemas/AdminProductsListRes.yaml

@@ -0,0 +1,17 @@
+type: object
+properties:
+  products:
+    type: array
+    items:
+      oneOf:
+        - $ref: ./Product.yaml
+        - $ref: ./PricedProduct.yaml
+  count:
+    type: integer
+    description: The total number of items available
+  offset:
+    type: integer
+    description: The number of items skipped before these items
+  limit:
+    type: integer
+    description: The number of items per page

docs/api/admin/components/schemas/AdminProductsListTagsRes.yaml

@@ -0,0 +1,15 @@
+type: object
+properties:
+  tags:
+    type: array
+    items:
+      properties:
+        id:
+          description: The ID of the tag.
+          type: string
+        usage_count:
+          description: The number of products that use this tag.
+          type: string
+        value:
+          description: The value of the tag.
+          type: string

docs/api/admin/components/schemas/AdminProductsListTypesRes.yaml

@@ -0,0 +1,6 @@
+type: object
+properties:
+  types:
+    type: array
+    items:
+      $ref: ./ProductType.yaml

docs/api/admin/components/schemas/AdminProductsListVariantsRes.yaml

@@ -0,0 +1,15 @@
+type: object
+properties:
+  variants:
+    type: array
+    items:
+      $ref: ./ProductVariant.yaml
+  count:
+    type: integer
+    description: The total number of items available
+  offset:
+    type: integer
+    description: The number of items skipped before these items
+  limit:
+    type: integer
+    description: The number of items per page

docs/api/admin/components/schemas/AdminProductsRes.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  product:
+    $ref: ./Product.yaml

docs/api/admin/components/schemas/AdminPublishableApiKeyDeleteRes.yaml

@@ -0,0 +1,13 @@
+type: object
+properties:
+  id:
+    type: string
+    description: The ID of the deleted PublishableApiKey.
+  object:
+    type: string
+    description: The type of the object that was deleted.
+    default: publishable_api_key
+  deleted:
+    type: boolean
+    description: Whether the PublishableApiKeys was deleted.
+    default: true

docs/api/admin/components/schemas/AdminPublishableApiKeysListRes.yaml

@@ -0,0 +1,15 @@
+type: object
+properties:
+  publishable_api_keys:
+    type: array
+    items:
+      $ref: ./PublishableApiKey.yaml
+  count:
+    type: integer
+    description: The total number of items available
+  offset:
+    type: integer
+    description: The number of items skipped before these items
+  limit:
+    type: integer
+    description: The number of items per page

docs/api/admin/components/schemas/AdminPublishableApiKeysListSalesChannelsRes.yaml

@@ -0,0 +1,6 @@
+type: object
+properties:
+  sales_channels:
+    type: array
+    items:
+      $ref: ./SalesChannel.yaml

docs/api/admin/components/schemas/AdminPublishableApiKeysRes.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  publishable_api_key:
+    $ref: ./PublishableApiKey.yaml

docs/api/admin/components/schemas/AdminRefundRes.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  refund:
+    $ref: ./Refund.yaml

docs/api/admin/components/schemas/AdminRegionsDeleteRes.yaml

@@ -0,0 +1,13 @@
+type: object
+properties:
+  id:
+    type: string
+    description: The ID of the deleted Region.
+  object:
+    type: string
+    description: The type of the object that was deleted.
+    default: region
+  deleted:
+    type: boolean
+    description: Whether or not the items were deleted.
+    default: true

docs/api/admin/components/schemas/AdminRegionsListRes.yaml

@@ -0,0 +1,15 @@
+type: object
+properties:
+  regions:
+    type: array
+    items:
+      $ref: ./Region.yaml
+  count:
+    type: integer
+    description: The total number of items available
+  offset:
+    type: integer
+    description: The number of items skipped before these items
+  limit:
+    type: integer
+    description: The number of items per page

docs/api/admin/components/schemas/AdminRegionsRes.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  region:
+    $ref: ./Region.yaml

docs/api/admin/components/schemas/AdminReturnReasonsDeleteRes.yaml

@@ -0,0 +1,13 @@
+type: object
+properties:
+  id:
+    type: string
+    description: The ID of the deleted return reason
+  object:
+    type: string
+    description: The type of the object that was deleted.
+    default: return_reason
+  deleted:
+    type: boolean
+    description: Whether or not the items were deleted.
+    default: true

docs/api/admin/components/schemas/AdminReturnReasonsListRes.yaml

@@ -0,0 +1,6 @@
+type: object
+properties:
+  return_reasons:
+    type: array
+    items:
+      $ref: ./ReturnReason.yaml

docs/api/admin/components/schemas/AdminReturnReasonsRes.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  return_reason:
+    $ref: ./ReturnReason.yaml

docs/api/admin/components/schemas/AdminReturnsCancelRes.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  order:
+    $ref: ./Order.yaml

docs/api/admin/components/schemas/AdminReturnsListRes.yaml

@@ -0,0 +1,15 @@
+type: object
+properties:
+  returns:
+    type: array
+    items:
+      $ref: ./Return.yaml
+  count:
+    type: integer
+    description: The total number of items available
+  offset:
+    type: integer
+    description: The number of items skipped before these items
+  limit:
+    type: integer
+    description: The number of items per page

docs/api/admin/components/schemas/AdminReturnsRes.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  return:
+    $ref: ./Return.yaml