Order contact REST API v2 (legacy)
Important
A newer version of this REST API (v2.1) is available. If you're new to this REST API, use the new version. Alternatively, if you're already using the old version, read about the differences between v2 and v2.1 so you can upgrade.
An order contact is a person who is the primary contact for an order. The same guest can be both the order contact and order consumer.
The following table describes the order contact attributes:
| Attribute | Type | Description | Example(s) |
|---|---|---|---|
title | string (title case) | The title of the order contact. | "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" |
firstName | string (title case recommended) | The first name of the order contact. | "John" |
lastName | string (title case recommended) | The last name of the order contact. | "Doe" |
gender | string (lowercase) | The gender of the order contact. | "male", "female", "unknown" |
dateOfBirth | ISO 8601 Date UTC | The date of birth of the order contact. | "1985-12-24T00:00Z" |
emails | array of strings | The email address of the order contact. | ["[email protected]", "[email protected]"] |
nationality | string (title case recommended) | The nationality of the order contact. | "Irish", "British", "Spanish", "French" |
country | 2 letter ISO 3166-1 Alpha-2 country code (uppercase) | The country where the order contact is currently living. | "IE", "GB", "ES", "FR" |
passportNumber | string | The passport number for the order contact. | "PZ4A9565" |
passportExpiry | ISO 8601 Date UTC | The expiry date for the order contact's passport. | "2025-01-01T00:00.000Z" |
phoneNumbers | A JSON array of strings. | The phone number of the order contact. | N/A |
identifiers | A JSON array of JSON objects. | The list of identifiers for the contact. | N/A |
guest | object | The guest resource linked to this resource. | N/A |
order | object | The order resource linked to this resource. | N/A |
The following are identifier model attributes:
| Attribute | Description | Type | Example(s) | Required/optional |
|---|---|---|---|---|
provider | The identifier provider. | string | "ProfileSystem" | Required |
id | The identifier ID. | string | "B7524AE6-CF1C-440F-B1A2-0C9D42F5CB41" | Required |
expiryDate | The expiry date of the identifier. | ISO 8601 Date/Time UTC | "2025-01-01T16:17.000Z" | Optional |
The following are the standard response attributes:
| Attribute | Description | Type | Example(s) |
|---|---|---|---|
href | The resource fully qualified location Uniform Resource Identifier (URI). | string | "https://{apiEndpoint}/v2/{resourceName}/{resourceRef}" |
ref | The reference of the resource. | string UUID | "9d94ee11-7043-4b71-980c-a777d00a7b46" |
createdAt | Date and time when the resource was created in Sitecore CDP. | ISO 8601 Date/Time UTC | "2026-01-01T16:17.000Z" |
modifiedAt | Date and time when the resource was updated in Sitecore CDP. | ISO 8601 Date/Time UTC | "2026-01-01T16:17.000Z" |
If you have suggestions for improving this article, let us know!