API docs by Redocly

Gift Cards API (1.0.0)

Download OpenAPI specification:

Gift Cards management

users

Finds all users

Authorizations:
X-Api-Token
query Parameters
page
number
Example: page=1
perPage
number
Example: perPage=25

Responses

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": [
    ],
  • "meta": {
    }
}

Creates a User

Authorizations:
X-Api-Token
Request Body schema: application/json
required
email
required
string

Responses

Request samples

Content type
application/json
{
  • "email": "test@test.com"
}

Response samples

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

Finds a User

Authorizations:
X-Api-Token

Responses

Response samples

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

Updates a User

Authorizations:
X-Api-Token
Request Body schema: application/json
required
email
required
string

Responses

Request samples

Content type
application/json
{
  • "email": "test@test.com"
}

Response samples

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

Finds a User by Email

Authorizations:
X-Api-Token
Request Body schema: application/json
required
email
required
string

Responses

Request samples

Content type
application/json
{
  • "email": "test@test.com"
}

Response samples

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

companies

Finds all Companies

Authorizations:
X-Api-Token

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Creates a Company

Authorizations:
X-Api-Token
Request Body schema: application/json
required
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "Test Company"
}

Response samples

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

Finds a Company

Authorizations:
X-Api-Token

Responses

Response samples

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

Updates a Company

Authorizations:
X-Api-Token
Request Body schema: application/json
required
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "Test Company"
}

Response samples

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

products

Finds all Products

Authorizations:
X-Api-Token
query Parameters
page
number
Example: page=1
perPage
number
Example: perPage=25

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Creates a Product

Authorizations:
X-Api-Token
Request Body schema: application/json
required
companyId
required
string
triggeredEmailId
required
string
sku
required
string
availabilityThreshold
number
communicationChannel
string

Responses

Request samples

Content type
application/json
{
  • "companyId": "8a9d607a-5c8d-4c13-b23f-e4bb5ed504e8",
  • "triggeredEmailId": "a5179552-21a3-4fdb-ac3b-35a218af504d",
  • "sku": "Test Sku",
  • "availabilityThreshold": 20,
  • "communicationChannel": "#it_test_com_100_credit_log"
}

Response samples

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

Finds a Product

Authorizations:
X-Api-Token

Responses

Response samples

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

Updates a Product

Authorizations:
X-Api-Token
Request Body schema: application/json
required
companyId
required
string
triggeredEmailId
required
string
sku
required
string
availabilityThreshold
number
communicationChannel
string

Responses

Request samples

Content type
application/json
{
  • "companyId": "8a9d607a-5c8d-4c13-b23f-e4bb5ed504e8",
  • "triggeredEmailId": "a5179552-21a3-4fdb-ac3b-35a218af504d",
  • "sku": "Test Sku",
  • "availabilityThreshold": 20,
  • "communicationChannel": "#it_test_com_100_credit_log"
}

Response samples

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

Finds a Promo by Product Id

Authorizations:
X-Api-Token
query Parameters
filter[notIssued]
any

Filter to get all issuedAt values that are null

page
number
Example: page=1
perPage
number
Example: perPage=25

Responses

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": [
    ],
  • "meta": {
    }
}

promos

Finds all Promos

Authorizations:
X-Api-Token
query Parameters
page
number
Example: page=1
perPage
number
Example: perPage=25

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Creates a Promo

Authorizations:
X-Api-Token
Request Body schema: application/json
required
userId
string
productId
required
string
salesOrderId
string
code
required
string
issuedAt
string

Responses

Request samples

Content type
application/json
{
  • "userId": "fe0d9fc0-9975-332e-b638-853a323b6c6f",
  • "productId": "f8e837a3-f8ff-44a2-93b5-90b4710a606c",
  • "salesOrderId": "93f74cce-83b7-4fd0-983d-a6231eb9dbcc",
  • "code": "USCCA-2B22BBB2",
  • "issuedAt": "2022-12-22 12:22:22"
}

Response samples

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

Finds a promo

Authorizations:
X-Api-Token

Responses

Response samples

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

Updates a Promo

Authorizations:
X-Api-Token
Request Body schema: application/json
required
userId
string
productId
required
string
salesOrderId
string
code
required
string
issuedAt
string

Responses

Request samples

Content type
application/json
{
  • "userId": "fe0d9fc0-9975-332e-b638-853a323b6c6f",
  • "productId": "f8e837a3-f8ff-44a2-93b5-90b4710a606c",
  • "salesOrderId": "93f74cce-83b7-4fd0-983d-a6231eb9dbcc",
  • "code": "USCCA-2B22BBB2",
  • "issuedAt": "2022-12-22 12:22:22"
}

Response samples

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

Deletes a promo

Authorizations:
X-Api-Token

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Finds a Promo by Sales Order Id

Authorizations:
X-Api-Token
query Parameters
page
number
Example: page=1
perPage
number
Example: perPage=25

Responses

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": [
    ],
  • "meta": {
    }
}