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:

Request
path Parameters
key
required
string <UUID>

The id or fulfillment number of the Fulfillment to update.

header Parameters
Accept-Encoding
string

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.

Authorization
string

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

Content-Encoding
string

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-Entity-Ids
string

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

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.

Zuora-Track-Id
string <= 64 characters

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

Request Body schema: application/json
required
billTargetDate
string <date>

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

carrier
string

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

object (FulfillmentCustomFields)

Container for custom fields of a Fulfillment object.

description
string

The description of the Fulfillment.

excludeItemBillingFromRevenueAccounting
boolean

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.

excludeItemBookingFromRevenueAccounting
boolean

The flag to exclude Fulfillment from revenue accounting.

Note: This field is only available if you have the Billing - Revenue Integration feature enabled.

externalId
string

The external id of the Fulfillment.

fulfillmentDate
string <date>

The date of the Fulfillment.

fulfillmentLocation
string

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

fulfillmentSystem
string

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

fulfillmentType
string

The type of the Fulfillment.

Enum: "Delivery" "Return"
orderLineItemId
string <UUID>

The reference id of the related Order Line Ite

quantity
number

The quantity of the Fulfillment.

state
string

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

Enum: "Executing" "Booked" "SentToBilling" "Complete" "Cancelled"
trackingNumber
string

The tracking number of the Fulfillment.

Responses
200
put/v1/fulfillments/{key}
Request samples
application/json
{
  • "billTargetDate": "2022-01-01",
  • "fulfillmentDate": "2022-01-01",
  • "fulfillmentType": "Delivery",
  • "quantity": 5,
  • "state": "SentToBilling"
}
Response samples
application/json
{
  • "success": true
}