Update a order line item using REST API (Part 1)

This topic explains how to update an order line item using the REST API, including determining required fields and understanding editable states.

Use the Update an order line item operation to update an order line item. Keep the following points in mind when you run the "Update an order" operation:

Determine the required field "itemId" and other required custom fields for the order line item.
The fields of an order line item are only editable in certain states, depending on the "itemState" field. See the field description for the Update an order line item operation.

The following API request updates an existing order line item without fulfillment in an order.

Request	`PUT /v1/order-line-items/{itemId}`
Request Body	`{ "itemName": "LMS Training Fee", "itemType": "Product", "description": "webcam", "purchaseOrderNumber": "PO-12345678", "productCode": "P-0000001", "quantity": 10, "amountPerUnit": 499, "listPricePerUnit": 500, "transactionStartDate": "2021-02-01", "transactionEndDate": "2021-02-01", "itemState": "SentToBilling", "billTargetDate": "2021-02-01" }`

Request

PUT /v1/order-line-items/{itemId}

Request Body

{
  "itemName": "LMS Training Fee",
  "itemType": "Product",
  "description": "webcam",
  "purchaseOrderNumber": "PO-12345678",
  "productCode": "P-0000001",
  "quantity": 10,
  "amountPerUnit": 499,
  "listPricePerUnit": 500,
  "transactionStartDate": "2021-02-01",
  "transactionEndDate": "2021-02-01",
  "itemState": "SentToBilling",
  "billTargetDate": "2021-02-01"
}

Welcome to Zuora Product Documentation

Explore our rich library of product information

Update a order line item using REST API (Part 1)

zuora-footer