Documents

• getCoupon

  getCoupon   description: get the coupon details given the coupon code. An example using our simple to use PHP codebookie … Read more →

  Was this article helpful to you? Yes No

• verify

  verify description: verify the discounted price and the checkout token.  This should be used after getCoupon has been used and … Read more →

  Was this article helpful to you? Yes No

• confirmOrder

  confirmOrder description: places the finalized order information into CodeBookie.  Should use after payment has been completed and confirmed by the … Read more →

  Was this article helpful to you? Yes No

• getTokenInfo

  getTokenInfo   description: given the checkout token, returns the order information

  require "codeBookie.php"; $codeBookie = new CodeBookie(); $checkoutToken = "TEST_TOKEN"; $result = $codeBookie->getTokenInfo($checkoutToken);

  1 2 3 4 5

  require "codeBookie.php"; $codeBookie = new CodeBookie(); $checkoutToken = "TEST_TOKEN";   $result = $codeBookie->getTokenInfo($checkoutToken);

  Output:

  Was this article helpful to you? Yes No

• cancelCommission

  description: API call to refund a transaction and reverse commission from a sale if required Example usage

  require "codeBookie.php"; $codeBookie = new CodeBookie(); $confirmationID = '1234567890'; $result = $codeBookie->refundCouponCommission($confirmationID);

  1 2 3 4 5 6 7

  require "codeBookie.php"; $codeBookie = new CodeBookie();   $confirmationID = '1234567890'; $result = $codeBookie->refundCouponCommission($confirmationID);

  Output variables:

  Was this article helpful to you? Yes No

• generateCouponProduct

  /coupon/generateCouponProduct Used to generate a one time usage coupon for a client. Example PHP Code using the Codebookie Class:

  generateCouponProduct Example Code

  require "codeBookie.php"; $codeBookie = new CodeBookie(); //the email address the coupon will be generated for $email = "test@test.com"; //coupon will expire in 3 days $daysExpire = 3; //discount type is either $ or % $discountType = '%'; //we want the discount type to be 10% off original price $discountAmount = '10'; //sku of the product $sku = 'PRODUCTCODE1'; //website ID of your site you want the coupon generated for $websiteID = 1; $result = $codeBookie->createLimitedOneTimeCouponForProduct($email,$daysExpire,$discountType,$discountAmount,$sku,$websiteID); //coupon generated successfully if ($result['status'] == "OK"): $coupon = $result['coupon_code']; //anthing else is an error else: $errorMessage = $result['message']; endif;

  1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25

  require "codeBookie.php"; $codeBookie = new CodeBookie(); //the email address the coupon will be generated for $email = "test@test.com"; //coupon will expire in 3 days $daysExpire = 3; //discount type is either $ or % $discountType = '%'; //we want the discount type to be 10% off original price $discountAmount = '10'; //sku of the product $sku = 'PRODUCTCODE1'; //website ID of your site you want the coupon generated for $websiteID = 1;       $result = $codeBookie->createLimitedOneTimeCouponForProduct($email,$daysExpire,$discountType,$discountAmount,$sku,$websiteID); //coupon generated successfully if ($result['status'] == "OK"):     $coupon = $result['coupon_code']; //anthing else is an error else:     $errorMessage = $result['message']; endif;

  … Read more →

  Was this article helpful to you? Yes No