PUT api/Purchase/{purchaseOrderId}

Returns a Purchase order with the new purchase order item added and any previous purchase order items

Request Information

URI Parameters

Name	Description	Type	Additional information
purchaseOrderId	The purchase order identifier.	integer	Required
v	The requested API version	string	Default value is 2.0

Body Parameters

The purchase order item.

FilmFlex.Platform.Common.API.Contracts.V2.PurchaseOrderItemDTO

Name	Description	Type	Additional information
Id	Purchase Order Item Id	integer	None.
PurchaseOrderId	The associated Purchase Order Id	integer	None.
OfferId	FK of offer that is/was being purchased	integer	None.
UnitPrice	unit price that the user is paying	decimal number	None.
SupplierRef	Supplier Reference for the media item	string	None.
TimeOfFirstPlay	The date and time when the first DRM licence was issued for this rental	date	None.
RentalTime	Total time (in days) from the time the order was created until the rental ends whether watched or not	integer	None.
ViewTime	Total time (in hours) from first play to when the rental expires	integer	None.
Title	Film title. For historical records - film may no longer exist on the service	string	None.
BbfcRating	BBFC rating. For historical records - film may no longer exist on the service	string	None.
Duration	Film duration. For historical records - film may no longer exist on the service	integer	None.
Deleted	Deleted flag. Item may be flagged as deleted, but will remain in the db	boolean	None.
RequiresPreRoll	Film requires pre-roll ad when played.	boolean	None.
PersistentLicenseIssued	Persistent License Issued	boolean	None.
IsDtr	Purchase supports DTR	boolean	None.
SupportedDevices		string	None.
ShippingIds		string	None.
DrmProfile	The drm profile to apply when delivering a license	string	None.
LicenseAcknowledged	License Acknowledged	boolean	None.
EntitlementTypeId	Entitlement Type Id	integer	None.
CreatedDate	Date and time that the parent Purchase Order Item was created.	date	None.
TimeUserFirstStreamed	Date and time that the user first streamed this media item.	date	None.
TimeUserFirstDownloaded	Date and time that the user first downloaded this media item.	date	None.
DeviceIdOfFirstPlay	ID of the device on which the user first viewed this media item, if known.	integer	None.
PaymentProvider	Payment Provider (from parent Purchase Order)	string	None.
PaymentProviderTransactionId	Payment Provider Transaction Id (from parent Purchase Order)	string	None.
Inherited	Gets or sets a value indicating whether this is inherited.	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "PurchaseOrderId": 2,
  "OfferId": 3,
  "UnitPrice": 4.0,
  "SupplierRef": "sample string 5",
  "TimeOfFirstPlay": "2025-09-02T13:35:23.5036241+00:00",
  "RentalTime": 1,
  "ViewTime": 1,
  "Title": "sample string 6",
  "BbfcRating": "sample string 7",
  "Duration": 8,
  "Deleted": true,
  "RequiresPreRoll": true,
  "PersistentLicenseIssued": true,
  "IsDtr": true,
  "SupportedDevices": "sample string 11",
  "ShippingIds": "sample string 12",
  "DrmProfile": "sample string 13",
  "LicenseAcknowledged": true,
  "EntitlementTypeId": 15,
  "CreatedDate": "2025-09-02T13:35:23.5036241+00:00",
  "TimeUserFirstStreamed": "2025-09-02T13:35:23.5036241+00:00",
  "TimeUserFirstDownloaded": "2025-09-02T13:35:23.5036241+00:00",
  "DeviceIdOfFirstPlay": 1,
  "PaymentProvider": "sample string 17",
  "PaymentProviderTransactionId": "sample string 18",
  "Inherited": true
}

Response Information

Resource Description

Returns a Purchase order with the new purchase order item added and any previous purchase order items

FilmFlex.Platform.Common.API.Contracts.V2.PurchaseOrderDTO

Name	Description	Type	Additional information
Id	Purchase Order Id	integer	None.
MerchantRef	Payment gateway Merchant reference	globally unique identifier	None.
CustomerId	Internal Customer Id	globally unique identifier	None.
Status	Purchase Order Status	FilmFlex.Platform.Common.API.Contracts.V2.PurchaseOrderStatusDTO	None.
OfferType	Gets or sets the type of the offer.	string	None.
CreateDate	Date created	date	None.
PurchaseOrderItemDtos	The associated purchase order items	Collection of FilmFlex.Platform.Common.API.Contracts.V2.PurchaseOrderItemDTO	None.
PaymentProvider	PaymentProvider	string	None.
PaymentProviderCustomerId	PaymentProviderCustomerId	string	None.
PaymentProviderTransactionId	Payment Provider Transaction Id	string	None.
PaymentProviderRefundTransId	Payment Provider Refund Transaction Id	string	None.
OfferTypeId	Gets or sets the offer type identifier.	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "MerchantRef": "18f4ab0b-648e-4f61-9e52-8ad47b5c914b",
  "CustomerId": "64acf0d1-da9a-464c-a2f6-7183cfb3e120",
  "Status": {
    "Id": 1,
    "Code": "sample string 2",
    "Name": "sample string 3"
  },
  "OfferType": "sample string 4",
  "CreateDate": "2025-09-02T13:35:23.5192313+00:00",
  "PurchaseOrderItemDtos": [
    {
      "Id": 1,
      "PurchaseOrderId": 2,
      "OfferId": 3,
      "UnitPrice": 4.0,
      "SupplierRef": "sample string 5",
      "TimeOfFirstPlay": "2025-09-02T13:35:23.5192313+00:00",
      "RentalTime": 1,
      "ViewTime": 1,
      "Title": "sample string 6",
      "BbfcRating": "sample string 7",
      "Duration": 8,
      "Deleted": true,
      "RequiresPreRoll": true,
      "PersistentLicenseIssued": true,
      "IsDtr": true,
      "SupportedDevices": "sample string 11",
      "ShippingIds": "sample string 12",
      "DrmProfile": "sample string 13",
      "LicenseAcknowledged": true,
      "EntitlementTypeId": 15,
      "CreatedDate": "2025-09-02T13:35:23.5192313+00:00",
      "TimeUserFirstStreamed": "2025-09-02T13:35:23.5192313+00:00",
      "TimeUserFirstDownloaded": "2025-09-02T13:35:23.5192313+00:00",
      "DeviceIdOfFirstPlay": 1,
      "PaymentProvider": "sample string 17",
      "PaymentProviderTransactionId": "sample string 18",
      "Inherited": true
    },
    {
      "Id": 1,
      "PurchaseOrderId": 2,
      "OfferId": 3,
      "UnitPrice": 4.0,
      "SupplierRef": "sample string 5",
      "TimeOfFirstPlay": "2025-09-02T13:35:23.5192313+00:00",
      "RentalTime": 1,
      "ViewTime": 1,
      "Title": "sample string 6",
      "BbfcRating": "sample string 7",
      "Duration": 8,
      "Deleted": true,
      "RequiresPreRoll": true,
      "PersistentLicenseIssued": true,
      "IsDtr": true,
      "SupportedDevices": "sample string 11",
      "ShippingIds": "sample string 12",
      "DrmProfile": "sample string 13",
      "LicenseAcknowledged": true,
      "EntitlementTypeId": 15,
      "CreatedDate": "2025-09-02T13:35:23.5192313+00:00",
      "TimeUserFirstStreamed": "2025-09-02T13:35:23.5192313+00:00",
      "TimeUserFirstDownloaded": "2025-09-02T13:35:23.5192313+00:00",
      "DeviceIdOfFirstPlay": 1,
      "PaymentProvider": "sample string 17",
      "PaymentProviderTransactionId": "sample string 18",
      "Inherited": true
    }
  ],
  "PaymentProvider": "sample string 6",
  "PaymentProviderCustomerId": "sample string 7",
  "PaymentProviderTransactionId": "sample string 8",
  "PaymentProviderRefundTransId": "sample string 9",
  "OfferTypeId": 10
}