Reward commerce | Orishare docs

Create a commerce catalogue_revision

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Path Parameters

id*string

Length1 <= length

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.

expected_revision*string

Match^(0|[1-9][0-9]{0,18})$

name*string

Length1 <= length <= 255

status*string

Value in

"active"
"disabled"

Response Body

`application/json`

curl -X POST "https://example.com/reward_catalogues/string/revisions" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "expected_revision": "0",    "name": "Rewards",    "status": "disabled"  }'

{  "id": "string",  "revision": "string"}

Create a commerce offer_revocation

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Path Parameters

id*string

Length1 <= length

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.

expected_version*integer

Range1 <= value <= 2147483647

Response Body

`application/json`

curl -X POST "https://example.com/reward_offer_versions/string/revocations" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "expected_version": 1  }'

{  "id": "string",  "version": 1,  "revoked": true}

List reward catalogues

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Query Parameters

cursor?string

Lengthlength <= 8192

limit?integer

Range1 <= value <= 100

Default50

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`

curl -X GET "https://example.com/reward_catalogues"

{  "data": [    {      "id": "string",      "revision": "string",      "key": "string",      "name": "string",      "status": "active"    }  ],  "next_cursor": "string",  "has_more": true}

Create a commerce catalogue

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.

key*string

Match^[a-z][a-z0-9_]{0,62}$

name*string

Length1 <= length <= 255

Response Body

`application/json`

curl -X POST "https://example.com/reward_catalogues" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "key": "rewards",    "name": "Rewards"  }'

{  "id": "string",  "revision": "string"}

Create a commerce offer

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Path Parameters

id*string

Length1 <= length

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.

key*string

Match^[a-z][a-z0-9_]{0,62}$

version*integer

Range1 <= value <= 2147483647

terms*

reward_id?string

Length1 <= length <= 255

inventory_id?string

Length1 <= length <= 255

code_pool_id?string

Length1 <= length <= 255

Response Body

`application/json`

curl -X POST "https://example.com/reward_catalogues/string/offer_versions" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "key": "book",    "version": 1,    "terms": {      "display": {        "title": "Book"      },      "currency_id": "cur_example",      "cost_minor": "100",      "quantity": 1,      "eligibility": {        "audience": [],        "minimum_assurance": "authenticated_customer"      },      "stock": {        "type": "unlimited"      },      "delivery": {        "type": "manual"      },      "quote_ttl_seconds": 300,      "entitlement_ttl_seconds": null,      "cancellation": "before_commitment"    }  }'

{  "id": "string",  "kind": "catalogue_offer",  "catalogue_id": "string",  "key": "string",  "version": 1,  "terms": {    "display": {      "title": "string",      "description": "string"    },    "currency_id": "string",    "cost_minor": "string",    "quantity": 1,    "eligibility": {      "audience": [        "string"      ],      "minimum_assurance": "anonymous",      "minimum_tier": {        "tier_program": "string",        "min_level": "string"      }    },    "reward": {      "key": "string",      "version": 1,      "digest": "string"    },    "season": {      "key": "string",      "version": 1,      "digest": "string"    },    "stock": {      "type": "unlimited"    },    "delivery": {      "type": "manual"    },    "quote_ttl_seconds": 1,    "entitlement_ttl_seconds": 1,    "cancellation": "before_commitment",    "discount": {      "type": "fixed",      "currency": "string",      "amount_minor": "string",      "maximum_minor": "string"    }  },  "digest": "string"}

List reward inventory

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Query Parameters

cursor?string

Lengthlength <= 8192

limit?integer

Range1 <= value <= 100

Default50

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`

curl -X GET "https://example.com/reward_inventory"

{  "data": [    {      "id": "string",      "available": "string",      "revision": "string",      "key": "string",      "reserved": "string",      "consumed": "string",      "damaged": "string"    }  ],  "next_cursor": "string",  "has_more": true}

Create a commerce inventory

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.

key*string

Match^[a-z][a-z0-9_]{0,62}$

quantity*integer

Range0 <= value <= 1000000

Response Body

`application/json`

curl -X POST "https://example.com/reward_inventory" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "key": "books",    "quantity": 10  }'

{  "id": "string",  "available": "string",  "revision": "string"}

Create a commerce supply

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Path Parameters

id*string

Length1 <= length

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.

expected_revision*string

Match^(0|[1-9][0-9]{0,18})$

quantity*integer

Range1 <= value <= 1000000

Response Body

`application/json`

curl -X POST "https://example.com/reward_inventory/string/movements" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "expected_revision": "0",    "quantity": 5  }'

{  "id": "string",  "available": "string",  "revision": "string"}

List reward code pools

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Query Parameters

cursor?string

Lengthlength <= 8192

limit?integer

Range1 <= value <= 100

Default50

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`

curl -X GET "https://example.com/reward_code_pools"

{  "data": [    {      "id": "string",      "key": "string",      "inventory_id": "string"    }  ],  "next_cursor": "string",  "has_more": true}

Create a commerce pool

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.

key*string

Match^[a-z][a-z0-9_]{0,62}$

Response Body

`application/json`

curl -X POST "https://example.com/reward_code_pools" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "key": "books"  }'

{  "id": "string"}

Create a commerce import

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Path Parameters

id*string

Length1 <= length

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.

codes*array<>

Items1 <= items <= 100

Response Body

`application/json`

curl -X POST "https://example.com/reward_code_pools/string/imports" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "codes": [      "EXAMPLE-CODE"    ]  }'

{  "pool_id": "string",  "imported": 0}

Create a commerce reconciliation

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Path Parameters

id*string

Length1 <= length

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.

expected_revision*string

Match^(0|[1-9][0-9]{0,18})$

outcome*string

Value in

"fulfilled"
"not_delivered"
"reversed"

reason*string

Value in

"provider_verified"
"manual_fulfillment"
"operator_verified"

proof_digest*string

Match^[a-f0-9]{64}$

Response Body

`application/json`

curl -X POST "https://example.com/fulfillments/string/reconciliations" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "expected_revision": "0",    "outcome": "fulfilled",    "reason": "manual_fulfillment",    "proof_digest": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"  }'

{  "id": "string",  "redemption_id": "string",  "status": "string",  "revision": "string"}

Read reward catalogues

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`

curl -X GET "https://example.com/reward_catalogues/string"

{  "id": "string",  "revision": "string",  "key": "string",  "name": "string",  "status": "active"}

List reward offer versions

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Query Parameters

cursor?string

Lengthlength <= 8192

limit?integer

Range1 <= value <= 100

Default50

catalogue_id?string

Length1 <= length <= 255

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`

curl -X GET "https://example.com/reward_offer_versions"

{  "data": [    {      "id": "string",      "kind": "catalogue_offer",      "catalogue_id": "string",      "key": "string",      "version": 1,      "terms": {        "display": {          "title": "string",          "description": "string"        },        "currency_id": "string",        "cost_minor": "string",        "quantity": 1,        "eligibility": {          "audience": [            "string"          ],          "minimum_assurance": "anonymous",          "minimum_tier": {            "tier_program": "string",            "min_level": "string"          }        },        "reward": {          "key": "string",          "version": 1,          "digest": "string"        },        "season": {          "key": "string",          "version": 1,          "digest": "string"        },        "stock": {          "type": "unlimited"        },        "delivery": {          "type": "manual"        },        "quote_ttl_seconds": 1,        "entitlement_ttl_seconds": 1,        "cancellation": "before_commitment",        "discount": {          "type": "fixed",          "currency": "string",          "amount_minor": "string",          "maximum_minor": "string"        }      },      "digest": "string"    }  ],  "next_cursor": "string",  "has_more": true}

Read reward offer versions

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`

curl -X GET "https://example.com/reward_offer_versions/string"

{  "id": "string",  "kind": "catalogue_offer",  "catalogue_id": "string",  "key": "string",  "version": 1,  "terms": {    "display": {      "title": "string",      "description": "string"    },    "currency_id": "string",    "cost_minor": "string",    "quantity": 1,    "eligibility": {      "audience": [        "string"      ],      "minimum_assurance": "anonymous",      "minimum_tier": {        "tier_program": "string",        "min_level": "string"      }    },    "reward": {      "key": "string",      "version": 1,      "digest": "string"    },    "season": {      "key": "string",      "version": 1,      "digest": "string"    },    "stock": {      "type": "unlimited"    },    "delivery": {      "type": "manual"    },    "quote_ttl_seconds": 1,    "entitlement_ttl_seconds": 1,    "cancellation": "before_commitment",    "discount": {      "type": "fixed",      "currency": "string",      "amount_minor": "string",      "maximum_minor": "string"    }  },  "digest": "string"}

Read reward inventory

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`

curl -X GET "https://example.com/reward_inventory/string"

{  "id": "string",  "available": "string",  "revision": "string",  "key": "string",  "reserved": "string",  "consumed": "string",  "damaged": "string"}

Read reward code pools

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`

curl -X GET "https://example.com/reward_code_pools/string"

{  "id": "string",  "key": "string",  "inventory_id": "string"}

List fulfillments

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Query Parameters

cursor?string

Lengthlength <= 8192

limit?integer

Range1 <= value <= 100

Default50

customer_id?string

Length1 <= length <= 255

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`

curl -X GET "https://example.com/fulfillments"

{  "data": [    {      "id": "string",      "redemption_id": "string",      "status": "string",      "revision": "string",      "customer_id": "string"    }  ],  "next_cursor": "string",  "has_more": true}

Read fulfillments

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`

curl -X GET "https://example.com/fulfillments/string"

{  "id": "string",  "redemption_id": "string",  "status": "string",  "revision": "string",  "customer_id": "string"}

201application/json

400application/json

401application/json

403application/json

404application/json

409application/json

421application/json

422application/json

429application/json

500application/json

501application/json

201application/json

400application/json

401application/json

403application/json

404application/json

409application/json

421application/json

422application/json

429application/json

500application/json

501application/json

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

421application/json

422application/json

429application/json

500application/json

201application/json

400application/json

401application/json

403application/json

404application/json

409application/json

421application/json

422application/json

429application/json

500application/json

501application/json

201application/json

400application/json

401application/json

403application/json

404application/json

409application/json

421application/json

422application/json

429application/json

500application/json

501application/json

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

421application/json

422application/json

429application/json

500application/json

201application/json

400application/json

401application/json

403application/json

404application/json

409application/json

421application/json

422application/json

429application/json

500application/json

501application/json

201application/json

400application/json

401application/json

403application/json

404application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`