From a48063ec26751d6cd54c278957d5d1d82aeb3a97 Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Thu, 31 Jul 2025 14:42:14 +0300 Subject: [PATCH] docs: add link to manage metadata section in OAS and API reference (#13102) --- .../schemas/AdminAddDraftOrderItems.yaml | 3 + .../AdminAddDraftOrderShippingMethod.yaml | 3 + .../schemas/AdminBatchUpdateProduct.yaml | 3 + .../AdminBatchUpdateProductVariant.yaml | 3 + .../admin/components/schemas/AdminClaim.yaml | 3 + .../components/schemas/AdminCollection.yaml | 3 + .../schemas/AdminCreateCustomerGroup.yaml | 3 + .../schemas/AdminCreateFulfillment.yaml | 6 + ...AdminCreateFulfillmentSetServiceZones.yaml | 12 + .../schemas/AdminCreateGiftCardParams.yaml | 3 + .../schemas/AdminCreateInventoryItem.yaml | 3 + .../schemas/AdminCreateOrderCreditLines.yaml | 3 + .../schemas/AdminCreateProduct.yaml | 3 + .../schemas/AdminCreateProductCategory.yaml | 3 + .../schemas/AdminCreateProductTag.yaml | 3 + .../schemas/AdminCreateProductType.yaml | 3 + .../schemas/AdminCreateProductVariant.yaml | 3 + .../components/schemas/AdminCreateRegion.yaml | 3 + .../schemas/AdminCreateReservation.yaml | 3 + .../schemas/AdminCreateReturnReason.yaml | 3 + .../schemas/AdminCreateSalesChannel.yaml | 3 + .../schemas/AdminCreateShippingProfile.yaml | 3 + .../schemas/AdminCreateStockLocation.yaml | 3 + .../AdminCreateStoreCreditAccount.yaml | 3 + .../schemas/AdminCreateTaxRate.yaml | 3 + .../schemas/AdminCreateTaxRegion.yaml | 6 + .../components/schemas/AdminCustomer.yaml | 3 + .../schemas/AdminCustomerAddress.yaml | 3 + .../schemas/AdminCustomerGroup.yaml | 3 + .../components/schemas/AdminDraftOrder.yaml | 3 + .../schemas/AdminDraftOrderPreview.yaml | 9 + .../components/schemas/AdminExchange.yaml | 3 + .../components/schemas/AdminFulfillment.yaml | 3 + .../schemas/AdminFulfillmentAddress.yaml | 3 + .../schemas/AdminInventoryLevel.yaml | 3 + .../admin/components/schemas/AdminInvite.yaml | 3 + .../admin/components/schemas/AdminOrder.yaml | 3 + .../components/schemas/AdminOrderAddress.yaml | 3 + .../components/schemas/AdminOrderChange.yaml | 3 + .../schemas/AdminOrderFulfillment.yaml | 3 + .../schemas/AdminOrderLineItem.yaml | 3 + .../components/schemas/AdminOrderPreview.yaml | 9 + .../schemas/AdminOrderShippingMethod.yaml | 3 + .../schemas/AdminPaymentCollection.yaml | 3 + .../AdminPostClaimsAddItemsReqSchema.yaml | 3 + ...dminPostClaimsShippingActionReqSchema.yaml | 3 + .../AdminPostClaimsShippingReqSchema.yaml | 3 + .../AdminPostExchangesAddItemsReqSchema.yaml | 3 + ...ngesRequestItemsReturnActionReqSchema.yaml | 3 + ...tExchangesReturnRequestItemsReqSchema.yaml | 3 + ...nPostExchangesShippingActionReqSchema.yaml | 3 + .../AdminPostExchangesShippingReqSchema.yaml | 3 + .../AdminPostOrderClaimsReqSchema.yaml | 3 + .../AdminPostOrderEditsAddItemsReqSchema.yaml | 3 + .../schemas/AdminPostOrderEditsReqSchema.yaml | 3 + ...PostOrderEditsShippingActionReqSchema.yaml | 3 + .../AdminPostOrderEditsShippingReqSchema.yaml | 3 + .../AdminPostOrderExchangesReqSchema.yaml | 3 + .../AdminPostReceiveReturnsReqSchema.yaml | 3 + .../schemas/AdminPostReturnsReqSchema.yaml | 3 + ...ostReturnsRequestItemsActionReqSchema.yaml | 3 + ...AdminPostReturnsRequestItemsReqSchema.yaml | 3 + .../AdminPostReturnsReturnReqSchema.yaml | 3 + ...minPostReturnsShippingActionReqSchema.yaml | 3 + .../AdminPostReturnsShippingReqSchema.yaml | 3 + .../components/schemas/AdminProduct.yaml | 3 + .../schemas/AdminProductCategory.yaml | 3 + .../components/schemas/AdminProductImage.yaml | 3 + .../schemas/AdminProductOption.yaml | 3 + .../schemas/AdminProductOptionValue.yaml | 3 + .../components/schemas/AdminProductTag.yaml | 3 + .../components/schemas/AdminProductType.yaml | 3 + .../schemas/AdminProductVariant.yaml | 3 + .../components/schemas/AdminRefundReason.yaml | 3 + .../admin/components/schemas/AdminRegion.yaml | 3 + .../components/schemas/AdminReservation.yaml | 3 + .../components/schemas/AdminReturnItem.yaml | 3 + .../components/schemas/AdminReturnReason.yaml | 3 + .../components/schemas/AdminSalesChannel.yaml | 3 + .../schemas/AdminShippingOption.yaml | 3 + .../schemas/AdminShippingProfile.yaml | 3 + .../admin/components/schemas/AdminStore.yaml | 3 + .../schemas/AdminStoreCreditAccount.yaml | 3 + .../components/schemas/AdminTaxRate.yaml | 3 + .../components/schemas/AdminTaxRegion.yaml | 3 + .../components/schemas/AdminTransaction.yaml | 3 + .../schemas/AdminTransactionGroup.yaml | 3 + .../schemas/AdminUpdateCustomerGroup.yaml | 3 + .../schemas/AdminUpdateDraftOrder.yaml | 9 + ...nUpdateDraftOrderActionShippingMethod.yaml | 3 + ...AdminUpdateFulfillmentSetServiceZones.yaml | 12 + .../schemas/AdminUpdateGiftCardParams.yaml | 3 + .../schemas/AdminUpdateInventoryItem.yaml | 3 + .../components/schemas/AdminUpdateOrder.yaml | 9 + .../schemas/AdminUpdateProduct.yaml | 3 + .../schemas/AdminUpdateProductCategory.yaml | 3 + .../schemas/AdminUpdateProductTag.yaml | 3 + .../schemas/AdminUpdateProductType.yaml | 3 + .../schemas/AdminUpdateProductVariant.yaml | 3 + .../components/schemas/AdminUpdateRegion.yaml | 3 + .../schemas/AdminUpdateReservation.yaml | 3 + .../schemas/AdminUpdateReturnReason.yaml | 3 + .../schemas/AdminUpdateSalesChannel.yaml | 3 + .../schemas/AdminUpdateShippingProfile.yaml | 3 + .../schemas/AdminUpdateStockLocation.yaml | 3 + .../components/schemas/AdminUpdateStore.yaml | 3 + .../schemas/AdminUpdateTaxRate.yaml | 3 + .../schemas/AdminUpdateTaxRegion.yaml | 3 + .../components/schemas/AdminUpdateUser.yaml | 3 + .../admin/components/schemas/AdminUser.yaml | 3 + .../admin/components/schemas/BaseCart.yaml | 3 + .../components/schemas/BaseCartLineItem.yaml | 3 + .../schemas/BaseCartShippingMethod.yaml | 3 + .../components/schemas/BaseClaimItem.yaml | 3 + .../components/schemas/BaseCollection.yaml | 3 + .../components/schemas/BaseExchangeItem.yaml | 3 + .../admin/components/schemas/BaseOrder.yaml | 3 + .../components/schemas/BaseOrderAddress.yaml | 3 + .../schemas/BaseOrderFulfillment.yaml | 3 + .../components/schemas/BaseOrderLineItem.yaml | 3 + .../schemas/BaseOrderShippingMethod.yaml | 3 + .../schemas/BaseOrderTransaction.yaml | 3 + .../schemas/BasePaymentCollection.yaml | 3 + .../admin/components/schemas/BaseProduct.yaml | 3 + .../schemas/BaseProductCategory.yaml | 3 + .../components/schemas/BaseProductImage.yaml | 3 + .../components/schemas/BaseProductOption.yaml | 3 + .../schemas/BaseProductOptionValue.yaml | 3 + .../components/schemas/BaseProductTag.yaml | 3 + .../components/schemas/BaseProductType.yaml | 3 + .../schemas/BaseProductVariant.yaml | 3 + .../admin/components/schemas/BaseRegion.yaml | 3 + .../components/schemas/CreateAddress.yaml | 3 + .../components/schemas/InventoryLevel.yaml | 3 + .../specs/admin/components/schemas/Order.yaml | 3 + .../components/schemas/OrderAddress.yaml | 3 + .../admin/components/schemas/OrderChange.yaml | 3 + .../admin/components/schemas/OrderClaim.yaml | 3 + .../components/schemas/OrderCreditLine.yaml | 3 + .../components/schemas/OrderExchange.yaml | 3 + .../admin/components/schemas/OrderItem.yaml | 3 + .../components/schemas/OrderLineItem.yaml | 3 + .../components/schemas/OrderReturnItem.yaml | 3 + .../schemas/OrderShippingMethod.yaml | 3 + .../components/schemas/OrderTransaction.yaml | 3 + .../components/schemas/RefundReason.yaml | 3 + .../admin/components/schemas/Return.yaml | 3 + .../schemas/StoreAddCartLineItem.yaml | 3 + .../admin/components/schemas/StoreCart.yaml | 3 + .../components/schemas/StoreCartAddress.yaml | 3 + .../components/schemas/StoreCartLineItem.yaml | 3 + .../schemas/StoreCartShippingMethod.yaml | 3 + .../components/schemas/StoreCollection.yaml | 3 + .../components/schemas/StoreCreateCart.yaml | 3 + .../schemas/StoreCreateCustomer.yaml | 3 + .../components/schemas/StoreCustomer.yaml | 3 + .../schemas/StoreCustomerAddress.yaml | 3 + .../admin/components/schemas/StoreOrder.yaml | 3 + .../components/schemas/StoreOrderAddress.yaml | 3 + .../schemas/StoreOrderFulfillment.yaml | 3 + .../schemas/StoreOrderLineItem.yaml | 65 ++ .../schemas/StoreOrderShippingMethod.yaml | 18 + .../schemas/StorePaymentCollection.yaml | 3 + .../components/schemas/StoreProduct.yaml | 3 + .../schemas/StoreProductCategory.yaml | 3 + .../components/schemas/StoreProductImage.yaml | 3 + .../schemas/StoreProductOption.yaml | 3 + .../schemas/StoreProductOptionValue.yaml | 3 + .../components/schemas/StoreProductTag.yaml | 3 + .../components/schemas/StoreProductType.yaml | 3 + .../schemas/StoreProductVariant.yaml | 3 + .../admin/components/schemas/StoreRegion.yaml | 3 + .../components/schemas/StoreReturnItem.yaml | 3 + .../components/schemas/StoreReturnReason.yaml | 3 + .../schemas/StoreShippingOption.yaml | 3 + .../schemas/StoreStoreCreditAccount.yaml | 3 + .../schemas/StoreTransactionGroup.yaml | 3 + .../schemas/StoreUpdateCartLineItem.yaml | 3 + .../schemas/StoreUpdateCustomer.yaml | 3 + .../components/schemas/UpdateAddress.yaml | 3 + .../components/schemas/UpdateCartData.yaml | 3 + .../specs/admin/openapi.full.yaml | 666 ++++++++++++++++++ .../schemas/AdminAddDraftOrderItems.yaml | 3 + .../AdminAddDraftOrderShippingMethod.yaml | 3 + .../schemas/AdminBatchUpdateProduct.yaml | 3 + .../AdminBatchUpdateProductVariant.yaml | 3 + .../store/components/schemas/AdminClaim.yaml | 3 + .../components/schemas/AdminCollection.yaml | 3 + .../schemas/AdminCreateCustomerGroup.yaml | 3 + .../schemas/AdminCreateFulfillment.yaml | 6 + ...AdminCreateFulfillmentSetServiceZones.yaml | 12 + .../schemas/AdminCreateGiftCardParams.yaml | 3 + .../schemas/AdminCreateInventoryItem.yaml | 3 + .../schemas/AdminCreateOrderCreditLines.yaml | 3 + .../schemas/AdminCreateProduct.yaml | 3 + .../schemas/AdminCreateProductCategory.yaml | 3 + .../schemas/AdminCreateProductTag.yaml | 3 + .../schemas/AdminCreateProductType.yaml | 3 + .../schemas/AdminCreateProductVariant.yaml | 3 + .../components/schemas/AdminCreateRegion.yaml | 3 + .../schemas/AdminCreateReservation.yaml | 3 + .../schemas/AdminCreateReturnReason.yaml | 3 + .../schemas/AdminCreateSalesChannel.yaml | 3 + .../schemas/AdminCreateShippingProfile.yaml | 3 + .../schemas/AdminCreateStockLocation.yaml | 3 + .../AdminCreateStoreCreditAccount.yaml | 3 + .../schemas/AdminCreateTaxRate.yaml | 3 + .../schemas/AdminCreateTaxRegion.yaml | 6 + .../components/schemas/AdminCustomer.yaml | 3 + .../schemas/AdminCustomerAddress.yaml | 3 + .../schemas/AdminCustomerGroup.yaml | 3 + .../components/schemas/AdminDraftOrder.yaml | 3 + .../schemas/AdminDraftOrderPreview.yaml | 9 + .../components/schemas/AdminExchange.yaml | 3 + .../components/schemas/AdminFulfillment.yaml | 3 + .../schemas/AdminFulfillmentAddress.yaml | 3 + .../schemas/AdminInventoryLevel.yaml | 3 + .../store/components/schemas/AdminInvite.yaml | 3 + .../store/components/schemas/AdminOrder.yaml | 3 + .../components/schemas/AdminOrderAddress.yaml | 3 + .../components/schemas/AdminOrderChange.yaml | 3 + .../schemas/AdminOrderFulfillment.yaml | 3 + .../schemas/AdminOrderLineItem.yaml | 3 + .../components/schemas/AdminOrderPreview.yaml | 9 + .../schemas/AdminOrderShippingMethod.yaml | 3 + .../schemas/AdminPaymentCollection.yaml | 3 + .../AdminPostClaimsAddItemsReqSchema.yaml | 3 + ...dminPostClaimsShippingActionReqSchema.yaml | 3 + .../AdminPostClaimsShippingReqSchema.yaml | 3 + .../AdminPostExchangesAddItemsReqSchema.yaml | 3 + ...ngesRequestItemsReturnActionReqSchema.yaml | 3 + ...tExchangesReturnRequestItemsReqSchema.yaml | 3 + ...nPostExchangesShippingActionReqSchema.yaml | 3 + .../AdminPostExchangesShippingReqSchema.yaml | 3 + .../AdminPostOrderClaimsReqSchema.yaml | 3 + .../AdminPostOrderEditsAddItemsReqSchema.yaml | 3 + .../schemas/AdminPostOrderEditsReqSchema.yaml | 3 + ...PostOrderEditsShippingActionReqSchema.yaml | 3 + .../AdminPostOrderEditsShippingReqSchema.yaml | 3 + .../AdminPostOrderExchangesReqSchema.yaml | 3 + .../AdminPostReceiveReturnsReqSchema.yaml | 3 + .../schemas/AdminPostReturnsReqSchema.yaml | 3 + ...ostReturnsRequestItemsActionReqSchema.yaml | 3 + ...AdminPostReturnsRequestItemsReqSchema.yaml | 3 + .../AdminPostReturnsReturnReqSchema.yaml | 3 + ...minPostReturnsShippingActionReqSchema.yaml | 3 + .../AdminPostReturnsShippingReqSchema.yaml | 3 + .../components/schemas/AdminProduct.yaml | 3 + .../schemas/AdminProductCategory.yaml | 3 + .../components/schemas/AdminProductImage.yaml | 3 + .../schemas/AdminProductOption.yaml | 3 + .../schemas/AdminProductOptionValue.yaml | 3 + .../components/schemas/AdminProductTag.yaml | 3 + .../components/schemas/AdminProductType.yaml | 3 + .../schemas/AdminProductVariant.yaml | 3 + .../components/schemas/AdminRefundReason.yaml | 3 + .../store/components/schemas/AdminRegion.yaml | 3 + .../components/schemas/AdminReservation.yaml | 3 + .../components/schemas/AdminReturnItem.yaml | 3 + .../components/schemas/AdminReturnReason.yaml | 3 + .../components/schemas/AdminSalesChannel.yaml | 3 + .../schemas/AdminShippingOption.yaml | 3 + .../schemas/AdminShippingProfile.yaml | 3 + .../store/components/schemas/AdminStore.yaml | 3 + .../schemas/AdminStoreCreditAccount.yaml | 3 + .../components/schemas/AdminTaxRate.yaml | 3 + .../components/schemas/AdminTaxRegion.yaml | 3 + .../components/schemas/AdminTransaction.yaml | 3 + .../schemas/AdminTransactionGroup.yaml | 3 + .../schemas/AdminUpdateCustomerGroup.yaml | 3 + .../schemas/AdminUpdateDraftOrder.yaml | 9 + ...nUpdateDraftOrderActionShippingMethod.yaml | 3 + ...AdminUpdateFulfillmentSetServiceZones.yaml | 12 + .../schemas/AdminUpdateGiftCardParams.yaml | 3 + .../schemas/AdminUpdateInventoryItem.yaml | 3 + .../components/schemas/AdminUpdateOrder.yaml | 9 + .../schemas/AdminUpdateProduct.yaml | 3 + .../schemas/AdminUpdateProductCategory.yaml | 3 + .../schemas/AdminUpdateProductTag.yaml | 3 + .../schemas/AdminUpdateProductType.yaml | 3 + .../schemas/AdminUpdateProductVariant.yaml | 3 + .../components/schemas/AdminUpdateRegion.yaml | 3 + .../schemas/AdminUpdateReservation.yaml | 3 + .../schemas/AdminUpdateReturnReason.yaml | 3 + .../schemas/AdminUpdateSalesChannel.yaml | 3 + .../schemas/AdminUpdateShippingProfile.yaml | 3 + .../schemas/AdminUpdateStockLocation.yaml | 3 + .../components/schemas/AdminUpdateStore.yaml | 3 + .../schemas/AdminUpdateTaxRate.yaml | 3 + .../schemas/AdminUpdateTaxRegion.yaml | 3 + .../components/schemas/AdminUpdateUser.yaml | 3 + .../store/components/schemas/AdminUser.yaml | 3 + .../store/components/schemas/BaseCart.yaml | 3 + .../components/schemas/BaseCartLineItem.yaml | 3 + .../schemas/BaseCartShippingMethod.yaml | 3 + .../components/schemas/BaseClaimItem.yaml | 3 + .../components/schemas/BaseCollection.yaml | 3 + .../components/schemas/BaseExchangeItem.yaml | 3 + .../store/components/schemas/BaseOrder.yaml | 3 + .../components/schemas/BaseOrderAddress.yaml | 3 + .../schemas/BaseOrderFulfillment.yaml | 3 + .../components/schemas/BaseOrderLineItem.yaml | 3 + .../schemas/BaseOrderShippingMethod.yaml | 3 + .../schemas/BaseOrderTransaction.yaml | 3 + .../schemas/BasePaymentCollection.yaml | 3 + .../store/components/schemas/BaseProduct.yaml | 3 + .../schemas/BaseProductCategory.yaml | 3 + .../components/schemas/BaseProductImage.yaml | 3 + .../components/schemas/BaseProductOption.yaml | 3 + .../schemas/BaseProductOptionValue.yaml | 3 + .../components/schemas/BaseProductTag.yaml | 3 + .../components/schemas/BaseProductType.yaml | 3 + .../schemas/BaseProductVariant.yaml | 3 + .../store/components/schemas/BaseRegion.yaml | 3 + .../components/schemas/CreateAddress.yaml | 3 + .../components/schemas/InventoryLevel.yaml | 3 + .../specs/store/components/schemas/Order.yaml | 3 + .../components/schemas/OrderAddress.yaml | 3 + .../store/components/schemas/OrderChange.yaml | 3 + .../store/components/schemas/OrderClaim.yaml | 3 + .../components/schemas/OrderCreditLine.yaml | 3 + .../components/schemas/OrderExchange.yaml | 3 + .../store/components/schemas/OrderItem.yaml | 3 + .../components/schemas/OrderLineItem.yaml | 3 + .../components/schemas/OrderReturnItem.yaml | 3 + .../schemas/OrderShippingMethod.yaml | 3 + .../components/schemas/OrderTransaction.yaml | 3 + .../components/schemas/RefundReason.yaml | 3 + .../store/components/schemas/Return.yaml | 3 + .../schemas/StoreAddCartLineItem.yaml | 3 + .../store/components/schemas/StoreCart.yaml | 3 + .../components/schemas/StoreCartAddress.yaml | 3 + .../components/schemas/StoreCartLineItem.yaml | 3 + .../schemas/StoreCartShippingMethod.yaml | 3 + .../components/schemas/StoreCollection.yaml | 3 + .../components/schemas/StoreCreateCart.yaml | 3 + .../schemas/StoreCreateCustomer.yaml | 3 + .../components/schemas/StoreCustomer.yaml | 3 + .../schemas/StoreCustomerAddress.yaml | 3 + .../store/components/schemas/StoreOrder.yaml | 3 + .../components/schemas/StoreOrderAddress.yaml | 3 + .../schemas/StoreOrderFulfillment.yaml | 3 + .../schemas/StoreOrderLineItem.yaml | 65 ++ .../schemas/StoreOrderShippingMethod.yaml | 18 + .../schemas/StorePaymentCollection.yaml | 3 + .../components/schemas/StoreProduct.yaml | 3 + .../schemas/StoreProductCategory.yaml | 3 + .../components/schemas/StoreProductImage.yaml | 3 + .../schemas/StoreProductOption.yaml | 3 + .../schemas/StoreProductOptionValue.yaml | 3 + .../components/schemas/StoreProductTag.yaml | 3 + .../components/schemas/StoreProductType.yaml | 3 + .../schemas/StoreProductVariant.yaml | 3 + .../store/components/schemas/StoreRegion.yaml | 3 + .../components/schemas/StoreReturnItem.yaml | 3 + .../components/schemas/StoreReturnReason.yaml | 3 + .../schemas/StoreShippingOption.yaml | 3 + .../schemas/StoreStoreCreditAccount.yaml | 3 + .../schemas/StoreTransactionGroup.yaml | 3 + .../schemas/StoreUpdateCartLineItem.yaml | 3 + .../schemas/StoreUpdateCustomer.yaml | 3 + .../components/schemas/UpdateAddress.yaml | 3 + .../components/schemas/UpdateCartData.yaml | 3 + .../specs/store/openapi.full.yaml | 666 ++++++++++++++++++ .../data-models/json-properties/page.mdx | 8 +- www/apps/book/generated/edit-dates.mjs | 2 +- www/apps/book/public/llms-full.txt | 8 +- www/apps/book/public/llms.txt | 2 +- .../schemas/AdminAddDraftOrderItems.ts | 3 + .../AdminAddDraftOrderShippingMethod.ts | 3 + .../schemas/AdminBatchUpdateProduct.ts | 3 + .../schemas/AdminBatchUpdateProductVariant.ts | 3 + .../oas-output/schemas/AdminClaim.ts | 3 + .../oas-output/schemas/AdminCollection.ts | 3 + .../schemas/AdminCreateCustomerGroup.ts | 3 + .../schemas/AdminCreateFulfillment.ts | 6 + .../AdminCreateFulfillmentSetServiceZones.ts | 12 + .../schemas/AdminCreateGiftCardParams.ts | 3 + .../schemas/AdminCreateInventoryItem.ts | 3 + .../schemas/AdminCreateOrderCreditLines.ts | 3 + .../oas-output/schemas/AdminCreateProduct.ts | 3 + .../schemas/AdminCreateProductCategory.ts | 3 + .../schemas/AdminCreateProductTag.ts | 3 + .../schemas/AdminCreateProductType.ts | 3 + .../schemas/AdminCreateProductVariant.ts | 3 + .../oas-output/schemas/AdminCreateRegion.ts | 3 + .../schemas/AdminCreateReservation.ts | 3 + .../schemas/AdminCreateReturnReason.ts | 3 + .../schemas/AdminCreateSalesChannel.ts | 3 + .../schemas/AdminCreateShippingProfile.ts | 3 + .../schemas/AdminCreateStockLocation.ts | 3 + .../schemas/AdminCreateStoreCreditAccount.ts | 3 + .../oas-output/schemas/AdminCreateTaxRate.ts | 3 + .../schemas/AdminCreateTaxRegion.ts | 6 + .../oas-output/schemas/AdminCustomer.ts | 3 + .../schemas/AdminCustomerAddress.ts | 3 + .../oas-output/schemas/AdminCustomerGroup.ts | 3 + .../oas-output/schemas/AdminDraftOrder.ts | 3 + .../schemas/AdminDraftOrderPreview.ts | 9 + .../oas-output/schemas/AdminExchange.ts | 3 + .../oas-output/schemas/AdminFulfillment.ts | 3 + .../schemas/AdminFulfillmentAddress.ts | 3 + .../oas-output/schemas/AdminInventoryLevel.ts | 3 + .../oas-output/schemas/AdminInvite.ts | 3 + .../oas-output/schemas/AdminOrder.ts | 3 + .../oas-output/schemas/AdminOrderAddress.ts | 3 + .../oas-output/schemas/AdminOrderChange.ts | 3 + .../schemas/AdminOrderFulfillment.ts | 3 + .../oas-output/schemas/AdminOrderLineItem.ts | 3 + .../oas-output/schemas/AdminOrderPreview.ts | 9 + .../schemas/AdminOrderShippingMethod.ts | 3 + .../schemas/AdminPaymentCollection.ts | 3 + .../AdminPostClaimsAddItemsReqSchema.ts | 3 + .../AdminPostClaimsShippingActionReqSchema.ts | 3 + .../AdminPostClaimsShippingReqSchema.ts | 3 + .../AdminPostExchangesAddItemsReqSchema.ts | 3 + ...hangesRequestItemsReturnActionReqSchema.ts | 3 + ...ostExchangesReturnRequestItemsReqSchema.ts | 3 + ...minPostExchangesShippingActionReqSchema.ts | 3 + .../AdminPostExchangesShippingReqSchema.ts | 3 + .../schemas/AdminPostOrderClaimsReqSchema.ts | 3 + .../AdminPostOrderEditsAddItemsReqSchema.ts | 3 + .../schemas/AdminPostOrderEditsReqSchema.ts | 3 + ...inPostOrderEditsShippingActionReqSchema.ts | 3 + .../AdminPostOrderEditsShippingReqSchema.ts | 3 + .../AdminPostOrderExchangesReqSchema.ts | 3 + .../AdminPostReceiveReturnsReqSchema.ts | 3 + .../schemas/AdminPostReturnsReqSchema.ts | 3 + ...nPostReturnsRequestItemsActionReqSchema.ts | 3 + .../AdminPostReturnsRequestItemsReqSchema.ts | 3 + .../AdminPostReturnsReturnReqSchema.ts | 3 + ...AdminPostReturnsShippingActionReqSchema.ts | 3 + .../AdminPostReturnsShippingReqSchema.ts | 3 + .../oas-output/schemas/AdminProduct.ts | 3 + .../schemas/AdminProductCategory.ts | 3 + .../oas-output/schemas/AdminProductImage.ts | 3 + .../oas-output/schemas/AdminProductOption.ts | 3 + .../schemas/AdminProductOptionValue.ts | 3 + .../oas-output/schemas/AdminProductTag.ts | 3 + .../oas-output/schemas/AdminProductType.ts | 3 + .../oas-output/schemas/AdminProductVariant.ts | 3 + .../oas-output/schemas/AdminRefundReason.ts | 3 + .../oas-output/schemas/AdminRegion.ts | 3 + .../oas-output/schemas/AdminReservation.ts | 3 + .../oas-output/schemas/AdminReturnItem.ts | 3 + .../oas-output/schemas/AdminReturnReason.ts | 3 + .../oas-output/schemas/AdminSalesChannel.ts | 3 + .../oas-output/schemas/AdminShippingOption.ts | 3 + .../schemas/AdminShippingProfile.ts | 3 + .../oas-output/schemas/AdminStore.ts | 3 + .../schemas/AdminStoreCreditAccount.ts | 3 + .../oas-output/schemas/AdminTaxRate.ts | 3 + .../oas-output/schemas/AdminTaxRegion.ts | 3 + .../oas-output/schemas/AdminTransaction.ts | 3 + .../schemas/AdminTransactionGroup.ts | 3 + .../schemas/AdminUpdateCustomerGroup.ts | 3 + .../schemas/AdminUpdateDraftOrder.ts | 9 + ...minUpdateDraftOrderActionShippingMethod.ts | 3 + .../AdminUpdateFulfillmentSetServiceZones.ts | 12 + .../schemas/AdminUpdateGiftCardParams.ts | 3 + .../schemas/AdminUpdateInventoryItem.ts | 3 + .../oas-output/schemas/AdminUpdateOrder.ts | 9 + .../oas-output/schemas/AdminUpdateProduct.ts | 3 + .../schemas/AdminUpdateProductCategory.ts | 3 + .../schemas/AdminUpdateProductTag.ts | 3 + .../schemas/AdminUpdateProductType.ts | 3 + .../schemas/AdminUpdateProductVariant.ts | 3 + .../oas-output/schemas/AdminUpdateRegion.ts | 3 + .../schemas/AdminUpdateReservation.ts | 3 + .../schemas/AdminUpdateReturnReason.ts | 3 + .../schemas/AdminUpdateSalesChannel.ts | 3 + .../schemas/AdminUpdateShippingProfile.ts | 3 + .../schemas/AdminUpdateStockLocation.ts | 3 + .../oas-output/schemas/AdminUpdateStore.ts | 3 + .../oas-output/schemas/AdminUpdateTaxRate.ts | 3 + .../schemas/AdminUpdateTaxRegion.ts | 3 + .../oas-output/schemas/AdminUpdateUser.ts | 3 + .../generated/oas-output/schemas/AdminUser.ts | 3 + .../generated/oas-output/schemas/BaseCart.ts | 3 + .../oas-output/schemas/BaseCartLineItem.ts | 3 + .../schemas/BaseCartShippingMethod.ts | 3 + .../oas-output/schemas/BaseClaimItem.ts | 3 + .../oas-output/schemas/BaseCollection.ts | 3 + .../oas-output/schemas/BaseExchangeItem.ts | 3 + .../generated/oas-output/schemas/BaseOrder.ts | 3 + .../oas-output/schemas/BaseOrderAddress.ts | 3 + .../schemas/BaseOrderFulfillment.ts | 3 + .../oas-output/schemas/BaseOrderLineItem.ts | 3 + .../schemas/BaseOrderShippingMethod.ts | 3 + .../schemas/BaseOrderTransaction.ts | 3 + .../schemas/BasePaymentCollection.ts | 3 + .../oas-output/schemas/BaseProduct.ts | 3 + .../oas-output/schemas/BaseProductCategory.ts | 3 + .../oas-output/schemas/BaseProductImage.ts | 3 + .../oas-output/schemas/BaseProductOption.ts | 3 + .../schemas/BaseProductOptionValue.ts | 3 + .../oas-output/schemas/BaseProductTag.ts | 3 + .../oas-output/schemas/BaseProductType.ts | 3 + .../oas-output/schemas/BaseProductVariant.ts | 3 + .../oas-output/schemas/BaseRegion.ts | 3 + .../oas-output/schemas/CreateAddress.ts | 3 + .../oas-output/schemas/InventoryLevel.ts | 3 + .../generated/oas-output/schemas/Order.ts | 3 + .../oas-output/schemas/OrderAddress.ts | 3 + .../oas-output/schemas/OrderChange.ts | 3 + .../oas-output/schemas/OrderClaim.ts | 3 + .../oas-output/schemas/OrderCreditLine.ts | 3 + .../oas-output/schemas/OrderExchange.ts | 3 + .../generated/oas-output/schemas/OrderItem.ts | 3 + .../oas-output/schemas/OrderLineItem.ts | 3 + .../oas-output/schemas/OrderReturnItem.ts | 3 + .../oas-output/schemas/OrderShippingMethod.ts | 3 + .../oas-output/schemas/OrderTransaction.ts | 3 + .../oas-output/schemas/RefundReason.ts | 3 + .../generated/oas-output/schemas/Return.ts | 3 + .../schemas/StoreAddCartLineItem.ts | 3 + .../generated/oas-output/schemas/StoreCart.ts | 3 + .../oas-output/schemas/StoreCartAddress.ts | 3 + .../oas-output/schemas/StoreCartLineItem.ts | 3 + .../schemas/StoreCartShippingMethod.ts | 3 + .../oas-output/schemas/StoreCollection.ts | 3 + .../oas-output/schemas/StoreCreateCart.ts | 3 + .../oas-output/schemas/StoreCreateCustomer.ts | 3 + .../oas-output/schemas/StoreCustomer.ts | 3 + .../schemas/StoreCustomerAddress.ts | 3 + .../oas-output/schemas/StoreOrder.ts | 3 + .../oas-output/schemas/StoreOrderAddress.ts | 3 + .../schemas/StoreOrderFulfillment.ts | 3 + .../oas-output/schemas/StoreOrderLineItem.ts | 63 ++ .../schemas/StoreOrderShippingMethod.ts | 18 + .../schemas/StorePaymentCollection.ts | 3 + .../oas-output/schemas/StoreProduct.ts | 3 + .../schemas/StoreProductCategory.ts | 3 + .../oas-output/schemas/StoreProductImage.ts | 3 + .../oas-output/schemas/StoreProductOption.ts | 3 + .../schemas/StoreProductOptionValue.ts | 3 + .../oas-output/schemas/StoreProductTag.ts | 3 + .../oas-output/schemas/StoreProductType.ts | 3 + .../oas-output/schemas/StoreProductVariant.ts | 3 + .../oas-output/schemas/StoreRegion.ts | 3 + .../oas-output/schemas/StoreReturnItem.ts | 3 + .../oas-output/schemas/StoreReturnReason.ts | 3 + .../oas-output/schemas/StoreShippingOption.ts | 3 + .../schemas/StoreStoreCreditAccount.ts | 3 + .../schemas/StoreTransactionGroup.ts | 3 + .../schemas/StoreUpdateCartLineItem.ts | 3 + .../oas-output/schemas/StoreUpdateCustomer.ts | 3 + .../oas-output/schemas/UpdateAddress.ts | 3 + .../oas-output/schemas/UpdateCartData.ts | 3 + .../src/classes/helpers/schema-factory.ts | 9 + 550 files changed, 3359 insertions(+), 4 deletions(-) diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminAddDraftOrderItems.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminAddDraftOrderItems.yaml index fc172864f4..4e62ee3b22 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminAddDraftOrderItems.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminAddDraftOrderItems.yaml @@ -42,3 +42,6 @@ properties: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminAddDraftOrderShippingMethod.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminAddDraftOrderShippingMethod.yaml index 443413665e..b2e9636393 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminAddDraftOrderShippingMethod.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminAddDraftOrderShippingMethod.yaml @@ -25,3 +25,6 @@ properties: metadata: type: object description: The shipping method's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminBatchUpdateProduct.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminBatchUpdateProduct.yaml index 0af27aa475..c59675a8e7 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminBatchUpdateProduct.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminBatchUpdateProduct.yaml @@ -147,6 +147,9 @@ properties: metadata: type: object description: The product's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata external_id: type: string title: external_id diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminBatchUpdateProductVariant.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminBatchUpdateProductVariant.yaml index 82a68abb60..bd4043cb70 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminBatchUpdateProductVariant.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminBatchUpdateProductVariant.yaml @@ -71,6 +71,9 @@ properties: metadata: type: object description: The product variant's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata prices: type: array description: The product variant's prices. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminClaim.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminClaim.yaml index d6104bdceb..c4bf2d32df 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminClaim.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminClaim.yaml @@ -68,6 +68,9 @@ properties: metadata: type: object description: The claim's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCollection.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCollection.yaml index 572a94f4f6..68b150b1ba 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCollection.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCollection.yaml @@ -45,3 +45,6 @@ properties: metadata: type: object description: The collection's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateCustomerGroup.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateCustomerGroup.yaml index 4dd642b053..1f528e4cc8 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateCustomerGroup.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateCustomerGroup.yaml @@ -11,3 +11,6 @@ properties: metadata: type: object description: The customer group's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateFulfillment.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateFulfillment.yaml index e315d770d3..31eec6b3ef 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateFulfillment.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateFulfillment.yaml @@ -70,6 +70,9 @@ properties: metadata: type: object description: The delivery address's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata items: type: array description: The items to fulfill. @@ -167,3 +170,6 @@ properties: metadata: type: object description: The fulfillment's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateFulfillmentSetServiceZones.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateFulfillmentSetServiceZones.yaml index 438165ffd9..4d3d7c2ae0 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateFulfillmentSetServiceZones.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateFulfillmentSetServiceZones.yaml @@ -22,6 +22,9 @@ properties: metadata: type: object description: The geo zone's metadata. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata country_code: type: string title: country_code @@ -42,6 +45,9 @@ properties: metadata: type: object description: The geo zone's metadata. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata country_code: type: string title: country_code @@ -71,6 +77,9 @@ properties: metadata: type: object description: The geo zone's metadata. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata country_code: type: string title: country_code @@ -105,6 +114,9 @@ properties: metadata: type: object description: The geo zone's metadata. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata country_code: type: string title: country_code diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateGiftCardParams.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateGiftCardParams.yaml index 98f5b3fc78..df9577984c 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateGiftCardParams.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateGiftCardParams.yaml @@ -49,3 +49,6 @@ properties: metadata: type: object description: The gift card's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateInventoryItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateInventoryItem.yaml index 21a7ed1cd9..db8552d937 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateInventoryItem.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateInventoryItem.yaml @@ -57,3 +57,6 @@ properties: metadata: type: object description: The inventory item's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateOrderCreditLines.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateOrderCreditLines.yaml index a5d094df4d..edb07be15c 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateOrderCreditLines.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateOrderCreditLines.yaml @@ -24,3 +24,6 @@ properties: metadata: type: object description: The credit line's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProduct.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProduct.yaml index 0d83da3c00..e463da6f69 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProduct.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProduct.yaml @@ -146,6 +146,9 @@ properties: metadata: type: object description: The product's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata external_id: type: string title: external_id diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProductCategory.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProductCategory.yaml index 5273e97f2b..b4eebd83f2 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProductCategory.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProductCategory.yaml @@ -35,3 +35,6 @@ properties: metadata: type: object description: The product category's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProductTag.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProductTag.yaml index 88b118a73f..453f7815fe 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProductTag.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProductTag.yaml @@ -11,3 +11,6 @@ properties: metadata: type: object description: The product tag's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProductType.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProductType.yaml index 92179c7066..ec0a42d6a9 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProductType.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProductType.yaml @@ -7,6 +7,9 @@ properties: metadata: type: object description: The product's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata value: type: string title: value diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProductVariant.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProductVariant.yaml index 5cbbf93868..29b6784aba 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProductVariant.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProductVariant.yaml @@ -74,6 +74,9 @@ properties: metadata: type: object description: The variant's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata prices: type: array description: The variant's prices. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateRegion.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateRegion.yaml index 6028eaf5d3..b50a259f29 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateRegion.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateRegion.yaml @@ -41,3 +41,6 @@ properties: metadata: type: object description: The region's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateReservation.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateReservation.yaml index 1f78aa26dd..a025ab2c17 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateReservation.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateReservation.yaml @@ -29,3 +29,6 @@ properties: metadata: type: object description: The reservation's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateReturnReason.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateReturnReason.yaml index adac302423..4be2cf28d1 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateReturnReason.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateReturnReason.yaml @@ -24,3 +24,6 @@ properties: metadata: type: object description: The return reason's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateSalesChannel.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateSalesChannel.yaml index 69ac7d89c6..cd673e3285 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateSalesChannel.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateSalesChannel.yaml @@ -19,3 +19,6 @@ properties: metadata: type: object description: The sales channel's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateShippingProfile.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateShippingProfile.yaml index 80a6b3ae52..679f3438f9 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateShippingProfile.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateShippingProfile.yaml @@ -16,3 +16,6 @@ properties: metadata: type: object description: The shipping profile's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateStockLocation.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateStockLocation.yaml index 4e52d487ce..bfa63d63d0 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateStockLocation.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateStockLocation.yaml @@ -17,3 +17,6 @@ properties: metadata: type: object description: The stock location's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateStoreCreditAccount.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateStoreCreditAccount.yaml index 56c12f0536..387063e6c9 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateStoreCreditAccount.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateStoreCreditAccount.yaml @@ -17,3 +17,6 @@ properties: metadata: type: object description: The store credit account's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateTaxRate.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateTaxRate.yaml index 8aa3b751de..474c362dbc 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateTaxRate.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateTaxRate.yaml @@ -43,3 +43,6 @@ properties: metadata: type: object description: The tax rate's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateTaxRegion.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateTaxRegion.yaml index f2343d568f..f882c43052 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateTaxRegion.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateTaxRegion.yaml @@ -51,9 +51,15 @@ properties: metadata: type: object description: The default tax rate's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata metadata: type: object description: The tax region's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata provider_id: type: string title: provider_id diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCustomer.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCustomer.yaml index 7a8ef94f4f..7c6d09c86a 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCustomer.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCustomer.yaml @@ -62,6 +62,9 @@ properties: metadata: type: object description: The customer's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_by: type: string title: created_by diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCustomerAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCustomerAddress.yaml index 9cce8725ae..9cfc816b85 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCustomerAddress.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCustomerAddress.yaml @@ -89,6 +89,9 @@ properties: metadata: type: object description: The address's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCustomerGroup.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCustomerGroup.yaml index ddef197fa0..cfc0b7ae4c 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCustomerGroup.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCustomerGroup.yaml @@ -25,6 +25,9 @@ properties: metadata: type: object description: The customer group's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrder.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrder.yaml index d0807a7018..7a40e1caf0 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrder.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrder.yaml @@ -144,6 +144,9 @@ properties: metadata: type: object description: The draft order's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrderPreview.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrderPreview.yaml index 992e94feb2..8f3a96628c 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrderPreview.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrderPreview.yaml @@ -215,6 +215,9 @@ properties: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata original_total: type: number title: original_total @@ -352,6 +355,9 @@ properties: metadata: type: object description: The shipping method's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata tax_lines: type: array description: The shipping method's tax lines. @@ -541,6 +547,9 @@ properties: metadata: type: object description: The order's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminExchange.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminExchange.yaml index 0123920e3f..b693ed2333 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminExchange.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminExchange.yaml @@ -66,6 +66,9 @@ properties: metadata: type: object description: The exchange's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillment.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillment.yaml index a459be7817..140d1f4809 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillment.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillment.yaml @@ -77,6 +77,9 @@ properties: metadata: type: object description: The fulfillment's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentAddress.yaml index 67f9793026..c207f520f1 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentAddress.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentAddress.yaml @@ -74,6 +74,9 @@ properties: metadata: type: object description: The address's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminInventoryLevel.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminInventoryLevel.yaml index d7802818c2..b0f6bb9c25 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminInventoryLevel.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminInventoryLevel.yaml @@ -56,6 +56,9 @@ properties: metadata: type: object description: The location level's metadata. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata inventory_item: type: object available_quantity: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminInvite.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminInvite.yaml index 566d068b14..500fa0a27f 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminInvite.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminInvite.yaml @@ -35,6 +35,9 @@ properties: metadata: type: object description: The invite's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrder.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrder.yaml index ac1c9a0489..f0d0784c76 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminOrder.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrder.yaml @@ -139,6 +139,9 @@ properties: metadata: type: object description: The order's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderAddress.yaml index fad010e48b..fb80941ffa 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderAddress.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderAddress.yaml @@ -65,6 +65,9 @@ properties: metadata: type: object description: The address's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderChange.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderChange.yaml index 195bd76d5e..36005625f3 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderChange.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderChange.yaml @@ -112,6 +112,9 @@ properties: metadata: type: object description: The order change's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata declined_at: type: string title: declined_at diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderFulfillment.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderFulfillment.yaml index e1312673f4..7ae1b3f61d 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderFulfillment.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderFulfillment.yaml @@ -63,6 +63,9 @@ properties: metadata: type: object description: The fulfillment's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderLineItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderLineItem.yaml index a6b3ba9b68..c590d05144 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderLineItem.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderLineItem.yaml @@ -160,6 +160,9 @@ properties: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata original_total: type: number title: original_total diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderPreview.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderPreview.yaml index 030a16e48c..98cf4090b7 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderPreview.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderPreview.yaml @@ -217,6 +217,9 @@ properties: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata original_total: type: number title: original_total @@ -354,6 +357,9 @@ properties: metadata: type: object description: The shipping method's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata tax_lines: type: array description: The shipping method's tax lines. @@ -543,6 +549,9 @@ properties: metadata: type: object description: The order's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderShippingMethod.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderShippingMethod.yaml index ab93242120..1b64bc87e6 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderShippingMethod.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderShippingMethod.yaml @@ -60,6 +60,9 @@ properties: metadata: type: object description: The shipping method's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata tax_lines: type: array description: The shipping method's tax lines. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentCollection.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentCollection.yaml index 1af31ef864..a67ab43e57 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentCollection.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentCollection.yaml @@ -50,6 +50,9 @@ properties: metadata: type: object description: The payment collection's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata status: type: string description: The payment collection's status. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsAddItemsReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsAddItemsReqSchema.yaml index c9ce264412..71c3bc5ac6 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsAddItemsReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsAddItemsReqSchema.yaml @@ -31,3 +31,6 @@ properties: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsShippingActionReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsShippingActionReqSchema.yaml index 8d6fe6cdad..d16214b606 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsShippingActionReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsShippingActionReqSchema.yaml @@ -13,3 +13,6 @@ properties: metadata: type: object description: The claim's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsShippingReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsShippingReqSchema.yaml index 34e2356020..ec629bd78a 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsShippingReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsShippingReqSchema.yaml @@ -23,3 +23,6 @@ properties: metadata: type: object description: The claim's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesAddItemsReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesAddItemsReqSchema.yaml index bc0234b0bd..33f64855b3 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesAddItemsReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesAddItemsReqSchema.yaml @@ -35,3 +35,6 @@ properties: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesRequestItemsReturnActionReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesRequestItemsReturnActionReqSchema.yaml index 666ccbcfe5..b54a811fac 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesRequestItemsReturnActionReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesRequestItemsReturnActionReqSchema.yaml @@ -17,3 +17,6 @@ properties: metadata: type: object description: The exchange's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesReturnRequestItemsReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesReturnRequestItemsReqSchema.yaml index da3d011473..0149dfd44a 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesReturnRequestItemsReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesReturnRequestItemsReqSchema.yaml @@ -35,3 +35,6 @@ properties: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesShippingActionReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesShippingActionReqSchema.yaml index 9564ca8aa4..4fa5f2d335 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesShippingActionReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesShippingActionReqSchema.yaml @@ -13,3 +13,6 @@ properties: metadata: type: object description: The exchange's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesShippingReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesShippingReqSchema.yaml index 4bff8e27eb..577bcd7bc7 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesShippingReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesShippingReqSchema.yaml @@ -23,3 +23,6 @@ properties: metadata: type: object description: The exchange's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderClaimsReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderClaimsReqSchema.yaml index e3dc6b300e..b828e16fa2 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderClaimsReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderClaimsReqSchema.yaml @@ -30,3 +30,6 @@ properties: metadata: type: object description: The claim's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsAddItemsReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsAddItemsReqSchema.yaml index d477bfb838..91614c5e78 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsAddItemsReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsAddItemsReqSchema.yaml @@ -37,6 +37,9 @@ properties: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata compare_at_unit_price: type: number title: compare_at_unit_price diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsReqSchema.yaml index 23a158dae9..bffbcdd2c2 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsReqSchema.yaml @@ -19,3 +19,6 @@ properties: metadata: type: object description: The order edit's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsShippingActionReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsShippingActionReqSchema.yaml index 3bad2acc19..a7c7003352 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsShippingActionReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsShippingActionReqSchema.yaml @@ -13,3 +13,6 @@ properties: metadata: type: object description: The order edit's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsShippingReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsShippingReqSchema.yaml index 3327fc1442..4aa99ea642 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsShippingReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsShippingReqSchema.yaml @@ -23,3 +23,6 @@ properties: metadata: type: object description: The shipping method's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderExchangesReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderExchangesReqSchema.yaml index 4472a42d37..f6f32aad33 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderExchangesReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderExchangesReqSchema.yaml @@ -19,3 +19,6 @@ properties: metadata: type: object description: The exchange's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReceiveReturnsReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReceiveReturnsReqSchema.yaml index 12d20a347b..f4b1f18cb7 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReceiveReturnsReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReceiveReturnsReqSchema.yaml @@ -13,3 +13,6 @@ properties: metadata: type: object description: The return's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReqSchema.yaml index 0fbd580159..137c180ca9 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReqSchema.yaml @@ -27,3 +27,6 @@ properties: metadata: type: object description: The return's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsRequestItemsActionReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsRequestItemsActionReqSchema.yaml index 0d0c6e633c..0ae505d7fb 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsRequestItemsActionReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsRequestItemsActionReqSchema.yaml @@ -17,3 +17,6 @@ properties: metadata: type: object description: The claim's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsRequestItemsReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsRequestItemsReqSchema.yaml index d47549d7ef..b64ffbe8d0 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsRequestItemsReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsRequestItemsReqSchema.yaml @@ -35,3 +35,6 @@ properties: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReturnReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReturnReqSchema.yaml index bdb5f9b00d..638346da8c 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReturnReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReturnReqSchema.yaml @@ -15,3 +15,6 @@ properties: metadata: type: object description: The return's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsShippingActionReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsShippingActionReqSchema.yaml index 2fb4607a74..0ad7fb99be 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsShippingActionReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsShippingActionReqSchema.yaml @@ -13,3 +13,6 @@ properties: metadata: type: object description: The return's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsShippingReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsShippingReqSchema.yaml index 861fa03fc7..d7ab099fe3 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsShippingReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsShippingReqSchema.yaml @@ -23,3 +23,6 @@ properties: metadata: type: object description: The exchange's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProduct.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProduct.yaml index 304df0f157..6674fcc3e6 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProduct.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProduct.yaml @@ -86,6 +86,9 @@ properties: metadata: type: object description: The product's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategory.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategory.yaml index 3c5286bc34..b14093d05d 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategory.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategory.yaml @@ -43,6 +43,9 @@ properties: metadata: type: object description: The category's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductImage.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductImage.yaml index d1561e5a2f..1238fdf516 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductImage.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductImage.yaml @@ -28,6 +28,9 @@ properties: metadata: type: object description: The image's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata rank: type: number title: rank diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductOption.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductOption.yaml index 415115c416..ab5b7196de 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductOption.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductOption.yaml @@ -27,6 +27,9 @@ properties: metadata: type: object description: The product option's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductOptionValue.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductOptionValue.yaml index 88175464a4..28ec39ea38 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductOptionValue.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductOptionValue.yaml @@ -22,6 +22,9 @@ properties: metadata: type: object description: The value's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductTag.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductTag.yaml index 7fc320de89..8fb2c7567e 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductTag.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductTag.yaml @@ -33,3 +33,6 @@ properties: metadata: type: object description: The tag's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductType.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductType.yaml index ef5f2ece56..6cef7208c7 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductType.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductType.yaml @@ -33,3 +33,6 @@ properties: metadata: type: object description: The type's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariant.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariant.yaml index 5696575641..b6c4ca8752 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariant.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariant.yaml @@ -136,6 +136,9 @@ properties: metadata: type: object description: The variant's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata inventory_items: type: array description: The variant's inventory items. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminRefundReason.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminRefundReason.yaml index 919bb56bfa..a1f49a55fa 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminRefundReason.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminRefundReason.yaml @@ -23,6 +23,9 @@ properties: metadata: type: object description: The refund reason's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminRegion.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminRegion.yaml index 96b6ff979c..f8126c6286 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminRegion.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminRegion.yaml @@ -36,6 +36,9 @@ properties: metadata: type: object description: The region's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminReservation.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminReservation.yaml index 2b75d1102d..652eb20437 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminReservation.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminReservation.yaml @@ -43,6 +43,9 @@ properties: metadata: type: object description: The reservation's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_by: type: string title: created_by diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminReturnItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminReturnItem.yaml index 96691fc7ca..0d4d8cb249 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminReturnItem.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminReturnItem.yaml @@ -48,3 +48,6 @@ properties: metadata: type: object description: The return item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminReturnReason.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminReturnReason.yaml index 7de3166b71..fe647c7656 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminReturnReason.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminReturnReason.yaml @@ -27,6 +27,9 @@ properties: metadata: type: object description: The return reason's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminSalesChannel.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminSalesChannel.yaml index 2311a9b687..8ed84c4f28 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminSalesChannel.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminSalesChannel.yaml @@ -30,6 +30,9 @@ properties: metadata: type: object description: The sales channel's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOption.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOption.yaml index 7cb57ee389..116a1b720e 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOption.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOption.yaml @@ -88,6 +88,9 @@ properties: metadata: type: object description: The shipping option's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminShippingProfile.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingProfile.yaml index 1dc31c1b5b..9a29de8f6c 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminShippingProfile.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingProfile.yaml @@ -17,6 +17,9 @@ properties: metadata: type: object description: The shipping profile's metadata, holds custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminStore.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminStore.yaml index 32f483dc82..7dbecee439 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminStore.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminStore.yaml @@ -40,6 +40,9 @@ properties: metadata: type: object description: The store's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminStoreCreditAccount.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminStoreCreditAccount.yaml index 0e54b944b4..4c19a0069c 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminStoreCreditAccount.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminStoreCreditAccount.yaml @@ -49,6 +49,9 @@ properties: metadata: type: object description: The store credit account's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRate.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRate.yaml index 7972123ffe..19c88dbd9b 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRate.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRate.yaml @@ -37,6 +37,9 @@ properties: metadata: type: object description: The tax rate's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata tax_region_id: type: string title: tax_region_id diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRegion.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRegion.yaml index f75bb9af92..7595bc5aba 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRegion.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRegion.yaml @@ -35,6 +35,9 @@ properties: metadata: type: object description: The tax region's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata parent_id: type: string title: parent_id diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminTransaction.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminTransaction.yaml index 0a488a5fd2..fae0c25d1c 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminTransaction.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminTransaction.yaml @@ -51,6 +51,9 @@ properties: metadata: type: object description: The transaction's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminTransactionGroup.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminTransactionGroup.yaml index bf509bb167..40e5f640f0 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminTransactionGroup.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminTransactionGroup.yaml @@ -35,3 +35,6 @@ properties: metadata: type: object description: The transaction group's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateCustomerGroup.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateCustomerGroup.yaml index 57fb90e715..930e67c47e 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateCustomerGroup.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateCustomerGroup.yaml @@ -9,3 +9,6 @@ properties: metadata: type: object description: The customer group's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateDraftOrder.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateDraftOrder.yaml index e4e0c8a5ee..8396b38deb 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateDraftOrder.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateDraftOrder.yaml @@ -59,6 +59,9 @@ properties: metadata: type: object description: The shipping address's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata billing_address: type: object description: The draft order's billing address. @@ -111,9 +114,15 @@ properties: metadata: type: object description: The billing address's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata metadata: type: object description: The draft order's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata customer_id: type: string title: customer_id diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateDraftOrderActionShippingMethod.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateDraftOrderActionShippingMethod.yaml index 8b2d7422db..48b76c24ec 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateDraftOrderActionShippingMethod.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateDraftOrderActionShippingMethod.yaml @@ -25,3 +25,6 @@ properties: metadata: type: object description: The shipping method's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateFulfillmentSetServiceZones.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateFulfillmentSetServiceZones.yaml index 982be2f5eb..a319aa1491 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateFulfillmentSetServiceZones.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateFulfillmentSetServiceZones.yaml @@ -25,6 +25,9 @@ properties: metadata: type: object description: The geo zone's metadata. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata country_code: type: string title: country_code @@ -49,6 +52,9 @@ properties: metadata: type: object description: The geo zone's metadata. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata country_code: type: string title: country_code @@ -82,6 +88,9 @@ properties: metadata: type: object description: The geo zone's metadata. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata city: type: string title: city @@ -120,6 +129,9 @@ properties: metadata: type: object description: The geo zone's metadata. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata city: type: string title: city diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateGiftCardParams.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateGiftCardParams.yaml index f53e7e9728..108d2cde1e 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateGiftCardParams.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateGiftCardParams.yaml @@ -32,3 +32,6 @@ properties: metadata: type: object description: The gift card's metadata. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateInventoryItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateInventoryItem.yaml index 34faa57636..c7a6b67450 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateInventoryItem.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateInventoryItem.yaml @@ -58,4 +58,7 @@ properties: metadata: type: object description: The inventory item's metadata. Can be custom data in key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata x-schemaName: AdminUpdateInventoryItem diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateOrder.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateOrder.yaml index 78280d8e76..cd3ef369d9 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateOrder.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateOrder.yaml @@ -59,6 +59,9 @@ properties: metadata: type: object description: The address's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata billing_address: type: object description: The order's billing address. @@ -111,6 +114,12 @@ properties: metadata: type: object description: The address's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata metadata: type: object description: The order's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateProduct.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateProduct.yaml index 1f220e671f..c0d35a7892 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateProduct.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateProduct.yaml @@ -147,6 +147,9 @@ properties: metadata: type: object description: The product's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata external_id: type: string title: external_id diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateProductCategory.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateProductCategory.yaml index 5ce56e3290..2f8962e651 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateProductCategory.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateProductCategory.yaml @@ -30,6 +30,9 @@ properties: metadata: type: object description: The product category's metadata. Can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata rank: type: number title: rank diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateProductTag.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateProductTag.yaml index 674eb56aa6..50b569184e 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateProductTag.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateProductTag.yaml @@ -8,4 +8,7 @@ properties: metadata: type: object description: The product tag's metadata. Can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata x-schemaName: AdminUpdateProductTag diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateProductType.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateProductType.yaml index e086a5129f..6c60edd1a6 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateProductType.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateProductType.yaml @@ -8,4 +8,7 @@ properties: metadata: type: object description: The product type's metadata. Can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata x-schemaName: AdminUpdateProductType diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateProductVariant.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateProductVariant.yaml index 59f99cff83..93e6b70266 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateProductVariant.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateProductVariant.yaml @@ -71,6 +71,9 @@ properties: metadata: type: object description: The product variant's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata prices: type: array description: The product variant's prices. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateRegion.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateRegion.yaml index 57633c59f9..740456f51c 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateRegion.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateRegion.yaml @@ -30,6 +30,9 @@ properties: metadata: type: object description: The region's metadata. Can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata is_tax_inclusive: type: boolean title: is_tax_inclusive diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateReservation.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateReservation.yaml index c274e12d51..e2931ef4b8 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateReservation.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateReservation.yaml @@ -16,4 +16,7 @@ properties: metadata: type: object description: The reservation's metadata. Can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata x-schemaName: AdminUpdateReservation diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateReturnReason.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateReturnReason.yaml index 3299988196..9f1309e182 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateReturnReason.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateReturnReason.yaml @@ -17,6 +17,9 @@ properties: metadata: type: object description: The return reason's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata required: - value - label diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateSalesChannel.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateSalesChannel.yaml index db5e76e560..d1e4592427 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateSalesChannel.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateSalesChannel.yaml @@ -17,3 +17,6 @@ properties: metadata: type: object description: The sales channel's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateShippingProfile.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateShippingProfile.yaml index 468cc8ab28..4102792ddf 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateShippingProfile.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateShippingProfile.yaml @@ -12,4 +12,7 @@ properties: metadata: type: object description: The shipping profile's metadata. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata x-schemaName: AdminUpdateShippingProfile diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateStockLocation.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateStockLocation.yaml index 9d47328396..ed60861669 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateStockLocation.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateStockLocation.yaml @@ -61,3 +61,6 @@ properties: metadata: type: object description: The stock location's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateStore.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateStore.yaml index e8c4463b52..734283353b 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateStore.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateStore.yaml @@ -43,3 +43,6 @@ properties: metadata: type: object description: The store's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateTaxRate.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateTaxRate.yaml index 8000de42a9..e79271cd68 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateTaxRate.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateTaxRate.yaml @@ -48,3 +48,6 @@ properties: metadata: type: object description: The tax rate's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateTaxRegion.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateTaxRegion.yaml index 9420709221..ee6a84b52e 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateTaxRegion.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateTaxRegion.yaml @@ -13,6 +13,9 @@ properties: metadata: type: object description: The tax region's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata provider_id: type: string title: provider_id diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateUser.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateUser.yaml index 32e881a213..c6011259d7 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateUser.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateUser.yaml @@ -17,3 +17,6 @@ properties: metadata: type: object description: The user's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUser.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUser.yaml index c3bca505cb..223368c4c7 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUser.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUser.yaml @@ -36,6 +36,9 @@ properties: metadata: type: object description: The user's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseCart.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseCart.yaml index 5ba46f61aa..c3dd5d8621 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseCart.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseCart.yaml @@ -73,6 +73,9 @@ properties: metadata: type: object description: The cart's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseCartLineItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseCartLineItem.yaml index b2e59d9621..eca6c74f23 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseCartLineItem.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseCartLineItem.yaml @@ -133,6 +133,9 @@ properties: metadata: type: object description: The item's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseCartShippingMethod.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseCartShippingMethod.yaml index 0a23a60cdc..2601c6fffd 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseCartShippingMethod.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseCartShippingMethod.yaml @@ -57,6 +57,9 @@ properties: metadata: type: object description: The shipping method's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata tax_lines: type: array description: The shipping method's tax lines. diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseClaimItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseClaimItem.yaml index fe407754be..470709cfa6 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseClaimItem.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseClaimItem.yaml @@ -55,6 +55,9 @@ properties: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseCollection.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseCollection.yaml index 58ab3baab3..a038a2eab7 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseCollection.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseCollection.yaml @@ -45,3 +45,6 @@ properties: metadata: type: object description: The collection's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseExchangeItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseExchangeItem.yaml index 82c98c6dbf..8fa9874692 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseExchangeItem.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseExchangeItem.yaml @@ -33,6 +33,9 @@ properties: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseOrder.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseOrder.yaml index daa6b8cc66..4322ff6393 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseOrder.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseOrder.yaml @@ -134,6 +134,9 @@ properties: metadata: type: object description: The order's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderAddress.yaml index 87e7549077..0b2e3f17d7 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderAddress.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderAddress.yaml @@ -63,6 +63,9 @@ properties: metadata: type: object description: The address's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderFulfillment.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderFulfillment.yaml index eba0b4539b..824eb98ba3 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderFulfillment.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderFulfillment.yaml @@ -63,6 +63,9 @@ properties: metadata: type: object description: The fulfillment's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderLineItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderLineItem.yaml index 115a58c2db..279d023e9c 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderLineItem.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderLineItem.yaml @@ -160,6 +160,9 @@ properties: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata original_total: type: number title: original_total diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderShippingMethod.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderShippingMethod.yaml index 930352a943..54df7640ad 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderShippingMethod.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderShippingMethod.yaml @@ -60,6 +60,9 @@ properties: metadata: type: object description: The shipping method's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata tax_lines: type: array description: The shipping method's tax lines. diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderTransaction.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderTransaction.yaml index f822566df9..542c5349d2 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderTransaction.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderTransaction.yaml @@ -46,6 +46,9 @@ properties: metadata: type: object description: The transaction's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/BasePaymentCollection.yaml b/www/apps/api-reference/specs/admin/components/schemas/BasePaymentCollection.yaml index e5c542339e..47c61f8a0c 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BasePaymentCollection.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BasePaymentCollection.yaml @@ -50,6 +50,9 @@ properties: metadata: type: object description: The payment collection's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata status: type: string description: The payment collection's status. diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseProduct.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseProduct.yaml index 51b5946075..6b2f40b707 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseProduct.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseProduct.yaml @@ -80,6 +80,9 @@ properties: metadata: type: object description: The product's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseProductCategory.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseProductCategory.yaml index b7311e2213..589d8220ee 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseProductCategory.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseProductCategory.yaml @@ -43,6 +43,9 @@ properties: metadata: type: object description: The category's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseProductImage.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseProductImage.yaml index 25637c69e8..cb6694260c 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseProductImage.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseProductImage.yaml @@ -28,6 +28,9 @@ properties: metadata: type: object description: The image's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata rank: type: number title: rank diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseProductOption.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseProductOption.yaml index 7964d121fe..69e0e5a487 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseProductOption.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseProductOption.yaml @@ -27,6 +27,9 @@ properties: metadata: type: object description: The product option's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseProductOptionValue.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseProductOptionValue.yaml index ba0a4dfd87..83b476b9eb 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseProductOptionValue.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseProductOptionValue.yaml @@ -22,6 +22,9 @@ properties: metadata: type: object description: The value's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseProductTag.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseProductTag.yaml index 2f9a58b017..f39f147ccc 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseProductTag.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseProductTag.yaml @@ -33,3 +33,6 @@ properties: metadata: type: object description: The tag's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseProductType.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseProductType.yaml index 70c15ce3ff..34600a475f 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseProductType.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseProductType.yaml @@ -33,3 +33,6 @@ properties: metadata: type: object description: The type's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseProductVariant.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseProductVariant.yaml index e27ee0ea8c..74d80a6209 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseProductVariant.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseProductVariant.yaml @@ -130,3 +130,6 @@ properties: metadata: type: object description: The variant's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseRegion.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseRegion.yaml index bbf5758714..6e64976df1 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseRegion.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseRegion.yaml @@ -35,6 +35,9 @@ properties: metadata: type: object description: The region's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/CreateAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/CreateAddress.yaml index a610a042be..238fe69428 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/CreateAddress.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/CreateAddress.yaml @@ -54,3 +54,6 @@ properties: metadata: type: object description: The address's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/InventoryLevel.yaml b/www/apps/api-reference/specs/admin/components/schemas/InventoryLevel.yaml index aa13bb7243..6107f2104a 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/InventoryLevel.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/InventoryLevel.yaml @@ -41,3 +41,6 @@ properties: metadata: type: object description: The inventory level's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/Order.yaml b/www/apps/api-reference/specs/admin/components/schemas/Order.yaml index a933e4e94d..6c331fd686 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/Order.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/Order.yaml @@ -177,6 +177,9 @@ properties: metadata: type: object description: The order's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata canceled_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/OrderAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/OrderAddress.yaml index f2ca629923..8160d47381 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/OrderAddress.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/OrderAddress.yaml @@ -62,6 +62,9 @@ properties: metadata: type: object description: The address's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/OrderChange.yaml b/www/apps/api-reference/specs/admin/components/schemas/OrderChange.yaml index 58d07e2b68..72b1f74a7b 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/OrderChange.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/OrderChange.yaml @@ -112,6 +112,9 @@ properties: metadata: type: object description: The order change's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata declined_at: type: string title: declined_at diff --git a/www/apps/api-reference/specs/admin/components/schemas/OrderClaim.yaml b/www/apps/api-reference/specs/admin/components/schemas/OrderClaim.yaml index a68218b780..9acfe0de87 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/OrderClaim.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/OrderClaim.yaml @@ -64,6 +64,9 @@ properties: metadata: type: object description: The claim's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/OrderCreditLine.yaml b/www/apps/api-reference/specs/admin/components/schemas/OrderCreditLine.yaml index 17b199333b..e2769840af 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/OrderCreditLine.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/OrderCreditLine.yaml @@ -35,6 +35,9 @@ properties: metadata: type: object description: The credit line's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/OrderExchange.yaml b/www/apps/api-reference/specs/admin/components/schemas/OrderExchange.yaml index 857b9ed634..e211bb4ba0 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/OrderExchange.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/OrderExchange.yaml @@ -59,6 +59,9 @@ properties: metadata: type: object description: The exchange's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/OrderItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/OrderItem.yaml index ab12ebb4d2..98fe9e4853 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/OrderItem.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/OrderItem.yaml @@ -62,6 +62,9 @@ properties: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/OrderLineItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/OrderLineItem.yaml index 1a0cf29b96..3bf42aa2b2 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/OrderLineItem.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/OrderLineItem.yaml @@ -141,6 +141,9 @@ properties: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata original_total: type: number title: original_total diff --git a/www/apps/api-reference/specs/admin/components/schemas/OrderReturnItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/OrderReturnItem.yaml index 41fd512de0..465be4ee1f 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/OrderReturnItem.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/OrderReturnItem.yaml @@ -37,6 +37,9 @@ properties: metadata: type: object description: The return item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata order_id: type: string title: order_id diff --git a/www/apps/api-reference/specs/admin/components/schemas/OrderShippingMethod.yaml b/www/apps/api-reference/specs/admin/components/schemas/OrderShippingMethod.yaml index 3aa794be00..b052eacde5 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/OrderShippingMethod.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/OrderShippingMethod.yaml @@ -57,6 +57,9 @@ properties: metadata: type: object description: The shipping method's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata tax_lines: type: array description: The shipping method's tax lines. diff --git a/www/apps/api-reference/specs/admin/components/schemas/OrderTransaction.yaml b/www/apps/api-reference/specs/admin/components/schemas/OrderTransaction.yaml index d497d2305c..76e5da6dfc 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/OrderTransaction.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/OrderTransaction.yaml @@ -48,6 +48,9 @@ properties: metadata: type: object description: The transaction's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/RefundReason.yaml b/www/apps/api-reference/specs/admin/components/schemas/RefundReason.yaml index 5c68174797..fad95d0cde 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/RefundReason.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/RefundReason.yaml @@ -23,6 +23,9 @@ properties: metadata: type: object description: The refund reason's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/Return.yaml b/www/apps/api-reference/specs/admin/components/schemas/Return.yaml index cfefdef18c..f0933b5d2c 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/Return.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/Return.yaml @@ -47,6 +47,9 @@ properties: metadata: type: object description: The return's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreAddCartLineItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreAddCartLineItem.yaml index 8ce18622d4..b967a3087e 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreAddCartLineItem.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreAddCartLineItem.yaml @@ -16,3 +16,6 @@ properties: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreCart.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreCart.yaml index 6cd3dc8a0d..2ff9e3c53a 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreCart.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCart.yaml @@ -78,6 +78,9 @@ properties: metadata: type: object description: The cart's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreCartAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreCartAddress.yaml index 89963e7b4c..6f1f560076 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreCartAddress.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCartAddress.yaml @@ -62,6 +62,9 @@ properties: metadata: type: object description: The address's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string title: created_at diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreCartLineItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreCartLineItem.yaml index 824b9623cb..cbb841f1d0 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreCartLineItem.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCartLineItem.yaml @@ -277,6 +277,9 @@ properties: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string title: created_at diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreCartShippingMethod.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreCartShippingMethod.yaml index 818a670856..4cd0151100 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreCartShippingMethod.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCartShippingMethod.yaml @@ -57,6 +57,9 @@ properties: metadata: type: object description: The shipping method's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata tax_lines: type: array description: The shipping method's tax lines. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreCollection.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreCollection.yaml index 121ef729ec..b5f66d0361 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreCollection.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCollection.yaml @@ -45,3 +45,6 @@ properties: metadata: type: object description: The collection's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreCreateCart.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreCreateCart.yaml index 69fb5ff088..608d8bbea2 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreCreateCart.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCreateCart.yaml @@ -39,3 +39,6 @@ properties: metadata: type: object description: The cart's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreCreateCustomer.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreCreateCustomer.yaml index 6821b05339..2685212918 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreCreateCustomer.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCreateCustomer.yaml @@ -28,3 +28,6 @@ properties: metadata: type: object description: The customer's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreCustomer.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreCustomer.yaml index 0c0997ff3f..d079b0a0e7 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreCustomer.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCustomer.yaml @@ -52,6 +52,9 @@ properties: metadata: type: object description: The customer's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreCustomerAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreCustomerAddress.yaml index 7c24514a35..1153236620 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreCustomerAddress.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCustomerAddress.yaml @@ -89,6 +89,9 @@ properties: metadata: type: object description: The address's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreOrder.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreOrder.yaml index 8235fd5e24..c4013d4431 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreOrder.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreOrder.yaml @@ -125,6 +125,9 @@ properties: metadata: type: object description: The order's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreOrderAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreOrderAddress.yaml index 8c24ea8e12..a960f1c7fb 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreOrderAddress.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreOrderAddress.yaml @@ -65,6 +65,9 @@ properties: metadata: type: object description: The address's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreOrderFulfillment.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreOrderFulfillment.yaml index 4c9e22c359..ed2f535f34 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreOrderFulfillment.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreOrderFulfillment.yaml @@ -63,6 +63,9 @@ properties: metadata: type: object description: The fulfillment's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreOrderLineItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreOrderLineItem.yaml index 556ab17106..0925dc3195 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreOrderLineItem.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreOrderLineItem.yaml @@ -349,6 +349,9 @@ properties: metadata: type: object description: The variant's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata variant_id: type: string title: variant_id @@ -530,6 +533,9 @@ properties: metadata: type: object description: The product's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata product_id: type: string title: product_id @@ -794,6 +800,9 @@ properties: metadata: type: object description: The detail's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -817,6 +826,9 @@ properties: metadata: type: object description: The item's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata original_total: type: number title: original_total @@ -1016,6 +1028,9 @@ properties: metadata: type: object description: The variant's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -1201,6 +1216,9 @@ properties: metadata: type: object description: The product's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -1494,6 +1512,10 @@ properties: metadata: type: object description: The detail's metadata. + externalDocs: + url: >- + https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -1524,6 +1546,9 @@ properties: metadata: type: object description: The item's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -1878,6 +1903,9 @@ properties: metadata: type: object description: The variant's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata variant_id: type: string title: variant_id @@ -2059,6 +2087,9 @@ properties: metadata: type: object description: The product's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata product_id: type: string title: product_id @@ -2323,6 +2354,9 @@ properties: metadata: type: object description: The detail's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -2346,6 +2380,9 @@ properties: metadata: type: object description: The item's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata original_total: type: number title: original_total @@ -2541,6 +2578,9 @@ properties: metadata: type: object description: The variant's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -2726,6 +2766,9 @@ properties: metadata: type: object description: The product's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -3019,6 +3062,10 @@ properties: metadata: type: object description: The detail's metadata. + externalDocs: + url: >- + https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -3049,6 +3096,9 @@ properties: metadata: type: object description: The item's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -3295,6 +3345,9 @@ properties: metadata: type: object description: The variant's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -3480,6 +3533,9 @@ properties: metadata: type: object description: The product's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -3773,6 +3829,9 @@ properties: metadata: type: object description: The detail's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -3803,6 +3862,9 @@ properties: metadata: type: object description: The item's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -3958,6 +4020,9 @@ properties: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata original_total: type: number title: original_total diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreOrderShippingMethod.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreOrderShippingMethod.yaml index 513ce23b45..b2994b98df 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreOrderShippingMethod.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreOrderShippingMethod.yaml @@ -60,6 +60,9 @@ properties: metadata: type: object description: The shipping method's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata tax_lines: type: array description: The shipping method's tax lines. @@ -137,6 +140,9 @@ properties: metadata: type: object description: The shipping method's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata tax_lines: type: array description: The shipping method's tax lines. @@ -668,6 +674,9 @@ properties: metadata: type: object description: The shipping method's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata original_total: type: number title: original_total @@ -786,6 +795,9 @@ properties: metadata: type: object description: The shipping method's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata tax_lines: type: array description: The shipping method's tax lines. @@ -1313,6 +1325,9 @@ properties: metadata: type: object description: The shipping method's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata original_total: type: number title: original_total @@ -1669,6 +1684,9 @@ properties: metadata: type: object description: The shipping method's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata original_total: type: number title: original_total diff --git a/www/apps/api-reference/specs/admin/components/schemas/StorePaymentCollection.yaml b/www/apps/api-reference/specs/admin/components/schemas/StorePaymentCollection.yaml index b1f572ce80..bd11eb1da2 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StorePaymentCollection.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StorePaymentCollection.yaml @@ -50,6 +50,9 @@ properties: metadata: type: object description: The payment collection's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata status: type: string description: The payment collection's status. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreProduct.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreProduct.yaml index 137cd220c4..b985c4eef9 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreProduct.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreProduct.yaml @@ -68,6 +68,9 @@ properties: metadata: type: object description: The product's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreProductCategory.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreProductCategory.yaml index 4df135c98f..b1e3dafb31 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreProductCategory.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreProductCategory.yaml @@ -48,6 +48,9 @@ properties: metadata: type: object description: The category's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreProductImage.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreProductImage.yaml index a3b3b1c72a..21e551b763 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreProductImage.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreProductImage.yaml @@ -32,6 +32,9 @@ properties: metadata: type: object description: The image's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata rank: type: number title: rank diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreProductOption.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreProductOption.yaml index 40ba71a5d9..06b88c40d2 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreProductOption.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreProductOption.yaml @@ -24,6 +24,9 @@ properties: metadata: type: object description: The option's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreProductOptionValue.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreProductOptionValue.yaml index 9a754c37c2..5a4a747f0a 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreProductOptionValue.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreProductOptionValue.yaml @@ -22,6 +22,9 @@ properties: metadata: type: object description: The value's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreProductTag.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreProductTag.yaml index 1e31fdb2fb..cce1492ca6 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreProductTag.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreProductTag.yaml @@ -28,6 +28,9 @@ properties: metadata: type: object description: The tag's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata required: - id - value diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreProductType.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreProductType.yaml index ed951b4c13..96a52be903 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreProductType.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreProductType.yaml @@ -14,6 +14,9 @@ properties: metadata: type: object description: The product type's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreProductVariant.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreProductVariant.yaml index 677ad64a10..5ee38cc877 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreProductVariant.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreProductVariant.yaml @@ -20,6 +20,9 @@ properties: metadata: type: object description: The variant's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata id: type: string title: id diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreRegion.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreRegion.yaml index 4f92f9c220..cd8f654d03 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreRegion.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreRegion.yaml @@ -38,6 +38,9 @@ properties: metadata: type: object description: The region's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreReturnItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreReturnItem.yaml index bd4223318c..5b681b1ca4 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreReturnItem.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreReturnItem.yaml @@ -44,3 +44,6 @@ properties: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreReturnReason.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreReturnReason.yaml index b08051fb32..c7b6e9ed0f 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreReturnReason.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreReturnReason.yaml @@ -27,6 +27,9 @@ properties: metadata: type: object description: The return reason's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreShippingOption.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreShippingOption.yaml index c1e75ff242..c57f31d6d8 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreShippingOption.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreShippingOption.yaml @@ -70,3 +70,6 @@ properties: metadata: type: object description: The shipping option's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreStoreCreditAccount.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreStoreCreditAccount.yaml index 26cf2ddc5b..44d636dcb5 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreStoreCreditAccount.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreStoreCreditAccount.yaml @@ -49,6 +49,9 @@ properties: metadata: type: object description: The store credit account's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreTransactionGroup.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreTransactionGroup.yaml index 0a7fe807c1..6ddf0d8bb7 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreTransactionGroup.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreTransactionGroup.yaml @@ -34,4 +34,7 @@ properties: metadata: type: object description: The transaction group's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata x-schemaName: StoreTransactionGroup diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreUpdateCartLineItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreUpdateCartLineItem.yaml index 844c2958ce..dc31e201cc 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreUpdateCartLineItem.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreUpdateCartLineItem.yaml @@ -11,3 +11,6 @@ properties: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreUpdateCustomer.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreUpdateCustomer.yaml index 700e28826a..8e1fb61246 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreUpdateCustomer.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreUpdateCustomer.yaml @@ -21,3 +21,6 @@ properties: metadata: type: object description: The customer's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/UpdateAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/UpdateAddress.yaml index 6968ed3b46..08c8e679b5 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/UpdateAddress.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/UpdateAddress.yaml @@ -60,3 +60,6 @@ properties: metadata: type: object description: The address's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/components/schemas/UpdateCartData.yaml b/www/apps/api-reference/specs/admin/components/schemas/UpdateCartData.yaml index 32376f2c2f..e7f19ea496 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/UpdateCartData.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/UpdateCartData.yaml @@ -47,3 +47,6 @@ properties: metadata: type: object description: The cart's metadata, ca hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/admin/openapi.full.yaml b/www/apps/api-reference/specs/admin/openapi.full.yaml index 0399d7ed7c..0fe3712c6a 100644 --- a/www/apps/api-reference/specs/admin/openapi.full.yaml +++ b/www/apps/api-reference/specs/admin/openapi.full.yaml @@ -54200,6 +54200,9 @@ components: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminAddDraftOrderPromotions: type: object description: The details of the promotions to add to a draft order. @@ -54240,6 +54243,9 @@ components: metadata: type: object description: The shipping method's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminApiKey: type: object description: The API key's details. @@ -54830,6 +54836,9 @@ components: metadata: type: object description: The product's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata external_id: type: string title: external_id @@ -54916,6 +54925,9 @@ components: metadata: type: object description: The product variant's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata prices: type: array description: The product variant's prices. @@ -55103,6 +55115,9 @@ components: metadata: type: object description: The claim's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -55301,6 +55316,9 @@ components: metadata: type: object description: The collection's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminCollectionDeleteResponse: type: object description: The details of the deleted collection. @@ -55396,6 +55414,9 @@ components: metadata: type: object description: The customer group's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminCreateFulfillment: type: object description: The filfillment's details. @@ -55469,6 +55490,9 @@ components: metadata: type: object description: The delivery address's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata items: type: array description: The items to fulfill. @@ -55565,6 +55589,9 @@ components: metadata: type: object description: The fulfillment's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminCreateFulfillmentSetServiceZones: type: object description: The service zone's details. @@ -55590,6 +55617,9 @@ components: metadata: type: object description: The geo zone's metadata. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata country_code: type: string title: country_code @@ -55610,6 +55640,9 @@ components: metadata: type: object description: The geo zone's metadata. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata country_code: type: string title: country_code @@ -55639,6 +55672,9 @@ components: metadata: type: object description: The geo zone's metadata. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata country_code: type: string title: country_code @@ -55673,6 +55709,9 @@ components: metadata: type: object description: The geo zone's metadata. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata country_code: type: string title: country_code @@ -55750,6 +55789,9 @@ components: metadata: type: object description: The gift card's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminCreateInventoryItem: type: object description: The inventory item's details. @@ -55810,6 +55852,9 @@ components: metadata: type: object description: The inventory item's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminCreateInventoryLocationLevel: type: object description: The inventory level's details. @@ -55856,6 +55901,9 @@ components: metadata: type: object description: The credit line's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminCreatePaymentCapture: type: object description: The payment's details. @@ -56145,6 +56193,9 @@ components: metadata: type: object description: The product's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata external_id: type: string title: external_id @@ -56191,6 +56242,9 @@ components: metadata: type: object description: The product category's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminCreateProductOption: type: object description: The product option's details. @@ -56224,6 +56278,9 @@ components: metadata: type: object description: The product tag's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminCreateProductType: type: object description: The details of the product type to create. @@ -56234,6 +56291,9 @@ components: metadata: type: object description: The product's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata value: type: string title: value @@ -56313,6 +56373,9 @@ components: metadata: type: object description: The variant's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata prices: type: array description: The variant's prices. @@ -56480,6 +56543,9 @@ components: metadata: type: object description: The region's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminCreateReservation: type: object description: The reservation's details. @@ -56512,6 +56578,9 @@ components: metadata: type: object description: The reservation's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminCreateReturnReason: type: object description: The details of the return reason to create. @@ -56539,6 +56608,9 @@ components: metadata: type: object description: The return reason's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminCreateSalesChannel: type: object description: The sales channel's details. @@ -56561,6 +56633,9 @@ components: metadata: type: object description: The sales channel's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminCreateShipment: type: object description: The shipment's details. @@ -56753,6 +56828,9 @@ components: metadata: type: object description: The shipping profile's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminCreateStockLocation: type: object description: The stock location's details. @@ -56773,6 +56851,9 @@ components: metadata: type: object description: The stock location's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminCreateStockLocationFulfillmentSet: type: object description: The fulfillment set to create. @@ -56809,6 +56890,9 @@ components: metadata: type: object description: The store credit account's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminCreateTaxRate: type: object description: The tax rate's details. @@ -56854,6 +56938,9 @@ components: metadata: type: object description: The tax rate's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminCreateTaxRateRule: type: object description: The tax rate rule's details. @@ -56925,9 +57012,15 @@ components: metadata: type: object description: The default tax rate's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata metadata: type: object description: The tax region's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata provider_id: type: string title: provider_id @@ -57148,6 +57241,9 @@ components: metadata: type: object description: The customer's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_by: type: string title: created_by @@ -57259,6 +57355,9 @@ components: metadata: type: object description: The address's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -57306,6 +57405,9 @@ components: metadata: type: object description: The customer group's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -58057,6 +58159,9 @@ components: metadata: type: object description: The draft order's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -58413,6 +58518,9 @@ components: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata original_total: type: number title: original_total @@ -58539,6 +58647,9 @@ components: metadata: type: object description: The shipping method's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata tax_lines: type: array description: The shipping method's tax lines. @@ -58716,6 +58827,9 @@ components: metadata: type: object description: The order's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -58916,6 +59030,9 @@ components: metadata: type: object description: The exchange's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -59157,6 +59274,9 @@ components: metadata: type: object description: The fulfillment's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -59249,6 +59369,9 @@ components: metadata: type: object description: The address's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -59954,6 +60077,9 @@ components: metadata: type: object description: The location level's metadata. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata inventory_item: type: object available_quantity: @@ -59998,6 +60124,9 @@ components: metadata: type: object description: The invite's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -60308,6 +60437,9 @@ components: metadata: type: object description: The order's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -60489,6 +60621,9 @@ components: metadata: type: object description: The address's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -60612,6 +60747,9 @@ components: metadata: type: object description: The order change's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata declined_at: type: string title: declined_at @@ -60830,6 +60968,9 @@ components: metadata: type: object description: The fulfillment's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -61053,6 +61194,9 @@ components: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata original_total: type: number title: original_total @@ -61324,6 +61468,9 @@ components: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata original_total: type: number title: original_total @@ -61450,6 +61597,9 @@ components: metadata: type: object description: The shipping method's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata tax_lines: type: array description: The shipping method's tax lines. @@ -61627,6 +61777,9 @@ components: metadata: type: object description: The order's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -61834,6 +61987,9 @@ components: metadata: type: object description: The shipping method's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata tax_lines: type: array description: The shipping method's tax lines. @@ -62018,6 +62174,9 @@ components: metadata: type: object description: The payment collection's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata status: type: string description: The payment collection's status. @@ -62258,6 +62417,9 @@ components: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminPostClaimsItemsActionReqSchema: type: object description: The details to update in the item. @@ -62291,6 +62453,9 @@ components: metadata: type: object description: The claim's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminPostClaimsShippingReqSchema: type: object description: The details of the shipping method used to ship outbound items. @@ -62317,6 +62482,9 @@ components: metadata: type: object description: The claim's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminPostExchangesAddItemsReqSchema: type: object description: The details of outbound items. @@ -62355,6 +62523,9 @@ components: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminPostExchangesItemsActionReqSchema: type: object description: The details to update in an outbound item. @@ -62388,6 +62559,9 @@ components: metadata: type: object description: The exchange's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminPostExchangesReturnRequestItemsReqSchema: type: object description: The details of the inbound (return) items. @@ -62426,6 +62600,9 @@ components: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminPostExchangesShippingActionReqSchema: type: object description: The details of the shipping method to update. @@ -62442,6 +62619,9 @@ components: metadata: type: object description: The exchange's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminPostExchangesShippingReqSchema: type: object description: The outbound shipping method's details. @@ -62468,6 +62648,9 @@ components: metadata: type: object description: The exchange's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminPostOrderClaimsReqSchema: type: object description: The claim's details. @@ -62501,6 +62684,9 @@ components: metadata: type: object description: The claim's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminPostOrderEditsAddItemsReqSchema: type: object description: The details of items to be edited. @@ -62539,6 +62725,9 @@ components: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata compare_at_unit_price: type: number title: compare_at_unit_price @@ -62586,6 +62775,9 @@ components: metadata: type: object description: The order edit's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminPostOrderEditsShippingActionReqSchema: type: object description: The shipping method's details. @@ -62602,6 +62794,9 @@ components: metadata: type: object description: The order edit's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminPostOrderEditsShippingReqSchema: type: object description: The shipping method's details. @@ -62628,6 +62823,9 @@ components: metadata: type: object description: The shipping method's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminPostOrderEditsUpdateItemQuantityReqSchema: type: object description: The order item's details to update. @@ -62673,6 +62871,9 @@ components: metadata: type: object description: The exchange's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminPostReceiveReturnsReqSchema: type: object description: The return receival details. @@ -62689,6 +62890,9 @@ components: metadata: type: object description: The return's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminPostReturnsConfirmRequestReqSchema: type: object description: The confirmation's details. @@ -62785,6 +62989,9 @@ components: metadata: type: object description: The return's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminPostReturnsRequestItemsActionReqSchema: type: object description: The details to update in the item. @@ -62805,6 +63012,9 @@ components: metadata: type: object description: The claim's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminPostReturnsRequestItemsReqSchema: type: object description: The items' details. @@ -62843,6 +63053,9 @@ components: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminPostReturnsReturnReqSchema: type: object description: The return's details. @@ -62859,6 +63072,9 @@ components: metadata: type: object description: The return's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminPostReturnsShippingActionReqSchema: type: object description: The shipping method's details. @@ -62875,6 +63091,9 @@ components: metadata: type: object description: The return's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminPostReturnsShippingReqSchema: type: object description: The shipping method's details. @@ -62901,6 +63120,9 @@ components: metadata: type: object description: The exchange's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminPrice: type: object description: The price's details. @@ -63415,6 +63637,9 @@ components: metadata: type: object description: The product's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -63543,6 +63768,9 @@ components: metadata: type: object description: The category's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -63694,6 +63922,9 @@ components: metadata: type: object description: The image's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata rank: type: number title: rank @@ -63732,6 +63963,9 @@ components: metadata: type: object description: The product option's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -63805,6 +64039,9 @@ components: metadata: type: object description: The value's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -63865,6 +64102,9 @@ components: metadata: type: object description: The tag's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminProductTagDeleteResponse: type: object description: The details of the product tag deletion. @@ -63964,6 +64204,9 @@ components: metadata: type: object description: The type's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminProductTypeDeleteResponse: type: object description: The details of the product type deletion. @@ -64162,6 +64405,9 @@ components: metadata: type: object description: The variant's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata inventory_items: type: array description: The variant's inventory items. @@ -64576,6 +64822,9 @@ components: metadata: type: object description: The refund reason's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -64625,6 +64874,9 @@ components: metadata: type: object description: The region's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -64738,6 +64990,9 @@ components: metadata: type: object description: The reservation's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_by: type: string title: created_by @@ -64890,6 +65145,9 @@ components: metadata: type: object description: The return item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminReturnPreviewResponse: type: object description: The details of a return and a preview of the order once the return is applied. @@ -64932,6 +65190,9 @@ components: metadata: type: object description: The return reason's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -65104,6 +65365,9 @@ components: metadata: type: object description: The sales channel's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -65317,6 +65581,9 @@ components: metadata: type: object description: The shipping option's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -65641,6 +65908,9 @@ components: metadata: type: object description: The shipping profile's metadata, holds custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -65895,6 +66165,9 @@ components: metadata: type: object description: The store's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -65957,6 +66230,9 @@ components: metadata: type: object description: The store credit account's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -66154,6 +66430,9 @@ components: metadata: type: object description: The tax rate's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata tax_region_id: type: string title: tax_region_id @@ -66281,6 +66560,9 @@ components: metadata: type: object description: The tax region's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata parent_id: type: string title: parent_id @@ -66401,6 +66683,9 @@ components: metadata: type: object description: The transaction's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -66449,6 +66734,9 @@ components: metadata: type: object description: The transaction group's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminTransactionGroupsResponse: type: object description: The paginated list of transaction groups. @@ -66555,6 +66843,9 @@ components: metadata: type: object description: The customer group's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminUpdateDraftOrder: type: object description: The data to update in the draft order. @@ -66617,6 +66908,9 @@ components: metadata: type: object description: The shipping address's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata billing_address: type: object description: The draft order's billing address. @@ -66669,9 +66963,15 @@ components: metadata: type: object description: The billing address's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata metadata: type: object description: The draft order's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata customer_id: type: string title: customer_id @@ -66706,6 +67006,9 @@ components: metadata: type: object description: The shipping method's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminUpdateDraftOrderItem: type: object description: The updates to make on a draft order's item. @@ -66774,6 +67077,9 @@ components: metadata: type: object description: The geo zone's metadata. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata country_code: type: string title: country_code @@ -66798,6 +67104,9 @@ components: metadata: type: object description: The geo zone's metadata. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata country_code: type: string title: country_code @@ -66831,6 +67140,9 @@ components: metadata: type: object description: The geo zone's metadata. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata city: type: string title: city @@ -66869,6 +67181,9 @@ components: metadata: type: object description: The geo zone's metadata. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata city: type: string title: city @@ -66928,6 +67243,9 @@ components: metadata: type: object description: The gift card's metadata. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminUpdateInventoryItem: type: object description: The properties to update in the inventory item. @@ -66987,6 +67305,9 @@ components: metadata: type: object description: The inventory item's metadata. Can be custom data in key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata x-schemaName: AdminUpdateInventoryItem AdminUpdateInventoryLocationLevel: type: object @@ -67063,6 +67384,9 @@ components: metadata: type: object description: The address's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata billing_address: type: object description: The order's billing address. @@ -67115,9 +67439,15 @@ components: metadata: type: object description: The address's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata metadata: type: object description: The order's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminUpdatePaymentRefundReason: type: object description: The properties to update in the refund reason. @@ -67337,6 +67667,9 @@ components: metadata: type: object description: The product's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata external_id: type: string title: external_id @@ -67372,6 +67705,9 @@ components: metadata: type: object description: The product category's metadata. Can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata rank: type: number title: rank @@ -67404,6 +67740,9 @@ components: metadata: type: object description: The product tag's metadata. Can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata x-schemaName: AdminUpdateProductTag AdminUpdateProductType: type: object @@ -67416,6 +67755,9 @@ components: metadata: type: object description: The product type's metadata. Can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata x-schemaName: AdminUpdateProductType AdminUpdateProductVariant: type: object @@ -67489,6 +67831,9 @@ components: metadata: type: object description: The product variant's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata prices: type: array description: The product variant's prices. @@ -67575,6 +67920,9 @@ components: metadata: type: object description: The region's metadata. Can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata is_tax_inclusive: type: boolean title: is_tax_inclusive @@ -67599,6 +67947,9 @@ components: metadata: type: object description: The reservation's metadata. Can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata x-schemaName: AdminUpdateReservation AdminUpdateReturnReason: type: object @@ -67620,6 +67971,9 @@ components: metadata: type: object description: The return reason's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata required: - value - label @@ -67643,6 +67997,9 @@ components: metadata: type: object description: The sales channel's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminUpdateShippingOption: type: object description: The properties to update in the shipping option. @@ -67870,6 +68227,9 @@ components: metadata: type: object description: The shipping profile's metadata. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata x-schemaName: AdminUpdateShippingProfile AdminUpdateStockLocation: type: object @@ -67931,6 +68291,9 @@ components: metadata: type: object description: The stock location's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminUpdateStore: type: object description: The properties to update in a store. @@ -67977,6 +68340,9 @@ components: metadata: type: object description: The store's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminUpdateTaxRate: type: object description: The properties to update in the tax rate. @@ -68027,6 +68393,9 @@ components: metadata: type: object description: The tax rate's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminUpdateTaxRegion: type: object description: The details to update in a tax region. @@ -68043,6 +68412,9 @@ components: metadata: type: object description: The tax region's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata provider_id: type: string title: provider_id @@ -68067,6 +68439,9 @@ components: metadata: type: object description: The user's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminUpdateVariantInventoryItem: type: object description: The properties to update of the variant's inventory item association. @@ -68228,6 +68603,9 @@ components: metadata: type: object description: The user's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -68796,6 +69174,9 @@ components: metadata: type: object description: The cart's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -69034,6 +69415,9 @@ components: metadata: type: object description: The item's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -69150,6 +69534,9 @@ components: metadata: type: object description: The shipping method's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata tax_lines: type: array description: The shipping method's tax lines. @@ -69260,6 +69647,9 @@ components: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -69318,6 +69708,9 @@ components: metadata: type: object description: The collection's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata BaseExchangeItem: type: object description: The item's details. @@ -69354,6 +69747,9 @@ components: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -69637,6 +70033,9 @@ components: metadata: type: object description: The order's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -69809,6 +70208,9 @@ components: metadata: type: object description: The address's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -69882,6 +70284,9 @@ components: metadata: type: object description: The fulfillment's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -70135,6 +70540,9 @@ components: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata original_total: type: number title: original_total @@ -70414,6 +70822,9 @@ components: metadata: type: object description: The shipping method's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata tax_lines: type: array description: The shipping method's tax lines. @@ -70675,6 +71086,9 @@ components: metadata: type: object description: The transaction's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -70815,6 +71229,9 @@ components: metadata: type: object description: The payment collection's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata status: type: string description: The payment collection's status. @@ -70994,6 +71411,9 @@ components: metadata: type: object description: The product's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -71120,6 +71540,9 @@ components: metadata: type: object description: The category's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -71186,6 +71609,9 @@ components: metadata: type: object description: The image's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata rank: type: number title: rank @@ -71224,6 +71650,9 @@ components: metadata: type: object description: The product option's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -71264,6 +71693,9 @@ components: metadata: type: object description: The value's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -71315,6 +71747,9 @@ components: metadata: type: object description: The tag's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata BaseProductType: type: object description: The product type's details. @@ -71351,6 +71786,9 @@ components: metadata: type: object description: The type's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata BaseProductVariant: type: object description: The product variant's details. @@ -71480,6 +71918,9 @@ components: metadata: type: object description: The variant's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata BasePromotionRuleValue: type: object description: The rule value's details. @@ -71572,6 +72013,9 @@ components: metadata: type: object description: The region's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -71890,6 +72334,9 @@ components: metadata: type: object description: The address's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata CustomerGroupInCustomerFilters: type: object description: Filter by customer groups to get their associated customers. @@ -72346,6 +72793,9 @@ components: metadata: type: object description: The inventory level's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata Order: type: object description: The order change's order. @@ -72524,6 +72974,9 @@ components: metadata: type: object description: The order's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata canceled_at: type: string format: date-time @@ -72718,6 +73171,9 @@ components: metadata: type: object description: The address's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -72841,6 +73297,9 @@ components: metadata: type: object description: The order change's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata declined_at: type: string title: declined_at @@ -73032,6 +73491,9 @@ components: metadata: type: object description: The claim's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -73118,6 +73580,9 @@ components: metadata: type: object description: The credit line's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -73190,6 +73655,9 @@ components: metadata: type: object description: The exchange's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -73303,6 +73771,9 @@ components: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -73457,6 +73928,9 @@ components: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata original_total: type: number title: original_total @@ -73675,6 +74149,9 @@ components: metadata: type: object description: The return item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata order_id: type: string title: order_id @@ -73750,6 +74227,9 @@ components: metadata: type: object description: The shipping method's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata tax_lines: type: array description: The shipping method's tax lines. @@ -73970,6 +74450,9 @@ components: metadata: type: object description: The transaction's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -74012,6 +74495,9 @@ components: metadata: type: object description: The refund reason's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -74081,6 +74567,9 @@ components: metadata: type: object description: The return's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -74185,6 +74674,9 @@ components: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata StoreAddCartShippingMethods: type: object description: The shipping method's details. @@ -74426,6 +74918,9 @@ components: metadata: type: object description: The cart's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -74608,6 +75103,9 @@ components: metadata: type: object description: The address's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string title: created_at @@ -74898,6 +75396,9 @@ components: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string title: created_at @@ -75078,6 +75579,9 @@ components: metadata: type: object description: The shipping method's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata tax_lines: type: array description: The shipping method's tax lines. @@ -75421,6 +75925,9 @@ components: metadata: type: object description: The collection's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata StoreCollectionResponse: type: object description: The collection's details. @@ -75465,6 +75972,9 @@ components: metadata: type: object description: The cart's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata StoreCreateCustomer: type: object description: The details of the customer to create. @@ -75496,6 +76006,9 @@ components: metadata: type: object description: The customer's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata StoreCreateCustomerAddress: type: object description: The address's details. @@ -75793,6 +76306,9 @@ components: metadata: type: object description: The customer's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -75900,6 +76416,9 @@ components: metadata: type: object description: The address's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -76204,6 +76723,9 @@ components: metadata: type: object description: The order's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -76385,6 +76907,9 @@ components: metadata: type: object description: The address's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -76458,6 +76983,9 @@ components: metadata: type: object description: The fulfillment's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -76824,6 +77352,9 @@ components: metadata: type: object description: The variant's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata variant_id: type: string title: variant_id @@ -77005,6 +77536,9 @@ components: metadata: type: object description: The product's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata product_id: type: string title: product_id @@ -77269,6 +77803,9 @@ components: metadata: type: object description: The detail's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -77292,6 +77829,9 @@ components: metadata: type: object description: The item's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata original_total: type: number title: original_total @@ -77491,6 +78031,9 @@ components: metadata: type: object description: The variant's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -77676,6 +78219,9 @@ components: metadata: type: object description: The product's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -77969,6 +78515,9 @@ components: metadata: type: object description: The detail's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -77999,6 +78548,9 @@ components: metadata: type: object description: The item's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -78353,6 +78905,9 @@ components: metadata: type: object description: The variant's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata variant_id: type: string title: variant_id @@ -78534,6 +79089,9 @@ components: metadata: type: object description: The product's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata product_id: type: string title: product_id @@ -78798,6 +79356,9 @@ components: metadata: type: object description: The detail's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -78821,6 +79382,9 @@ components: metadata: type: object description: The item's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata original_total: type: number title: original_total @@ -79016,6 +79580,9 @@ components: metadata: type: object description: The variant's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -79201,6 +79768,9 @@ components: metadata: type: object description: The product's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -79494,6 +80064,9 @@ components: metadata: type: object description: The detail's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -79524,6 +80097,9 @@ components: metadata: type: object description: The item's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -79770,6 +80346,9 @@ components: metadata: type: object description: The variant's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -79955,6 +80534,9 @@ components: metadata: type: object description: The product's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -80248,6 +80830,9 @@ components: metadata: type: object description: The detail's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -80278,6 +80863,9 @@ components: metadata: type: object description: The item's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -80433,6 +81021,9 @@ components: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata original_total: type: number title: original_total @@ -80558,6 +81149,9 @@ components: metadata: type: object description: The shipping method's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata tax_lines: type: array description: The shipping method's tax lines. @@ -80635,6 +81229,9 @@ components: metadata: type: object description: The shipping method's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata tax_lines: type: array description: The shipping method's tax lines. @@ -81166,6 +81763,9 @@ components: metadata: type: object description: The shipping method's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata original_total: type: number title: original_total @@ -81284,6 +81884,9 @@ components: metadata: type: object description: The shipping method's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata tax_lines: type: array description: The shipping method's tax lines. @@ -81811,6 +82414,9 @@ components: metadata: type: object description: The shipping method's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata original_total: type: number title: original_total @@ -82167,6 +82773,9 @@ components: metadata: type: object description: The shipping method's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata original_total: type: number title: original_total @@ -82263,6 +82872,9 @@ components: metadata: type: object description: The payment collection's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata status: type: string description: The payment collection's status. @@ -82505,6 +83117,9 @@ components: metadata: type: object description: The product's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -82648,6 +83263,9 @@ components: metadata: type: object description: The category's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -82744,6 +83362,9 @@ components: metadata: type: object description: The image's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata rank: type: number title: rank @@ -82775,6 +83396,9 @@ components: metadata: type: object description: The option's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -82818,6 +83442,9 @@ components: metadata: type: object description: The value's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -82873,6 +83500,9 @@ components: metadata: type: object description: The tag's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata required: - id - value @@ -82936,6 +83566,9 @@ components: metadata: type: object description: The product type's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -83019,6 +83652,9 @@ components: metadata: type: object description: The variant's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata id: type: string title: id @@ -83170,6 +83806,9 @@ components: metadata: type: object description: The region's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -83349,6 +83988,9 @@ components: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata StoreReturnReason: type: object description: The return reason's details. @@ -83379,6 +84021,9 @@ components: metadata: type: object description: The return reason's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -83476,6 +84121,9 @@ components: metadata: type: object description: The shipping option's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata StoreShippingOptionListResponse: type: object description: The shipping option's details. @@ -83598,6 +84246,9 @@ components: metadata: type: object description: The store credit account's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -83686,6 +84337,9 @@ components: metadata: type: object description: The transaction group's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata x-schemaName: StoreTransactionGroup StoreUpdateCartLineItem: type: object @@ -83701,6 +84355,9 @@ components: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata StoreUpdateCustomer: type: object description: The details to update in the customer. @@ -83725,6 +84382,9 @@ components: metadata: type: object description: The customer's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata StoreUpdateCustomerAddress: type: object description: The properties to update in the address. @@ -83852,6 +84512,9 @@ components: metadata: type: object description: The address's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata UpdateCartData: type: object description: The details to update in a cart. @@ -83898,6 +84561,9 @@ components: metadata: type: object description: The cart's metadata, ca hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata WorkflowExecutionContext: type: object description: The workflow execution's context. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminAddDraftOrderItems.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminAddDraftOrderItems.yaml index fc172864f4..4e62ee3b22 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminAddDraftOrderItems.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminAddDraftOrderItems.yaml @@ -42,3 +42,6 @@ properties: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminAddDraftOrderShippingMethod.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminAddDraftOrderShippingMethod.yaml index 443413665e..b2e9636393 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminAddDraftOrderShippingMethod.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminAddDraftOrderShippingMethod.yaml @@ -25,3 +25,6 @@ properties: metadata: type: object description: The shipping method's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminBatchUpdateProduct.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminBatchUpdateProduct.yaml index 0af27aa475..c59675a8e7 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminBatchUpdateProduct.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminBatchUpdateProduct.yaml @@ -147,6 +147,9 @@ properties: metadata: type: object description: The product's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata external_id: type: string title: external_id diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminBatchUpdateProductVariant.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminBatchUpdateProductVariant.yaml index 82a68abb60..bd4043cb70 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminBatchUpdateProductVariant.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminBatchUpdateProductVariant.yaml @@ -71,6 +71,9 @@ properties: metadata: type: object description: The product variant's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata prices: type: array description: The product variant's prices. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminClaim.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminClaim.yaml index d6104bdceb..c4bf2d32df 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminClaim.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminClaim.yaml @@ -68,6 +68,9 @@ properties: metadata: type: object description: The claim's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCollection.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCollection.yaml index 572a94f4f6..68b150b1ba 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCollection.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCollection.yaml @@ -45,3 +45,6 @@ properties: metadata: type: object description: The collection's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateCustomerGroup.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateCustomerGroup.yaml index 4dd642b053..1f528e4cc8 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateCustomerGroup.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateCustomerGroup.yaml @@ -11,3 +11,6 @@ properties: metadata: type: object description: The customer group's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateFulfillment.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateFulfillment.yaml index e315d770d3..31eec6b3ef 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateFulfillment.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateFulfillment.yaml @@ -70,6 +70,9 @@ properties: metadata: type: object description: The delivery address's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata items: type: array description: The items to fulfill. @@ -167,3 +170,6 @@ properties: metadata: type: object description: The fulfillment's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateFulfillmentSetServiceZones.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateFulfillmentSetServiceZones.yaml index 438165ffd9..4d3d7c2ae0 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateFulfillmentSetServiceZones.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateFulfillmentSetServiceZones.yaml @@ -22,6 +22,9 @@ properties: metadata: type: object description: The geo zone's metadata. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata country_code: type: string title: country_code @@ -42,6 +45,9 @@ properties: metadata: type: object description: The geo zone's metadata. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata country_code: type: string title: country_code @@ -71,6 +77,9 @@ properties: metadata: type: object description: The geo zone's metadata. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata country_code: type: string title: country_code @@ -105,6 +114,9 @@ properties: metadata: type: object description: The geo zone's metadata. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata country_code: type: string title: country_code diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateGiftCardParams.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateGiftCardParams.yaml index 98f5b3fc78..df9577984c 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateGiftCardParams.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateGiftCardParams.yaml @@ -49,3 +49,6 @@ properties: metadata: type: object description: The gift card's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateInventoryItem.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateInventoryItem.yaml index 21a7ed1cd9..db8552d937 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateInventoryItem.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateInventoryItem.yaml @@ -57,3 +57,6 @@ properties: metadata: type: object description: The inventory item's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateOrderCreditLines.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateOrderCreditLines.yaml index a5d094df4d..edb07be15c 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateOrderCreditLines.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateOrderCreditLines.yaml @@ -24,3 +24,6 @@ properties: metadata: type: object description: The credit line's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateProduct.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateProduct.yaml index 0d83da3c00..e463da6f69 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateProduct.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateProduct.yaml @@ -146,6 +146,9 @@ properties: metadata: type: object description: The product's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata external_id: type: string title: external_id diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateProductCategory.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateProductCategory.yaml index 5273e97f2b..b4eebd83f2 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateProductCategory.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateProductCategory.yaml @@ -35,3 +35,6 @@ properties: metadata: type: object description: The product category's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateProductTag.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateProductTag.yaml index 88b118a73f..453f7815fe 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateProductTag.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateProductTag.yaml @@ -11,3 +11,6 @@ properties: metadata: type: object description: The product tag's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateProductType.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateProductType.yaml index 92179c7066..ec0a42d6a9 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateProductType.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateProductType.yaml @@ -7,6 +7,9 @@ properties: metadata: type: object description: The product's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata value: type: string title: value diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateProductVariant.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateProductVariant.yaml index 5cbbf93868..29b6784aba 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateProductVariant.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateProductVariant.yaml @@ -74,6 +74,9 @@ properties: metadata: type: object description: The variant's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata prices: type: array description: The variant's prices. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateRegion.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateRegion.yaml index 6028eaf5d3..b50a259f29 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateRegion.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateRegion.yaml @@ -41,3 +41,6 @@ properties: metadata: type: object description: The region's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateReservation.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateReservation.yaml index 1f78aa26dd..a025ab2c17 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateReservation.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateReservation.yaml @@ -29,3 +29,6 @@ properties: metadata: type: object description: The reservation's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateReturnReason.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateReturnReason.yaml index adac302423..4be2cf28d1 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateReturnReason.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateReturnReason.yaml @@ -24,3 +24,6 @@ properties: metadata: type: object description: The return reason's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateSalesChannel.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateSalesChannel.yaml index 69ac7d89c6..cd673e3285 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateSalesChannel.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateSalesChannel.yaml @@ -19,3 +19,6 @@ properties: metadata: type: object description: The sales channel's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateShippingProfile.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateShippingProfile.yaml index 80a6b3ae52..679f3438f9 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateShippingProfile.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateShippingProfile.yaml @@ -16,3 +16,6 @@ properties: metadata: type: object description: The shipping profile's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateStockLocation.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateStockLocation.yaml index 4e52d487ce..bfa63d63d0 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateStockLocation.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateStockLocation.yaml @@ -17,3 +17,6 @@ properties: metadata: type: object description: The stock location's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateStoreCreditAccount.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateStoreCreditAccount.yaml index 56c12f0536..387063e6c9 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateStoreCreditAccount.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateStoreCreditAccount.yaml @@ -17,3 +17,6 @@ properties: metadata: type: object description: The store credit account's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateTaxRate.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateTaxRate.yaml index 8aa3b751de..474c362dbc 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateTaxRate.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateTaxRate.yaml @@ -43,3 +43,6 @@ properties: metadata: type: object description: The tax rate's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateTaxRegion.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateTaxRegion.yaml index f2343d568f..f882c43052 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateTaxRegion.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateTaxRegion.yaml @@ -51,9 +51,15 @@ properties: metadata: type: object description: The default tax rate's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata metadata: type: object description: The tax region's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata provider_id: type: string title: provider_id diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCustomer.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCustomer.yaml index 7a8ef94f4f..7c6d09c86a 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCustomer.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCustomer.yaml @@ -62,6 +62,9 @@ properties: metadata: type: object description: The customer's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_by: type: string title: created_by diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCustomerAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCustomerAddress.yaml index 9cce8725ae..9cfc816b85 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCustomerAddress.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCustomerAddress.yaml @@ -89,6 +89,9 @@ properties: metadata: type: object description: The address's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCustomerGroup.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCustomerGroup.yaml index ddef197fa0..cfc0b7ae4c 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCustomerGroup.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCustomerGroup.yaml @@ -25,6 +25,9 @@ properties: metadata: type: object description: The customer group's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminDraftOrder.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminDraftOrder.yaml index d0807a7018..7a40e1caf0 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminDraftOrder.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminDraftOrder.yaml @@ -144,6 +144,9 @@ properties: metadata: type: object description: The draft order's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminDraftOrderPreview.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminDraftOrderPreview.yaml index 992e94feb2..8f3a96628c 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminDraftOrderPreview.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminDraftOrderPreview.yaml @@ -215,6 +215,9 @@ properties: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata original_total: type: number title: original_total @@ -352,6 +355,9 @@ properties: metadata: type: object description: The shipping method's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata tax_lines: type: array description: The shipping method's tax lines. @@ -541,6 +547,9 @@ properties: metadata: type: object description: The order's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminExchange.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminExchange.yaml index 0123920e3f..b693ed2333 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminExchange.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminExchange.yaml @@ -66,6 +66,9 @@ properties: metadata: type: object description: The exchange's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminFulfillment.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminFulfillment.yaml index a459be7817..140d1f4809 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminFulfillment.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminFulfillment.yaml @@ -77,6 +77,9 @@ properties: metadata: type: object description: The fulfillment's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentAddress.yaml index 67f9793026..c207f520f1 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentAddress.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentAddress.yaml @@ -74,6 +74,9 @@ properties: metadata: type: object description: The address's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminInventoryLevel.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminInventoryLevel.yaml index d7802818c2..b0f6bb9c25 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminInventoryLevel.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminInventoryLevel.yaml @@ -56,6 +56,9 @@ properties: metadata: type: object description: The location level's metadata. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata inventory_item: type: object available_quantity: diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminInvite.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminInvite.yaml index 566d068b14..500fa0a27f 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminInvite.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminInvite.yaml @@ -35,6 +35,9 @@ properties: metadata: type: object description: The invite's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminOrder.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminOrder.yaml index ac1c9a0489..f0d0784c76 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminOrder.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminOrder.yaml @@ -139,6 +139,9 @@ properties: metadata: type: object description: The order's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminOrderAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminOrderAddress.yaml index fad010e48b..fb80941ffa 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminOrderAddress.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminOrderAddress.yaml @@ -65,6 +65,9 @@ properties: metadata: type: object description: The address's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminOrderChange.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminOrderChange.yaml index 195bd76d5e..36005625f3 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminOrderChange.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminOrderChange.yaml @@ -112,6 +112,9 @@ properties: metadata: type: object description: The order change's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata declined_at: type: string title: declined_at diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminOrderFulfillment.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminOrderFulfillment.yaml index e1312673f4..7ae1b3f61d 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminOrderFulfillment.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminOrderFulfillment.yaml @@ -63,6 +63,9 @@ properties: metadata: type: object description: The fulfillment's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminOrderLineItem.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminOrderLineItem.yaml index a6b3ba9b68..c590d05144 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminOrderLineItem.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminOrderLineItem.yaml @@ -160,6 +160,9 @@ properties: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata original_total: type: number title: original_total diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminOrderPreview.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminOrderPreview.yaml index 030a16e48c..98cf4090b7 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminOrderPreview.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminOrderPreview.yaml @@ -217,6 +217,9 @@ properties: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata original_total: type: number title: original_total @@ -354,6 +357,9 @@ properties: metadata: type: object description: The shipping method's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata tax_lines: type: array description: The shipping method's tax lines. @@ -543,6 +549,9 @@ properties: metadata: type: object description: The order's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminOrderShippingMethod.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminOrderShippingMethod.yaml index ab93242120..1b64bc87e6 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminOrderShippingMethod.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminOrderShippingMethod.yaml @@ -60,6 +60,9 @@ properties: metadata: type: object description: The shipping method's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata tax_lines: type: array description: The shipping method's tax lines. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPaymentCollection.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPaymentCollection.yaml index 1af31ef864..a67ab43e57 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPaymentCollection.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPaymentCollection.yaml @@ -50,6 +50,9 @@ properties: metadata: type: object description: The payment collection's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata status: type: string description: The payment collection's status. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsAddItemsReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsAddItemsReqSchema.yaml index c9ce264412..71c3bc5ac6 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsAddItemsReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsAddItemsReqSchema.yaml @@ -31,3 +31,6 @@ properties: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsShippingActionReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsShippingActionReqSchema.yaml index 8d6fe6cdad..d16214b606 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsShippingActionReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsShippingActionReqSchema.yaml @@ -13,3 +13,6 @@ properties: metadata: type: object description: The claim's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsShippingReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsShippingReqSchema.yaml index 34e2356020..ec629bd78a 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsShippingReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsShippingReqSchema.yaml @@ -23,3 +23,6 @@ properties: metadata: type: object description: The claim's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesAddItemsReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesAddItemsReqSchema.yaml index bc0234b0bd..33f64855b3 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesAddItemsReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesAddItemsReqSchema.yaml @@ -35,3 +35,6 @@ properties: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesRequestItemsReturnActionReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesRequestItemsReturnActionReqSchema.yaml index 666ccbcfe5..b54a811fac 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesRequestItemsReturnActionReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesRequestItemsReturnActionReqSchema.yaml @@ -17,3 +17,6 @@ properties: metadata: type: object description: The exchange's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesReturnRequestItemsReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesReturnRequestItemsReqSchema.yaml index da3d011473..0149dfd44a 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesReturnRequestItemsReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesReturnRequestItemsReqSchema.yaml @@ -35,3 +35,6 @@ properties: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesShippingActionReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesShippingActionReqSchema.yaml index 9564ca8aa4..4fa5f2d335 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesShippingActionReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesShippingActionReqSchema.yaml @@ -13,3 +13,6 @@ properties: metadata: type: object description: The exchange's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesShippingReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesShippingReqSchema.yaml index 4bff8e27eb..577bcd7bc7 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesShippingReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesShippingReqSchema.yaml @@ -23,3 +23,6 @@ properties: metadata: type: object description: The exchange's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderClaimsReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderClaimsReqSchema.yaml index e3dc6b300e..b828e16fa2 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderClaimsReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderClaimsReqSchema.yaml @@ -30,3 +30,6 @@ properties: metadata: type: object description: The claim's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsAddItemsReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsAddItemsReqSchema.yaml index d477bfb838..91614c5e78 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsAddItemsReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsAddItemsReqSchema.yaml @@ -37,6 +37,9 @@ properties: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata compare_at_unit_price: type: number title: compare_at_unit_price diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsReqSchema.yaml index 23a158dae9..bffbcdd2c2 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsReqSchema.yaml @@ -19,3 +19,6 @@ properties: metadata: type: object description: The order edit's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsShippingActionReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsShippingActionReqSchema.yaml index 3bad2acc19..a7c7003352 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsShippingActionReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsShippingActionReqSchema.yaml @@ -13,3 +13,6 @@ properties: metadata: type: object description: The order edit's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsShippingReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsShippingReqSchema.yaml index 3327fc1442..4aa99ea642 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsShippingReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsShippingReqSchema.yaml @@ -23,3 +23,6 @@ properties: metadata: type: object description: The shipping method's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderExchangesReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderExchangesReqSchema.yaml index 4472a42d37..f6f32aad33 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderExchangesReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderExchangesReqSchema.yaml @@ -19,3 +19,6 @@ properties: metadata: type: object description: The exchange's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostReceiveReturnsReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostReceiveReturnsReqSchema.yaml index 12d20a347b..f4b1f18cb7 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostReceiveReturnsReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostReceiveReturnsReqSchema.yaml @@ -13,3 +13,6 @@ properties: metadata: type: object description: The return's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsReqSchema.yaml index 0fbd580159..137c180ca9 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsReqSchema.yaml @@ -27,3 +27,6 @@ properties: metadata: type: object description: The return's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsRequestItemsActionReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsRequestItemsActionReqSchema.yaml index 0d0c6e633c..0ae505d7fb 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsRequestItemsActionReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsRequestItemsActionReqSchema.yaml @@ -17,3 +17,6 @@ properties: metadata: type: object description: The claim's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsRequestItemsReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsRequestItemsReqSchema.yaml index d47549d7ef..b64ffbe8d0 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsRequestItemsReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsRequestItemsReqSchema.yaml @@ -35,3 +35,6 @@ properties: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsReturnReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsReturnReqSchema.yaml index bdb5f9b00d..638346da8c 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsReturnReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsReturnReqSchema.yaml @@ -15,3 +15,6 @@ properties: metadata: type: object description: The return's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsShippingActionReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsShippingActionReqSchema.yaml index 2fb4607a74..0ad7fb99be 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsShippingActionReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsShippingActionReqSchema.yaml @@ -13,3 +13,6 @@ properties: metadata: type: object description: The return's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsShippingReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsShippingReqSchema.yaml index 861fa03fc7..d7ab099fe3 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsShippingReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsShippingReqSchema.yaml @@ -23,3 +23,6 @@ properties: metadata: type: object description: The exchange's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProduct.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProduct.yaml index 304df0f157..6674fcc3e6 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProduct.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProduct.yaml @@ -86,6 +86,9 @@ properties: metadata: type: object description: The product's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductCategory.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductCategory.yaml index 3c5286bc34..b14093d05d 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProductCategory.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductCategory.yaml @@ -43,6 +43,9 @@ properties: metadata: type: object description: The category's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductImage.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductImage.yaml index d1561e5a2f..1238fdf516 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProductImage.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductImage.yaml @@ -28,6 +28,9 @@ properties: metadata: type: object description: The image's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata rank: type: number title: rank diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductOption.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductOption.yaml index 415115c416..ab5b7196de 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProductOption.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductOption.yaml @@ -27,6 +27,9 @@ properties: metadata: type: object description: The product option's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductOptionValue.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductOptionValue.yaml index 88175464a4..28ec39ea38 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProductOptionValue.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductOptionValue.yaml @@ -22,6 +22,9 @@ properties: metadata: type: object description: The value's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductTag.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductTag.yaml index 7fc320de89..8fb2c7567e 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProductTag.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductTag.yaml @@ -33,3 +33,6 @@ properties: metadata: type: object description: The tag's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductType.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductType.yaml index ef5f2ece56..6cef7208c7 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProductType.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductType.yaml @@ -33,3 +33,6 @@ properties: metadata: type: object description: The type's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductVariant.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductVariant.yaml index 5696575641..b6c4ca8752 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProductVariant.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductVariant.yaml @@ -136,6 +136,9 @@ properties: metadata: type: object description: The variant's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata inventory_items: type: array description: The variant's inventory items. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminRefundReason.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminRefundReason.yaml index 919bb56bfa..a1f49a55fa 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminRefundReason.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminRefundReason.yaml @@ -23,6 +23,9 @@ properties: metadata: type: object description: The refund reason's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminRegion.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminRegion.yaml index 96b6ff979c..f8126c6286 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminRegion.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminRegion.yaml @@ -36,6 +36,9 @@ properties: metadata: type: object description: The region's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminReservation.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminReservation.yaml index 2b75d1102d..652eb20437 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminReservation.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminReservation.yaml @@ -43,6 +43,9 @@ properties: metadata: type: object description: The reservation's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_by: type: string title: created_by diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminReturnItem.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminReturnItem.yaml index 96691fc7ca..0d4d8cb249 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminReturnItem.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminReturnItem.yaml @@ -48,3 +48,6 @@ properties: metadata: type: object description: The return item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminReturnReason.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminReturnReason.yaml index 7de3166b71..fe647c7656 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminReturnReason.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminReturnReason.yaml @@ -27,6 +27,9 @@ properties: metadata: type: object description: The return reason's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminSalesChannel.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminSalesChannel.yaml index 2311a9b687..8ed84c4f28 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminSalesChannel.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminSalesChannel.yaml @@ -30,6 +30,9 @@ properties: metadata: type: object description: The sales channel's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminShippingOption.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminShippingOption.yaml index 7cb57ee389..116a1b720e 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminShippingOption.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminShippingOption.yaml @@ -88,6 +88,9 @@ properties: metadata: type: object description: The shipping option's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminShippingProfile.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminShippingProfile.yaml index 1dc31c1b5b..9a29de8f6c 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminShippingProfile.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminShippingProfile.yaml @@ -17,6 +17,9 @@ properties: metadata: type: object description: The shipping profile's metadata, holds custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminStore.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminStore.yaml index 32f483dc82..7dbecee439 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminStore.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminStore.yaml @@ -40,6 +40,9 @@ properties: metadata: type: object description: The store's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminStoreCreditAccount.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminStoreCreditAccount.yaml index 0e54b944b4..4c19a0069c 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminStoreCreditAccount.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminStoreCreditAccount.yaml @@ -49,6 +49,9 @@ properties: metadata: type: object description: The store credit account's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminTaxRate.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminTaxRate.yaml index 7972123ffe..19c88dbd9b 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminTaxRate.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminTaxRate.yaml @@ -37,6 +37,9 @@ properties: metadata: type: object description: The tax rate's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata tax_region_id: type: string title: tax_region_id diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminTaxRegion.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminTaxRegion.yaml index f75bb9af92..7595bc5aba 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminTaxRegion.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminTaxRegion.yaml @@ -35,6 +35,9 @@ properties: metadata: type: object description: The tax region's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata parent_id: type: string title: parent_id diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminTransaction.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminTransaction.yaml index 0a488a5fd2..fae0c25d1c 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminTransaction.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminTransaction.yaml @@ -51,6 +51,9 @@ properties: metadata: type: object description: The transaction's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminTransactionGroup.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminTransactionGroup.yaml index bf509bb167..40e5f640f0 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminTransactionGroup.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminTransactionGroup.yaml @@ -35,3 +35,6 @@ properties: metadata: type: object description: The transaction group's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateCustomerGroup.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateCustomerGroup.yaml index 57fb90e715..930e67c47e 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateCustomerGroup.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateCustomerGroup.yaml @@ -9,3 +9,6 @@ properties: metadata: type: object description: The customer group's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateDraftOrder.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateDraftOrder.yaml index e4e0c8a5ee..8396b38deb 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateDraftOrder.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateDraftOrder.yaml @@ -59,6 +59,9 @@ properties: metadata: type: object description: The shipping address's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata billing_address: type: object description: The draft order's billing address. @@ -111,9 +114,15 @@ properties: metadata: type: object description: The billing address's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata metadata: type: object description: The draft order's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata customer_id: type: string title: customer_id diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateDraftOrderActionShippingMethod.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateDraftOrderActionShippingMethod.yaml index 8b2d7422db..48b76c24ec 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateDraftOrderActionShippingMethod.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateDraftOrderActionShippingMethod.yaml @@ -25,3 +25,6 @@ properties: metadata: type: object description: The shipping method's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateFulfillmentSetServiceZones.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateFulfillmentSetServiceZones.yaml index 982be2f5eb..a319aa1491 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateFulfillmentSetServiceZones.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateFulfillmentSetServiceZones.yaml @@ -25,6 +25,9 @@ properties: metadata: type: object description: The geo zone's metadata. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata country_code: type: string title: country_code @@ -49,6 +52,9 @@ properties: metadata: type: object description: The geo zone's metadata. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata country_code: type: string title: country_code @@ -82,6 +88,9 @@ properties: metadata: type: object description: The geo zone's metadata. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata city: type: string title: city @@ -120,6 +129,9 @@ properties: metadata: type: object description: The geo zone's metadata. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata city: type: string title: city diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateGiftCardParams.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateGiftCardParams.yaml index f53e7e9728..108d2cde1e 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateGiftCardParams.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateGiftCardParams.yaml @@ -32,3 +32,6 @@ properties: metadata: type: object description: The gift card's metadata. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateInventoryItem.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateInventoryItem.yaml index 34faa57636..c7a6b67450 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateInventoryItem.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateInventoryItem.yaml @@ -58,4 +58,7 @@ properties: metadata: type: object description: The inventory item's metadata. Can be custom data in key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata x-schemaName: AdminUpdateInventoryItem diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateOrder.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateOrder.yaml index 78280d8e76..cd3ef369d9 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateOrder.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateOrder.yaml @@ -59,6 +59,9 @@ properties: metadata: type: object description: The address's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata billing_address: type: object description: The order's billing address. @@ -111,6 +114,12 @@ properties: metadata: type: object description: The address's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata metadata: type: object description: The order's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateProduct.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateProduct.yaml index 1f220e671f..c0d35a7892 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateProduct.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateProduct.yaml @@ -147,6 +147,9 @@ properties: metadata: type: object description: The product's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata external_id: type: string title: external_id diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateProductCategory.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateProductCategory.yaml index 5ce56e3290..2f8962e651 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateProductCategory.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateProductCategory.yaml @@ -30,6 +30,9 @@ properties: metadata: type: object description: The product category's metadata. Can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata rank: type: number title: rank diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateProductTag.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateProductTag.yaml index 674eb56aa6..50b569184e 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateProductTag.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateProductTag.yaml @@ -8,4 +8,7 @@ properties: metadata: type: object description: The product tag's metadata. Can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata x-schemaName: AdminUpdateProductTag diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateProductType.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateProductType.yaml index e086a5129f..6c60edd1a6 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateProductType.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateProductType.yaml @@ -8,4 +8,7 @@ properties: metadata: type: object description: The product type's metadata. Can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata x-schemaName: AdminUpdateProductType diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateProductVariant.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateProductVariant.yaml index 59f99cff83..93e6b70266 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateProductVariant.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateProductVariant.yaml @@ -71,6 +71,9 @@ properties: metadata: type: object description: The product variant's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata prices: type: array description: The product variant's prices. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateRegion.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateRegion.yaml index 57633c59f9..740456f51c 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateRegion.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateRegion.yaml @@ -30,6 +30,9 @@ properties: metadata: type: object description: The region's metadata. Can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata is_tax_inclusive: type: boolean title: is_tax_inclusive diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateReservation.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateReservation.yaml index c274e12d51..e2931ef4b8 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateReservation.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateReservation.yaml @@ -16,4 +16,7 @@ properties: metadata: type: object description: The reservation's metadata. Can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata x-schemaName: AdminUpdateReservation diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateReturnReason.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateReturnReason.yaml index 3299988196..9f1309e182 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateReturnReason.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateReturnReason.yaml @@ -17,6 +17,9 @@ properties: metadata: type: object description: The return reason's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata required: - value - label diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateSalesChannel.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateSalesChannel.yaml index db5e76e560..d1e4592427 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateSalesChannel.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateSalesChannel.yaml @@ -17,3 +17,6 @@ properties: metadata: type: object description: The sales channel's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateShippingProfile.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateShippingProfile.yaml index 468cc8ab28..4102792ddf 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateShippingProfile.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateShippingProfile.yaml @@ -12,4 +12,7 @@ properties: metadata: type: object description: The shipping profile's metadata. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata x-schemaName: AdminUpdateShippingProfile diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateStockLocation.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateStockLocation.yaml index 9d47328396..ed60861669 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateStockLocation.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateStockLocation.yaml @@ -61,3 +61,6 @@ properties: metadata: type: object description: The stock location's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateStore.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateStore.yaml index e8c4463b52..734283353b 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateStore.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateStore.yaml @@ -43,3 +43,6 @@ properties: metadata: type: object description: The store's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateTaxRate.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateTaxRate.yaml index 8000de42a9..e79271cd68 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateTaxRate.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateTaxRate.yaml @@ -48,3 +48,6 @@ properties: metadata: type: object description: The tax rate's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateTaxRegion.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateTaxRegion.yaml index 9420709221..ee6a84b52e 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateTaxRegion.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateTaxRegion.yaml @@ -13,6 +13,9 @@ properties: metadata: type: object description: The tax region's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata provider_id: type: string title: provider_id diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateUser.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateUser.yaml index 32e881a213..c6011259d7 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateUser.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateUser.yaml @@ -17,3 +17,6 @@ properties: metadata: type: object description: The user's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUser.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUser.yaml index c3bca505cb..223368c4c7 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUser.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUser.yaml @@ -36,6 +36,9 @@ properties: metadata: type: object description: The user's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseCart.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseCart.yaml index 5ba46f61aa..c3dd5d8621 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseCart.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseCart.yaml @@ -73,6 +73,9 @@ properties: metadata: type: object description: The cart's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseCartLineItem.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseCartLineItem.yaml index b2e59d9621..eca6c74f23 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseCartLineItem.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseCartLineItem.yaml @@ -133,6 +133,9 @@ properties: metadata: type: object description: The item's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseCartShippingMethod.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseCartShippingMethod.yaml index 0a23a60cdc..2601c6fffd 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseCartShippingMethod.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseCartShippingMethod.yaml @@ -57,6 +57,9 @@ properties: metadata: type: object description: The shipping method's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata tax_lines: type: array description: The shipping method's tax lines. diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseClaimItem.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseClaimItem.yaml index fe407754be..470709cfa6 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseClaimItem.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseClaimItem.yaml @@ -55,6 +55,9 @@ properties: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseCollection.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseCollection.yaml index 58ab3baab3..a038a2eab7 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseCollection.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseCollection.yaml @@ -45,3 +45,6 @@ properties: metadata: type: object description: The collection's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseExchangeItem.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseExchangeItem.yaml index 82c98c6dbf..8fa9874692 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseExchangeItem.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseExchangeItem.yaml @@ -33,6 +33,9 @@ properties: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseOrder.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseOrder.yaml index daa6b8cc66..4322ff6393 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseOrder.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseOrder.yaml @@ -134,6 +134,9 @@ properties: metadata: type: object description: The order's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseOrderAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseOrderAddress.yaml index 87e7549077..0b2e3f17d7 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseOrderAddress.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseOrderAddress.yaml @@ -63,6 +63,9 @@ properties: metadata: type: object description: The address's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseOrderFulfillment.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseOrderFulfillment.yaml index eba0b4539b..824eb98ba3 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseOrderFulfillment.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseOrderFulfillment.yaml @@ -63,6 +63,9 @@ properties: metadata: type: object description: The fulfillment's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseOrderLineItem.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseOrderLineItem.yaml index 115a58c2db..279d023e9c 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseOrderLineItem.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseOrderLineItem.yaml @@ -160,6 +160,9 @@ properties: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata original_total: type: number title: original_total diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseOrderShippingMethod.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseOrderShippingMethod.yaml index 930352a943..54df7640ad 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseOrderShippingMethod.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseOrderShippingMethod.yaml @@ -60,6 +60,9 @@ properties: metadata: type: object description: The shipping method's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata tax_lines: type: array description: The shipping method's tax lines. diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseOrderTransaction.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseOrderTransaction.yaml index f822566df9..542c5349d2 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseOrderTransaction.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseOrderTransaction.yaml @@ -46,6 +46,9 @@ properties: metadata: type: object description: The transaction's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/BasePaymentCollection.yaml b/www/apps/api-reference/specs/store/components/schemas/BasePaymentCollection.yaml index e5c542339e..47c61f8a0c 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BasePaymentCollection.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BasePaymentCollection.yaml @@ -50,6 +50,9 @@ properties: metadata: type: object description: The payment collection's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata status: type: string description: The payment collection's status. diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseProduct.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseProduct.yaml index 51b5946075..6b2f40b707 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseProduct.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseProduct.yaml @@ -80,6 +80,9 @@ properties: metadata: type: object description: The product's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseProductCategory.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseProductCategory.yaml index b7311e2213..589d8220ee 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseProductCategory.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseProductCategory.yaml @@ -43,6 +43,9 @@ properties: metadata: type: object description: The category's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseProductImage.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseProductImage.yaml index 25637c69e8..cb6694260c 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseProductImage.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseProductImage.yaml @@ -28,6 +28,9 @@ properties: metadata: type: object description: The image's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata rank: type: number title: rank diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseProductOption.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseProductOption.yaml index 7964d121fe..69e0e5a487 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseProductOption.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseProductOption.yaml @@ -27,6 +27,9 @@ properties: metadata: type: object description: The product option's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseProductOptionValue.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseProductOptionValue.yaml index ba0a4dfd87..83b476b9eb 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseProductOptionValue.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseProductOptionValue.yaml @@ -22,6 +22,9 @@ properties: metadata: type: object description: The value's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseProductTag.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseProductTag.yaml index 2f9a58b017..f39f147ccc 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseProductTag.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseProductTag.yaml @@ -33,3 +33,6 @@ properties: metadata: type: object description: The tag's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseProductType.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseProductType.yaml index 70c15ce3ff..34600a475f 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseProductType.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseProductType.yaml @@ -33,3 +33,6 @@ properties: metadata: type: object description: The type's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseProductVariant.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseProductVariant.yaml index e27ee0ea8c..74d80a6209 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseProductVariant.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseProductVariant.yaml @@ -130,3 +130,6 @@ properties: metadata: type: object description: The variant's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseRegion.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseRegion.yaml index bbf5758714..6e64976df1 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseRegion.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseRegion.yaml @@ -35,6 +35,9 @@ properties: metadata: type: object description: The region's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/CreateAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/CreateAddress.yaml index a610a042be..238fe69428 100644 --- a/www/apps/api-reference/specs/store/components/schemas/CreateAddress.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/CreateAddress.yaml @@ -54,3 +54,6 @@ properties: metadata: type: object description: The address's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/InventoryLevel.yaml b/www/apps/api-reference/specs/store/components/schemas/InventoryLevel.yaml index aa13bb7243..6107f2104a 100644 --- a/www/apps/api-reference/specs/store/components/schemas/InventoryLevel.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/InventoryLevel.yaml @@ -41,3 +41,6 @@ properties: metadata: type: object description: The inventory level's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/Order.yaml b/www/apps/api-reference/specs/store/components/schemas/Order.yaml index a933e4e94d..6c331fd686 100644 --- a/www/apps/api-reference/specs/store/components/schemas/Order.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/Order.yaml @@ -177,6 +177,9 @@ properties: metadata: type: object description: The order's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata canceled_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/OrderAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/OrderAddress.yaml index f2ca629923..8160d47381 100644 --- a/www/apps/api-reference/specs/store/components/schemas/OrderAddress.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/OrderAddress.yaml @@ -62,6 +62,9 @@ properties: metadata: type: object description: The address's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/OrderChange.yaml b/www/apps/api-reference/specs/store/components/schemas/OrderChange.yaml index 58d07e2b68..72b1f74a7b 100644 --- a/www/apps/api-reference/specs/store/components/schemas/OrderChange.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/OrderChange.yaml @@ -112,6 +112,9 @@ properties: metadata: type: object description: The order change's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata declined_at: type: string title: declined_at diff --git a/www/apps/api-reference/specs/store/components/schemas/OrderClaim.yaml b/www/apps/api-reference/specs/store/components/schemas/OrderClaim.yaml index a68218b780..9acfe0de87 100644 --- a/www/apps/api-reference/specs/store/components/schemas/OrderClaim.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/OrderClaim.yaml @@ -64,6 +64,9 @@ properties: metadata: type: object description: The claim's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/OrderCreditLine.yaml b/www/apps/api-reference/specs/store/components/schemas/OrderCreditLine.yaml index 17b199333b..e2769840af 100644 --- a/www/apps/api-reference/specs/store/components/schemas/OrderCreditLine.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/OrderCreditLine.yaml @@ -35,6 +35,9 @@ properties: metadata: type: object description: The credit line's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/OrderExchange.yaml b/www/apps/api-reference/specs/store/components/schemas/OrderExchange.yaml index 857b9ed634..e211bb4ba0 100644 --- a/www/apps/api-reference/specs/store/components/schemas/OrderExchange.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/OrderExchange.yaml @@ -59,6 +59,9 @@ properties: metadata: type: object description: The exchange's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/OrderItem.yaml b/www/apps/api-reference/specs/store/components/schemas/OrderItem.yaml index ab12ebb4d2..98fe9e4853 100644 --- a/www/apps/api-reference/specs/store/components/schemas/OrderItem.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/OrderItem.yaml @@ -62,6 +62,9 @@ properties: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/OrderLineItem.yaml b/www/apps/api-reference/specs/store/components/schemas/OrderLineItem.yaml index 1a0cf29b96..3bf42aa2b2 100644 --- a/www/apps/api-reference/specs/store/components/schemas/OrderLineItem.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/OrderLineItem.yaml @@ -141,6 +141,9 @@ properties: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata original_total: type: number title: original_total diff --git a/www/apps/api-reference/specs/store/components/schemas/OrderReturnItem.yaml b/www/apps/api-reference/specs/store/components/schemas/OrderReturnItem.yaml index 41fd512de0..465be4ee1f 100644 --- a/www/apps/api-reference/specs/store/components/schemas/OrderReturnItem.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/OrderReturnItem.yaml @@ -37,6 +37,9 @@ properties: metadata: type: object description: The return item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata order_id: type: string title: order_id diff --git a/www/apps/api-reference/specs/store/components/schemas/OrderShippingMethod.yaml b/www/apps/api-reference/specs/store/components/schemas/OrderShippingMethod.yaml index 3aa794be00..b052eacde5 100644 --- a/www/apps/api-reference/specs/store/components/schemas/OrderShippingMethod.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/OrderShippingMethod.yaml @@ -57,6 +57,9 @@ properties: metadata: type: object description: The shipping method's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata tax_lines: type: array description: The shipping method's tax lines. diff --git a/www/apps/api-reference/specs/store/components/schemas/OrderTransaction.yaml b/www/apps/api-reference/specs/store/components/schemas/OrderTransaction.yaml index d497d2305c..76e5da6dfc 100644 --- a/www/apps/api-reference/specs/store/components/schemas/OrderTransaction.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/OrderTransaction.yaml @@ -48,6 +48,9 @@ properties: metadata: type: object description: The transaction's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/RefundReason.yaml b/www/apps/api-reference/specs/store/components/schemas/RefundReason.yaml index 5c68174797..fad95d0cde 100644 --- a/www/apps/api-reference/specs/store/components/schemas/RefundReason.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/RefundReason.yaml @@ -23,6 +23,9 @@ properties: metadata: type: object description: The refund reason's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/Return.yaml b/www/apps/api-reference/specs/store/components/schemas/Return.yaml index cfefdef18c..f0933b5d2c 100644 --- a/www/apps/api-reference/specs/store/components/schemas/Return.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/Return.yaml @@ -47,6 +47,9 @@ properties: metadata: type: object description: The return's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreAddCartLineItem.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreAddCartLineItem.yaml index 8ce18622d4..b967a3087e 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreAddCartLineItem.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreAddCartLineItem.yaml @@ -16,3 +16,6 @@ properties: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCart.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCart.yaml index 6cd3dc8a0d..2ff9e3c53a 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreCart.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCart.yaml @@ -78,6 +78,9 @@ properties: metadata: type: object description: The cart's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCartAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCartAddress.yaml index 89963e7b4c..6f1f560076 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreCartAddress.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCartAddress.yaml @@ -62,6 +62,9 @@ properties: metadata: type: object description: The address's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string title: created_at diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCartLineItem.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCartLineItem.yaml index 824b9623cb..cbb841f1d0 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreCartLineItem.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCartLineItem.yaml @@ -277,6 +277,9 @@ properties: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string title: created_at diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCartShippingMethod.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCartShippingMethod.yaml index 818a670856..4cd0151100 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreCartShippingMethod.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCartShippingMethod.yaml @@ -57,6 +57,9 @@ properties: metadata: type: object description: The shipping method's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata tax_lines: type: array description: The shipping method's tax lines. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCollection.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCollection.yaml index 121ef729ec..b5f66d0361 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreCollection.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCollection.yaml @@ -45,3 +45,6 @@ properties: metadata: type: object description: The collection's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCreateCart.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCreateCart.yaml index 69fb5ff088..608d8bbea2 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreCreateCart.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCreateCart.yaml @@ -39,3 +39,6 @@ properties: metadata: type: object description: The cart's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCreateCustomer.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCreateCustomer.yaml index 6821b05339..2685212918 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreCreateCustomer.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCreateCustomer.yaml @@ -28,3 +28,6 @@ properties: metadata: type: object description: The customer's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCustomer.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCustomer.yaml index 0c0997ff3f..d079b0a0e7 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreCustomer.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCustomer.yaml @@ -52,6 +52,9 @@ properties: metadata: type: object description: The customer's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCustomerAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCustomerAddress.yaml index 7c24514a35..1153236620 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreCustomerAddress.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCustomerAddress.yaml @@ -89,6 +89,9 @@ properties: metadata: type: object description: The address's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreOrder.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreOrder.yaml index 8235fd5e24..c4013d4431 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreOrder.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreOrder.yaml @@ -125,6 +125,9 @@ properties: metadata: type: object description: The order's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreOrderAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreOrderAddress.yaml index 8c24ea8e12..a960f1c7fb 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreOrderAddress.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreOrderAddress.yaml @@ -65,6 +65,9 @@ properties: metadata: type: object description: The address's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreOrderFulfillment.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreOrderFulfillment.yaml index 4c9e22c359..ed2f535f34 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreOrderFulfillment.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreOrderFulfillment.yaml @@ -63,6 +63,9 @@ properties: metadata: type: object description: The fulfillment's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreOrderLineItem.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreOrderLineItem.yaml index 556ab17106..0925dc3195 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreOrderLineItem.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreOrderLineItem.yaml @@ -349,6 +349,9 @@ properties: metadata: type: object description: The variant's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata variant_id: type: string title: variant_id @@ -530,6 +533,9 @@ properties: metadata: type: object description: The product's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata product_id: type: string title: product_id @@ -794,6 +800,9 @@ properties: metadata: type: object description: The detail's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -817,6 +826,9 @@ properties: metadata: type: object description: The item's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata original_total: type: number title: original_total @@ -1016,6 +1028,9 @@ properties: metadata: type: object description: The variant's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -1201,6 +1216,9 @@ properties: metadata: type: object description: The product's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -1494,6 +1512,10 @@ properties: metadata: type: object description: The detail's metadata. + externalDocs: + url: >- + https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -1524,6 +1546,9 @@ properties: metadata: type: object description: The item's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -1878,6 +1903,9 @@ properties: metadata: type: object description: The variant's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata variant_id: type: string title: variant_id @@ -2059,6 +2087,9 @@ properties: metadata: type: object description: The product's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata product_id: type: string title: product_id @@ -2323,6 +2354,9 @@ properties: metadata: type: object description: The detail's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -2346,6 +2380,9 @@ properties: metadata: type: object description: The item's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata original_total: type: number title: original_total @@ -2541,6 +2578,9 @@ properties: metadata: type: object description: The variant's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -2726,6 +2766,9 @@ properties: metadata: type: object description: The product's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -3019,6 +3062,10 @@ properties: metadata: type: object description: The detail's metadata. + externalDocs: + url: >- + https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -3049,6 +3096,9 @@ properties: metadata: type: object description: The item's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -3295,6 +3345,9 @@ properties: metadata: type: object description: The variant's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -3480,6 +3533,9 @@ properties: metadata: type: object description: The product's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -3773,6 +3829,9 @@ properties: metadata: type: object description: The detail's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -3803,6 +3862,9 @@ properties: metadata: type: object description: The item's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -3958,6 +4020,9 @@ properties: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata original_total: type: number title: original_total diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreOrderShippingMethod.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreOrderShippingMethod.yaml index 513ce23b45..b2994b98df 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreOrderShippingMethod.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreOrderShippingMethod.yaml @@ -60,6 +60,9 @@ properties: metadata: type: object description: The shipping method's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata tax_lines: type: array description: The shipping method's tax lines. @@ -137,6 +140,9 @@ properties: metadata: type: object description: The shipping method's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata tax_lines: type: array description: The shipping method's tax lines. @@ -668,6 +674,9 @@ properties: metadata: type: object description: The shipping method's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata original_total: type: number title: original_total @@ -786,6 +795,9 @@ properties: metadata: type: object description: The shipping method's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata tax_lines: type: array description: The shipping method's tax lines. @@ -1313,6 +1325,9 @@ properties: metadata: type: object description: The shipping method's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata original_total: type: number title: original_total @@ -1669,6 +1684,9 @@ properties: metadata: type: object description: The shipping method's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata original_total: type: number title: original_total diff --git a/www/apps/api-reference/specs/store/components/schemas/StorePaymentCollection.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePaymentCollection.yaml index b1f572ce80..bd11eb1da2 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StorePaymentCollection.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StorePaymentCollection.yaml @@ -50,6 +50,9 @@ properties: metadata: type: object description: The payment collection's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata status: type: string description: The payment collection's status. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreProduct.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreProduct.yaml index 137cd220c4..b985c4eef9 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreProduct.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreProduct.yaml @@ -68,6 +68,9 @@ properties: metadata: type: object description: The product's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreProductCategory.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreProductCategory.yaml index 4df135c98f..b1e3dafb31 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreProductCategory.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreProductCategory.yaml @@ -48,6 +48,9 @@ properties: metadata: type: object description: The category's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreProductImage.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreProductImage.yaml index a3b3b1c72a..21e551b763 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreProductImage.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreProductImage.yaml @@ -32,6 +32,9 @@ properties: metadata: type: object description: The image's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata rank: type: number title: rank diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreProductOption.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreProductOption.yaml index 40ba71a5d9..06b88c40d2 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreProductOption.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreProductOption.yaml @@ -24,6 +24,9 @@ properties: metadata: type: object description: The option's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreProductOptionValue.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreProductOptionValue.yaml index 9a754c37c2..5a4a747f0a 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreProductOptionValue.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreProductOptionValue.yaml @@ -22,6 +22,9 @@ properties: metadata: type: object description: The value's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreProductTag.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreProductTag.yaml index 1e31fdb2fb..cce1492ca6 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreProductTag.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreProductTag.yaml @@ -28,6 +28,9 @@ properties: metadata: type: object description: The tag's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata required: - id - value diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreProductType.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreProductType.yaml index ed951b4c13..96a52be903 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreProductType.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreProductType.yaml @@ -14,6 +14,9 @@ properties: metadata: type: object description: The product type's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreProductVariant.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreProductVariant.yaml index 677ad64a10..5ee38cc877 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreProductVariant.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreProductVariant.yaml @@ -20,6 +20,9 @@ properties: metadata: type: object description: The variant's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata id: type: string title: id diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreRegion.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreRegion.yaml index 4f92f9c220..cd8f654d03 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreRegion.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreRegion.yaml @@ -38,6 +38,9 @@ properties: metadata: type: object description: The region's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreReturnItem.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreReturnItem.yaml index bd4223318c..5b681b1ca4 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreReturnItem.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreReturnItem.yaml @@ -44,3 +44,6 @@ properties: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreReturnReason.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreReturnReason.yaml index b08051fb32..c7b6e9ed0f 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreReturnReason.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreReturnReason.yaml @@ -27,6 +27,9 @@ properties: metadata: type: object description: The return reason's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreShippingOption.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreShippingOption.yaml index c1e75ff242..c57f31d6d8 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreShippingOption.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreShippingOption.yaml @@ -70,3 +70,6 @@ properties: metadata: type: object description: The shipping option's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreStoreCreditAccount.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreStoreCreditAccount.yaml index 26cf2ddc5b..44d636dcb5 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreStoreCreditAccount.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreStoreCreditAccount.yaml @@ -49,6 +49,9 @@ properties: metadata: type: object description: The store credit account's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreTransactionGroup.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreTransactionGroup.yaml index 0a7fe807c1..6ddf0d8bb7 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreTransactionGroup.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreTransactionGroup.yaml @@ -34,4 +34,7 @@ properties: metadata: type: object description: The transaction group's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata x-schemaName: StoreTransactionGroup diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreUpdateCartLineItem.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreUpdateCartLineItem.yaml index 844c2958ce..dc31e201cc 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreUpdateCartLineItem.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreUpdateCartLineItem.yaml @@ -11,3 +11,6 @@ properties: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreUpdateCustomer.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreUpdateCustomer.yaml index 700e28826a..8e1fb61246 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreUpdateCustomer.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreUpdateCustomer.yaml @@ -21,3 +21,6 @@ properties: metadata: type: object description: The customer's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/UpdateAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/UpdateAddress.yaml index 6968ed3b46..08c8e679b5 100644 --- a/www/apps/api-reference/specs/store/components/schemas/UpdateAddress.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/UpdateAddress.yaml @@ -60,3 +60,6 @@ properties: metadata: type: object description: The address's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/components/schemas/UpdateCartData.yaml b/www/apps/api-reference/specs/store/components/schemas/UpdateCartData.yaml index 32376f2c2f..e7f19ea496 100644 --- a/www/apps/api-reference/specs/store/components/schemas/UpdateCartData.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/UpdateCartData.yaml @@ -47,3 +47,6 @@ properties: metadata: type: object description: The cart's metadata, ca hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata diff --git a/www/apps/api-reference/specs/store/openapi.full.yaml b/www/apps/api-reference/specs/store/openapi.full.yaml index 637397b002..f4209e7860 100644 --- a/www/apps/api-reference/specs/store/openapi.full.yaml +++ b/www/apps/api-reference/specs/store/openapi.full.yaml @@ -9576,6 +9576,9 @@ components: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminAddDraftOrderPromotions: type: object description: The details of the promotions to add to a draft order. @@ -9616,6 +9619,9 @@ components: metadata: type: object description: The shipping method's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminApiKey: type: object description: The API key's details. @@ -10206,6 +10212,9 @@ components: metadata: type: object description: The product's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata external_id: type: string title: external_id @@ -10292,6 +10301,9 @@ components: metadata: type: object description: The product variant's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata prices: type: array description: The product variant's prices. @@ -10479,6 +10491,9 @@ components: metadata: type: object description: The claim's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -10677,6 +10692,9 @@ components: metadata: type: object description: The collection's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminCollectionDeleteResponse: type: object description: The details of the deleted collection. @@ -10772,6 +10790,9 @@ components: metadata: type: object description: The customer group's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminCreateFulfillment: type: object description: The filfillment's details. @@ -10845,6 +10866,9 @@ components: metadata: type: object description: The delivery address's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata items: type: array description: The items to fulfill. @@ -10941,6 +10965,9 @@ components: metadata: type: object description: The fulfillment's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminCreateFulfillmentSetServiceZones: type: object description: The service zone's details. @@ -10966,6 +10993,9 @@ components: metadata: type: object description: The geo zone's metadata. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata country_code: type: string title: country_code @@ -10986,6 +11016,9 @@ components: metadata: type: object description: The geo zone's metadata. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata country_code: type: string title: country_code @@ -11015,6 +11048,9 @@ components: metadata: type: object description: The geo zone's metadata. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata country_code: type: string title: country_code @@ -11049,6 +11085,9 @@ components: metadata: type: object description: The geo zone's metadata. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata country_code: type: string title: country_code @@ -11126,6 +11165,9 @@ components: metadata: type: object description: The gift card's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminCreateInventoryItem: type: object description: The inventory item's details. @@ -11186,6 +11228,9 @@ components: metadata: type: object description: The inventory item's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminCreateInventoryLocationLevel: type: object description: The inventory level's details. @@ -11232,6 +11277,9 @@ components: metadata: type: object description: The credit line's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminCreatePaymentCapture: type: object description: The payment's details. @@ -11521,6 +11569,9 @@ components: metadata: type: object description: The product's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata external_id: type: string title: external_id @@ -11567,6 +11618,9 @@ components: metadata: type: object description: The product category's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminCreateProductOption: type: object description: The product option's details. @@ -11600,6 +11654,9 @@ components: metadata: type: object description: The product tag's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminCreateProductType: type: object description: The details of the product type to create. @@ -11610,6 +11667,9 @@ components: metadata: type: object description: The product's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata value: type: string title: value @@ -11689,6 +11749,9 @@ components: metadata: type: object description: The variant's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata prices: type: array description: The variant's prices. @@ -11856,6 +11919,9 @@ components: metadata: type: object description: The region's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminCreateReservation: type: object description: The reservation's details. @@ -11888,6 +11954,9 @@ components: metadata: type: object description: The reservation's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminCreateReturnReason: type: object description: The details of the return reason to create. @@ -11915,6 +11984,9 @@ components: metadata: type: object description: The return reason's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminCreateSalesChannel: type: object description: The sales channel's details. @@ -11937,6 +12009,9 @@ components: metadata: type: object description: The sales channel's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminCreateShipment: type: object description: The shipment's details. @@ -12129,6 +12204,9 @@ components: metadata: type: object description: The shipping profile's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminCreateStockLocation: type: object description: The stock location's details. @@ -12149,6 +12227,9 @@ components: metadata: type: object description: The stock location's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminCreateStockLocationFulfillmentSet: type: object description: The fulfillment set to create. @@ -12185,6 +12266,9 @@ components: metadata: type: object description: The store credit account's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminCreateTaxRate: type: object description: The tax rate's details. @@ -12230,6 +12314,9 @@ components: metadata: type: object description: The tax rate's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminCreateTaxRateRule: type: object description: The tax rate rule's details. @@ -12301,9 +12388,15 @@ components: metadata: type: object description: The default tax rate's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata metadata: type: object description: The tax region's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata provider_id: type: string title: provider_id @@ -12524,6 +12617,9 @@ components: metadata: type: object description: The customer's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_by: type: string title: created_by @@ -12635,6 +12731,9 @@ components: metadata: type: object description: The address's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -12682,6 +12781,9 @@ components: metadata: type: object description: The customer group's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -13433,6 +13535,9 @@ components: metadata: type: object description: The draft order's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -13789,6 +13894,9 @@ components: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata original_total: type: number title: original_total @@ -13915,6 +14023,9 @@ components: metadata: type: object description: The shipping method's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata tax_lines: type: array description: The shipping method's tax lines. @@ -14092,6 +14203,9 @@ components: metadata: type: object description: The order's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -14292,6 +14406,9 @@ components: metadata: type: object description: The exchange's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -14533,6 +14650,9 @@ components: metadata: type: object description: The fulfillment's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -14625,6 +14745,9 @@ components: metadata: type: object description: The address's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -15330,6 +15453,9 @@ components: metadata: type: object description: The location level's metadata. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata inventory_item: type: object available_quantity: @@ -15374,6 +15500,9 @@ components: metadata: type: object description: The invite's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -15684,6 +15813,9 @@ components: metadata: type: object description: The order's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -15865,6 +15997,9 @@ components: metadata: type: object description: The address's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -15988,6 +16123,9 @@ components: metadata: type: object description: The order change's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata declined_at: type: string title: declined_at @@ -16206,6 +16344,9 @@ components: metadata: type: object description: The fulfillment's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -16429,6 +16570,9 @@ components: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata original_total: type: number title: original_total @@ -16700,6 +16844,9 @@ components: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata original_total: type: number title: original_total @@ -16826,6 +16973,9 @@ components: metadata: type: object description: The shipping method's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata tax_lines: type: array description: The shipping method's tax lines. @@ -17003,6 +17153,9 @@ components: metadata: type: object description: The order's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -17210,6 +17363,9 @@ components: metadata: type: object description: The shipping method's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata tax_lines: type: array description: The shipping method's tax lines. @@ -17394,6 +17550,9 @@ components: metadata: type: object description: The payment collection's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata status: type: string description: The payment collection's status. @@ -17634,6 +17793,9 @@ components: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminPostClaimsItemsActionReqSchema: type: object description: The details to update in the item. @@ -17667,6 +17829,9 @@ components: metadata: type: object description: The claim's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminPostClaimsShippingReqSchema: type: object description: The details of the shipping method used to ship outbound items. @@ -17693,6 +17858,9 @@ components: metadata: type: object description: The claim's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminPostExchangesAddItemsReqSchema: type: object description: The details of outbound items. @@ -17731,6 +17899,9 @@ components: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminPostExchangesItemsActionReqSchema: type: object description: The details to update in an outbound item. @@ -17764,6 +17935,9 @@ components: metadata: type: object description: The exchange's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminPostExchangesReturnRequestItemsReqSchema: type: object description: The details of the inbound (return) items. @@ -17802,6 +17976,9 @@ components: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminPostExchangesShippingActionReqSchema: type: object description: The details of the shipping method to update. @@ -17818,6 +17995,9 @@ components: metadata: type: object description: The exchange's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminPostExchangesShippingReqSchema: type: object description: The outbound shipping method's details. @@ -17844,6 +18024,9 @@ components: metadata: type: object description: The exchange's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminPostOrderClaimsReqSchema: type: object description: The claim's details. @@ -17877,6 +18060,9 @@ components: metadata: type: object description: The claim's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminPostOrderEditsAddItemsReqSchema: type: object description: The details of items to be edited. @@ -17915,6 +18101,9 @@ components: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata compare_at_unit_price: type: number title: compare_at_unit_price @@ -17962,6 +18151,9 @@ components: metadata: type: object description: The order edit's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminPostOrderEditsShippingActionReqSchema: type: object description: The shipping method's details. @@ -17978,6 +18170,9 @@ components: metadata: type: object description: The order edit's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminPostOrderEditsShippingReqSchema: type: object description: The shipping method's details. @@ -18004,6 +18199,9 @@ components: metadata: type: object description: The shipping method's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminPostOrderEditsUpdateItemQuantityReqSchema: type: object description: The order item's details to update. @@ -18049,6 +18247,9 @@ components: metadata: type: object description: The exchange's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminPostReceiveReturnsReqSchema: type: object description: The return receival details. @@ -18065,6 +18266,9 @@ components: metadata: type: object description: The return's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminPostReturnsConfirmRequestReqSchema: type: object description: The confirmation's details. @@ -18161,6 +18365,9 @@ components: metadata: type: object description: The return's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminPostReturnsRequestItemsActionReqSchema: type: object description: The details to update in the item. @@ -18181,6 +18388,9 @@ components: metadata: type: object description: The claim's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminPostReturnsRequestItemsReqSchema: type: object description: The items' details. @@ -18219,6 +18429,9 @@ components: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminPostReturnsReturnReqSchema: type: object description: The return's details. @@ -18235,6 +18448,9 @@ components: metadata: type: object description: The return's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminPostReturnsShippingActionReqSchema: type: object description: The shipping method's details. @@ -18251,6 +18467,9 @@ components: metadata: type: object description: The return's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminPostReturnsShippingReqSchema: type: object description: The shipping method's details. @@ -18277,6 +18496,9 @@ components: metadata: type: object description: The exchange's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminPrice: type: object description: The price's details. @@ -18791,6 +19013,9 @@ components: metadata: type: object description: The product's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -18919,6 +19144,9 @@ components: metadata: type: object description: The category's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -19070,6 +19298,9 @@ components: metadata: type: object description: The image's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata rank: type: number title: rank @@ -19108,6 +19339,9 @@ components: metadata: type: object description: The product option's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -19181,6 +19415,9 @@ components: metadata: type: object description: The value's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -19241,6 +19478,9 @@ components: metadata: type: object description: The tag's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminProductTagDeleteResponse: type: object description: The details of the product tag deletion. @@ -19340,6 +19580,9 @@ components: metadata: type: object description: The type's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminProductTypeDeleteResponse: type: object description: The details of the product type deletion. @@ -19538,6 +19781,9 @@ components: metadata: type: object description: The variant's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata inventory_items: type: array description: The variant's inventory items. @@ -19952,6 +20198,9 @@ components: metadata: type: object description: The refund reason's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -20001,6 +20250,9 @@ components: metadata: type: object description: The region's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -20114,6 +20366,9 @@ components: metadata: type: object description: The reservation's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_by: type: string title: created_by @@ -20266,6 +20521,9 @@ components: metadata: type: object description: The return item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminReturnPreviewResponse: type: object description: The details of a return and a preview of the order once the return is applied. @@ -20308,6 +20566,9 @@ components: metadata: type: object description: The return reason's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -20480,6 +20741,9 @@ components: metadata: type: object description: The sales channel's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -20693,6 +20957,9 @@ components: metadata: type: object description: The shipping option's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -21017,6 +21284,9 @@ components: metadata: type: object description: The shipping profile's metadata, holds custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -21271,6 +21541,9 @@ components: metadata: type: object description: The store's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -21333,6 +21606,9 @@ components: metadata: type: object description: The store credit account's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -21530,6 +21806,9 @@ components: metadata: type: object description: The tax rate's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata tax_region_id: type: string title: tax_region_id @@ -21657,6 +21936,9 @@ components: metadata: type: object description: The tax region's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata parent_id: type: string title: parent_id @@ -21777,6 +22059,9 @@ components: metadata: type: object description: The transaction's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -21825,6 +22110,9 @@ components: metadata: type: object description: The transaction group's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminTransactionGroupsResponse: type: object description: The paginated list of transaction groups. @@ -21931,6 +22219,9 @@ components: metadata: type: object description: The customer group's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminUpdateDraftOrder: type: object description: The data to update in the draft order. @@ -21993,6 +22284,9 @@ components: metadata: type: object description: The shipping address's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata billing_address: type: object description: The draft order's billing address. @@ -22045,9 +22339,15 @@ components: metadata: type: object description: The billing address's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata metadata: type: object description: The draft order's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata customer_id: type: string title: customer_id @@ -22082,6 +22382,9 @@ components: metadata: type: object description: The shipping method's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminUpdateDraftOrderItem: type: object description: The updates to make on a draft order's item. @@ -22150,6 +22453,9 @@ components: metadata: type: object description: The geo zone's metadata. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata country_code: type: string title: country_code @@ -22174,6 +22480,9 @@ components: metadata: type: object description: The geo zone's metadata. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata country_code: type: string title: country_code @@ -22207,6 +22516,9 @@ components: metadata: type: object description: The geo zone's metadata. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata city: type: string title: city @@ -22245,6 +22557,9 @@ components: metadata: type: object description: The geo zone's metadata. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata city: type: string title: city @@ -22304,6 +22619,9 @@ components: metadata: type: object description: The gift card's metadata. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminUpdateInventoryItem: type: object description: The properties to update in the inventory item. @@ -22363,6 +22681,9 @@ components: metadata: type: object description: The inventory item's metadata. Can be custom data in key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata x-schemaName: AdminUpdateInventoryItem AdminUpdateInventoryLocationLevel: type: object @@ -22439,6 +22760,9 @@ components: metadata: type: object description: The address's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata billing_address: type: object description: The order's billing address. @@ -22491,9 +22815,15 @@ components: metadata: type: object description: The address's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata metadata: type: object description: The order's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminUpdatePaymentRefundReason: type: object description: The properties to update in the refund reason. @@ -22713,6 +23043,9 @@ components: metadata: type: object description: The product's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata external_id: type: string title: external_id @@ -22748,6 +23081,9 @@ components: metadata: type: object description: The product category's metadata. Can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata rank: type: number title: rank @@ -22780,6 +23116,9 @@ components: metadata: type: object description: The product tag's metadata. Can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata x-schemaName: AdminUpdateProductTag AdminUpdateProductType: type: object @@ -22792,6 +23131,9 @@ components: metadata: type: object description: The product type's metadata. Can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata x-schemaName: AdminUpdateProductType AdminUpdateProductVariant: type: object @@ -22865,6 +23207,9 @@ components: metadata: type: object description: The product variant's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata prices: type: array description: The product variant's prices. @@ -22951,6 +23296,9 @@ components: metadata: type: object description: The region's metadata. Can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata is_tax_inclusive: type: boolean title: is_tax_inclusive @@ -22975,6 +23323,9 @@ components: metadata: type: object description: The reservation's metadata. Can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata x-schemaName: AdminUpdateReservation AdminUpdateReturnReason: type: object @@ -22996,6 +23347,9 @@ components: metadata: type: object description: The return reason's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata required: - value - label @@ -23019,6 +23373,9 @@ components: metadata: type: object description: The sales channel's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminUpdateShippingOption: type: object description: The properties to update in the shipping option. @@ -23246,6 +23603,9 @@ components: metadata: type: object description: The shipping profile's metadata. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata x-schemaName: AdminUpdateShippingProfile AdminUpdateStockLocation: type: object @@ -23307,6 +23667,9 @@ components: metadata: type: object description: The stock location's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminUpdateStore: type: object description: The properties to update in a store. @@ -23353,6 +23716,9 @@ components: metadata: type: object description: The store's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminUpdateTaxRate: type: object description: The properties to update in the tax rate. @@ -23403,6 +23769,9 @@ components: metadata: type: object description: The tax rate's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminUpdateTaxRegion: type: object description: The details to update in a tax region. @@ -23419,6 +23788,9 @@ components: metadata: type: object description: The tax region's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata provider_id: type: string title: provider_id @@ -23443,6 +23815,9 @@ components: metadata: type: object description: The user's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata AdminUpdateVariantInventoryItem: type: object description: The properties to update of the variant's inventory item association. @@ -23604,6 +23979,9 @@ components: metadata: type: object description: The user's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/admin#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -24172,6 +24550,9 @@ components: metadata: type: object description: The cart's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -24410,6 +24791,9 @@ components: metadata: type: object description: The item's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -24526,6 +24910,9 @@ components: metadata: type: object description: The shipping method's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata tax_lines: type: array description: The shipping method's tax lines. @@ -24636,6 +25023,9 @@ components: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -24694,6 +25084,9 @@ components: metadata: type: object description: The collection's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata BaseExchangeItem: type: object description: The item's details. @@ -24730,6 +25123,9 @@ components: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -25013,6 +25409,9 @@ components: metadata: type: object description: The order's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -25185,6 +25584,9 @@ components: metadata: type: object description: The address's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -25258,6 +25660,9 @@ components: metadata: type: object description: The fulfillment's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -25511,6 +25916,9 @@ components: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata original_total: type: number title: original_total @@ -25790,6 +26198,9 @@ components: metadata: type: object description: The shipping method's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata tax_lines: type: array description: The shipping method's tax lines. @@ -26051,6 +26462,9 @@ components: metadata: type: object description: The transaction's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -26191,6 +26605,9 @@ components: metadata: type: object description: The payment collection's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata status: type: string description: The payment collection's status. @@ -26370,6 +26787,9 @@ components: metadata: type: object description: The product's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -26496,6 +26916,9 @@ components: metadata: type: object description: The category's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -26562,6 +26985,9 @@ components: metadata: type: object description: The image's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata rank: type: number title: rank @@ -26600,6 +27026,9 @@ components: metadata: type: object description: The product option's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -26640,6 +27069,9 @@ components: metadata: type: object description: The value's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -26691,6 +27123,9 @@ components: metadata: type: object description: The tag's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata BaseProductType: type: object description: The product type's details. @@ -26727,6 +27162,9 @@ components: metadata: type: object description: The type's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata BaseProductVariant: type: object description: The product variant's details. @@ -26856,6 +27294,9 @@ components: metadata: type: object description: The variant's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata BasePromotionRuleValue: type: object description: The rule value's details. @@ -26948,6 +27389,9 @@ components: metadata: type: object description: The region's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -27266,6 +27710,9 @@ components: metadata: type: object description: The address's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata CustomerGroupInCustomerFilters: type: object description: Filter by customer groups to get their associated customers. @@ -27722,6 +28169,9 @@ components: metadata: type: object description: The inventory level's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata Order: type: object description: The order change's order. @@ -27900,6 +28350,9 @@ components: metadata: type: object description: The order's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata canceled_at: type: string format: date-time @@ -28094,6 +28547,9 @@ components: metadata: type: object description: The address's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -28217,6 +28673,9 @@ components: metadata: type: object description: The order change's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata declined_at: type: string title: declined_at @@ -28408,6 +28867,9 @@ components: metadata: type: object description: The claim's metadata, used to store custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -28494,6 +28956,9 @@ components: metadata: type: object description: The credit line's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -28566,6 +29031,9 @@ components: metadata: type: object description: The exchange's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -28679,6 +29147,9 @@ components: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -28833,6 +29304,9 @@ components: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata original_total: type: number title: original_total @@ -29051,6 +29525,9 @@ components: metadata: type: object description: The return item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata order_id: type: string title: order_id @@ -29126,6 +29603,9 @@ components: metadata: type: object description: The shipping method's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata tax_lines: type: array description: The shipping method's tax lines. @@ -29346,6 +29826,9 @@ components: metadata: type: object description: The transaction's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -29388,6 +29871,9 @@ components: metadata: type: object description: The refund reason's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -29457,6 +29943,9 @@ components: metadata: type: object description: The return's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -29561,6 +30050,9 @@ components: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata StoreAddCartShippingMethods: type: object description: The shipping method's details. @@ -29802,6 +30294,9 @@ components: metadata: type: object description: The cart's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -29984,6 +30479,9 @@ components: metadata: type: object description: The address's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string title: created_at @@ -30274,6 +30772,9 @@ components: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string title: created_at @@ -30454,6 +30955,9 @@ components: metadata: type: object description: The shipping method's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata tax_lines: type: array description: The shipping method's tax lines. @@ -30797,6 +31301,9 @@ components: metadata: type: object description: The collection's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata StoreCollectionResponse: type: object description: The collection's details. @@ -30841,6 +31348,9 @@ components: metadata: type: object description: The cart's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata StoreCreateCustomer: type: object description: The details of the customer to create. @@ -30872,6 +31382,9 @@ components: metadata: type: object description: The customer's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata StoreCreateCustomerAddress: type: object description: The address's details. @@ -31169,6 +31682,9 @@ components: metadata: type: object description: The customer's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -31276,6 +31792,9 @@ components: metadata: type: object description: The address's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -31580,6 +32099,9 @@ components: metadata: type: object description: The order's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -31761,6 +32283,9 @@ components: metadata: type: object description: The address's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -31834,6 +32359,9 @@ components: metadata: type: object description: The fulfillment's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -32200,6 +32728,9 @@ components: metadata: type: object description: The variant's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata variant_id: type: string title: variant_id @@ -32381,6 +32912,9 @@ components: metadata: type: object description: The product's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata product_id: type: string title: product_id @@ -32645,6 +33179,9 @@ components: metadata: type: object description: The detail's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -32668,6 +33205,9 @@ components: metadata: type: object description: The item's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata original_total: type: number title: original_total @@ -32867,6 +33407,9 @@ components: metadata: type: object description: The variant's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -33052,6 +33595,9 @@ components: metadata: type: object description: The product's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -33345,6 +33891,9 @@ components: metadata: type: object description: The detail's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -33375,6 +33924,9 @@ components: metadata: type: object description: The item's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -33729,6 +34281,9 @@ components: metadata: type: object description: The variant's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata variant_id: type: string title: variant_id @@ -33910,6 +34465,9 @@ components: metadata: type: object description: The product's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata product_id: type: string title: product_id @@ -34174,6 +34732,9 @@ components: metadata: type: object description: The detail's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -34197,6 +34758,9 @@ components: metadata: type: object description: The item's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata original_total: type: number title: original_total @@ -34392,6 +34956,9 @@ components: metadata: type: object description: The variant's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -34577,6 +35144,9 @@ components: metadata: type: object description: The product's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -34870,6 +35440,9 @@ components: metadata: type: object description: The detail's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -34900,6 +35473,9 @@ components: metadata: type: object description: The item's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -35146,6 +35722,9 @@ components: metadata: type: object description: The variant's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -35331,6 +35910,9 @@ components: metadata: type: object description: The product's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -35624,6 +36206,9 @@ components: metadata: type: object description: The detail's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -35654,6 +36239,9 @@ components: metadata: type: object description: The item's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -35809,6 +36397,9 @@ components: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata original_total: type: number title: original_total @@ -35934,6 +36525,9 @@ components: metadata: type: object description: The shipping method's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata tax_lines: type: array description: The shipping method's tax lines. @@ -36011,6 +36605,9 @@ components: metadata: type: object description: The shipping method's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata tax_lines: type: array description: The shipping method's tax lines. @@ -36542,6 +37139,9 @@ components: metadata: type: object description: The shipping method's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata original_total: type: number title: original_total @@ -36660,6 +37260,9 @@ components: metadata: type: object description: The shipping method's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata tax_lines: type: array description: The shipping method's tax lines. @@ -37187,6 +37790,9 @@ components: metadata: type: object description: The shipping method's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata original_total: type: number title: original_total @@ -37543,6 +38149,9 @@ components: metadata: type: object description: The shipping method's metadata. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata original_total: type: number title: original_total @@ -37639,6 +38248,9 @@ components: metadata: type: object description: The payment collection's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata status: type: string description: The payment collection's status. @@ -37881,6 +38493,9 @@ components: metadata: type: object description: The product's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -38024,6 +38639,9 @@ components: metadata: type: object description: The category's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -38120,6 +38738,9 @@ components: metadata: type: object description: The image's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata rank: type: number title: rank @@ -38151,6 +38772,9 @@ components: metadata: type: object description: The option's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -38194,6 +38818,9 @@ components: metadata: type: object description: The value's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -38249,6 +38876,9 @@ components: metadata: type: object description: The tag's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata required: - id - value @@ -38312,6 +38942,9 @@ components: metadata: type: object description: The product type's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -38395,6 +39028,9 @@ components: metadata: type: object description: The variant's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata id: type: string title: id @@ -38546,6 +39182,9 @@ components: metadata: type: object description: The region's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -38725,6 +39364,9 @@ components: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata StoreReturnReason: type: object description: The return reason's details. @@ -38755,6 +39397,9 @@ components: metadata: type: object description: The return reason's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -38852,6 +39497,9 @@ components: metadata: type: object description: The shipping option's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata StoreShippingOptionListResponse: type: object description: The shipping option's details. @@ -38974,6 +39622,9 @@ components: metadata: type: object description: The store credit account's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata created_at: type: string format: date-time @@ -39062,6 +39713,9 @@ components: metadata: type: object description: The transaction group's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata x-schemaName: StoreTransactionGroup StoreUpdateCartLineItem: type: object @@ -39077,6 +39731,9 @@ components: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata StoreUpdateCustomer: type: object description: The details to update in the customer. @@ -39101,6 +39758,9 @@ components: metadata: type: object description: The customer's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata StoreUpdateCustomerAddress: type: object description: The properties to update in the address. @@ -39228,6 +39888,9 @@ components: metadata: type: object description: The address's metadata, can hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata UpdateCartData: type: object description: The details to update in a cart. @@ -39274,6 +39937,9 @@ components: metadata: type: object description: The cart's metadata, ca hold custom key-value pairs. + externalDocs: + url: https://docs.medusajs.com/api/store#manage-metadata + description: Learn how to manage metadata WorkflowExecutionContext: type: object description: The workflow execution's context. diff --git a/www/apps/book/app/learn/fundamentals/data-models/json-properties/page.mdx b/www/apps/book/app/learn/fundamentals/data-models/json-properties/page.mdx index 0eff132453..652b7b4e5e 100644 --- a/www/apps/book/app/learn/fundamentals/data-models/json-properties/page.mdx +++ b/www/apps/book/app/learn/fundamentals/data-models/json-properties/page.mdx @@ -72,7 +72,7 @@ For example, if you want to re-use brands across different products, it's better ### How Medusa Updates JSON Properties -Consider a Brand Module with a `Brand` data model as shown [in the previous section](#what-are-json-properties). The [module's service](../../modules/page.mdx#2-create-service) will extend `MedusaService`, which generates methods like [updateBrands](!resources!/service-factory-reference/methods/update) to update a brand. +Consider a Brand Module with a `Brand` data model as shown [in the previous section](#what-is-a-json-property). The [module's service](../../modules/page.mdx#2-create-service) will extend `MedusaService`, which generates methods like [updateBrands](!resources!/service-factory-reference/methods/update) to update a brand. When you pass a JSON property in the `updateBrands` method, Medusa will merge the provided JSON object with the existing one in the database. So, only the properties you pass will be updated, and the rest will remain unchanged. @@ -235,3 +235,9 @@ The brand record will now have the `metadata` property updated to remove the `is } } ``` + +### Manage JSON Properties in API Routes + +The instructions above also apply when managing JSON properties in API routes, since they typically use a service's `update` method under the hood. + +Refer to the [API reference](!api!/store#manage-metadata) to learn more about managing JSON properties, such as `metadata`, in API routes. diff --git a/www/apps/book/generated/edit-dates.mjs b/www/apps/book/generated/edit-dates.mjs index 63edcd9062..df6ffc5e0e 100644 --- a/www/apps/book/generated/edit-dates.mjs +++ b/www/apps/book/generated/edit-dates.mjs @@ -127,5 +127,5 @@ export const generatedEditDates = { "app/learn/fundamentals/generated-types/page.mdx": "2025-07-25T13:17:35.319Z", "app/learn/introduction/from-v1-to-v2/page.mdx": "2025-07-30T08:13:48.592Z", "app/learn/debugging-and-testing/debug-workflows/page.mdx": "2025-07-30T13:45:14.117Z", - "app/learn/fundamentals/data-models/json-properties/page.mdx": "2025-07-31T08:38:55.014Z" + "app/learn/fundamentals/data-models/json-properties/page.mdx": "2025-07-31T10:47:27.882Z" } \ No newline at end of file diff --git a/www/apps/book/public/llms-full.txt b/www/apps/book/public/llms-full.txt index 5922c8aac4..13ba237df7 100644 --- a/www/apps/book/public/llms-full.txt +++ b/www/apps/book/public/llms-full.txt @@ -9674,7 +9674,7 @@ For example, if you want to re-use brands across different products, it's better ### How Medusa Updates JSON Properties -Consider a Brand Module with a `Brand` data model as shown [in the previous section](#what-are-json-properties). The [module's service](https://docs.medusajs.com/learn/fundamentals/modules#2-create-service/index.html.md) will extend `MedusaService`, which generates methods like [updateBrands](https://docs.medusajs.com/resources/service-factory-reference/methods/update/index.html.md) to update a brand. +Consider a Brand Module with a `Brand` data model as shown [in the previous section](#what-is-a-json-property). The [module's service](https://docs.medusajs.com/learn/fundamentals/modules#2-create-service/index.html.md) will extend `MedusaService`, which generates methods like [updateBrands](https://docs.medusajs.com/resources/service-factory-reference/methods/update/index.html.md) to update a brand. When you pass a JSON property in the `updateBrands` method, Medusa will merge the provided JSON object with the existing one in the database. So, only the properties you pass will be updated, and the rest will remain unchanged. @@ -9834,6 +9834,12 @@ The brand record will now have the `metadata` property updated to remove the `is } ``` +### Manage JSON Properties in API Routes + +The instructions above also apply when managing JSON properties in API routes, since they typically use a service's `update` method under the hood. + +Refer to the [API reference](https://docs.medusajs.com/api/store#manage-metadata) to learn more about managing JSON properties, such as `metadata`, in API routes. + # Manage Relationships diff --git a/www/apps/book/public/llms.txt b/www/apps/book/public/llms.txt index c7a2ca0f20..65d540aef7 100644 --- a/www/apps/book/public/llms.txt +++ b/www/apps/book/public/llms.txt @@ -1,6 +1,6 @@ # Medusa -> Medusa is a digital commerce platform with a built-in framework for customization. When you install Medusa, you get a fully fledged commerce platform with all the features you need to get off the ground. However, unlike other platforms, Medusa is built with customization in mind. You don't need to build hacky workarounds that are difficult to maintain and scale. Your efforts go into building features that bring your business's vision to life. +> Medusa is a digital commerce platform with a built-in Framework for customization. When you install Medusa, you get a fully fledged commerce platform with all the features you need to get off the ground. However, unlike other platforms, Medusa is built with customization in mind. You don't need to build hacky workarounds that are difficult to maintain and scale. Your efforts go into building features that bring your business's vision to life. Medusa ships with three main tools: diff --git a/www/utils/generated/oas-output/schemas/AdminAddDraftOrderItems.ts b/www/utils/generated/oas-output/schemas/AdminAddDraftOrderItems.ts index 1bde9d61e6..1ed5c1ffc8 100644 --- a/www/utils/generated/oas-output/schemas/AdminAddDraftOrderItems.ts +++ b/www/utils/generated/oas-output/schemas/AdminAddDraftOrderItems.ts @@ -44,6 +44,9 @@ * metadata: * type: object * description: The item's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/AdminAddDraftOrderShippingMethod.ts b/www/utils/generated/oas-output/schemas/AdminAddDraftOrderShippingMethod.ts index 82393aa95b..d0604015b8 100644 --- a/www/utils/generated/oas-output/schemas/AdminAddDraftOrderShippingMethod.ts +++ b/www/utils/generated/oas-output/schemas/AdminAddDraftOrderShippingMethod.ts @@ -25,6 +25,9 @@ * metadata: * type: object * description: The shipping method's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/AdminBatchUpdateProduct.ts b/www/utils/generated/oas-output/schemas/AdminBatchUpdateProduct.ts index 9e150d2b32..31bccbb37b 100644 --- a/www/utils/generated/oas-output/schemas/AdminBatchUpdateProduct.ts +++ b/www/utils/generated/oas-output/schemas/AdminBatchUpdateProduct.ts @@ -147,6 +147,9 @@ * metadata: * type: object * description: The product's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * external_id: * type: string * title: external_id diff --git a/www/utils/generated/oas-output/schemas/AdminBatchUpdateProductVariant.ts b/www/utils/generated/oas-output/schemas/AdminBatchUpdateProductVariant.ts index 6bc0755222..f9defaf53f 100644 --- a/www/utils/generated/oas-output/schemas/AdminBatchUpdateProductVariant.ts +++ b/www/utils/generated/oas-output/schemas/AdminBatchUpdateProductVariant.ts @@ -71,6 +71,9 @@ * metadata: * type: object * description: The product variant's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * prices: * type: array * description: The product variant's prices. diff --git a/www/utils/generated/oas-output/schemas/AdminClaim.ts b/www/utils/generated/oas-output/schemas/AdminClaim.ts index dacff62bc6..e5d39bef74 100644 --- a/www/utils/generated/oas-output/schemas/AdminClaim.ts +++ b/www/utils/generated/oas-output/schemas/AdminClaim.ts @@ -69,6 +69,9 @@ * metadata: * type: object * description: The claim's metadata, used to store custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/AdminCollection.ts b/www/utils/generated/oas-output/schemas/AdminCollection.ts index 5f3f4294f0..b5a2569ce5 100644 --- a/www/utils/generated/oas-output/schemas/AdminCollection.ts +++ b/www/utils/generated/oas-output/schemas/AdminCollection.ts @@ -47,6 +47,9 @@ * metadata: * type: object * description: The collection's metadata, used to store custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/AdminCreateCustomerGroup.ts b/www/utils/generated/oas-output/schemas/AdminCreateCustomerGroup.ts index db94006a07..aacb0f48b3 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreateCustomerGroup.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreateCustomerGroup.ts @@ -13,6 +13,9 @@ * metadata: * type: object * description: The customer group's metadata, used to store custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/AdminCreateFulfillment.ts b/www/utils/generated/oas-output/schemas/AdminCreateFulfillment.ts index abe3b756f6..36643400db 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreateFulfillment.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreateFulfillment.ts @@ -72,6 +72,9 @@ * metadata: * type: object * description: The delivery address's metadata, used to store custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * items: * type: array * description: The items to fulfill. @@ -168,6 +171,9 @@ * metadata: * type: object * description: The fulfillment's metadata, used to store custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/AdminCreateFulfillmentSetServiceZones.ts b/www/utils/generated/oas-output/schemas/AdminCreateFulfillmentSetServiceZones.ts index 8427281e74..afc094619e 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreateFulfillmentSetServiceZones.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreateFulfillmentSetServiceZones.ts @@ -24,6 +24,9 @@ * metadata: * type: object * description: The geo zone's metadata. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * country_code: * type: string * title: country_code @@ -44,6 +47,9 @@ * metadata: * type: object * description: The geo zone's metadata. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * country_code: * type: string * title: country_code @@ -73,6 +79,9 @@ * metadata: * type: object * description: The geo zone's metadata. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * country_code: * type: string * title: country_code @@ -107,6 +116,9 @@ * metadata: * type: object * description: The geo zone's metadata. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * country_code: * type: string * title: country_code diff --git a/www/utils/generated/oas-output/schemas/AdminCreateGiftCardParams.ts b/www/utils/generated/oas-output/schemas/AdminCreateGiftCardParams.ts index 971704a155..d78ecd1137 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreateGiftCardParams.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreateGiftCardParams.ts @@ -51,6 +51,9 @@ * metadata: * type: object * description: The gift card's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/AdminCreateInventoryItem.ts b/www/utils/generated/oas-output/schemas/AdminCreateInventoryItem.ts index 89c844f2f5..f2846e8064 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreateInventoryItem.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreateInventoryItem.ts @@ -59,6 +59,9 @@ * metadata: * type: object * description: The inventory item's metadata, used to store custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/AdminCreateOrderCreditLines.ts b/www/utils/generated/oas-output/schemas/AdminCreateOrderCreditLines.ts index 63fbd3427a..0c5b2d6e77 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreateOrderCreditLines.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreateOrderCreditLines.ts @@ -26,6 +26,9 @@ * metadata: * type: object * description: The credit line's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/AdminCreateProduct.ts b/www/utils/generated/oas-output/schemas/AdminCreateProduct.ts index 8256c39783..dabe396f53 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreateProduct.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreateProduct.ts @@ -148,6 +148,9 @@ * metadata: * type: object * description: The product's metadata, used to store custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * external_id: * type: string * title: external_id diff --git a/www/utils/generated/oas-output/schemas/AdminCreateProductCategory.ts b/www/utils/generated/oas-output/schemas/AdminCreateProductCategory.ts index 3e55613866..26749ad407 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreateProductCategory.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreateProductCategory.ts @@ -37,6 +37,9 @@ * metadata: * type: object * description: The product category's metadata, used to store custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/AdminCreateProductTag.ts b/www/utils/generated/oas-output/schemas/AdminCreateProductTag.ts index abd515281f..43d8a350d7 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreateProductTag.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreateProductTag.ts @@ -13,6 +13,9 @@ * metadata: * type: object * description: The product tag's metadata, used to store custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/AdminCreateProductType.ts b/www/utils/generated/oas-output/schemas/AdminCreateProductType.ts index fe4f51f326..784b2eafdc 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreateProductType.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreateProductType.ts @@ -9,6 +9,9 @@ * metadata: * type: object * description: The product's metadata, used to store custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * value: * type: string * title: value diff --git a/www/utils/generated/oas-output/schemas/AdminCreateProductVariant.ts b/www/utils/generated/oas-output/schemas/AdminCreateProductVariant.ts index 1142c05edc..991291e976 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreateProductVariant.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreateProductVariant.ts @@ -74,6 +74,9 @@ * metadata: * type: object * description: The variant's metadata, used to store custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * prices: * type: array * description: The variant's prices. diff --git a/www/utils/generated/oas-output/schemas/AdminCreateRegion.ts b/www/utils/generated/oas-output/schemas/AdminCreateRegion.ts index acafffd191..481bc2265e 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreateRegion.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreateRegion.ts @@ -43,6 +43,9 @@ * metadata: * type: object * description: The region's metadata, used to store custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/AdminCreateReservation.ts b/www/utils/generated/oas-output/schemas/AdminCreateReservation.ts index 42ec53f578..d1fbf1c9dc 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreateReservation.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreateReservation.ts @@ -31,6 +31,9 @@ * metadata: * type: object * description: The reservation's metadata, used to store custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/AdminCreateReturnReason.ts b/www/utils/generated/oas-output/schemas/AdminCreateReturnReason.ts index ce585e7d24..4c3f813092 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreateReturnReason.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreateReturnReason.ts @@ -26,6 +26,9 @@ * metadata: * type: object * description: The return reason's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/AdminCreateSalesChannel.ts b/www/utils/generated/oas-output/schemas/AdminCreateSalesChannel.ts index 79756cc1bb..5809e07461 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreateSalesChannel.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreateSalesChannel.ts @@ -21,6 +21,9 @@ * metadata: * type: object * description: The sales channel's metadata, used to store custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/AdminCreateShippingProfile.ts b/www/utils/generated/oas-output/schemas/AdminCreateShippingProfile.ts index 1a5a0f41c5..8d2f3c3a25 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreateShippingProfile.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreateShippingProfile.ts @@ -18,6 +18,9 @@ * metadata: * type: object * description: The shipping profile's metadata, used to store custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/AdminCreateStockLocation.ts b/www/utils/generated/oas-output/schemas/AdminCreateStockLocation.ts index 2fea1e3dd3..4beabff743 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreateStockLocation.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreateStockLocation.ts @@ -19,6 +19,9 @@ * metadata: * type: object * description: The stock location's metadata, used to store custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/AdminCreateStoreCreditAccount.ts b/www/utils/generated/oas-output/schemas/AdminCreateStoreCreditAccount.ts index 5a13545e6c..353f1bf1d1 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreateStoreCreditAccount.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreateStoreCreditAccount.ts @@ -19,6 +19,9 @@ * metadata: * type: object * description: The store credit account's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/AdminCreateTaxRate.ts b/www/utils/generated/oas-output/schemas/AdminCreateTaxRate.ts index 1b472c86b6..efbfaeb897 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreateTaxRate.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreateTaxRate.ts @@ -44,6 +44,9 @@ * metadata: * type: object * description: The tax rate's metadata, used to store custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/AdminCreateTaxRegion.ts b/www/utils/generated/oas-output/schemas/AdminCreateTaxRegion.ts index e6cf9aa277..61b0cb4b78 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreateTaxRegion.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreateTaxRegion.ts @@ -52,9 +52,15 @@ * metadata: * type: object * description: The default tax rate's metadata, used to store custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * metadata: * type: object * description: The tax region's metadata, used to store custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * provider_id: * type: string * title: provider_id diff --git a/www/utils/generated/oas-output/schemas/AdminCustomer.ts b/www/utils/generated/oas-output/schemas/AdminCustomer.ts index 8ec49e0b8a..43c25bb383 100644 --- a/www/utils/generated/oas-output/schemas/AdminCustomer.ts +++ b/www/utils/generated/oas-output/schemas/AdminCustomer.ts @@ -64,6 +64,9 @@ * metadata: * type: object * description: The customer's metadata, used to store custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * created_by: * type: string * title: created_by diff --git a/www/utils/generated/oas-output/schemas/AdminCustomerAddress.ts b/www/utils/generated/oas-output/schemas/AdminCustomerAddress.ts index 4d6639b1a2..b0f88609dc 100644 --- a/www/utils/generated/oas-output/schemas/AdminCustomerAddress.ts +++ b/www/utils/generated/oas-output/schemas/AdminCustomerAddress.ts @@ -91,6 +91,9 @@ * metadata: * type: object * description: The address's metadata, used to store custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/AdminCustomerGroup.ts b/www/utils/generated/oas-output/schemas/AdminCustomerGroup.ts index c4b3d93828..47737401b0 100644 --- a/www/utils/generated/oas-output/schemas/AdminCustomerGroup.ts +++ b/www/utils/generated/oas-output/schemas/AdminCustomerGroup.ts @@ -27,6 +27,9 @@ * metadata: * type: object * description: The customer group's metadata, used to store custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/AdminDraftOrder.ts b/www/utils/generated/oas-output/schemas/AdminDraftOrder.ts index d4d28b9a8f..eb7d3d5aff 100644 --- a/www/utils/generated/oas-output/schemas/AdminDraftOrder.ts +++ b/www/utils/generated/oas-output/schemas/AdminDraftOrder.ts @@ -146,6 +146,9 @@ * metadata: * type: object * description: The draft order's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/AdminDraftOrderPreview.ts b/www/utils/generated/oas-output/schemas/AdminDraftOrderPreview.ts index 623a0f0f5c..949f8b5fe4 100644 --- a/www/utils/generated/oas-output/schemas/AdminDraftOrderPreview.ts +++ b/www/utils/generated/oas-output/schemas/AdminDraftOrderPreview.ts @@ -214,6 +214,9 @@ * metadata: * type: object * description: The item's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * original_total: * type: number * title: original_total @@ -340,6 +343,9 @@ * metadata: * type: object * description: The shipping method's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * tax_lines: * type: array * description: The shipping method's tax lines. @@ -517,6 +523,9 @@ * metadata: * type: object * description: The order's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/AdminExchange.ts b/www/utils/generated/oas-output/schemas/AdminExchange.ts index 164c2ecb24..7dc19c99ab 100644 --- a/www/utils/generated/oas-output/schemas/AdminExchange.ts +++ b/www/utils/generated/oas-output/schemas/AdminExchange.ts @@ -64,6 +64,9 @@ * metadata: * type: object * description: The exchange's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/AdminFulfillment.ts b/www/utils/generated/oas-output/schemas/AdminFulfillment.ts index f8987a2341..733ccccb9c 100644 --- a/www/utils/generated/oas-output/schemas/AdminFulfillment.ts +++ b/www/utils/generated/oas-output/schemas/AdminFulfillment.ts @@ -76,6 +76,9 @@ * metadata: * type: object * description: The fulfillment's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/AdminFulfillmentAddress.ts b/www/utils/generated/oas-output/schemas/AdminFulfillmentAddress.ts index 383604fbdc..f2d189dafb 100644 --- a/www/utils/generated/oas-output/schemas/AdminFulfillmentAddress.ts +++ b/www/utils/generated/oas-output/schemas/AdminFulfillmentAddress.ts @@ -76,6 +76,9 @@ * metadata: * type: object * description: The address's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/AdminInventoryLevel.ts b/www/utils/generated/oas-output/schemas/AdminInventoryLevel.ts index 284322a404..84713298ee 100644 --- a/www/utils/generated/oas-output/schemas/AdminInventoryLevel.ts +++ b/www/utils/generated/oas-output/schemas/AdminInventoryLevel.ts @@ -58,6 +58,9 @@ * metadata: * type: object * description: The location level's metadata. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * inventory_item: * $ref: "#/components/schemas/AdminInventoryItem" * available_quantity: diff --git a/www/utils/generated/oas-output/schemas/AdminInvite.ts b/www/utils/generated/oas-output/schemas/AdminInvite.ts index 125892f428..d271fad9d7 100644 --- a/www/utils/generated/oas-output/schemas/AdminInvite.ts +++ b/www/utils/generated/oas-output/schemas/AdminInvite.ts @@ -37,6 +37,9 @@ * metadata: * type: object * description: The invite's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/AdminOrder.ts b/www/utils/generated/oas-output/schemas/AdminOrder.ts index 0f3a1462c1..ba49aaf0fa 100644 --- a/www/utils/generated/oas-output/schemas/AdminOrder.ts +++ b/www/utils/generated/oas-output/schemas/AdminOrder.ts @@ -141,6 +141,9 @@ * metadata: * type: object * description: The order's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/AdminOrderAddress.ts b/www/utils/generated/oas-output/schemas/AdminOrderAddress.ts index d14fcc9202..ea339afc95 100644 --- a/www/utils/generated/oas-output/schemas/AdminOrderAddress.ts +++ b/www/utils/generated/oas-output/schemas/AdminOrderAddress.ts @@ -67,6 +67,9 @@ * metadata: * type: object * description: The address's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/AdminOrderChange.ts b/www/utils/generated/oas-output/schemas/AdminOrderChange.ts index 1610a644cc..1c65cd3a17 100644 --- a/www/utils/generated/oas-output/schemas/AdminOrderChange.ts +++ b/www/utils/generated/oas-output/schemas/AdminOrderChange.ts @@ -112,6 +112,9 @@ * metadata: * type: object * description: The order change's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * declined_at: * type: string * title: declined_at diff --git a/www/utils/generated/oas-output/schemas/AdminOrderFulfillment.ts b/www/utils/generated/oas-output/schemas/AdminOrderFulfillment.ts index 15b94ff1f5..890802b185 100644 --- a/www/utils/generated/oas-output/schemas/AdminOrderFulfillment.ts +++ b/www/utils/generated/oas-output/schemas/AdminOrderFulfillment.ts @@ -62,6 +62,9 @@ * metadata: * type: object * description: The fulfillment's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/AdminOrderLineItem.ts b/www/utils/generated/oas-output/schemas/AdminOrderLineItem.ts index 2a59ebb67e..0932be04a3 100644 --- a/www/utils/generated/oas-output/schemas/AdminOrderLineItem.ts +++ b/www/utils/generated/oas-output/schemas/AdminOrderLineItem.ts @@ -162,6 +162,9 @@ * metadata: * type: object * description: The item's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * original_total: * type: number * title: original_total diff --git a/www/utils/generated/oas-output/schemas/AdminOrderPreview.ts b/www/utils/generated/oas-output/schemas/AdminOrderPreview.ts index 9d9dbeda34..bcb8f1ea3a 100644 --- a/www/utils/generated/oas-output/schemas/AdminOrderPreview.ts +++ b/www/utils/generated/oas-output/schemas/AdminOrderPreview.ts @@ -214,6 +214,9 @@ * metadata: * type: object * description: The item's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * original_total: * type: number * title: original_total @@ -340,6 +343,9 @@ * metadata: * type: object * description: The shipping method's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * tax_lines: * type: array * description: The shipping method's tax lines. @@ -517,6 +523,9 @@ * metadata: * type: object * description: The order's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/AdminOrderShippingMethod.ts b/www/utils/generated/oas-output/schemas/AdminOrderShippingMethod.ts index df4f87032e..8da283358c 100644 --- a/www/utils/generated/oas-output/schemas/AdminOrderShippingMethod.ts +++ b/www/utils/generated/oas-output/schemas/AdminOrderShippingMethod.ts @@ -59,6 +59,9 @@ * metadata: * type: object * description: The shipping method's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * tax_lines: * type: array * description: The shipping method's tax lines. diff --git a/www/utils/generated/oas-output/schemas/AdminPaymentCollection.ts b/www/utils/generated/oas-output/schemas/AdminPaymentCollection.ts index 8c791ab7f7..2d2d435573 100644 --- a/www/utils/generated/oas-output/schemas/AdminPaymentCollection.ts +++ b/www/utils/generated/oas-output/schemas/AdminPaymentCollection.ts @@ -52,6 +52,9 @@ * metadata: * type: object * description: The payment collection's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * status: * type: string * description: The payment collection's status. diff --git a/www/utils/generated/oas-output/schemas/AdminPostClaimsAddItemsReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostClaimsAddItemsReqSchema.ts index 7829010d5d..2f8aedc88b 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostClaimsAddItemsReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminPostClaimsAddItemsReqSchema.ts @@ -33,6 +33,9 @@ * metadata: * type: object * description: The item's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/AdminPostClaimsShippingActionReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostClaimsShippingActionReqSchema.ts index 2813f3ee7d..7194a0f494 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostClaimsShippingActionReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminPostClaimsShippingActionReqSchema.ts @@ -15,6 +15,9 @@ * metadata: * type: object * description: The claim's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/AdminPostClaimsShippingReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostClaimsShippingReqSchema.ts index 8a9de82feb..d5cb4f18cf 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostClaimsShippingReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminPostClaimsShippingReqSchema.ts @@ -25,6 +25,9 @@ * metadata: * type: object * description: The claim's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/AdminPostExchangesAddItemsReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostExchangesAddItemsReqSchema.ts index 84e6883ffc..53a85f623a 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostExchangesAddItemsReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminPostExchangesAddItemsReqSchema.ts @@ -37,6 +37,9 @@ * metadata: * type: object * description: The item's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/AdminPostExchangesRequestItemsReturnActionReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostExchangesRequestItemsReturnActionReqSchema.ts index 159cc68be7..97f76ea626 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostExchangesRequestItemsReturnActionReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminPostExchangesRequestItemsReturnActionReqSchema.ts @@ -19,6 +19,9 @@ * metadata: * type: object * description: The exchange's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/AdminPostExchangesReturnRequestItemsReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostExchangesReturnRequestItemsReqSchema.ts index 9c0d32f42a..02497b4dcb 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostExchangesReturnRequestItemsReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminPostExchangesReturnRequestItemsReqSchema.ts @@ -37,6 +37,9 @@ * metadata: * type: object * description: The item's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/AdminPostExchangesShippingActionReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostExchangesShippingActionReqSchema.ts index f0fbbf91fc..17a125d64d 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostExchangesShippingActionReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminPostExchangesShippingActionReqSchema.ts @@ -15,6 +15,9 @@ * metadata: * type: object * description: The exchange's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/AdminPostExchangesShippingReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostExchangesShippingReqSchema.ts index 7c9929e5e3..1841099bee 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostExchangesShippingReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminPostExchangesShippingReqSchema.ts @@ -25,6 +25,9 @@ * metadata: * type: object * description: The exchange's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/AdminPostOrderClaimsReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostOrderClaimsReqSchema.ts index dc9e82c96c..35b43c9287 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostOrderClaimsReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminPostOrderClaimsReqSchema.ts @@ -32,6 +32,9 @@ * metadata: * type: object * description: The claim's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/AdminPostOrderEditsAddItemsReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostOrderEditsAddItemsReqSchema.ts index f732e6bed3..6b3ace9060 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostOrderEditsAddItemsReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminPostOrderEditsAddItemsReqSchema.ts @@ -37,6 +37,9 @@ * metadata: * type: object * description: The item's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * compare_at_unit_price: * type: number * title: compare_at_unit_price diff --git a/www/utils/generated/oas-output/schemas/AdminPostOrderEditsReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostOrderEditsReqSchema.ts index 30bfb622a9..0331e9d4aa 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostOrderEditsReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminPostOrderEditsReqSchema.ts @@ -21,6 +21,9 @@ * metadata: * type: object * description: The order edit's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/AdminPostOrderEditsShippingActionReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostOrderEditsShippingActionReqSchema.ts index 6e5bc7d493..85b9bdc44a 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostOrderEditsShippingActionReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminPostOrderEditsShippingActionReqSchema.ts @@ -15,6 +15,9 @@ * metadata: * type: object * description: The order edit's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/AdminPostOrderEditsShippingReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostOrderEditsShippingReqSchema.ts index d3544889ae..7774fa700b 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostOrderEditsShippingReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminPostOrderEditsShippingReqSchema.ts @@ -25,6 +25,9 @@ * metadata: * type: object * description: The shipping method's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/AdminPostOrderExchangesReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostOrderExchangesReqSchema.ts index 7c0cd188aa..4b1b7400e7 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostOrderExchangesReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminPostOrderExchangesReqSchema.ts @@ -21,6 +21,9 @@ * metadata: * type: object * description: The exchange's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/AdminPostReceiveReturnsReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostReceiveReturnsReqSchema.ts index 5b5213820a..1197a4cc07 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostReceiveReturnsReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminPostReceiveReturnsReqSchema.ts @@ -15,6 +15,9 @@ * metadata: * type: object * description: The return's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/AdminPostReturnsReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostReturnsReqSchema.ts index 0b9090f846..e5b3c42bbf 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostReturnsReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminPostReturnsReqSchema.ts @@ -29,6 +29,9 @@ * metadata: * type: object * description: The return's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/AdminPostReturnsRequestItemsActionReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostReturnsRequestItemsActionReqSchema.ts index 1415f4706a..1baf789801 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostReturnsRequestItemsActionReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminPostReturnsRequestItemsActionReqSchema.ts @@ -19,6 +19,9 @@ * metadata: * type: object * description: The claim's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/AdminPostReturnsRequestItemsReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostReturnsRequestItemsReqSchema.ts index fbc5e2739d..d4d9fc6cf3 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostReturnsRequestItemsReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminPostReturnsRequestItemsReqSchema.ts @@ -37,6 +37,9 @@ * metadata: * type: object * description: The item's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/AdminPostReturnsReturnReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostReturnsReturnReqSchema.ts index ef50b681d7..4705fbcbf2 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostReturnsReturnReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminPostReturnsReturnReqSchema.ts @@ -15,6 +15,9 @@ * metadata: * type: object * description: The return's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/AdminPostReturnsShippingActionReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostReturnsShippingActionReqSchema.ts index 68143ecf2d..e4a079c5b8 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostReturnsShippingActionReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminPostReturnsShippingActionReqSchema.ts @@ -15,6 +15,9 @@ * metadata: * type: object * description: The return's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/AdminPostReturnsShippingReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostReturnsShippingReqSchema.ts index 2f791a57e1..586189f4f8 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostReturnsShippingReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminPostReturnsShippingReqSchema.ts @@ -25,6 +25,9 @@ * metadata: * type: object * description: The exchange's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/AdminProduct.ts b/www/utils/generated/oas-output/schemas/AdminProduct.ts index c1d796b34b..87e7913bed 100644 --- a/www/utils/generated/oas-output/schemas/AdminProduct.ts +++ b/www/utils/generated/oas-output/schemas/AdminProduct.ts @@ -88,6 +88,9 @@ * metadata: * type: object * description: The product's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/AdminProductCategory.ts b/www/utils/generated/oas-output/schemas/AdminProductCategory.ts index f3e25d5a12..de93b91990 100644 --- a/www/utils/generated/oas-output/schemas/AdminProductCategory.ts +++ b/www/utils/generated/oas-output/schemas/AdminProductCategory.ts @@ -45,6 +45,9 @@ * metadata: * type: object * description: The category's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/AdminProductImage.ts b/www/utils/generated/oas-output/schemas/AdminProductImage.ts index 74636a4e3b..f6509f9df3 100644 --- a/www/utils/generated/oas-output/schemas/AdminProductImage.ts +++ b/www/utils/generated/oas-output/schemas/AdminProductImage.ts @@ -30,6 +30,9 @@ * metadata: * type: object * description: The image's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * rank: * type: number * title: rank diff --git a/www/utils/generated/oas-output/schemas/AdminProductOption.ts b/www/utils/generated/oas-output/schemas/AdminProductOption.ts index 33a6a6dee9..7907677a65 100644 --- a/www/utils/generated/oas-output/schemas/AdminProductOption.ts +++ b/www/utils/generated/oas-output/schemas/AdminProductOption.ts @@ -29,6 +29,9 @@ * metadata: * type: object * description: The product option's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/AdminProductOptionValue.ts b/www/utils/generated/oas-output/schemas/AdminProductOptionValue.ts index 1f7a699b7c..ba13d472bd 100644 --- a/www/utils/generated/oas-output/schemas/AdminProductOptionValue.ts +++ b/www/utils/generated/oas-output/schemas/AdminProductOptionValue.ts @@ -24,6 +24,9 @@ * metadata: * type: object * description: The value's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/AdminProductTag.ts b/www/utils/generated/oas-output/schemas/AdminProductTag.ts index 4d4733bb23..33ed3bf2d3 100644 --- a/www/utils/generated/oas-output/schemas/AdminProductTag.ts +++ b/www/utils/generated/oas-output/schemas/AdminProductTag.ts @@ -35,6 +35,9 @@ * metadata: * type: object * description: The tag's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/AdminProductType.ts b/www/utils/generated/oas-output/schemas/AdminProductType.ts index 6dea7a1f21..e72e7bd9e2 100644 --- a/www/utils/generated/oas-output/schemas/AdminProductType.ts +++ b/www/utils/generated/oas-output/schemas/AdminProductType.ts @@ -35,6 +35,9 @@ * metadata: * type: object * description: The type's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/AdminProductVariant.ts b/www/utils/generated/oas-output/schemas/AdminProductVariant.ts index 0f958c8aa7..c994a59046 100644 --- a/www/utils/generated/oas-output/schemas/AdminProductVariant.ts +++ b/www/utils/generated/oas-output/schemas/AdminProductVariant.ts @@ -134,6 +134,9 @@ * metadata: * type: object * description: The variant's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * inventory_items: * type: array * description: The variant's inventory items. diff --git a/www/utils/generated/oas-output/schemas/AdminRefundReason.ts b/www/utils/generated/oas-output/schemas/AdminRefundReason.ts index fd7c8f4d15..e8d5b36f42 100644 --- a/www/utils/generated/oas-output/schemas/AdminRefundReason.ts +++ b/www/utils/generated/oas-output/schemas/AdminRefundReason.ts @@ -25,6 +25,9 @@ * metadata: * type: object * description: The refund reason's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/AdminRegion.ts b/www/utils/generated/oas-output/schemas/AdminRegion.ts index d009c0536c..9e2f86362c 100644 --- a/www/utils/generated/oas-output/schemas/AdminRegion.ts +++ b/www/utils/generated/oas-output/schemas/AdminRegion.ts @@ -38,6 +38,9 @@ * metadata: * type: object * description: The region's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/AdminReservation.ts b/www/utils/generated/oas-output/schemas/AdminReservation.ts index 99da085fc2..322f586d02 100644 --- a/www/utils/generated/oas-output/schemas/AdminReservation.ts +++ b/www/utils/generated/oas-output/schemas/AdminReservation.ts @@ -45,6 +45,9 @@ * metadata: * type: object * description: The reservation's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * created_by: * type: string * title: created_by diff --git a/www/utils/generated/oas-output/schemas/AdminReturnItem.ts b/www/utils/generated/oas-output/schemas/AdminReturnItem.ts index 077939a72e..10cd1899b3 100644 --- a/www/utils/generated/oas-output/schemas/AdminReturnItem.ts +++ b/www/utils/generated/oas-output/schemas/AdminReturnItem.ts @@ -46,6 +46,9 @@ * metadata: * type: object * description: The return item's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/AdminReturnReason.ts b/www/utils/generated/oas-output/schemas/AdminReturnReason.ts index b52740f98e..71ac227676 100644 --- a/www/utils/generated/oas-output/schemas/AdminReturnReason.ts +++ b/www/utils/generated/oas-output/schemas/AdminReturnReason.ts @@ -29,6 +29,9 @@ * metadata: * type: object * description: The return reason's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/AdminSalesChannel.ts b/www/utils/generated/oas-output/schemas/AdminSalesChannel.ts index 5186f16d15..42052ac9bc 100644 --- a/www/utils/generated/oas-output/schemas/AdminSalesChannel.ts +++ b/www/utils/generated/oas-output/schemas/AdminSalesChannel.ts @@ -32,6 +32,9 @@ * metadata: * type: object * description: The sales channel's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/AdminShippingOption.ts b/www/utils/generated/oas-output/schemas/AdminShippingOption.ts index 3bac24907f..541d25502c 100644 --- a/www/utils/generated/oas-output/schemas/AdminShippingOption.ts +++ b/www/utils/generated/oas-output/schemas/AdminShippingOption.ts @@ -80,6 +80,9 @@ * metadata: * type: object * description: The shipping option's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/AdminShippingProfile.ts b/www/utils/generated/oas-output/schemas/AdminShippingProfile.ts index 99d8edfe49..ade4c8ee4a 100644 --- a/www/utils/generated/oas-output/schemas/AdminShippingProfile.ts +++ b/www/utils/generated/oas-output/schemas/AdminShippingProfile.ts @@ -19,6 +19,9 @@ * metadata: * type: object * description: The shipping profile's metadata, holds custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/AdminStore.ts b/www/utils/generated/oas-output/schemas/AdminStore.ts index 9052840e38..383adacef0 100644 --- a/www/utils/generated/oas-output/schemas/AdminStore.ts +++ b/www/utils/generated/oas-output/schemas/AdminStore.ts @@ -42,6 +42,9 @@ * metadata: * type: object * description: The store's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/AdminStoreCreditAccount.ts b/www/utils/generated/oas-output/schemas/AdminStoreCreditAccount.ts index be78e18b9b..8462485de1 100644 --- a/www/utils/generated/oas-output/schemas/AdminStoreCreditAccount.ts +++ b/www/utils/generated/oas-output/schemas/AdminStoreCreditAccount.ts @@ -51,6 +51,9 @@ * metadata: * type: object * description: The store credit account's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/AdminTaxRate.ts b/www/utils/generated/oas-output/schemas/AdminTaxRate.ts index 90525352d2..e3079c4c1a 100644 --- a/www/utils/generated/oas-output/schemas/AdminTaxRate.ts +++ b/www/utils/generated/oas-output/schemas/AdminTaxRate.ts @@ -39,6 +39,9 @@ * metadata: * type: object * description: The tax rate's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * tax_region_id: * type: string * title: tax_region_id diff --git a/www/utils/generated/oas-output/schemas/AdminTaxRegion.ts b/www/utils/generated/oas-output/schemas/AdminTaxRegion.ts index deb0a1336c..5ce710f281 100644 --- a/www/utils/generated/oas-output/schemas/AdminTaxRegion.ts +++ b/www/utils/generated/oas-output/schemas/AdminTaxRegion.ts @@ -37,6 +37,9 @@ * metadata: * type: object * description: The tax region's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * parent_id: * type: string * title: parent_id diff --git a/www/utils/generated/oas-output/schemas/AdminTransaction.ts b/www/utils/generated/oas-output/schemas/AdminTransaction.ts index 19fb1b4d57..59a11f5b3d 100644 --- a/www/utils/generated/oas-output/schemas/AdminTransaction.ts +++ b/www/utils/generated/oas-output/schemas/AdminTransaction.ts @@ -53,6 +53,9 @@ * metadata: * type: object * description: The transaction's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/AdminTransactionGroup.ts b/www/utils/generated/oas-output/schemas/AdminTransactionGroup.ts index 0d38892253..ab7449364e 100644 --- a/www/utils/generated/oas-output/schemas/AdminTransactionGroup.ts +++ b/www/utils/generated/oas-output/schemas/AdminTransactionGroup.ts @@ -37,6 +37,9 @@ * metadata: * type: object * description: The transaction group's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateCustomerGroup.ts b/www/utils/generated/oas-output/schemas/AdminUpdateCustomerGroup.ts index fafae0f5ed..39de2cd947 100644 --- a/www/utils/generated/oas-output/schemas/AdminUpdateCustomerGroup.ts +++ b/www/utils/generated/oas-output/schemas/AdminUpdateCustomerGroup.ts @@ -11,6 +11,9 @@ * metadata: * type: object * description: The customer group's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateDraftOrder.ts b/www/utils/generated/oas-output/schemas/AdminUpdateDraftOrder.ts index 73dcdc5a5b..6672006106 100644 --- a/www/utils/generated/oas-output/schemas/AdminUpdateDraftOrder.ts +++ b/www/utils/generated/oas-output/schemas/AdminUpdateDraftOrder.ts @@ -61,6 +61,9 @@ * metadata: * type: object * description: The shipping address's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * billing_address: * type: object * description: The draft order's billing address. @@ -113,9 +116,15 @@ * metadata: * type: object * description: The billing address's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * metadata: * type: object * description: The draft order's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * customer_id: * type: string * title: customer_id diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateDraftOrderActionShippingMethod.ts b/www/utils/generated/oas-output/schemas/AdminUpdateDraftOrderActionShippingMethod.ts index 747f278a9f..4abeec462f 100644 --- a/www/utils/generated/oas-output/schemas/AdminUpdateDraftOrderActionShippingMethod.ts +++ b/www/utils/generated/oas-output/schemas/AdminUpdateDraftOrderActionShippingMethod.ts @@ -25,6 +25,9 @@ * metadata: * type: object * description: The shipping method's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateFulfillmentSetServiceZones.ts b/www/utils/generated/oas-output/schemas/AdminUpdateFulfillmentSetServiceZones.ts index f89cbfaf96..ccc607e144 100644 --- a/www/utils/generated/oas-output/schemas/AdminUpdateFulfillmentSetServiceZones.ts +++ b/www/utils/generated/oas-output/schemas/AdminUpdateFulfillmentSetServiceZones.ts @@ -27,6 +27,9 @@ * metadata: * type: object * description: The geo zone's metadata. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * country_code: * type: string * title: country_code @@ -51,6 +54,9 @@ * metadata: * type: object * description: The geo zone's metadata. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * country_code: * type: string * title: country_code @@ -84,6 +90,9 @@ * metadata: * type: object * description: The geo zone's metadata. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * city: * type: string * title: city @@ -122,6 +131,9 @@ * metadata: * type: object * description: The geo zone's metadata. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * city: * type: string * title: city diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateGiftCardParams.ts b/www/utils/generated/oas-output/schemas/AdminUpdateGiftCardParams.ts index c04a977d33..9733116625 100644 --- a/www/utils/generated/oas-output/schemas/AdminUpdateGiftCardParams.ts +++ b/www/utils/generated/oas-output/schemas/AdminUpdateGiftCardParams.ts @@ -34,6 +34,9 @@ * metadata: * type: object * description: The gift card's metadata. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateInventoryItem.ts b/www/utils/generated/oas-output/schemas/AdminUpdateInventoryItem.ts index 926e2f0486..8582a7b392 100644 --- a/www/utils/generated/oas-output/schemas/AdminUpdateInventoryItem.ts +++ b/www/utils/generated/oas-output/schemas/AdminUpdateInventoryItem.ts @@ -58,6 +58,9 @@ * metadata: * type: object * description: The inventory item's metadata. Can be custom data in key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * x-schemaName: AdminUpdateInventoryItem * */ diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateOrder.ts b/www/utils/generated/oas-output/schemas/AdminUpdateOrder.ts index 59c984a45e..45a5c2529a 100644 --- a/www/utils/generated/oas-output/schemas/AdminUpdateOrder.ts +++ b/www/utils/generated/oas-output/schemas/AdminUpdateOrder.ts @@ -61,6 +61,9 @@ * metadata: * type: object * description: The address's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * billing_address: * type: object * description: The order's billing address. @@ -113,9 +116,15 @@ * metadata: * type: object * description: The address's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * metadata: * type: object * description: The order's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateProduct.ts b/www/utils/generated/oas-output/schemas/AdminUpdateProduct.ts index 3aa92fc4a4..34023eaace 100644 --- a/www/utils/generated/oas-output/schemas/AdminUpdateProduct.ts +++ b/www/utils/generated/oas-output/schemas/AdminUpdateProduct.ts @@ -147,6 +147,9 @@ * metadata: * type: object * description: The product's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * external_id: * type: string * title: external_id diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateProductCategory.ts b/www/utils/generated/oas-output/schemas/AdminUpdateProductCategory.ts index b6db5026a7..6de4e29780 100644 --- a/www/utils/generated/oas-output/schemas/AdminUpdateProductCategory.ts +++ b/www/utils/generated/oas-output/schemas/AdminUpdateProductCategory.ts @@ -30,6 +30,9 @@ * metadata: * type: object * description: The product category's metadata. Can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * rank: * type: number * title: rank diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateProductTag.ts b/www/utils/generated/oas-output/schemas/AdminUpdateProductTag.ts index 87305fd350..3a3f1fac7c 100644 --- a/www/utils/generated/oas-output/schemas/AdminUpdateProductTag.ts +++ b/www/utils/generated/oas-output/schemas/AdminUpdateProductTag.ts @@ -10,6 +10,9 @@ * metadata: * type: object * description: The product tag's metadata. Can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * x-schemaName: AdminUpdateProductTag * */ diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateProductType.ts b/www/utils/generated/oas-output/schemas/AdminUpdateProductType.ts index c9e7a80a29..68749b58c8 100644 --- a/www/utils/generated/oas-output/schemas/AdminUpdateProductType.ts +++ b/www/utils/generated/oas-output/schemas/AdminUpdateProductType.ts @@ -10,6 +10,9 @@ * metadata: * type: object * description: The product type's metadata. Can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * x-schemaName: AdminUpdateProductType * */ diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateProductVariant.ts b/www/utils/generated/oas-output/schemas/AdminUpdateProductVariant.ts index 6d1083da44..4a1b4be54f 100644 --- a/www/utils/generated/oas-output/schemas/AdminUpdateProductVariant.ts +++ b/www/utils/generated/oas-output/schemas/AdminUpdateProductVariant.ts @@ -71,6 +71,9 @@ * metadata: * type: object * description: The product variant's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * prices: * type: array * description: The product variant's prices. diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateRegion.ts b/www/utils/generated/oas-output/schemas/AdminUpdateRegion.ts index 9fa41e6d95..aa9d52a02d 100644 --- a/www/utils/generated/oas-output/schemas/AdminUpdateRegion.ts +++ b/www/utils/generated/oas-output/schemas/AdminUpdateRegion.ts @@ -32,6 +32,9 @@ * metadata: * type: object * description: The region's metadata. Can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * is_tax_inclusive: * type: boolean * title: is_tax_inclusive diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateReservation.ts b/www/utils/generated/oas-output/schemas/AdminUpdateReservation.ts index 6edc39ec7d..b0587d3819 100644 --- a/www/utils/generated/oas-output/schemas/AdminUpdateReservation.ts +++ b/www/utils/generated/oas-output/schemas/AdminUpdateReservation.ts @@ -18,6 +18,9 @@ * metadata: * type: object * description: The reservation's metadata. Can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * x-schemaName: AdminUpdateReservation * */ diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateReturnReason.ts b/www/utils/generated/oas-output/schemas/AdminUpdateReturnReason.ts index 3508ad4ee8..930ff81732 100644 --- a/www/utils/generated/oas-output/schemas/AdminUpdateReturnReason.ts +++ b/www/utils/generated/oas-output/schemas/AdminUpdateReturnReason.ts @@ -19,6 +19,9 @@ * metadata: * type: object * description: The return reason's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * required: * - value * - label diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateSalesChannel.ts b/www/utils/generated/oas-output/schemas/AdminUpdateSalesChannel.ts index 666477df8f..d17877da87 100644 --- a/www/utils/generated/oas-output/schemas/AdminUpdateSalesChannel.ts +++ b/www/utils/generated/oas-output/schemas/AdminUpdateSalesChannel.ts @@ -19,6 +19,9 @@ * metadata: * type: object * description: The sales channel's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateShippingProfile.ts b/www/utils/generated/oas-output/schemas/AdminUpdateShippingProfile.ts index 12ebcff94c..5a7ed43661 100644 --- a/www/utils/generated/oas-output/schemas/AdminUpdateShippingProfile.ts +++ b/www/utils/generated/oas-output/schemas/AdminUpdateShippingProfile.ts @@ -14,6 +14,9 @@ * metadata: * type: object * description: The shipping profile's metadata. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * x-schemaName: AdminUpdateShippingProfile * */ diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateStockLocation.ts b/www/utils/generated/oas-output/schemas/AdminUpdateStockLocation.ts index a8aa8b84a5..4b75edf630 100644 --- a/www/utils/generated/oas-output/schemas/AdminUpdateStockLocation.ts +++ b/www/utils/generated/oas-output/schemas/AdminUpdateStockLocation.ts @@ -59,6 +59,9 @@ * metadata: * type: object * description: The stock location's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateStore.ts b/www/utils/generated/oas-output/schemas/AdminUpdateStore.ts index dcf918200b..b86d38d11f 100644 --- a/www/utils/generated/oas-output/schemas/AdminUpdateStore.ts +++ b/www/utils/generated/oas-output/schemas/AdminUpdateStore.ts @@ -45,6 +45,9 @@ * metadata: * type: object * description: The store's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateTaxRate.ts b/www/utils/generated/oas-output/schemas/AdminUpdateTaxRate.ts index 2a22b5d19c..a5d4df2784 100644 --- a/www/utils/generated/oas-output/schemas/AdminUpdateTaxRate.ts +++ b/www/utils/generated/oas-output/schemas/AdminUpdateTaxRate.ts @@ -49,6 +49,9 @@ * metadata: * type: object * description: The tax rate's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateTaxRegion.ts b/www/utils/generated/oas-output/schemas/AdminUpdateTaxRegion.ts index 750a1d396d..bf97ca3b38 100644 --- a/www/utils/generated/oas-output/schemas/AdminUpdateTaxRegion.ts +++ b/www/utils/generated/oas-output/schemas/AdminUpdateTaxRegion.ts @@ -15,6 +15,9 @@ * metadata: * type: object * description: The tax region's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * provider_id: * type: string * title: provider_id diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateUser.ts b/www/utils/generated/oas-output/schemas/AdminUpdateUser.ts index ca576cd194..95870ce315 100644 --- a/www/utils/generated/oas-output/schemas/AdminUpdateUser.ts +++ b/www/utils/generated/oas-output/schemas/AdminUpdateUser.ts @@ -19,6 +19,9 @@ * metadata: * type: object * description: The user's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/AdminUser.ts b/www/utils/generated/oas-output/schemas/AdminUser.ts index 2a6e12521b..ca05379d8f 100644 --- a/www/utils/generated/oas-output/schemas/AdminUser.ts +++ b/www/utils/generated/oas-output/schemas/AdminUser.ts @@ -38,6 +38,9 @@ * metadata: * type: object * description: The user's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/admin#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/BaseCart.ts b/www/utils/generated/oas-output/schemas/BaseCart.ts index f9fbfae78b..b9f16436f2 100644 --- a/www/utils/generated/oas-output/schemas/BaseCart.ts +++ b/www/utils/generated/oas-output/schemas/BaseCart.ts @@ -75,6 +75,9 @@ * metadata: * type: object * description: The cart's metadata. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/BaseCartLineItem.ts b/www/utils/generated/oas-output/schemas/BaseCartLineItem.ts index 022140712d..1fd44e92bf 100644 --- a/www/utils/generated/oas-output/schemas/BaseCartLineItem.ts +++ b/www/utils/generated/oas-output/schemas/BaseCartLineItem.ts @@ -135,6 +135,9 @@ * metadata: * type: object * description: The item's metadata. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/BaseCartShippingMethod.ts b/www/utils/generated/oas-output/schemas/BaseCartShippingMethod.ts index 7d935c64b8..5856f7c847 100644 --- a/www/utils/generated/oas-output/schemas/BaseCartShippingMethod.ts +++ b/www/utils/generated/oas-output/schemas/BaseCartShippingMethod.ts @@ -56,6 +56,9 @@ * metadata: * type: object * description: The shipping method's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * tax_lines: * type: array * description: The shipping method's tax lines. diff --git a/www/utils/generated/oas-output/schemas/BaseClaimItem.ts b/www/utils/generated/oas-output/schemas/BaseClaimItem.ts index 60bf42e179..977a80bda5 100644 --- a/www/utils/generated/oas-output/schemas/BaseClaimItem.ts +++ b/www/utils/generated/oas-output/schemas/BaseClaimItem.ts @@ -57,6 +57,9 @@ * metadata: * type: object * description: The item's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/BaseCollection.ts b/www/utils/generated/oas-output/schemas/BaseCollection.ts index e70937934c..c886dc8514 100644 --- a/www/utils/generated/oas-output/schemas/BaseCollection.ts +++ b/www/utils/generated/oas-output/schemas/BaseCollection.ts @@ -47,6 +47,9 @@ * metadata: * type: object * description: The collection's metadata, used to store custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/BaseExchangeItem.ts b/www/utils/generated/oas-output/schemas/BaseExchangeItem.ts index 6d0e609ec9..fe24bdb113 100644 --- a/www/utils/generated/oas-output/schemas/BaseExchangeItem.ts +++ b/www/utils/generated/oas-output/schemas/BaseExchangeItem.ts @@ -35,6 +35,9 @@ * metadata: * type: object * description: The item's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/BaseOrder.ts b/www/utils/generated/oas-output/schemas/BaseOrder.ts index e0e0ecfe09..9603d335ca 100644 --- a/www/utils/generated/oas-output/schemas/BaseOrder.ts +++ b/www/utils/generated/oas-output/schemas/BaseOrder.ts @@ -136,6 +136,9 @@ * metadata: * type: object * description: The order's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/BaseOrderAddress.ts b/www/utils/generated/oas-output/schemas/BaseOrderAddress.ts index 0552e1b567..90e12e4f71 100644 --- a/www/utils/generated/oas-output/schemas/BaseOrderAddress.ts +++ b/www/utils/generated/oas-output/schemas/BaseOrderAddress.ts @@ -65,6 +65,9 @@ * metadata: * type: object * description: The address's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/BaseOrderFulfillment.ts b/www/utils/generated/oas-output/schemas/BaseOrderFulfillment.ts index bd82946367..0a915621c9 100644 --- a/www/utils/generated/oas-output/schemas/BaseOrderFulfillment.ts +++ b/www/utils/generated/oas-output/schemas/BaseOrderFulfillment.ts @@ -62,6 +62,9 @@ * metadata: * type: object * description: The fulfillment's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/BaseOrderLineItem.ts b/www/utils/generated/oas-output/schemas/BaseOrderLineItem.ts index 9b9ef95f4a..2fc6d4c89d 100644 --- a/www/utils/generated/oas-output/schemas/BaseOrderLineItem.ts +++ b/www/utils/generated/oas-output/schemas/BaseOrderLineItem.ts @@ -162,6 +162,9 @@ * metadata: * type: object * description: The item's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * original_total: * type: number * title: original_total diff --git a/www/utils/generated/oas-output/schemas/BaseOrderShippingMethod.ts b/www/utils/generated/oas-output/schemas/BaseOrderShippingMethod.ts index 3a1bf9dde7..13549e83d9 100644 --- a/www/utils/generated/oas-output/schemas/BaseOrderShippingMethod.ts +++ b/www/utils/generated/oas-output/schemas/BaseOrderShippingMethod.ts @@ -59,6 +59,9 @@ * metadata: * type: object * description: The shipping method's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * tax_lines: * type: array * description: The shipping method's tax lines. diff --git a/www/utils/generated/oas-output/schemas/BaseOrderTransaction.ts b/www/utils/generated/oas-output/schemas/BaseOrderTransaction.ts index 7524dc64ca..08aac9d5c3 100644 --- a/www/utils/generated/oas-output/schemas/BaseOrderTransaction.ts +++ b/www/utils/generated/oas-output/schemas/BaseOrderTransaction.ts @@ -45,6 +45,9 @@ * metadata: * type: object * description: The transaction's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/BasePaymentCollection.ts b/www/utils/generated/oas-output/schemas/BasePaymentCollection.ts index c10f4b0866..f0012d607d 100644 --- a/www/utils/generated/oas-output/schemas/BasePaymentCollection.ts +++ b/www/utils/generated/oas-output/schemas/BasePaymentCollection.ts @@ -52,6 +52,9 @@ * metadata: * type: object * description: The payment collection's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * status: * type: string * description: The payment collection's status. diff --git a/www/utils/generated/oas-output/schemas/BaseProduct.ts b/www/utils/generated/oas-output/schemas/BaseProduct.ts index 9ecef6332e..9691de0d17 100644 --- a/www/utils/generated/oas-output/schemas/BaseProduct.ts +++ b/www/utils/generated/oas-output/schemas/BaseProduct.ts @@ -82,6 +82,9 @@ * metadata: * type: object * description: The product's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/BaseProductCategory.ts b/www/utils/generated/oas-output/schemas/BaseProductCategory.ts index 170ffe7e54..ba8bfa2ae0 100644 --- a/www/utils/generated/oas-output/schemas/BaseProductCategory.ts +++ b/www/utils/generated/oas-output/schemas/BaseProductCategory.ts @@ -45,6 +45,9 @@ * metadata: * type: object * description: The category's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/BaseProductImage.ts b/www/utils/generated/oas-output/schemas/BaseProductImage.ts index 9ff1cf55d2..430bee969a 100644 --- a/www/utils/generated/oas-output/schemas/BaseProductImage.ts +++ b/www/utils/generated/oas-output/schemas/BaseProductImage.ts @@ -30,6 +30,9 @@ * metadata: * type: object * description: The image's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * rank: * type: number * title: rank diff --git a/www/utils/generated/oas-output/schemas/BaseProductOption.ts b/www/utils/generated/oas-output/schemas/BaseProductOption.ts index 25a3688df1..db3e9a6455 100644 --- a/www/utils/generated/oas-output/schemas/BaseProductOption.ts +++ b/www/utils/generated/oas-output/schemas/BaseProductOption.ts @@ -29,6 +29,9 @@ * metadata: * type: object * description: The product option's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/BaseProductOptionValue.ts b/www/utils/generated/oas-output/schemas/BaseProductOptionValue.ts index af37e68f43..d3e6b9619a 100644 --- a/www/utils/generated/oas-output/schemas/BaseProductOptionValue.ts +++ b/www/utils/generated/oas-output/schemas/BaseProductOptionValue.ts @@ -24,6 +24,9 @@ * metadata: * type: object * description: The value's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/BaseProductTag.ts b/www/utils/generated/oas-output/schemas/BaseProductTag.ts index a1fc817c29..afe2975ce6 100644 --- a/www/utils/generated/oas-output/schemas/BaseProductTag.ts +++ b/www/utils/generated/oas-output/schemas/BaseProductTag.ts @@ -35,6 +35,9 @@ * metadata: * type: object * description: The tag's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/BaseProductType.ts b/www/utils/generated/oas-output/schemas/BaseProductType.ts index 370bc61cc8..3b4058f7e1 100644 --- a/www/utils/generated/oas-output/schemas/BaseProductType.ts +++ b/www/utils/generated/oas-output/schemas/BaseProductType.ts @@ -35,6 +35,9 @@ * metadata: * type: object * description: The type's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/BaseProductVariant.ts b/www/utils/generated/oas-output/schemas/BaseProductVariant.ts index 88bdc45e64..8c9f4a3869 100644 --- a/www/utils/generated/oas-output/schemas/BaseProductVariant.ts +++ b/www/utils/generated/oas-output/schemas/BaseProductVariant.ts @@ -128,6 +128,9 @@ * metadata: * type: object * description: The variant's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/BaseRegion.ts b/www/utils/generated/oas-output/schemas/BaseRegion.ts index 5434b339e9..7a3b1dfe66 100644 --- a/www/utils/generated/oas-output/schemas/BaseRegion.ts +++ b/www/utils/generated/oas-output/schemas/BaseRegion.ts @@ -37,6 +37,9 @@ * metadata: * type: object * description: The region's metadata. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/CreateAddress.ts b/www/utils/generated/oas-output/schemas/CreateAddress.ts index c893b059e0..c2bbe8384f 100644 --- a/www/utils/generated/oas-output/schemas/CreateAddress.ts +++ b/www/utils/generated/oas-output/schemas/CreateAddress.ts @@ -56,6 +56,9 @@ * metadata: * type: object * description: The address's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/InventoryLevel.ts b/www/utils/generated/oas-output/schemas/InventoryLevel.ts index 2f537ca249..c38602076d 100644 --- a/www/utils/generated/oas-output/schemas/InventoryLevel.ts +++ b/www/utils/generated/oas-output/schemas/InventoryLevel.ts @@ -43,6 +43,9 @@ * metadata: * type: object * description: The inventory level's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/Order.ts b/www/utils/generated/oas-output/schemas/Order.ts index d1c03b36bb..17ce9a860a 100644 --- a/www/utils/generated/oas-output/schemas/Order.ts +++ b/www/utils/generated/oas-output/schemas/Order.ts @@ -177,6 +177,9 @@ * metadata: * type: object * description: The order's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * canceled_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/OrderAddress.ts b/www/utils/generated/oas-output/schemas/OrderAddress.ts index 2990254894..c7127d00ef 100644 --- a/www/utils/generated/oas-output/schemas/OrderAddress.ts +++ b/www/utils/generated/oas-output/schemas/OrderAddress.ts @@ -64,6 +64,9 @@ * metadata: * type: object * description: The address's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/OrderChange.ts b/www/utils/generated/oas-output/schemas/OrderChange.ts index e42bd77a65..7084d2a421 100644 --- a/www/utils/generated/oas-output/schemas/OrderChange.ts +++ b/www/utils/generated/oas-output/schemas/OrderChange.ts @@ -112,6 +112,9 @@ * metadata: * type: object * description: The order change's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * declined_at: * type: string * title: declined_at diff --git a/www/utils/generated/oas-output/schemas/OrderClaim.ts b/www/utils/generated/oas-output/schemas/OrderClaim.ts index d430fff94d..545e1fdc4d 100644 --- a/www/utils/generated/oas-output/schemas/OrderClaim.ts +++ b/www/utils/generated/oas-output/schemas/OrderClaim.ts @@ -65,6 +65,9 @@ * metadata: * type: object * description: The claim's metadata, used to store custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/OrderCreditLine.ts b/www/utils/generated/oas-output/schemas/OrderCreditLine.ts index b6ea13c7e1..dde44309b0 100644 --- a/www/utils/generated/oas-output/schemas/OrderCreditLine.ts +++ b/www/utils/generated/oas-output/schemas/OrderCreditLine.ts @@ -35,6 +35,9 @@ * metadata: * type: object * description: The credit line's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/OrderExchange.ts b/www/utils/generated/oas-output/schemas/OrderExchange.ts index a1b7f92eb6..73b05f8c90 100644 --- a/www/utils/generated/oas-output/schemas/OrderExchange.ts +++ b/www/utils/generated/oas-output/schemas/OrderExchange.ts @@ -57,6 +57,9 @@ * metadata: * type: object * description: The exchange's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/OrderItem.ts b/www/utils/generated/oas-output/schemas/OrderItem.ts index a253efccdd..e75375b3fa 100644 --- a/www/utils/generated/oas-output/schemas/OrderItem.ts +++ b/www/utils/generated/oas-output/schemas/OrderItem.ts @@ -64,6 +64,9 @@ * metadata: * type: object * description: The item's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/OrderLineItem.ts b/www/utils/generated/oas-output/schemas/OrderLineItem.ts index de20c7e7e3..3dd3595304 100644 --- a/www/utils/generated/oas-output/schemas/OrderLineItem.ts +++ b/www/utils/generated/oas-output/schemas/OrderLineItem.ts @@ -143,6 +143,9 @@ * metadata: * type: object * description: The item's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * original_total: * type: number * title: original_total diff --git a/www/utils/generated/oas-output/schemas/OrderReturnItem.ts b/www/utils/generated/oas-output/schemas/OrderReturnItem.ts index 14235657a9..c578bfbb3d 100644 --- a/www/utils/generated/oas-output/schemas/OrderReturnItem.ts +++ b/www/utils/generated/oas-output/schemas/OrderReturnItem.ts @@ -37,6 +37,9 @@ * metadata: * type: object * description: The return item's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * order_id: * type: string * title: order_id diff --git a/www/utils/generated/oas-output/schemas/OrderShippingMethod.ts b/www/utils/generated/oas-output/schemas/OrderShippingMethod.ts index 8e97422ecf..68219656f1 100644 --- a/www/utils/generated/oas-output/schemas/OrderShippingMethod.ts +++ b/www/utils/generated/oas-output/schemas/OrderShippingMethod.ts @@ -56,6 +56,9 @@ * metadata: * type: object * description: The shipping method's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * tax_lines: * type: array * description: The shipping method's tax lines. diff --git a/www/utils/generated/oas-output/schemas/OrderTransaction.ts b/www/utils/generated/oas-output/schemas/OrderTransaction.ts index b733eb537d..4a9c41ae57 100644 --- a/www/utils/generated/oas-output/schemas/OrderTransaction.ts +++ b/www/utils/generated/oas-output/schemas/OrderTransaction.ts @@ -47,6 +47,9 @@ * metadata: * type: object * description: The transaction's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/RefundReason.ts b/www/utils/generated/oas-output/schemas/RefundReason.ts index fc1afe83ee..2a8ab353cd 100644 --- a/www/utils/generated/oas-output/schemas/RefundReason.ts +++ b/www/utils/generated/oas-output/schemas/RefundReason.ts @@ -25,6 +25,9 @@ * metadata: * type: object * description: The refund reason's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/Return.ts b/www/utils/generated/oas-output/schemas/Return.ts index b4d003ec8d..bd2ed516e8 100644 --- a/www/utils/generated/oas-output/schemas/Return.ts +++ b/www/utils/generated/oas-output/schemas/Return.ts @@ -49,6 +49,9 @@ * metadata: * type: object * description: The return's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/StoreAddCartLineItem.ts b/www/utils/generated/oas-output/schemas/StoreAddCartLineItem.ts index fbef5c7a82..c094b6d526 100644 --- a/www/utils/generated/oas-output/schemas/StoreAddCartLineItem.ts +++ b/www/utils/generated/oas-output/schemas/StoreAddCartLineItem.ts @@ -18,6 +18,9 @@ * metadata: * type: object * description: The item's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/StoreCart.ts b/www/utils/generated/oas-output/schemas/StoreCart.ts index 2a0b21610e..2d08620244 100644 --- a/www/utils/generated/oas-output/schemas/StoreCart.ts +++ b/www/utils/generated/oas-output/schemas/StoreCart.ts @@ -77,6 +77,9 @@ * metadata: * type: object * description: The cart's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/StoreCartAddress.ts b/www/utils/generated/oas-output/schemas/StoreCartAddress.ts index 707c1cb0b4..ff1678884a 100644 --- a/www/utils/generated/oas-output/schemas/StoreCartAddress.ts +++ b/www/utils/generated/oas-output/schemas/StoreCartAddress.ts @@ -64,6 +64,9 @@ * metadata: * type: object * description: The address's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * title: created_at diff --git a/www/utils/generated/oas-output/schemas/StoreCartLineItem.ts b/www/utils/generated/oas-output/schemas/StoreCartLineItem.ts index 39300e3182..3958dabe53 100644 --- a/www/utils/generated/oas-output/schemas/StoreCartLineItem.ts +++ b/www/utils/generated/oas-output/schemas/StoreCartLineItem.ts @@ -279,6 +279,9 @@ * metadata: * type: object * description: The item's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * title: created_at diff --git a/www/utils/generated/oas-output/schemas/StoreCartShippingMethod.ts b/www/utils/generated/oas-output/schemas/StoreCartShippingMethod.ts index 107cd07752..e687323c64 100644 --- a/www/utils/generated/oas-output/schemas/StoreCartShippingMethod.ts +++ b/www/utils/generated/oas-output/schemas/StoreCartShippingMethod.ts @@ -56,6 +56,9 @@ * metadata: * type: object * description: The shipping method's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * tax_lines: * type: array * description: The shipping method's tax lines. diff --git a/www/utils/generated/oas-output/schemas/StoreCollection.ts b/www/utils/generated/oas-output/schemas/StoreCollection.ts index f9ecbabdfe..a358d73528 100644 --- a/www/utils/generated/oas-output/schemas/StoreCollection.ts +++ b/www/utils/generated/oas-output/schemas/StoreCollection.ts @@ -47,6 +47,9 @@ * metadata: * type: object * description: The collection's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/StoreCreateCart.ts b/www/utils/generated/oas-output/schemas/StoreCreateCart.ts index 5e853365d2..43f416ca01 100644 --- a/www/utils/generated/oas-output/schemas/StoreCreateCart.ts +++ b/www/utils/generated/oas-output/schemas/StoreCreateCart.ts @@ -34,6 +34,9 @@ * metadata: * type: object * description: The cart's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/StoreCreateCustomer.ts b/www/utils/generated/oas-output/schemas/StoreCreateCustomer.ts index f0f1efcc87..fa4c322141 100644 --- a/www/utils/generated/oas-output/schemas/StoreCreateCustomer.ts +++ b/www/utils/generated/oas-output/schemas/StoreCreateCustomer.ts @@ -30,6 +30,9 @@ * metadata: * type: object * description: The customer's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/StoreCustomer.ts b/www/utils/generated/oas-output/schemas/StoreCustomer.ts index cc2b5e4246..78601403b0 100644 --- a/www/utils/generated/oas-output/schemas/StoreCustomer.ts +++ b/www/utils/generated/oas-output/schemas/StoreCustomer.ts @@ -54,6 +54,9 @@ * metadata: * type: object * description: The customer's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/StoreCustomerAddress.ts b/www/utils/generated/oas-output/schemas/StoreCustomerAddress.ts index 461b499d64..e4ab53d3c1 100644 --- a/www/utils/generated/oas-output/schemas/StoreCustomerAddress.ts +++ b/www/utils/generated/oas-output/schemas/StoreCustomerAddress.ts @@ -91,6 +91,9 @@ * metadata: * type: object * description: The address's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/StoreOrder.ts b/www/utils/generated/oas-output/schemas/StoreOrder.ts index 8188e97a89..54e01f9d26 100644 --- a/www/utils/generated/oas-output/schemas/StoreOrder.ts +++ b/www/utils/generated/oas-output/schemas/StoreOrder.ts @@ -127,6 +127,9 @@ * metadata: * type: object * description: The order's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/StoreOrderAddress.ts b/www/utils/generated/oas-output/schemas/StoreOrderAddress.ts index 71235a9f0c..05dc08a385 100644 --- a/www/utils/generated/oas-output/schemas/StoreOrderAddress.ts +++ b/www/utils/generated/oas-output/schemas/StoreOrderAddress.ts @@ -67,6 +67,9 @@ * metadata: * type: object * description: The address's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/StoreOrderFulfillment.ts b/www/utils/generated/oas-output/schemas/StoreOrderFulfillment.ts index 8510f339d4..1d392b1331 100644 --- a/www/utils/generated/oas-output/schemas/StoreOrderFulfillment.ts +++ b/www/utils/generated/oas-output/schemas/StoreOrderFulfillment.ts @@ -62,6 +62,9 @@ * metadata: * type: object * description: The fulfillment's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/StoreOrderLineItem.ts b/www/utils/generated/oas-output/schemas/StoreOrderLineItem.ts index 4cbe756553..6d6cdbf206 100644 --- a/www/utils/generated/oas-output/schemas/StoreOrderLineItem.ts +++ b/www/utils/generated/oas-output/schemas/StoreOrderLineItem.ts @@ -351,6 +351,9 @@ * metadata: * type: object * description: The variant's metadata. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * variant_id: * type: string * title: variant_id @@ -532,6 +535,9 @@ * metadata: * type: object * description: The product's metadata. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * product_id: * type: string * title: product_id @@ -796,6 +802,9 @@ * metadata: * type: object * description: The detail's metadata. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time @@ -819,6 +828,9 @@ * metadata: * type: object * description: The item's metadata. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * original_total: * type: number * title: original_total @@ -1018,6 +1030,9 @@ * metadata: * type: object * description: The variant's metadata. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time @@ -1203,6 +1218,9 @@ * metadata: * type: object * description: The product's metadata. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time @@ -1496,6 +1514,9 @@ * metadata: * type: object * description: The detail's metadata. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time @@ -1526,6 +1547,9 @@ * metadata: * type: object * description: The item's metadata. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time @@ -1880,6 +1904,9 @@ * metadata: * type: object * description: The variant's metadata. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * variant_id: * type: string * title: variant_id @@ -2061,6 +2088,9 @@ * metadata: * type: object * description: The product's metadata. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * product_id: * type: string * title: product_id @@ -2325,6 +2355,9 @@ * metadata: * type: object * description: The detail's metadata. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time @@ -2348,6 +2381,9 @@ * metadata: * type: object * description: The item's metadata. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * original_total: * type: number * title: original_total @@ -2543,6 +2579,9 @@ * metadata: * type: object * description: The variant's metadata. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time @@ -2728,6 +2767,9 @@ * metadata: * type: object * description: The product's metadata. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time @@ -3021,6 +3063,9 @@ * metadata: * type: object * description: The detail's metadata. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time @@ -3051,6 +3096,9 @@ * metadata: * type: object * description: The item's metadata. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time @@ -3297,6 +3345,9 @@ * metadata: * type: object * description: The variant's metadata. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time @@ -3482,6 +3533,9 @@ * metadata: * type: object * description: The product's metadata. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time @@ -3775,6 +3829,9 @@ * metadata: * type: object * description: The detail's metadata. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time @@ -3805,6 +3862,9 @@ * metadata: * type: object * description: The item's metadata. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time @@ -3960,6 +4020,9 @@ * metadata: * type: object * description: The item's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * original_total: * type: number * title: original_total diff --git a/www/utils/generated/oas-output/schemas/StoreOrderShippingMethod.ts b/www/utils/generated/oas-output/schemas/StoreOrderShippingMethod.ts index f19c7136b4..3b5f8e34f9 100644 --- a/www/utils/generated/oas-output/schemas/StoreOrderShippingMethod.ts +++ b/www/utils/generated/oas-output/schemas/StoreOrderShippingMethod.ts @@ -59,6 +59,9 @@ * metadata: * type: object * description: The shipping method's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * tax_lines: * type: array * description: The shipping method's tax lines. @@ -136,6 +139,9 @@ * metadata: * type: object * description: The shipping method's metadata. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * tax_lines: * type: array * description: The shipping method's tax lines. @@ -667,6 +673,9 @@ * metadata: * type: object * description: The shipping method's metadata. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * original_total: * type: number * title: original_total @@ -785,6 +794,9 @@ * metadata: * type: object * description: The shipping method's metadata. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * tax_lines: * type: array * description: The shipping method's tax lines. @@ -1312,6 +1324,9 @@ * metadata: * type: object * description: The shipping method's metadata. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * original_total: * type: number * title: original_total @@ -1668,6 +1683,9 @@ * metadata: * type: object * description: The shipping method's metadata. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * original_total: * type: number * title: original_total diff --git a/www/utils/generated/oas-output/schemas/StorePaymentCollection.ts b/www/utils/generated/oas-output/schemas/StorePaymentCollection.ts index 8636f9cd4e..eee4d1e9dc 100644 --- a/www/utils/generated/oas-output/schemas/StorePaymentCollection.ts +++ b/www/utils/generated/oas-output/schemas/StorePaymentCollection.ts @@ -52,6 +52,9 @@ * metadata: * type: object * description: The payment collection's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * status: * type: string * description: The payment collection's status. diff --git a/www/utils/generated/oas-output/schemas/StoreProduct.ts b/www/utils/generated/oas-output/schemas/StoreProduct.ts index 65c825224a..1e75539b1a 100644 --- a/www/utils/generated/oas-output/schemas/StoreProduct.ts +++ b/www/utils/generated/oas-output/schemas/StoreProduct.ts @@ -70,6 +70,9 @@ * metadata: * type: object * description: The product's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/StoreProductCategory.ts b/www/utils/generated/oas-output/schemas/StoreProductCategory.ts index 8f45a0e0c7..0734465619 100644 --- a/www/utils/generated/oas-output/schemas/StoreProductCategory.ts +++ b/www/utils/generated/oas-output/schemas/StoreProductCategory.ts @@ -50,6 +50,9 @@ * metadata: * type: object * description: The category's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/StoreProductImage.ts b/www/utils/generated/oas-output/schemas/StoreProductImage.ts index 5111ed18d4..28b57b4357 100644 --- a/www/utils/generated/oas-output/schemas/StoreProductImage.ts +++ b/www/utils/generated/oas-output/schemas/StoreProductImage.ts @@ -34,6 +34,9 @@ * metadata: * type: object * description: The image's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * rank: * type: number * title: rank diff --git a/www/utils/generated/oas-output/schemas/StoreProductOption.ts b/www/utils/generated/oas-output/schemas/StoreProductOption.ts index cb84c547fa..9ededae0b7 100644 --- a/www/utils/generated/oas-output/schemas/StoreProductOption.ts +++ b/www/utils/generated/oas-output/schemas/StoreProductOption.ts @@ -26,6 +26,9 @@ * metadata: * type: object * description: The option's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/StoreProductOptionValue.ts b/www/utils/generated/oas-output/schemas/StoreProductOptionValue.ts index 1ce6191248..e9eeeabd5a 100644 --- a/www/utils/generated/oas-output/schemas/StoreProductOptionValue.ts +++ b/www/utils/generated/oas-output/schemas/StoreProductOptionValue.ts @@ -24,6 +24,9 @@ * metadata: * type: object * description: The value's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/StoreProductTag.ts b/www/utils/generated/oas-output/schemas/StoreProductTag.ts index 9803efdd01..8569e2ed33 100644 --- a/www/utils/generated/oas-output/schemas/StoreProductTag.ts +++ b/www/utils/generated/oas-output/schemas/StoreProductTag.ts @@ -30,6 +30,9 @@ * metadata: * type: object * description: The tag's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * required: * - id * - value diff --git a/www/utils/generated/oas-output/schemas/StoreProductType.ts b/www/utils/generated/oas-output/schemas/StoreProductType.ts index 6e1a8b4ab0..ff6bc73599 100644 --- a/www/utils/generated/oas-output/schemas/StoreProductType.ts +++ b/www/utils/generated/oas-output/schemas/StoreProductType.ts @@ -16,6 +16,9 @@ * metadata: * type: object * description: The product type's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/StoreProductVariant.ts b/www/utils/generated/oas-output/schemas/StoreProductVariant.ts index 69ce0d5efd..79d635ca4e 100644 --- a/www/utils/generated/oas-output/schemas/StoreProductVariant.ts +++ b/www/utils/generated/oas-output/schemas/StoreProductVariant.ts @@ -22,6 +22,9 @@ * metadata: * type: object * description: The variant's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * id: * type: string * title: id diff --git a/www/utils/generated/oas-output/schemas/StoreRegion.ts b/www/utils/generated/oas-output/schemas/StoreRegion.ts index d4692b685d..86e8f63280 100644 --- a/www/utils/generated/oas-output/schemas/StoreRegion.ts +++ b/www/utils/generated/oas-output/schemas/StoreRegion.ts @@ -38,6 +38,9 @@ * metadata: * type: object * description: The region's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/StoreReturnItem.ts b/www/utils/generated/oas-output/schemas/StoreReturnItem.ts index 9fddc06677..0a69d8be96 100644 --- a/www/utils/generated/oas-output/schemas/StoreReturnItem.ts +++ b/www/utils/generated/oas-output/schemas/StoreReturnItem.ts @@ -46,6 +46,9 @@ * metadata: * type: object * description: The item's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/StoreReturnReason.ts b/www/utils/generated/oas-output/schemas/StoreReturnReason.ts index 505d7a9c8c..1c01b1d577 100644 --- a/www/utils/generated/oas-output/schemas/StoreReturnReason.ts +++ b/www/utils/generated/oas-output/schemas/StoreReturnReason.ts @@ -29,6 +29,9 @@ * metadata: * type: object * description: The return reason's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/StoreShippingOption.ts b/www/utils/generated/oas-output/schemas/StoreShippingOption.ts index 6e4477c5c9..c6afa112ac 100644 --- a/www/utils/generated/oas-output/schemas/StoreShippingOption.ts +++ b/www/utils/generated/oas-output/schemas/StoreShippingOption.ts @@ -69,6 +69,9 @@ * metadata: * type: object * description: The shipping option's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/StoreStoreCreditAccount.ts b/www/utils/generated/oas-output/schemas/StoreStoreCreditAccount.ts index 6d6b752231..67724900e1 100644 --- a/www/utils/generated/oas-output/schemas/StoreStoreCreditAccount.ts +++ b/www/utils/generated/oas-output/schemas/StoreStoreCreditAccount.ts @@ -51,6 +51,9 @@ * metadata: * type: object * description: The store credit account's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/StoreTransactionGroup.ts b/www/utils/generated/oas-output/schemas/StoreTransactionGroup.ts index 6213a2faf2..1899d3163d 100644 --- a/www/utils/generated/oas-output/schemas/StoreTransactionGroup.ts +++ b/www/utils/generated/oas-output/schemas/StoreTransactionGroup.ts @@ -36,6 +36,9 @@ * metadata: * type: object * description: The transaction group's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * x-schemaName: StoreTransactionGroup * */ diff --git a/www/utils/generated/oas-output/schemas/StoreUpdateCartLineItem.ts b/www/utils/generated/oas-output/schemas/StoreUpdateCartLineItem.ts index fce287cd90..6b92b74a74 100644 --- a/www/utils/generated/oas-output/schemas/StoreUpdateCartLineItem.ts +++ b/www/utils/generated/oas-output/schemas/StoreUpdateCartLineItem.ts @@ -13,6 +13,9 @@ * metadata: * type: object * description: The item's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/StoreUpdateCustomer.ts b/www/utils/generated/oas-output/schemas/StoreUpdateCustomer.ts index 90f0b31d5d..2724ad2bf1 100644 --- a/www/utils/generated/oas-output/schemas/StoreUpdateCustomer.ts +++ b/www/utils/generated/oas-output/schemas/StoreUpdateCustomer.ts @@ -23,6 +23,9 @@ * metadata: * type: object * description: The customer's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/UpdateAddress.ts b/www/utils/generated/oas-output/schemas/UpdateAddress.ts index 55b16a1eb5..228df1a21c 100644 --- a/www/utils/generated/oas-output/schemas/UpdateAddress.ts +++ b/www/utils/generated/oas-output/schemas/UpdateAddress.ts @@ -62,6 +62,9 @@ * metadata: * type: object * description: The address's metadata, can hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/generated/oas-output/schemas/UpdateCartData.ts b/www/utils/generated/oas-output/schemas/UpdateCartData.ts index 3252174fdc..d2dcf198d0 100644 --- a/www/utils/generated/oas-output/schemas/UpdateCartData.ts +++ b/www/utils/generated/oas-output/schemas/UpdateCartData.ts @@ -45,6 +45,9 @@ * metadata: * type: object * description: The cart's metadata, ca hold custom key-value pairs. + * externalDocs: + * url: https://docs.medusajs.com/api/store#manage-metadata + * description: Learn how to manage metadata * */ diff --git a/www/utils/packages/docs-generator/src/classes/helpers/schema-factory.ts b/www/utils/packages/docs-generator/src/classes/helpers/schema-factory.ts index c5c2f05471..cdca41865c 100644 --- a/www/utils/packages/docs-generator/src/classes/helpers/schema-factory.ts +++ b/www/utils/packages/docs-generator/src/classes/helpers/schema-factory.ts @@ -109,6 +109,15 @@ class SchemaFactory { url: "#pagination", }, }, + metadata: { + type: "object", + title: "metadata", + description: "Holds custom key-value pairs.", + externalDocs: { + url: "https://docs.medusajs.com/api/store#manage-metadata", + description: "Learn how to manage metadata", + }, + }, } /**