chore(docs): Generated References (automated) (#9727)
Generated the following references: - `api_key` - `auth` - `cart` - `core_flows` - `currency` - `customer` - `dml` - `fulfillment` - `helper_steps` - `inventory_next` - `js_sdk` - `medusa` - `medusa_config` - `modules` - `modules_sdk` - `notification` - `order` - `order_models` - `payment` - `pricing` - `product` - `promotion` - `region` - `sales_channel` - `stock_location_next` - `store` - `tax` - `tax_provider` - `types` - `user` - `utils` - `workflows` Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
2313 files changed
+533036
-383477
No files matched your search
+2
-2
@@ -28,8 +28,8 @@ sdk.admin.claim.addInboundItems(
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the claim to add the inbound items to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"body","type":"[AdminAddClaimInboundItems](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminAddClaimInboundItems/page.mdx)","description":"The inbound items' details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"items","type":"`object`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason","type":"[ClaimReason](../../../../../types/enums/types.ClaimReason/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the return.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addInboundItems"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the claim to add the inbound items to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"body","type":"[AdminAddClaimInboundItems](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminAddClaimInboundItems/page.mdx)","description":"The inbound items' details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"items","type":"`object`[]","description":"The items to add to the claim.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the item in the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity to claim.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason","type":"[ClaimReason](../../../../../types/enums/types.ClaimReason/page.mdx)","description":"The reason for adding this item to the claim.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The claim item's description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"An internal note viewed by admin users only.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the return.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"The fields and relations to retrieve.\n\nLearn more in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addInboundItems"/>
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminClaimReturnPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimReturnPreviewResponse/page.mdx)>","optional":false,"defaultValue":"","description":"The details of the return associated with the claim, with a preview of the order when the claim is applied.","expandable":false,"children":[{"name":"AdminClaimReturnPreviewResponse","type":"[AdminClaimReturnPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimReturnPreviewResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order_preview","type":"`AdminOrderPreview`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return","type":"[AdminReturn](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminReturn/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"items","type":"[AdminReturnItem](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminReturnItem/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_version","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"received_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ReturnStatus](../../../../../order/types/order.ReturnStatus-1/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addInboundItems"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminClaimReturnPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimReturnPreviewResponse/page.mdx)>","optional":false,"defaultValue":"","description":"The details of the return associated with the claim, with a preview of the order when the claim is applied.","expandable":false,"children":[{"name":"AdminClaimReturnPreviewResponse","type":"[AdminClaimReturnPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimReturnPreviewResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order_preview","type":"[AdminOrderPreview](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderPreview/page.mdx)","description":"Preview of the order when the claim is applied.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"payment_collections","type":"[AdminPaymentCollection](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPaymentCollection/page.mdx)[]","description":"The order's payment collections.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_requested_total","type":"`number`","description":"The total amount for the items requested to be returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change","type":"[AdminOrderChange](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderChange/page.mdx)","description":"The details of the changes on the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[AdminOrderLineItem](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderLineItem/page.mdx) & `object`[]","description":"The order's items.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[AdminOrderShippingMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderShippingMethod/page.mdx) & `object`[]","description":"The order's shipping methods.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The order's version.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`null` \\| `string`","description":"The ID of the associated region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"The ID of the customer that placed the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel the order was placed in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"The email of the customer that placed the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The order's currency code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../../../../types/types/types.PaymentStatus/page.mdx)","description":"The order's payment status.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../../../../types/types/types.FulfillmentStatus/page.mdx)","description":"The order's fulfillment status.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"summary","type":"[BaseOrderSummary](../../../../../types/interfaces/types.BaseOrderSummary/page.mdx)","description":"The order's summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The date the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"`number`","description":"The total of the order's items including taxes, excluding promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"`number`","description":"The total of the order's items excluding taxes, including promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"`number`","description":"The tax total applied on the order's items, excluding promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"`number`","desLine truncated
|
||||
+2
-2
@@ -25,8 +25,8 @@ sdk.admin.claim.addInboundShipping(
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"body","type":"[AdminClaimAddInboundShipping](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimAddInboundShipping/page.mdx)","description":"The shipping method's details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"shipping_option_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"custom_amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the return.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addInboundShipping"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"body","type":"[AdminClaimAddInboundShipping](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimAddInboundShipping/page.mdx)","description":"The shipping method's details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"shipping_option_id","type":"`string`","description":"The ID of the shipping option to create the method from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"custom_amount","type":"`number`","description":"A custom amount to use instead of the shipping option's amount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The method's description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"An internal note viewed by admin users only.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Key-value pairs of custom data.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the return.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"The fields and relations to retrieve.\n\nLearn more in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addInboundShipping"/>
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminClaimReturnPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimReturnPreviewResponse/page.mdx)>","optional":false,"defaultValue":"","description":"The details of the return associated wth the claim, with a preview of the order when the claim is applied.","expandable":false,"children":[{"name":"AdminClaimReturnPreviewResponse","type":"[AdminClaimReturnPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimReturnPreviewResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order_preview","type":"`AdminOrderPreview`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return","type":"[AdminReturn](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminReturn/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"items","type":"[AdminReturnItem](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminReturnItem/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_version","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"received_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ReturnStatus](../../../../../order/types/order.ReturnStatus-1/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addInboundShipping"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminClaimReturnPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimReturnPreviewResponse/page.mdx)>","optional":false,"defaultValue":"","description":"The details of the return associated wth the claim, with a preview of the order when the claim is applied.","expandable":false,"children":[{"name":"AdminClaimReturnPreviewResponse","type":"[AdminClaimReturnPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimReturnPreviewResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order_preview","type":"[AdminOrderPreview](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderPreview/page.mdx)","description":"Preview of the order when the claim is applied.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"payment_collections","type":"[AdminPaymentCollection](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPaymentCollection/page.mdx)[]","description":"The order's payment collections.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_requested_total","type":"`number`","description":"The total amount for the items requested to be returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change","type":"[AdminOrderChange](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderChange/page.mdx)","description":"The details of the changes on the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[AdminOrderLineItem](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderLineItem/page.mdx) & `object`[]","description":"The order's items.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[AdminOrderShippingMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderShippingMethod/page.mdx) & `object`[]","description":"The order's shipping methods.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The order's version.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`null` \\| `string`","description":"The ID of the associated region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"The ID of the customer that placed the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel the order was placed in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"The email of the customer that placed the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The order's currency code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../../../../types/types/types.PaymentStatus/page.mdx)","description":"The order's payment status.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../../../../types/types/types.FulfillmentStatus/page.mdx)","description":"The order's fulfillment status.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"summary","type":"[BaseOrderSummary](../../../../../types/interfaces/types.BaseOrderSummary/page.mdx)","description":"The order's summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The date the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"`number`","description":"The total of the order's items including taxes, excluding promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"`number`","description":"The total of the order's items excluding taxes, including promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"`number`","description":"The tax total applied on the order's items, excluding promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"`number`","descLine truncated
|
||||
+2
-2
@@ -23,8 +23,8 @@ sdk.admin.claim.addItems("claim_123", {
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the claim to add the items to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"body","type":"[AdminAddClaimItems](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminAddClaimItems/page.mdx)","description":"The items' details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"items","type":"`object`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason","type":"[ClaimReason](../../../../../types/enums/types.ClaimReason/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the claim.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addItems"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the claim to add the items to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"body","type":"[AdminAddClaimItems](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminAddClaimItems/page.mdx)","description":"The items' details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"items","type":"`object`[]","description":"The items to add to the claim.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the item in the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity to claim.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason","type":"[ClaimReason](../../../../../types/enums/types.ClaimReason/page.mdx)","description":"The reason for adding this item to the claim.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The claim item's description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"An internal note viewed by admin users only.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the claim.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"The fields and relations to retrieve.\n\nLearn more in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addItems"/>
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminClaimPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimPreviewResponse/page.mdx)>","optional":false,"defaultValue":"","description":"The claim's details with a preview of the order when the claim is applied.","expandable":false,"children":[{"name":"AdminClaimPreviewResponse","type":"[AdminClaimPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimPreviewResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order_preview","type":"`AdminOrderPreview`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim","type":"[AdminClaim](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaim/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"order","type":"`AdminOrder`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return","type":"[AdminReturn](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminReturn/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[OrderClaimType](../../../../../fulfillment/types/fulfillment.OrderClaimType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"[BaseClaimItem](../../../../../types/interfaces/types.BaseClaimItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_items","type":"[BaseClaimItem](../../../../../types/interfaces/types.BaseClaimItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"`AdminOrderShippingMethod`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactions","type":"`BaseOrderTransaction`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addItems"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminClaimPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimPreviewResponse/page.mdx)>","optional":false,"defaultValue":"","description":"The claim's details with a preview of the order when the claim is applied.","expandable":false,"children":[{"name":"AdminClaimPreviewResponse","type":"[AdminClaimPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimPreviewResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order_preview","type":"[AdminOrderPreview](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderPreview/page.mdx)","description":"Preview of the order when the claim is applied.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"payment_collections","type":"[AdminPaymentCollection](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPaymentCollection/page.mdx)[]","description":"The order's payment collections.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_requested_total","type":"`number`","description":"The total amount for the items requested to be returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change","type":"[AdminOrderChange](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderChange/page.mdx)","description":"The details of the changes on the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[AdminOrderLineItem](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderLineItem/page.mdx) & `object`[]","description":"The order's items.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[AdminOrderShippingMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderShippingMethod/page.mdx) & `object`[]","description":"The order's shipping methods.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The order's version.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`null` \\| `string`","description":"The ID of the associated region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"The ID of the customer that placed the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel the order was placed in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"The email of the customer that placed the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The order's currency code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../../../../types/types/types.PaymentStatus/page.mdx)","description":"The order's payment status.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../../../../types/types/types.FulfillmentStatus/page.mdx)","description":"The order's fulfillment status.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"summary","type":"[BaseOrderSummary](../../../../../types/interfaces/types.BaseOrderSummary/page.mdx)","description":"The order's summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The date the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"`number`","description":"The total of the order's items including taxes, excluding promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"`number`","description":"The total of the order's items excluding taxes, including promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"`number`","description":"The tax total applied on the order's items, excluding promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"`number`","description":"The total of the order's items including taxes and pLine truncated
|
||||
+2
-2
@@ -25,8 +25,8 @@ sdk.admin.claim.addOutboundItems(
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the claim to add the outbound items to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"body","type":"[AdminAddClaimOutboundItems](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminAddClaimOutboundItems/page.mdx)","description":"The items' details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"items","type":"`object`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason","type":"[ClaimReason](../../../../../types/enums/types.ClaimReason/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the claim.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addOutboundItems"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the claim to add the outbound items to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"body","type":"[AdminAddClaimOutboundItems](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminAddClaimOutboundItems/page.mdx)","description":"The items' details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"items","type":"`object`[]","description":"The items to add to the claim.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the item in the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity to claim.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason","type":"[ClaimReason](../../../../../types/enums/types.ClaimReason/page.mdx)","description":"The reason for adding this item to the claim.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The claim item's description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"An internal note viewed by admin users only.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the claim.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"The fields and relations to retrieve.\n\nLearn more in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addOutboundItems"/>
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminClaimPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimPreviewResponse/page.mdx)>","optional":false,"defaultValue":"","description":"The details of the claim, with a preview of the order when the claim is applied.","expandable":false,"children":[{"name":"AdminClaimPreviewResponse","type":"[AdminClaimPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimPreviewResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order_preview","type":"`AdminOrderPreview`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim","type":"[AdminClaim](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaim/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"order","type":"`AdminOrder`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return","type":"[AdminReturn](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminReturn/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[OrderClaimType](../../../../../fulfillment/types/fulfillment.OrderClaimType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"[BaseClaimItem](../../../../../types/interfaces/types.BaseClaimItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_items","type":"[BaseClaimItem](../../../../../types/interfaces/types.BaseClaimItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"`AdminOrderShippingMethod`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactions","type":"`BaseOrderTransaction`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addOutboundItems"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminClaimPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimPreviewResponse/page.mdx)>","optional":false,"defaultValue":"","description":"The details of the claim, with a preview of the order when the claim is applied.","expandable":false,"children":[{"name":"AdminClaimPreviewResponse","type":"[AdminClaimPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimPreviewResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order_preview","type":"[AdminOrderPreview](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderPreview/page.mdx)","description":"Preview of the order when the claim is applied.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"payment_collections","type":"[AdminPaymentCollection](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPaymentCollection/page.mdx)[]","description":"The order's payment collections.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_requested_total","type":"`number`","description":"The total amount for the items requested to be returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change","type":"[AdminOrderChange](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderChange/page.mdx)","description":"The details of the changes on the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[AdminOrderLineItem](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderLineItem/page.mdx) & `object`[]","description":"The order's items.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[AdminOrderShippingMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderShippingMethod/page.mdx) & `object`[]","description":"The order's shipping methods.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The order's version.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`null` \\| `string`","description":"The ID of the associated region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"The ID of the customer that placed the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel the order was placed in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"The email of the customer that placed the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The order's currency code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../../../../types/types/types.PaymentStatus/page.mdx)","description":"The order's payment status.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../../../../types/types/types.FulfillmentStatus/page.mdx)","description":"The order's fulfillment status.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"summary","type":"[BaseOrderSummary](../../../../../types/interfaces/types.BaseOrderSummary/page.mdx)","description":"The order's summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The date the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"`number`","description":"The total of the order's items including taxes, excluding promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"`number`","description":"The total of the order's items excluding taxes, including promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"`number`","description":"The tax total applied on the order's items, excluding promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"`number`","description":"The total of the order's items including taxesLine truncated
|
||||
+2
-2
@@ -26,8 +26,8 @@ API route.
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"body","type":"[AdminClaimAddOutboundShipping](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimAddOutboundShipping/page.mdx)","description":"The shipping method's details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"shipping_option_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"custom_amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the claim.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addOutboundShipping"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"body","type":"[AdminClaimAddOutboundShipping](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimAddOutboundShipping/page.mdx)","description":"The shipping method's details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"shipping_option_id","type":"`string`","description":"The ID of the shipping option to create the method from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"custom_amount","type":"`number`","description":"A custom amount to use instead of the shipping option's amount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The method's description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"An internal note viewed by admin users only.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Key-value pairs of custom data.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the claim.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"The fields and relations to retrieve.\n\nLearn more in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addOutboundShipping"/>
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminClaimPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimPreviewResponse/page.mdx)>","optional":false,"defaultValue":"","description":"The details of the claim, with a preview of the order when the claim is applied.","expandable":false,"children":[{"name":"AdminClaimPreviewResponse","type":"[AdminClaimPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimPreviewResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order_preview","type":"`AdminOrderPreview`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim","type":"[AdminClaim](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaim/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"order","type":"`AdminOrder`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return","type":"[AdminReturn](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminReturn/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[OrderClaimType](../../../../../fulfillment/types/fulfillment.OrderClaimType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"[BaseClaimItem](../../../../../types/interfaces/types.BaseClaimItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_items","type":"[BaseClaimItem](../../../../../types/interfaces/types.BaseClaimItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"`AdminOrderShippingMethod`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactions","type":"`BaseOrderTransaction`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addOutboundShipping"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminClaimPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimPreviewResponse/page.mdx)>","optional":false,"defaultValue":"","description":"The details of the claim, with a preview of the order when the claim is applied.","expandable":false,"children":[{"name":"AdminClaimPreviewResponse","type":"[AdminClaimPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimPreviewResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order_preview","type":"[AdminOrderPreview](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderPreview/page.mdx)","description":"Preview of the order when the claim is applied.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"payment_collections","type":"[AdminPaymentCollection](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPaymentCollection/page.mdx)[]","description":"The order's payment collections.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_requested_total","type":"`number`","description":"The total amount for the items requested to be returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change","type":"[AdminOrderChange](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderChange/page.mdx)","description":"The details of the changes on the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[AdminOrderLineItem](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderLineItem/page.mdx) & `object`[]","description":"The order's items.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[AdminOrderShippingMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderShippingMethod/page.mdx) & `object`[]","description":"The order's shipping methods.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The order's version.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`null` \\| `string`","description":"The ID of the associated region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"The ID of the customer that placed the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel the order was placed in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"The email of the customer that placed the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The order's currency code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../../../../types/types/types.PaymentStatus/page.mdx)","description":"The order's payment status.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../../../../types/types/types.FulfillmentStatus/page.mdx)","description":"The order's fulfillment status.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"summary","type":"[BaseOrderSummary](../../../../../types/interfaces/types.BaseOrderSummary/page.mdx)","description":"The order's summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The date the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"`number`","description":"The total of the order's items including taxes, excluding promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"`number`","description":"The total of the order's items excluding taxes, including promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"`number`","description":"The tax total applied on the order's items, excluding promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"`number`","description":"The total of the order's items including taxesLine truncated
|
||||
+2
-2
@@ -16,8 +16,8 @@ sdk.admin.claim.cancel("claim_123")
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the claim.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="cancel"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the claim.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"The fields and relations to retrieve.\n\nLearn more in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="cancel"/>
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminClaimResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimResponse/page.mdx)>","optional":false,"defaultValue":"","description":"The claim's details.","expandable":false,"children":[{"name":"AdminClaimResponse","type":"[AdminClaimResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"claim","type":"[AdminClaim](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaim/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"order","type":"`AdminOrder`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return","type":"[AdminReturn](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminReturn/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[OrderClaimType](../../../../../fulfillment/types/fulfillment.OrderClaimType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"[BaseClaimItem](../../../../../types/interfaces/types.BaseClaimItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_items","type":"[BaseClaimItem](../../../../../types/interfaces/types.BaseClaimItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"`AdminOrderShippingMethod`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactions","type":"`BaseOrderTransaction`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="cancel"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminClaimResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimResponse/page.mdx)>","optional":false,"defaultValue":"","description":"The claim's details.","expandable":false,"children":[{"name":"AdminClaimResponse","type":"[AdminClaimResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"claim","type":"[AdminClaim](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaim/page.mdx)","description":"The claim's details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"order","type":"[AdminOrder](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrder/page.mdx)","description":"The order this claim is created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return","type":"[AdminReturn](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminReturn/page.mdx)","description":"The associated return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[OrderClaimType](../../../../../fulfillment/types/fulfillment.OrderClaimType/page.mdx)","description":"The claim's type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the order this claim was created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The claim's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`string`","description":"The version of the order when the claim is applied.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The date the claim was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date the claim was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"The date the claim was canceled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"[BaseClaimItem](../../../../../types/interfaces/types.BaseClaimItem/page.mdx)[]","description":"The claim's additional items if its `type` is `replace`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_items","type":"[BaseClaimItem](../../../../../types/interfaces/types.BaseClaimItem/page.mdx)[]","description":"The claim's items.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[AdminOrderShippingMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderShippingMethod/page.mdx)[]","description":"The shipping methods of the claim's additional items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The ID of the associated return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"`number`","description":"The amount to be refunded due to this claim.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"The ID of the user that created this claim.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"The date the claim was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Whether to notify the customer about changes in the claim.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactions","type":"[BaseOrderTransaction](../../../../../types/interfaces/types.BaseOrderTransaction/page.mdx)[]","description":"The claim's transactions.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Key-value pairs of custom data.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="cancel"/>
|
||||
+1
-1
@@ -19,7 +19,7 @@ sdk.admin.claim.cancelRequest(
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the claim.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="cancelRequest"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the claim.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"The fields and relations to retrieve.\n\nLearn more in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="cancelRequest"/>
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+2
-2
@@ -19,8 +19,8 @@ sdk.admin.claim.create({
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"body","type":"[AdminCreateClaim](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCreateClaim/page.mdx)","description":"The claim's details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"type","type":"`\"replace\"` \\| `\"refund\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the claim.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/>
|
||||
<TypeList types={[{"name":"body","type":"[AdminCreateClaim](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCreateClaim/page.mdx)","description":"The claim's details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"type","type":"`\"replace\"` \\| `\"refund\"`","description":"The claim's type. If `refund`, it means the claim's items\nare returned and the customer is refunded. If `replace`, it\nmeans the merchant will send new items in place of the returned items.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the order this claim is created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The claim's description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"An internal note viewed by admin users only.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Key-value pairs of custom data.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the claim.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"The fields and relations to retrieve.\n\nLearn more in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/>
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminClaimOrderResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimOrderResponse/page.mdx)>","optional":false,"defaultValue":"","description":"The claim and order's details.","expandable":false,"children":[{"name":"AdminClaimOrderResponse","type":"[AdminClaimOrderResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimOrderResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order","type":"[OrderDTO](../../../../../fulfillment/interfaces/fulfillment.OrderDTO/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../../../fulfillment/types/fulfillment.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The subtotal of the order. (Excluding taxes)","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_subtotal","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The discount subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The discount total Line truncated
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminClaimOrderResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimOrderResponse/page.mdx)>","optional":false,"defaultValue":"","description":"The claim and order's details.","expandable":false,"children":[{"name":"AdminClaimOrderResponse","type":"[AdminClaimOrderResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimOrderResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order","type":"[OrderDTO](../../../../../fulfillment/interfaces/fulfillment.OrderDTO/page.mdx)","description":"The order's details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../../../fulfillment/types/fulfillment.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The subtotal of the order. (Excluding taxes)","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_subtotal","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The discount subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":Line truncated
|
||||
+2
-2
@@ -23,8 +23,8 @@ sdk.admin.claim.deleteInboundShipping(
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"actionId","type":"`string`","description":"The id of the shipping method's `SHIPPING_ADD` action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the return.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deleteInboundShipping"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"actionId","type":"`string`","description":"The id of the shipping method's `SHIPPING_ADD` action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the return.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"The fields and relations to retrieve.\n\nLearn more in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deleteInboundShipping"/>
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminClaimReturnPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimReturnPreviewResponse/page.mdx)>","optional":false,"defaultValue":"","description":"The details of the return associated wth the claim, with a preview of the order when the claim is applied.","expandable":false,"children":[{"name":"AdminClaimReturnPreviewResponse","type":"[AdminClaimReturnPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimReturnPreviewResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order_preview","type":"`AdminOrderPreview`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return","type":"[AdminReturn](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminReturn/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"items","type":"[AdminReturnItem](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminReturnItem/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_version","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"received_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ReturnStatus](../../../../../order/types/order.ReturnStatus-1/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deleteInboundShipping"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminClaimReturnPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimReturnPreviewResponse/page.mdx)>","optional":false,"defaultValue":"","description":"The details of the return associated wth the claim, with a preview of the order when the claim is applied.","expandable":false,"children":[{"name":"AdminClaimReturnPreviewResponse","type":"[AdminClaimReturnPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimReturnPreviewResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order_preview","type":"[AdminOrderPreview](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderPreview/page.mdx)","description":"Preview of the order when the claim is applied.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"payment_collections","type":"[AdminPaymentCollection](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPaymentCollection/page.mdx)[]","description":"The order's payment collections.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_requested_total","type":"`number`","description":"The total amount for the items requested to be returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change","type":"[AdminOrderChange](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderChange/page.mdx)","description":"The details of the changes on the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[AdminOrderLineItem](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderLineItem/page.mdx) & `object`[]","description":"The order's items.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[AdminOrderShippingMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderShippingMethod/page.mdx) & `object`[]","description":"The order's shipping methods.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The order's version.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`null` \\| `string`","description":"The ID of the associated region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"The ID of the customer that placed the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel the order was placed in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"The email of the customer that placed the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The order's currency code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../../../../types/types/types.PaymentStatus/page.mdx)","description":"The order's payment status.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../../../../types/types/types.FulfillmentStatus/page.mdx)","description":"The order's fulfillment status.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"summary","type":"[BaseOrderSummary](../../../../../types/interfaces/types.BaseOrderSummary/page.mdx)","description":"The order's summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The date the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"`number`","description":"The total of the order's items including taxes, excluding promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"`number`","description":"The total of the order's items excluding taxes, including promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"`number`","description":"The tax total applied on the order's items, excluding promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"`number`","descLine truncated
|
||||
+2
-2
@@ -21,8 +21,8 @@ sdk.admin.claim.deleteOutboundShipping(
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"actionId","type":"`string`","description":"The id of the shipping method's `SHIPPING_ADD` action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the claim.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deleteOutboundShipping"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"actionId","type":"`string`","description":"The id of the shipping method's `SHIPPING_ADD` action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the claim.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"The fields and relations to retrieve.\n\nLearn more in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deleteOutboundShipping"/>
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminClaimPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimPreviewResponse/page.mdx)>","optional":false,"defaultValue":"","description":"The details of the claim, with a preview of the order when the claim is applied.","expandable":false,"children":[{"name":"AdminClaimPreviewResponse","type":"[AdminClaimPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimPreviewResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order_preview","type":"`AdminOrderPreview`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim","type":"[AdminClaim](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaim/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"order","type":"`AdminOrder`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return","type":"[AdminReturn](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminReturn/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[OrderClaimType](../../../../../fulfillment/types/fulfillment.OrderClaimType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"[BaseClaimItem](../../../../../types/interfaces/types.BaseClaimItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_items","type":"[BaseClaimItem](../../../../../types/interfaces/types.BaseClaimItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"`AdminOrderShippingMethod`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactions","type":"`BaseOrderTransaction`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deleteOutboundShipping"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminClaimPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimPreviewResponse/page.mdx)>","optional":false,"defaultValue":"","description":"The details of the claim, with a preview of the order when the claim is applied.","expandable":false,"children":[{"name":"AdminClaimPreviewResponse","type":"[AdminClaimPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimPreviewResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order_preview","type":"[AdminOrderPreview](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderPreview/page.mdx)","description":"Preview of the order when the claim is applied.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"payment_collections","type":"[AdminPaymentCollection](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPaymentCollection/page.mdx)[]","description":"The order's payment collections.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_requested_total","type":"`number`","description":"The total amount for the items requested to be returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change","type":"[AdminOrderChange](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderChange/page.mdx)","description":"The details of the changes on the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[AdminOrderLineItem](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderLineItem/page.mdx) & `object`[]","description":"The order's items.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[AdminOrderShippingMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderShippingMethod/page.mdx) & `object`[]","description":"The order's shipping methods.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The order's version.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`null` \\| `string`","description":"The ID of the associated region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"The ID of the customer that placed the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel the order was placed in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"The email of the customer that placed the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The order's currency code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../../../../types/types/types.PaymentStatus/page.mdx)","description":"The order's payment status.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../../../../types/types/types.FulfillmentStatus/page.mdx)","description":"The order's fulfillment status.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"summary","type":"[BaseOrderSummary](../../../../../types/interfaces/types.BaseOrderSummary/page.mdx)","description":"The order's summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The date the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"`number`","description":"The total of the order's items including taxes, excluding promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"`number`","description":"The total of the order's items excluding taxes, including promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"`number`","description":"The tax total applied on the order's items, excluding promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"`number`","description":"The total of the order's items including taxesLine truncated
|
||||
+2
-2
@@ -46,8 +46,8 @@ Learn more about the `fields` property in the [API reference](https://docs.medus
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"query","type":"[AdminClaimListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimListParams/page.mdx)","description":"Filters and pagination configurations.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([AdminClaimListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<[AdminClaimListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimListParams/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([AdminClaimListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<[AdminClaimListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimListParams/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([AdminClaimListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<[AdminClaimListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimListParams/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"[OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)<string>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string` \\| `string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"`string` \\| `string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)<string>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)<string>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([AdminClaimListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<[AdminClaimListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimListParams/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([AdminClaimListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<[AdminClaimListParams](../../../../../tyLine truncated
|
||||
<TypeList types={[{"name":"query","type":"[AdminClaimListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimListParams/page.mdx)","description":"Filters and pagination configurations.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([AdminClaimListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<[AdminClaimListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimListParams/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([AdminClaimListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<[AdminClaimListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimListParams/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([AdminClaimListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<[AdminClaimListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimListParams/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Query or keywords to search the claim's searchable fields.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"Filter by ID(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string` \\| `string`[]","description":"Retrieve the claims of the specified order ID(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"`string` \\| `string`[]","description":"Filter by status(es).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)<string>","description":"Filter by the claim's creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)<string>","description":"Filter by the claim's update date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"[OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)<string>","description":"Filter by the claim's deletion date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"The fields and relations to retrieve.\n\nLearn more in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"The maximum number of items to retrieve.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip before retrieving the returned items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort by and in which order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([AdminClaimListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<[AdminClaimListParams](../../../../../types/HLine truncated
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminClaimListResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimListResponse/page.mdx)>","optional":false,"defaultValue":"","description":"The paginated list of claims.","expandable":false,"children":[{"name":"AdminClaimListResponse","type":"[AdminClaimListResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimListResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"claims","type":"[AdminClaim](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaim/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"order","type":"`AdminOrder`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return","type":"[AdminReturn](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminReturn/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[OrderClaimType](../../../../../fulfillment/types/fulfillment.OrderClaimType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"[BaseClaimItem](../../../../../types/interfaces/types.BaseClaimItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_items","type":"[BaseClaimItem](../../../../../types/interfaces/types.BaseClaimItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"`AdminOrderShippingMethod`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactions","type":"`BaseOrderTransaction`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"limit","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"count","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="list"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminClaimListResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimListResponse/page.mdx)>","optional":false,"defaultValue":"","description":"The paginated list of claims.","expandable":false,"children":[{"name":"AdminClaimListResponse","type":"[AdminClaimListResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimListResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"claims","type":"[AdminClaim](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaim/page.mdx)[]","description":"The list of claims.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"order","type":"[AdminOrder](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrder/page.mdx)","description":"The order this claim is created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return","type":"[AdminReturn](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminReturn/page.mdx)","description":"The associated return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[OrderClaimType](../../../../../fulfillment/types/fulfillment.OrderClaimType/page.mdx)","description":"The claim's type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the order this claim was created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The claim's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`string`","description":"The version of the order when the claim is applied.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The date the claim was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date the claim was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"The date the claim was canceled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"[BaseClaimItem](../../../../../types/interfaces/types.BaseClaimItem/page.mdx)[]","description":"The claim's additional items if its `type` is `replace`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_items","type":"[BaseClaimItem](../../../../../types/interfaces/types.BaseClaimItem/page.mdx)[]","description":"The claim's items.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[AdminOrderShippingMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderShippingMethod/page.mdx)[]","description":"The shipping methods of the claim's additional items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The ID of the associated return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"`number`","description":"The amount to be refunded due to this claim.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"The ID of the user that created this claim.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"The date the claim was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Whether to notify the customer about changes in the claim.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactions","type":"[BaseOrderTransaction](../../../../../types/interfaces/types.BaseOrderTransaction/page.mdx)[]","description":"The claim's transactions.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Key-value pairs of custom data.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"limit","type":"`number`","description":"The maximum number of items retrieved.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip before retrieving the returned items.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"count","type":"`number`","description":"The tLine truncated
|
||||
+2
-2
@@ -23,8 +23,8 @@ sdk.admin.claim.removeInboundItem(
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"actionId","type":"`string`","description":"The ID of the return item's `RETURN_ITEM` action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the return.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="removeInboundItem"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"actionId","type":"`string`","description":"The ID of the return item's `RETURN_ITEM` action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the return.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"The fields and relations to retrieve.\n\nLearn more in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="removeInboundItem"/>
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminClaimReturnPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimReturnPreviewResponse/page.mdx)>","optional":false,"defaultValue":"","description":"The details of the return associated wth the claim, with a preview of the order when the claim is applied.","expandable":false,"children":[{"name":"AdminClaimReturnPreviewResponse","type":"[AdminClaimReturnPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimReturnPreviewResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order_preview","type":"`AdminOrderPreview`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return","type":"[AdminReturn](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminReturn/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"items","type":"[AdminReturnItem](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminReturnItem/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_version","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"received_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ReturnStatus](../../../../../order/types/order.ReturnStatus-1/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="removeInboundItem"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminClaimReturnPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimReturnPreviewResponse/page.mdx)>","optional":false,"defaultValue":"","description":"The details of the return associated wth the claim, with a preview of the order when the claim is applied.","expandable":false,"children":[{"name":"AdminClaimReturnPreviewResponse","type":"[AdminClaimReturnPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimReturnPreviewResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order_preview","type":"[AdminOrderPreview](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderPreview/page.mdx)","description":"Preview of the order when the claim is applied.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"payment_collections","type":"[AdminPaymentCollection](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPaymentCollection/page.mdx)[]","description":"The order's payment collections.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_requested_total","type":"`number`","description":"The total amount for the items requested to be returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change","type":"[AdminOrderChange](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderChange/page.mdx)","description":"The details of the changes on the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[AdminOrderLineItem](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderLineItem/page.mdx) & `object`[]","description":"The order's items.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[AdminOrderShippingMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderShippingMethod/page.mdx) & `object`[]","description":"The order's shipping methods.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The order's version.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`null` \\| `string`","description":"The ID of the associated region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"The ID of the customer that placed the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel the order was placed in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"The email of the customer that placed the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The order's currency code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../../../../types/types/types.PaymentStatus/page.mdx)","description":"The order's payment status.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../../../../types/types/types.FulfillmentStatus/page.mdx)","description":"The order's fulfillment status.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"summary","type":"[BaseOrderSummary](../../../../../types/interfaces/types.BaseOrderSummary/page.mdx)","description":"The order's summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The date the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"`number`","description":"The total of the order's items including taxes, excluding promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"`number`","description":"The total of the order's items excluding taxes, including promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"`number`","description":"The tax total applied on the order's items, excluding promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"`number`","descLine truncated
|
||||
+2
-2
@@ -23,8 +23,8 @@ sdk.admin.claim.removeItem(
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"actionId","type":"`string`","description":"The id of the order item's `WRITE_OFF_ITEM` action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the claim.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="removeItem"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"actionId","type":"`string`","description":"The id of the order item's `WRITE_OFF_ITEM` action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the claim.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"The fields and relations to retrieve.\n\nLearn more in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="removeItem"/>
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminClaimPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimPreviewResponse/page.mdx)>","optional":false,"defaultValue":"","description":"The claim's details with a preview of the order when the claim is applied.","expandable":false,"children":[{"name":"AdminClaimPreviewResponse","type":"[AdminClaimPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimPreviewResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order_preview","type":"`AdminOrderPreview`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim","type":"[AdminClaim](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaim/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"order","type":"`AdminOrder`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return","type":"[AdminReturn](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminReturn/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[OrderClaimType](../../../../../fulfillment/types/fulfillment.OrderClaimType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"[BaseClaimItem](../../../../../types/interfaces/types.BaseClaimItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_items","type":"[BaseClaimItem](../../../../../types/interfaces/types.BaseClaimItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"`AdminOrderShippingMethod`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactions","type":"`BaseOrderTransaction`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="removeItem"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminClaimPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimPreviewResponse/page.mdx)>","optional":false,"defaultValue":"","description":"The claim's details with a preview of the order when the claim is applied.","expandable":false,"children":[{"name":"AdminClaimPreviewResponse","type":"[AdminClaimPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimPreviewResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order_preview","type":"[AdminOrderPreview](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderPreview/page.mdx)","description":"Preview of the order when the claim is applied.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"payment_collections","type":"[AdminPaymentCollection](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPaymentCollection/page.mdx)[]","description":"The order's payment collections.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_requested_total","type":"`number`","description":"The total amount for the items requested to be returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change","type":"[AdminOrderChange](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderChange/page.mdx)","description":"The details of the changes on the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[AdminOrderLineItem](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderLineItem/page.mdx) & `object`[]","description":"The order's items.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[AdminOrderShippingMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderShippingMethod/page.mdx) & `object`[]","description":"The order's shipping methods.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The order's version.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`null` \\| `string`","description":"The ID of the associated region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"The ID of the customer that placed the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel the order was placed in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"The email of the customer that placed the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The order's currency code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../../../../types/types/types.PaymentStatus/page.mdx)","description":"The order's payment status.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../../../../types/types/types.FulfillmentStatus/page.mdx)","description":"The order's fulfillment status.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"summary","type":"[BaseOrderSummary](../../../../../types/interfaces/types.BaseOrderSummary/page.mdx)","description":"The order's summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The date the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"`number`","description":"The total of the order's items including taxes, excluding promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"`number`","description":"The total of the order's items excluding taxes, including promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"`number`","description":"The tax total applied on the order's items, excluding promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"`number`","description":"The total of the order's items including taxes and pLine truncated
|
||||
+2
-2
@@ -23,8 +23,8 @@ sdk.admin.claim.removeOutboundItem(
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"actionId","type":"`string`","description":"The id of the new claim item's `ITEM_ADD` action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the claim.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="removeOutboundItem"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"actionId","type":"`string`","description":"The id of the new claim item's `ITEM_ADD` action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the claim.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"The fields and relations to retrieve.\n\nLearn more in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="removeOutboundItem"/>
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminClaimPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimPreviewResponse/page.mdx)>","optional":false,"defaultValue":"","description":"The details of the claim, with a preview of the order when the claim is applied.","expandable":false,"children":[{"name":"AdminClaimPreviewResponse","type":"[AdminClaimPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimPreviewResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order_preview","type":"`AdminOrderPreview`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim","type":"[AdminClaim](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaim/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"order","type":"`AdminOrder`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return","type":"[AdminReturn](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminReturn/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[OrderClaimType](../../../../../fulfillment/types/fulfillment.OrderClaimType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"[BaseClaimItem](../../../../../types/interfaces/types.BaseClaimItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_items","type":"[BaseClaimItem](../../../../../types/interfaces/types.BaseClaimItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"`AdminOrderShippingMethod`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactions","type":"`BaseOrderTransaction`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="removeOutboundItem"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminClaimPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimPreviewResponse/page.mdx)>","optional":false,"defaultValue":"","description":"The details of the claim, with a preview of the order when the claim is applied.","expandable":false,"children":[{"name":"AdminClaimPreviewResponse","type":"[AdminClaimPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimPreviewResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order_preview","type":"[AdminOrderPreview](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderPreview/page.mdx)","description":"Preview of the order when the claim is applied.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"payment_collections","type":"[AdminPaymentCollection](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPaymentCollection/page.mdx)[]","description":"The order's payment collections.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_requested_total","type":"`number`","description":"The total amount for the items requested to be returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change","type":"[AdminOrderChange](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderChange/page.mdx)","description":"The details of the changes on the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[AdminOrderLineItem](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderLineItem/page.mdx) & `object`[]","description":"The order's items.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[AdminOrderShippingMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderShippingMethod/page.mdx) & `object`[]","description":"The order's shipping methods.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The order's version.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`null` \\| `string`","description":"The ID of the associated region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"The ID of the customer that placed the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel the order was placed in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"The email of the customer that placed the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The order's currency code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../../../../types/types/types.PaymentStatus/page.mdx)","description":"The order's payment status.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../../../../types/types/types.FulfillmentStatus/page.mdx)","description":"The order's fulfillment status.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"summary","type":"[BaseOrderSummary](../../../../../types/interfaces/types.BaseOrderSummary/page.mdx)","description":"The order's summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The date the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"`number`","description":"The total of the order's items including taxes, excluding promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"`number`","description":"The total of the order's items excluding taxes, including promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"`number`","description":"The tax total applied on the order's items, excluding promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"`number`","description":"The total of the order's items including taxesLine truncated
|
||||
+2
-2
@@ -20,8 +20,8 @@ sdk.admin.claim.request(
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"body","type":"[AdminRequestClaim](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminRequestClaim/page.mdx)","description":"The confirmation details.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the claim.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="request"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"body","type":"[AdminRequestClaim](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminRequestClaim/page.mdx)","description":"The confirmation details.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the claim.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"The fields and relations to retrieve.\n\nLearn more in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="request"/>
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminClaimRequestResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimRequestResponse/page.mdx)>","optional":false,"defaultValue":"","description":"The details of the claim and its associated return, with a preview of the order when the claim is applied.","expandable":false,"children":[{"name":"AdminClaimRequestResponse","type":"[AdminClaimRequestResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimRequestResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order_preview","type":"`AdminOrderPreview`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim","type":"[AdminClaim](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaim/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"order","type":"`AdminOrder`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return","type":"[AdminReturn](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminReturn/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[OrderClaimType](../../../../../fulfillment/types/fulfillment.OrderClaimType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"[BaseClaimItem](../../../../../types/interfaces/types.BaseClaimItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_items","type":"[BaseClaimItem](../../../../../types/interfaces/types.BaseClaimItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"`AdminOrderShippingMethod`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactions","type":"`BaseOrderTransaction`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"return","type":"[AdminReturn](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminReturn/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"items","type":"[AdminReturnItem](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminReturnItem/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_version","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"received_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"Line truncated
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminClaimRequestResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimRequestResponse/page.mdx)>","optional":false,"defaultValue":"","description":"The details of the claim and its associated return, with a preview of the order when the claim is applied.","expandable":false,"children":[{"name":"AdminClaimRequestResponse","type":"[AdminClaimRequestResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimRequestResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order_preview","type":"[AdminOrderPreview](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderPreview/page.mdx)","description":"Preview of the order when the claim is applied.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"payment_collections","type":"[AdminPaymentCollection](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPaymentCollection/page.mdx)[]","description":"The order's payment collections.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_requested_total","type":"`number`","description":"The total amount for the items requested to be returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change","type":"[AdminOrderChange](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderChange/page.mdx)","description":"The details of the changes on the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[AdminOrderLineItem](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderLineItem/page.mdx) & `object`[]","description":"The order's items.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[AdminOrderShippingMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderShippingMethod/page.mdx) & `object`[]","description":"The order's shipping methods.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The order's version.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`null` \\| `string`","description":"The ID of the associated region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"The ID of the customer that placed the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel the order was placed in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"The email of the customer that placed the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The order's currency code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../../../../types/types/types.PaymentStatus/page.mdx)","description":"The order's payment status.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../../../../types/types/types.FulfillmentStatus/page.mdx)","description":"The order's fulfillment status.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"summary","type":"[BaseOrderSummary](../../../../../types/interfaces/types.BaseOrderSummary/page.mdx)","description":"The order's summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The date the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"`number`","description":"The total of the order's items including taxes, excluding promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"`number`","description":"The total of the order's items excluding taxes, including promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"`number`","description":"The tax total applied on the order's items, excluding promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"`number`","description":"The total of the ordLine truncated
|
||||
+2
-2
@@ -31,8 +31,8 @@ Learn more about the `fields` property in the [API reference](https://docs.medus
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the claim.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrieve"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the claim.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"The fields and relations to retrieve.\n\nLearn more in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrieve"/>
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminClaimResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimResponse/page.mdx)>","optional":false,"defaultValue":"","description":"The claim's details.","expandable":false,"children":[{"name":"AdminClaimResponse","type":"[AdminClaimResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"claim","type":"[AdminClaim](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaim/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"order","type":"`AdminOrder`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return","type":"[AdminReturn](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminReturn/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[OrderClaimType](../../../../../fulfillment/types/fulfillment.OrderClaimType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"[BaseClaimItem](../../../../../types/interfaces/types.BaseClaimItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_items","type":"[BaseClaimItem](../../../../../types/interfaces/types.BaseClaimItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"`AdminOrderShippingMethod`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactions","type":"`BaseOrderTransaction`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrieve"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminClaimResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimResponse/page.mdx)>","optional":false,"defaultValue":"","description":"The claim's details.","expandable":false,"children":[{"name":"AdminClaimResponse","type":"[AdminClaimResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"claim","type":"[AdminClaim](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaim/page.mdx)","description":"The claim's details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"order","type":"[AdminOrder](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrder/page.mdx)","description":"The order this claim is created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return","type":"[AdminReturn](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminReturn/page.mdx)","description":"The associated return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[OrderClaimType](../../../../../fulfillment/types/fulfillment.OrderClaimType/page.mdx)","description":"The claim's type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the order this claim was created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The claim's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`string`","description":"The version of the order when the claim is applied.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The date the claim was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date the claim was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"The date the claim was canceled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"[BaseClaimItem](../../../../../types/interfaces/types.BaseClaimItem/page.mdx)[]","description":"The claim's additional items if its `type` is `replace`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_items","type":"[BaseClaimItem](../../../../../types/interfaces/types.BaseClaimItem/page.mdx)[]","description":"The claim's items.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[AdminOrderShippingMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderShippingMethod/page.mdx)[]","description":"The shipping methods of the claim's additional items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The ID of the associated return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"`number`","description":"The amount to be refunded due to this claim.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"The ID of the user that created this claim.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"The date the claim was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Whether to notify the customer about changes in the claim.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactions","type":"[BaseOrderTransaction](../../../../../types/interfaces/types.BaseOrderTransaction/page.mdx)[]","description":"The claim's transactions.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Key-value pairs of custom data.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrieve"/>
|
||||
+2
-2
@@ -26,8 +26,8 @@ sdk.admin.claim.updateInboundItem(
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"actionId","type":"`string`","description":"The id of the return item's `RETURN_ITEM` action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"body","type":"[AdminUpdateClaimInboundItem](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateClaimInboundItem/page.mdx)","description":"The details to update in the inbound item.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"quantity","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reason_id","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the return.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateInboundItem"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"actionId","type":"`string`","description":"The id of the return item's `RETURN_ITEM` action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"body","type":"[AdminUpdateClaimInboundItem](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateClaimInboundItem/page.mdx)","description":"The details to update in the inbound item.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"quantity","type":"`number`","description":"The item's claimed quantity.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reason_id","type":"`null` \\| `string`","description":"The ID of the associated claim reason.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The claim item's description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"An internal note viewed by admin users only.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the return.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"The fields and relations to retrieve.\n\nLearn more in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateInboundItem"/>
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminClaimReturnPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimReturnPreviewResponse/page.mdx)>","optional":false,"defaultValue":"","description":"The details of the return associated wth the claim, with a preview of the order when the claim is applied.","expandable":false,"children":[{"name":"AdminClaimReturnPreviewResponse","type":"[AdminClaimReturnPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimReturnPreviewResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order_preview","type":"`AdminOrderPreview`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return","type":"[AdminReturn](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminReturn/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"items","type":"[AdminReturnItem](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminReturnItem/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_version","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"received_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ReturnStatus](../../../../../order/types/order.ReturnStatus-1/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateInboundItem"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminClaimReturnPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimReturnPreviewResponse/page.mdx)>","optional":false,"defaultValue":"","description":"The details of the return associated wth the claim, with a preview of the order when the claim is applied.","expandable":false,"children":[{"name":"AdminClaimReturnPreviewResponse","type":"[AdminClaimReturnPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimReturnPreviewResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order_preview","type":"[AdminOrderPreview](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderPreview/page.mdx)","description":"Preview of the order when the claim is applied.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"payment_collections","type":"[AdminPaymentCollection](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPaymentCollection/page.mdx)[]","description":"The order's payment collections.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_requested_total","type":"`number`","description":"The total amount for the items requested to be returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change","type":"[AdminOrderChange](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderChange/page.mdx)","description":"The details of the changes on the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[AdminOrderLineItem](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderLineItem/page.mdx) & `object`[]","description":"The order's items.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[AdminOrderShippingMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderShippingMethod/page.mdx) & `object`[]","description":"The order's shipping methods.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The order's version.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`null` \\| `string`","description":"The ID of the associated region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"The ID of the customer that placed the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel the order was placed in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"The email of the customer that placed the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The order's currency code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../../../../types/types/types.PaymentStatus/page.mdx)","description":"The order's payment status.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../../../../types/types/types.FulfillmentStatus/page.mdx)","description":"The order's fulfillment status.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"summary","type":"[BaseOrderSummary](../../../../../types/interfaces/types.BaseOrderSummary/page.mdx)","description":"The order's summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The date the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"`number`","description":"The total of the order's items including taxes, excluding promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"`number`","description":"The total of the order's items excluding taxes, including promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"`number`","description":"The tax total applied on the order's items, excluding promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"`number`","descLine truncated
|
||||
+2
-2
@@ -26,8 +26,8 @@ sdk.admin.claim.updateInboundShipping(
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"actionId","type":"`string`","description":"The id of the shipping method's `SHIPPING_ADD` action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"body","type":"[AdminClaimUpdateInboundShipping](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimUpdateInboundShipping/page.mdx)","description":"The details to update in the shipping method","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"custom_amount","type":"`null` \\| `number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the claim.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateInboundShipping"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"actionId","type":"`string`","description":"The id of the shipping method's `SHIPPING_ADD` action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"body","type":"[AdminClaimUpdateInboundShipping](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimUpdateInboundShipping/page.mdx)","description":"The details to update in the shipping method","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"custom_amount","type":"`null` \\| `number`","description":"A custom amount to use instead of the shipping option's amount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"An internal note viewed by admin users only.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Key-value pairs of custom data.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the claim.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"The fields and relations to retrieve.\n\nLearn more in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateInboundShipping"/>
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminClaimPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimPreviewResponse/page.mdx)>","optional":false,"defaultValue":"","description":"The details of the claim, with a preview of the order when the claim is applied.","expandable":false,"children":[{"name":"AdminClaimPreviewResponse","type":"[AdminClaimPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimPreviewResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order_preview","type":"`AdminOrderPreview`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim","type":"[AdminClaim](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaim/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"order","type":"`AdminOrder`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return","type":"[AdminReturn](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminReturn/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[OrderClaimType](../../../../../fulfillment/types/fulfillment.OrderClaimType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"[BaseClaimItem](../../../../../types/interfaces/types.BaseClaimItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_items","type":"[BaseClaimItem](../../../../../types/interfaces/types.BaseClaimItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"`AdminOrderShippingMethod`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactions","type":"`BaseOrderTransaction`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateInboundShipping"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminClaimPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimPreviewResponse/page.mdx)>","optional":false,"defaultValue":"","description":"The details of the claim, with a preview of the order when the claim is applied.","expandable":false,"children":[{"name":"AdminClaimPreviewResponse","type":"[AdminClaimPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimPreviewResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order_preview","type":"[AdminOrderPreview](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderPreview/page.mdx)","description":"Preview of the order when the claim is applied.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"payment_collections","type":"[AdminPaymentCollection](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPaymentCollection/page.mdx)[]","description":"The order's payment collections.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_requested_total","type":"`number`","description":"The total amount for the items requested to be returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change","type":"[AdminOrderChange](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderChange/page.mdx)","description":"The details of the changes on the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[AdminOrderLineItem](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderLineItem/page.mdx) & `object`[]","description":"The order's items.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[AdminOrderShippingMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderShippingMethod/page.mdx) & `object`[]","description":"The order's shipping methods.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The order's version.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`null` \\| `string`","description":"The ID of the associated region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"The ID of the customer that placed the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel the order was placed in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"The email of the customer that placed the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The order's currency code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../../../../types/types/types.PaymentStatus/page.mdx)","description":"The order's payment status.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../../../../types/types/types.FulfillmentStatus/page.mdx)","description":"The order's fulfillment status.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"summary","type":"[BaseOrderSummary](../../../../../types/interfaces/types.BaseOrderSummary/page.mdx)","description":"The order's summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The date the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"`number`","description":"The total of the order's items including taxes, excluding promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"`number`","description":"The total of the order's items excluding taxes, including promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"`number`","description":"The tax total applied on the order's items, excluding promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"`number`","description":"The total of the order's items including taxesLine truncated
|
||||
+2
-2
@@ -25,8 +25,8 @@ sdk.admin.claim.updateItem(
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"actionId","type":"`string`","description":"The id of the order item's `WRITE_OFF_ITEM` action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"body","type":"[AdminUpdateClaimItem](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateClaimItem/page.mdx)","description":"The details to update.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"quantity","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reason_id","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the claim.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateItem"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"actionId","type":"`string`","description":"The id of the order item's `WRITE_OFF_ITEM` action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"body","type":"[AdminUpdateClaimItem](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateClaimItem/page.mdx)","description":"The details to update.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"quantity","type":"`number`","description":"The item's claimed quantity.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reason_id","type":"`null` \\| `string`","description":"The ID of the associated claim reason.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The claim item's description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"An internal note viewed by admin users only.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the claim.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"The fields and relations to retrieve.\n\nLearn more in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateItem"/>
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminClaimPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimPreviewResponse/page.mdx)>","optional":false,"defaultValue":"","description":"The claim's details with a preview of the order when the claim is applied.","expandable":false,"children":[{"name":"AdminClaimPreviewResponse","type":"[AdminClaimPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimPreviewResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order_preview","type":"`AdminOrderPreview`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim","type":"[AdminClaim](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaim/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"order","type":"`AdminOrder`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return","type":"[AdminReturn](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminReturn/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[OrderClaimType](../../../../../fulfillment/types/fulfillment.OrderClaimType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"[BaseClaimItem](../../../../../types/interfaces/types.BaseClaimItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_items","type":"[BaseClaimItem](../../../../../types/interfaces/types.BaseClaimItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"`AdminOrderShippingMethod`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactions","type":"`BaseOrderTransaction`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateItem"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminClaimPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimPreviewResponse/page.mdx)>","optional":false,"defaultValue":"","description":"The claim's details with a preview of the order when the claim is applied.","expandable":false,"children":[{"name":"AdminClaimPreviewResponse","type":"[AdminClaimPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimPreviewResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order_preview","type":"[AdminOrderPreview](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderPreview/page.mdx)","description":"Preview of the order when the claim is applied.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"payment_collections","type":"[AdminPaymentCollection](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPaymentCollection/page.mdx)[]","description":"The order's payment collections.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_requested_total","type":"`number`","description":"The total amount for the items requested to be returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change","type":"[AdminOrderChange](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderChange/page.mdx)","description":"The details of the changes on the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[AdminOrderLineItem](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderLineItem/page.mdx) & `object`[]","description":"The order's items.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[AdminOrderShippingMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderShippingMethod/page.mdx) & `object`[]","description":"The order's shipping methods.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The order's version.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`null` \\| `string`","description":"The ID of the associated region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"The ID of the customer that placed the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel the order was placed in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"The email of the customer that placed the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The order's currency code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../../../../types/types/types.PaymentStatus/page.mdx)","description":"The order's payment status.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../../../../types/types/types.FulfillmentStatus/page.mdx)","description":"The order's fulfillment status.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"summary","type":"[BaseOrderSummary](../../../../../types/interfaces/types.BaseOrderSummary/page.mdx)","description":"The order's summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The date the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"`number`","description":"The total of the order's items including taxes, excluding promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"`number`","description":"The total of the order's items excluding taxes, including promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"`number`","description":"The tax total applied on the order's items, excluding promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"`number`","description":"The total of the order's items including taxes and pLine truncated
|
||||
+2
-2
@@ -26,8 +26,8 @@ sdk.admin.claim.updateOutboundItem(
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"actionId","type":"`string`","description":"The id of the new claim item's `ITEM_ADD` action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"body","type":"[AdminUpdateClaimOutboundItem](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateClaimOutboundItem/page.mdx)","description":"The item's details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"quantity","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reason_id","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the claim.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateOutboundItem"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"actionId","type":"`string`","description":"The id of the new claim item's `ITEM_ADD` action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"body","type":"[AdminUpdateClaimOutboundItem](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateClaimOutboundItem/page.mdx)","description":"The item's details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"quantity","type":"`number`","description":"The item's claimed quantity.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reason_id","type":"`null` \\| `string`","description":"The ID of the associated claim reason.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The claim item's description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"An internal note viewed by admin users only.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the claim.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"The fields and relations to retrieve.\n\nLearn more in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateOutboundItem"/>
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminClaimPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimPreviewResponse/page.mdx)>","optional":false,"defaultValue":"","description":"The details of the claim, with a preview of the order when the claim is applied.","expandable":false,"children":[{"name":"AdminClaimPreviewResponse","type":"[AdminClaimPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimPreviewResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order_preview","type":"`AdminOrderPreview`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim","type":"[AdminClaim](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaim/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"order","type":"`AdminOrder`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return","type":"[AdminReturn](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminReturn/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[OrderClaimType](../../../../../fulfillment/types/fulfillment.OrderClaimType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"[BaseClaimItem](../../../../../types/interfaces/types.BaseClaimItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_items","type":"[BaseClaimItem](../../../../../types/interfaces/types.BaseClaimItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"`AdminOrderShippingMethod`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactions","type":"`BaseOrderTransaction`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateOutboundItem"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminClaimPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimPreviewResponse/page.mdx)>","optional":false,"defaultValue":"","description":"The details of the claim, with a preview of the order when the claim is applied.","expandable":false,"children":[{"name":"AdminClaimPreviewResponse","type":"[AdminClaimPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimPreviewResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order_preview","type":"[AdminOrderPreview](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderPreview/page.mdx)","description":"Preview of the order when the claim is applied.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"payment_collections","type":"[AdminPaymentCollection](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPaymentCollection/page.mdx)[]","description":"The order's payment collections.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_requested_total","type":"`number`","description":"The total amount for the items requested to be returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change","type":"[AdminOrderChange](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderChange/page.mdx)","description":"The details of the changes on the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[AdminOrderLineItem](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderLineItem/page.mdx) & `object`[]","description":"The order's items.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[AdminOrderShippingMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderShippingMethod/page.mdx) & `object`[]","description":"The order's shipping methods.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The order's version.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`null` \\| `string`","description":"The ID of the associated region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"The ID of the customer that placed the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel the order was placed in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"The email of the customer that placed the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The order's currency code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../../../../types/types/types.PaymentStatus/page.mdx)","description":"The order's payment status.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../../../../types/types/types.FulfillmentStatus/page.mdx)","description":"The order's fulfillment status.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"summary","type":"[BaseOrderSummary](../../../../../types/interfaces/types.BaseOrderSummary/page.mdx)","description":"The order's summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The date the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"`number`","description":"The total of the order's items including taxes, excluding promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"`number`","description":"The total of the order's items excluding taxes, including promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"`number`","description":"The tax total applied on the order's items, excluding promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"`number`","description":"The total of the order's items including taxesLine truncated
|
||||
+2
-2
@@ -26,8 +26,8 @@ sdk.admin.claim.updateOutboundShipping(
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"actionId","type":"`string`","description":"The id of the shipping method's `SHIPPING_ADD` action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"body","type":"[AdminClaimUpdateOutboundShipping](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimUpdateOutboundShipping/page.mdx)","description":"The shipping method's details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"custom_amount","type":"`null` \\| `number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the claim.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateOutboundShipping"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"actionId","type":"`string`","description":"The id of the shipping method's `SHIPPING_ADD` action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"body","type":"[AdminClaimUpdateOutboundShipping](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimUpdateOutboundShipping/page.mdx)","description":"The shipping method's details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"custom_amount","type":"`null` \\| `number`","description":"A custom amount to use instead of the shipping option's amount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"An internal note viewed by admin users only.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Key-value pairs of custom data.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the claim.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"The fields and relations to retrieve.\n\nLearn more in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateOutboundShipping"/>
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminClaimPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimPreviewResponse/page.mdx)>","optional":false,"defaultValue":"","description":"The details of the claim, with a preview of the order when the claim is applied.","expandable":false,"children":[{"name":"AdminClaimPreviewResponse","type":"[AdminClaimPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimPreviewResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order_preview","type":"`AdminOrderPreview`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim","type":"[AdminClaim](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaim/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"order","type":"`AdminOrder`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return","type":"[AdminReturn](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminReturn/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[OrderClaimType](../../../../../fulfillment/types/fulfillment.OrderClaimType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"[BaseClaimItem](../../../../../types/interfaces/types.BaseClaimItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_items","type":"[BaseClaimItem](../../../../../types/interfaces/types.BaseClaimItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"`AdminOrderShippingMethod`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactions","type":"`BaseOrderTransaction`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateOutboundShipping"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AdminClaimPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimPreviewResponse/page.mdx)>","optional":false,"defaultValue":"","description":"The details of the claim, with a preview of the order when the claim is applied.","expandable":false,"children":[{"name":"AdminClaimPreviewResponse","type":"[AdminClaimPreviewResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaimPreviewResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order_preview","type":"[AdminOrderPreview](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderPreview/page.mdx)","description":"Preview of the order when the claim is applied.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"payment_collections","type":"[AdminPaymentCollection](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPaymentCollection/page.mdx)[]","description":"The order's payment collections.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_requested_total","type":"`number`","description":"The total amount for the items requested to be returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change","type":"[AdminOrderChange](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderChange/page.mdx)","description":"The details of the changes on the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[AdminOrderLineItem](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderLineItem/page.mdx) & `object`[]","description":"The order's items.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[AdminOrderShippingMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderShippingMethod/page.mdx) & `object`[]","description":"The order's shipping methods.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The order's version.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`null` \\| `string`","description":"The ID of the associated region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"The ID of the customer that placed the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel the order was placed in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"The email of the customer that placed the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The order's currency code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../../../../types/types/types.PaymentStatus/page.mdx)","description":"The order's payment status.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../../../../types/types/types.FulfillmentStatus/page.mdx)","description":"The order's fulfillment status.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"summary","type":"[BaseOrderSummary](../../../../../types/interfaces/types.BaseOrderSummary/page.mdx)","description":"The order's summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The date the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"`number`","description":"The total of the order's items including taxes, excluding promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"`number`","description":"The total of the order's items excluding taxes, including promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"`number`","description":"The tax total applied on the order's items, excluding promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"`number`","description":"The total of the order's items including taxesLine truncated
|
||||
Reference in new issue
Block a user