Remove an Inbound Item from Claim
Run in Apidog
Remove an inbound (or return) item from a claim using the ID
of the item's RETURN_ITEM
action. Every item has an actions
property, whose value is an array of actions. You can check the action's name using its action
property, and use the value of the id
property.
curl --location -g --request DELETE '{{BASE_URL}}/admin/claims//inbound/items/'
Response Response Example
Request
The ID of the return item's RETURN_ITEM
action.
Responses
The details of the claim's return, with a preview of the order when the claim's return is applied.
order_preview
object  (AdminOrderPreview)Â
required A preview of an order if a change, such as exchange, return, edit, or claim is applied on it.
order_change
object  (AdminOrderChange)Â
required The order change's details.
shipping_address
object  (AdminOrderAddress)Â
optional
billing_address
object  (AdminOrderAddress)Â
optional
summary
object  (BaseOrderSummary)Â
required The order's summary details.
customer
object  (AdminCustomer)Â
optional
sales_channel
object  (AdminSalesChannel)Â
optional The sales channel's details.
region
object  (AdminRegion)Â
optional
return_requested_total
number Â
required The total of the requested return.
The order's currency code.
The order's version when this preview is applied.
The ID of the order's associated region.
The ID of the customer that placed the order.
The ID of the sales channel that the order was placed in.
The email of the customer that placed the order.
payment_collections
array [object (AdminPaymentCollection) {14}]Â
required The order's payment collections.
fulfillments
array [object (AdminOrderFulfillment) {13}]Â
optional The order's fulfillments.
transactions
array [object (BaseOrderTransaction) {9}]Â
optional The order's transactions.
The order's metadata, can hold custom key-value pairs.
created_at
string  <date-time>
required The date the order was created.
updated_at
string  <date-time>
required The date the order was updated.
original_item_total
number Â
required The total of the order's items including taxes, excluding promotions.
original_item_subtotal
number Â
required The total of the order's items excluding taxes, including promotions.
original_item_tax_total
number Â
required The tax total of the order's items excluding promotions.
The total of the order's items including taxes and promotions.
The total of the order's items excluding taxes, including promotions.
The tax total of the order's items including promotions.
The order's total excluding promotions, including taxes.
The order's total excluding taxes, including promotions.
original_tax_total
number Â
required The order's tax total, excluding promotions.
The order's total including taxes and promotions.
The order's total excluding taxes, including promotions.
The order's tax total including promotions.
The order's discount or promotions total.
discount_tax_total
number Â
required The tax total of order's discount or promotion.
The order's gift card total.
gift_card_tax_total
number Â
required The tax total of the order's gift card.
The order's shipping total including taxes and promotions.
The order's shipping total excluding taxes, including promotions.
shipping_tax_total
number Â
required The tax total of the order's shipping.
original_shipping_total
number Â
required The order's shipping total including taxes, excluding promotions.
original_shipping_subtotal
number Â
required The order's shipping total excluding taxes, including promotions.
original_shipping_tax_total
number Â
required The tax total of the order's shipping excluding promotions.
credit_lines
array [object (OrderCreditLine) {9}]Â
optional The order preview's credit lines.
payment_status
enum<string> Â
required The order's payment status.
Allowed values: canceled not_paid awaiting authorized partially_authorized captured partially_captured partially_refunded refunded requires_action
fulfillment_status
enum<string> Â
required The order's fulfillment status.
Allowed values: canceled not_fulfilled partially_fulfilled fulfilled partially_shipped shipped partially_delivered delivered
shipping_methods
array  [object {22}]Â
optional The order's shipping methods.
items
array  [object {44}]Â
optional return
object  (AdminReturn)Â
required
Modified at 2025-06-17 04:10:32