Xoxoday
  • πŸ““User Resources
    • πŸ‘¨β€πŸ’ΌFor Admins
      • πŸ“ŒGetting Started
        • βš™οΈSettings
          • Manage Super Admin/Admins
            • Hierarchy vs Non-Hierarchy
            • Threshold
            • Delete an Admin
            • Redemption APIs
              • Generic Redemption APIs
              • Oauth 2.0 Implementation for Stores Redemption
          • Platform Preferences
          • Account Verification
        • Types of Companies
      • πŸš€Plum Launch Communication Kit
        • πŸŒ‰Pre-Launch Templates
        • 🀝Introduction to Plum Templates
        • πŸ“ΊHow to Sign up on Plum’s reward storefront Template
        • πŸ“‘How to Bookmark Plum’s reward storefront for easy access Template
        • πŸŽ‰How to Redeem the Rewards on Plum’s Reward Storefront?
      • Xoxo Points
        • πŸ“ŒGetting Started
        • 🚚Distribution of Xoxo-points
        • πŸ“©Email/SMS Customization
        • FAQs
      • Xoxo Codes
        • πŸ“ŒGetting Started
        • 🚚Distribution of Xoxo-codes
        • πŸ“©Email, SMS, and Xoxo Code Campaign Customization
        • FAQs
      • Points vs Codes
      • Xoxo Links
        • πŸ“ŒGetting Started
        • 🚚Distribution of Xoxo-links
        • FAQs
      • Domain Authentication Guide
        • Troubleshooting Domain Authentication
      • πŸ’°Add Funds
        • Base Currency
      • Campaigns
        • Getting Started
        • Editing a campaign?
        • Delete/disabling a Xoxo Campaign?
      • 🏬Reports
      • πŸ’³Prepaid Card User Guide
        • Virtual Paypal International
          • πŸ“ŒGetting Started
          • πŸ“­How to Redeem?
        • Virtual Visa Card
          • πŸ“ŒGetting Started
          • πŸ’³How to Redeem?
      • πŸ”Security and Compliance
        • Cryptography & Encryption
        • Email Whitelisting
        • Governance, Risk, & Data Compliance
        • Application,Dev & Security
        • Cloud Security
        • HR Compliance
        • Identity & Access Management
        • Solution Development
        • Security Operations
        • Training and Awareness
        • Vulnerability and Threat Management
        • Security Operations & Technical Capabilities and Support
        • Data Management
        • Policies & Procedures
        • Tax Compliance
        • Privacy Compliance
        • Cloud Security Alliance
        • Others
        • Documents
          • Data Security
          • Information Security
          • Admin/Business
          • Others
          • Finance Compliance
    • πŸ§‘β€πŸ€β€πŸ§‘For End-Users
      • πŸ“ŒGetting Started
      • πŸ§‘β€πŸ’»Signing up/Logging in
      • πŸͺ™How to redeem?
      • πŸ’³Gift Vouchers
      • 🎁Gift Box Queries
      • 🚚Delivery Related Issues
      • πŸ›‘Cancelation/Refunds
    • πŸ”—Pre-Built Integrations
      • Qualtrics Integration Guide
        • Using Qualtrics Workflow Extension to Send Rewards
        • Public Survey Rewarding
        • Anonymous Survey Rewarding
      • HubSpot + Plum
        • 1-1 Reward Widget in HubSpot
        • Workflow Based Reward Automation
        • 1-Many Link for Xoxolink’s Reward Automation
        • Email based Reward Automation
      • Darwinbox + Plum
      • SurveyMonkey + Plum
        • Public Survey Automation
        • Anonymous Survey Automation
      • Zapier + Plum
      • ActiveCampaign + Plum
        • Creating Automation
      • Salesforce + Plum
        • Getting Started with Xoxoday Plum
        • Getting Started and Setting up Salesforce Integration
        • Sending 1-1 Reward
        • Steps to create a Flow and add a Trigger
        • Redemption Journey for your Recipients
      • Typeform + Plum by Xoxoday
      • Zoho People + Plum
      • SAP Successfactors + Plum
        • SAP Client Registration with Xoxoday for Stores Redemption
      • Decipher - Forsta Integration
      • Zoho CRM
        • Send 1-1 rewards
        • Automation : Workflow Rules
      • Connect Plum to thousands of apps using Zapier
      • Other Integrations
    • πŸ›£οΈProduct Roadmap
      • 2022
      • 2021
  • πŸ‘¨β€πŸ’»Developer Resources
    • Rewards API
      • Getting started
      • API Endpoints
        • Authentication
          • Client ID, Secret ID, and Token Creation
          • Token Management
        • Catalog
          • GetVouchers API
          • GetFilters API
        • Orders
          • PlaceOrder API
          • GetOrderDetails API
          • GetOrderHistory API
        • Account Balance
          • GetBalance API
        • Postman Collection URL
      • Concepts
        • Staging Environment
        • Catalog
        • Error Handling
          • Standard HTTP status code summary
          • Errors related to API
        • Exchange Rates
      • Guides
        • Funding the Account
        • Reporting and Analytics
      • Webhooks
        • Test Webhooks
        • How to implement webhooks?
        • How to secure your webhooks?
      • Forex
      • Best Practices
      • Frequently Asked Questions
    • StoreFront Integration
      • Getting started
      • API Endpoints
        • Authorization
        • Token Creation & Token Management
        • SSO Redirection
        • End Points
      • Concepts
        • Points
      • Guides
        • Funding Account
        • Reports and Analytics
    • Xoxo Link API
    • Roadmap for 2021
  • πŸ“…Release Notes
    • Release April 2023
    • Release March 2023
    • Release February 2023
    • Release December 2022
    • Release October 2022
    • Release September 2022
    • Release July 2022
    • Release May 2022
    • Release March 2022
    • Release February 2022
    • Release December 2021
    • Release November 2021
    • Release October 2021
    • Release September 2021
    • Release July 2021
    • Release May 2021
    • Release March 2021
    • Release December 2020
    • Release October 2020
    • Release September 2020
    • Release August 2020
    • Release June 2020
    • Release May 2020
    • Release April 2020
    • Release March 2020
Powered by GitBook
On this page

Was this helpful?

  1. Developer Resources
  2. Rewards API
  3. API Endpoints
  4. Orders

PlaceOrder API

Use the PlaceOrder API to place the order for a voucher via the Rewards API

PreviousOrdersNextGetOrderDetails API

Last updated 2 years ago

Was this helpful?

Base URL :

Staging :

Production :

curl -X POST {OAUTH_URL}/v1/oauth/api 
-H 'Authorization: Bearer eyJ0b2tlbkNvbnRlbnQiOnsiaXNzdWVkRm9yIjoiRnJlc2h3b3JrcyIsInNjb3BlIjoiIiwiaXNzdWVkQXQiOjE1NTk4MDQ1Nzg1ODIsImV4cGlyZXNBdCI6IjIwMTktMDYtMjFUMDc6MDI6NTguNTgyWiIsInRva2VuX3R5cGUiOiJVU0VSIn0sImFfdCI6ImV5SmxibU1pT2lKQk1USTRRMEpsETFVoVE1qVTJJaXdpWVd4bklqb2lSVU5FU0MxRlV5SXNJbXRwWkNJNkltVnVZeUlzSW1Wd2F5STZleUpyZEhraU9pSkZReUlzSW1OeWRpSTZJbEF0TWpVMklpd2llQ0k2SWpoMmJVTkVRMUZQZW1wQlNHWndabXQ0TVhjNVluZHphM1JhZWtRek0ySXRZamx0VVhSclEyRnhNV3NpTENKNUlqb2lZMGR0V2kxdWIySjBWbUptTVdGdVNraDBUMmxoWW5VMFZHUlVhRzVVYmpCYWRuWnJabGMwYzBWb2N5SjlmUS4uU1h3TlNUSWhFUXNlN0htaXpPUmFIQS5NRzBVUy1lek1IOEFsbWFLc2ZTY3Nwa2FlYzBIcW9FcUV1YXRoNHRSTTRpeVg2dFByX1ZjTnlsdnk5YjlGLTZHR01DbjY1TjYwYnpIUUJtRVZvZGRYVWlvQS1kTkpuaE9KdThHczRfeW9pM042VGFOdWhjRENCUGtwWk1CeTlDRjJBaEh4UGotQkd0SzdEamhNbjBBQXpTM1VhTE11eUdrTmNwSGxQSUxNcFlVM' 
--header 'Content-Type: application/json'
  -d '{
	"query": "plumProAPI.mutation.placeOrder",
	"tag": "plumProAPI",
	"variables": {
		"data":{
			"productId":15365,
	        	"quantity": 1,
	        	"denomination": 20, 
	        	"email":"",
	        	"contact":"+1-5234567890",
	        	"tag":"",
	        	"poNumber":"PO12662",
			"notifyReceiverEmail":0,
			"notifyAdminEmail":0
		}
	}
}

200 : Success

returns list of vouchers filtered by the applicable filters

{
    "data": {
        "placeOrder": {
             status: 1,
             data:{
               "orderId": 1,
               "vouchers":[{
                 "amount": "10",
                 "country": "ES",
                 "currency": "INR",
                 "orderId": 128618,
                 "pin": "key_c26323726135beaa4e",
                 "productId": 28543,
                 "type": "codePin",
                 "validity": "2020-10-02",
                 "voucherCode": "4162581029814703",
                 "currencyValue": 0.1,
               }],
               "amountCharged": 90,
               "currencyCode": "USD",
               "tag": "",
               "discountPercent": 10,
               "orderDiscount": 10,
               "orderTotal": 100,
               "orderStatus": "complete",
               "deliveryStatus": "pending"
             }
           }
    }
}

400 : Failure

Validation error in place order

{ 
   code: 400, 
   errorId: PLE10001,
   errorInfo: "Validation error in place order”,
   error: "Eg: Bad request"
}

401 : Failure

Clinets not allowed to place international orders

{ 
   code: 401, 
   errorId: PLE10019,
   errorInfo: "Clients are not allowed to place international orders”,
   error: "Eg: Unauthorized, Client is unauthorized for international orders"
}

403 : Failure

For procuring amazon vouchers , one needs to get amazon KYC done.

 { 
   code: 403, 
   errorId: PLE10015,
   errorInfo: "Amazon KYC is not approved",
   error: "Eg: Forbidden, Ordering Amazon voucher requires client KYC to be approved"
}

404 : Failure

Invalid denomination for the product

{ 
   code: 404, 
   errorId: PLE10018,
   errorInfo: "Invalid denomination for the product",
   error: "Eg: Not found, ProductId and Denomination Combination Not Found, Order Details Not Found"
}

422: Failure

Failed to process order

{ 
   code: 422, 
   errorId: PLE10012,
   errorInfo: "Failed to process order",
   error: "Eg: Unprocessable Entity, Order Process Failed due to Unavailability of Vouchers"
}

409 : Failure

Client not allowed to place more than 10 orders

 {
    code: 409,
    "errorId": "PLE10041",
    "errorInfo": "Clients are not allowed to place more than 10 Qty",
    "error": "Order Failed, as per your current setup you are not allowed to add more than 10 qty. Plz contact cs@xoxoday.com to get more clarity"
}

502 : Failure

Failed to fetch currency details of the client.

{ 
   code: 502, 
   errorId: PLE10020,
   errorInfo: "Failed to get currency details for the client",
   error: "Eg: Bad Gateway, Currency API did not return data"
}

500: Failure

Internal server error

{ 
   code: 500, 
   error: "Eg: Internal server error"
}

Parameters

Body Parameters

Property

Type

Description

productId*

Integer

ProductId of the product to be ordered

quantity*

Integer

Quantity of the product to be ordered

denomination

Integer

Denomination of the product to be ordered

email

String

Email on which the product should be delivered

contact

String

Mobile number the product should be delivered to in the format specified, Optional for products except Paytm

tag

String

A comment or reference data parameter

poNumber

String

Client-side orderId or reference id

notifyAdminEmail*

Integer

Send 1 if order reference need to be emailed to Admin user

notifyReceiverEmail*

Integer

Send 1 if the product should be delivered via email to the receiver

"*" means the parameter is mandatory

Body Parameters

Property

Type

Description

status

Integer

0 (Failure) / 1 (Successful)

orderId

Integer

Order id of the order

tag

String

Order’s tag

amountCharged

Integer

Amount charged for the order in Client’s base currency

Currency Code

String

Base currency code of the client

currencyValue

Float

Currency Value will be showing the exchange rate between the base currency of the account and product currency

discountPercent

Float

Percentage of discount if any

orderDiscount

Float

Discount amount based on discount Percent

orderTotal

Float

Order total of the order excluding the discount

deliveryStatus

String

Product delivery status of the order

vouchers

Array

Array of vouchers ordered

vouchers.productid

Integer

Product Id of the product,

vouchers.voucherCode

String

Voucher Code or url based on the type parameter

vouchers.pin

String

Pin for the voucher if applicable

vouchers.validity

String

The validity of the voucher

vouchers.amount

String

Denomination of the voucher ordered

vouchers.currency

String

The currency of the ordered product

vouchers.currencyValue

Float

Value compared to INR

vouchers.orderStatus

String

Order place status of the order

vouchers.country

String

Countries that the product can be redeemed in

vouchers.type

String

Type of vouchers,For eg: pin, codePin, url

vouchers.xyz= vouchers property objects

Note: We do not currently support Notification by SMS functionality

πŸ‘¨β€πŸ’»
https://stagingaccount.xoxoday.com/chef
https://accounts.xoxoday.com/chef