This article will help you understand the concepts to get you up and running with the Rewards API in a jiffy!

This section contains various sections that help you get a quick understanding of the various concepts of the Rewards API.

Staging Environment

The Xoxoday staging environment is a free and fully-featured environment for application development and testing. All of the Xoxoday Rewards API is supported in the staging environment.

Xoxoday Rewards API clients typically develop their applications against the staging environment and then switch to production when they are ready to go live.

πŸ“˜

Products & Denominations

The Xoxoday staging environment supports a limited number of products and denominations. Please refer here for the list of products available in staging.

Catalog

Xoxoday offers a vast collection of vouchers that can be ordered via the Rewards API.

Refreshing the catalog

We recommend syncing with our catalog twice per day – 7:35 AM GMT and 7:35 PM GMT to pull the latest information about the products available to you. This will ensure you always have the latest product images, terms & conditions, and available product denominations to order.

πŸ‘

Recommended Sync Frequency

We recommend syncing with our catalog twice per day – 7:35 AM GMT and 7:35 PM GMT to pull the latest information about the products available to you.

Digital Vouchers

All the vouchers available via the Xoxoday Rewards API are digital. These vouchers can be redeemed online as well in physical stores. Each voucher's terms and conditions specify where and how it can be redeemed.
Please note that there are no physical vouchers/gifts available via the Rewards API.

Order Fulfilment

There are 2 types of vouchers that can be ordered via the Rewards API:

Real-Time

These are the vouchers whose orders get fulfilled on a real-time basis. So, the moment the order is placed, the voucher is delivered instantly.

Non-real-time

These are the vouchers whose orders are not fulfilled on a real-time basis and may take 3-10 working days to be fulfilled. Please refer to the voucher's terms & conditions to find the exact timelines.

πŸ“˜

How to know voucher types?

Please refer to deliveryType filter in the GetVouchers API response to determine if a voucher is real-time or delayed.

πŸ“˜

How to check status of Non-real-time Vouchers?

To find the status of delayed orders, use the GetOrderDetails API.

Recommended Practices

πŸ‘

Recommended Practices

Below are some of our recommendations to ensure a smooth implentation and consumtion of Xoxoday APIs. Please feel free to reach out to [email protected] for any questions, suggestions, and feedback.

Catalog Refresh

Xoxoday recommends that you refresh your catalog once every 24 hours to fetch the latest information about the available gift cards.

Use of PO Number

Xoxoday recommends that you implement the PO number functionality to avoid duplicate orders being placed.

API Time Out

Xoxoday recommends that you should wait 30 seconds to get a response from the API. This is because of API lag in our vendor systems.

Error Code Handling

Xoxoday provides a wide variety of error codes in the API response. Please use them to fine-tune the error handling at your end.