...
| Field | Type | Required | Edit/Update | Comment | ||
| merchantId | string(30) | Yes* | No | old password | ||
| customerProfileId | string(30) | Yes* | No | new password | ||
| id | id | Yes* | No | an internal identifer to the record. Used during updates/deletes. Do not create your own. The server will assign an id when the object is created and it will be returned from the insert call. | ||
| cardType | string | Yes | Yes | A Valid card type. This depends on what the merchant has configured, but the possible values are: Case and spaces matter on the card type. Take care. | ||
| cardExpMonth | int | Yes | Yes | 1-12 corresponding to the 12 months of Jan-Feb | ||
| cardExpYear | int | Yes | Yes | Four digit year. | ||
| cardNumber | string | Yes | Yes | A valid credit card number. Validity depends on the card type.
| ||
| lastUsedDate | string | No | No | ISO-8601 format. very handy when used with something like moment.js Updated whenever the card is used or changed. Do not provide or update this value. Any updates are ignored. This value is assigned on the server. | ||
| lastUsedDateFormatted | string | No | No | A formatted version of lastUsedDate. Format is: dd MMM yyyy HH:mm:ss |
CustomerCredentials
This is the wrapper object for the values needed during login.
| Field | Type | Required | Edit/Update | Comment |
| merchantId | string(50) | Yes | N/A | |
| string(100) | Yes | N/A |
| |
| password | string(30) | Yes | N/A |
CustomerCredentials
MyAccount
NotReviewedItem
Order
OrderTracking
OrderItem
ReviewedItem
MyAccount
This contains the high level record for the customer. While there is overlap between this record and the shipping/billing addresses, this is the address of record.
It cannot be deleted, except to delete the entire customer.
This record cannot be created, except during the ordering process by the customer. It can only be selected / updated / deleted from the MyAccount API
| Field | Type | Required | Comment |
| merchantId | string(5) | Yes | |
| customerProfileId | 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! |
| title | string(50) | No | |
| 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 | |
| fax | string(32) | No | Does anyone even use fax machines any more? If so, this field is for them. |
| taxId | string(15) | No | Very popular field for wholesale customers. |
| password | string(30) | No | This is not returned when the records are selected, and it cannot be updated via this record. It must be updated via a specific call (changePassword). As I write this, I'm not really sure why it's even a part of this record... |
NotReviewedItem
This object represents a purchased item that does not yet have a review written by the customer. It's used on the reviews page and contains enough information to display a line enticing the customer to write a review and then direct them to the review screen.
Reviews cannot be created via this API. This was done on purpose to drive all reviews through the review cgi. That cgi has a multitude of functionality chosen not to duplicate.
| Field | Type | Comment |
| merchantId | string(5) | |
| itemId | string(30) | The merchant item id. |
| merchantItemOid | string | An string containing a number that is used to internally identify the item record. Both the item id and oid are provided because both are needed at different times during the display and link creation. |
| lastOrderDate | string | ISO-8601 format. very handy when used with something like moment.js Contains the last date the item was ordered. Since the "not reviewed yet" item list is a distinct list, this value helps show the most recent purchases first. |
| lastOrderDateFormatted | string | A formatted version of lastOrderDate. 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. |
| item | Item | A complex item containing all the details about the item. See its page for specifics. |
Order
OrderTracking
ReviewedItem
This read-only object contains an item review.
| Field | Type | Comment |
| itemId | string | the item id of the item reviewed |
| item | Item | A complex item containing all the details about the item. See its page for specifics. |
| reviewOid | integer | review record's internal identifier |
| merchantId | string | the merchant id (your merchant id) |
| customerProfileId | integer | customer's internal identifier |
| merchantItemOid | integer | item's internal identifier |
| overall | number | 1-5 The overall rating of the item. This should be featured prominently. |
| ratingName1 | string | The name (category) of this rating. Configured by the merchant. Examples: Ease of Use, Price, Durability, etc. |
| ratingName2 | string | The name (category) of this rating. |
| ratingName3 | string | The name (category) of this rating. |
| ratingName4 | string | The name (category) of this rating. |
| ratingName5 | string | The name (category) of this rating. |
| ratingName6 | string | The name (category) of this rating. |
| ratingName7 | string | The name (category) of this rating. |
| ratingName8 | string | The name (category) of this rating. |
| ratingName9 | string | The name (category) of this rating. |
| ratingName10 | string | The name (category) of this rating. |
| ratingScore1 | number | 1-5, the rating for the associated rating name. |
| ratingScore2 | number | 1-5, the rating for the associated rating name. |
| ratingScore3 | number | 1-5, the rating for the associated rating name. |
| ratingScore4 | number | 1-5, the rating for the associated rating name. |
| ratingScore5 | number | 1-5, the rating for the associated rating name. |
| ratingScore6 | number | 1-5, the rating for the associated rating name. |
| ratingScore7 | number | 1-5, the rating for the associated rating name. |
| ratingScore8 | number | 1-5, the rating for the associated rating name. |
| ratingScore9 | number | 1-5, the rating for the associated rating name. |
| ratingScore10 | number | 1-5, the rating for the associated rating name. |
| recommendToFriend | boolean | true if the customer would recomment the item to a friend. |
| title | string | The title of the review |
| review | string | The review itself. These are the customer's comments. |
| statusCode | string | Approved, Rejected, or Unapproved |
| featured | boolean | true if the merchant has chosen to feature this review |
| recommendStoreToFriend | boolean | true if the customer would recommend your store to friends. |
| storeFeedback | string | any comments the customer had for your store |
| submittedDate | string | ISO-8601 format. very handy when used with something like moment.js Contains the date when the review was submitted |
| submittedDateFormatted | string | A formatted version of submittedDate. 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. |
| helpfulYesVotes | integer | the number of times other customers have marked a review as helpful. |
| helpfulNoVotes | integer | the number of times other customers have marked a review as unhelpful. |
TODO:
/myaccount/loggedIn (GET)
...