Push Redemptions


Request Details

Item Value
Description Sends information about a particular redemption to a client specified endpoint.
Method POST
Endpoint Client provided, must begin with https://


Request Body

Field Name Sample Value Required Format Description
orderDate 1438043367   String  
orderId 101   Long Unique ID for the redemption
shippingFirstName null   String  
shippingLastName null   String  
shippingStreetAddress1 null   String  
shippingStreetAddress2 null   String  
shippingCountry null   String  
shippingState null   String  
shippingCity null   String  
shippingPostalCode null   String  
shippingPhoneNumber null   String  
emailAddress johndoe@gmail.com   String  
redeemablePoints 2000   Long  
quantity 1   Long  
category Reward Category   String  
rewardTitle Reward Title   String  
color null   String  
size null   String  
couponCode null   String  
notes Reward Notes   String  
thirdPartyId null   String  
referenceId null   String  
firstName John   String  
lastName Lim   String  
userName johndoe23   String  
dateFulfilled null   String  
trackingNumber null   String  
totalPointsRedeemed 10   Long  
userId     Long  


Sample Request

{
  "totalPointsRedeemed": 10,
  "shippingCity": null,
  "lastName": "Lim",
  "notes": "Reward Notes",
  "color": null,
  "orderId": 101,
  "redeemablePoints": 2000,
  "rewardTitle": "Reward Title",
  "shippingStreetAddress1": null,
  "shippingStreetAddress2": null,
  "shippingPostalCode": null,
  "referenceId": null,
  "thirdPartyId": null,
  "emailAddress": "johndoe@gmail.com",
  "shippingCountry": null,
  "shippingPhoneNumber": null,
  "trackingNumber": null,
  "quantity": 1,
  "shippingLastName": null,
  "userName": "johndoe23",
  "firstName": "John",
  "dateFulfilled": null,
  "size": null,
  "shippingFirstName": null,
  "shippingState": null,
  "category": "Reward Category",
  "orderDate": "1438043367",
  "couponCode": null
}
{
  "totalPointsRedeemed": 10,
  "shippingCity": null,
  "lastName": "Lim",
  "notes": "Reward Notes",
  "color": null,
  "orderId": 101,
  "redeemablePoints": 2000,
  "rewardTitle": "Reward Title",
  "shippingStreetAddress1": null,
  "shippingStreetAddress2": null,
  "shippingPostalCode": null,
  "referenceId": null,
  "thirdPartyId": null,
  "emailAddress": "johndoe@gmail.com",
  "shippingCountry": null,
  "shippingPhoneNumber": null,
  "trackingNumber": null,
  "quantity": 1,
  "shippingLastName": null,
  "userName": "johndoe23",
  "firstName": "John",
  "dateFulfilled": null,
  "size": null,
  "shippingFirstName": null,
  "shippingState": null,
  "category": "Reward Category",
  "orderDate": "1438043367",
  "couponCode": null
}