WUPEX GIFTCARDS

Api Development & Integration Guide

Developers who integrate their systems with Wupex APIs are advised to read this guideline. This document provides information about the codes used in the Product and Order APIs.

"You can locate your API keys at this location."

{{link}}: https://service.wupex.com

{{x-api-key}}: https://portal.wupex.com/settings

1.PRODUCT

1.1 post

(place order)

2.ORDER

2.1 post

(pull codes)

2.2 post

(orderlist)

2.3 get

(order-detail)

3.CUSTOMER

3.1 GET balance

Download

4.1 Download PDF

1.PRODUCT

This page helps you to find products.

1.1 POST merchant-invited-list

"This page is designed to assist you in creating and placing an order."

> API Endpoint : {{link}}/api/product/merchant/invited/list

> Headers:

Accept-Language: en-US

x-api-key: {{x-api-key}}

> Body raw (json)

{

"page": 1, //min: 1

"pageSize": 20 //max: 100

}

Parameter

Description

Type

Required

page

int

pageSize

The number of items to be displayed

on a page (max:100)

int

> Response

Parameter

Description

page info

data

status

Information related to pagination

product information

True for success, false for faliure

Parameter

Description

Type

productName

URL of the product image

string

imageUrl

Name of the product

string

productCode

Unique code of the product

string

price

Price of the product

double

limit

Limit associated with the product (if applicable)

int

redeemed

Number of times the product has been redeemed (if applicable)

int

available

Number of units available for purchase (if applicable)

int

enabled

Indicates if the product is available for purchase

bool

productType

Category of the product (e.g., "Apple iTunes", "Google Play")

string

balance

How many of the product are available (if applicable)

double

discountRate

Discount rate applied to the product (if applicable)

double

previouslyPurchased

Indicates if the user has previously purchased the product

bool

favorite

Indicates if the product is favorited by the user

bool

{
  "pageInfo": {
    "totalPage": 1,
    "totalCount": 5,
    "pageSize": 5,
    "currentPage": 1
  },
  "data": [
    {
      "imageUrl": "",
      "productName": "Apple Gift Card $2 (USA)",
      "productCode": "APPLE-USA-2USD",
      "price": 2.000000,
      "limit": 0,
      "redeemed": 0,
      "available": 0,
      "enabled": true,
      "productType": "Apple iTunes",
      "balance": -50.00000000,
      "discountRate": 0.00000000000000,
      "previouslyPurchased": false,
      "favorite": false
    },
    {
      "imageUrl": "",
      "productName": "Google Play $10 (USA)",
      "productCode": "GOOGLE-USA-10USD",
      "price": 10.000000,
      "limit": 0,
      "redeemed": 0,
      "available": 0,
      "enabled": true,
      "productType": "Google Play",
      "balance": 0.00000000,
      "discountRate": 0.00000000000000,
      "previouslyPurchased": false,
      "favorite": false
    }
  ],
  "status": true
}

Copy Code

Copied

2.ORDER

You can view the details of your order on this page.

2.1 POST pull-codes

> API Endpoint : {{link}}/api/order/pull-codes

> Headers:

Accept-Language: en-US

x-api-key: {{x-api-key}}

> Query Parameter: (optional)

{{link}}/api/order/pull-codes?referenceId=yourReferenceId

ReferenceId : Your reference id.

Parameter

Description

Type

Required

merchant

Unique code of the merchant

string

Yes

sku

Unique code of the product

string

Yes

quantity

Product quantity

int

Yes

> Body raw (json)

[
  {
    "merchant": "MerchantCode",
    "sku": "productCode0",
    "quantity": 1
  },
  {
    "merchant": "MerchantCode",
    "sku": "productCode1",
    "quantity": 2
  },
  {
    "merchant": "MerchantCode",
    "sku": "productCode2",
    "quantity": 3
  }
]

Copy Code

Copied

> Response

Parameter

Description

Type

data

An object containing order details

object

orderName

Unique name or identifier for the order

string

totalAmount

Total amount of the order

double

status

Indicates the success status of the API call

bool

{
  "data": {
    "orderName": "A00000000000021",
    "totalAmount": 20.00000000
  },
  "status": true
}

Copy Code

Copied

2.2 POST order-list

> API Endpoint : {{link}}/api/order/list

> Headers:

Accept-Language: en-US

x-api-key: {{x-api-key}}

Parameter

Description

Type

Required

page

Unique code of the merchant

string

Yes

pageSize

Unique code of the product

string

Yes

orderColumn

Product quantity

int

Yes

order

Unique code of the product

string

Yes

Product quantity

int

Yes

column

Unique code of the product

string

Yes

order

Product quantity

int

Yes

operator

Unique code of the product

string

Yes

value

Product quantity

int

Yes

> Body raw (json)

EXP 1:

{
  "page": 1, // min: 1
  "pageSize": 20, // max: 100
  "orderColumn": "OrderName",
  "order": "DESC", // or ASC
  "search": [
    {
      "column": "OrderName",
      "operator": "Equals",
      "value": "A00000000000003"
    }
  ]
}

Copy Code

Copied

EXP 2:

{
  "page": 1, //min: 1
  "pageSize": 20, //max: 100
  "orderColumn": "OrderName",
  "order": "DESC", //or ASC
  "search": [
    {
      "column": Referenceid ",
      "operator": "Equals",
      "value": "yourReferenceID"
    }
  ]
}

Copy Code

Copied

> Response

Parameter

Description

page info

data

status

Information related to pagination

Order information

True for success, false for faliure

Parameter

Description

Type

pageInfo

An object containing pagination information

object

totalPage

Total number of pages available in the result set

int

totalCount

Total number of items across all pages

int

pageSize

The number of items to be displayed on a page (max:100)

int

currentPage

Current page number of the results

int

data

An array containing order data

array

Unique identifier for the order

int

orderName

Name or identifier for the order

string

orderDate

Date the order was created

string (format may vary depending on API)

orderAmount

Total amount of the order

double

status

Indicates the success status of the API call

bool

{
  "pageInfo": {
    "totalPage": 1,
    "totalCount": 1,
    "pageSize": 1,
    "currentPage": 1
  },
  "data": [
    {
      "id": 19,
      "orderName": "A00000000000002",
      "orderDate": "2023-12-28T00:00:00",
      "orderAmount": 100.00000000
    }
  ],
  "status": true
}

Copy Code

Copied

2.3 GET order-detail

"This page is designed to assist you in finding information about your orders."

> API Endpoint : {{link}}/api/order/detail?orderName=A00000000000003

> Headers:

Accept-Language: en-US

x-api-key: {{x-api-key}}

> Response

Parameter

Description

data

orderData

serials

status

Product Information

Order information

Serials Information

True for success, false for faliure

Parameter

Description

Type

data.id

Unique identifier for the order

int

data.orderName

Name or identifier for the order

string

data.orderDate

Date the order was created

DateTime

data.orderAmount

Total amount of the order

double

data.orderData.rowId

Unique identifier for the order item within the order

int

data.orderData.productCode

Code associated with the product

string

data.orderData.productName

Name of the product

string

data.orderData.serials.serialNumber

Serial number of the product (may be empty if not applicable)

string

data.orderData.serials.serialCode

Serial code of the product (may be empty if not applicable)

string

data.orderData.serials.productId

Unique identifier for the product

int

data.orderData.serials.productName

Name of the product

string

data.orderData.serials.productName

Name of the product (same as in order item details)

string

{
  "data": {
    "id": 19,
    "orderName": "A00000000000002",
    "orderDate": "2023-12-28T00:00:00",
    "orderAmount": 100.00000000,
    "orderData": [
      {
        "rowId": 23,
        "productCode": "testProduct001",
        "productName": "Test Product",
        "serials": [
          {
            "serialNumber": "",
            "serialCode": "",
            "productId": 23,
            "productName": "Test Product",
            "productSku": "testProduct001"
          },
          {
            "serialNumber": "",
            "serialCode": "",
            "productId": 23,
            "productName": "Test Product",
            "productSku": "testProduct001"
          }
        ]
      }
    ]
  },
  "status": true
}

Copy Code

Copied

3.CUSTOMER

"You can view the details of your customer on this page."

3.1 GET BALANCE

"This page is designed to assist you to find information abotut your account balances."

> API Endpoint : {{link}}/api/customer/balance

> Headers:

Accept-Language: en-US

x-api-key: {{x-api-key}}

> Response

Parameter

Description

Type

data

An object containing order details

object

* balance

Current total balance of the account

double

* credit

Available credit limit on the account (if applicable)

double

* creditBalance

Combination of balance and credit limit (if applicable)

double

status

Indicates the success status of the API call

bool

{
  "data": {
    "balance": 9952.50000000,
    "credit": 0.000000,
    "creditBalance": 9952.50000000
  },
  "status": true
}

Copy Code

Copied

4.DOWNLOAD

"Download API Documentation in PDF."

> Click to download

+399

Wholesaler Serving

+99K

Daily Transaction

Countries Serving

6 Million

Satisfied Customers Monthly

Turning seamless integration into limitless opportunities

Company

Downloads

Partners

Support

Features

CONNECT WITH US

Turning seamless integration into limitless opportunities

Company

Downloads

Partners

Support

Features

CONNECT WITH US

Turning seamless integration into limitless opportunities

Company

Downloads

Company

Profile

API

Documentation

Partners

Support

Features

CONNECT WITH US