API's for the diamond industry
| Parameter | Details | Format | Mandatory |
|---|---|---|---|
| api_key | Your API key, for example "HNNSSA1223311" | String | Yes |
| api_secret | Your API secret, for example "DDccdaaedf123" | String | Yes |
| diamonds |
diamond_id, numeric, mandatory customer_name, string, optional notes, string, optional sales_person, string, optional |
Object Array | Yes |
| branch_id |
Branch ID for delivery. For example 54312 |
Integer | Yes |
| total_cost | Total amount to pay, including shipping. This will be verified before finalizing the order. | Decimal | Yes |
| shipping_method | The shipping method you choose. Can be "standard" or "expedited" | String | Yes |
| mode | The mode is to allow testing. This can be "test" or "live". Test transactions won't be placed, you will receive a fictitious transaction number in response. | String | Yes |
{
"authentication_details":{
"api_key":"HNNSSA1223311",
"api_secret":"DDccdaaedf123"
},
"parameters":{
"diamonds": [
{
"diamond_id": 389254754,
"customer_name": "John Grisham"
"notes": "your note for later"
"sales_person": "Michael"
},
{
"diamond_id": 389254750,
"notes":"for Jane."
}
],
"branch_id": 2489 ,
"total_cost": 1872.64,
"shipping_method": "standard",
"mode": "test"
}
}
{
"result_info": {
"response_code": 0,
"response_description": ""
},
"results": {
"place_order_success": true,
"transaction_id": 66543
}
}
{
"result_info": {
"response_code": 32110,
"response_description": "A description of the exception."
}
}