Page Comparison

...

Info

id fields are only required for existing objects. When creating/adding new objects, the id field is always blank and provided by the UltraCart servers.
Any string fields larger than their maximum size are silently truncated. The field sizes are large enough to handle most data, and the truncation is rarely a problem. The biggest issue with with email addresses. But, an email over 100 characters is also a rarity (pity the soul that has that address).

Address

Field	Type	Required	Comment
id	int	Yes*	Object Identifier. This will always be returned from the server. Do not create one on your own (won't be accepted). A common problem that causes our json deserializer to vomit is submitting a new Address with an empty string. Null is okay. A string that is a parsable integer is okay. But a zero length string has no integer equivalent. Be careful not to do this!
company	string(50)	No
firstName	string(30)	Yes
lastName	string(30)	Yes
address1	string(32)	Yes
address2	string(32)	No
city	string(32)	Yes
state	string(32)	Yes
postalCode	string(20)	Yes	In the US, this is known as 'zip code'
country	string(32)	Yes
title	string(50)	No
dayPhone	string(25)	No
eveningPhone	string(25)	No

Case

Field	Type	Required	Edit/Update	Comment
caseOid	string	Yes*	No	Object Identifier. This will always be returned from the server. Do not create one on your own (won't be accepted).
merchantId	string(5)	Yes	No	not required during insert. it's collected from cookies
orderId	string(30)	Yes	No
email	string(100)	Yes	Yes	order email is used if missing
customerProfileId	string	Yes	No	this is an integer (it's type is a string to avoid server parser errors) this is the customer identifier. It is created when a customer creates a new profile during ordering. This value can be found from the MyAccount object returned from the login methods.
creationDate	string		No	ISO-8601 format. very handy when used with something like moment.js Assigned during case creation. Immutable afterwards.
creationDateFormatted	string		No	A formatted version of creationDate. Format is: dd MMM yyyy HH:mm:ss Sometimes it's not practical to format the ISO-8601 string, for example, within a Handlebars template.
subject	string(200)		Yes	This is whatever the customer chooses to name their correspondence with you. This isn't a prominent feature (it's not used as extensively as it could be).
status	string(50)		Yes	Valid Values: `New, Open, Reply Received, Awaiting Feedback, Closed` `New` `Open` `Reply Received` - the last activity on this case was the customer sending you, the merchant, an email `Awaiting Feedback` - the last activity on this case was you, the merchant, sending the customer an email. `Closed` As a merchant, you'll want to monitor New and Reply Received very closely. They require immediate response.
lastUpdateDate	string		No	ISO-8601 format. very handy when used with something like moment.js Updated whenever activity occurs. The system updates this. It will ignore any changes you make to this field.
lastUpdateDateFormatted	string		No	A formatted version of lastUpdateDate. Format is: dd MMM yyyy HH:mm:ss Sometimes it's not practical to format the ISO-8601 string, for example, within a Handlebars template.
messages	CaseMessage[ ]		Insert	an array of messages (emails). Contains both customer and merchant emails.

CaseMessage

ChangePasswordRequest

...

Versions Compared

Old Version 3

New Version 4

Key

Address

Case