User Receipt History
Request Details
| Item | Value |
| Description | The user receipt history endpoint returns all of a member’s receipt processing submissions. *This feature requires a configured receipt scanning program.* |
| Method | GET |
| Endpoint | https://[environment]api[client_id].crowdtwist.com/v2/users/[user_id]/receipts?api_key=[api key]&id_type=[id type] |
Request
| Field Name | Sample Value | Required | Format | Notes |
| URL PARAMETERS | ||||
| user_id | alice@crowdtwist.com | Yes | String | Unique ID of the user for whom activities will be returned: Options: – Email Address – Facebook User ID – Twitter User ID – CrowdTwist ID – Third Party ID – Username – Mobile Phone Number |
| QUERY STRING PARAMETERS | ||||
| api_key | QWERTYUIOP | Yes | String | |
| id_type | No | String | Type of ID being Sent: Options: – facebook_user_id – twitter_user_id – id (CrowdTwist ID) – default ID if id_type is not specified – third_party_id – username – mobile_phone_number |
|
| page | No | Number | The page being requested. | |
| page_size | No | Number | The number of results to display per page. The default is 10 and maximum is 25. | |
Samples
Sample Response Body
{
"paging": {
"total": 30,
"pages": 2,
"next_page": "[link to next page]",
"prev_page": "[link to prev page]"
},
"submitted_receipts": [
{
"date_submitted": "2019-01-01T12:00:00Z",
"file_id": "283f26e2be62866cb06c40886cd11c9fa2396385",
"file_name": "receipt.jpg",
"file_url": "https://cdn.crowdtwist.com/img/v2/283f26e2be62866cb06c40886cd11c9fa2396385/w/h/0/image.jpeg",
"id": 19382,
"scan_result": "NO_PRODUCTS",
"scan_result_text": "The products listed on your receipt are not included in this promotion."
}
]
}
Scan Results:
The following scan results are possible:
- NOT_SCANNED
- RECEIPT_UNREADABLE
- INVALID_PURCHASE_DATE
- NO_PRODUCTS
- DUPLICATE_SUBMISSION
- INVALID_STORE
- DEFER_TO_CUSTOMER_SERVICE
- POTENTIAL_FRAUD_DETECTED
- PURCHASED_OUT_OF_STATE
- NO_STATE_INFO_ON_RECEIPT
- NO_STATE_INFO_IN_USER_PROFILE
- NO_MATCHING_PRODUCTS_FOUND
- AWARDED
Each result has corresponding text key that can be modified.
Sample Error Response: Status Code 404 – User Provided Cannot be Found
{
"error": "user_not_found",
"message": "User does not exist or is inactive."
}