POST api/CRM/AddPurchase

Add purchase - A combination of AddPerson and ProcessTrialOrder

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
BillingAddress		AddressModel	None.
CampaignCode		string	None.
CompanyName		string	None.
DialerCampaignName		string	None.
DialerOrderId		string	None.
DialerSource		string	None.
Email		string	None.
FirstName		string	None.
IsCompany		boolean	None.
LastName		string	None.
MobilePhone		string	None.
Products		Collection of OrderedProduct	None.
SalesPersonEmail		string	None.
SalesPersonName		string	None.
SalesPersonOffice		string	None.
SMSApprovedDate		date	None.
StartDate		date	None.
UniqueNumber	Person/organisation number	string	None.

Request Formats

application/json, text/json

Sample:

{
  "BillingAddress": {
    "$id": "2",
    "Address1": "sample string 1",
    "Address2": "sample string 2",
    "City": "sample string 3",
    "DoorCode": "sample string 4",
    "PostNumber": "sample string 5"
  },
  "CampaignCode": "sample string 1",
  "CompanyName": "sample string 2",
  "DialerCampaignName": "sample string 3",
  "DialerOrderId": "sample string 4",
  "DialerSource": "sample string 5",
  "Email": "sample string 6",
  "FirstName": "sample string 7",
  "IsCompany": true,
  "LastName": "sample string 9",
  "MobilePhone": "sample string 10",
  "Products": [
    {
      "$id": "3",
      "Address": {
        "$ref": "2"
      },
      "DesiredSerialNumber": "sample string 1",
      "ExtraTagCount": 2,
      "Name": "sample string 3",
      "PublicId": "sample string 4",
      "SecurityServiceOpted": true
    },
    {
      "$ref": "3"
    }
  ],
  "SalesPersonEmail": "sample string 11",
  "SalesPersonName": "sample string 12",
  "SalesPersonOffice": "sample string 13",
  "SMSApprovedDate": "2025-12-22T03:05:50.7475627+00:00",
  "StartDate": "2025-12-22T03:05:50.7475627+00:00",
  "UniqueNumber": "sample string 15"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseOfAddPersonResponse

Name	Type	Additional information
Data	AddPersonResponse	None.
Result	boolean	None.
Message	string	None.
Errors	Object	None.

Response Formats

application/json, text/json

Sample:

{
  "Data": {
    "$id": "2",
    "IsPersonSaved": true,
    "PersonId": 2,
    "PersonOrganisationId": 3,
    "LeadId": "33fd6d90-03ba-4191-8a4d-fa3f074a7340",
    "EmailStatus": {
      "$id": "3",
      "EmailType": "sample string 1",
      "IsSent": true,
      "Message": "sample string 3"
    }
  },
  "Result": true,
  "Message": "sample string 2",
  "Errors": {
    "$id": "4"
  }
}