API docs by Redocly

point reward system integration api (0.1.0)

Download OpenAPI specification:Download

point reward system integration api

partner

list all stores

point reward system query for all stores in detail

Authorizations:
ApiKeyAuth
path Parameters
limit
any
Example: 6
cursor_id
any

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

get checkout detail

point reward system query for products using checkout id from from partner

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

partner's checkout id

Responses

Response samples

Content type
application/json
{
  • "message": "",
  • "code": "",
  • "data": {
    }
}

get updated checkout price with offers

update checkout price with offers applied

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

partner's checkout id

Request Body schema: application/json
required
object (Transaction)

Responses

Request samples

Content type
application/json
{
  • "transaction": {
    }
}

Response samples

Content type
application/json
{
  • "message": "",
  • "code": "",
  • "data": {
    }
}

point-reward-system

send integration event to point reward system

endpoint to receive integration event from merchant

Authorizations:
ApiKeyAuth
path Parameters
merchant_id
required
integer

merchant's id

Request Body schema: application/json
required
event
string
Enum: "PaymentCompleted" "ProductOnSale" "ProductOffSale" "ProductInfoUpdated"
created_at
date-time
data
object

Responses

Request samples

Content type
application/json
Example
{
  • "event": "PaymentCompleted",
  • "created_at": "2017-07-21T17:32:28Z",
  • "data": {
    }
}

get transaction detail by id

get transaction detail by its id

Authorizations:
ApiKeyAuth
path Parameters
merchant_id
required
integer

merchant's id

id
required
string <uuid>

point reward system's transaction id

Responses

Response samples

Content type
application/json
{
  • "message": "",
  • "code": "prs@0",
  • "data": {
    }
}