Create an order contact

Request

Creates the primary contact on an order. In identifiers, make sure to provide enough identity information according to your organization's identity rules.

In the response, ref contains the order contact reference. Use the order contact reference to interact with a specific contact, for example, to retrieve or update it.

Security

BasicAuth

Path

orderRefstringrequired

The order reference. This is a unique identifier of the order record. Automatically generated when you created the order. If you don't know the order reference, first list orders.

Example:2d7de9df-45a2-45ea-872c-30e45139007d

Bodyapplication/json

firstNamestring, (title case)

The person's first name.

Example:"John"

lastNamestring, (title case recommended)

The person's last name.

Example:"Doe"

emailsArray of strings

All the email addresses of the person.

Example:

[
  "john.doe@gmail.com"
]

identifiersArray of objects(Identifier)

The guest's identifiers.

streetArray of strings

The order contact's street address.

Example:

[
  "Tara St.",
  "Main Ave."
]

citystring, (String)

The order contact's city.

Example:"Dublin"

statestring, (String)

The order contact's post code.

Example:"10001"

titlestring, (title case)

The title of the person.

Example values: "Br", "Brigadier", "Capt", "Colonel", "Dame", "Dr", "Elder", "Fr", "General", "Hon", "Judge", "Lord", "Master", "Miss", "Mr", "Mrs", "Ms", "Mstr", "Prof", "Rabbi", "Rev", "Shaikha", "Sheikh", "Sir", "Sister", "Sr"

Example:"Mr"

genderstring, (lowercase)

The person's gender.

Example values: "male", "female", "unknown"

Enum:"male""female""unknown"

Example:"male"

dateOfBirthstring, (date-time)

The person's date of birth. Validation: Date must be in the past.

Example:"1991-01-01T16:17:16Z"

phoneNumbersArray of strings

The phone numbers of the person.

Example:

[
  "+353161123345",
  "+353161123346"
]

nationalitystring, (title case)

The person's nationality.

Example values: "Irish", "British", "Spanish", "French"

Example:"Irish"

passportNumberstring, (uppercase)

The passport number of the contact.

Example:"PZ4A9565"

countrystring, (2-letter ISO 3166-1 Alpha-2 country code)

The guest's country.

Example values: "IE", "GB", "ES", "FR"

Example:"IE"

curl -i -X POST \
  -u '<username>:<password>' \
  https://api-engage-ap.sitecorecloud.io/v2.1/orders/2d7de9df-45a2-45ea-872c-30e45139007d/contacts \
  -H 'Content-Type: application/json' \
  -d '{
    "firstName": "John",
    "lastName": "Doe",
    "emails": [
      "john.doe@gmail.com"
    ],
    "identifiers": [
      {
        "provider": "ProfileSystem",
        "id": "B7524AE6-CF1C-440F-B1A2-0C9D42F5CB41"
      }
    ],
    "street": [
      "Tara St.",
      "Main Ave."
    ],
    "city": "Dublin",
    "state": "10001",
    "title": "Mr",
    "gender": "male",
    "dateOfBirth": "1991-01-01T16:17:16Z",
    "phoneNumbers": [
      "+353161123345",
      "+353161123346"
    ],
    "nationality": "Irish",
    "passportNumber": "PZ4A9565",
    "country": "IE"
  }'

Responses

Resource successfully created

Bodyapplication/json

refstring, (UUID)

The order contact reference.

Example:"2d7de9df-45a2-45ea-872c-30e45139007d"

hrefstring

The link to the order contact.

Example:"https://api-engage-eu.sitecorecloud.io/v2.1/orderContacts/2d7de9df-45a2-45ea-872c-30e45139007d"

firstNamestring, (title case)

The person's first name.

Example:"John"

lastNamestring, (title case recommended)

The person's last name.

Example:"Doe"

emailsArray of strings

All the email addresses of the person.

Example:

[
  "john.doe@gmail.com"
]

identifiersArray of objects(Identifier)

The guest's identifiers.

streetArray of strings

The order contact's street address.

Example:

[
  "Tara St.",
  "Main Ave."
]

citystring, (String)

The order contact's city.

Example:"Dublin"

statestring, (String)

The order contact's state.

Example:"New York"

postCodestring, (String)

The order contact's post code.

Example:"10001"

titlestring, (title case)

The title of the person.

Example values: "Br", "Brigadier", "Capt", "Colonel", "Dame", "Dr", "Elder", "Fr", "General", "Hon", "Judge", "Lord", "Master", "Miss", "Mr", "Mrs", "Ms", "Mstr", "Prof", "Rabbi", "Rev", "Shaikha", "Sheikh", "Sir", "Sister", "Sr"

Example:"Mr"

genderstring, (lowercase)

The person's gender.

Example values: "male", "female", "unknown"

Enum:"male""female""unknown"

Example:"male"

dateOfBirthstring, (date-time)

The person's date of birth. Validation: Date must be in the past.

Example:"1991-01-01T16:17:16Z"

phoneNumbersArray of strings

The phone numbers of the person.

Example:

[
  "+353161123345",
  "+353161123346"
]

nationalitystring, (title case)

The person's nationality.

Example values: "Irish", "British", "Spanish", "French"

Example:"Irish"

passportNumberstring, (uppercase)

The passport number of the contact.

Example:"PZ4A9565"

countrystring, (2-letter ISO 3166-1 Alpha-2 country code)

The guest's country.

Example values: "IE", "GB", "ES", "FR"

Example:"IE"

orderobject

The link to the order.

guestobject

The link to the guest.

Response

{
  "ref": "2d7de9df-45a2-45ea-872c-30e45139007d",
  "href": "https://api-engage-eu.sitecorecloud.io/v2.1/orderContacts/2d7de9df-45a2-45ea-872c-30e45139007d",
  "firstName": "John",
  "lastName": "Doe",
  "emails": [
    "john.doe@gmail.com"
  ],
  "identifiers": [
    { … }
  ],
  "street": [
    "Tara St.",
    "Main Ave."
  ],
  "city": "Dublin",
  "state": "New York",
  "postCode": "10001",
  "title": "Mr",
  "gender": "male",
  "dateOfBirth": "1991-01-01T16:17:16Z",
  "phoneNumbers": [
    "+353161123345",
    "+353161123346"
  ],
  "nationality": "Irish",
  "passportNumber": "PZ4A9565",
  "country": "IE",
  "order": {
    "href": "https://api-engage-eu.sitecorecloud.io/v2.1/orders?guestRef=2d7de9df-45a2-45ea-872c-30e45139007d&offset=1&limit=10"
  },
  "guest": {
    "href": "https://api-engage-eu.sitecorecloud.io/v2.1/guests/f7aabbca-1c1b-4fc2-be72-3e16294a4f03"
  }
}