Sign in
Fulfillments

Update a fulfillment

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:

put/v1/fulfillments/{key}

Path parameters

keystring UUID required

The id or fulfillment number of the Fulfillment to update.

Headers

Accept-Encodingstring

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.

Content-Encodingstring

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-Idstring

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 (').

Zuora-Entity-Idsstring

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 should not set this header.

Zuora-Org-Idsstring

Comma separated IDs. If you have <a href="https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org" target="_blank">Zuora Multi-Org</a> 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. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs.

Zuora-Versionstring

The minor API version.

For a list of available minor versions, see API upgrades.

Request body

billTargetDatestring date

The target date for the Fulfillment to be picked up by bill run for billing.

carrierstring

The carrier of the Fulfillment. The available values can be managed in the Fulfillment Settings page under Billing Settings.

customFieldsFulfillmentCustomFields

Container for custom fields of a Fulfillment object.

descriptionstring

The description of the Fulfillment.

externalIdstring

The external id of the Fulfillment.

fulfillmentDatestring date

The date of the Fulfillment.

fulfillmentLocationstring

The fulfillment location of the Fulfillment. The available values can be managed in the Fulfillment Settings page under Billing Settings.

fulfillmentSystemstring

The fulfillment system of the Fulfillment. The available values can be managed in the Fulfillment Settings page under Billing Settings.

quantitynumber

The quantity of the Fulfillment.

state'Executing' | 'Booked' | 'SentToBilling' | 'Complete' | 'Cancelled'

The state of the Fulfillment. See Order Line Item states, Order states, and state transitions for more information.

trackingNumberstring

The tracking number of the Fulfillment.

Example request

{
  "billTargetDate": "2022-01-01",
  "fulfillmentDate": "2022-01-01",
  "fulfillmentType": "Delivery",
  "quantity": 5,
  "state": "SentToBilling"
}

Response

OK

processIdstring

The ID of the process that handles the operation.

requestIdstring uuid

Unique identifier of the request.

successboolean

Indicates whether the call succeeded.

Changes