ReDoc documentation

giftcardaccounts

giftcardaccounts

Create a new gift card account with duplicate code detection.

Request
Request Body schema:
required
object (gift-card-account-api-data-gift-card-account-data-interface)

Data interface for individual gift card account entities.

Responses
200

200 Success.

401

401 Unauthorized

500

Internal Server error

default

Unexpected error

post/V1/giftcardaccounts
Request samples
{
  • "giftcardAccount": {
    }
}
Response samples
{
  • "account_id": 0,
  • "code": "string",
  • "status": 0,
  • "date_created": "string",
  • "date_expires": "string",
  • "balance": 0,
  • "state": 0,
  • "is_redeemable": 0
}

giftcardaccounts

Retrieve gift card accounts matching search criteria.

Request
query Parameters
searchCriteria[filterGroups][0][filters][0][field]
string

Field

searchCriteria[filterGroups][0][filters][0][value]
string

Value

searchCriteria[filterGroups][0][filters][0][conditionType]
string

Condition type

searchCriteria[sortOrders][0][field]
string

Sorting field.

searchCriteria[sortOrders][0][direction]
string

Sorting direction.

searchCriteria[pageSize]
integer

Page size.

searchCriteria[currentPage]
integer

Current page.

Responses
200

200 Success.

401

401 Unauthorized

default

Unexpected error

get/V1/giftcardaccounts
Response samples
{
  • "items": [
    ],
  • "search_criteria": {
    },
  • "total_count": 0
}
➔ Next to giftcardaccounts/code/{code}