docs: generated references after collapse types improvement (#11889)
This commit is contained in:
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -35,4 +35,4 @@ const {
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[OrderChangeReturn](../../../interfaces/order.OrderChangeReturn/page.mdx)>","optional":false,"defaultValue":"","description":"The changes made by applying the actions on the orders.","expandable":false,"children":[{"name":"OrderChangeReturn","type":"[OrderChangeReturn](../../../interfaces/order.OrderChangeReturn/page.mdx)","optional":false,"defaultValue":"","description":"The details of changes made on orders.","expandable":false,"children":[{"name":"items","type":"`object`[]","description":"The list of items created or updated.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"item_id","type":"`string`","description":"The associated item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfilled_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's fulfilled quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's shipped quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_requested_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's request quantity to be returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_received_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's quantity that was received through a return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_dismissed_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's quantity that was dismissed in a return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"written_off_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's quantity that was written off.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shippingMethods","type":"`any`[]","description":"The list of shipping methods created or updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="applyPendingOrderActions"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[OrderChangeReturn](../../../interfaces/order.OrderChangeReturn/page.mdx)>","optional":false,"defaultValue":"","description":"The changes made by applying the actions on the orders.","expandable":false,"children":[{"name":"items","type":"`object`[]","description":"The list of items created or updated.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"item_id","type":"`string`","description":"The associated item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfilled_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's fulfilled quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's shipped quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_requested_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's request quantity to be returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_received_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's quantity that was received through a return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_dismissed_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's quantity that was dismissed in a return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"written_off_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's quantity that was written off.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shippingMethods","type":"`any`[]","description":"The list of shipping methods created or updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="applyPendingOrderActions"/>
|
||||
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -35,7 +35,7 @@ const {
|
||||
|
||||
### Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[OrderChangeReturn](../../../interfaces/order.OrderChangeReturn/page.mdx)>","optional":false,"defaultValue":"","description":"The item and shipping method changes made on the order.","expandable":false,"children":[{"name":"OrderChangeReturn","type":"[OrderChangeReturn](../../../interfaces/order.OrderChangeReturn/page.mdx)","optional":false,"defaultValue":"","description":"The details of changes made on orders.","expandable":false,"children":[{"name":"items","type":"`object`[]","description":"The list of items created or updated.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"item_id","type":"`string`","description":"The associated item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfilled_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's fulfilled quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's shipped quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_requested_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's request quantity to be returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_received_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's quantity that was received through a return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_dismissed_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's quantity that was dismissed in a return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"written_off_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's quantity that was written off.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shippingMethods","type":"`any`[]","description":"The list of shipping methods created or updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="confirmOrderChange"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[OrderChangeReturn](../../../interfaces/order.OrderChangeReturn/page.mdx)>","optional":false,"defaultValue":"","description":"The item and shipping method changes made on the order.","expandable":false,"children":[{"name":"items","type":"`object`[]","description":"The list of items created or updated.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"item_id","type":"`string`","description":"The associated item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfilled_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's fulfilled quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's shipped quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_requested_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's request quantity to be returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_received_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's quantity that was received through a return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_dismissed_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's quantity that was dismissed in a return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"written_off_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's quantity that was written off.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shippingMethods","type":"`any`[]","description":"The list of shipping methods created or updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="confirmOrderChange"/>
|
||||
|
||||
## confirmOrderChange(orderChangeId, sharedContext?): Promise<[OrderChangeReturn](../../../interfaces/order.OrderChangeReturn/page.mdx)>
|
||||
|
||||
@@ -53,7 +53,7 @@ await orderModuleService.confirmOrderChange(["123"])
|
||||
|
||||
### Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[OrderChangeReturn](../../../interfaces/order.OrderChangeReturn/page.mdx)>","optional":false,"defaultValue":"","description":"The item and shipping method changes made on the order.","expandable":false,"children":[{"name":"OrderChangeReturn","type":"[OrderChangeReturn](../../../interfaces/order.OrderChangeReturn/page.mdx)","optional":false,"defaultValue":"","description":"The details of changes made on orders.","expandable":false,"children":[{"name":"items","type":"`object`[]","description":"The list of items created or updated.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"item_id","type":"`string`","description":"The associated item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfilled_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's fulfilled quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's shipped quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_requested_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's request quantity to be returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_received_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's quantity that was received through a return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_dismissed_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's quantity that was dismissed in a return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"written_off_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's quantity that was written off.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shippingMethods","type":"`any`[]","description":"The list of shipping methods created or updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="confirmOrderChange"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[OrderChangeReturn](../../../interfaces/order.OrderChangeReturn/page.mdx)>","optional":false,"defaultValue":"","description":"The item and shipping method changes made on the order.","expandable":false,"children":[{"name":"items","type":"`object`[]","description":"The list of items created or updated.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"item_id","type":"`string`","description":"The associated item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfilled_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's fulfilled quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's shipped quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_requested_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's request quantity to be returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_received_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's quantity that was received through a return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_dismissed_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's quantity that was dismissed in a return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"written_off_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's quantity that was written off.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shippingMethods","type":"`any`[]","description":"The list of shipping methods created or updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="confirmOrderChange"/>
|
||||
|
||||
## confirmOrderChange(data, sharedContext?): Promise<[OrderChangeReturn](../../../interfaces/order.OrderChangeReturn/page.mdx)>
|
||||
|
||||
@@ -74,7 +74,7 @@ await orderModuleService.confirmOrderChange({
|
||||
|
||||
### Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[OrderChangeReturn](../../../interfaces/order.OrderChangeReturn/page.mdx)>","optional":false,"defaultValue":"","description":"The item and shipping method changes made on the order.","expandable":false,"children":[{"name":"OrderChangeReturn","type":"[OrderChangeReturn](../../../interfaces/order.OrderChangeReturn/page.mdx)","optional":false,"defaultValue":"","description":"The details of changes made on orders.","expandable":false,"children":[{"name":"items","type":"`object`[]","description":"The list of items created or updated.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"item_id","type":"`string`","description":"The associated item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfilled_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's fulfilled quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's shipped quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_requested_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's request quantity to be returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_received_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's quantity that was received through a return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_dismissed_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's quantity that was dismissed in a return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"written_off_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's quantity that was written off.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shippingMethods","type":"`any`[]","description":"The list of shipping methods created or updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="confirmOrderChange"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[OrderChangeReturn](../../../interfaces/order.OrderChangeReturn/page.mdx)>","optional":false,"defaultValue":"","description":"The item and shipping method changes made on the order.","expandable":false,"children":[{"name":"items","type":"`object`[]","description":"The list of items created or updated.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"item_id","type":"`string`","description":"The associated item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfilled_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's fulfilled quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's shipped quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_requested_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's request quantity to be returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_received_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's quantity that was received through a return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_dismissed_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's quantity that was dismissed in a return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"written_off_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's quantity that was written off.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shippingMethods","type":"`any`[]","description":"The list of shipping methods created or updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="confirmOrderChange"/>
|
||||
|
||||
## confirmOrderChange(data, sharedContext?): Promise<[OrderChangeReturn](../../../interfaces/order.OrderChangeReturn/page.mdx)>
|
||||
|
||||
@@ -95,4 +95,4 @@ await orderModuleService.confirmOrderChange([{
|
||||
|
||||
### Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[OrderChangeReturn](../../../interfaces/order.OrderChangeReturn/page.mdx)>","optional":false,"defaultValue":"","description":"The item and shipping method changes made on all the orders.","expandable":false,"children":[{"name":"OrderChangeReturn","type":"[OrderChangeReturn](../../../interfaces/order.OrderChangeReturn/page.mdx)","optional":false,"defaultValue":"","description":"The details of changes made on orders.","expandable":false,"children":[{"name":"items","type":"`object`[]","description":"The list of items created or updated.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"item_id","type":"`string`","description":"The associated item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfilled_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's fulfilled quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's shipped quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_requested_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's request quantity to be returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_received_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's quantity that was received through a return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_dismissed_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's quantity that was dismissed in a return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"written_off_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's quantity that was written off.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shippingMethods","type":"`any`[]","description":"The list of shipping methods created or updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="confirmOrderChange"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[OrderChangeReturn](../../../interfaces/order.OrderChangeReturn/page.mdx)>","optional":false,"defaultValue":"","description":"The item and shipping method changes made on all the orders.","expandable":false,"children":[{"name":"items","type":"`object`[]","description":"The list of items created or updated.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"item_id","type":"`string`","description":"The associated item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfilled_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's fulfilled quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's shipped quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_requested_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's request quantity to be returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_received_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's quantity that was received through a return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_dismissed_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's quantity that was dismissed in a return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"written_off_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's quantity that was written off.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shippingMethods","type":"`any`[]","description":"The list of shipping methods created or updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="confirmOrderChange"/>
|
||||
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -42,7 +42,7 @@ const addresses = await orderModuleService.createOrderAddresses([
|
||||
|
||||
### Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[OrderAddressDTO](../../../interfaces/order.OrderAddressDTO/page.mdx)[]>","optional":false,"defaultValue":"","description":"The created addresses.","expandable":false,"children":[{"name":"OrderAddressDTO[]","type":"[OrderAddressDTO](../../../interfaces/order.OrderAddressDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderAddressDTO","type":"`object`","description":"The address details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createOrderAddresses"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[OrderAddressDTO](../../../interfaces/order.OrderAddressDTO/page.mdx)[]>","optional":false,"defaultValue":"","description":"The created addresses.","expandable":false,"children":[{"name":"OrderAddressDTO[]","type":"[OrderAddressDTO](../../../interfaces/order.OrderAddressDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the address was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the address was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The customer ID of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The phone number of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The first address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The second address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string`","description":"The province/state of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"The postal code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createOrderAddresses"/>
|
||||
|
||||
## createOrderAddresses(data, sharedContext?): Promise<[OrderAddressDTO](../../../interfaces/order.OrderAddressDTO/page.mdx)>
|
||||
|
||||
@@ -68,4 +68,4 @@ const address = await orderModuleService.createOrderAddresses({
|
||||
|
||||
### Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[OrderAddressDTO](../../../interfaces/order.OrderAddressDTO/page.mdx)>","optional":false,"defaultValue":"","description":"The created return.","expandable":false,"children":[{"name":"OrderAddressDTO","type":"[OrderAddressDTO](../../../interfaces/order.OrderAddressDTO/page.mdx)","optional":false,"defaultValue":"","description":"The address details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the address was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the address was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The customer ID of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The phone number of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The first address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The second address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string`","description":"The province/state of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"The postal code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createOrderAddresses"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[OrderAddressDTO](../../../interfaces/order.OrderAddressDTO/page.mdx)>","optional":false,"defaultValue":"","description":"The created return.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the address was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the address was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The customer ID of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The phone number of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The first address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The second address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string`","description":"The province/state of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"The postal code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createOrderAddresses"/>
|
||||
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -36,7 +36,7 @@ const returnItem = await orderModuleService.createReturnItems({
|
||||
|
||||
### Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[OrderReturnItemDTO](../../../interfaces/order.OrderReturnItemDTO/page.mdx)>","optional":false,"defaultValue":"","description":"The created return item.","expandable":false,"children":[{"name":"OrderReturnItemDTO","type":"[OrderReturnItemDTO](../../../interfaces/order.OrderReturnItemDTO/page.mdx)","optional":false,"defaultValue":"","description":"The order return item details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order return item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"The associated line item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the item to return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_quantity","type":"[BigNumberRawValue](../../../types/order.BigNumberRawValue/page.mdx)","description":"The raw quantity of the item to return.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"reason_id","type":"`null` \\| `string`","description":"The associated reason's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"received_quantity","type":"`number`","description":"The received quantity of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_received_quantity","type":"[BigNumberRawValue](../../../types/order.BigNumberRawValue/page.mdx)","description":"The raw received quantity of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"damaged_quantity","type":"`number`","description":"The damaged quantity of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_damaged_quantity","type":"[BigNumberRawValue](../../../types/order.BigNumberRawValue/page.mdx)","description":"The raw damaged quantity of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createReturnItems"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[OrderReturnItemDTO](../../../interfaces/order.OrderReturnItemDTO/page.mdx)>","optional":false,"defaultValue":"","description":"The created return item.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order return item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"The associated line item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the item to return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_quantity","type":"[BigNumberRawValue](../../../types/order.BigNumberRawValue/page.mdx)","description":"The raw quantity of the item to return.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"reason_id","type":"`null` \\| `string`","description":"The associated reason's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"received_quantity","type":"`number`","description":"The received quantity of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_received_quantity","type":"[BigNumberRawValue](../../../types/order.BigNumberRawValue/page.mdx)","description":"The raw received quantity of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"damaged_quantity","type":"`number`","description":"The damaged quantity of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_damaged_quantity","type":"[BigNumberRawValue](../../../types/order.BigNumberRawValue/page.mdx)","description":"The raw damaged quantity of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createReturnItems"/>
|
||||
|
||||
## createReturnItems(data, sharedContext?): Promise<[OrderReturnItemDTO](../../../interfaces/order.OrderReturnItemDTO/page.mdx)[]>
|
||||
|
||||
@@ -58,4 +58,4 @@ const returnItems = await orderModuleService.createReturnItems([{
|
||||
|
||||
### Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[OrderReturnItemDTO](../../../interfaces/order.OrderReturnItemDTO/page.mdx)[]>","optional":false,"defaultValue":"","description":"The created return items.","expandable":false,"children":[{"name":"OrderReturnItemDTO[]","type":"[OrderReturnItemDTO](../../../interfaces/order.OrderReturnItemDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderReturnItemDTO","type":"`object`","description":"The order return item details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createReturnItems"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[OrderReturnItemDTO](../../../interfaces/order.OrderReturnItemDTO/page.mdx)[]>","optional":false,"defaultValue":"","description":"The created return items.","expandable":false,"children":[{"name":"OrderReturnItemDTO[]","type":"[OrderReturnItemDTO](../../../interfaces/order.OrderReturnItemDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order return item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"The associated line item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the item to return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_quantity","type":"[BigNumberRawValue](../../../types/order.BigNumberRawValue/page.mdx)","description":"The raw quantity of the item to return.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"reason_id","type":"`null` \\| `string`","description":"The associated reason's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"received_quantity","type":"`number`","description":"The received quantity of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_received_quantity","type":"[BigNumberRawValue](../../../types/order.BigNumberRawValue/page.mdx)","description":"The raw received quantity of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"damaged_quantity","type":"`number`","description":"The damaged quantity of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_damaged_quantity","type":"[BigNumberRawValue](../../../types/order.BigNumberRawValue/page.mdx)","description":"The raw damaged quantity of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createReturnItems"/>
|
||||
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -45,4 +45,4 @@ const addresses = await orderModuleService.listOrderAddresses({
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[OrderAddressDTO](../../../interfaces/order.OrderAddressDTO/page.mdx)[]>","optional":false,"defaultValue":"","description":"The list of addresses.","expandable":false,"children":[{"name":"OrderAddressDTO[]","type":"[OrderAddressDTO](../../../interfaces/order.OrderAddressDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderAddressDTO","type":"`object`","description":"The address details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="listOrderAddresses"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[OrderAddressDTO](../../../interfaces/order.OrderAddressDTO/page.mdx)[]>","optional":false,"defaultValue":"","description":"The list of addresses.","expandable":false,"children":[{"name":"OrderAddressDTO[]","type":"[OrderAddressDTO](../../../interfaces/order.OrderAddressDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the address was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the address was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The customer ID of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The phone number of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The first address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The second address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string`","description":"The province/state of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"The postal code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="listOrderAddresses"/>
|
||||
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -35,7 +35,7 @@ const addresses = await orderModuleService.updateOrderAddresses([{
|
||||
|
||||
### Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[OrderAddressDTO](../../../interfaces/order.OrderAddressDTO/page.mdx)[]>","optional":false,"defaultValue":"","description":"The updated addresses.","expandable":false,"children":[{"name":"OrderAddressDTO[]","type":"[OrderAddressDTO](../../../interfaces/order.OrderAddressDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderAddressDTO","type":"`object`","description":"The address details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateOrderAddresses"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[OrderAddressDTO](../../../interfaces/order.OrderAddressDTO/page.mdx)[]>","optional":false,"defaultValue":"","description":"The updated addresses.","expandable":false,"children":[{"name":"OrderAddressDTO[]","type":"[OrderAddressDTO](../../../interfaces/order.OrderAddressDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the address was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the address was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The customer ID of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The phone number of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The first address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The second address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string`","description":"The province/state of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"The postal code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateOrderAddresses"/>
|
||||
|
||||
## updateOrderAddresses(data, sharedContext?): Promise<[OrderAddressDTO](../../../interfaces/order.OrderAddressDTO/page.mdx)>
|
||||
|
||||
@@ -56,4 +56,4 @@ const address = await orderModuleService.updateOrderAddresses({
|
||||
|
||||
### Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[OrderAddressDTO](../../../interfaces/order.OrderAddressDTO/page.mdx)>","optional":false,"defaultValue":"","description":"The updated address.","expandable":false,"children":[{"name":"OrderAddressDTO","type":"[OrderAddressDTO](../../../interfaces/order.OrderAddressDTO/page.mdx)","optional":false,"defaultValue":"","description":"The address details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the address was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the address was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The customer ID of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The phone number of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The first address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The second address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string`","description":"The province/state of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"The postal code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateOrderAddresses"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[OrderAddressDTO](../../../interfaces/order.OrderAddressDTO/page.mdx)>","optional":false,"defaultValue":"","description":"The updated address.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the address was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the address was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The customer ID of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The phone number of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The first address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The second address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string`","description":"The province/state of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"The postal code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateOrderAddresses"/>
|
||||
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
Reference in New Issue
Block a user