Request Details

Item	Value
Description	The Points Awaiting Fulfillment API returns a summary of the points waiting fulfillment for a specific user.
Method	GET
Endpoint	https://[environment]pos[client_id].crowdtwist.com/fulfillment/users/[user_id]
HTTP Header	X-CT-Authorization = CTApiKey [API Key] Note: there is a space between CTApiKey and the API Key value

Request

Field Name	Sample Value	Required	Format	Description
URL PARAMETERS
user_id	11138266	Yes	String	CrowdTwist generated user_id. Required if query parameters are not used.
QUERY PARAMETERS
email_address	test@crowdtwist.com	No	String	Customer email address
mobile_phone_number	5551239687	No	String	Customer phone number
third_party_id	97843	No	String	Customer generated user identifier

Response

Response Body

Field Name	Sample Value	Required	Format	Description
user_id	1	Yes	Integer	The CrowdTwist ID of the user.
total_points_awaiting_fulfillment	4000	Yes	Integer	The total purchase points for a user that have not yet been fulfilled.
bonus_points_awaiting_fulfillment	1000	Yes	Integer	The total bonus points for a user from purchases that have not yet been fulfilled.

Error Responses

Field Name	Sample Value	Required	Format	Description
system	pos	Yes	String	Domain where the error occurred.
reason	internal_error	Yes	String	The identifier of the category of the error. This gives the client the ability to categorize errors and make assumptions based on the identifier of the error.
description	Field value is empty	Yes	String	This is a short form description of the error.
message	User could not be found	Yes	String	This is a detailed message around the error specifying, as specifically as possible, what the fields are that are missing or where exactly the error is.

Error Response Codes

Error	Error Code	Description	Reason
Input Error	4xx	Returned whenever the request is missing required fields, including situations in which the body is malformed (e.g. HTTP method not supported, receipt not found, etc.).	– missing_data – not_unique – receipt_not_found – quantity_too_large – sku_not_found – not_supported (if an endpoint is not supported, a status HTTP code of 405 will be returned) – invalid
Server Error	5xx	HTTP error status code is returned due to an error that occurred in the backend.	– internal_error: unexpected error occurred in the CrowdTwist backend – not_configured: error occurs when an configuration has not been configured yet

Example Response Codes

Response Code	System	Reason	Description	Message
400	pos	user_not_found	User not found	User with given attributes could not be found.

Samples

Sample Request with User ID

 

Sample Request with Email Address

 

Sample Response Body

 

Sample Error Response