post
https://api.ecartapi.com/api/v2/orders//returns
Create a Return from Order Fulfillments You can create a return based on the fulfillments of an order. The items inside the items array of the fulfillments include a property called fulfillmentItemId, which is required to create the return. As long as the fulfillments are in their final shipment status (FULFILLED) and belong to the same orderId, their items can be included in the same return. --- ### Required Item Properties Each item object that you intend to return must include the following 3 required properties: - id: The fulfillmentItemId - quantity: The quantity of the item to be returned - reason: A string representing the reason for the return --- ### Valid Return Reasons The allowed values for the reason property are: - color: The buyer did not like the color. (Displays as Color__) - defective: The item is damaged or defective. (Displays as Damaged or defective__) - notAsDescribed: The item was not as described. (Displays as Item not as described__) - sizeTooLarge: The size was too large. (Displays as Size was too large__) - sizeTooSmall: The size was too small. (Displays as Size was too small__) - style: The buyer did not like the style. (Displays as Style__) - unknown: The reason is unknown. (Displays as Unknown__) - wrongItem: The wrong item was received. (Displays as Wrong item received__) - unwanted: The customer changed their mind. (Displays as Customer changed their mind__) --- ### Successful Request A successful request will create a return in status: OPEN. - The response will include a property returnFulfillmentOrderId, which is required to create a return fulfillment (see the Return Fulfillments documentation). - At this stage, only the return itself is created — no shipping information is provided yet. - The items array in the response will show the products included in the return request. - The fulfillmentItemId allows you to identify the specific item in relation to a fulfillment. - The orderItemId indicates the item’s ID inside the order’s items array to which the created return belongs.
items array of the fulfillments include a property called fulfillmentItemId, which is required to create the return. As long as the fulfillments are in their final shipment status (FULFILLED) and belong to the same orderId, their items can be included in the same return. --- ### Required Item Properties Each item object that you intend to return must include the following 3 required properties: - id: The fulfillmentItemId - quantity: The quantity of the item to be returned - reason: A string representing the reason for the return --- ### Valid Return Reasons The allowed values for the reason property are: - color: The buyer did not like the color. (Displays as Color__) - defective: The item is damaged or defective. (Displays as Damaged or defective__) - notAsDescribed: The item was not as described. (Displays as Item not as described__) - sizeTooLarge: The size was too large. (Displays as Size was too large__) - sizeTooSmall: The size was too small. (Displays as Size was too small__) - style: The buyer did not like the style. (Displays as Style__) - unknown: The reason is unknown. (Displays as Unknown__) - wrongItem: The wrong item was received. (Displays as Wrong item received__) - unwanted: The customer changed their mind. (Displays as Customer changed their mind__) --- ### Successful Request A successful request will create a return in status: OPEN. - The response will include a property returnFulfillmentOrderId, which is required to create a return fulfillment (see the Return Fulfillments documentation). - At this stage, only the return itself is created — no shipping information is provided yet. - The items array in the response will show the products included in the return request. - The fulfillmentItemId allows you to identify the specific item in relation to a fulfillment. - The orderItemId indicates the item’s ID inside the order’s items array to which the created return belongs.