Retrieve an order line item

Quickstart API Reference

Retrieve an order line item

Request

Use this operation to retrieve the detailed information about a specific order line item.

Security

bearerAuth

Path

order_line_item_idstringrequired

Identifier for the order line item.

Query

fields[]Array of strings

Allows you to specify which fields are returned in the response.

Accepted values

`custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `total`, `subtotal`, `quantity_fulfilled`, `quantity_pending_fulfillment`, `unit_of_measure`, `accounting_code`, `adjustment_liability_account`, `unit_amount`, `target_date`, `billing_rule`, `contract_asset_account`, `contract_liability_account`, `description`, `discount_total`, `revenue`, `discount_unit_amount`, `discount_percent`, `category`, `name`, `item_number`, `type`, `list_price`, `list_unit_price`, `original_order_date`, `original_order_id`, `original_order_line_item_id`, `original_order_line_item_number`, `original_order_number`, `product_code`, `price_id`, `purchase_order_number`, `quantity`, `quantity_available_for_return`, `related_subscription_number`, `requires_fulfillment`, `sold_to_id`, `original_sold_to_id`, `tax_code`, `tax_inclusive`, `end_date`, `start_date`, `unbilled_receivables_account`, `state`, `order_id`

Example:fields[]=id,created_time

line_item.fields[]Array of strings

Allows you to specify which fields are returned in the response.

Accepted values

Example:line_item.fields[]=id,created_time

invoice_items.fields[]Array of strings

Allows you to specify which fields are returned in the response.

Accepted values

`custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `booking_reference`, `applied_to_item_id`, `price_id`, `discount_item`, `deferred_revenue_account`, `description`, `invoice_id`, `sku`, `name`, `purchase_order_number`, `quantity`, `recognized_revenue_account`, `remaining_balance`, `revenue_recognition_rule_name`, `accounting_code`, `service_end`, `service_start`, `accounts_receivable_account`, `subscription_id`, `subscription_item_id`, `tax`, `tax_code`, `tax_inclusive`, `unit_amount`, `unit_of_measure`, `document_item_date`

Example:invoice_items.fields[]=id,created_time

expand[]Array of strings

Allows you to expand responses by including related object information in a single call. See the Expand responses section of the Quickstart API Tutorials for detailed instructions.

filter[]Array of strings

A case-sensitive filter on the list. See the Filter lists section of the Quickstart API Tutorial for detailed instructions.
Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the "Retrieve a billing document" operation, you can use the filter[] parameter on the related objects such as filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63

page_sizeinteger, [ 1 .. 99 ]

The maximum number of results to return in a single page. If the specified page_size is less than 1 or greater than 99, Zuora will return a 400 error.

zuora-track-idstring

A custom identifier for tracking API requests. If you set a value for this header, Zuora returns the same value in the response header. This header enables you to track your 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 ("), or quote (').

asyncboolean

Making asynchronous requests allows you to scale your applications more efficiently by leveraging Zuora's infrastructure to enqueue and execute requests for you without blocking. These requests also use built-in retry semantics, which makes them much less likely to fail for non-deterministic reasons, even in extreme high-throughput scenarios. Meanwhile, when you send a request to one of these endpoints, you can expect to receive a response in less than 150 milliseconds and these calls are unlikely to trigger rate limit errors. If set to true, Zuora returns a 202 Accepted response, and the response body contains only a request ID.

Default:false

zuora-entity-idsstring

An entity ID. If you have Multi-entity enabled and the authorization token is valid for more than one entity, you must use this header to specify which entity to perform the operation on. If the authorization token is only valid for a single entity or you do not have Multi-entity enabled, you do not need to set this header.

idempotency-keystring

Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. This idempotency key should be a unique value, and the Zuora server identifies subsequent retries of the same request using this value. For more information, see Idempotent Requests.

accept-encodingstring

Include a accept-encoding: gzip header to compress responses, which can reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes. For more information about this header, see Request and Response Compression.

content-encodingstring

Include a content-encoding: gzip header to compress a request. Upload a gzipped file for the payload if you specify this header. For more information, see Request and Response Compression.

zuora-org-idsstring

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.

cURL

curl -i -X GET \
  'https://rest.test.zuora.com/v2/order_line_items/{order_line_item_id}?fields%5B%5D=id%2Ccreated_time&line_item.fields%5B%5D=id%2Ccreated_time&invoice_items.fields%5B%5D=id%2Ccreated_time&expand%5B%5D=string&filter%5B%5D=string&page_size=1' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'accept-encoding: string' \
  -H 'async: false' \
  -H 'content-encoding: string' \
  -H 'idempotency-key: string' \
  -H 'zuora-entity-ids: string' \
  -H 'zuora-org-ids: string' \
  -H 'zuora-track-id: string'

Responses

Default Response

Headers

ratelimit-limitstring

The request limit quota for the time window closest to exhaustion. See rate limits for more information.

ratelimit-remainingnumber

The number of requests remaining in the time window closest to quota exhaustion. See rate limits for more information.

ratelimit-resetnumber

The number of seconds until the quota resets for the time window closest to quota exhaustion. See rate limits for more information.

zuora-request-idstring

Zuora’s internal identifier for this request.

zuora-track-idstring

A user-supplied identifier for this request. If you supply a zuora-track-id as a request header, Zuora returns the zuora-track-id as a response header.

Bodyapplication/json

idstringread-only

Unique identifier for the object.

updated_by_idstringread-only

Unique identifier of the Zuora user who last updated the object

updated_timestring, (date-time)read-only

The date and time when the object was last updated in ISO 8601 UTC format.

created_by_idstringread-only

Unique identifier of the Zuora user who created the object

created_timestring, (date-time)read-only

The date and time when the object was created in ISO 8601 UTC format.

custom_fieldsobject(CustomFields)

Set of user-defined fields associated with this object. Useful for storing additional information about the object in a structured format.

custom_objectsobjectread-only

The custom objects associated with a Zuora standard object.

revenueobject(OrderLineItemRevenue)

Accounting configuration if you have Zuora Revenue enabled.

unit_of_measurestring

A configured unit of measure.

accounting_codestring

An active accounting code in your Zuora chart of accounts.

adjustment_liability_accountstring

An active accounting code in your Zuora chart of accounts.

unit_amountnumber

The unit amount to be charged.

target_datestring, (date)

All order line items that were unbilled on or before this date are included in future bill runs.

billing_ruleany

The billing rule for the order line item.

Enum:"trigger_without_fulfillment""trigger_on_fulfillment"

contract_asset_accountstring

An active accounting code in your Zuora chart of accounts.

contract_liability_accountstring

An active accounting code in your Zuora chart of accounts.

descriptionstring

An arbitrary string attached to the object. Often useful for displaying to users.

discount_unit_amountnumber

Discount amount per unit.

discount_percentnumber

Discount percent.

categoryany

The category for the order line item, to indicate a product sale or return.

Enum:"sale""return"

namestring

The name of the order line item.

typeany

The type of the order line item.

Enum:"product""fee""services"

list_unit_pricenumber

The list price per unit for the order line item.

product_codestring

The product code for the order line item.

purchase_order_numberstring

Used by customers to specify the Purchase Order Number provided by the buyer.

quantitynumber

The quantity of the product ordered.

related_subscription_numberstring

Use this field to relate an order line item to an subscription.

sold_to_idstring

The unique identifier of a contact belonging to the billing account of the order line item. Use this field to assign and existing contact as the sold to contact of an order line item.

Example:"8ad0823f8040e52d0180433026b156fe"

tax_codestring

The tax code for the order line item.

unbilled_receivables_accountstring

An active accounting code in your Zuora chart of accounts..

stateany

The state of an order line item. If you want to generate billing documents for order line items, you must set this field to sent_to_billing. For invoice preview, you do not need to set this field.

Enum:"pending""booked""sent_to_billing""complete""canceled"

item_numberstring

Human-readable identifier of the order item. It can be user-supplied.

start_datestring, (date)

The date a transaction starts. The default value of this field is the order date.

Example:"2022-01-01"

end_datestring, (date)

The date the order line item transitions to complete.

Example:"2022-01-01"

price_idstring

Identifier of the price.

quantity_available_for_returnnumber

The quantity of the product ordered available for return.

tax_inclusiveboolean

If this field is set to true, it indicates that amounts are inclusive of tax.

invoice_itemsobject(InvoiceItemListResponse)read-only

List of invoice items. EXPANDABLE

order_idstring

The unique identifier for the order associated with this order line item.

totalnumber

Total after discounts and taxes.

subtotalnumber

Total before discounts and taxes are applied.

quantity_fulfillednumber

The quantity fulfilled.

quantity_pending_fulfillmentnumber

The quantity pending fulfillment.

requires_fulfillmentboolean

If true, a fulfillment is required to trigger billing.

original_order_datestring, (date)

The date when the subscription item is created through an order. This field is to standardize the booking date information to increase audit ability and traceability of data between Zuora Billing and Zuora Revenue. It is mapped as the booking date for a sales order line in Zuora Revenue.

Example:"2022-01-01"

original_order_idstring

The unique identifier of the original sales order for a return order line item.

original_order_line_item_idstring

The unique identifier of the original sales order line item for a return order line item.

original_order_line_item_numberstring

The number of the original sales order line item for a return order line item.

original_order_numberstring

The number of the original sales order for a return order line item.

discount_totalnumber

Total discount amount.

list_pricenumber

The extended list price for an order line item, calculated by the formula: listPrice = listPricePerUnit * quantity

original_sold_to_idstring

The unique identifier of a contact belonging to the billing account of the order line item that was the original sold to contact when the order line item was created.

Response

{
  "id": "8ad09b218736ff1b018749258bf15f73",
  "updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
  "updated_time": "2023-04-03T16:03:39-07:00",
  "created_by_id": "2c92c0946a6dffc0016a7faab604299b",
  "created_time": "2023-04-03T15:03:30-07:00",
  "custom_fields": {},
  "unit_of_measure": "Each",
  "accounting_code": "",
  "adjustment_liability_account": "",
  "adjustment_revenue_account": "",
  "unit_amount": 1100,
  "target_date": "2023-02-15",
  "deferred_revenue_account": "",
  "description": "",
  "discount_unit_amount": -100,
  "name": "A cellphone",
  "type": "product",
  "list_unit_price": 1000,
  "product_code": "aapl_14_pro",
  "purchase_order_number": "",
  "quantity": 40,
  "recognized_revenue_account": "",
  "related_subscription_number": "",
  "revenue_recognition_rule_name": "",
  "sold_to_id": "8ad09b218736ff1b018749258b9a5f70",
  "tax_code": "",
  "unbilled_receivables_account": "",
  "revenue": {
    "adjustment_revenue_account": null,
    "exclude_item_billing_from_revenue_accounting": false,
    "exclude_item_booking_from_revenue_accounting": false
  },
  "item_number": "1",
  "category": "sale",
  "state": "pending",
  "price_id": "",
  "quantity_available_for_return": 0,
  "tax_inclusive": false,
  "start_date": "2023-02-15",
  "end_date": "2023-02-15",
  "order_id": "8ad09b218736ff1b018749258a265f3d",
  "total": 44000,
  "subtotal": 44000,
  "quantity_fulfilled": 0,
  "quantity_pending_fulfillment": 40,
  "original_order_date": "2023-02-15",
  "discount_total": -4000,
  "list_price": 40000,
  "original_sold_to_id": "8ad09e208727f63f018734233f6d39c2"
}