OrderItem.md

OrderItem

Represents a purchase order item with complete status and fulfillment information.

Properties

Name	Type	Description	Notes
order_id	int	Vendor order ID that uniquely identifies this purchase order.	[optional]
order_line_id	int	Line number within the order that identifies this specific item.	[optional]
asset_id	int	Unique identifier for the digital asset associated with this order item.	[optional]
title	str	Title of the purchased asset	[optional]
customer	str	Customer name associated with the order for personalization purposes.	[optional]
unit_price	float	Unit price for a single item in the vendor's currency.	[optional]
line_item_price	float	Total price for this line item (unit price × quantity) in the vendor's currency.	[optional]
quantity	float	Quantity of items ordered in this line item.	[optional]
country_code	str	ISO 3166-1 alpha-2 country code for the country of sale.	[optional]
download_url	str	Secure download URL for the purchased asset. Available when the order is completed. Null if not yet fulfilled or if not applicable.	[optional]
view_url	str	Secure view URL for the purchased asset. Available when the order is completed. Null if not yet fulfilled or if not applicable.	[optional]
file_url	str	Direct URL to the raw asset file (SCORCH-shown assets, PianoWizard, OSF packages). Null if not applicable to this asset type.	[optional]
signed_url	str	Time-limited presigned S3 URL for MusicXML assets, when the vendor has S3 delivery credentials configured. Null otherwise.	[optional]
file	bytearray	Base64-encoded binary file content, for legacy CSF/MTD asset types only. Null for every other asset type.	[optional]
view_url_webm	str	Streaming URL for the webm version of a purchased VIDEO asset (view_url carries the mp4 version). Null otherwise.	[optional]
recording_download_url	str	Direct download link for a purchased VIDEO or AUDIO recording (mp4 or mp3). Null otherwise.	[optional]
license_confirmation_code	str	Opaque license confirmation code for Windows Media (WMA/WMV) asset sales.	[optional]
status	str	Status of this order line. Lines of one order are fulfilled independently, so an order may hold lines in different statuses at once. Cancelled lines are not returned.	[optional]
status_code	int	Fulfillment status code of a failed line. Absent unless status is FAILED.	[optional]
status_description	str	Fulfillment error description of a failed line. Absent unless status is FAILED.	[optional]
url_expires_at	int	A UNIX timestamp representing when `download_url` and `view_url` stop working.	[optional]

Example

from hlconnect_client.models.order_item import OrderItem

# TODO update the JSON string below
json = "{}"
# create an instance of OrderItem from a JSON string
order_item_instance = OrderItem.from_json(json)
# print the JSON string representation of the object
print(OrderItem.to_json())

# convert the object into a dict
order_item_dict = order_item_instance.to_dict()
# create an instance of OrderItem from a dict
order_item_from_dict = OrderItem.from_dict(order_item_dict)

[Back to Model list] [Back to API list] [Back to README]