The Users resource contains information about the customers in the system.
{base_url}/users
| Name | Type | Mandatory? | Constraints | Notes |
|---|---|---|---|---|
| id | int | yes | Must be unique. | Internal unique ID generated by the system. |
| user_id | string | yes | Must be unique. | Unique ID. |
| amazon_id | string | yes | - | The user’s Amazon account ID. |
| name | string | yes | - | The user’s full name. |
| string | yes | Must contain an ‘@’ symbol. | The user’s email address. | |
| gift_cards | string[] | yes | - | Array of gift card card_ids associated with the user. |
Example:
{
"id": 1,
"user_id": "user001",
"amazon_id": "amz12345",
"name": "John Doe",
"email": "john.doe@example.com",
"gift_cards": [
"hanes-gc-001",
"nike-gc-002"
]
}
The Users resource offers the following REST interfaces: