POST api/Subscriptions

Request Information

URI Parameters

None.

Body Parameters

PostSubscription
NameDescriptionTypeAdditional information
OfferId

globally unique identifier

Required

OfferSerialNumberId

globally unique identifier

None.

AppInstallId

string

Required

String length: inclusive between 0 and 200

Scanned

date

Required

OrderDetails

OrderDetails

Required

CustomFieldValues

Collection of OfferFieldValue

None.

ContractHtml

string

None.

LoyaltyCode

string

None.

Source

SubscriptionSource

None.

Request Formats

application/json, text/json

Sample:
{
  "OfferId": "1207f459-6c84-4151-82fc-edd844539649",
  "OfferSerialNumberId": "ebf3cd5a-0b7f-4741-b3b5-c1af8e8c14e0",
  "AppInstallId": "sample string 3",
  "Scanned": "2022-05-21T10:19:00.3308418+00:00",
  "OrderDetails": {
    "Honorific": "sample string 1",
    "Initials": "sample string 2",
    "SurnamePrefix": "sample string 3",
    "Surname": "sample string 4",
    "PhoneNumber": "sample string 5",
    "Email": "sample string 6",
    "MerchantOrderReference": "sample string 7",
    "PaymentReference": 1,
    "TraceReference": 1,
    "TransactionReference": "sample string 8",
    "IsPaid": true,
    "PaymentStatus": 0,
    "DateOfBirth": "2022-05-21T10:19:00.3621446+00:00",
    "BankAccount": {
      "AccountNumber": "sample string 1",
      "AccountHolder": "sample string 2"
    },
    "Address": {
      "CountryCode": "sample string 1",
      "StreetName": "sample string 2",
      "HouseNumber": "sample string 3",
      "HouseNumberSuffix": "sample string 4",
      "ZipCode": "sample string 5",
      "Locality": "sample string 6",
      "AddressLine1": "sample string 7",
      "AddressLine2": "sample string 8",
      "StateOrProvince": "sample string 9"
    },
    "DeliveryConsignee": "sample string 10",
    "DeliveryAddress": {
      "CountryCode": "sample string 1",
      "StreetName": "sample string 2",
      "HouseNumber": "sample string 3",
      "HouseNumberSuffix": "sample string 4",
      "ZipCode": "sample string 5",
      "Locality": "sample string 6",
      "AddressLine1": "sample string 7",
      "AddressLine2": "sample string 8",
      "StateOrProvince": "sample string 9"
    },
    "HonorificCode": 2
  },
  "CustomFieldValues": [
    {
      "OfferFieldDefinitionId": "af478cf2-33ff-4cfa-bdbd-cc5d48ef3f93",
      "Value": {}
    },
    {
      "OfferFieldDefinitionId": "af478cf2-33ff-4cfa-bdbd-cc5d48ef3f93",
      "Value": {}
    }
  ],
  "ContractHtml": "sample string 5",
  "LoyaltyCode": "sample string 6",
  "Source": 0
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Subscription
NameDescriptionTypeAdditional information
Id

globally unique identifier

Required

CompanyId

globally unique identifier

Required

OfferId

globally unique identifier

Required

OfferSerialNumberId

globally unique identifier

Required

AppInstallId

string

Required

String length: inclusive between 0 and 200

Scanned

date

Required

CompanyName

string

None.

Source

SubscriptionSource

None.

OrderDetails

OrderDetails

Required

CustomFieldValues

Collection of Object

None.

Price

decimal number

Range: inclusive between 0.00 and 999999999999999999.99

CurrencyCode

string

Required

LoyaltyCode

string

None.

DataPartner

string

None.

ContractPdf

Collection of byte

None.

Created

date

None.

ResponseDownloaded

date

None.

AvailableForResponse

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": "7e575cfd-9284-404a-9818-517a24b2b8e7",
  "CompanyId": "801178a8-9fc1-49e1-84b6-0e8c721d91ef",
  "OfferId": "9fa19b77-48a4-4f7b-9158-42c3dc653d53",
  "OfferSerialNumberId": "b4c47475-5863-4e28-b509-2c5d17e69d89",
  "AppInstallId": "sample string 5",
  "Scanned": "2022-05-21T10:19:00.5026992+00:00",
  "CompanyName": "sample string 7",
  "Source": 0,
  "OrderDetails": {
    "Honorific": "sample string 1",
    "Initials": "sample string 2",
    "SurnamePrefix": "sample string 3",
    "Surname": "sample string 4",
    "PhoneNumber": "sample string 5",
    "Email": "sample string 6",
    "MerchantOrderReference": "sample string 7",
    "PaymentReference": 1,
    "TraceReference": 1,
    "TransactionReference": "sample string 8",
    "IsPaid": true,
    "PaymentStatus": 0,
    "DateOfBirth": "2022-05-21T10:19:00.5026992+00:00",
    "BankAccount": {
      "AccountNumber": "sample string 1",
      "AccountHolder": "sample string 2"
    },
    "Address": {
      "CountryCode": "sample string 1",
      "StreetName": "sample string 2",
      "HouseNumber": "sample string 3",
      "HouseNumberSuffix": "sample string 4",
      "ZipCode": "sample string 5",
      "Locality": "sample string 6",
      "AddressLine1": "sample string 7",
      "AddressLine2": "sample string 8",
      "StateOrProvince": "sample string 9"
    },
    "DeliveryConsignee": "sample string 10",
    "DeliveryAddress": {
      "CountryCode": "sample string 1",
      "StreetName": "sample string 2",
      "HouseNumber": "sample string 3",
      "HouseNumberSuffix": "sample string 4",
      "ZipCode": "sample string 5",
      "Locality": "sample string 6",
      "AddressLine1": "sample string 7",
      "AddressLine2": "sample string 8",
      "StateOrProvince": "sample string 9"
    },
    "HonorificCode": 2
  },
  "CustomFieldValues": [],
  "Price": 1.0,
  "CurrencyCode": "sample string 8",
  "LoyaltyCode": "sample string 9",
  "DataPartner": "sample string 10",
  "ContractPdf": "QEA=",
  "Created": "2022-05-21T10:19:00.5495711+00:00",
  "ResponseDownloaded": "2022-05-21T10:19:00.5495711+00:00",
  "AvailableForResponse": true
}

application/xml, text/xml

Sample:
<Subscription xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Id>7e575cfd-9284-404a-9818-517a24b2b8e7</Id>
  <CompanyId>801178a8-9fc1-49e1-84b6-0e8c721d91ef</CompanyId>
  <OfferId>9fa19b77-48a4-4f7b-9158-42c3dc653d53</OfferId>
  <OfferSerialNumberId>b4c47475-5863-4e28-b509-2c5d17e69d89</OfferSerialNumberId>
  <SerialNumber>
    <Id>a08e04df-c83f-4506-b66f-be2a464bf042</Id>
    <SequenceNumber>4</SequenceNumber>
    <CampaignItemId>6f343929-a252-4a82-a1a1-9e19c57f2cc8</CampaignItemId>
    <ScanCode>sample string 5</ScanCode>
    <CreatorUserId>sample string 6</CreatorUserId>
    <DisplayLabelId>307c839f-0ab2-450b-8028-764cb6fb65bc</DisplayLabelId>
    <BarcodeId>073c59c6-f42c-479e-a382-84b5d1ba6d03</BarcodeId>
    <Created>2022-05-21T10:19:00.5026992+00:00</Created>
    <LastModified>2022-05-21T10:19:00.5026992+00:00</LastModified>
    <OfferId>6f343929-a252-4a82-a1a1-9e19c57f2cc8</OfferId>
  </SerialNumber>
  <AppInstallId>sample string 5</AppInstallId>
  <Scanned>2022-05-21T10:19:00.5026992+00:00</Scanned>
  <CompanyName>sample string 7</CompanyName>
  <Source>App</Source>
  <OrderDetails>
    <Honorific>sample string 1</Honorific>
    <Initials>sample string 2</Initials>
    <SurnamePrefix>sample string 3</SurnamePrefix>
    <Surname>sample string 4</Surname>
    <PhoneNumber>sample string 5</PhoneNumber>
    <Email>sample string 6</Email>
    <MerchantOrderReference>sample string 7</MerchantOrderReference>
    <PaymentReference>1</PaymentReference>
    <TraceReference>1</TraceReference>
    <TransactionReference>sample string 8</TransactionReference>
    <IsPaid>true</IsPaid>
    <PaymentStatus>Open</PaymentStatus>
    <DateOfBirth>2022-05-21T10:19:00.5026992+00:00</DateOfBirth>
    <BankAccount>
      <AccountNumber>sample string 1</AccountNumber>
      <AccountHolder>sample string 2</AccountHolder>
    </BankAccount>
    <Address>
      <CountryCode>sample string 1</CountryCode>
      <StreetName>sample string 2</StreetName>
      <HouseNumber>sample string 3</HouseNumber>
      <HouseNumberSuffix>sample string 4</HouseNumberSuffix>
      <ZipCode>sample string 5</ZipCode>
      <Locality>sample string 6</Locality>
      <AddressLine1>sample string 7</AddressLine1>
      <AddressLine2>sample string 8</AddressLine2>
      <StateOrProvince>sample string 9</StateOrProvince>
    </Address>
    <DeliveryConsignee>sample string 10</DeliveryConsignee>
    <DeliveryAddress>
      <CountryCode>sample string 1</CountryCode>
      <StreetName>sample string 2</StreetName>
      <HouseNumber>sample string 3</HouseNumber>
      <HouseNumberSuffix>sample string 4</HouseNumberSuffix>
      <ZipCode>sample string 5</ZipCode>
      <Locality>sample string 6</Locality>
      <AddressLine1>sample string 7</AddressLine1>
      <AddressLine2>sample string 8</AddressLine2>
      <StateOrProvince>sample string 9</StateOrProvince>
    </DeliveryAddress>
  </OrderDetails>
  <CustomFieldValues />
  <Price>1</Price>
  <CurrencyCode>sample string 8</CurrencyCode>
  <LoyaltyCode>sample string 9</LoyaltyCode>
  <DataPartner>sample string 10</DataPartner>
  <ContractPdf>QEA=</ContractPdf>
  <Created>2022-05-21T10:19:00.5495711+00:00</Created>
  <ResponseDownloaded>2022-05-21T10:19:00.5495711+00:00</ResponseDownloaded>
  <AvailableForResponse>true</AvailableForResponse>
  <RowVersion>QEA=</RowVersion>
</Subscription>