View All Methods in this API

createCommerceCoupon

Version 1 This method is used to create a new commerce coupon.

https://api.peoplevine.com/commerce.asmx/createCommerceCoupon

For non required fields, you can either omit from the JSON string or set it to a default value
(e.g. String = "", Integer/Double = 0, Boolean = false, DateTime = 1900-01-01T00:00:00.000Z)

INPUT

Name Type Description Required
{"auth": {"api_username": "", "api_password": "", "api_key": "", "company_no": 0, "username": "", "password": "", "timezone_offset": 0, "auth_type": "", "system_name": "", "system_company_no": 0 }, "item": {"item_type": "", "times_used": 0, "commerce_coupon_no": 0, "item_no": 0, "company_no": 0, "item_title": "", "valid_on": "1/1/1900 12:00 AM", "valid_to": "1/1/1900 12:00 AM", "coupon_code": "", "coupon_title": "", "coupon_description": "", "coupon_type": "", "coupon_value": 0, "customer_type": "", "created_on": "1/1/1900 12:00 AM", "user_no": 0, "apply_type": "", "requires_code": false, "customer_no": 0, "coupon_status": "", "max_redemptions": 0, "minimum_type": "", "minimum_value": 0 } }
{"auth": {"api_username": "", "api_password": "", "api_key": "", "company_no": 0, "username": "", "password": "" }, "item": {"item_type": "", "times_used": 0, "commerce_coupon_no": 0, "item_no": 0, "company_no": 0, "item_title": "", "valid_on": "1/1/1900 12:00 AM", "valid_to": "1/1/1900 12:00 AM", "coupon_code": "", "coupon_title": "", "coupon_description": "", "coupon_type": "", "coupon_value": 0, "customer_type": "", "created_on": "1/1/1900 12:00 AM", "user_no": 0, "apply_type": "", "requires_code": false, "customer_no": 0, "coupon_status": "", "max_redemptions": 0, "minimum_type": "", "minimum_value": 0 } }

OUTPUT

By default, every API call returns an object of returnMessage as either XML or JSON depending on your content-type of the request.  With in the returnMessage structure the returnObject is specified above and differs based on the API meth.

Name Type Description
responseCode String This identifies the error that occurred for additional handling. Response codes starting with "A" are a success or "E" are an error.
message String Additional minor details on the response to display to your customers.
isError Boolean True if an error. False if succesful.
methodFailed String If there's an error, this is the method it failed at for debugging purposes.
extendedMessage String Additional instructions on how you can fix the error or what you can do with the return object.
reason String Explains why this error occurred or what was completed.
reponseTime Double How long it took to respond in seconds.
returnObject wi_commerce_coupon
item_type string
times_used double
commerce_coupon_no double
item_no double
company_no double
item_title string
valid_on dateTime
valid_to dateTime
coupon_code string
coupon_title string
coupon_description string
coupon_type string
coupon_value double
customer_type string
created_on dateTime
user_no double
apply_type string
requires_code boolean
customer_no double
coupon_status string
max_redemptions double
minimum_type string
minimum_value double
{"responseCode": "", "message": "", "isError": false, "methodFailed": "", "extendedMessage": "", "reason": "", "responseTime": 0, "returnObject": {"item_type": "", "times_used": 0, "commerce_coupon_no": 0, "item_no": 0, "company_no": 0, "item_title": "", "valid_on": "1/1/1900 12:00 AM", "valid_to": "1/1/1900 12:00 AM", "coupon_code": "", "coupon_title": "", "coupon_description": "", "coupon_type": "", "coupon_value": 0, "customer_type": "", "created_on": "1/1/1900 12:00 AM", "user_no": 0, "apply_type": "", "requires_code": false, "customer_no": 0, "coupon_status": "", "max_redemptions": 0, "minimum_type": "", "minimum_value": 0 } }

Sample Code

This sample code is to generate a function leveraging existing core functions you've already built.

                
func getAPIKit() -> (url: String, dict: Dictionary<String, AnyObject>) {

    var item_type = ""
    var times_used = 0
    var commerce_coupon_no = 0
    var item_no = 0
    var company_no = 0
    var item_title = ""
    var valid_on = "1/1/1900 12:00 AM"
    var valid_to = "1/1/1900 12:00 AM"
    var coupon_code = ""
    var coupon_title = ""
    var coupon_description = ""
    var coupon_type = ""
    var coupon_value = 0
    var customer_type = ""
    var created_on = "1/1/1900 12:00 AM"
    var user_no = 0
    var apply_type = ""
    var requires_code = false
    var customer_no = 0
    var coupon_status = ""
    var max_redemptions = 0
    var minimum_type = ""
    var minimum_value = 0

    let url = "https://api.peoplevine.com/commerce.asmx/createCommerceCoupon"
    
    let key = "item"
    let itemDict: Dictionary<String, AnyObject> = ["item_type": item_type, "times_used": times_used, "commerce_coupon_no": commerce_coupon_no, "item_no": item_no, "company_no": company_no, "item_title": item_title, "valid_on": valid_on, "valid_to": valid_to, "coupon_code": coupon_code, "coupon_title": coupon_title, "coupon_description": coupon_description, "coupon_type": coupon_type, "coupon_value": coupon_value, "customer_type": customer_type, "created_on": created_on, "user_no": user_no, "apply_type": apply_type, "requires_code": requires_code, "customer_no": customer_no, "coupon_status": coupon_status, "max_redemptions": max_redemptions, "minimum_type": minimum_type, "minimum_value": minimum_value ]
    let finalDict = User.getAuthDict(dictToAdd: itemDict, dictKey: key)
    
    return (url, finalDict)
  }

                
            

To get started we reccomend that you download the Alamofire project to simplify integration: https://github.com/Alamofire/Alamofire, in addition to SwiftyJSON: https://github.com/SwiftyJSON/SwiftyJSON

                
import Foundation

struct AUTH {
    static var api_username = <string>
    static var api_password = <string>
    static var api_key = <string>
    static var company_no = <double>
    static var username = <string>
    static var password = <string>
    static var timezone_offset = <double>
    static var auth_type = <string>
    static var system_name = <string>
    static var system_company_no = <double>}
    
struct ITEM {
    static var item_type = <string>
    static var times_used = <double>
    static var commerce_coupon_no = <double>
    static var item_no = <double>
    static var company_no = <double>
    static var item_title = <string>
    static var valid_on = <dateTime>
    static var valid_to = <dateTime>
    static var coupon_code = <string>
    static var coupon_title = <string>
    static var coupon_description = <string>
    static var coupon_type = <string>
    static var coupon_value = <double>
    static var customer_type = <string>
    static var created_on = <dateTime>
    static var user_no = <double>
    static var apply_type = <string>
    static var requires_code = <boolean>
    static var customer_no = <double>
    static var coupon_status = <string>
    static var max_redemptions = <double>
    static var minimum_type = <string>
    static var minimum_value = <double>}
    
func createCommerceCouponRequest() {
    
    var createCommerceCouponObjects = [AnyObject]()
    let postsEndpoint: String = "https://api.peoplevine.com/commerce.asmx/createCommerceCoupon"

    let authAndFieldsDict = ["auth": ["api_username": AUTH.api_username, "api_password": AUTH.api_password, "api_key": AUTH.api_key, "company_no": AUTH.company_no, "username": AUTH.username, "password": AUTH.password, "timezone_offset": AUTH.timezone_offset, "auth_type": AUTH.auth_type, "system_name": AUTH.system_name, "system_company_no": AUTH.system_company_no ], "item": ["item_type": ITEM.item_type, "times_used": ITEM.times_used, "commerce_coupon_no": ITEM.commerce_coupon_no, "item_no": ITEM.item_no, "company_no": ITEM.company_no, "item_title": ITEM.item_title, "valid_on": ITEM.valid_on, "valid_to": ITEM.valid_to, "coupon_code": ITEM.coupon_code, "coupon_title": ITEM.coupon_title, "coupon_description": ITEM.coupon_description, "coupon_type": ITEM.coupon_type, "coupon_value": ITEM.coupon_value, "customer_type": ITEM.customer_type, "created_on": ITEM.created_on, "user_no": ITEM.user_no, "apply_type": ITEM.apply_type, "requires_code": ITEM.requires_code, "customer_no": ITEM.customer_no, "coupon_status": ITEM.coupon_status, "max_redemptions": ITEM.max_redemptions, "minimum_type": ITEM.minimum_type, "minimum_value": ITEM.minimum_value ] ]

    Alamofire.request(.POST, postsEndpoint, parameters: authAndFieldsDict, encoding: .JSON).responseJSON { (request, response, data, error) in

      if let anError = error {

        println("error calling POST on /posts")
        println(error)

      } else if let jsonData: AnyObject = data {
        if let dataString = (jsonData.valueForKey("d") as! String).dataUsingEncoding(NSUTF8StringEncoding) {
            let json = JSON(data: dataString)  //use this object to parse data
            
            //SAMPLE PARSING
            let varData = json["returnObject"][0]["object"].stringValue

            // ----------
            // BELOW REPRESENTS AN EXAMPLE USING PURE SWIFT JSONSERIALIZATION INSTEAD OF SWIFTYJSON --------//

            //          if let createCommerceCouponDict = NSJSONSerialization.JSONObjectWithData(encoString, options: .MutableContainers, error: nil) as? NSDictionary {
            //            if let returnObjectArray = createCommerceCouponDict["returnObject"] as? NSArray {
            //
            //              for createCommerceCouponObject in returnObjectArray {
            //                createCommerceCouponObjects.append(createCommerceCouponObject)
            //                if let item = createCommerceCouponObject["object_name"] as? NSDictionary {
            //                  let varItem = item["field_name"] as! String
            //                }
            //              }
            //
            //              println("\n\(createCommerceCouponObjects.count) Total")
            //            }
            //          }
        }
      }
    }
  }



            
<!DOCTYPE html>
<html>
<head>
<title>API Call - createCommerceCoupon</title>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>
<script type="text/javascript">
   $(function() {
      var dataValue = {
         
            "auth": {
                "api_username": "", 
                "api_password": "", 
                "api_key": "", 
                "company_no": 0, 
                "username": "", 
                "password": "", 
                "timezone_offset": 0, 
                "auth_type": "", 
                "system_name": "", 
                "system_company_no": 0, 
                },
            
            "item": {
                "item_type": "", 
                "times_used": 0, 
                "commerce_coupon_no": 0, 
                "item_no": 0, 
                "company_no": 0, 
                "item_title": "", 
                "valid_on": "1/1/1900 12:00 AM", 
                "valid_to": "1/1/1900 12:00 AM", 
                "coupon_code": "", 
                "coupon_title": "", 
                "coupon_description": "", 
                "coupon_type": "", 
                "coupon_value": 0, 
                "customer_type": "", 
                "created_on": "1/1/1900 12:00 AM", 
                "user_no": 0, 
                "apply_type": "", 
                "requires_code": false, 
                "customer_no": 0, 
                "coupon_status": "", 
                "max_redemptions": 0, 
                "minimum_type": "", 
                "minimum_value": 0, 
                },
            
      };
      
      $.ajax({
         url: 'https://api.peoplevine.com/commerce.asmx/createCommerceCoupon',
         type: 'POST',
         data: JSON.stringify(dataValue),
         contentType: 'application/json; charset=utf-8',
         dataType: 'json',
         error: function (XMLHttpRequest, textStatus, errorThrown) {
                alert("ERROR");
         },
         success: function (result) {
                var obj = JSON.parse(result.d).returnObject;

                $.each(obj, function(i) {
                    $("#divID").html(obj[i].field_name); //do something with the data
                })
         }
      })
   });
</script>
</body>
</html>
            
    
System.Net.HttpWebRequest req = System.Net.HttpWebRequest.Create("https://api.peoplevine.com/commerce.asmx/createCommerceCoupon");
req.Method = "POST";
req.ContentType = "application/json; charset=utf-8";

string dataValue = "{auth: {api_username: <string>, api_password: <string>, api_key: <string>, company_no: <double>, username: <string>, password: <string>, timezone_offset: <double>, auth_type: <string>, system_name: <string>, system_company_no: <double> },item: {item_type: <string>, times_used: <double>, commerce_coupon_no: <double>, item_no: <double>, company_no: <double>, item_title: <string>, valid_on: <dateTime>, valid_to: <dateTime>, coupon_code: <string>, coupon_title: <string>, coupon_description: <string>, coupon_type: <string>, coupon_value: <double>, customer_type: <string>, created_on: <dateTime>, user_no: <double>, apply_type: <string>, requires_code: <boolean>, customer_no: <double>, coupon_status: <string>, max_redemptions: <double>, minimum_type: <string>, minimum_value: <double> }}";

ASCIIEncoding encoding = new ASCIIEncoding();
byte[] bytes = encoding.GetBytes(dataValue);

req.ContentLength = bytes.Length;

System.IO.Stream strm = req.GetRequestStream();
strm.Write(bytes, 0, bytes.Length);
strm.Close();

System.Net.HttpWebResponse rsp = req.GetResponse();
System.IO.Stream data = rsp.GetResponseStream();
System.IO.StreamReader rdr = new System.IO.StreamReader(data);

string response = rdr.ReadToEnd();

Dim req As System.Net.HttpWebRequest = System.Net.HttpWebRequest.Create("https://api.peoplevine.com/commerce.asmx/createCommerceCoupon")
req.Method = "POST"
req.ContentType = "application/json; charset=utf-8"
        
Dim dataValue As String = "{auth: {api_username: <string>, api_password: <string>, api_key: <string>, company_no: <double>, username: <string>, password: <string>, timezone_offset: <double>, auth_type: <string>, system_name: <string>, system_company_no: <double> },item: {item_type: <string>, times_used: <double>, commerce_coupon_no: <double>, item_no: <double>, company_no: <double>, item_title: <string>, valid_on: <dateTime>, valid_to: <dateTime>, coupon_code: <string>, coupon_title: <string>, coupon_description: <string>, coupon_type: <string>, coupon_value: <double>, customer_type: <string>, created_on: <dateTime>, user_no: <double>, apply_type: <string>, requires_code: <boolean>, customer_no: <double>, coupon_status: <string>, max_redemptions: <double>, minimum_type: <string>, minimum_value: <double> }}"
        
Dim encoding As New ASCIIEncoding()
Dim bytes As Byte() = encoding.GetBytes(dataValue)
        
req.ContentLength = bytes.Length
        
Dim strm As System.IO.Stream = req.GetRequestStream()
strm.Write(bytes, 0, bytes.Length)
strm.Close()
        
Dim rsp As System.Net.HttpWebResponse = req.GetResponse()
Dim data As System.IO.Stream = rsp.GetResponseStream()
Dim rdr As New System.IO.StreamReader(data)

Dim response As String = rdr.ReadToEnd()
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;

import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample {

  public static void main(String[] args) {
   HttpClient httpclient = HttpClients.createDefault();

   try
   {
      URIBuilder builder = new URIBuilder("https://peoplevine.azure-api.net/customer/customer/registerCustomer");
      // Specify your subscription key
      builder.setParameter("subscription-key", "");
      URI uri = builder.build();
      HttpPost request = new HttpPost(uri);
      StringEntity reqEntity = new StringEntity("", ContentType.create("application/json"));
      request.setEntity(reqEntity);
      HttpResponse response = httpclient.execute(request);
      HttpEntity entity = response.getEntity();
      if (entity != null) {
         System.out.println(EntityUtils.toString(entity));
      }
   }
   catch (Exception e)
   {
      System.out.println(e.getMessage());
   }
  }
}
<?php

// This sample uses the HTTP_Request2 package. (for more information: http://pear.php.net/package/HTTP_Request2)
require_once 'HTTP/Request2.php';
$headers = array(
   'Content-Type' => 'application/json',
);

$query_params = array(
   // Specify your subscription key
   'subscription-key' => '',
);

$request = new Http_Request2('https://peoplevine.azure-api.net/customer/customer/registerCustomer');
$request->setMethod(HTTP_Request2::METHOD_POST);
// Basic Authorization Sample
// $request-setAuth('{username}', '{password}');
$request->setHeader($headers);

$url = $request->getUrl();
$url->setQueryVariables($query_params);
$request->setBody("");

try
{
   $response = $request->send();
   
   echo $response->getBody();
}
catch (HttpException $ex)
{
   echo $ex;
}

?>

    #import <Foundation/Foundation.h>
    
    NSDictionary *authDic = [NSDictionary dictionaryWithObjectsAndKeys:
            <string>, @"api_username",
            <string>, @"api_password",
            <string>, @"api_key",
            <double>, @"company_no",
            <string>, @"username",
            <string>, @"password",
            <double>, @"timezone_offset",
            <string>, @"auth_type",
            <string>, @"system_name",
            <double>, @"system_company_no", nil];
    
    NSDictionary *itemDic = [NSDictionary dictionaryWithObjectsAndKeys:
            <string>, @"item_type",
            <double>, @"times_used",
            <double>, @"commerce_coupon_no",
            <double>, @"item_no",
            <double>, @"company_no",
            <string>, @"item_title",
            <dateTime>, @"valid_on",
            <dateTime>, @"valid_to",
            <string>, @"coupon_code",
            <string>, @"coupon_title",
            <string>, @"coupon_description",
            <string>, @"coupon_type",
            <double>, @"coupon_value",
            <string>, @"customer_type",
            <dateTime>, @"created_on",
            <double>, @"user_no",
            <string>, @"apply_type",
            <boolean>, @"requires_code",
            <double>, @"customer_no",
            <string>, @"coupon_status",
            <double>, @"max_redemptions",
            <string>, @"minimum_type",
            <double>, @"minimum_value", nil];
    
    NSDictionary *finalDic = [NSDictionary dictionaryWithObjectsAndKeys:
                authDic, @"auth",itemDic, @"item", nil];
 
    NSMutableDictionary* jsonString = nil;
    jsonString = [NSJSONSerialization JSONObjectWithData: findalDic options:NSJSONReadingMutableContainers];
    
    NSMutableData *bodyData = [NSMutableData dataWithData:[jsonString dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSString *urlString = @"https://api.peoplevine.com/commerce.asmx/createCommerceCoupon";
    
    ASIFormDataRequest *request = [ASIFormDataRequest requestWithURL:[NSURL URLWithString:urlString]];    
    [request setTimeOutSeconds:250];    
    [request setRequestMethod:@"POST"];    
    [request addRequestHeader:@"Content-Type" value:@"application/json"];    
    [request addRequestHeader:[NSString stringWithFormat:@"%d",bodyData.length] value:@"Content-length"];    
    [request setPostBody:bodyData];    
    [request startSynchronous];

    NSDictionary *responseDic = (NSDictionary*)[request.responseString JSONValue];   
   
    if (responseDic || [responseDic objectForKey:@"d"])
    {
        NSMutableDictionary *dicSave=[responseDic objectForKey:@"d"];
        // -------------------------------------------------------------------
        // convert into the data and NSUTF8StringEncoding
        // -------------------------------------------------------------------
        NSString *strDic=[dicSave copy];
        NSMutableDictionary *dirJson;
        if (strDic)
        {
            NSData* dataFile=[strDic dataUsingEncoding:NSUTF8StringEncoding];
            NSString* newStr = [[NSString alloc] initWithData:dataFile
                                                     encoding:NSUTF8StringEncoding];
           
            dirJson = [newStr JSONValue] ;
        }
        // -------------------------------------------------------------------
        
        NSString *str=[[dirJson objectForKey:@"returnObject"]valueForKey:@"customer_no"];
    }
    else
    {
        UIAlertView *alert=[[UIAlertView alloc]initWithTitle:@"Error" message:@"An Error Occurred" delegate:nil cancelButtonTitle:@"Ok" otherButtonTitles:nil];
        [alert show];
    }
require 'net/http'

uri = URI('https://peoplevine.azure-api.net/customer/customer/registerCustomer')

uri.query = URI.encode_www_form({
   # Specify your subscription key
   'subscription-key' => '',
})

request = Net::HTTP::Post.new(uri.request_uri)

# Basic Authorization Sample
# request.basic_auth 'username', 'password'
request['Content-type'] = 'application/json'

request.body = ""

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
   # Basic Authorization Sample
   # 'Authorization': 'Basic %s' % base64.encodestring('{username}:{password}'),
   'Content-type': 'application/json',
}

params = urllib.urlencode({
   # Specify your subscription key
   'subscription-key': '',
})

try:
   conn = httplib.HTTPSConnection('peoplevine.azure-api.net')
   conn.request("POST", "/customer/customer/registerCustomer?%s" % params, "", headers)
   response = conn.getresponse()
   data = response.read()
   print(data)
   conn.close()
except Exception as e:
   print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
   # Basic Authorization Sample
   # 'Authorization': 'Basic %s' % base64.encodestring('{username}:{password}'),
   'Content-type': 'application/json',
}

params = urllib.parse.urlencode({
   # Specify your subscription key
   'subscription-key': '',
})

try:
   conn = http.client.HTTPSConnection('peoplevine.azure-api.net')
   conn.request("POST", "/customer/customer/registerCustomer?%s" % params, "", headers)
   response = conn.getresponse()
   data = response.read()
   print(data)
   conn.close()
except Exception as e:
   print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
@ECHO OFF

REM for Basic Authorization use: --user {username}:{password}
REM Specify values for path parameters (shown as {...}), your subscription key and values for query parameters
curl -v -X POST "https://peoplevine.azure-api.net/customer/customer/registerCustomer?subscription-key="^
 -H "Content-Type: application/json"