POST api/Offers

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
SourceOfferId	globally unique identifier	None.
CampaignId	globally unique identifier	None.
OfferType	OfferType	None.
CampaignGroupId	globally unique identifier	None.
ScanCode	string	String length: inclusive between 0 and 200
NumberOfSerialNumbers	integer	Range: inclusive between 1 and 2147483647
Name	string	String length: inclusive between 0 and 100
Remarks	string	String length: inclusive between 0 and 400
Title	string	String length: inclusive between 0 and 100
Description	string	String length: inclusive between 0 and 800
TermsAndConditions	string	String length: inclusive between 0 and 5000
RequiresAutograph	boolean	None.
CustomFields	Collection of OfferFieldDefinition	None.
RequiredFields	OrderDetailFieldType	None.
Price	decimal number	Range: inclusive between 0.00 and 999999999999999999.99
CurrencyCode	string	Required
AskLoyaltyOptIn	boolean	None.
LoyaltyCode	string	None.
LoyaltyQuestion	string	None.
DataPartner	string	None.
Image	Collection of byte	Max length: 512000
Start	date	None.
End	date	None.
PublisherId	globally unique identifier	None.
PaymentHandler	PaymentHandler	None.
DeliveryCountryCode	string	Required
HasVaultOption	boolean	Required
RetentionDays	integer	None.
OfferCodeType	OfferCodeType	None.
MaxOfferCodes	integer	Range: inclusive between 0 and 9999999
ManualOfferCodes	Collection of string	None.
EmailTemplateSelection	OfferEmailTemplateSelection	None.
ConfirmationAttachment	Collection of byte	Max length: 2048000
ConfirmationAttachmentName	string	None.
RemoveExistingConfirmationAttachment	boolean	None.
AllowWebSubmissions	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "SourceOfferId": "60a9b4c9-00ac-48a6-81d6-3c03d218e2ee",
  "CampaignId": "4e0f94c9-49c3-444b-b455-87a1e4df082e",
  "OfferType": 1,
  "CampaignGroupId": "7891962d-bad8-489a-acbf-0ff44ff6bf12",
  "ScanCode": "sample string 3",
  "NumberOfSerialNumbers": 4,
  "Name": "sample string 5",
  "Remarks": "sample string 6",
  "Title": "sample string 7",
  "Description": "sample string 8",
  "TermsAndConditions": "sample string 9",
  "RequiresAutograph": true,
  "CustomFields": [
    {
      "Id": "bbf36408-f88a-4f48-9ddc-e188957014df",
      "Order": 2,
      "Title": "sample string 3",
      "Type": 0,
      "Values": [
        "sample string 1",
        "sample string 2"
      ]
    },
    {
      "Id": "bbf36408-f88a-4f48-9ddc-e188957014df",
      "Order": 2,
      "Title": "sample string 3",
      "Type": 0,
      "Values": [
        "sample string 1",
        "sample string 2"
      ]
    }
  ],
  "RequiredFields": 0,
  "Price": 1.0,
  "CurrencyCode": "sample string 11",
  "AskLoyaltyOptIn": true,
  "LoyaltyCode": "sample string 13",
  "LoyaltyQuestion": "sample string 14",
  "DataPartner": "sample string 15",
  "Image": "QEA=",
  "Start": "2022-05-21T09:50:56.2920422+00:00",
  "End": "2022-05-21T09:50:56.2920422+00:00",
  "PublisherId": "0ef8809c-212f-44c7-9b33-53f3d036e6b2",
  "PaymentHandler": 0,
  "DeliveryCountryCode": "sample string 18",
  "HasVaultOption": true,
  "RetentionDays": 1,
  "OfferCodeType": 0,
  "MaxOfferCodes": 1,
  "ManualOfferCodes": [
    "sample string 1",
    "sample string 2"
  ],
  "EmailTemplateSelection": {
    "Localization": 11,
    "TemplateId": "5b635347-89c3-4970-9d24-364c9d010d2b"
  },
  "ConfirmationAttachment": "QEA=",
  "ConfirmationAttachmentName": "sample string 20",
  "RemoveExistingConfirmationAttachment": true,
  "AllowWebSubmissions": true
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IOffer

Name	Type	Additional information
Enabled	boolean	None.
Blocked	boolean	None.
CampaignId	globally unique identifier	None.
CampaignGroupId	globally unique identifier	None.
CreatorUserId	string	None.
BarcodeId	globally unique identifier	None.
Name	string	None.
Version	integer	None.
IsLatestVersion	boolean	None.
Remarks	string	None.
AllowWebSubmissions	boolean	None.
Created	date	None.
LastModified	date	None.
DeliveryCountryCode	string	None.
PublisherId	globally unique identifier	None.
HasVaultOption	boolean	None.
RetentionDays	integer	None.
OfferCodeType	OfferCodeType	None.
MaxOfferCodes	integer	None.
HumanReadableOfferId	string	None.

Response Formats

application/json, text/json

Sample:

Sample not available.