chore(docs): Generated References (automated) (#8154)

Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
This commit is contained in:
github-actions[bot]andkodiakhq authored and GitHub committed 2024-07-17 08:34:29 +01:00
1 parent 23053afe95
commit 238582ee67
176 files changed
+59620 -59050

No files matched your search

+88 -80
View File
@@ -1087,6 +1087,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/api_key/types/api_key.ApiKeyType/page.mdx", "filePath": "/www/apps/resources/references/api_key/types/api_key.ApiKeyType/page.mdx",
"pathname": "/references/api_key/types/api_key.ApiKeyType" "pathname": "/references/api_key/types/api_key.ApiKeyType"
}, },
{
"filePath": "/www/apps/resources/references/api_key/types/api_key.Event/page.mdx",
"pathname": "/references/api_key/types/api_key.Event"
},
{ {
"filePath": "/www/apps/resources/references/api_key/types/api_key.EventMetadata/page.mdx", "filePath": "/www/apps/resources/references/api_key/types/api_key.EventMetadata/page.mdx",
"pathname": "/references/api_key/types/api_key.EventMetadata" "pathname": "/references/api_key/types/api_key.EventMetadata"
@@ -1103,10 +1107,6 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/api_key/types/api_key.Message/page.mdx", "filePath": "/www/apps/resources/references/api_key/types/api_key.Message/page.mdx",
"pathname": "/references/api_key/types/api_key.Message" "pathname": "/references/api_key/types/api_key.Message"
}, },
{
"filePath": "/www/apps/resources/references/api_key/types/api_key.MessageBody/page.mdx",
"pathname": "/references/api_key/types/api_key.MessageBody"
},
{ {
"filePath": "/www/apps/resources/references/api_key/types/api_key.ModuleJoinerConfig/page.mdx", "filePath": "/www/apps/resources/references/api_key/types/api_key.ModuleJoinerConfig/page.mdx",
"pathname": "/references/api_key/types/api_key.ModuleJoinerConfig" "pathname": "/references/api_key/types/api_key.ModuleJoinerConfig"
@@ -1239,6 +1239,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/auth/interfaces/auth.UpdateAuthIdentityDTO/page.mdx", "filePath": "/www/apps/resources/references/auth/interfaces/auth.UpdateAuthIdentityDTO/page.mdx",
"pathname": "/references/auth/interfaces/auth.UpdateAuthIdentityDTO" "pathname": "/references/auth/interfaces/auth.UpdateAuthIdentityDTO"
}, },
{
"filePath": "/www/apps/resources/references/auth/types/auth.Event/page.mdx",
"pathname": "/references/auth/types/auth.Event"
},
{ {
"filePath": "/www/apps/resources/references/auth/types/auth.EventMetadata/page.mdx", "filePath": "/www/apps/resources/references/auth/types/auth.EventMetadata/page.mdx",
"pathname": "/references/auth/types/auth.EventMetadata" "pathname": "/references/auth/types/auth.EventMetadata"
@@ -1255,10 +1259,6 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/auth/types/auth.Message/page.mdx", "filePath": "/www/apps/resources/references/auth/types/auth.Message/page.mdx",
"pathname": "/references/auth/types/auth.Message" "pathname": "/references/auth/types/auth.Message"
}, },
{
"filePath": "/www/apps/resources/references/auth/types/auth.MessageBody/page.mdx",
"pathname": "/references/auth/types/auth.MessageBody"
},
{ {
"filePath": "/www/apps/resources/references/auth/types/auth.ModuleJoinerConfig/page.mdx", "filePath": "/www/apps/resources/references/auth/types/auth.ModuleJoinerConfig/page.mdx",
"pathname": "/references/auth/types/auth.ModuleJoinerConfig" "pathname": "/references/auth/types/auth.ModuleJoinerConfig"
@@ -1727,6 +1727,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/cart/types/cart.BigNumberValue/page.mdx", "filePath": "/www/apps/resources/references/cart/types/cart.BigNumberValue/page.mdx",
"pathname": "/references/cart/types/cart.BigNumberValue" "pathname": "/references/cart/types/cart.BigNumberValue"
}, },
{
"filePath": "/www/apps/resources/references/cart/types/cart.Event/page.mdx",
"pathname": "/references/cart/types/cart.Event"
},
{ {
"filePath": "/www/apps/resources/references/cart/types/cart.EventMetadata/page.mdx", "filePath": "/www/apps/resources/references/cart/types/cart.EventMetadata/page.mdx",
"pathname": "/references/cart/types/cart.EventMetadata" "pathname": "/references/cart/types/cart.EventMetadata"
@@ -1759,10 +1763,6 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/cart/types/cart.Message/page.mdx", "filePath": "/www/apps/resources/references/cart/types/cart.Message/page.mdx",
"pathname": "/references/cart/types/cart.Message" "pathname": "/references/cart/types/cart.Message"
}, },
{
"filePath": "/www/apps/resources/references/cart/types/cart.MessageBody/page.mdx",
"pathname": "/references/cart/types/cart.MessageBody"
},
{ {
"filePath": "/www/apps/resources/references/cart/types/cart.ModuleJoinerConfig/page.mdx", "filePath": "/www/apps/resources/references/cart/types/cart.ModuleJoinerConfig/page.mdx",
"pathname": "/references/cart/types/cart.ModuleJoinerConfig" "pathname": "/references/cart/types/cart.ModuleJoinerConfig"
@@ -1903,6 +1903,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/currency/interfaces/currency.MessageAggregatorFormat/page.mdx", "filePath": "/www/apps/resources/references/currency/interfaces/currency.MessageAggregatorFormat/page.mdx",
"pathname": "/references/currency/interfaces/currency.MessageAggregatorFormat" "pathname": "/references/currency/interfaces/currency.MessageAggregatorFormat"
}, },
{
"filePath": "/www/apps/resources/references/currency/types/currency.Event/page.mdx",
"pathname": "/references/currency/types/currency.Event"
},
{ {
"filePath": "/www/apps/resources/references/currency/types/currency.EventMetadata/page.mdx", "filePath": "/www/apps/resources/references/currency/types/currency.EventMetadata/page.mdx",
"pathname": "/references/currency/types/currency.EventMetadata" "pathname": "/references/currency/types/currency.EventMetadata"
@@ -1919,10 +1923,6 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/currency/types/currency.Message/page.mdx", "filePath": "/www/apps/resources/references/currency/types/currency.Message/page.mdx",
"pathname": "/references/currency/types/currency.Message" "pathname": "/references/currency/types/currency.Message"
}, },
{
"filePath": "/www/apps/resources/references/currency/types/currency.MessageBody/page.mdx",
"pathname": "/references/currency/types/currency.MessageBody"
},
{ {
"filePath": "/www/apps/resources/references/currency/types/currency.ModuleJoinerConfig/page.mdx", "filePath": "/www/apps/resources/references/currency/types/currency.ModuleJoinerConfig/page.mdx",
"pathname": "/references/currency/types/currency.ModuleJoinerConfig" "pathname": "/references/currency/types/currency.ModuleJoinerConfig"
@@ -2155,6 +2155,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/customer/interfaces/customer.UpdateCustomerAddressDTO/page.mdx", "filePath": "/www/apps/resources/references/customer/interfaces/customer.UpdateCustomerAddressDTO/page.mdx",
"pathname": "/references/customer/interfaces/customer.UpdateCustomerAddressDTO" "pathname": "/references/customer/interfaces/customer.UpdateCustomerAddressDTO"
}, },
{
"filePath": "/www/apps/resources/references/customer/types/customer.Event/page.mdx",
"pathname": "/references/customer/types/customer.Event"
},
{ {
"filePath": "/www/apps/resources/references/customer/types/customer.EventMetadata/page.mdx", "filePath": "/www/apps/resources/references/customer/types/customer.EventMetadata/page.mdx",
"pathname": "/references/customer/types/customer.EventMetadata" "pathname": "/references/customer/types/customer.EventMetadata"
@@ -2187,10 +2191,6 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/customer/types/customer.Message/page.mdx", "filePath": "/www/apps/resources/references/customer/types/customer.Message/page.mdx",
"pathname": "/references/customer/types/customer.Message" "pathname": "/references/customer/types/customer.Message"
}, },
{
"filePath": "/www/apps/resources/references/customer/types/customer.MessageBody/page.mdx",
"pathname": "/references/customer/types/customer.MessageBody"
},
{ {
"filePath": "/www/apps/resources/references/customer/types/customer.MetadataType/page.mdx", "filePath": "/www/apps/resources/references/customer/types/customer.MetadataType/page.mdx",
"pathname": "/references/customer/types/customer.MetadataType" "pathname": "/references/customer/types/customer.MetadataType"
@@ -3007,6 +3007,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/fulfillment/types/fulfillment.CreateGeoZoneDTO/page.mdx", "filePath": "/www/apps/resources/references/fulfillment/types/fulfillment.CreateGeoZoneDTO/page.mdx",
"pathname": "/references/fulfillment/types/fulfillment.CreateGeoZoneDTO" "pathname": "/references/fulfillment/types/fulfillment.CreateGeoZoneDTO"
}, },
{
"filePath": "/www/apps/resources/references/fulfillment/types/fulfillment.Event/page.mdx",
"pathname": "/references/fulfillment/types/fulfillment.Event"
},
{ {
"filePath": "/www/apps/resources/references/fulfillment/types/fulfillment.EventMetadata/page.mdx", "filePath": "/www/apps/resources/references/fulfillment/types/fulfillment.EventMetadata/page.mdx",
"pathname": "/references/fulfillment/types/fulfillment.EventMetadata" "pathname": "/references/fulfillment/types/fulfillment.EventMetadata"
@@ -3043,10 +3047,6 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/fulfillment/types/fulfillment.Message/page.mdx", "filePath": "/www/apps/resources/references/fulfillment/types/fulfillment.Message/page.mdx",
"pathname": "/references/fulfillment/types/fulfillment.Message" "pathname": "/references/fulfillment/types/fulfillment.Message"
}, },
{
"filePath": "/www/apps/resources/references/fulfillment/types/fulfillment.MessageBody/page.mdx",
"pathname": "/references/fulfillment/types/fulfillment.MessageBody"
},
{ {
"filePath": "/www/apps/resources/references/fulfillment/types/fulfillment.ModuleJoinerConfig/page.mdx", "filePath": "/www/apps/resources/references/fulfillment/types/fulfillment.ModuleJoinerConfig/page.mdx",
"pathname": "/references/fulfillment/types/fulfillment.ModuleJoinerConfig" "pathname": "/references/fulfillment/types/fulfillment.ModuleJoinerConfig"
@@ -3415,6 +3415,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/inventory_next/interfaces/inventory_next.UpdateReservationItemInput/page.mdx", "filePath": "/www/apps/resources/references/inventory_next/interfaces/inventory_next.UpdateReservationItemInput/page.mdx",
"pathname": "/references/inventory_next/interfaces/inventory_next.UpdateReservationItemInput" "pathname": "/references/inventory_next/interfaces/inventory_next.UpdateReservationItemInput"
}, },
{
"filePath": "/www/apps/resources/references/inventory_next/types/inventory_next.Event/page.mdx",
"pathname": "/references/inventory_next/types/inventory_next.Event"
},
{ {
"filePath": "/www/apps/resources/references/inventory_next/types/inventory_next.EventMetadata/page.mdx", "filePath": "/www/apps/resources/references/inventory_next/types/inventory_next.EventMetadata/page.mdx",
"pathname": "/references/inventory_next/types/inventory_next.EventMetadata" "pathname": "/references/inventory_next/types/inventory_next.EventMetadata"
@@ -3447,10 +3451,6 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/inventory_next/types/inventory_next.Message/page.mdx", "filePath": "/www/apps/resources/references/inventory_next/types/inventory_next.Message/page.mdx",
"pathname": "/references/inventory_next/types/inventory_next.Message" "pathname": "/references/inventory_next/types/inventory_next.Message"
}, },
{
"filePath": "/www/apps/resources/references/inventory_next/types/inventory_next.MessageBody/page.mdx",
"pathname": "/references/inventory_next/types/inventory_next.MessageBody"
},
{ {
"filePath": "/www/apps/resources/references/inventory_next/types/inventory_next.ModuleJoinerConfig/page.mdx", "filePath": "/www/apps/resources/references/inventory_next/types/inventory_next.ModuleJoinerConfig/page.mdx",
"pathname": "/references/inventory_next/types/inventory_next.ModuleJoinerConfig" "pathname": "/references/inventory_next/types/inventory_next.ModuleJoinerConfig"
@@ -3771,6 +3771,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/medusa/types/medusa.Constructor/page.mdx", "filePath": "/www/apps/resources/references/medusa/types/medusa.Constructor/page.mdx",
"pathname": "/references/medusa/types/medusa.Constructor" "pathname": "/references/medusa/types/medusa.Constructor"
}, },
{
"filePath": "/www/apps/resources/references/medusa/types/medusa.Event/page.mdx",
"pathname": "/references/medusa/types/medusa.Event"
},
{ {
"filePath": "/www/apps/resources/references/medusa/types/medusa.EventMetadata/page.mdx", "filePath": "/www/apps/resources/references/medusa/types/medusa.EventMetadata/page.mdx",
"pathname": "/references/medusa/types/medusa.EventMetadata" "pathname": "/references/medusa/types/medusa.EventMetadata"
@@ -3803,10 +3807,6 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/medusa/types/medusa.MedusaResponse/page.mdx", "filePath": "/www/apps/resources/references/medusa/types/medusa.MedusaResponse/page.mdx",
"pathname": "/references/medusa/types/medusa.MedusaResponse" "pathname": "/references/medusa/types/medusa.MedusaResponse"
}, },
{
"filePath": "/www/apps/resources/references/medusa/types/medusa.MessageBody/page.mdx",
"pathname": "/references/medusa/types/medusa.MessageBody"
},
{ {
"filePath": "/www/apps/resources/references/medusa/types/medusa.QueryConfig/page.mdx", "filePath": "/www/apps/resources/references/medusa/types/medusa.QueryConfig/page.mdx",
"pathname": "/references/medusa/types/medusa.QueryConfig" "pathname": "/references/medusa/types/medusa.QueryConfig"
@@ -4951,6 +4951,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/order/IOrderModuleService/methods/order.IOrderModuleService.updateReturns/page.mdx", "filePath": "/www/apps/resources/references/order/IOrderModuleService/methods/order.IOrderModuleService.updateReturns/page.mdx",
"pathname": "/references/order/IOrderModuleService/methods/order.IOrderModuleService.updateReturns" "pathname": "/references/order/IOrderModuleService/methods/order.IOrderModuleService.updateReturns"
}, },
{
"filePath": "/www/apps/resources/references/order/IOrderModuleService/methods/order.IOrderModuleService.updateShippingMethods/page.mdx",
"pathname": "/references/order/IOrderModuleService/methods/order.IOrderModuleService.updateShippingMethods"
},
{ {
"filePath": "/www/apps/resources/references/order/interfaces/order.BaseFilterable/page.mdx", "filePath": "/www/apps/resources/references/order/interfaces/order.BaseFilterable/page.mdx",
"pathname": "/references/order/interfaces/order.BaseFilterable" "pathname": "/references/order/interfaces/order.BaseFilterable"
@@ -5315,6 +5319,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/order/interfaces/order.UpdateOrderShippingMethodAdjustmentDTO/page.mdx", "filePath": "/www/apps/resources/references/order/interfaces/order.UpdateOrderShippingMethodAdjustmentDTO/page.mdx",
"pathname": "/references/order/interfaces/order.UpdateOrderShippingMethodAdjustmentDTO" "pathname": "/references/order/interfaces/order.UpdateOrderShippingMethodAdjustmentDTO"
}, },
{
"filePath": "/www/apps/resources/references/order/interfaces/order.UpdateOrderShippingMethodDTO/page.mdx",
"pathname": "/references/order/interfaces/order.UpdateOrderShippingMethodDTO"
},
{ {
"filePath": "/www/apps/resources/references/order/interfaces/order.UpdateOrderShippingMethodTaxLineDTO/page.mdx", "filePath": "/www/apps/resources/references/order/interfaces/order.UpdateOrderShippingMethodTaxLineDTO/page.mdx",
"pathname": "/references/order/interfaces/order.UpdateOrderShippingMethodTaxLineDTO" "pathname": "/references/order/interfaces/order.UpdateOrderShippingMethodTaxLineDTO"
@@ -5355,6 +5363,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/order/types/order.ClaimReason/page.mdx", "filePath": "/www/apps/resources/references/order/types/order.ClaimReason/page.mdx",
"pathname": "/references/order/types/order.ClaimReason" "pathname": "/references/order/types/order.ClaimReason"
}, },
{
"filePath": "/www/apps/resources/references/order/types/order.Event/page.mdx",
"pathname": "/references/order/types/order.Event"
},
{ {
"filePath": "/www/apps/resources/references/order/types/order.EventMetadata/page.mdx", "filePath": "/www/apps/resources/references/order/types/order.EventMetadata/page.mdx",
"pathname": "/references/order/types/order.EventMetadata" "pathname": "/references/order/types/order.EventMetadata"
@@ -5387,10 +5399,6 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/order/types/order.Message/page.mdx", "filePath": "/www/apps/resources/references/order/types/order.Message/page.mdx",
"pathname": "/references/order/types/order.Message" "pathname": "/references/order/types/order.Message"
}, },
{
"filePath": "/www/apps/resources/references/order/types/order.MessageBody/page.mdx",
"pathname": "/references/order/types/order.MessageBody"
},
{ {
"filePath": "/www/apps/resources/references/order/types/order.ModuleJoinerConfig/page.mdx", "filePath": "/www/apps/resources/references/order/types/order.ModuleJoinerConfig/page.mdx",
"pathname": "/references/order/types/order.ModuleJoinerConfig" "pathname": "/references/order/types/order.ModuleJoinerConfig"
@@ -5795,6 +5803,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/payment/types/payment.BigNumberValue/page.mdx", "filePath": "/www/apps/resources/references/payment/types/payment.BigNumberValue/page.mdx",
"pathname": "/references/payment/types/payment.BigNumberValue" "pathname": "/references/payment/types/payment.BigNumberValue"
}, },
{
"filePath": "/www/apps/resources/references/payment/types/payment.Event/page.mdx",
"pathname": "/references/payment/types/payment.Event"
},
{ {
"filePath": "/www/apps/resources/references/payment/types/payment.EventMetadata/page.mdx", "filePath": "/www/apps/resources/references/payment/types/payment.EventMetadata/page.mdx",
"pathname": "/references/payment/types/payment.EventMetadata" "pathname": "/references/payment/types/payment.EventMetadata"
@@ -5827,10 +5839,6 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/payment/types/payment.Message/page.mdx", "filePath": "/www/apps/resources/references/payment/types/payment.Message/page.mdx",
"pathname": "/references/payment/types/payment.Message" "pathname": "/references/payment/types/payment.Message"
}, },
{
"filePath": "/www/apps/resources/references/payment/types/payment.MessageBody/page.mdx",
"pathname": "/references/payment/types/payment.MessageBody"
},
{ {
"filePath": "/www/apps/resources/references/payment/types/payment.ModuleJoinerConfig/page.mdx", "filePath": "/www/apps/resources/references/payment/types/payment.ModuleJoinerConfig/page.mdx",
"pathname": "/references/payment/types/payment.ModuleJoinerConfig" "pathname": "/references/payment/types/payment.ModuleJoinerConfig"
@@ -6315,6 +6323,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/pricing/types/pricing.BigNumberValue/page.mdx", "filePath": "/www/apps/resources/references/pricing/types/pricing.BigNumberValue/page.mdx",
"pathname": "/references/pricing/types/pricing.BigNumberValue" "pathname": "/references/pricing/types/pricing.BigNumberValue"
}, },
{
"filePath": "/www/apps/resources/references/pricing/types/pricing.Event/page.mdx",
"pathname": "/references/pricing/types/pricing.Event"
},
{ {
"filePath": "/www/apps/resources/references/pricing/types/pricing.EventMetadata/page.mdx", "filePath": "/www/apps/resources/references/pricing/types/pricing.EventMetadata/page.mdx",
"pathname": "/references/pricing/types/pricing.EventMetadata" "pathname": "/references/pricing/types/pricing.EventMetadata"
@@ -6347,10 +6359,6 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/pricing/types/pricing.Message/page.mdx", "filePath": "/www/apps/resources/references/pricing/types/pricing.Message/page.mdx",
"pathname": "/references/pricing/types/pricing.Message" "pathname": "/references/pricing/types/pricing.Message"
}, },
{
"filePath": "/www/apps/resources/references/pricing/types/pricing.MessageBody/page.mdx",
"pathname": "/references/pricing/types/pricing.MessageBody"
},
{ {
"filePath": "/www/apps/resources/references/pricing/types/pricing.ModuleJoinerConfig/page.mdx", "filePath": "/www/apps/resources/references/pricing/types/pricing.ModuleJoinerConfig/page.mdx",
"pathname": "/references/pricing/types/pricing.ModuleJoinerConfig" "pathname": "/references/pricing/types/pricing.ModuleJoinerConfig"
@@ -6887,6 +6895,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/product/interfaces/product.UpsertProductVariantDTO/page.mdx", "filePath": "/www/apps/resources/references/product/interfaces/product.UpsertProductVariantDTO/page.mdx",
"pathname": "/references/product/interfaces/product.UpsertProductVariantDTO" "pathname": "/references/product/interfaces/product.UpsertProductVariantDTO"
}, },
{
"filePath": "/www/apps/resources/references/product/types/product.Event/page.mdx",
"pathname": "/references/product/types/product.Event"
},
{ {
"filePath": "/www/apps/resources/references/product/types/product.EventMetadata/page.mdx", "filePath": "/www/apps/resources/references/product/types/product.EventMetadata/page.mdx",
"pathname": "/references/product/types/product.EventMetadata" "pathname": "/references/product/types/product.EventMetadata"
@@ -6919,10 +6931,6 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/product/types/product.Message/page.mdx", "filePath": "/www/apps/resources/references/product/types/product.Message/page.mdx",
"pathname": "/references/product/types/product.Message" "pathname": "/references/product/types/product.Message"
}, },
{
"filePath": "/www/apps/resources/references/product/types/product.MessageBody/page.mdx",
"pathname": "/references/product/types/product.MessageBody"
},
{ {
"filePath": "/www/apps/resources/references/product/types/product.MetadataType/page.mdx", "filePath": "/www/apps/resources/references/product/types/product.MetadataType/page.mdx",
"pathname": "/references/product/types/product.MetadataType" "pathname": "/references/product/types/product.MetadataType"
@@ -7323,6 +7331,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/promotion/types/promotion.ComputeActions/page.mdx", "filePath": "/www/apps/resources/references/promotion/types/promotion.ComputeActions/page.mdx",
"pathname": "/references/promotion/types/promotion.ComputeActions" "pathname": "/references/promotion/types/promotion.ComputeActions"
}, },
{
"filePath": "/www/apps/resources/references/promotion/types/promotion.Event/page.mdx",
"pathname": "/references/promotion/types/promotion.Event"
},
{ {
"filePath": "/www/apps/resources/references/promotion/types/promotion.EventMetadata/page.mdx", "filePath": "/www/apps/resources/references/promotion/types/promotion.EventMetadata/page.mdx",
"pathname": "/references/promotion/types/promotion.EventMetadata" "pathname": "/references/promotion/types/promotion.EventMetadata"
@@ -7355,10 +7367,6 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/promotion/types/promotion.Message/page.mdx", "filePath": "/www/apps/resources/references/promotion/types/promotion.Message/page.mdx",
"pathname": "/references/promotion/types/promotion.Message" "pathname": "/references/promotion/types/promotion.Message"
}, },
{
"filePath": "/www/apps/resources/references/promotion/types/promotion.MessageBody/page.mdx",
"pathname": "/references/promotion/types/promotion.MessageBody"
},
{ {
"filePath": "/www/apps/resources/references/promotion/types/promotion.ModuleJoinerConfig/page.mdx", "filePath": "/www/apps/resources/references/promotion/types/promotion.ModuleJoinerConfig/page.mdx",
"pathname": "/references/promotion/types/promotion.ModuleJoinerConfig" "pathname": "/references/promotion/types/promotion.ModuleJoinerConfig"
@@ -7567,6 +7575,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/region/interfaces/region.UpsertRegionDTO/page.mdx", "filePath": "/www/apps/resources/references/region/interfaces/region.UpsertRegionDTO/page.mdx",
"pathname": "/references/region/interfaces/region.UpsertRegionDTO" "pathname": "/references/region/interfaces/region.UpsertRegionDTO"
}, },
{
"filePath": "/www/apps/resources/references/region/types/region.Event/page.mdx",
"pathname": "/references/region/types/region.Event"
},
{ {
"filePath": "/www/apps/resources/references/region/types/region.EventMetadata/page.mdx", "filePath": "/www/apps/resources/references/region/types/region.EventMetadata/page.mdx",
"pathname": "/references/region/types/region.EventMetadata" "pathname": "/references/region/types/region.EventMetadata"
@@ -7599,10 +7611,6 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/region/types/region.Message/page.mdx", "filePath": "/www/apps/resources/references/region/types/region.Message/page.mdx",
"pathname": "/references/region/types/region.Message" "pathname": "/references/region/types/region.Message"
}, },
{
"filePath": "/www/apps/resources/references/region/types/region.MessageBody/page.mdx",
"pathname": "/references/region/types/region.MessageBody"
},
{ {
"filePath": "/www/apps/resources/references/region/types/region.MetadataType/page.mdx", "filePath": "/www/apps/resources/references/region/types/region.MetadataType/page.mdx",
"pathname": "/references/region/types/region.MetadataType" "pathname": "/references/region/types/region.MetadataType"
@@ -7771,6 +7779,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/sales_channel/interfaces/sales_channel.UpsertSalesChannelDTO/page.mdx", "filePath": "/www/apps/resources/references/sales_channel/interfaces/sales_channel.UpsertSalesChannelDTO/page.mdx",
"pathname": "/references/sales_channel/interfaces/sales_channel.UpsertSalesChannelDTO" "pathname": "/references/sales_channel/interfaces/sales_channel.UpsertSalesChannelDTO"
}, },
{
"filePath": "/www/apps/resources/references/sales_channel/types/sales_channel.Event/page.mdx",
"pathname": "/references/sales_channel/types/sales_channel.Event"
},
{ {
"filePath": "/www/apps/resources/references/sales_channel/types/sales_channel.EventMetadata/page.mdx", "filePath": "/www/apps/resources/references/sales_channel/types/sales_channel.EventMetadata/page.mdx",
"pathname": "/references/sales_channel/types/sales_channel.EventMetadata" "pathname": "/references/sales_channel/types/sales_channel.EventMetadata"
@@ -7787,10 +7799,6 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/sales_channel/types/sales_channel.Message/page.mdx", "filePath": "/www/apps/resources/references/sales_channel/types/sales_channel.Message/page.mdx",
"pathname": "/references/sales_channel/types/sales_channel.Message" "pathname": "/references/sales_channel/types/sales_channel.Message"
}, },
{
"filePath": "/www/apps/resources/references/sales_channel/types/sales_channel.MessageBody/page.mdx",
"pathname": "/references/sales_channel/types/sales_channel.MessageBody"
},
{ {
"filePath": "/www/apps/resources/references/sales_channel/types/sales_channel.MetadataType/page.mdx", "filePath": "/www/apps/resources/references/sales_channel/types/sales_channel.MetadataType/page.mdx",
"pathname": "/references/sales_channel/types/sales_channel.MetadataType" "pathname": "/references/sales_channel/types/sales_channel.MetadataType"
@@ -7971,6 +7979,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/stock_location_next/types/stock_location_next.CreateStockLocationInput/page.mdx", "filePath": "/www/apps/resources/references/stock_location_next/types/stock_location_next.CreateStockLocationInput/page.mdx",
"pathname": "/references/stock_location_next/types/stock_location_next.CreateStockLocationInput" "pathname": "/references/stock_location_next/types/stock_location_next.CreateStockLocationInput"
}, },
{
"filePath": "/www/apps/resources/references/stock_location_next/types/stock_location_next.Event/page.mdx",
"pathname": "/references/stock_location_next/types/stock_location_next.Event"
},
{ {
"filePath": "/www/apps/resources/references/stock_location_next/types/stock_location_next.EventMetadata/page.mdx", "filePath": "/www/apps/resources/references/stock_location_next/types/stock_location_next.EventMetadata/page.mdx",
"pathname": "/references/stock_location_next/types/stock_location_next.EventMetadata" "pathname": "/references/stock_location_next/types/stock_location_next.EventMetadata"
@@ -8007,10 +8019,6 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/stock_location_next/types/stock_location_next.Message/page.mdx", "filePath": "/www/apps/resources/references/stock_location_next/types/stock_location_next.Message/page.mdx",
"pathname": "/references/stock_location_next/types/stock_location_next.Message" "pathname": "/references/stock_location_next/types/stock_location_next.Message"
}, },
{
"filePath": "/www/apps/resources/references/stock_location_next/types/stock_location_next.MessageBody/page.mdx",
"pathname": "/references/stock_location_next/types/stock_location_next.MessageBody"
},
{ {
"filePath": "/www/apps/resources/references/stock_location_next/types/stock_location_next.MetadataType/page.mdx", "filePath": "/www/apps/resources/references/stock_location_next/types/stock_location_next.MetadataType/page.mdx",
"pathname": "/references/stock_location_next/types/stock_location_next.MetadataType" "pathname": "/references/stock_location_next/types/stock_location_next.MetadataType"
@@ -8203,6 +8211,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/store/interfaces/store.UpsertStoreDTO/page.mdx", "filePath": "/www/apps/resources/references/store/interfaces/store.UpsertStoreDTO/page.mdx",
"pathname": "/references/store/interfaces/store.UpsertStoreDTO" "pathname": "/references/store/interfaces/store.UpsertStoreDTO"
}, },
{
"filePath": "/www/apps/resources/references/store/types/store.Event/page.mdx",
"pathname": "/references/store/types/store.Event"
},
{ {
"filePath": "/www/apps/resources/references/store/types/store.EventMetadata/page.mdx", "filePath": "/www/apps/resources/references/store/types/store.EventMetadata/page.mdx",
"pathname": "/references/store/types/store.EventMetadata" "pathname": "/references/store/types/store.EventMetadata"
@@ -8219,10 +8231,6 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/store/types/store.Message/page.mdx", "filePath": "/www/apps/resources/references/store/types/store.Message/page.mdx",
"pathname": "/references/store/types/store.Message" "pathname": "/references/store/types/store.Message"
}, },
{
"filePath": "/www/apps/resources/references/store/types/store.MessageBody/page.mdx",
"pathname": "/references/store/types/store.MessageBody"
},
{ {
"filePath": "/www/apps/resources/references/store/types/store.ModuleJoinerConfig/page.mdx", "filePath": "/www/apps/resources/references/store/types/store.ModuleJoinerConfig/page.mdx",
"pathname": "/references/store/types/store.ModuleJoinerConfig" "pathname": "/references/store/types/store.ModuleJoinerConfig"
@@ -8459,6 +8467,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/tax/types/tax.BigNumberRawValue/page.mdx", "filePath": "/www/apps/resources/references/tax/types/tax.BigNumberRawValue/page.mdx",
"pathname": "/references/tax/types/tax.BigNumberRawValue" "pathname": "/references/tax/types/tax.BigNumberRawValue"
}, },
{
"filePath": "/www/apps/resources/references/tax/types/tax.Event/page.mdx",
"pathname": "/references/tax/types/tax.Event"
},
{ {
"filePath": "/www/apps/resources/references/tax/types/tax.EventMetadata/page.mdx", "filePath": "/www/apps/resources/references/tax/types/tax.EventMetadata/page.mdx",
"pathname": "/references/tax/types/tax.EventMetadata" "pathname": "/references/tax/types/tax.EventMetadata"
@@ -8491,10 +8503,6 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/tax/types/tax.Message/page.mdx", "filePath": "/www/apps/resources/references/tax/types/tax.Message/page.mdx",
"pathname": "/references/tax/types/tax.Message" "pathname": "/references/tax/types/tax.Message"
}, },
{
"filePath": "/www/apps/resources/references/tax/types/tax.MessageBody/page.mdx",
"pathname": "/references/tax/types/tax.MessageBody"
},
{ {
"filePath": "/www/apps/resources/references/tax/types/tax.MetadataType/page.mdx", "filePath": "/www/apps/resources/references/tax/types/tax.MetadataType/page.mdx",
"pathname": "/references/tax/types/tax.MetadataType" "pathname": "/references/tax/types/tax.MetadataType"
@@ -8875,6 +8883,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/EventBusTypes/interfaces/types.EventBusTypes.IEventBusService/page.mdx", "filePath": "/www/apps/resources/references/types/EventBusTypes/interfaces/types.EventBusTypes.IEventBusService/page.mdx",
"pathname": "/references/types/EventBusTypes/interfaces/types.EventBusTypes.IEventBusService" "pathname": "/references/types/EventBusTypes/interfaces/types.EventBusTypes.IEventBusService"
}, },
{
"filePath": "/www/apps/resources/references/types/EventBusTypes/types/types.EventBusTypes.Event/page.mdx",
"pathname": "/references/types/EventBusTypes/types/types.EventBusTypes.Event"
},
{ {
"filePath": "/www/apps/resources/references/types/EventBusTypes/types/types.EventBusTypes.EventMetadata/page.mdx", "filePath": "/www/apps/resources/references/types/EventBusTypes/types/types.EventBusTypes.EventMetadata/page.mdx",
"pathname": "/references/types/EventBusTypes/types/types.EventBusTypes.EventMetadata" "pathname": "/references/types/EventBusTypes/types/types.EventBusTypes.EventMetadata"
@@ -8883,10 +8895,6 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/EventBusTypes/types/types.EventBusTypes.Message/page.mdx", "filePath": "/www/apps/resources/references/types/EventBusTypes/types/types.EventBusTypes.Message/page.mdx",
"pathname": "/references/types/EventBusTypes/types/types.EventBusTypes.Message" "pathname": "/references/types/EventBusTypes/types/types.EventBusTypes.Message"
}, },
{
"filePath": "/www/apps/resources/references/types/EventBusTypes/types/types.EventBusTypes.MessageBody/page.mdx",
"pathname": "/references/types/EventBusTypes/types/types.EventBusTypes.MessageBody"
},
{ {
"filePath": "/www/apps/resources/references/types/EventBusTypes/types/types.EventBusTypes.RawMessageFormat/page.mdx", "filePath": "/www/apps/resources/references/types/EventBusTypes/types/types.EventBusTypes.RawMessageFormat/page.mdx",
"pathname": "/references/types/EventBusTypes/types/types.EventBusTypes.RawMessageFormat" "pathname": "/references/types/EventBusTypes/types/types.EventBusTypes.RawMessageFormat"
@@ -10551,6 +10559,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/user/interfaces/user.UserDTO/page.mdx", "filePath": "/www/apps/resources/references/user/interfaces/user.UserDTO/page.mdx",
"pathname": "/references/user/interfaces/user.UserDTO" "pathname": "/references/user/interfaces/user.UserDTO"
}, },
{
"filePath": "/www/apps/resources/references/user/types/user.Event/page.mdx",
"pathname": "/references/user/types/user.Event"
},
{ {
"filePath": "/www/apps/resources/references/user/types/user.EventMetadata/page.mdx", "filePath": "/www/apps/resources/references/user/types/user.EventMetadata/page.mdx",
"pathname": "/references/user/types/user.EventMetadata" "pathname": "/references/user/types/user.EventMetadata"
@@ -10567,10 +10579,6 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/user/types/user.Message/page.mdx", "filePath": "/www/apps/resources/references/user/types/user.Message/page.mdx",
"pathname": "/references/user/types/user.Message" "pathname": "/references/user/types/user.Message"
}, },
{
"filePath": "/www/apps/resources/references/user/types/user.MessageBody/page.mdx",
"pathname": "/references/user/types/user.MessageBody"
},
{ {
"filePath": "/www/apps/resources/references/user/types/user.ModuleJoinerConfig/page.mdx", "filePath": "/www/apps/resources/references/user/types/user.ModuleJoinerConfig/page.mdx",
"pathname": "/references/user/types/user.ModuleJoinerConfig" "pathname": "/references/user/types/user.ModuleJoinerConfig"
+7
View File
@@ -3185,6 +3185,13 @@ export const generatedSidebar = [
"path": "/references/order/updateReturns", "path": "/references/order/updateReturns",
"title": "updateReturns", "title": "updateReturns",
"children": [] "children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/updateShippingMethods",
"title": "updateShippingMethods",
"children": []
} }
] ]
} }
@@ -2634,6 +2634,11 @@ export const slugChanges = [
"newSlug": "/references/order/updateReturns", "newSlug": "/references/order/updateReturns",
"filePath": "/www/apps/resources/references/order/IOrderModuleService/methods/order.IOrderModuleService.updateReturns/page.mdx" "filePath": "/www/apps/resources/references/order/IOrderModuleService/methods/order.IOrderModuleService.updateReturns/page.mdx"
}, },
{
"origSlug": "/references/order/IOrderModuleService/methods/order.IOrderModuleService.updateShippingMethods",
"newSlug": "/references/order/updateShippingMethods",
"filePath": "/www/apps/resources/references/order/IOrderModuleService/methods/order.IOrderModuleService.updateShippingMethods/page.mdx"
},
{ {
"origSlug": "/references/order/interfaces/order.IOrderModuleService", "origSlug": "/references/order/interfaces/order.IOrderModuleService",
"newSlug": "/references/order", "newSlug": "/references/order",
@@ -12,4 +12,4 @@ import { TypeList } from "docs-ui"
## Returns ## Returns
<TypeList types={[{"name":"Record","type":"`Record<string, [Message](../../../types/api_key.Message/page.mdx)[]>`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"Message[]","type":"[Message](../../../types/api_key.Message/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"Message","type":"[MessageBody](../../../types/api_key.MessageBody/page.mdx)&#60;TData&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="getMessages"/> <TypeList types={[{"name":"Record","type":"`Record<string, [Message](../../../types/api_key.Message/page.mdx)[]>`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"Message[]","type":"[Message](../../../types/api_key.Message/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"Message","type":"[Event](../../../types/api_key.Event/page.mdx)&#60;TData&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="getMessages"/>
@@ -8,7 +8,7 @@ import { TypeList } from "docs-ui"
## Parameters ## Parameters
<TypeList types={[{"name":"msg","type":"[Message](../../../types/api_key.Message/page.mdx) \\| [Message](../../../types/api_key.Message/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"eventName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[EventMetadata](../../../types/api_key.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="save"/> <TypeList types={[{"name":"msg","type":"[Message](../../../types/api_key.Message/page.mdx) \\| [Message](../../../types/api_key.Message/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[EventMetadata](../../../types/api_key.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="save"/>
## Returns ## Returns
@@ -0,0 +1,13 @@
---
displayed_sidebar: apiKeyReference
---
import { TypeList } from "docs-ui"
# Event
**Event**: `Object`
## Properties
<TypeList types={[{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[EventMetadata](../api_key.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="Event"/>
@@ -6,4 +6,4 @@ import { TypeList } from "docs-ui"
# Message # Message
**Message**: [MessageBody](../api_key.MessageBody/page.mdx)&#60;TData&#62; & `object` **Message**: [Event](../api_key.Event/page.mdx)&#60;TData&#62; & `object`
@@ -1,13 +0,0 @@
---
displayed_sidebar: apiKeyReference
---
import { TypeList } from "docs-ui"
# MessageBody
**MessageBody**: `Object`
## Properties
<TypeList types={[{"name":"eventName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[EventMetadata](../api_key.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="MessageBody"/>
@@ -12,4 +12,4 @@ import { TypeList } from "docs-ui"
## Returns ## Returns
<TypeList types={[{"name":"Record","type":"`Record<string, [Message](../../../types/auth.Message/page.mdx)[]>`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"Message[]","type":"[Message](../../../types/auth.Message/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"Message","type":"[MessageBody](../../../types/auth.MessageBody/page.mdx)&#60;TData&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="getMessages"/> <TypeList types={[{"name":"Record","type":"`Record<string, [Message](../../../types/auth.Message/page.mdx)[]>`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"Message[]","type":"[Message](../../../types/auth.Message/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"Message","type":"[Event](../../../types/auth.Event/page.mdx)&#60;TData&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="getMessages"/>
@@ -8,7 +8,7 @@ import { TypeList } from "docs-ui"
## Parameters ## Parameters
<TypeList types={[{"name":"msg","type":"[Message](../../../types/auth.Message/page.mdx) \\| [Message](../../../types/auth.Message/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"eventName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[EventMetadata](../../../types/auth.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="save"/> <TypeList types={[{"name":"msg","type":"[Message](../../../types/auth.Message/page.mdx) \\| [Message](../../../types/auth.Message/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[EventMetadata](../../../types/auth.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="save"/>
## Returns ## Returns
@@ -0,0 +1,13 @@
---
displayed_sidebar: authReference
---
import { TypeList } from "docs-ui"
# Event
**Event**: `Object`
## Properties
<TypeList types={[{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[EventMetadata](../auth.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="Event"/>
@@ -6,4 +6,4 @@ import { TypeList } from "docs-ui"
# Message # Message
**Message**: [MessageBody](../auth.MessageBody/page.mdx)&#60;TData&#62; & `object` **Message**: [Event](../auth.Event/page.mdx)&#60;TData&#62; & `object`
@@ -1,13 +0,0 @@
---
displayed_sidebar: authReference
---
import { TypeList } from "docs-ui"
# MessageBody
**MessageBody**: `Object`
## Properties
<TypeList types={[{"name":"eventName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[EventMetadata](../auth.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="MessageBody"/>
@@ -12,4 +12,4 @@ import { TypeList } from "docs-ui"
## Returns ## Returns
<TypeList types={[{"name":"Record","type":"`Record<string, [Message](../../../types/cart.Message/page.mdx)[]>`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"Message[]","type":"[Message](../../../types/cart.Message/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"Message","type":"[MessageBody](../../../types/cart.MessageBody/page.mdx)&#60;TData&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="getMessages"/> <TypeList types={[{"name":"Record","type":"`Record<string, [Message](../../../types/cart.Message/page.mdx)[]>`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"Message[]","type":"[Message](../../../types/cart.Message/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"Message","type":"[Event](../../../types/cart.Event/page.mdx)&#60;TData&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="getMessages"/>
@@ -8,7 +8,7 @@ import { TypeList } from "docs-ui"
## Parameters ## Parameters
<TypeList types={[{"name":"msg","type":"[Message](../../../types/cart.Message/page.mdx) \\| [Message](../../../types/cart.Message/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"eventName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[EventMetadata](../../../types/cart.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="save"/> <TypeList types={[{"name":"msg","type":"[Message](../../../types/cart.Message/page.mdx) \\| [Message](../../../types/cart.Message/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[EventMetadata](../../../types/cart.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="save"/>
## Returns ## Returns
@@ -0,0 +1,13 @@
---
displayed_sidebar: cartReference
---
import { TypeList } from "docs-ui"
# Event
**Event**: `Object`
## Properties
<TypeList types={[{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[EventMetadata](../cart.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="Event"/>
@@ -6,4 +6,4 @@ import { TypeList } from "docs-ui"
# Message # Message
**Message**: [MessageBody](../cart.MessageBody/page.mdx)&#60;TData&#62; & `object` **Message**: [Event](../cart.Event/page.mdx)&#60;TData&#62; & `object`
@@ -1,13 +0,0 @@
---
displayed_sidebar: cartReference
---
import { TypeList } from "docs-ui"
# MessageBody
**MessageBody**: `Object`
## Properties
<TypeList types={[{"name":"eventName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[EventMetadata](../cart.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="MessageBody"/>
@@ -12,4 +12,4 @@ import { TypeList } from "docs-ui"
## Returns ## Returns
<TypeList types={[{"name":"Record","type":"`Record<string, [Message](../../../types/currency.Message/page.mdx)[]>`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"Message[]","type":"[Message](../../../types/currency.Message/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"Message","type":"[MessageBody](../../../types/currency.MessageBody/page.mdx)&#60;TData&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="getMessages"/> <TypeList types={[{"name":"Record","type":"`Record<string, [Message](../../../types/currency.Message/page.mdx)[]>`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"Message[]","type":"[Message](../../../types/currency.Message/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"Message","type":"[Event](../../../types/currency.Event/page.mdx)&#60;TData&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="getMessages"/>
@@ -8,7 +8,7 @@ import { TypeList } from "docs-ui"
## Parameters ## Parameters
<TypeList types={[{"name":"msg","type":"[Message](../../../types/currency.Message/page.mdx) \\| [Message](../../../types/currency.Message/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"eventName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[EventMetadata](../../../types/currency.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="save"/> <TypeList types={[{"name":"msg","type":"[Message](../../../types/currency.Message/page.mdx) \\| [Message](../../../types/currency.Message/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[EventMetadata](../../../types/currency.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="save"/>
## Returns ## Returns
@@ -0,0 +1,13 @@
---
displayed_sidebar: currencyReference
---
import { TypeList } from "docs-ui"
# Event
**Event**: `Object`
## Properties
<TypeList types={[{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[EventMetadata](../currency.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="Event"/>
@@ -6,4 +6,4 @@ import { TypeList } from "docs-ui"
# Message # Message
**Message**: [MessageBody](../currency.MessageBody/page.mdx)&#60;TData&#62; & `object` **Message**: [Event](../currency.Event/page.mdx)&#60;TData&#62; & `object`
@@ -1,13 +0,0 @@
---
displayed_sidebar: currencyReference
---
import { TypeList } from "docs-ui"
# MessageBody
**MessageBody**: `Object`
## Properties
<TypeList types={[{"name":"eventName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[EventMetadata](../currency.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="MessageBody"/>
@@ -12,4 +12,4 @@ import { TypeList } from "docs-ui"
## Returns ## Returns
<TypeList types={[{"name":"Record","type":"`Record<string, [Message](../../../types/customer.Message/page.mdx)[]>`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"Message[]","type":"[Message](../../../types/customer.Message/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"Message","type":"[MessageBody](../../../types/customer.MessageBody/page.mdx)&#60;TData&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="getMessages"/> <TypeList types={[{"name":"Record","type":"`Record<string, [Message](../../../types/customer.Message/page.mdx)[]>`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"Message[]","type":"[Message](../../../types/customer.Message/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"Message","type":"[Event](../../../types/customer.Event/page.mdx)&#60;TData&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="getMessages"/>
@@ -8,7 +8,7 @@ import { TypeList } from "docs-ui"
## Parameters ## Parameters
<TypeList types={[{"name":"msg","type":"[Message](../../../types/customer.Message/page.mdx) \\| [Message](../../../types/customer.Message/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"eventName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[EventMetadata](../../../types/customer.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="save"/> <TypeList types={[{"name":"msg","type":"[Message](../../../types/customer.Message/page.mdx) \\| [Message](../../../types/customer.Message/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[EventMetadata](../../../types/customer.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="save"/>
## Returns ## Returns
@@ -0,0 +1,13 @@
---
displayed_sidebar: customerReference
---
import { TypeList } from "docs-ui"
# Event
**Event**: `Object`
## Properties
<TypeList types={[{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[EventMetadata](../customer.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="Event"/>
@@ -6,4 +6,4 @@ import { TypeList } from "docs-ui"
# Message # Message
**Message**: [MessageBody](../customer.MessageBody/page.mdx)&#60;TData&#62; & `object` **Message**: [Event](../customer.Event/page.mdx)&#60;TData&#62; & `object`
@@ -1,13 +0,0 @@
---
displayed_sidebar: customerReference
---
import { TypeList } from "docs-ui"
# MessageBody
**MessageBody**: `Object`
## Properties
<TypeList types={[{"name":"eventName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[EventMetadata](../customer.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="MessageBody"/>
@@ -12,4 +12,4 @@ import { TypeList } from "docs-ui"
## Returns ## Returns
<TypeList types={[{"name":"Record","type":"`Record<string, [Message](../../../types/fulfillment.Message/page.mdx)[]>`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"Message[]","type":"[Message](../../../types/fulfillment.Message/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"Message","type":"[MessageBody](../../../types/fulfillment.MessageBody/page.mdx)&#60;TData&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="getMessages"/> <TypeList types={[{"name":"Record","type":"`Record<string, [Message](../../../types/fulfillment.Message/page.mdx)[]>`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"Message[]","type":"[Message](../../../types/fulfillment.Message/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"Message","type":"[Event](../../../types/fulfillment.Event/page.mdx)&#60;TData&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="getMessages"/>
@@ -8,7 +8,7 @@ import { TypeList } from "docs-ui"
## Parameters ## Parameters
<TypeList types={[{"name":"msg","type":"[Message](../../../types/fulfillment.Message/page.mdx) \\| [Message](../../../types/fulfillment.Message/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"eventName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[EventMetadata](../../../types/fulfillment.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="save"/> <TypeList types={[{"name":"msg","type":"[Message](../../../types/fulfillment.Message/page.mdx) \\| [Message](../../../types/fulfillment.Message/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[EventMetadata](../../../types/fulfillment.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="save"/>
## Returns ## Returns
@@ -0,0 +1,13 @@
---
displayed_sidebar: fulfillmentReference
---
import { TypeList } from "docs-ui"
# Event
**Event**: `Object`
## Properties
<TypeList types={[{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[EventMetadata](../fulfillment.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="Event"/>
@@ -6,4 +6,4 @@ import { TypeList } from "docs-ui"
# Message # Message
**Message**: [MessageBody](../fulfillment.MessageBody/page.mdx)&#60;TData&#62; & `object` **Message**: [Event](../fulfillment.Event/page.mdx)&#60;TData&#62; & `object`
@@ -1,13 +0,0 @@
---
displayed_sidebar: fulfillmentReference
---
import { TypeList } from "docs-ui"
# MessageBody
**MessageBody**: `Object`
## Properties
<TypeList types={[{"name":"eventName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[EventMetadata](../fulfillment.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="MessageBody"/>
@@ -12,4 +12,4 @@ import { TypeList } from "docs-ui"
## Returns ## Returns
<TypeList types={[{"name":"Record","type":"`Record<string, [Message](../../../types/inventory_next.Message/page.mdx)[]>`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"Message[]","type":"[Message](../../../types/inventory_next.Message/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"Message","type":"[MessageBody](../../../types/inventory_next.MessageBody/page.mdx)&#60;TData&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="getMessages"/> <TypeList types={[{"name":"Record","type":"`Record<string, [Message](../../../types/inventory_next.Message/page.mdx)[]>`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"Message[]","type":"[Message](../../../types/inventory_next.Message/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"Message","type":"[Event](../../../types/inventory_next.Event/page.mdx)&#60;TData&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="getMessages"/>
@@ -8,7 +8,7 @@ import { TypeList } from "docs-ui"
## Parameters ## Parameters
<TypeList types={[{"name":"msg","type":"[Message](../../../types/inventory_next.Message/page.mdx) \\| [Message](../../../types/inventory_next.Message/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"eventName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[EventMetadata](../../../types/inventory_next.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="save"/> <TypeList types={[{"name":"msg","type":"[Message](../../../types/inventory_next.Message/page.mdx) \\| [Message](../../../types/inventory_next.Message/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[EventMetadata](../../../types/inventory_next.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="save"/>
## Returns ## Returns
@@ -0,0 +1,13 @@
---
displayed_sidebar: inventoryNextReference
---
import { TypeList } from "docs-ui"
# Event
**Event**: `Object`
## Properties
<TypeList types={[{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[EventMetadata](../inventory_next.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="Event"/>
@@ -6,4 +6,4 @@ import { TypeList } from "docs-ui"
# Message # Message
**Message**: [MessageBody](../inventory_next.MessageBody/page.mdx)&#60;TData&#62; & `object` **Message**: [Event](../inventory_next.Event/page.mdx)&#60;TData&#62; & `object`
@@ -1,13 +0,0 @@
---
displayed_sidebar: inventoryNextReference
---
import { TypeList } from "docs-ui"
# MessageBody
**MessageBody**: `Object`
## Properties
<TypeList types={[{"name":"eventName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[EventMetadata](../inventory_next.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="MessageBody"/>
@@ -0,0 +1,13 @@
import { TypeList } from "docs-ui"
# Event
**Event**: `Object`
## Type Parameters
<TypeList types={[{"name":"TData","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records" sectionTitle="Event"/>
## Properties
<TypeList types={[{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[EventMetadata](../medusa.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records" sectionTitle="Event"/>
@@ -1,13 +0,0 @@
import { TypeList } from "docs-ui"
# MessageBody
**MessageBody**: `Object`
## Type Parameters
<TypeList types={[{"name":"TData","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records" sectionTitle="MessageBody"/>
## Properties
<TypeList types={[{"name":"eventName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[EventMetadata](../medusa.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records" sectionTitle="MessageBody"/>
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
## Properties ## Properties
<TypeList types={[{"name":"data","type":"[MessageBody](../medusa.MessageBody/page.mdx)&#60;T&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"eventName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[EventMetadata](../medusa.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"eventName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"container","type":"[MedusaContainer](../medusa.MedusaContainer/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"pluginOptions","type":"`Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records" sectionTitle="SubscriberArgs"/> <TypeList types={[{"name":"event","type":"[Event](../medusa.Event/page.mdx)&#60;T&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[EventMetadata](../medusa.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"container","type":"[MedusaContainer](../medusa.MedusaContainer/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"pluginOptions","type":"`Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records" sectionTitle="SubscriberArgs"/>
@@ -24,7 +24,7 @@ import { TypeList } from "docs-ui"
- [ApiKeyType](../../api_key/types/api_key.ApiKeyType/page.mdx) - [ApiKeyType](../../api_key/types/api_key.ApiKeyType/page.mdx)
- [EventMetadata](../../api_key/types/api_key.EventMetadata/page.mdx) - [EventMetadata](../../api_key/types/api_key.EventMetadata/page.mdx)
- [MessageBody](../../api_key/types/api_key.MessageBody/page.mdx) - [Event](../../api_key/types/api_key.Event/page.mdx)
- [Message](../../api_key/types/api_key.Message/page.mdx) - [Message](../../api_key/types/api_key.Message/page.mdx)
- [RawMessageFormat](../../api_key/types/api_key.RawMessageFormat/page.mdx) - [RawMessageFormat](../../api_key/types/api_key.RawMessageFormat/page.mdx)
- [JoinerRelationship](../../api_key/types/api_key.JoinerRelationship/page.mdx) - [JoinerRelationship](../../api_key/types/api_key.JoinerRelationship/page.mdx)
@@ -25,7 +25,7 @@ import { TypeList } from "docs-ui"
## Type Aliases ## Type Aliases
- [EventMetadata](../../auth/types/auth.EventMetadata/page.mdx) - [EventMetadata](../../auth/types/auth.EventMetadata/page.mdx)
- [MessageBody](../../auth/types/auth.MessageBody/page.mdx) - [Event](../../auth/types/auth.Event/page.mdx)
- [Message](../../auth/types/auth.Message/page.mdx) - [Message](../../auth/types/auth.Message/page.mdx)
- [RawMessageFormat](../../auth/types/auth.RawMessageFormat/page.mdx) - [RawMessageFormat](../../auth/types/auth.RawMessageFormat/page.mdx)
- [JoinerRelationship](../../auth/types/auth.JoinerRelationship/page.mdx) - [JoinerRelationship](../../auth/types/auth.JoinerRelationship/page.mdx)
@@ -72,7 +72,7 @@ import { TypeList } from "docs-ui"
- [PrevLimit](../../cart/types/cart.PrevLimit/page.mdx) - [PrevLimit](../../cart/types/cart.PrevLimit/page.mdx)
- [FilterQuery](../../cart/types/cart.FilterQuery/page.mdx) - [FilterQuery](../../cart/types/cart.FilterQuery/page.mdx)
- [EventMetadata](../../cart/types/cart.EventMetadata/page.mdx) - [EventMetadata](../../cart/types/cart.EventMetadata/page.mdx)
- [MessageBody](../../cart/types/cart.MessageBody/page.mdx) - [Event](../../cart/types/cart.Event/page.mdx)
- [Message](../../cart/types/cart.Message/page.mdx) - [Message](../../cart/types/cart.Message/page.mdx)
- [RawMessageFormat](../../cart/types/cart.RawMessageFormat/page.mdx) - [RawMessageFormat](../../cart/types/cart.RawMessageFormat/page.mdx)
- [JoinerRelationship](../../cart/types/cart.JoinerRelationship/page.mdx) - [JoinerRelationship](../../cart/types/cart.JoinerRelationship/page.mdx)
@@ -19,7 +19,7 @@ import { TypeList } from "docs-ui"
## Type Aliases ## Type Aliases
- [EventMetadata](../../currency/types/currency.EventMetadata/page.mdx) - [EventMetadata](../../currency/types/currency.EventMetadata/page.mdx)
- [MessageBody](../../currency/types/currency.MessageBody/page.mdx) - [Event](../../currency/types/currency.Event/page.mdx)
- [Message](../../currency/types/currency.Message/page.mdx) - [Message](../../currency/types/currency.Message/page.mdx)
- [RawMessageFormat](../../currency/types/currency.RawMessageFormat/page.mdx) - [RawMessageFormat](../../currency/types/currency.RawMessageFormat/page.mdx)
- [JoinerRelationship](../../currency/types/currency.JoinerRelationship/page.mdx) - [JoinerRelationship](../../currency/types/currency.JoinerRelationship/page.mdx)
@@ -45,7 +45,7 @@ import { TypeList } from "docs-ui"
- [PrevLimit](../../customer/types/customer.PrevLimit/page.mdx) - [PrevLimit](../../customer/types/customer.PrevLimit/page.mdx)
- [FilterQuery](../../customer/types/customer.FilterQuery/page.mdx) - [FilterQuery](../../customer/types/customer.FilterQuery/page.mdx)
- [EventMetadata](../../customer/types/customer.EventMetadata/page.mdx) - [EventMetadata](../../customer/types/customer.EventMetadata/page.mdx)
- [MessageBody](../../customer/types/customer.MessageBody/page.mdx) - [Event](../../customer/types/customer.Event/page.mdx)
- [Message](../../customer/types/customer.Message/page.mdx) - [Message](../../customer/types/customer.Message/page.mdx)
- [RawMessageFormat](../../customer/types/customer.RawMessageFormat/page.mdx) - [RawMessageFormat](../../customer/types/customer.RawMessageFormat/page.mdx)
- [JoinerRelationship](../../customer/types/customer.JoinerRelationship/page.mdx) - [JoinerRelationship](../../customer/types/customer.JoinerRelationship/page.mdx)
@@ -99,7 +99,7 @@ import { TypeList } from "docs-ui"
- [PrevLimit](../../fulfillment/types/fulfillment.PrevLimit/page.mdx) - [PrevLimit](../../fulfillment/types/fulfillment.PrevLimit/page.mdx)
- [FilterQuery](../../fulfillment/types/fulfillment.FilterQuery/page.mdx) - [FilterQuery](../../fulfillment/types/fulfillment.FilterQuery/page.mdx)
- [EventMetadata](../../fulfillment/types/fulfillment.EventMetadata/page.mdx) - [EventMetadata](../../fulfillment/types/fulfillment.EventMetadata/page.mdx)
- [MessageBody](../../fulfillment/types/fulfillment.MessageBody/page.mdx) - [Event](../../fulfillment/types/fulfillment.Event/page.mdx)
- [Message](../../fulfillment/types/fulfillment.Message/page.mdx) - [Message](../../fulfillment/types/fulfillment.Message/page.mdx)
- [RawMessageFormat](../../fulfillment/types/fulfillment.RawMessageFormat/page.mdx) - [RawMessageFormat](../../fulfillment/types/fulfillment.RawMessageFormat/page.mdx)
- [GeoZoneType](../../fulfillment/types/fulfillment.GeoZoneType/page.mdx) - [GeoZoneType](../../fulfillment/types/fulfillment.GeoZoneType/page.mdx)
@@ -43,7 +43,7 @@ import { TypeList } from "docs-ui"
- [PrevLimit](../../inventory_next/types/inventory_next.PrevLimit/page.mdx) - [PrevLimit](../../inventory_next/types/inventory_next.PrevLimit/page.mdx)
- [FilterQuery](../../inventory_next/types/inventory_next.FilterQuery/page.mdx) - [FilterQuery](../../inventory_next/types/inventory_next.FilterQuery/page.mdx)
- [EventMetadata](../../inventory_next/types/inventory_next.EventMetadata/page.mdx) - [EventMetadata](../../inventory_next/types/inventory_next.EventMetadata/page.mdx)
- [MessageBody](../../inventory_next/types/inventory_next.MessageBody/page.mdx) - [Event](../../inventory_next/types/inventory_next.Event/page.mdx)
- [Message](../../inventory_next/types/inventory_next.Message/page.mdx) - [Message](../../inventory_next/types/inventory_next.Message/page.mdx)
- [RawMessageFormat](../../inventory_next/types/inventory_next.RawMessageFormat/page.mdx) - [RawMessageFormat](../../inventory_next/types/inventory_next.RawMessageFormat/page.mdx)
- [JoinerRelationship](../../inventory_next/types/inventory_next.JoinerRelationship/page.mdx) - [JoinerRelationship](../../inventory_next/types/inventory_next.JoinerRelationship/page.mdx)
@@ -15,7 +15,7 @@ import { TypeList } from "docs-ui"
- [MedusaContainer](../../medusa/types/medusa.MedusaContainer/page.mdx) - [MedusaContainer](../../medusa/types/medusa.MedusaContainer/page.mdx)
- [EventMetadata](../../medusa/types/medusa.EventMetadata/page.mdx) - [EventMetadata](../../medusa/types/medusa.EventMetadata/page.mdx)
- [MessageBody](../../medusa/types/medusa.MessageBody/page.mdx) - [Event](../../medusa/types/medusa.Event/page.mdx)
- [MedusaPricingContext](../../medusa/types/medusa.MedusaPricingContext/page.mdx) - [MedusaPricingContext](../../medusa/types/medusa.MedusaPricingContext/page.mdx)
- [QueryConfig](../../medusa/types/medusa.QueryConfig/page.mdx) - [QueryConfig](../../medusa/types/medusa.QueryConfig/page.mdx)
- [ClassConstructor](../../medusa/types/medusa.ClassConstructor/page.mdx) - [ClassConstructor](../../medusa/types/medusa.ClassConstructor/page.mdx)
@@ -63,6 +63,7 @@ import { TypeList } from "docs-ui"
- [UpdateOrderLineItemWithSelectorDTO](../../order/interfaces/order.UpdateOrderLineItemWithSelectorDTO/page.mdx) - [UpdateOrderLineItemWithSelectorDTO](../../order/interfaces/order.UpdateOrderLineItemWithSelectorDTO/page.mdx)
- [UpdateOrderLineItemDTO](../../order/interfaces/order.UpdateOrderLineItemDTO/page.mdx) - [UpdateOrderLineItemDTO](../../order/interfaces/order.UpdateOrderLineItemDTO/page.mdx)
- [CreateOrderShippingMethodDTO](../../order/interfaces/order.CreateOrderShippingMethodDTO/page.mdx) - [CreateOrderShippingMethodDTO](../../order/interfaces/order.CreateOrderShippingMethodDTO/page.mdx)
- [UpdateOrderShippingMethodDTO](../../order/interfaces/order.UpdateOrderShippingMethodDTO/page.mdx)
- [CreateOrderShippingMethodAdjustmentDTO](../../order/interfaces/order.CreateOrderShippingMethodAdjustmentDTO/page.mdx) - [CreateOrderShippingMethodAdjustmentDTO](../../order/interfaces/order.CreateOrderShippingMethodAdjustmentDTO/page.mdx)
- [UpdateOrderShippingMethodAdjustmentDTO](../../order/interfaces/order.UpdateOrderShippingMethodAdjustmentDTO/page.mdx) - [UpdateOrderShippingMethodAdjustmentDTO](../../order/interfaces/order.UpdateOrderShippingMethodAdjustmentDTO/page.mdx)
- [CreateOrderChangeDTO](../../order/interfaces/order.CreateOrderChangeDTO/page.mdx) - [CreateOrderChangeDTO](../../order/interfaces/order.CreateOrderChangeDTO/page.mdx)
@@ -114,7 +115,7 @@ import { TypeList } from "docs-ui"
- [PrevLimit](../../order/types/order.PrevLimit/page.mdx) - [PrevLimit](../../order/types/order.PrevLimit/page.mdx)
- [FilterQuery](../../order/types/order.FilterQuery/page.mdx) - [FilterQuery](../../order/types/order.FilterQuery/page.mdx)
- [EventMetadata](../../order/types/order.EventMetadata/page.mdx) - [EventMetadata](../../order/types/order.EventMetadata/page.mdx)
- [MessageBody](../../order/types/order.MessageBody/page.mdx) - [Event](../../order/types/order.Event/page.mdx)
- [Message](../../order/types/order.Message/page.mdx) - [Message](../../order/types/order.Message/page.mdx)
- [RawMessageFormat](../../order/types/order.RawMessageFormat/page.mdx) - [RawMessageFormat](../../order/types/order.RawMessageFormat/page.mdx)
- [JoinerRelationship](../../order/types/order.JoinerRelationship/page.mdx) - [JoinerRelationship](../../order/types/order.JoinerRelationship/page.mdx)
@@ -53,7 +53,7 @@ import { TypeList } from "docs-ui"
- [PrevLimit](../../payment/types/payment.PrevLimit/page.mdx) - [PrevLimit](../../payment/types/payment.PrevLimit/page.mdx)
- [FilterQuery](../../payment/types/payment.FilterQuery/page.mdx) - [FilterQuery](../../payment/types/payment.FilterQuery/page.mdx)
- [EventMetadata](../../payment/types/payment.EventMetadata/page.mdx) - [EventMetadata](../../payment/types/payment.EventMetadata/page.mdx)
- [MessageBody](../../payment/types/payment.MessageBody/page.mdx) - [Event](../../payment/types/payment.Event/page.mdx)
- [Message](../../payment/types/payment.Message/page.mdx) - [Message](../../payment/types/payment.Message/page.mdx)
- [RawMessageFormat](../../payment/types/payment.RawMessageFormat/page.mdx) - [RawMessageFormat](../../payment/types/payment.RawMessageFormat/page.mdx)
- [JoinerRelationship](../../payment/types/payment.JoinerRelationship/page.mdx) - [JoinerRelationship](../../payment/types/payment.JoinerRelationship/page.mdx)
@@ -69,7 +69,7 @@ import { TypeList } from "docs-ui"
- [PrevLimit](../../pricing/types/pricing.PrevLimit/page.mdx) - [PrevLimit](../../pricing/types/pricing.PrevLimit/page.mdx)
- [FilterQuery](../../pricing/types/pricing.FilterQuery/page.mdx) - [FilterQuery](../../pricing/types/pricing.FilterQuery/page.mdx)
- [EventMetadata](../../pricing/types/pricing.EventMetadata/page.mdx) - [EventMetadata](../../pricing/types/pricing.EventMetadata/page.mdx)
- [MessageBody](../../pricing/types/pricing.MessageBody/page.mdx) - [Event](../../pricing/types/pricing.Event/page.mdx)
- [Message](../../pricing/types/pricing.Message/page.mdx) - [Message](../../pricing/types/pricing.Message/page.mdx)
- [RawMessageFormat](../../pricing/types/pricing.RawMessageFormat/page.mdx) - [RawMessageFormat](../../pricing/types/pricing.RawMessageFormat/page.mdx)
- [JoinerRelationship](../../pricing/types/pricing.JoinerRelationship/page.mdx) - [JoinerRelationship](../../pricing/types/pricing.JoinerRelationship/page.mdx)
@@ -69,7 +69,7 @@ import { TypeList } from "docs-ui"
- [PrevLimit](../../product/types/product.PrevLimit/page.mdx) - [PrevLimit](../../product/types/product.PrevLimit/page.mdx)
- [FilterQuery](../../product/types/product.FilterQuery/page.mdx) - [FilterQuery](../../product/types/product.FilterQuery/page.mdx)
- [EventMetadata](../../product/types/product.EventMetadata/page.mdx) - [EventMetadata](../../product/types/product.EventMetadata/page.mdx)
- [MessageBody](../../product/types/product.MessageBody/page.mdx) - [Event](../../product/types/product.Event/page.mdx)
- [Message](../../product/types/product.Message/page.mdx) - [Message](../../product/types/product.Message/page.mdx)
- [RawMessageFormat](../../product/types/product.RawMessageFormat/page.mdx) - [RawMessageFormat](../../product/types/product.RawMessageFormat/page.mdx)
- [JoinerRelationship](../../product/types/product.JoinerRelationship/page.mdx) - [JoinerRelationship](../../product/types/product.JoinerRelationship/page.mdx)
@@ -59,7 +59,7 @@ import { TypeList } from "docs-ui"
- [PrevLimit](../../promotion/types/promotion.PrevLimit/page.mdx) - [PrevLimit](../../promotion/types/promotion.PrevLimit/page.mdx)
- [FilterQuery](../../promotion/types/promotion.FilterQuery/page.mdx) - [FilterQuery](../../promotion/types/promotion.FilterQuery/page.mdx)
- [EventMetadata](../../promotion/types/promotion.EventMetadata/page.mdx) - [EventMetadata](../../promotion/types/promotion.EventMetadata/page.mdx)
- [MessageBody](../../promotion/types/promotion.MessageBody/page.mdx) - [Event](../../promotion/types/promotion.Event/page.mdx)
- [Message](../../promotion/types/promotion.Message/page.mdx) - [Message](../../promotion/types/promotion.Message/page.mdx)
- [RawMessageFormat](../../promotion/types/promotion.RawMessageFormat/page.mdx) - [RawMessageFormat](../../promotion/types/promotion.RawMessageFormat/page.mdx)
- [JoinerRelationship](../../promotion/types/promotion.JoinerRelationship/page.mdx) - [JoinerRelationship](../../promotion/types/promotion.JoinerRelationship/page.mdx)
@@ -38,7 +38,7 @@ import { TypeList } from "docs-ui"
- [PrevLimit](../../region/types/region.PrevLimit/page.mdx) - [PrevLimit](../../region/types/region.PrevLimit/page.mdx)
- [FilterQuery](../../region/types/region.FilterQuery/page.mdx) - [FilterQuery](../../region/types/region.FilterQuery/page.mdx)
- [EventMetadata](../../region/types/region.EventMetadata/page.mdx) - [EventMetadata](../../region/types/region.EventMetadata/page.mdx)
- [MessageBody](../../region/types/region.MessageBody/page.mdx) - [Event](../../region/types/region.Event/page.mdx)
- [Message](../../region/types/region.Message/page.mdx) - [Message](../../region/types/region.Message/page.mdx)
- [RawMessageFormat](../../region/types/region.RawMessageFormat/page.mdx) - [RawMessageFormat](../../region/types/region.RawMessageFormat/page.mdx)
- [JoinerRelationship](../../region/types/region.JoinerRelationship/page.mdx) - [JoinerRelationship](../../region/types/region.JoinerRelationship/page.mdx)
@@ -26,7 +26,7 @@ import { TypeList } from "docs-ui"
- [MetadataType](../../sales_channel/types/sales_channel.MetadataType/page.mdx) - [MetadataType](../../sales_channel/types/sales_channel.MetadataType/page.mdx)
- [EventMetadata](../../sales_channel/types/sales_channel.EventMetadata/page.mdx) - [EventMetadata](../../sales_channel/types/sales_channel.EventMetadata/page.mdx)
- [MessageBody](../../sales_channel/types/sales_channel.MessageBody/page.mdx) - [Event](../../sales_channel/types/sales_channel.Event/page.mdx)
- [Message](../../sales_channel/types/sales_channel.Message/page.mdx) - [Message](../../sales_channel/types/sales_channel.Message/page.mdx)
- [RawMessageFormat](../../sales_channel/types/sales_channel.RawMessageFormat/page.mdx) - [RawMessageFormat](../../sales_channel/types/sales_channel.RawMessageFormat/page.mdx)
- [JoinerRelationship](../../sales_channel/types/sales_channel.JoinerRelationship/page.mdx) - [JoinerRelationship](../../sales_channel/types/sales_channel.JoinerRelationship/page.mdx)
@@ -44,7 +44,7 @@ import { TypeList } from "docs-ui"
- [PrevLimit](../../stock_location_next/types/stock_location_next.PrevLimit/page.mdx) - [PrevLimit](../../stock_location_next/types/stock_location_next.PrevLimit/page.mdx)
- [FilterQuery](../../stock_location_next/types/stock_location_next.FilterQuery/page.mdx) - [FilterQuery](../../stock_location_next/types/stock_location_next.FilterQuery/page.mdx)
- [EventMetadata](../../stock_location_next/types/stock_location_next.EventMetadata/page.mdx) - [EventMetadata](../../stock_location_next/types/stock_location_next.EventMetadata/page.mdx)
- [MessageBody](../../stock_location_next/types/stock_location_next.MessageBody/page.mdx) - [Event](../../stock_location_next/types/stock_location_next.Event/page.mdx)
- [Message](../../stock_location_next/types/stock_location_next.Message/page.mdx) - [Message](../../stock_location_next/types/stock_location_next.Message/page.mdx)
- [RawMessageFormat](../../stock_location_next/types/stock_location_next.RawMessageFormat/page.mdx) - [RawMessageFormat](../../stock_location_next/types/stock_location_next.RawMessageFormat/page.mdx)
- [GeoZoneType](../../stock_location_next/types/stock_location_next.GeoZoneType/page.mdx) - [GeoZoneType](../../stock_location_next/types/stock_location_next.GeoZoneType/page.mdx)
@@ -26,7 +26,7 @@ import { TypeList } from "docs-ui"
## Type Aliases ## Type Aliases
- [EventMetadata](../../store/types/store.EventMetadata/page.mdx) - [EventMetadata](../../store/types/store.EventMetadata/page.mdx)
- [MessageBody](../../store/types/store.MessageBody/page.mdx) - [Event](../../store/types/store.Event/page.mdx)
- [Message](../../store/types/store.Message/page.mdx) - [Message](../../store/types/store.Message/page.mdx)
- [RawMessageFormat](../../store/types/store.RawMessageFormat/page.mdx) - [RawMessageFormat](../../store/types/store.RawMessageFormat/page.mdx)
- [JoinerRelationship](../../store/types/store.JoinerRelationship/page.mdx) - [JoinerRelationship](../../store/types/store.JoinerRelationship/page.mdx)
@@ -47,7 +47,7 @@ import { TypeList } from "docs-ui"
- [PrevLimit](../../tax/types/tax.PrevLimit/page.mdx) - [PrevLimit](../../tax/types/tax.PrevLimit/page.mdx)
- [FilterQuery](../../tax/types/tax.FilterQuery/page.mdx) - [FilterQuery](../../tax/types/tax.FilterQuery/page.mdx)
- [EventMetadata](../../tax/types/tax.EventMetadata/page.mdx) - [EventMetadata](../../tax/types/tax.EventMetadata/page.mdx)
- [MessageBody](../../tax/types/tax.MessageBody/page.mdx) - [Event](../../tax/types/tax.Event/page.mdx)
- [Message](../../tax/types/tax.Message/page.mdx) - [Message](../../tax/types/tax.Message/page.mdx)
- [RawMessageFormat](../../tax/types/tax.RawMessageFormat/page.mdx) - [RawMessageFormat](../../tax/types/tax.RawMessageFormat/page.mdx)
- [JoinerRelationship](../../tax/types/tax.JoinerRelationship/page.mdx) - [JoinerRelationship](../../tax/types/tax.JoinerRelationship/page.mdx)
@@ -26,7 +26,7 @@ import { TypeList } from "docs-ui"
## Type Aliases ## Type Aliases
- [EventMetadata](../../user/types/user.EventMetadata/page.mdx) - [EventMetadata](../../user/types/user.EventMetadata/page.mdx)
- [MessageBody](../../user/types/user.MessageBody/page.mdx) - [Event](../../user/types/user.Event/page.mdx)
- [Message](../../user/types/user.Message/page.mdx) - [Message](../../user/types/user.Message/page.mdx)
- [RawMessageFormat](../../user/types/user.RawMessageFormat/page.mdx) - [RawMessageFormat](../../user/types/user.RawMessageFormat/page.mdx)
- [JoinerRelationship](../../user/types/user.JoinerRelationship/page.mdx) - [JoinerRelationship](../../user/types/user.JoinerRelationship/page.mdx)
@@ -12,4 +12,4 @@ import { TypeList } from "docs-ui"
## Returns ## Returns
<TypeList types={[{"name":"Record","type":"`Record<string, [Message](../../../types/order.Message/page.mdx)[]>`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"Message[]","type":"[Message](../../../types/order.Message/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"Message","type":"[MessageBody](../../../types/order.MessageBody/page.mdx)&#60;TData&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="getMessages"/> <TypeList types={[{"name":"Record","type":"`Record<string, [Message](../../../types/order.Message/page.mdx)[]>`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"Message[]","type":"[Message](../../../types/order.Message/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"Message","type":"[Event](../../../types/order.Event/page.mdx)&#60;TData&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="getMessages"/>
@@ -8,7 +8,7 @@ import { TypeList } from "docs-ui"
## Parameters ## Parameters
<TypeList types={[{"name":"msg","type":"[Message](../../../types/order.Message/page.mdx) \\| [Message](../../../types/order.Message/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"eventName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[EventMetadata](../../../types/order.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="save"/> <TypeList types={[{"name":"msg","type":"[Message](../../../types/order.Message/page.mdx) \\| [Message](../../../types/order.Message/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[EventMetadata](../../../types/order.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="save"/>
## Returns ## Returns
@@ -14,7 +14,7 @@ This documentation provides a reference to the `updateOrderChangeActions` method
### Parameters ### Parameters
<TypeList types={[{"name":"data","type":"[UpdateOrderChangeActionDTO](../../../interfaces/order.UpdateOrderChangeActionDTO/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/order.Context/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../interfaces/order.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="updateOrderChangeActions"/> <TypeList types={[{"name":"data","type":"[UpdateOrderChangeActionDTO](../../../interfaces/order.UpdateOrderChangeActionDTO/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/order.Context/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../interfaces/order.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="updateOrderChangeActions"/>
### Returns ### Returns
@@ -39,7 +39,7 @@ const result = await orderModuleService.updateOrderChangeActions(updateOrderChan
### Parameters ### Parameters
<TypeList types={[{"name":"data","type":"[UpdateOrderChangeActionDTO](../../../interfaces/order.UpdateOrderChangeActionDTO/page.mdx)[]","description":"The order change action to be updated.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/order.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../interfaces/order.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="updateOrderChangeActions"/> <TypeList types={[{"name":"data","type":"[UpdateOrderChangeActionDTO](../../../interfaces/order.UpdateOrderChangeActionDTO/page.mdx)[]","description":"The order change action to be updated.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/order.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../interfaces/order.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="updateOrderChangeActions"/>
### Returns ### Returns
@@ -60,7 +60,7 @@ const result = await orderModuleService.updateOrderChangeActions({
### Parameters ### Parameters
<TypeList types={[{"name":"data","type":"[UpdateOrderChangeActionDTO](../../../interfaces/order.UpdateOrderChangeActionDTO/page.mdx) \\| [UpdateOrderChangeActionDTO](../../../interfaces/order.UpdateOrderChangeActionDTO/page.mdx)[]","description":"The order change action d t o \\| order change to be updated.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/order.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../interfaces/order.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="updateOrderChangeActions"/> <TypeList types={[{"name":"data","type":"[UpdateOrderChangeActionDTO](../../../interfaces/order.UpdateOrderChangeActionDTO/page.mdx) \\| [UpdateOrderChangeActionDTO](../../../interfaces/order.UpdateOrderChangeActionDTO/page.mdx)[]","description":"The order change action d t o \\| order change to be updated.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/order.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../interfaces/order.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="updateOrderChangeActions"/>
### Returns ### Returns
@@ -0,0 +1,31 @@
---
displayed_sidebar: orderReference
slug: /references/order/updateShippingMethods
sidebar_label: updateShippingMethods
---
import { TypeList } from "docs-ui"
# updateShippingMethods - Order Module Reference
This documentation provides a reference to the `updateShippingMethods` method. This belongs to the Order Module.
## updateShippingMethods(data, sharedContext?): Promise&#60;[OrderShippingMethodDTO](../../../interfaces/order.OrderShippingMethodDTO/page.mdx)[]&#62;
### Parameters
<TypeList types={[{"name":"data","type":"[UpdateOrderShippingMethodDTO](../../../interfaces/order.UpdateOrderShippingMethodDTO/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"data","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_lines","type":"[CreateOrderTaxLineDTO](../../../interfaces/order.CreateOrderTaxLineDTO/page.mdx)[] \\| [UpdateOrderTaxLineDTO](../../../interfaces/order.UpdateOrderTaxLineDTO/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"adjustments","type":"[CreateOrderAdjustmentDTO](../../../interfaces/order.CreateOrderAdjustmentDTO/page.mdx)[] \\| [UpdateOrderAdjustmentDTO](../../../interfaces/order.UpdateOrderAdjustmentDTO/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"amount","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/order.Context/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","typeLine truncated
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderShippingMethodDTO](../../../interfaces/order.OrderShippingMethodDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderShippingMethodDTO[]","type":"[OrderShippingMethodDTO](../../../interfaces/order.OrderShippingMethodDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderShippingMethodDTO","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="updateShippingMethods"/>
## updateShippingMethods(data, sharedContext?): Promise&#60;[OrderShippingMethodDTO](../../../interfaces/order.OrderShippingMethodDTO/page.mdx)&#62;
### Parameters
<TypeList types={[{"name":"data","type":"[UpdateOrderShippingMethodDTO](../../../interfaces/order.UpdateOrderShippingMethodDTO/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"data","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_lines","type":"[CreateOrderTaxLineDTO](../../../interfaces/order.CreateOrderTaxLineDTO/page.mdx)[] \\| [UpdateOrderTaxLineDTO](../../../interfaces/order.UpdateOrderTaxLineDTO/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"adjustments","type":"[CreateOrderAdjustmentDTO](../../../interfaces/order.CreateOrderAdjustmentDTO/page.mdx)[] \\| [UpdateOrderAdjustmentDTO](../../../interfaces/order.UpdateOrderAdjustmentDTO/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"amount","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/order.Context/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":Line truncated
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderShippingMethodDTO](../../../interfaces/order.OrderShippingMethodDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderShippingMethodDTO","type":"[OrderShippingMethodDTO](../../../interfaces/order.OrderShippingMethodDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the shipping method","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the shipping method","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The price of the shipping method","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"[BigNumberRawValue](../../../types/order.BigNumberRawValue/page.mdx)","description":"The raw price of the shipping method","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Whether the shipping method price is tax inclusive or not","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the shipping method was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the shipping method was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_original_total","type":"[BigNumberRawValue](../../../types/order.BigNumberRawValue/page.mdx)","description":"The raw original total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"raw_original_subtotal","type":"[BigNumberRawValue](../../../types/order.BigNumberRawValue/page.mdx)","description":"The raw original subtotal of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"raw_original_tax_total","type":"[BigNumberRawValue](../../../types/order.BigNumberRawValue/page.mdx)","description":"The raw original tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"raw_total","type":"[BigNumberRawVLine truncated
@@ -42,6 +42,7 @@ This section of the documentation provides a reference to the `IOrderModuleServi
- [updateOrderItem](../../IOrderModuleService/methods/order.IOrderModuleService.updateOrderItem/page.mdx) - [updateOrderItem](../../IOrderModuleService/methods/order.IOrderModuleService.updateOrderItem/page.mdx)
- [listShippingMethods](../../IOrderModuleService/methods/order.IOrderModuleService.listShippingMethods/page.mdx) - [listShippingMethods](../../IOrderModuleService/methods/order.IOrderModuleService.listShippingMethods/page.mdx)
- [createShippingMethods](../../IOrderModuleService/methods/order.IOrderModuleService.createShippingMethods/page.mdx) - [createShippingMethods](../../IOrderModuleService/methods/order.IOrderModuleService.createShippingMethods/page.mdx)
- [updateShippingMethods](../../IOrderModuleService/methods/order.IOrderModuleService.updateShippingMethods/page.mdx)
- [deleteShippingMethods](../../IOrderModuleService/methods/order.IOrderModuleService.deleteShippingMethods/page.mdx) - [deleteShippingMethods](../../IOrderModuleService/methods/order.IOrderModuleService.deleteShippingMethods/page.mdx)
- [listLineItemAdjustments](../../IOrderModuleService/methods/order.IOrderModuleService.listLineItemAdjustments/page.mdx) - [listLineItemAdjustments](../../IOrderModuleService/methods/order.IOrderModuleService.listLineItemAdjustments/page.mdx)
- [createLineItemAdjustments](../../IOrderModuleService/methods/order.IOrderModuleService.createLineItemAdjustments/page.mdx) - [createLineItemAdjustments](../../IOrderModuleService/methods/order.IOrderModuleService.createLineItemAdjustments/page.mdx)
@@ -6,4 +6,4 @@ import { TypeList } from "docs-ui"
# UpdateOrderChangeActionDTO # UpdateOrderChangeActionDTO
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="UpdateOrderChangeActionDTO"/> <TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="UpdateOrderChangeActionDTO"/>
@@ -0,0 +1,9 @@
---
displayed_sidebar: orderReference
---
import { TypeList } from "docs-ui"
# UpdateOrderShippingMethodDTO
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../types/order.BigNumberInput/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"data","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_lines","type":"[CreateOrderTaxLineDTO](../order.CreateOrderTaxLineDTO/page.mdx)[] \\| [UpdateOrderTaxLineDTO](../order.UpdateOrderTaxLineDTO/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"[BigNumberInput](../../types/order.BigNumberInput/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"[BigNumberInput](../../types/order.BigNumberInput/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"provider_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"adjustments","type":"[CreateOrderAdjustmentDTO](../order.CreateOrderAdjustmentDTO/page.mdx)[] \\| [UpdateOrderAdjustmentDTO](../order.UpdateOrderAdjustmentDTO/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"amount","type":"[BigNumberInput](../../types/order.BigNumberInput/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../types/order.BigNumberInput/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="UpdateOrderShippingMethodDTO"/>
@@ -0,0 +1,13 @@
---
displayed_sidebar: orderReference
---
import { TypeList } from "docs-ui"
# Event
**Event**: `Object`
## Properties
<TypeList types={[{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[EventMetadata](../order.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="Event"/>
@@ -6,4 +6,4 @@ import { TypeList } from "docs-ui"
# Message # Message
**Message**: [MessageBody](../order.MessageBody/page.mdx)&#60;TData&#62; & `object` **Message**: [Event](../order.Event/page.mdx)&#60;TData&#62; & `object`
@@ -1,13 +0,0 @@
---
displayed_sidebar: orderReference
---
import { TypeList } from "docs-ui"
# MessageBody
**MessageBody**: `Object`
## Properties
<TypeList types={[{"name":"eventName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[EventMetadata](../order.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="MessageBody"/>
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the ClaimItem . This belongs to the Order Module. This documentation provides a reference to the ClaimItem . This belongs to the Order Module.
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"images","type":"Collection&#60;[ClaimItemImage](../order_models.ClaimItemImage/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"[ClaimItem](page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"images","type":"Collection&#60;[ClaimItemImage](../order_models.ClaimItemImage/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason","type":"`null` \\| [ClaimReason](../../../utils/OrderUtils/enums/utils.OrderUtils.ClaimReason/page.mdx)","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"quantity","type":"`number` \\| `Number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_quantity","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim","type":"[OrderClaim](../order_models.OrderClaim/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"[LineItem](../order_models.LineItem/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_additional_item","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"note","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"[ModelDateColumns](../../../types/DAL/types/types.DAL.ModelDateColumns/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"url","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"[ModelDateColumns](../../../types/DAL/types/types.DAL.ModelDateColumns/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"reason","type":"`null` \\| [ClaimReason](../../../utils/OrderUtils/enums/utils.OrderUtils.ClaimReason/page.mdx)","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[{"name":"MISSING_ITEM","type":"`\"missing_item\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"WRONG_ITEM","type":"`\"wrong_item\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PRODUCTION_FAILURE","type":"`\"production_failure\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"OTHER","type":"`\"other\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"quantity","type":"`number` \\| `Number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_quantity","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optionaLine truncated <TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"images","type":"Collection&#60;[ClaimItemImage](../order_models.ClaimItemImage/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"[ClaimItem](page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"images","type":"Collection&#60;[ClaimItemImage](../order_models.ClaimItemImage/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason","type":"`null` \\| [ClaimReason](../../../utils/OrderUtils/enums/utils.OrderUtils.ClaimReason/page.mdx)","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"quantity","type":"`number` \\| `Number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_quantity","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim","type":"[OrderClaim](../order_models.OrderClaim/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"[LineItem](../order_models.LineItem/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_additional_item","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"note","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"[ModelDateColumns](../../../types/DAL/types/types.DAL.ModelDateColumns/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"url","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"[ModelDateColumns](../../../types/DAL/types/types.DAL.ModelDateColumns/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"reason","type":"`null` \\| [ClaimReason](../../../utils/OrderUtils/enums/utils.OrderUtils.ClaimReason/page.mdx)","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[{"name":"MISSING_ITEM","type":"`\"missing_item\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"WRONG_ITEM","type":"`\"wrong_item\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PRODUCTION_FAILURE","type":"`\"production_failure\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"OTHER","type":"`\"other\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"quantity","type":"`number` \\| `Number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_quantity","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optionaLine truncated
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the ClaimItemImage . This belongs to the Order Module. This documentation provides a reference to the ClaimItemImage . This belongs to the Order Module.
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"[ClaimItem](../order_models.ClaimItem/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"images","type":"Collection&#60;[ClaimItemImage](page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"[ClaimItem](../order_models.ClaimItem/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"[ModelDateColumns](../../../types/DAL/types/types.DAL.ModelDateColumns/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"reason","type":"`null` \\| [ClaimReason](../../../utils/OrderUtils/enums/utils.OrderUtils.ClaimReason/page.mdx)","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[{"name":"MISSING_ITEM","type":"`\"missing_item\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"WRONG_ITEM","type":"`\"wrong_item\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PRODUCTION_FAILURE","type":"`\"production_failure\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"OTHER","type":"`\"other\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"quantity","type":"`number` \\| `Number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_quantity","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"claim_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim","type":"[OrderClaim](../order_models.OrderClaim/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../order_models.Order/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return","type":"[Return](../order_models.Return/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"order_version","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ClaimType](../../../utils/OrderUtils/enums/utils.OrderUtils.ClaimType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`null` \\| `boolean`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"refund_amount","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_refund_amount","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":""Line truncated <TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"[ClaimItem](../order_models.ClaimItem/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"images","type":"Collection&#60;[ClaimItemImage](page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"[ClaimItem](../order_models.ClaimItem/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"[ModelDateColumns](../../../types/DAL/types/types.DAL.ModelDateColumns/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"reason","type":"`null` \\| [ClaimReason](../../../utils/OrderUtils/enums/utils.OrderUtils.ClaimReason/page.mdx)","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[{"name":"MISSING_ITEM","type":"`\"missing_item\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"WRONG_ITEM","type":"`\"wrong_item\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PRODUCTION_FAILURE","type":"`\"production_failure\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"OTHER","type":"`\"other\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"quantity","type":"`number` \\| `Number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_quantity","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"claim_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim","type":"[OrderClaim](../order_models.OrderClaim/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../order_models.Order/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return","type":"[Return](../order_models.Return/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"order_version","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ClaimType](../../../utils/OrderUtils/enums/utils.OrderUtils.ClaimType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`null` \\| `boolean`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"refund_amount","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_refund_amount","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":""Line truncated
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the ExchangeItem . This belongs to the Order Module. This documentation provides a reference to the ExchangeItem . This belongs to the Order Module.
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number` \\| `Number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_quantity","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"exchange_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange","type":"[OrderExchange](../order_models.OrderExchange/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../order_models.Order/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"","optional":false,"defaultValue":"1","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../utils/OrderUtils/enums/utils.OrderUtils.OrderStatus/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_draft_order","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`null` \\| `boolean`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"summary","type":"Collection&#60;[OrderSummary](../order_models.OrderSummary/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"items","type":"Collection&#60;[OrderItem](../order_models.OrderItem/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"Collection&#60;[OrderShippingMethod](../order_models.OrderShippingMethod/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"transactions","type":"Collection&#60;[Transaction](../order_models.Transaction/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"canceled_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"`OptionalOrderProps`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address_id","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"`null` \\| [Address](../order_models.Address/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"billing_address_id","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"billing_address","type":"`null` \\| [Address](../order_models.Address/page.mdx)","description":"","opLine truncated <TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number` \\| `Number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_quantity","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"exchange_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange","type":"[OrderExchange](../order_models.OrderExchange/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../order_models.Order/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"","optional":false,"defaultValue":"1","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../utils/OrderUtils/enums/utils.OrderUtils.OrderStatus/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_draft_order","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`null` \\| `boolean`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"summary","type":"Collection&#60;[OrderSummary](../order_models.OrderSummary/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"items","type":"Collection&#60;[OrderItem](../order_models.OrderItem/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"Collection&#60;[OrderShippingMethod](../order_models.OrderShippingMethod/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"transactions","type":"Collection&#60;[Transaction](../order_models.Transaction/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"canceled_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"`OptionalOrderProps`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address_id","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"`null` \\| [Address](../order_models.Address/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"billing_address_id","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"billing_address","type":"`null` \\| [Address](../order_models.Address/page.mdx)","description":"","opLine truncated
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the LineItem . This belongs to the Order Module. This documentation provides a reference to the LineItem . This belongs to the Order Module.
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"variant_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"product_title","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"product_description","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"product_subtitle","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"product_type","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"product_collection","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"product_handle","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"variant_sku","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"variant_barcode","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"variant_title","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"variant_option_values","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"is_discountable","type":"`boolean`","description":"","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"raw_compare_at_unit_price","type":"`null` \\| [BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"unit_price","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_unit_price","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"tax_lines","type":"Collection&#60;[LineItemTaxLine](../order_models.LineItemTaxLine/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"item","type":"[LineItem](page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"variant_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"product_title","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"product_description","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"product_subtitle","type":"`null` \\| `string`","description":"","Line truncated <TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"variant_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"product_title","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"product_description","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"product_subtitle","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"product_type","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"product_collection","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"product_handle","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"variant_sku","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"variant_barcode","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"variant_title","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"variant_option_values","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"is_discountable","type":"`boolean`","description":"","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"raw_compare_at_unit_price","type":"`null` \\| [BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"unit_price","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_unit_price","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"tax_lines","type":"Collection&#60;[LineItemTaxLine](../order_models.LineItemTaxLine/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"item","type":"[LineItem](page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"variant_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"product_title","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"product_description","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"product_subtitle","type":"`null` \\| `string`","description":"","Line truncated
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the LineItemAdjustment . This belongs to the Order Module. This documentation provides a reference to the LineItemAdjustment . This belongs to the Order Module.
<TypeList types={[{"name":"[OptionalProps]","type":"[ModelDateColumns](../../../types/DAL/types/types.DAL.ModelDateColumns/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"promotion_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"amount","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"provider_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"[LineItem](../order_models.LineItem/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"variant_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"product_title","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"product_description","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"product_subtitle","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"product_type","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"product_collection","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"product_handle","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"variant_sku","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"variant_barcode","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"variant_title","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"variant_option_values","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"is_discountable","type":"`boolean`","description":"","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"raw_compare_at_unit_price","type":"`null` \\| [BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"unit_price","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_unit_price","type":"[BigNumberRawValue](../../../types/types/typesLine truncated <TypeList types={[{"name":"[OptionalProps]","type":"[ModelDateColumns](../../../types/DAL/types/types.DAL.ModelDateColumns/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"promotion_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"amount","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"provider_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"item","type":"[LineItem](../order_models.LineItem/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"variant_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"product_title","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"product_description","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"product_subtitle","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"product_type","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"product_collection","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"product_handle","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"variant_sku","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"variant_barcode","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"variant_title","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"variant_option_values","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"is_discountable","type":"`boolean`","description":"","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"raw_compare_at_unit_price","type":"`null` \\| [BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"unit_price","type":"`number` \\| `BigNumber`","description":"","optional"Line truncated
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the LineItemTaxLine . This belongs to the Order Module. This documentation provides a reference to the LineItemTaxLine . This belongs to the Order Module.
<TypeList types={[{"name":"item","type":"[LineItem](../order_models.LineItem/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"variant_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"product_title","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"product_description","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"product_subtitle","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"product_type","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"product_collection","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"product_handle","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"variant_sku","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"variant_barcode","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"variant_title","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"variant_option_values","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"is_discountable","type":"`boolean`","description":"","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"raw_compare_at_unit_price","type":"`null` \\| [BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"unit_price","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_unit_price","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"tax_lines","type":"Collection&#60;[LineItemTaxLine](page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"item","type":"[LineItem](../order_models.LineItem/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_rate","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"","optional":trueLine truncated <TypeList types={[{"name":"item","type":"[LineItem](../order_models.LineItem/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"variant_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"product_title","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"product_description","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"product_subtitle","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"product_type","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"product_collection","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"product_handle","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"variant_sku","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"variant_barcode","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"variant_title","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"variant_option_values","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"is_discountable","type":"`boolean`","description":"","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"raw_compare_at_unit_price","type":"`null` \\| [BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"unit_price","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_unit_price","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"tax_lines","type":"Collection&#60;[LineItemTaxLine](page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"item","type":"[LineItem](../order_models.LineItem/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_rate","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"Line truncated
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the Order . This belongs to the Order Module. This documentation provides a reference to the Order . This belongs to the Order Module.
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"","optional":false,"defaultValue":"1","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../utils/OrderUtils/enums/utils.OrderUtils.OrderStatus/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"PENDING","type":"`\"pending\"`","description":"The order is pending.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"COMPLETED","type":"`\"completed\"`","description":"The order is completed","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DRAFT","type":"`\"draft\"`","description":"The order is a draft.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ARCHIVED","type":"`\"archived\"`","description":"The order is archived.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CANCELED","type":"`\"canceled\"`","description":"The order is canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"REQUIRES_ACTION","type":"`\"requires_action\"`","description":"The order requires action.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"is_draft_order","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`null` \\| `boolean`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"summary","type":"Collection&#60;[OrderSummary](../order_models.OrderSummary/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"","optional":false,"defaultValue":"1","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../utils/OrderUtils/enums/utils.OrderUtils.OrderStatus/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_draft_order","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`null` \\| `boolean`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"summary","type":"Collection&#60;[OrderSummary](../order_models.OrderSummary/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"items","type":"Collection&#60;[OrderItem](../order_models.OrderItem/page.mdx), object&#62;"Line truncated <TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"","optional":false,"defaultValue":"1","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../utils/OrderUtils/enums/utils.OrderUtils.OrderStatus/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"PENDING","type":"`\"pending\"`","description":"The order is pending.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"COMPLETED","type":"`\"completed\"`","description":"The order is completed","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DRAFT","type":"`\"draft\"`","description":"The order is a draft.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ARCHIVED","type":"`\"archived\"`","description":"The order is archived.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CANCELED","type":"`\"canceled\"`","description":"The order is canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"REQUIRES_ACTION","type":"`\"requires_action\"`","description":"The order requires action.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"is_draft_order","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`null` \\| `boolean`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"summary","type":"Collection&#60;[OrderSummary](../order_models.OrderSummary/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"","optional":false,"defaultValue":"1","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../utils/OrderUtils/enums/utils.OrderUtils.OrderStatus/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_draft_order","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`null` \\| `boolean`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"summary","type":"Collection&#60;[OrderSummary](../order_models.OrderSummary/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"items","type":"Collection&#60;[OrderItem](../order_models.OrderItem/page.mdx), object&#62;"Line truncated
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the OrderClaim . This belongs to the Order Module. This documentation provides a reference to the OrderClaim . This belongs to the Order Module.
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../order_models.Order/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"","optional":false,"defaultValue":"1","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../utils/OrderUtils/enums/utils.OrderUtils.OrderStatus/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"PENDING","type":"`\"pending\"`","description":"The order is pending.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"COMPLETED","type":"`\"completed\"`","description":"The order is completed","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DRAFT","type":"`\"draft\"`","description":"The order is a draft.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ARCHIVED","type":"`\"archived\"`","description":"The order is archived.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CANCELED","type":"`\"canceled\"`","description":"The order is canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"REQUIRES_ACTION","type":"`\"requires_action\"`","description":"The order requires action.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"is_draft_order","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`null` \\| `boolean`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"summary","type":"Collection&#60;[OrderSummary](../order_models.OrderSummary/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../order_models.Order/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"","optional":false,"defaultValue":"1","expandable":false,"children":[]},{"name":"totals","type":"`null` \\| `OrderSummaryTotals`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]}]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"items","type":"Collection&#60;[OrderItem](../order_models.OrderItem/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../order_models.Order/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"","optional":Line truncated <TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../order_models.Order/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"","optional":false,"defaultValue":"1","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../utils/OrderUtils/enums/utils.OrderUtils.OrderStatus/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"PENDING","type":"`\"pending\"`","description":"The order is pending.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"COMPLETED","type":"`\"completed\"`","description":"The order is completed","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DRAFT","type":"`\"draft\"`","description":"The order is a draft.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ARCHIVED","type":"`\"archived\"`","description":"The order is archived.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CANCELED","type":"`\"canceled\"`","description":"The order is canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"REQUIRES_ACTION","type":"`\"requires_action\"`","description":"The order requires action.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"is_draft_order","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`null` \\| `boolean`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"summary","type":"Collection&#60;[OrderSummary](../order_models.OrderSummary/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../order_models.Order/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"","optional":false,"defaultValue":"1","expandable":false,"children":[]},{"name":"totals","type":"`null` \\| `OrderSummaryTotals`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]}]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"items","type":"Collection&#60;[OrderItem](../order_models.OrderItem/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../order_models.Order/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"","optional":Line truncated
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the OrderExchange . This belongs to the Order Module. This documentation provides a reference to the OrderExchange . This belongs to the Order Module.
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../order_models.Order/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"","optional":false,"defaultValue":"1","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../utils/OrderUtils/enums/utils.OrderUtils.OrderStatus/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"PENDING","type":"`\"pending\"`","description":"The order is pending.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"COMPLETED","type":"`\"completed\"`","description":"The order is completed","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DRAFT","type":"`\"draft\"`","description":"The order is a draft.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ARCHIVED","type":"`\"archived\"`","description":"The order is archived.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CANCELED","type":"`\"canceled\"`","description":"The order is canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"REQUIRES_ACTION","type":"`\"requires_action\"`","description":"The order requires action.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"is_draft_order","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`null` \\| `boolean`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"summary","type":"Collection&#60;[OrderSummary](../order_models.OrderSummary/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../order_models.Order/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"","optional":false,"defaultValue":"1","expandable":false,"children":[]},{"name":"totals","type":"`null` \\| `OrderSummaryTotals`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]}]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"items","type":"Collection&#60;[OrderItem](../order_models.OrderItem/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../order_models.Order/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"","optional":Line truncated <TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../order_models.Order/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"","optional":false,"defaultValue":"1","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../utils/OrderUtils/enums/utils.OrderUtils.OrderStatus/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"PENDING","type":"`\"pending\"`","description":"The order is pending.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"COMPLETED","type":"`\"completed\"`","description":"The order is completed","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DRAFT","type":"`\"draft\"`","description":"The order is a draft.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ARCHIVED","type":"`\"archived\"`","description":"The order is archived.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CANCELED","type":"`\"canceled\"`","description":"The order is canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"REQUIRES_ACTION","type":"`\"requires_action\"`","description":"The order requires action.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"is_draft_order","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`null` \\| `boolean`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"summary","type":"Collection&#60;[OrderSummary](../order_models.OrderSummary/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../order_models.Order/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"","optional":false,"defaultValue":"1","expandable":false,"children":[]},{"name":"totals","type":"`null` \\| `OrderSummaryTotals`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]}]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"items","type":"Collection&#60;[OrderItem](../order_models.OrderItem/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../order_models.Order/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"","optional":Line truncated
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the OrderItem . This belongs to the Order Module. This documentation provides a reference to the OrderItem . This belongs to the Order Module.
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../order_models.Order/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"","optional":false,"defaultValue":"1","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../utils/OrderUtils/enums/utils.OrderUtils.OrderStatus/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"PENDING","type":"`\"pending\"`","description":"The order is pending.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"COMPLETED","type":"`\"completed\"`","description":"The order is completed","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DRAFT","type":"`\"draft\"`","description":"The order is a draft.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ARCHIVED","type":"`\"archived\"`","description":"The order is archived.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CANCELED","type":"`\"canceled\"`","description":"The order is canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"REQUIRES_ACTION","type":"`\"requires_action\"`","description":"The order requires action.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"is_draft_order","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`null` \\| `boolean`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"summary","type":"Collection&#60;[OrderSummary](../order_models.OrderSummary/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../order_models.Order/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"","optional":false,"defaultValue":"1","expandable":false,"children":[]},{"name":"totals","type":"`null` \\| `OrderSummaryTotals`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]}]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"items","type":"Collection&#60;[OrderItem](page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../order_models.Order/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"","optional":false,"defaultValue":"","eLine truncated <TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../order_models.Order/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"","optional":false,"defaultValue":"1","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../utils/OrderUtils/enums/utils.OrderUtils.OrderStatus/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"PENDING","type":"`\"pending\"`","description":"The order is pending.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"COMPLETED","type":"`\"completed\"`","description":"The order is completed","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DRAFT","type":"`\"draft\"`","description":"The order is a draft.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ARCHIVED","type":"`\"archived\"`","description":"The order is archived.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CANCELED","type":"`\"canceled\"`","description":"The order is canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"REQUIRES_ACTION","type":"`\"requires_action\"`","description":"The order requires action.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"is_draft_order","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`null` \\| `boolean`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"summary","type":"Collection&#60;[OrderSummary](../order_models.OrderSummary/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../order_models.Order/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"","optional":false,"defaultValue":"1","expandable":false,"children":[]},{"name":"totals","type":"`null` \\| `OrderSummaryTotals`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]}]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"items","type":"Collection&#60;[OrderItem](page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../order_models.Order/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"","optional":false,"defaultValue":"","eLine truncated
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the OrderShippingMethod . This belongs to the Order Module. This documentation provides a reference to the OrderShippingMethod . This belongs to the Order Module.
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../order_models.Order/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"","optional":false,"defaultValue":"1","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../utils/OrderUtils/enums/utils.OrderUtils.OrderStatus/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"PENDING","type":"`\"pending\"`","description":"The order is pending.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"COMPLETED","type":"`\"completed\"`","description":"The order is completed","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DRAFT","type":"`\"draft\"`","description":"The order is a draft.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ARCHIVED","type":"`\"archived\"`","description":"The order is archived.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CANCELED","type":"`\"canceled\"`","description":"The order is canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"REQUIRES_ACTION","type":"`\"requires_action\"`","description":"The order requires action.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"is_draft_order","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`null` \\| `boolean`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"summary","type":"Collection&#60;[OrderSummary](../order_models.OrderSummary/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../order_models.Order/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"","optional":false,"defaultValue":"1","expandable":false,"children":[]},{"name":"totals","type":"`null` \\| `OrderSummaryTotals`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]}]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"items","type":"Collection&#60;[OrderItem](../order_models.OrderItem/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../order_models.Order/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"","optional":Line truncated <TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../order_models.Order/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"","optional":false,"defaultValue":"1","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../utils/OrderUtils/enums/utils.OrderUtils.OrderStatus/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"PENDING","type":"`\"pending\"`","description":"The order is pending.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"COMPLETED","type":"`\"completed\"`","description":"The order is completed","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DRAFT","type":"`\"draft\"`","description":"The order is a draft.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ARCHIVED","type":"`\"archived\"`","description":"The order is archived.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CANCELED","type":"`\"canceled\"`","description":"The order is canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"REQUIRES_ACTION","type":"`\"requires_action\"`","description":"The order requires action.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"is_draft_order","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`null` \\| `boolean`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"summary","type":"Collection&#60;[OrderSummary](../order_models.OrderSummary/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../order_models.Order/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"","optional":false,"defaultValue":"1","expandable":false,"children":[]},{"name":"totals","type":"`null` \\| `OrderSummaryTotals`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]}]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"items","type":"Collection&#60;[OrderItem](../order_models.OrderItem/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../order_models.Order/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"","optional":Line truncated
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the Return . This belongs to the Order Module. This documentation provides a reference to the Return . This belongs to the Order Module.
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../order_models.Order/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"","optional":false,"defaultValue":"1","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../utils/OrderUtils/enums/utils.OrderUtils.OrderStatus/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"PENDING","type":"`\"pending\"`","description":"The order is pending.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"COMPLETED","type":"`\"completed\"`","description":"The order is completed","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DRAFT","type":"`\"draft\"`","description":"The order is a draft.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ARCHIVED","type":"`\"archived\"`","description":"The order is archived.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CANCELED","type":"`\"canceled\"`","description":"The order is canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"REQUIRES_ACTION","type":"`\"requires_action\"`","description":"The order requires action.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"is_draft_order","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`null` \\| `boolean`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"summary","type":"Collection&#60;[OrderSummary](../order_models.OrderSummary/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../order_models.Order/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"","optional":false,"defaultValue":"1","expandable":false,"children":[]},{"name":"totals","type":"`null` \\| `OrderSummaryTotals`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]}]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"items","type":"Collection&#60;[OrderItem](../order_models.OrderItem/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../order_models.Order/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"","optional":Line truncated <TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../order_models.Order/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"","optional":false,"defaultValue":"1","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../utils/OrderUtils/enums/utils.OrderUtils.OrderStatus/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"PENDING","type":"`\"pending\"`","description":"The order is pending.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"COMPLETED","type":"`\"completed\"`","description":"The order is completed","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DRAFT","type":"`\"draft\"`","description":"The order is a draft.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ARCHIVED","type":"`\"archived\"`","description":"The order is archived.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CANCELED","type":"`\"canceled\"`","description":"The order is canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"REQUIRES_ACTION","type":"`\"requires_action\"`","description":"The order requires action.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"is_draft_order","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`null` \\| `boolean`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"summary","type":"Collection&#60;[OrderSummary](../order_models.OrderSummary/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../order_models.Order/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"","optional":false,"defaultValue":"1","expandable":false,"children":[]},{"name":"totals","type":"`null` \\| `OrderSummaryTotals`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]}]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"items","type":"Collection&#60;[OrderItem](../order_models.OrderItem/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../order_models.Order/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"","optional":Line truncated
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the ReturnItem . This belongs to the Order Module. This documentation provides a reference to the ReturnItem . This belongs to the Order Module.
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"reason","type":"[ReturnReason](../order_models.ReturnReason/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"return_reason_children","type":"[ReturnReason](../order_models.ReturnReason/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"return_reason_children","type":"[ReturnReason](../order_models.ReturnReason/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"`OptionalOrderProps`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"`null` \\| [ReturnReason](../order_models.ReturnReason/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"`OptionalOrderProps`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"`null` \\| [ReturnReason](../order_models.ReturnReason/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"return_reason_children","type":"[ReturnReason](../order_models.ReturnReason/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"Line truncated <TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"reason","type":"[ReturnReason](../order_models.ReturnReason/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"return_reason_children","type":"[ReturnReason](../order_models.ReturnReason/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"return_reason_children","type":"[ReturnReason](../order_models.ReturnReason/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"`OptionalOrderProps`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"`null` \\| [ReturnReason](../order_models.ReturnReason/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"`OptionalOrderProps`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"`null` \\| [ReturnReason](../order_models.ReturnReason/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"return_reason_children","type":"[ReturnReason](../order_models.ReturnReason/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"Line truncated
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the ShippingMethod . This belongs to the Order Module. This documentation provides a reference to the ShippingMethod . This belongs to the Order Module.
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"amount","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"is_tax_inclusive","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"data","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"tax_lines","type":"Collection&#60;[ShippingMethodTaxLine](../order_models.ShippingMethodTaxLine/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"shipping_method","type":"[ShippingMethod](page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"amount","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"data","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"tax_lines","type":"Collection&#60;[ShippingMethodTaxLine](../order_models.ShippingMethodTaxLine/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"adjustments","type":"Collection&#60;[ShippingMethodAdjustment](../order_models.ShippingMethodAdjustment/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shipping_method_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_rate","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name"Line truncated <TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"amount","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"is_tax_inclusive","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"data","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"tax_lines","type":"Collection&#60;[ShippingMethodTaxLine](../order_models.ShippingMethodTaxLine/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"shipping_method","type":"[ShippingMethod](page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"amount","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"data","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"tax_lines","type":"Collection&#60;[ShippingMethodTaxLine](../order_models.ShippingMethodTaxLine/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"adjustments","type":"Collection&#60;[ShippingMethodAdjustment](../order_models.ShippingMethodAdjustment/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]}]},{"name":"shipping_method_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_rate","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"namLine truncated
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the ShippingMethodAdjustment . This belongs to the Order Module. This documentation provides a reference to the ShippingMethodAdjustment . This belongs to the Order Module.
<TypeList types={[{"name":"[OptionalProps]","type":"[ModelDateColumns](../../../types/DAL/types/types.DAL.ModelDateColumns/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"promotion_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"amount","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"provider_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method","type":"[ShippingMethod](../order_models.ShippingMethod/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"amount","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"is_tax_inclusive","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"data","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"tax_lines","type":"Collection&#60;[ShippingMethodTaxLine](../order_models.ShippingMethodTaxLine/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"shipping_method","type":"[ShippingMethod](../order_models.ShippingMethod/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_rate","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"adjustments","type":"Collection&#60;[ShippingLine truncated <TypeList types={[{"name":"[OptionalProps]","type":"[ModelDateColumns](../../../types/DAL/types/types.DAL.ModelDateColumns/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"promotion_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"amount","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"provider_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"shipping_method","type":"[ShippingMethod](../order_models.ShippingMethod/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"amount","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"is_tax_inclusive","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"data","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"tax_lines","type":"Collection&#60;[ShippingMethodTaxLine](../order_models.ShippingMethodTaxLine/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"shipping_method","type":"[ShippingMethod](../order_models.ShippingMethod/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_rate","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`null` \\| `string`","Line truncated
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the ShippingMethodTaxLine . This belongs to the Order Module. This documentation provides a reference to the ShippingMethodTaxLine . This belongs to the Order Module.
<TypeList types={[{"name":"shipping_method","type":"[ShippingMethod](../order_models.ShippingMethod/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"amount","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"is_tax_inclusive","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"data","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"tax_lines","type":"Collection&#60;[ShippingMethodTaxLine](page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"shipping_method","type":"[ShippingMethod](../order_models.ShippingMethod/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_rate","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"adjustments","type":"Collection&#60;[ShippingMethodAdjustment](../order_models.ShippingMethodAdjustment/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"[OptionalProps]","type":"[ModelDateColumns](../../../types/DAL/types/types.DAL.ModelDateColumns/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"promotion_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"amount","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"naLine truncated <TypeList types={[{"name":"shipping_method","type":"[ShippingMethod](../order_models.ShippingMethod/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"amount","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"is_tax_inclusive","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"data","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"tax_lines","type":"Collection&#60;[ShippingMethodTaxLine](page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"shipping_method","type":"[ShippingMethod](../order_models.ShippingMethod/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_rate","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"adjustments","type":"Collection&#60;[ShippingMethodAdjustment](../order_models.ShippingMethodAdjustment/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"[OptionalProps]","type":"[ModelDateColumns](../../../types/DAL/types/types.DAL.ModelDateColumns/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"promotion_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"amount","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"chiLine truncated
@@ -12,4 +12,4 @@ import { TypeList } from "docs-ui"
## Returns ## Returns
<TypeList types={[{"name":"Record","type":"`Record<string, [Message](../../../types/payment.Message/page.mdx)[]>`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"Message[]","type":"[Message](../../../types/payment.Message/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"Message","type":"[MessageBody](../../../types/payment.MessageBody/page.mdx)&#60;TData&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="getMessages"/> <TypeList types={[{"name":"Record","type":"`Record<string, [Message](../../../types/payment.Message/page.mdx)[]>`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"Message[]","type":"[Message](../../../types/payment.Message/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"Message","type":"[Event](../../../types/payment.Event/page.mdx)&#60;TData&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="getMessages"/>
@@ -8,7 +8,7 @@ import { TypeList } from "docs-ui"
## Parameters ## Parameters
<TypeList types={[{"name":"msg","type":"[Message](../../../types/payment.Message/page.mdx) \\| [Message](../../../types/payment.Message/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"eventName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[EventMetadata](../../../types/payment.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="save"/> <TypeList types={[{"name":"msg","type":"[Message](../../../types/payment.Message/page.mdx) \\| [Message](../../../types/payment.Message/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[EventMetadata](../../../types/payment.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="save"/>
## Returns ## Returns
@@ -0,0 +1,13 @@
---
displayed_sidebar: paymentReference
---
import { TypeList } from "docs-ui"
# Event
**Event**: `Object`
## Properties
<TypeList types={[{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[EventMetadata](../payment.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="Event"/>
@@ -6,4 +6,4 @@ import { TypeList } from "docs-ui"
# Message # Message
**Message**: [MessageBody](../payment.MessageBody/page.mdx)&#60;TData&#62; & `object` **Message**: [Event](../payment.Event/page.mdx)&#60;TData&#62; & `object`
@@ -1,13 +0,0 @@
---
displayed_sidebar: paymentReference
---
import { TypeList } from "docs-ui"
# MessageBody
**MessageBody**: `Object`
## Properties
<TypeList types={[{"name":"eventName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[EventMetadata](../payment.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="MessageBody"/>
@@ -12,4 +12,4 @@ import { TypeList } from "docs-ui"
## Returns ## Returns
<TypeList types={[{"name":"Record","type":"`Record<string, [Message](../../../types/pricing.Message/page.mdx)[]>`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"Message[]","type":"[Message](../../../types/pricing.Message/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"Message","type":"[MessageBody](../../../types/pricing.MessageBody/page.mdx)&#60;TData&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="getMessages"/> <TypeList types={[{"name":"Record","type":"`Record<string, [Message](../../../types/pricing.Message/page.mdx)[]>`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"Message[]","type":"[Message](../../../types/pricing.Message/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"Message","type":"[Event](../../../types/pricing.Event/page.mdx)&#60;TData&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="getMessages"/>
@@ -8,7 +8,7 @@ import { TypeList } from "docs-ui"
## Parameters ## Parameters
<TypeList types={[{"name":"msg","type":"[Message](../../../types/pricing.Message/page.mdx) \\| [Message](../../../types/pricing.Message/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"eventName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[EventMetadata](../../../types/pricing.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="save"/> <TypeList types={[{"name":"msg","type":"[Message](../../../types/pricing.Message/page.mdx) \\| [Message](../../../types/pricing.Message/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[EventMetadata](../../../types/pricing.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="save"/>
## Returns ## Returns
@@ -0,0 +1,13 @@
---
displayed_sidebar: pricingReference
---
import { TypeList } from "docs-ui"
# Event
**Event**: `Object`
## Properties
<TypeList types={[{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[EventMetadata](../pricing.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="Event"/>
@@ -6,4 +6,4 @@ import { TypeList } from "docs-ui"
# Message # Message
**Message**: [MessageBody](../pricing.MessageBody/page.mdx)&#60;TData&#62; & `object` **Message**: [Event](../pricing.Event/page.mdx)&#60;TData&#62; & `object`
@@ -1,13 +0,0 @@
---
displayed_sidebar: pricingReference
---
import { TypeList } from "docs-ui"
# MessageBody
**MessageBody**: `Object`
## Properties
<TypeList types={[{"name":"eventName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[EventMetadata](../pricing.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="MessageBody"/>
@@ -12,4 +12,4 @@ import { TypeList } from "docs-ui"
## Returns ## Returns
<TypeList types={[{"name":"Record","type":"`Record<string, [Message](../../../types/product.Message/page.mdx)[]>`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"Message[]","type":"[Message](../../../types/product.Message/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"Message","type":"[MessageBody](../../../types/product.MessageBody/page.mdx)&#60;TData&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="getMessages"/> <TypeList types={[{"name":"Record","type":"`Record<string, [Message](../../../types/product.Message/page.mdx)[]>`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"Message[]","type":"[Message](../../../types/product.Message/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"Message","type":"[Event](../../../types/product.Event/page.mdx)&#60;TData&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="getMessages"/>
@@ -8,7 +8,7 @@ import { TypeList } from "docs-ui"
## Parameters ## Parameters
<TypeList types={[{"name":"msg","type":"[Message](../../../types/product.Message/page.mdx) \\| [Message](../../../types/product.Message/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"eventName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[EventMetadata](../../../types/product.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="save"/> <TypeList types={[{"name":"msg","type":"[Message](../../../types/product.Message/page.mdx) \\| [Message](../../../types/product.Message/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[EventMetadata](../../../types/product.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="save"/>
## Returns ## Returns
@@ -0,0 +1,13 @@
---
displayed_sidebar: productReference
---
import { TypeList } from "docs-ui"
# Event
**Event**: `Object`
## Properties
<TypeList types={[{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[EventMetadata](../product.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="Event"/>
@@ -6,4 +6,4 @@ import { TypeList } from "docs-ui"
# Message # Message
**Message**: [MessageBody](../product.MessageBody/page.mdx)&#60;TData&#62; & `object` **Message**: [Event](../product.Event/page.mdx)&#60;TData&#62; & `object`
Loaded 100 of 176 files, more files were not shown because too many files have changed in this diff. Show more