Fields used as keys

Learn how to use fields as keys.

For reporting purposes, you can use the following keys described below with Order Notification, Sales Order Activity, and Subscription Services for reporting purposes.

Email address

To use email as a key, check the email element under the billingAddress element first.

JSON

{
	"billingAddress": {
		"emailAddress": ""
	}
}

If no billingAddress elements exist, locate the email element associated with the shippingAddress.

JSON

{
	"shippingAddress": {
		"emailAddress": ""
	}
}

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

{
	"payment": {
		"customerFirstName": "",
		"customerLastName": ""
	}
}

If no payment element exists, locate the consumer name element associated with the shippingAddress.

JSON

{
	"shippingAddress": {
		"customerFirstName": "",
		"customerLastName": ""
	}
}

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

{
	"lineItems": {
		"lineItem": {
			"digitalRights": {
				"serialNumber": "",
				"unlockCode": ""
			}
		}
	}
}

CustomerID field

Use the customerID field as a key when you want to attribute orders to users with access to MyAccount, where they can change their login IDs and email addresses.