Skip to content

Latest commit

 

History

History
29 lines (26 loc) · 2.94 KB

OrderItem.md

File metadata and controls

29 lines (26 loc) · 2.94 KB

# OrderItem

Properties

Name Type Description Notes
orderId int Vendor order ID that uniquely identifies this purchase order. [optional]
orderLineId int Line number within the order that identifies this specific item. [optional]
assetId int Unique identifier for the digital asset associated with this order item. [optional]
title string Title of the purchased asset [optional]
customer string Customer name associated with the order for personalization purposes. [optional]
unitPrice float Unit price for a single item in the vendor's currency. [optional]
lineItemPrice 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]
countryCode string ISO 3166-1 alpha-2 country code for the country of sale. [optional]
downloadUrl string Secure download URL for the purchased asset. Available when the order is completed. Null if not yet fulfilled or if not applicable. [optional]
viewUrl string Secure view URL for the purchased asset. Available when the order is completed. Null if not yet fulfilled or if not applicable. [optional]
fileUrl string Direct URL to the raw asset file (SCORCH-shown assets, PianoWizard, OSF packages). Null if not applicable to this asset type. [optional]
signedUrl string Time-limited presigned S3 URL for MusicXML assets, when the vendor has S3 delivery credentials configured. Null otherwise. [optional]
file string Base64-encoded binary file content, for legacy CSF/MTD asset types only. Null for every other asset type. [optional]
viewUrlWebm string Streaming URL for the webm version of a purchased VIDEO asset (view_url carries the mp4 version). Null otherwise. [optional]
recordingDownloadUrl string Direct download link for a purchased VIDEO or AUDIO recording (mp4 or mp3). Null otherwise. [optional]
licenseConfirmationCode string Opaque license confirmation code for Windows Media (WMA/WMV) asset sales. [optional]
status string 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]
statusCode int Fulfillment status code of a failed line. Absent unless status is FAILED. [optional]
statusDescription string Fulfillment error description of a failed line. Absent unless status is FAILED. [optional]
urlExpiresAt int A UNIX timestamp representing when `download_url` and `view_url` stop working. [optional]

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