GET api/Purchase/{affiliateIs}/{purchaseOrderId}?affiliateId={affiliateId}&withPOIs={withPOIs}

Returns a given PO. With (default) or without POIs

Request Information

URI Parameters

Name	Description	Type	Additional information
affiliateId		integer	Required
purchaseOrderId		integer	Required
withPOIs	True (default) returns the POIs, False does not	boolean	Default value is True
affiliateIs		string	None.
v	The requested API version	string	Required Default value is 1

Body Parameters

None.

Response Information

Resource Description

Returns a given PO. With (default) or without POIs

FilmFlex.Platform.Common.API.Contracts.V1.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.V1.PurchaseOrderStatusDTO	None.
CreateDate	Date created	date	None.
PurchaseOrderItemDtos	The associated purchase order items	Collection of FilmFlex.Platform.Common.API.Contracts.V1.PurchaseOrderItemDTO	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "MerchantRef": "6007bd1a-426b-44e5-9990-fb7ae46f2a9a",
  "CustomerId": "1759c2fe-6331-4533-89fd-c6c88792020f",
  "Status": {
    "Id": 1,
    "Code": "sample string 2",
    "Name": "sample string 3"
  },
  "CreateDate": "2025-09-01T04:34:04.7714479+00:00",
  "PurchaseOrderItemDtos": [
    {
      "Id": 1,
      "PurchaseOrderId": 2,
      "OfferId": 3,
      "UnitPrice": 4.0,
      "SupplierRef": "sample string 5",
      "TimeOfFirstPlay": "2025-09-01T04:34:04.7714479+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",
      "DrmProfile": "sample string 12",
      "LicenseAcknowledged": true,
      "EntitlementTypeId": 14
    },
    {
      "Id": 1,
      "PurchaseOrderId": 2,
      "OfferId": 3,
      "UnitPrice": 4.0,
      "SupplierRef": "sample string 5",
      "TimeOfFirstPlay": "2025-09-01T04:34:04.7714479+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",
      "DrmProfile": "sample string 12",
      "LicenseAcknowledged": true,
      "EntitlementTypeId": 14
    }
  ]
}