ReturnFulfillment (Shopify)

Return Fulfillment Use this resource to create a Return Fulfillment. This allows you to add tracking information to a return. The returnFulfillmentOrderId property is obtained from a return in OPEN status, and it enables the creation of a shipment for the items linked to that return. --- ### Tracking Information Within the tracking object, you can provide the following properties: - number – The tracking number. - url – The tracking URL. --- ### Shipping Label Inside documents.document, you can include the shipping label in PDF format. This file can be printed and used by the end customer for their return shipment. --- ### Behavior and Limitations - Return Fulfillments do not have statuses. - Once created, they cannot be updated. - To make changes, you must first use the Cancel a return for an order resource to cancel the existing return, and then create a new one. - There is no way to track the shipment status through the API. - Whenever a return is created via the API, the tracking company (carrier) is always set to "other". - This follows Shopify’s logic when returns are created programmatically. - The status of the Return itself (not the Return Fulfillment) will remain in OPEN even after creating a Return Fulfillment. - It does not move to CLOSED because refunds must still be processed to fully close the return. - Currently, ecartapi does not support Shopify’s Refund API.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The unique identifier of the order

string
required

The unique identifier of the return

Body Params
fulfillment
object
Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json