Skip to main content

Update or cancel a fulfillment

Zuora

Update or cancel a fulfillment

You can update or cancel fulfillments on a sales or return order line item.

You can use one of the following methods to update a fulfillment or cancel a fulfillment:

Update or cancel a fulfillment using the Zuora UI

To update or cancel a fulfillment, perform the following steps:

  1. Log in to the Zuora application and then navigate to Customers > Orders. The Orders page opens.
  2. Search for the order that contains the order line items. For information about how to search for an order, see View the Details of an Order.
  3. Open the order details page by clicking the order number in blue in the ORDER column.
    A sales order number starts with the prefix O-, for example, O-00007470, and a return order number starts with the prefix RMA-, for example, RMA-00007467.
  4. In the Sales Order Line Items or Return Order Line Items area, click the item name in blue in the ITEM NAME column to open the order line item details page.
  5. In the Fulfillment Details area, click the fulfillment number in blue, for example, F-00000003, to open the fulfillment details page.
  6. Click Edit at the top right to change the fulfillment details page to the edit mode.
  7. Perform the following updates:
    • If the fulfillment is in the Executing state, you can update editable fields in the Overview and Fulfillment Integration areas. For example, you can set the state from Executing to Canceled to cancel the fulfillment.
    • If the fulfillment is in the Booked, Send To Billing, or Complete state, you can create new fulfillment items or edit the existing fulfillment items in the Fulfillment Items area, and then click the save icon icon-save.png to make the update take effect.

    Note that you can create multiple fulfillment items, but the number of fulfillment items should not be greater than the value of the Fulfillment Quantity field.

  8. Click Save at the top right of the fulfillment details page to make the changes take effect.

Update or cancel a fulfillment using the REST API

Use the Update a fulfillment operation to update a fulfillment. 

The following API request updates a fulfillment from the Executing state to the Booked state, and updates the quantity and trackingNumber fields.

Request PUT {{host}}/apps/v1/fulfillments/{key}
Request Body
{
"state": "Booked",
"quantity": 2,
"description": "return fulfillment",
"trackingNumber": "T-0009874"
}

Use the Update a fulfillment operation to cancel a fulfillment. 

The following API request updates a fulfillment from the Executing state to the Cancelled state.

Request PUT {{host}}/apps/v1/fulfillments/{key}
Request Body
{
"state": "Cancelled"
}