PUT /v1/fulfillments/{key}

Updates a specified fulfillment. The state field of a fulfillment can only be updated when it is in a different state, to trigger the state transition. The other fields of a fulfillment can only be updated when the fulfillment is in the Executing state, or when the fulfillment is in the Booked state and the user has the "Allow Edit Of Booked Order Line Items" permission. The following tutorial demonstrates how to use this operation:

Update or cancel a fulfillment

Servers

https://rest.test.zuora.com
https://rest.sandbox.na.zuora.com
https://rest.apisandbox.zuora.com
https://rest.na.zuora.com
https://rest.zuora.com
https://rest.test.eu.zuora.com
https://rest.sandbox.eu.zuora.com
https://rest.eu.zuora.com

Path parameters

Name	Type	Required	Description
`key`	String	Yes	The id or fulfillment number of the Fulfillment to update.

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"
`Content-Encoding`	String	No	Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.
`Zuora-Track-Id`	String	No	A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`).
`Authorization`	String	No	The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling Create an OAuth token.
`Zuora-Entity-Ids`	String	No	An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
`Zuora-Org-Ids`	String	No	Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
`Accept-Encoding`	String	No	Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.

Request body fields

Name	Type	Required	Description
`description`	String	No	The description of the Fulfillment.
`billTargetDate`	String	No	The target date for the Fulfillment to be picked up by bill run for billing.
`carrier`	String	No	The carrier of the Fulfillment. The available values can be managed in the Fulfillment Settings page under Billing Settings.
`quantity`	Number	No	The quantity of the Fulfillment.
`trackingNumber`	String	No	The tracking number of the Fulfillment.
`fulfillmentDate`	String	No	The date of the Fulfillment.
`state`	String	No	The state of the Fulfillment. See Order Line Item states, Order states, and state transitions for more information. Possible values: `"Booked"` `"Complete"` `"Executing"` `"Cancelled"` `"SentToBilling"`
`excludeItemBookingFromRevenueAccounting`	Boolean	No	The flag to exclude Fulfillment from revenue accounting. Note: This field is only available if you have the Billing - Revenue Integration feature enabled.
`fulfillmentLocation`	String	No	The fulfillment location of the Fulfillment. The available values can be managed in the Fulfillment Settings page under Billing Settings.
`fulfillmentSystem`	String	No	The fulfillment system of the Fulfillment. The available values can be managed in the Fulfillment Settings page under Billing Settings.
`excludeItemBillingFromRevenueAccounting`	Boolean	No	The flag to exclude Fulfillment related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting. Note: This field is only available if you have the Billing - Revenue Integration feature enabled.
`customFields`	Object	No	Container for custom fields of a Fulfillment object.
`externalId`	String	No	The external id of the Fulfillment.
`fulfillmentType`	String	No	The type of the Fulfillment. Possible values: `"Return"` `"Delivery"`
`orderLineItemId`	String	No	The reference id of the related Order Line Ite

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.