Mark a fulfillment as Integrated Refund

Sets a fulfillment's status to Integrated Refund and returns the updated fulfillment. Despite the GET, this doesn't look anything up: it changes the status.

This can trigger a real refund in Shopify

This endpoint doesn't refund anything in Shopify itself. If your store has a Shopify refund Glue job, it listens for the fulfillment_status_change system hook and issues a real refund in Shopify when a fulfillment moves to Integrated Refund. That only applies to Shopify orders: the fulfillment has a Shopify ID and is linked to a sale. Only call it when you mean to refund.

This is the only way a fulfillment gets to Integrated Refund: shipping and returning never set it. It only works while the fulfillment is Open, In Progress or Awaiting Pickup: any other status returns a 400. When the status changes, the fulfillment_status_change system hook fires with the fulfillment before and after.

Heads up: this is a GET request, but it changes data. Don't call it just to look something up, and keep it away from link prefetchers and caches.

Required permission:

GroupPermission
Fulfilment & ShippingCreate, edit, pick, ship and return fulfilments
Path Params
int64
required

ID of the fulfillment.

Responses

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