Skip to content

OrderItem.md

Latest commit

 

History

History
44 lines (30 loc) · 3.02 KB

OrderItem.md

File metadata and controls

44 lines (30 loc) · 3.02 KB
Raw

HlConnect.OrderItem

Properties

Name Type Description Notes
orderId Number Vendor order ID that uniquely identifies this purchase order. [optional]
orderLineId Number Line number within the order that identifies this specific item. [optional]
assetId Number 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 Number Unit price for a single item in the vendor's currency. [optional]
lineItemPrice Number Total price for this line item (unit price × quantity) in the vendor's currency. [optional]
quantity Number 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 Blob 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 Number 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 Number A UNIX timestamp representing when `download_url` and `view_url` stop working. [optional]

Enum: StatusEnum

  • COMPLETED (value: "COMPLETED")

  • PROCESSING (value: "PROCESSING")

  • CREATED (value: "CREATED")

  • FAILED (value: "FAILED")