Read a single entry

Request

Returns one entry in the full representation, identical to the create response. Only entries you sent are addressable here — entries Onward issued itself have no shop_transaction_id.

Security

api_key

Path

shopRewardIdstringrequired

The ID of the parent discount that the reward is tied to — not the discount code, and not one of Onward's internal IDs. Read it from the customer's rewards array. Onward rewrites this value if it has to recreate a discount that was deleted, so treat a 404 here as a signal to re-read GET /customers/{shopCustomerId} and pick up the current value.

Example:1234567890

shopTransactionIdstringrequired

The entry's ID in your platform, as you sent it.

Acceptstringrequired

Accept must be application/json

Example:application/json

curl -i -X GET \
  'https://app.useonward.com/api/v1/rewards/1234567890/transactions/{shopTransactionId}' \
  -H 'Accept: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Successful operation

Bodyapplication/json

shop_transaction_idstring or nullrequired

Null for entries Onward issued itself, which are therefore not individually addressable.

Example:"inveterate:1a2b3c"

amountobject(Money)required

classificationstringrequired

Derived by Onward and returned for information only.

Enum:"issued""pending_issuance""used"

issues_atstring or null, (date-time)

created_atstring, (date-time)required

source_detailsobject(SourceDetails)

Where the entry came from. name is a stable lowercase slug assigned when your integration is onboarded, and it is the only key Onward reads — it attributes the entry to the platform that sent it, since the API key resolves to a shop rather than to a caller. Every other key belongs to you: Onward stores it verbatim, surfaces it for support, and never interprets it. Keep it a flat object of string values with a small number of keys. There is deliberately no Onward vocabulary for why credit was earned, so your own reason travels here.

Example:

{
  "name": "inveterate",
  "reason": "SIGNUP_STORE_CREDIT"
}

rewardobject(Reward)required

The affected reward, with balances updated.

Response

{
  "shop_transaction_id": "inveterate:1a2b3c",
  "amount": {
    "cents": 1299,
    "currency": "USD"
  },
  "classification": "issued",
  "issues_at": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "source_details": {
    "name": "inveterate",
    "reason": "SIGNUP_STORE_CREDIT"
  },
  "reward": {
    "shop_reward_id": "1234567890",
    "balance": { … },
    "pending_issuance_balance": { … },
    "lifetime_issued": { … },
    "lifetime_used": { … },
    "lifetime_refunded": { … },
    "redemption_details": { … },
    "balance_updated_at": "2019-08-24T14:15:22Z"
  }
}