Search…
Fields used as keys
Learn how to use fields as keys.
You can use the following keys for reporting purposes with Order Notification, Sales Order Activity, and Subscription Services:

Email address

To use email as a key, check the email element under the billingAddress element first.
JSON
1
{
2
"billingAddress": {
3
"emailAddress": ""
4
}
5
}
Copied!
If no billingAddress elements exist, locate the email element associated with the shippingAddress.
JSON
1
{
2
"shippingAddress": {
3
"emailAddress": ""
4
}
5
}
Copied!
Any shippingAddress for any lineItem will suffice since the address appears for all the line items.

Consumer name

To use the consumer name as a key, check the name element under the payment element first.
JSON
1
{
2
"payment": {
3
"customerFirstName": "",
4
"customerLastName": ""
5
}
6
}
Copied!
If no payment element exists, locate the consumer name element associated with the shippingAddress.
JSON
1
{
2
"shippingAddress": {
3
"customerFirstName": "",
4
"customerLastName": ""
5
}
6
}
Copied!
Any the shippingAddress for any lineItem will suffice since the address appears for all the line items.

Digital rights

To use digital rights as a key, check the serialNumber and unlockCode elements under the lineItems element.
Plain Text
1
{
2
"lineItems": {
3
"lineItem": {
4
"digitalRights": {
5
"serialNumber": "",
6
"unlockCode": ""
7
}
8
}
9
}
10
}
Copied!

CustomerID field

Use the customerID field as a key, when you want to attribute orders to users who have access to MyAccount where they can change their login IDs and email addresses.
Last modified 1yr ago