Orishare
API reference

List rewards with issued counts

GET
/rewards

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Query Parameters

limit?integer
Range1 <= value <= 200
Default50
cursor?string
Lengthlength <= 2048
status?string

Value in

  • "active"
  • "archived"

Header Parameters

X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length
X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/rewards"
{  "data": [    {      "id": "string",      "name": "string",      "cost": 0,      "currency": "string",      "availability": 0,      "issued": 0,      "expiry_after": "string",      "status": "active",      "version": 0,      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "next_cursor": "string",  "has_more": true}

Create a reward

POST
/rewards

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Header Parameters

Idempotency-Key*string

Required. Official clients generate a UUID when omitted by the caller.

Length1 <= length <= 255
X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length
X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/rewards" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "name": "Reward",    "cost": 0  }'
{  "id": "string",  "name": "string",  "cost": 0,  "currency": "string",  "availability": 0,  "issued": 0,  "expiry_after": "string",  "status": "active",  "version": 0,  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}

One reward

GET
/rewards/{id}

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Path Parameters

id*string
Length1 <= length

Header Parameters

X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length
X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/rewards/string"
{  "id": "string",  "name": "string",  "cost": 0,  "currency": "string",  "availability": 0,  "issued": 0,  "expiry_after": "string",  "status": "active",  "version": 0,  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}

Edit or archive a reward (availability cannot drop below issued)

PATCH
/rewards/{id}

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Path Parameters

id*string
Length1 <= length

Header Parameters

X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length
X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length
If-Match?string

Optional legacy revision. Missing or malformed values follow the existing route parser.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/rewards/string" \  -H "Content-Type: application/json" \  -d '{    "name": "Updated"  }'
{  "id": "string",  "name": "string",  "cost": 0,  "currency": "string",  "availability": 0,  "issued": 0,  "expiry_after": "string",  "status": "active",  "version": 0,  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}

Delete a never-issued, unreferenced reward

DELETE
/rewards/{id}

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Path Parameters

id*string
Length1 <= length

Header Parameters

X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length
X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/rewards/string"
Empty

List issuances

GET
/reward_issuances

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Query Parameters

limit?integer
Range1 <= value <= 200
Default50
cursor?string
Lengthlength <= 2048
customer_id?string
reward_id?string
status?string

Value in

  • "issued"
  • "redeemed"
  • "cancelled"
  • "expired"

Header Parameters

X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length
X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/reward_issuances"
{  "data": [    {      "id": "string",      "reward_id": "string",      "customer_id": "string",      "status": "issued",      "source_type": "rule_execution",      "source_id": "string",      "cost": 0,      "currency": "string",      "cost_entry_id": "string",      "expires_at": "2019-08-24T14:15:22Z",      "redeemed_at": "2019-08-24T14:15:22Z",      "cancelled_at": "2019-08-24T14:15:22Z",      "version": 0,      "created_at": "2019-08-24T14:15:22Z"    }  ],  "next_cursor": "string",  "has_more": true}

Issue a reward to a customer manually (counts against availability)

POST
/reward_issuances

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Header Parameters

Idempotency-Key*string

Required. Official clients generate a UUID when omitted by the caller.

Length1 <= length <= 255
X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length
X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/reward_issuances" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "reward_id": "rw_0123456789abcdef0123456789abcdef",    "customer_id": "cust_0123456789abcdef0123456789abcdef"  }'
{  "id": "string",  "reward_id": "string",  "customer_id": "string",  "status": "issued",  "source_type": "rule_execution",  "source_id": "string",  "cost": 0,  "currency": "string",  "cost_entry_id": "string",  "expires_at": "2019-08-24T14:15:22Z",  "redeemed_at": "2019-08-24T14:15:22Z",  "cancelled_at": "2019-08-24T14:15:22Z",  "version": 0,  "created_at": "2019-08-24T14:15:22Z"}

One issuance

GET
/reward_issuances/{id}

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Path Parameters

id*string
Length1 <= length

Header Parameters

X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length
X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/reward_issuances/string"
{  "id": "string",  "reward_id": "string",  "customer_id": "string",  "status": "issued",  "source_type": "rule_execution",  "source_id": "string",  "cost": 0,  "currency": "string",  "cost_entry_id": "string",  "expires_at": "2019-08-24T14:15:22Z",  "redeemed_at": "2019-08-24T14:15:22Z",  "cancelled_at": "2019-08-24T14:15:22Z",  "version": 0,  "created_at": "2019-08-24T14:15:22Z"}

Redeem: issued → redeemed, spending the reward cost in the same transaction

POST
/reward_issuances/{id}/redeem

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Path Parameters

id*string
Length1 <= length

Header Parameters

Idempotency-Key?string

Optional. When sent, the stored response is replayed for 24 h.

Length1 <= length <= 255
X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length
X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length
If-Match?string

Optional legacy revision. Missing or malformed values follow the existing route parser.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/reward_issuances/string/redeem"
{  "id": "string",  "reward_id": "string",  "customer_id": "string",  "status": "issued",  "source_type": "rule_execution",  "source_id": "string",  "cost": 0,  "currency": "string",  "cost_entry_id": "string",  "expires_at": "2019-08-24T14:15:22Z",  "redeemed_at": "2019-08-24T14:15:22Z",  "cancelled_at": "2019-08-24T14:15:22Z",  "version": 0,  "created_at": "2019-08-24T14:15:22Z"}

Cancel: refunds a spent cost by reversal and releases availability

POST
/reward_issuances/{id}/cancel

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Path Parameters

id*string
Length1 <= length

Header Parameters

Idempotency-Key?string

Optional. When sent, the stored response is replayed for 24 h.

Length1 <= length <= 255
X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length
X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length
If-Match?string

Optional legacy revision. Missing or malformed values follow the existing route parser.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/reward_issuances/string/cancel" \  -H "Content-Type: application/json" \  -d '{    "reason": "Cancelled by operator"  }'
{  "id": "string",  "reward_id": "string",  "customer_id": "string",  "status": "issued",  "source_type": "rule_execution",  "source_id": "string",  "cost": 0,  "currency": "string",  "cost_entry_id": "string",  "expires_at": "2019-08-24T14:15:22Z",  "redeemed_at": "2019-08-24T14:15:22Z",  "cancelled_at": "2019-08-24T14:15:22Z",  "version": 0,  "created_at": "2019-08-24T14:15:22Z"}

Reward commerce

Reward catalogues, quotes, inventory and fulfillment.

Rules

Rules, immutable versions, publish, pause, simulate.